src/gromacs/legacyheaders/gmx_detect_hardware.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014,2015, 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
  36 #ifndef GMX_HARDWARE_DETECT_H
  37 #define GMX_HARDWARE_DETECT_H
  38
  39 #include "gromacs/legacyheaders/typedefs.h"
  40
  41 #ifdef __cplusplus
  42 extern "C" {
  43 #endif
  44 #if 0
  45 } /* fixes auto-indentation problems */
  46 #endif
  47
  48 /*! \brief Return whether mdrun can use more than one GPU per node
  49  *
  50  * The OpenCL implementation cannot use more than one GPU per node,
  51  * for example. */
  52 gmx_bool gmx_multiple_gpu_per_node_supported();
  53
  54 /*! \brief Return whether PP ranks can share a GPU
  55  *
  56  * The OpenCL implementation cannot share a GPU between ranks, for
  57  * example. */
  58 gmx_bool gmx_gpu_sharing_supported();
  59
  60 /* the init and consistency functions depend on commrec that may not be
  61    consistent in cuda because MPI types don't exist there.  */
  62 #ifndef __CUDACC__
  63 /* Construct the global hwinfo structure and return a pointer to
  64    it. Caller is responsible for freeing this pointer. */
  65 gmx_hw_info_t *gmx_detect_hardware(FILE *fplog, const t_commrec *cr,
  66                                    gmx_bool bDetectGPUs);
  67
  68 /* Print information about the detected hardware to fplog (if != NULL)
  69  * and to stderr the master rank.
  70  */
  71 void gmx_print_detected_hardware(FILE *fplog, const t_commrec *cr,
  72                                  const gmx_hw_info_t *hwinfo);
  73
  74 void gmx_hardware_info_free(gmx_hw_info_t *hwinfo);
  75
  76 void gmx_parse_gpu_ids(gmx_gpu_opt_t *gpu_opt);
  77
  78 void gmx_select_gpu_ids(FILE *fplog, const t_commrec *cr,
  79                         const gmx_gpu_info_t *gpu_info,
  80                         gmx_bool bForceUseGPU,
  81                         gmx_gpu_opt_t *gpu_opt);
  82
  83 /* Check the consistency of hw_opt with hwinfo.
  84    This function should be called once on each MPI rank. */
  85 void gmx_check_hw_runconf_consistency(FILE                *fplog,
  86                                       const gmx_hw_info_t *hwinfo,
  87                                       const t_commrec     *cr,
  88                                       const gmx_hw_opt_t  *hw_opt,
  89                                       gmx_bool             bUseGPU);
  90 #endif
  91
  92
  93 /* Check whether a GPU is shared among ranks, and return the number of shared
  94    gpus
  95
  96    gpu_opt       = the gpu options struct
  97
  98    returns: The number of GPUs shared among ranks, or 0 */
  99 int gmx_count_gpu_dev_shared(const gmx_gpu_opt_t *gpu_opt);
 100
 101
 102 #ifdef __cplusplus
 103 }
 104 #endif
 105
 106
 107 #endif /* GMX_HARDWARE_DETECT_H */