Merge release-5-0 into master
[alexxy/gromacs.git] / src / gromacs / gmxlib / gmx_detect_hardware.cpp
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 #include "gmxpre.h"
36
37 #include "gromacs/legacyheaders/gmx_detect_hardware.h"
38
39 #include "config.h"
40
41 #include <assert.h>
42 #include <errno.h>
43 #include <stdlib.h>
44 #include <string.h>
45
46 #include <string>
47 #include <vector>
48
49 #ifdef HAVE_UNISTD_H
50 /* For sysconf */
51 #include <unistd.h>
52 #endif
53 #ifdef GMX_NATIVE_WINDOWS
54 #include <windows.h>
55 #endif
56
57 #include "thread_mpi/threads.h"
58
59 #include "gromacs/gmxlib/gpu_utils/gpu_utils.h"
60 #include "gromacs/legacyheaders/copyrite.h"
61 #include "gromacs/legacyheaders/gmx_cpuid.h"
62 #include "gromacs/legacyheaders/md_logging.h"
63 #include "gromacs/legacyheaders/network.h"
64 #include "gromacs/legacyheaders/types/commrec.h"
65 #include "gromacs/legacyheaders/types/enums.h"
66 #include "gromacs/legacyheaders/types/hw_info.h"
67 #include "gromacs/utility/arrayref.h"
68 #include "gromacs/utility/basenetwork.h"
69 #include "gromacs/utility/cstringutil.h"
70 #include "gromacs/utility/exceptions.h"
71 #include "gromacs/utility/fatalerror.h"
72 #include "gromacs/utility/gmxassert.h"
73 #include "gromacs/utility/gmxomp.h"
74 #include "gromacs/utility/smalloc.h"
75 #include "gromacs/utility/stringutil.h"
76 #include "gromacs/utility/sysinfo.h"
77
78
79 #ifdef GMX_GPU
80 const gmx_bool bGPUBinary = TRUE;
81 #else
82 const gmx_bool bGPUBinary = FALSE;
83 #endif
84
85 static const char * invalid_gpuid_hint =
86     "A delimiter-free sequence of valid numeric IDs of available GPUs is expected.";
87
88 /* The globally shared hwinfo structure. */
89 static gmx_hw_info_t      *hwinfo_g;
90 /* A reference counter for the hwinfo structure */
91 static int                 n_hwinfo = 0;
92 /* A lock to protect the hwinfo structure */
93 static tMPI_Thread_mutex_t hw_info_lock = TMPI_THREAD_MUTEX_INITIALIZER;
94
95 #define HOSTNAMELEN 80
96
97 /* FW decl. */
98 static void set_gpu_ids(gmx_gpu_opt_t *gpu_opt, int nrank, int rank);
99 static int gmx_count_gpu_dev_unique(const gmx_gpu_info_t *gpu_info,
100                                     const gmx_gpu_opt_t  *gpu_opt);
101
102 static void sprint_gpus(char *sbuf, const gmx_gpu_info_t *gpu_info)
103 {
104     int      i, ndev;
105     char     stmp[STRLEN];
106
107     ndev = gpu_info->n_dev;
108
109     sbuf[0] = '\0';
110     for (i = 0; i < ndev; i++)
111     {
112         get_gpu_device_info_string(stmp, gpu_info, i);
113         strcat(sbuf, "    ");
114         strcat(sbuf, stmp);
115         if (i < ndev - 1)
116         {
117             strcat(sbuf, "\n");
118         }
119     }
120 }
121
122 static void print_gpu_detection_stats(FILE                 *fplog,
123                                       const gmx_gpu_info_t *gpu_info,
124                                       const t_commrec      *cr)
125 {
126     char onhost[HOSTNAMELEN+10], stmp[STRLEN];
127     int  ngpu;
128
129     if (!gpu_info->bDetectGPUs)
130     {
131         /* We skipped the detection, so don't print detection stats */
132         return;
133     }
134
135     ngpu = gpu_info->n_dev;
136
137 #if defined GMX_MPI && !defined GMX_THREAD_MPI
138     /* We only print the detection on one, of possibly multiple, nodes */
139     strncpy(onhost, " on host ", 10);
140     gmx_gethostname(onhost + 9, HOSTNAMELEN);
141 #else
142     /* We detect all relevant GPUs */
143     strncpy(onhost, "", 1);
144 #endif
145
146     if (ngpu > 0)
147     {
148         sprint_gpus(stmp, gpu_info);
149         md_print_warn(cr, fplog, "%d GPU%s detected%s:\n%s\n",
150                       ngpu, (ngpu > 1) ? "s" : "", onhost, stmp);
151     }
152     else
153     {
154         md_print_warn(cr, fplog, "No GPUs detected%s\n", onhost);
155     }
156 }
157
158 /*! \brief Helper function for reporting GPU usage information
159  * in the mdrun log file
160  *
161  * \param[in] gpu_info       Pointer to per-node GPU info struct
162  * \param[in] gpu_opt        Pointer to per-node GPU options struct
163  * \param[in] numPpRanks     Number of PP ranks per node
164  * \param[in] bPrintHostName Print the hostname in the usage information
165  * \return                   String to write to the log file
166  * \throws                   std::bad_alloc if out of memory */
167 static std::string
168 makeGpuUsageReport(const gmx_gpu_info_t *gpu_info,
169                    const gmx_gpu_opt_t  *gpu_opt,
170                    size_t                numPpRanks,
171                    bool                  bPrintHostName)
172 {
173     int  ngpu_use  = gpu_opt->n_dev_use;
174     int  ngpu_comp = gpu_info->n_dev_compatible;
175     char host[HOSTNAMELEN];
176
177     if (bPrintHostName)
178     {
179         gmx_gethostname(host, HOSTNAMELEN);
180     }
181
182     /* Issue a note if GPUs are available but not used */
183     if (ngpu_comp > 0 && ngpu_use < 1)
184     {
185         return gmx::formatString("%d compatible GPU%s detected in the system, but none will be used.\n"
186                                  "Consider trying GPU acceleration with the Verlet scheme!\n",
187                                  ngpu_comp, (ngpu_comp > 1) ? "s" : "");
188     }
189
190     std::string output;
191     if (!gpu_opt->bUserSet)
192     {
193         // gpu_opt->dev_compatible is only populated during auto-selection
194         std::string gpuIdsString =
195             formatAndJoin(gmx::constArrayRefFromArray(gpu_opt->dev_compatible,
196                                                       gpu_opt->n_dev_compatible),
197                           ",", gmx::StringFormatter("%d"));
198         bool bPluralGpus = gpu_opt->n_dev_compatible > 1;
199
200         if (bPrintHostName)
201         {
202             output += gmx::formatString("On host %s ", host);
203         }
204         output += gmx::formatString("%d compatible GPU%s %s present, with ID%s %s\n",
205                                     gpu_opt->n_dev_compatible,
206                                     bPluralGpus ? "s" : "",
207                                     bPluralGpus ? "are" : "is",
208                                     bPluralGpus ? "s" : "",
209                                     gpuIdsString.c_str());
210     }
211
212     {
213         std::vector<int>   gpuIdsInUse;
214         for (int i = 0; i < ngpu_use; i++)
215         {
216             gpuIdsInUse.push_back(get_cuda_gpu_device_id(gpu_info, gpu_opt, i));
217         }
218         std::string gpuIdsString =
219             formatAndJoin(gpuIdsInUse, ",", gmx::StringFormatter("%d"));
220         int         numGpusInUse = gmx_count_gpu_dev_unique(gpu_info, gpu_opt);
221         bool        bPluralGpus  = numGpusInUse > 1;
222
223         if (bPrintHostName)
224         {
225             output += gmx::formatString("On host %s ", host);
226         }
227         output += gmx::formatString("%d GPU%s %sselected for this run.\n"
228                                     "Mapping of GPU ID%s to the %d PP rank%s in this node: %s\n",
229                                     numGpusInUse, bPluralGpus ? "s" : "",
230                                     gpu_opt->bUserSet ? "user-" : "auto-",
231                                     bPluralGpus ? "s" : "",
232                                     numPpRanks,
233                                     (numPpRanks > 1) ? "s" : "",
234                                     gpuIdsString.c_str());
235     }
236
237     return output;
238 }
239
240 /* Give a suitable fatal error or warning if the build configuration
241    and runtime CPU do not match. */
242 static void
243 check_use_of_rdtscp_on_this_cpu(FILE                *fplog,
244                                 const t_commrec     *cr,
245                                 const gmx_hw_info_t *hwinfo)
246 {
247     gmx_bool bCpuHasRdtscp, bBinaryUsesRdtscp;
248 #ifdef HAVE_RDTSCP
249     bBinaryUsesRdtscp = TRUE;
250 #else
251     bBinaryUsesRdtscp = FALSE;
252 #endif
253
254     bCpuHasRdtscp = gmx_cpuid_feature(hwinfo->cpuid_info, GMX_CPUID_FEATURE_X86_RDTSCP);
255
256     if (!bCpuHasRdtscp && bBinaryUsesRdtscp)
257     {
258         gmx_fatal(FARGS, "The %s executable was compiled to use the rdtscp CPU instruction. "
259                   "However, this is not supported by the current hardware and continuing would lead to a crash. "
260                   "Please rebuild GROMACS with the GMX_USE_RDTSCP=OFF CMake option.",
261                   ShortProgram());
262     }
263
264     if (bCpuHasRdtscp && !bBinaryUsesRdtscp)
265     {
266         md_print_warn(cr, fplog, "The current CPU can measure timings more accurately than the code in\n"
267                       "%s was configured to use. This might affect your simulation\n"
268                       "speed as accurate timings are needed for load-balancing.\n"
269                       "Please consider rebuilding %s with the GMX_USE_RDTSCP=ON CMake option.\n",
270                       ShortProgram(), ShortProgram());
271     }
272 }
273
274 void gmx_check_hw_runconf_consistency(FILE                *fplog,
275                                       const gmx_hw_info_t *hwinfo,
276                                       const t_commrec     *cr,
277                                       const gmx_hw_opt_t  *hw_opt,
278                                       gmx_bool             bUseGPU)
279 {
280     int      npppn;
281     char     th_or_proc[STRLEN], th_or_proc_plural[STRLEN], pernode[STRLEN];
282     gmx_bool btMPI, bMPI, bNthreadsAuto, bEmulateGPU;
283
284     assert(hwinfo);
285     assert(cr);
286
287     /* Below we only do consistency checks for PP and GPUs,
288      * this is irrelevant for PME only nodes, so in that case we return
289      * here.
290      */
291     if (!(cr->duty & DUTY_PP))
292     {
293         return;
294     }
295
296 #if defined(GMX_THREAD_MPI)
297     bMPI          = FALSE;
298     btMPI         = TRUE;
299     bNthreadsAuto = (hw_opt->nthreads_tmpi < 1);
300 #elif defined(GMX_LIB_MPI)
301     bMPI          = TRUE;
302     btMPI         = FALSE;
303     bNthreadsAuto = FALSE;
304 #else
305     bMPI          = FALSE;
306     btMPI         = FALSE;
307     bNthreadsAuto = FALSE;
308 #endif
309
310     /* GPU emulation detection is done later, but we need here as well
311      * -- uncool, but there's no elegant workaround */
312     bEmulateGPU       = (getenv("GMX_EMULATE_GPU") != NULL);
313
314     if (hwinfo->gpu_info.n_dev_compatible > 0)
315     {
316         std::string gpuUseageReport;
317         try
318         {
319             gpuUseageReport = makeGpuUsageReport(&hwinfo->gpu_info,
320                                                  &hw_opt->gpu_opt,
321                                                  cr->nrank_pp_intranode,
322                                                  bMPI && cr->nnodes > 1);
323         }
324         GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR;
325
326         /* NOTE: this print is only for and on one physical node */
327         md_print_info(cr, fplog, "%s\n", gpuUseageReport.c_str());
328     }
329
330     /* Need to ensure that we have enough GPUs:
331      * - need one GPU per PP node
332      * - no GPU oversubscription with tMPI
333      * */
334     /* number of PP processes per node */
335     npppn = cr->nrank_pp_intranode;
336
337     pernode[0]           = '\0';
338     th_or_proc_plural[0] = '\0';
339     if (btMPI)
340     {
341         sprintf(th_or_proc, "thread-MPI thread");
342         if (npppn > 1)
343         {
344             sprintf(th_or_proc_plural, "s");
345         }
346     }
347     else if (bMPI)
348     {
349         sprintf(th_or_proc, "MPI process");
350         if (npppn > 1)
351         {
352             sprintf(th_or_proc_plural, "es");
353         }
354         sprintf(pernode, " per node");
355     }
356     else
357     {
358         /* neither MPI nor tMPI */
359         sprintf(th_or_proc, "process");
360     }
361
362     if (bUseGPU && hwinfo->gpu_info.n_dev_compatible > 0 &&
363         !bEmulateGPU)
364     {
365         int  ngpu_comp, ngpu_use;
366         char gpu_comp_plural[2], gpu_use_plural[2];
367
368         ngpu_comp = hwinfo->gpu_info.n_dev_compatible;
369         ngpu_use  = hw_opt->gpu_opt.n_dev_use;
370
371         sprintf(gpu_comp_plural, "%s", (ngpu_comp > 1) ? "s" : "");
372         sprintf(gpu_use_plural,  "%s", (ngpu_use > 1) ? "s" : "");
373
374         /* number of tMPI threads auto-adjusted */
375         if (btMPI && bNthreadsAuto)
376         {
377             if (hw_opt->gpu_opt.bUserSet && npppn < ngpu_use)
378             {
379                 /* The user manually provided more GPUs than threads we
380                    could automatically start. */
381                 gmx_fatal(FARGS,
382                           "%d GPU%s provided, but only %d PP thread-MPI thread%s coud be started.\n"
383                           "%s requires one PP tread-MPI thread per GPU; use fewer GPUs.",
384                           ngpu_use, gpu_use_plural,
385                           npppn, th_or_proc_plural,
386                           ShortProgram());
387             }
388
389             if (!hw_opt->gpu_opt.bUserSet && npppn < ngpu_comp)
390             {
391                 /* There are more GPUs than tMPI threads; we have
392                    limited the number GPUs used. */
393                 md_print_warn(cr, fplog,
394                               "NOTE: %d GPU%s were detected, but only %d PP thread-MPI thread%s can be started.\n"
395                               "      %s can use one GPU per PP tread-MPI thread, so only %d GPU%s will be used.\n",
396                               ngpu_comp, gpu_comp_plural,
397                               npppn, th_or_proc_plural,
398                               ShortProgram(), npppn,
399                               npppn > 1 ? "s" : "");
400             }
401         }
402
403         if (hw_opt->gpu_opt.bUserSet)
404         {
405             if (ngpu_use != npppn)
406             {
407                 gmx_fatal(FARGS,
408                           "Incorrect launch configuration: mismatching number of PP %s%s and GPUs%s.\n"
409                           "%s was started with %d PP %s%s%s, but you provided %d GPU%s.",
410                           th_or_proc, btMPI ? "s" : "es", pernode,
411                           ShortProgram(), npppn, th_or_proc,
412                           th_or_proc_plural, pernode,
413                           ngpu_use, gpu_use_plural);
414             }
415         }
416         else
417         {
418             if (ngpu_comp > npppn)
419             {
420                 md_print_warn(cr, fplog,
421                               "NOTE: potentially sub-optimal launch configuration, %s started with less\n"
422                               "      PP %s%s%s than GPU%s available.\n"
423                               "      Each PP %s can use only one GPU, %d GPU%s%s will be used.\n",
424                               ShortProgram(), th_or_proc,
425                               th_or_proc_plural, pernode, gpu_comp_plural,
426                               th_or_proc, npppn, gpu_use_plural, pernode);
427             }
428
429             if (ngpu_use != npppn)
430             {
431                 /* Avoid duplicate error messages.
432                  * Unfortunately we can only do this at the physical node
433                  * level, since the hardware setup and MPI process count
434                  * might differ between physical nodes.
435                  */
436                 if (cr->rank_pp_intranode == 0)
437                 {
438                     gmx_fatal(FARGS,
439                               "Incorrect launch configuration: mismatching number of PP %s%s and GPUs%s.\n"
440                               "%s was started with %d PP %s%s%s, but only %d GPU%s were detected.",
441                               th_or_proc, btMPI ? "s" : "es", pernode,
442                               ShortProgram(), npppn, th_or_proc,
443                               th_or_proc_plural, pernode,
444                               ngpu_use, gpu_use_plural);
445                 }
446             }
447         }
448
449         {
450             int      same_count;
451
452             same_count = gmx_count_gpu_dev_shared(&hw_opt->gpu_opt);
453
454             if (same_count > 0)
455             {
456                 md_print_info(cr, fplog,
457                               "NOTE: You assigned %s to multiple %s%s.\n",
458                               same_count > 1 ? "GPUs" : "a GPU", th_or_proc, btMPI ? "s" : "es");
459             }
460         }
461     }
462
463 #ifdef GMX_MPI
464     if (PAR(cr))
465     {
466         /* Avoid other ranks to continue after
467            inconsistency */
468         MPI_Barrier(cr->mpi_comm_mygroup);
469     }
470 #endif
471
472 }
473
474 /* Return 0 if none of the GPU (per node) are shared among PP ranks.
475  *
476  * Sharing GPUs among multiple PP ranks is possible when the user passes
477  * GPU IDs. Here we check for sharing and return a non-zero value when
478  * this is detected. Note that the return value represents the number of
479  * PP rank pairs that share a device.
480  */
481 int gmx_count_gpu_dev_shared(const gmx_gpu_opt_t *gpu_opt)
482 {
483     int      same_count    = 0;
484     int      ngpu          = gpu_opt->n_dev_use;
485
486     if (gpu_opt->bUserSet)
487     {
488         int      i, j;
489
490         for (i = 0; i < ngpu - 1; i++)
491         {
492             for (j = i + 1; j < ngpu; j++)
493             {
494                 same_count      += (gpu_opt->dev_use[i] ==
495                                     gpu_opt->dev_use[j]);
496             }
497         }
498     }
499
500     return same_count;
501 }
502
503 /* Count and return the number of unique GPUs (per node) selected.
504  *
505  * As sharing GPUs among multiple PP ranks is possible when the user passes
506  * GPU IDs, the number of GPUs user (per node) can be different from the
507  * number of GPU IDs selected.
508  */
509 static int gmx_count_gpu_dev_unique(const gmx_gpu_info_t *gpu_info,
510                                     const gmx_gpu_opt_t  *gpu_opt)
511 {
512     int  i, uniq_count, ngpu;
513     int *uniq_ids;
514
515     assert(gpu_info);
516     assert(gpu_opt);
517
518     ngpu = gpu_info->n_dev;
519
520     uniq_count  = 0;
521
522     snew(uniq_ids, ngpu);
523
524     /* Each element in uniq_ids will be set to 0 or 1. The n-th element set
525      * to 1 indicates that the respective GPU was selected to be used. */
526     for (i = 0; i < gpu_opt->n_dev_use; i++)
527     {
528         uniq_ids[get_cuda_gpu_device_id(gpu_info, gpu_opt, i)] = 1;
529     }
530     /* Count the devices used. */
531     for (i = 0; i < ngpu; i++)
532     {
533         uniq_count += uniq_ids[i];
534     }
535
536     sfree(uniq_ids);
537
538     return uniq_count;
539 }
540
541 static int get_ncores(gmx_cpuid_t cpuid)
542 {
543     int        nprocessors, npackages, ncores_per_package, nhwthreads_per_core;
544     const int *package_id, *core_id, *hwthread_id, *locality_order;
545     int        rc;
546
547     rc = gmx_cpuid_topology(cpuid,
548                             &nprocessors, &npackages,
549                             &ncores_per_package, &nhwthreads_per_core,
550                             &package_id, &core_id,
551                             &hwthread_id, &locality_order);
552
553     if (rc == 0)
554     {
555         return npackages*ncores_per_package;
556     }
557     else
558     {
559         /* We don't have cpuid topology info, return 0 core count */
560         return 0;
561     }
562 }
563
564 /* Return the number of hardware threads supported by the current CPU.
565  * We assume that this is equal with the number of "processors"
566  * reported to be online by the OS at the time of the call. The
567  * definition of "processor" is according to an old POSIX standard.
568  *
569  * Note that the number of hardware threads is generally greater than
570  * the number of cores (e.g. x86 hyper-threading, Power). Managing the
571  * mapping of software threads to hardware threads is managed
572  * elsewhere. */
573 static int get_nthreads_hw_avail(FILE gmx_unused *fplog, const t_commrec gmx_unused *cr)
574 {
575     int ret = 0;
576
577 #if ((defined(WIN32) || defined( _WIN32 ) || defined(WIN64) || defined( _WIN64 )) && !(defined (__CYGWIN__) || defined (__CYGWIN32__)))
578     /* Windows */
579     SYSTEM_INFO sysinfo;
580     GetSystemInfo( &sysinfo );
581     ret = sysinfo.dwNumberOfProcessors;
582 #elif defined HAVE_SYSCONF
583     /* We are probably on Unix.
584      * Now check if we have the argument to use before executing the call
585      */
586 #if defined(_SC_NPROCESSORS_ONLN)
587     ret = sysconf(_SC_NPROCESSORS_ONLN);
588 #elif defined(_SC_NPROC_ONLN)
589     ret = sysconf(_SC_NPROC_ONLN);
590 #elif defined(_SC_NPROCESSORS_CONF)
591     ret = sysconf(_SC_NPROCESSORS_CONF);
592 #elif defined(_SC_NPROC_CONF)
593     ret = sysconf(_SC_NPROC_CONF);
594 #else
595 #warning "No valid sysconf argument value found. Executables will not be able to determine the number of logical cores: mdrun will use 1 thread by default!"
596 #endif /* End of check for sysconf argument values */
597
598 #else
599     /* Neither windows nor Unix. No fscking idea how many hardware threads we have! */
600     ret = -1;
601 #endif
602
603     if (debug)
604     {
605         fprintf(debug, "Detected %d hardware threads to use.\n", ret);
606     }
607
608 #ifdef GMX_OPENMP
609     if (ret != gmx_omp_get_num_procs())
610     {
611         md_print_warn(cr, fplog,
612                       "Number of logical cores detected (%d) does not match the number reported by OpenMP (%d).\n"
613                       "Consider setting the launch configuration manually!",
614                       ret, gmx_omp_get_num_procs());
615     }
616 #endif
617
618     return ret;
619 }
620
621 static void gmx_detect_gpus(FILE *fplog, const t_commrec *cr)
622 {
623 #ifdef GMX_LIB_MPI
624     int              rank_world;
625     MPI_Comm         physicalnode_comm;
626 #endif
627     int              rank_local;
628
629     /* Under certain circumstances MPI ranks on the same physical node
630      * can not simultaneously access the same GPU(s). Therefore we run
631      * the detection only on one MPI rank per node and broadcast the info.
632      * Note that with thread-MPI only a single thread runs this code.
633      *
634      * TODO: We should also do CPU hardware detection only once on each
635      * physical node and broadcast it, instead of do it on every MPI rank.
636      */
637 #ifdef GMX_LIB_MPI
638     /* A split of MPI_COMM_WORLD over physical nodes is only required here,
639      * so we create and destroy it locally.
640      */
641     MPI_Comm_rank(MPI_COMM_WORLD, &rank_world);
642     MPI_Comm_split(MPI_COMM_WORLD, gmx_physicalnode_id_hash(),
643                    rank_world, &physicalnode_comm);
644     MPI_Comm_rank(physicalnode_comm, &rank_local);
645 #else
646     /* Here there should be only one process, check this */
647     assert(cr->nnodes == 1 && cr->sim_nodeid == 0);
648
649     rank_local = 0;
650 #endif
651
652     if (rank_local == 0)
653     {
654         char detection_error[STRLEN] = "", sbuf[STRLEN];
655
656         if (detect_gpus(&hwinfo_g->gpu_info, detection_error) != 0)
657         {
658             if (detection_error[0] != '\0')
659             {
660                 sprintf(sbuf, ":\n      %s\n", detection_error);
661             }
662             else
663             {
664                 sprintf(sbuf, ".");
665             }
666             md_print_warn(cr, fplog,
667                           "NOTE: Error occurred during GPU detection%s"
668                           "      Can not use GPU acceleration, will fall back to CPU kernels.\n",
669                           sbuf);
670         }
671     }
672
673 #ifdef GMX_LIB_MPI
674     /* Broadcast the GPU info to the other ranks within this node */
675     MPI_Bcast(&hwinfo_g->gpu_info.n_dev, 1, MPI_INT, 0, physicalnode_comm);
676
677     if (hwinfo_g->gpu_info.n_dev > 0)
678     {
679         int dev_size;
680
681         dev_size = hwinfo_g->gpu_info.n_dev*sizeof_gpu_dev_info();
682
683         if (rank_local > 0)
684         {
685             hwinfo_g->gpu_info.gpu_dev =
686                 (struct gmx_device_info_t *)malloc(dev_size);
687         }
688         MPI_Bcast(hwinfo_g->gpu_info.gpu_dev, dev_size, MPI_BYTE,
689                   0, physicalnode_comm);
690         MPI_Bcast(&hwinfo_g->gpu_info.n_dev_compatible, 1, MPI_INT,
691                   0, physicalnode_comm);
692     }
693
694     MPI_Comm_free(&physicalnode_comm);
695 #endif
696 }
697
698 static void gmx_collect_hardware_mpi()
699 {
700 #ifdef GMX_LIB_MPI
701     int  rank_id;
702     int  nrank, rank, ncore, nhwthread, ngpu, i;
703     int  gpu_hash;
704     int *buf, *all;
705
706     rank_id   = gmx_physicalnode_id_hash();
707     MPI_Comm_rank(MPI_COMM_WORLD, &rank);
708     MPI_Comm_size(MPI_COMM_WORLD, &nrank);
709     ncore     = hwinfo_g->ncore;
710     nhwthread = hwinfo_g->nthreads_hw_avail;
711     ngpu      = hwinfo_g->gpu_info.n_dev_compatible;
712     /* Create a unique hash of the GPU type(s) in this node */
713     gpu_hash  = 0;
714     /* Here it might be better to only loop over the compatible GPU, but we
715      * don't have that information available and it would also require
716      * removing the device ID from the device info string.
717      */
718     for (i = 0; i < hwinfo_g->gpu_info.n_dev; i++)
719     {
720         char stmp[STRLEN];
721
722         /* Since the device ID is incorporated in the hash, the order of
723          * the GPUs affects the hash. Also two identical GPUs won't give
724          * a gpu_hash of zero after XORing.
725          */
726         get_gpu_device_info_string(stmp, &hwinfo_g->gpu_info, i);
727         gpu_hash ^= gmx_string_fullhash_func(stmp, gmx_string_hash_init);
728     }
729
730     snew(buf, nrank);
731     snew(all, nrank);
732     buf[rank] = rank_id;
733
734     MPI_Allreduce(buf, all, nrank, MPI_INT, MPI_SUM, MPI_COMM_WORLD);
735
736     gmx_bool bFound;
737     int      nnode0, ncore0, nhwthread0, ngpu0, r;
738
739     bFound     = FALSE;
740     ncore0     = 0;
741     nnode0     = 0;
742     nhwthread0 = 0;
743     ngpu0      = 0;
744     for (r = 0; r < nrank; r++)
745     {
746         if (all[r] == rank_id)
747         {
748             if (!bFound && r == rank)
749             {
750                 /* We are the first rank in this physical node */
751                 nnode0     = 1;
752                 ncore0     = ncore;
753                 nhwthread0 = nhwthread;
754                 ngpu0      = ngpu;
755             }
756             bFound = TRUE;
757         }
758     }
759
760     sfree(buf);
761     sfree(all);
762
763     int sum[4], maxmin[10];
764
765     {
766         int buf[4];
767
768         /* Sum values from only intra-rank 0 so we get the sum over all nodes */
769         buf[0] = nnode0;
770         buf[1] = ncore0;
771         buf[2] = nhwthread0;
772         buf[3] = ngpu0;
773
774         MPI_Allreduce(buf, sum, 4, MPI_INT, MPI_SUM, MPI_COMM_WORLD);
775     }
776
777     {
778         int buf[10];
779
780         /* Store + and - values for all ranks,
781          * so we can get max+min with one MPI call.
782          */
783         buf[0] = ncore;
784         buf[1] = nhwthread;
785         buf[2] = ngpu;
786         buf[3] = gmx_cpuid_simd_suggest(hwinfo_g->cpuid_info);
787         buf[4] = gpu_hash;
788         buf[5] = -buf[0];
789         buf[6] = -buf[1];
790         buf[7] = -buf[2];
791         buf[8] = -buf[3];
792         buf[9] = -buf[4];
793
794         MPI_Allreduce(buf, maxmin, 10, MPI_INT, MPI_MAX, MPI_COMM_WORLD);
795     }
796
797     hwinfo_g->nphysicalnode       = sum[0];
798     hwinfo_g->ncore_tot           = sum[1];
799     hwinfo_g->ncore_min           = -maxmin[5];
800     hwinfo_g->ncore_max           = maxmin[0];
801     hwinfo_g->nhwthread_tot       = sum[2];
802     hwinfo_g->nhwthread_min       = -maxmin[6];
803     hwinfo_g->nhwthread_max       = maxmin[1];
804     hwinfo_g->ngpu_compatible_tot = sum[3];
805     hwinfo_g->ngpu_compatible_min = -maxmin[7];
806     hwinfo_g->ngpu_compatible_max = maxmin[2];
807     hwinfo_g->simd_suggest_min    = static_cast<enum gmx_cpuid_simd>(-maxmin[8]);
808     hwinfo_g->simd_suggest_max    = static_cast<enum gmx_cpuid_simd>(maxmin[3]);
809     hwinfo_g->bIdenticalGPUs      = (maxmin[4] == -maxmin[9]);
810 #else
811     /* All ranks use the same pointer, protect it with a mutex */
812     tMPI_Thread_mutex_lock(&hw_info_lock);
813     hwinfo_g->nphysicalnode       = 1;
814     hwinfo_g->ncore_tot           = hwinfo_g->ncore;
815     hwinfo_g->ncore_min           = hwinfo_g->ncore;
816     hwinfo_g->ncore_max           = hwinfo_g->ncore;
817     hwinfo_g->nhwthread_tot       = hwinfo_g->nthreads_hw_avail;
818     hwinfo_g->nhwthread_min       = hwinfo_g->nthreads_hw_avail;
819     hwinfo_g->nhwthread_max       = hwinfo_g->nthreads_hw_avail;
820     hwinfo_g->ngpu_compatible_tot = hwinfo_g->gpu_info.n_dev_compatible;
821     hwinfo_g->ngpu_compatible_min = hwinfo_g->gpu_info.n_dev_compatible;
822     hwinfo_g->ngpu_compatible_max = hwinfo_g->gpu_info.n_dev_compatible;
823     hwinfo_g->simd_suggest_min    = gmx_cpuid_simd_suggest(hwinfo_g->cpuid_info);
824     hwinfo_g->simd_suggest_max    = gmx_cpuid_simd_suggest(hwinfo_g->cpuid_info);
825     hwinfo_g->bIdenticalGPUs      = TRUE;
826     tMPI_Thread_mutex_unlock(&hw_info_lock);
827 #endif
828 }
829
830 gmx_hw_info_t *gmx_detect_hardware(FILE *fplog, const t_commrec *cr,
831                                    gmx_bool bDetectGPUs)
832 {
833     int ret;
834
835     /* make sure no one else is doing the same thing */
836     ret = tMPI_Thread_mutex_lock(&hw_info_lock);
837     if (ret != 0)
838     {
839         gmx_fatal(FARGS, "Error locking hwinfo mutex: %s", strerror(errno));
840     }
841
842     /* only initialize the hwinfo structure if it is not already initalized */
843     if (n_hwinfo == 0)
844     {
845         snew(hwinfo_g, 1);
846
847         /* detect CPUID info; no fuss, we don't detect system-wide
848          * -- sloppy, but that's it for now */
849         if (gmx_cpuid_init(&hwinfo_g->cpuid_info) != 0)
850         {
851             gmx_fatal_collective(FARGS, cr, NULL, "CPUID detection failed!");
852         }
853
854         /* get the number of cores, will be 0 when not detected */
855         hwinfo_g->ncore             = get_ncores(hwinfo_g->cpuid_info);
856
857         /* detect number of hardware threads */
858         hwinfo_g->nthreads_hw_avail = get_nthreads_hw_avail(fplog, cr);
859
860         /* detect GPUs */
861         hwinfo_g->gpu_info.n_dev            = 0;
862         hwinfo_g->gpu_info.n_dev_compatible = 0;
863         hwinfo_g->gpu_info.gpu_dev          = NULL;
864
865         /* Run the detection if the binary was compiled with GPU support
866          * and we requested detection.
867          */
868         hwinfo_g->gpu_info.bDetectGPUs =
869             (bGPUBinary && bDetectGPUs &&
870              getenv("GMX_DISABLE_GPU_DETECTION") == NULL);
871         if (hwinfo_g->gpu_info.bDetectGPUs)
872         {
873             gmx_detect_gpus(fplog, cr);
874         }
875     }
876     /* increase the reference counter */
877     n_hwinfo++;
878
879     ret = tMPI_Thread_mutex_unlock(&hw_info_lock);
880     if (ret != 0)
881     {
882         gmx_fatal(FARGS, "Error unlocking hwinfo mutex: %s", strerror(errno));
883     }
884
885     gmx_collect_hardware_mpi();
886
887     return hwinfo_g;
888 }
889
890 static std::string detected_hardware_string(const gmx_hw_info_t *hwinfo,
891                                             bool                 bFullCpuInfo)
892 {
893     std::string s;
894
895     s  = gmx::formatString("\n");
896     s += gmx::formatString("Running on %d node%s with total",
897                            hwinfo->nphysicalnode,
898                            hwinfo->nphysicalnode == 1 ? "" : "s");
899     if (hwinfo->ncore_tot > 0)
900     {
901         s += gmx::formatString(" %d cores,", hwinfo->ncore_tot);
902     }
903     s += gmx::formatString(" %d logical cores", hwinfo->nhwthread_tot);
904     if (hwinfo->gpu_info.bDetectGPUs)
905     {
906         s += gmx::formatString(", %d compatible GPU%s",
907                                hwinfo->ngpu_compatible_tot,
908                                hwinfo->ngpu_compatible_tot == 1 ? "" : "s");
909     }
910     else if (bGPUBinary)
911     {
912         s += gmx::formatString(" (GPU detection deactivated)");
913     }
914     s += gmx::formatString("\n");
915
916     if (hwinfo->nphysicalnode > 1)
917     {
918         /* Print per node hardware feature counts */
919         if (hwinfo->ncore_max > 0)
920         {
921             s += gmx::formatString("  Cores per node:           %2d", hwinfo->ncore_min);
922             if (hwinfo->ncore_max > hwinfo->ncore_min)
923             {
924                 s += gmx::formatString(" - %2d", hwinfo->ncore_max);
925             }
926             s += gmx::formatString("\n");
927         }
928         s += gmx::formatString("  Logical cores per node:   %2d", hwinfo->nhwthread_min);
929         if (hwinfo->nhwthread_max > hwinfo->nhwthread_min)
930         {
931             s += gmx::formatString(" - %2d", hwinfo->nhwthread_max);
932         }
933         s += gmx::formatString("\n");
934         if (bGPUBinary)
935         {
936             s += gmx::formatString("  Compatible GPUs per node: %2d",
937                                    hwinfo->ngpu_compatible_min);
938             if (hwinfo->ngpu_compatible_max > hwinfo->ngpu_compatible_min)
939             {
940                 s += gmx::formatString(" - %2d", hwinfo->ngpu_compatible_max);
941             }
942             s += gmx::formatString("\n");
943             if (hwinfo->ngpu_compatible_tot > 0)
944             {
945                 if (hwinfo->bIdenticalGPUs)
946                 {
947                     s += gmx::formatString("  All nodes have identical type(s) of GPUs\n");
948                 }
949                 else
950                 {
951                     /* This message will also appear with identical GPU types
952                      * when at least one node has no GPU.
953                      */
954                     s += gmx::formatString("  Different nodes have different type(s) and/or order of GPUs\n");
955                 }
956             }
957         }
958     }
959
960 #ifdef GMX_LIB_MPI
961     char host[HOSTNAMELEN];
962     int  rank;
963
964     gmx_gethostname(host, HOSTNAMELEN);
965     MPI_Comm_rank(MPI_COMM_WORLD, &rank);
966
967     s += gmx::formatString("Hardware detected on host %s (the node of MPI rank %d):\n",
968                            host, rank);
969 #else
970     s += gmx::formatString("Hardware detected:\n");
971 #endif
972     s += gmx::formatString("  CPU info:\n");
973     if (bFullCpuInfo)
974     {
975         char buf[1024];
976
977         gmx_cpuid_formatstring(hwinfo->cpuid_info, buf, 1023);
978         buf[1023] = '\0';
979
980         s += gmx::formatString("%s", buf);
981     }
982     else
983     {
984         s += gmx::formatString("    Vendor: %s\n",
985                                gmx_cpuid_vendor_string[gmx_cpuid_vendor(hwinfo->cpuid_info)]);
986         s += gmx::formatString("    Brand:  %s\n",
987                                gmx_cpuid_brand(hwinfo->cpuid_info));
988     }
989     s += gmx::formatString("    SIMD instructions most likely to fit this hardware: %s",
990                            gmx_cpuid_simd_string[hwinfo->simd_suggest_min]);
991     if (hwinfo->simd_suggest_max > hwinfo->simd_suggest_min)
992     {
993         s += gmx::formatString(" - %s",
994                                gmx_cpuid_simd_string[hwinfo->simd_suggest_max]);
995     }
996     s += gmx::formatString("\n");
997     s += gmx::formatString("    SIMD instructions selected at GROMACS compile time: %s\n",
998                            gmx_cpuid_simd_string[gmx_compiled_simd()]);
999     if (bGPUBinary && (hwinfo->ngpu_compatible_tot > 0 ||
1000                        hwinfo->gpu_info.n_dev > 0))
1001     {
1002         s += gmx::formatString("  GPU info:\n");
1003         s += gmx::formatString("    Number of GPUs detected: %d\n",
1004                                hwinfo->gpu_info.n_dev);
1005         if (hwinfo->gpu_info.n_dev > 0)
1006         {
1007             char buf[STRLEN];
1008
1009             sprint_gpus(buf, &hwinfo->gpu_info);
1010             s += gmx::formatString("%s\n", buf);
1011         }
1012     }
1013
1014     return s;
1015 }
1016
1017 void gmx_print_detected_hardware(FILE *fplog, const t_commrec *cr,
1018                                  const gmx_hw_info_t *hwinfo)
1019 {
1020     if (fplog != NULL)
1021     {
1022         std::string detected;
1023
1024         detected = detected_hardware_string(hwinfo, TRUE);
1025
1026         fprintf(fplog, "%s\n", detected.c_str());
1027     }
1028
1029     if (MULTIMASTER(cr))
1030     {
1031         std::string detected;
1032
1033         detected = detected_hardware_string(hwinfo, FALSE);
1034
1035         fprintf(stderr, "%s\n", detected.c_str());
1036     }
1037
1038     /* Check the compiled SIMD instruction set against that of the node
1039      * with the lowest SIMD level support.
1040      */
1041     gmx_cpuid_simd_check(hwinfo->simd_suggest_min, fplog, MULTIMASTER(cr));
1042
1043     /* For RDTSCP we only check on our local node and skip the MPI reduction */
1044     check_use_of_rdtscp_on_this_cpu(fplog, cr, hwinfo);
1045 }
1046
1047 void gmx_parse_gpu_ids(gmx_gpu_opt_t *gpu_opt)
1048 {
1049     char *env;
1050
1051     if (gpu_opt->gpu_id != NULL && !bGPUBinary)
1052     {
1053         gmx_fatal(FARGS, "GPU ID string set, but %s was compiled without GPU support!", ShortProgram());
1054     }
1055
1056     env = getenv("GMX_GPU_ID");
1057     if (env != NULL && gpu_opt->gpu_id != NULL)
1058     {
1059         gmx_fatal(FARGS, "GMX_GPU_ID and -gpu_id can not be used at the same time");
1060     }
1061     if (env == NULL)
1062     {
1063         env = gpu_opt->gpu_id;
1064     }
1065
1066     /* parse GPU IDs if the user passed any */
1067     if (env != NULL)
1068     {
1069         /* Parse a "plain" GPU ID string which contains a sequence of
1070          * digits corresponding to GPU IDs; the order will indicate
1071          * the process/tMPI thread - GPU assignment. */
1072         parse_digits_from_plain_string(env,
1073                                        &gpu_opt->n_dev_use,
1074                                        &gpu_opt->dev_use);
1075
1076         if (gpu_opt->n_dev_use == 0)
1077         {
1078             gmx_fatal(FARGS, "Empty GPU ID string encountered.\n%s\n",
1079                       invalid_gpuid_hint);
1080         }
1081
1082         gpu_opt->bUserSet = TRUE;
1083     }
1084 }
1085
1086 void gmx_select_gpu_ids(FILE *fplog, const t_commrec *cr,
1087                         const gmx_gpu_info_t *gpu_info,
1088                         gmx_bool bForceUseGPU,
1089                         gmx_gpu_opt_t *gpu_opt)
1090 {
1091     int              i;
1092     char             sbuf[STRLEN], stmp[STRLEN];
1093
1094     /* Bail if binary is not compiled with GPU acceleration, but this is either
1095      * explicitly (-nb gpu) or implicitly (gpu ID passed) requested. */
1096     if (bForceUseGPU && !bGPUBinary)
1097     {
1098         gmx_fatal(FARGS, "GPU acceleration requested, but %s was compiled without GPU support!", ShortProgram());
1099     }
1100
1101     if (!(cr->duty & DUTY_PP))
1102     {
1103         /* Our rank is not doing PP, we don't use a GPU */
1104         return;
1105     }
1106
1107     if (gpu_opt->bUserSet)
1108     {
1109         /* Check the GPU IDs passed by the user.
1110          * (GPU IDs have been parsed by gmx_parse_gpu_ids before)
1111          */
1112         int *checkres;
1113         int  res;
1114
1115         snew(checkres, gpu_opt->n_dev_use);
1116
1117         res = check_selected_gpus(checkres, gpu_info, gpu_opt);
1118
1119         if (!res)
1120         {
1121             print_gpu_detection_stats(fplog, gpu_info, cr);
1122
1123             sprintf(sbuf, "Some of the requested GPUs do not exist, behave strangely, or are not compatible:\n");
1124             for (i = 0; i < gpu_opt->n_dev_use; i++)
1125             {
1126                 if (checkres[i] != egpuCompatible)
1127                 {
1128                     sprintf(stmp, "    GPU #%d: %s\n",
1129                             gpu_opt->dev_use[i],
1130                             gpu_detect_res_str[checkres[i]]);
1131                     strcat(sbuf, stmp);
1132                 }
1133             }
1134             gmx_fatal(FARGS, "%s", sbuf);
1135         }
1136
1137         sfree(checkres);
1138     }
1139     else if (getenv("GMX_EMULATE_GPU") == NULL)
1140     {
1141         pick_compatible_gpus(&hwinfo_g->gpu_info, gpu_opt);
1142         set_gpu_ids(gpu_opt, cr->nrank_pp_intranode, cr->rank_pp_intranode);
1143     }
1144
1145     /* If the user asked for a GPU, check whether we have a GPU */
1146     if (bForceUseGPU && gpu_info->n_dev_compatible == 0)
1147     {
1148         gmx_fatal(FARGS, "GPU acceleration requested, but no compatible GPUs were detected.");
1149     }
1150 }
1151
1152 /* Select the GPUs we will use. This is an operation local to each physical
1153  * node. If we have less MPI ranks than GPUs, we will waste some GPUs.
1154  * nrank and rank are the rank count and id for PP processes in our node.
1155  */
1156 static void set_gpu_ids(gmx_gpu_opt_t *gpu_opt, int nrank, int rank)
1157 {
1158     GMX_RELEASE_ASSERT(gpu_opt, "Invalid gpu_opt pointer passed");
1159     GMX_RELEASE_ASSERT(nrank >= 1,
1160                        gmx::formatString("Invalid limit (%d) for the number of GPUs (detected %d compatible GPUs)",
1161                                          rank, gpu_opt->n_dev_compatible).c_str());
1162
1163     if (gpu_opt->n_dev_compatible == 0)
1164     {
1165         char host[HOSTNAMELEN];
1166
1167         gmx_gethostname(host, HOSTNAMELEN);
1168         gmx_fatal(FARGS, "A GPU was requested on host %s, but no compatible GPUs were detected. All nodes with PP ranks need to have GPUs. If you intended to use GPU acceleration in a parallel run, you can either avoid using the nodes that don't have GPUs or place PME ranks on these nodes.", host);
1169     }
1170
1171     int nshare;
1172
1173     nshare = 1;
1174     if (nrank > gpu_opt->n_dev_compatible)
1175     {
1176         if (nrank % gpu_opt->n_dev_compatible == 0)
1177         {
1178             nshare = nrank/gpu_opt->n_dev_compatible;
1179         }
1180         else
1181         {
1182             if (rank == 0)
1183             {
1184                 gmx_fatal(FARGS, "The number of MPI ranks (%d) in a physical node is not a multiple of the number of GPUs (%d). Select a different number of MPI ranks or use the -gpu_id option to manually specify the GPU to be used.",
1185                           nrank, gpu_opt->n_dev_compatible);
1186             }
1187
1188 #ifdef GMX_MPI
1189             /* We use a global barrier to prevent ranks from continuing with
1190              * an invalid setup.
1191              */
1192             MPI_Barrier(MPI_COMM_WORLD);
1193 #endif
1194         }
1195     }
1196
1197     /* Here we will waste GPUs when nrank < gpu_opt->n_dev_compatible */
1198     gpu_opt->n_dev_use = std::min(gpu_opt->n_dev_compatible*nshare, nrank);
1199     snew(gpu_opt->dev_use, gpu_opt->n_dev_use);
1200     for (int i = 0; i != gpu_opt->n_dev_use; ++i)
1201     {
1202         /* TODO: improve this implementation: either sort GPUs or remove the weakest here */
1203         gpu_opt->dev_use[i] = gpu_opt->dev_compatible[i/nshare];
1204     }
1205 }
1206
1207 void gmx_hardware_info_free(gmx_hw_info_t *hwinfo)
1208 {
1209     int ret;
1210
1211     ret = tMPI_Thread_mutex_lock(&hw_info_lock);
1212     if (ret != 0)
1213     {
1214         gmx_fatal(FARGS, "Error locking hwinfo mutex: %s", strerror(errno));
1215     }
1216
1217     /* decrease the reference counter */
1218     n_hwinfo--;
1219
1220
1221     if (hwinfo != hwinfo_g)
1222     {
1223         gmx_incons("hwinfo < hwinfo_g");
1224     }
1225
1226     if (n_hwinfo < 0)
1227     {
1228         gmx_incons("n_hwinfo < 0");
1229     }
1230
1231     if (n_hwinfo == 0)
1232     {
1233         gmx_cpuid_done(hwinfo_g->cpuid_info);
1234         free_gpu_info(&hwinfo_g->gpu_info);
1235         sfree(hwinfo_g);
1236     }
1237
1238     ret = tMPI_Thread_mutex_unlock(&hw_info_lock);
1239     if (ret != 0)
1240     {
1241         gmx_fatal(FARGS, "Error unlocking hwinfo mutex: %s", strerror(errno));
1242     }
1243 }