2 * This file is part of the GROMACS molecular simulation package.
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.
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.
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.
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.
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.
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.
39 #include "gromacs/legacyheaders/gmx_cpuid.h"
40 #include "gromacs/legacyheaders/types/simple.h"
46 } /* fixes auto-indentation problems */
49 struct gmx_device_info_t;
51 /* Possible results of the GPU detection/check.
53 * The egpuInsane value means that during the sanity checks an error
54 * occurred that indicates malfunctioning of the device, driver, or
55 * incompatible driver/runtime. */
58 egpuCompatible = 0, egpuNonexistent, egpuIncompatible, egpuInsane, egpuNR
61 /* Names of the GPU detection/check results */
62 extern const char * const gpu_detect_res_str[egpuNR];
64 /* GPU device information -- for now with only CUDA devices
65 * The gmx_hardware_detect module initializes it. */
68 gmx_bool bDetectGPUs; /* Did we try to detect GPUs? */
69 int n_dev; /* total number of GPU devices detected */
70 struct gmx_device_info_t *gpu_dev; /* GPU devices detected in the system (per node) */
71 int n_dev_compatible; /* number of compatible GPUs */
74 /* Hardware information structure with CPU and GPU information.
75 * It is initialized by gmx_detect_hardware().
76 * NOTE: this structure may only contain structures that are globally valid
77 * (i.e. must be able to be shared among all threads) */
80 /* Data for our local physical node */
81 struct gmx_gpu_info_t gpu_info; /* Information about GPUs detected in the system */
83 gmx_cpuid_t cpuid_info; /* CPUID information about CPU detected;
84 NOTE: this will only detect the CPU thread 0 of the
85 current process runs on. */
86 int ncore; /* Number of cores, will be 0 when not detected */
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. */
91 /* Data reduced through MPI over all physical nodes */
92 int nphysicalnode; /* Number of physical nodes */
93 int ncore_tot; /* Sum of #cores over all nodes, can be 0 */
94 int ncore_min; /* Min #cores over all nodes */
95 int ncore_max; /* Max #cores over all nodes */
96 int nhwthread_tot; /* Sum of #hwthreads over all nodes */
97 int nhwthread_min; /* Min #hwthreads over all nodes */
98 int nhwthread_max; /* Max #hwthreads over all nodes */
99 int ngpu_compatible_tot; /* Sum of #GPUs over all nodes */
100 int ngpu_compatible_min; /* Min #GPUs over all nodes */
101 int ngpu_compatible_max; /* Max #GPUs over all nodes */
103 /* The values below are only used for printing, so here it's not an issue
104 * that stricly speaking SIMD instruction sets can't be uniquely ordered.
106 enum gmx_cpuid_simd simd_suggest_min; /* Highest SIMD instruction set supported by all ranks */
107 enum gmx_cpuid_simd simd_suggest_max; /* Highest SIMD instruction set supported by at least one rank */
109 gmx_bool bIdenticalGPUs; /* TRUE if all ranks have the same type(s) and order of GPUs */
113 /* The options for the thread affinity setting, default: auto */
115 threadaffSEL, threadaffAUTO, threadaffON, threadaffOFF, threadaffNR
118 /* GPU device selection information -- for now with only CUDA devices */
121 char *gpu_id; /* GPU id's to use, each specified as chars */
122 gmx_bool bUserSet; /* true if the GPUs in dev_use are manually provided by the user */
124 int n_dev_compatible; /* number of compatible GPU devices that could be used */
125 int *dev_compatible; /* array of compatible GPU device IDs, from which automatic selection occurs */
126 int n_dev_use; /* number of GPU devices selected to be used, either by the user or automatically */
127 int *dev_use; /* array mapping from PP rank index to GPU device ID; GPU IDs can be listed multiple times when ranks share them */
130 /* Threading and GPU options, can be set automatically or by the user */
132 int nthreads_tot; /* Total number of threads requested (TMPI) */
133 int nthreads_tmpi; /* Number of TMPI threads requested */
134 int nthreads_omp; /* Number of OpenMP threads requested */
135 int nthreads_omp_pme; /* As nthreads_omp, but for PME only nodes */
136 int thread_affinity; /* Thread affinity switch, see enum above */
137 int core_pinning_stride; /* Logical core pinning stride */
138 int core_pinning_offset; /* Logical core pinning offset */
140 gmx_gpu_opt_t gpu_opt; /* The GPU options */
147 #endif /* HWINFO_H */