src/gromacs/legacyheaders/types/hw_info.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014, 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 HWINFO_H
  37 #define HWINFO_H
  38
  39 #include "gromacs/legacyheaders/types/simple.h"
  40 #include "gromacs/legacyheaders/types/nbnxn_cuda_types_ext.h"
  41 #include "../gmx_cpuid.h"
  42
  43 #ifdef __cplusplus
  44 extern "C" {
  45 #endif
  46 #if 0
  47 } /* fixes auto-indentation problems */
  48 #endif
  49
  50 /* Possible results of the GPU detection/check.
  51  *
  52  * The egpuInsane value means that during the sanity checks an error
  53  * occurred that indicates malfunctioning of the device, driver, or
  54  * incompatible driver/runtime. */
  55 typedef enum
  56 {
  57     egpuCompatible = 0,  egpuNonexistent,  egpuIncompatible, egpuInsane
  58 } e_gpu_detect_res_t;
  59
  60 /* Textual names of the GPU detection/check results (see e_gpu_detect_res_t). */
  61 static const char * const gpu_detect_res_str[] =
  62 {
  63     "compatible", "inexistent", "incompatible", "insane"
  64 };
  65
  66 /* GPU device information -- for now with only CUDA devices.
  67  * The gmx_hardware_detect module initializes it. */
  68 typedef struct
  69 {
  70     gmx_bool             bDetectGPUs;          /* Did we try to detect GPUs? */
  71     int                  ncuda_dev;            /* total number of devices detected */
  72     cuda_dev_info_ptr_t  cuda_dev;             /* devices detected in the system (per node) */
  73     int                  ncuda_dev_compatible; /* number of compatible GPUs */
  74 } gmx_gpu_info_t;
  75
  76 /* Hardware information structure with CPU and GPU information.
  77  * It is initialized by gmx_detect_hardware().
  78  * NOTE: this structure may only contain structures that are globally valid
  79  *       (i.e. must be able to be shared among all threads) */
  80 typedef struct
  81 {
  82     gmx_gpu_info_t  gpu_info;            /* Information about GPUs detected in the system */
  83
  84     gmx_cpuid_t     cpuid_info;          /* CPUID information about CPU detected;
  85                                             NOTE: this will only detect the CPU thread 0 of the
  86                                             current process runs on. */
  87     int             nthreads_hw_avail;   /* Number of hardware threads available; this number
  88                                             is based on the number of CPUs reported as available
  89                                             by the OS at the time of detection. */
  90 } gmx_hw_info_t;
  91
  92
  93 /* The options for the thread affinity setting, default: auto */
  94 enum {
  95     threadaffSEL, threadaffAUTO, threadaffON, threadaffOFF, threadaffNR
  96 };
  97
  98 /* GPU device selection information -- for now with only CUDA devices */
  99 typedef struct
 100 {
 101     char     *gpu_id;        /* GPU id's to use, each specified as chars */
 102     gmx_bool  bUserSet;      /* true if the GPUs in cuda_dev_use are manually provided by the user */
 103
 104     int       ncuda_dev_use; /* number of device (IDs) selected to be used */
 105     int      *cuda_dev_use;  /* device index list providing GPU to PP rank mapping, GPUs can be listed multiple times when ranks share them */
 106 } gmx_gpu_opt_t;
 107
 108 /* Threading and GPU options, can be set automatically or by the user */
 109 typedef struct {
 110     int           nthreads_tot;        /* Total number of threads requested (TMPI) */
 111     int           nthreads_tmpi;       /* Number of TMPI threads requested         */
 112     int           nthreads_omp;        /* Number of OpenMP threads requested       */
 113     int           nthreads_omp_pme;    /* As nthreads_omp, but for PME only nodes  */
 114     int           thread_affinity;     /* Thread affinity switch, see enum above   */
 115     int           core_pinning_stride; /* Logical core pinning stride              */
 116     int           core_pinning_offset; /* Logical core pinning offset              */
 117
 118     gmx_gpu_opt_t gpu_opt;             /* The GPU options                          */
 119 } gmx_hw_opt_t;
 120
 121 #ifdef __cplusplus
 122 }
 123 #endif
 124
 125 #endif /* HWINFO_H */