src/gromacs/hardware/detecthardware.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014,2015,2016,2017, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35 #ifndef GMX_HARDWARE_DETECTHARDWARE_H
  36 #define GMX_HARDWARE_DETECTHARDWARE_H
  37
  38 #include <cstdio>
  39
  40 #include <string>
  41
  42 #include "gromacs/utility/basedefinitions.h"
  43
  44 struct gmx_gpu_info_t;
  45 struct gmx_gpu_opt_t;
  46 struct gmx_hw_info_t;
  47 struct gmx_hw_opt_t;
  48 struct t_commrec;
  49
  50 namespace gmx
  51 {
  52 class HardwareTopology;
  53 class MDLogger;
  54 }
  55
  56 /*! \brief Run detection, consistency checks, and make available on all ranks.
  57  *
  58  * This routine constructs the global hwinfo structure and returns a pointer to
  59  * it. It will run a preamble before executing cpu and hardware checks, and
  60  * then run consistency checks afterwards. The results will also be made
  61  * available on all nodes.
  62  * Caller is responsible for freeing this pointer.
  63  */
  64 gmx_hw_info_t *gmx_detect_hardware(const gmx::MDLogger &mdlog,
  65                                    const t_commrec *cr, gmx_bool bDetectGPUs);
  66
  67 /* Print information about the detected hardware to fplog (if != NULL)
  68  * and to stderr the master rank.
  69  */
  70 void gmx_print_detected_hardware(FILE *fplog, const t_commrec *cr,
  71                                  const gmx::MDLogger &mdlog,
  72                                  const gmx_hw_info_t *hwinfo);
  73
  74 /*! \brief Helper function for reporting GPU usage information
  75  * in the mdrun log file
  76  *
  77  * \param[in] gpu_info       Information detected about GPUs
  78  * \param[in] gpu_opt        Pointer to per-node GPU options struct
  79  * \param[in] userSetGpuIds  Whether the user selected the GPU ids
  80  * \param[in] numPpRanks     Number of PP ranks per node
  81  * \param[in] bPrintHostName Print the hostname in the usage information
  82  * \return                   String to write to the log file
  83  * \throws                   std::bad_alloc if out of memory */
  84 std::string
  85 makeGpuUsageReport(const gmx_gpu_info_t &gpu_info,
  86                    const gmx_gpu_opt_t  *gpu_opt,
  87                    bool                  userSetGpuIds,
  88                    size_t                numPpRanks,
  89                    bool                  bPrintHostName);
  90
  91 void gmx_hardware_info_free(gmx_hw_info_t *hwinfo);
  92
  93 /* Return whether the user selected GPU ids */
  94 bool hasUserSetGpuIds(const gmx_gpu_opt_t *gpu_opt);
  95
  96 //! Return whether compatible GPUs were found.
  97 bool compatibleGpusFound(const gmx_gpu_info_t &gpu_info);
  98
  99 /* Parse the GPU ids the user may have passed. */
 100 void gmx_parse_gpu_ids(gmx_gpu_opt_t *gpu_opt);
 101
 102 /*! \brief Check the consistency of hw_opt with hwinfo.
 103  *
 104  * This function should be called once on each MPI rank. */
 105 void gmx_check_hw_runconf_consistency(const gmx::MDLogger &mdlog,
 106                                       const gmx_hw_info_t *hwinfo,
 107                                       const t_commrec     *cr,
 108                                       const gmx_hw_opt_t  *hw_opt,
 109                                       bool                 userSetGpuIds,
 110                                       bool                 willUsePhysicalGpu);
 111
 112 #endif