src/gromacs/mdlib/gmx_omp_nthreads.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014,2015,2016,2017,2018, 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 #include "gmxpre.h"
  37
  38 #include "gmx_omp_nthreads.h"
  39
  40 #include "config.h"
  41
  42 #include <cstdio>
  43 #include <cstdlib>
  44 #include <cstring>
  45
  46 #include "gromacs/gmxlib/network.h"
  47 #include "gromacs/mdtypes/commrec.h"
  48 #include "gromacs/utility/cstringutil.h"
  49 #include "gromacs/utility/fatalerror.h"
  50 #include "gromacs/utility/gmxassert.h"
  51 #include "gromacs/utility/gmxomp.h"
  52 #include "gromacs/utility/logger.h"
  53 #include "gromacs/utility/programcontext.h"
  54
  55 /** Structure with the number of threads for each OpenMP multi-threaded
  56  *  algorithmic module in mdrun. */
  57 typedef struct
  58 {
  59     int      gnth;          /**< Global num. of threads per PP or PP+PME process/tMPI thread. */
  60     int      gnth_pme;      /**< Global num. of threads per PME only process/tMPI thread. */
  61
  62     int      nth[emntNR];   /**< Number of threads for each module, indexed with module_nth_t */
  63     gmx_bool initialized;   /**< TRUE if the module as been initialized. */
  64 } omp_module_nthreads_t;
  65
  66 /** Names of environment variables to set the per module number of threads.
  67  *
  68  *  Indexed with the values of module_nth_t.
  69  * */
  70 static const char *modth_env_var[emntNR] =
  71 {
  72     "GMX_DEFAULT_NUM_THREADS should never be set",
  73     "GMX_DOMDEC_NUM_THREADS", "GMX_PAIRSEARCH_NUM_THREADS",
  74     "GMX_NONBONDED_NUM_THREADS", "GMX_LISTED_FORCES_NUM_THREADS",
  75     "GMX_PME_NUM_THREADS", "GMX_UPDATE_NUM_THREADS",
  76     "GMX_VSITE_NUM_THREADS",
  77     "GMX_LINCS_NUM_THREADS", "GMX_SETTLE_NUM_THREADS"
  78 };
  79
  80 /** Names of the modules. */
  81 static const char *mod_name[emntNR] =
  82 {
  83     "default", "domain decomposition", "pair search", "non-bonded",
  84     "bonded", "PME", "update", "LINCS", "SETTLE"
  85 };
  86
  87 /** Number of threads for each algorithmic module.
  88  *
  89  *  File-scope global variable that gets set once in pick_module_nthreads()
  90  *  and queried via gmx_omp_nthreads_get().
  91  *
  92  *  All fields are initialized to 0 which should result in errors if
  93  *  the init call is omitted.
  94  * */
  95 static omp_module_nthreads_t modth = { 0, 0, {0, 0, 0, 0, 0, 0, 0, 0, 0}, FALSE};
  96
  97
  98 /** Determine the number of threads for module \p mod.
  99  *
 100  *  \p m takes values form the module_nth_t enum and maps these to the
 101  *  corresponding value in modth_env_var.
 102  *
 103  *  Each number of threads per module takes the default value unless
 104  *  GMX_*_NUM_THERADS env var is set, case in which its value overrides
 105  *  the deafult.
 106  *
 107  *  The "group" scheme supports OpenMP only in PME and in thise case all but
 108  *  the PME nthread values default to 1.
 109  */
 110 static void pick_module_nthreads(const gmx::MDLogger &mdlog, int m,
 111                                  gmx_bool bFullOmpSupport,
 112                                  gmx_bool bSepPME)
 113 {
 114     char      *env;
 115     int        nth;
 116
 117     const bool bOMP = GMX_OPENMP;
 118
 119     /* The default should never be set through a GMX_*_NUM_THREADS env var
 120      * as it's always equal with gnth. */
 121     if (m == emntDefault)
 122     {
 123         return;
 124     }
 125
 126     /* check the environment variable */
 127     if ((env = getenv(modth_env_var[m])) != nullptr)
 128     {
 129         sscanf(env, "%d", &nth);
 130
 131         // cppcheck-suppress knownConditionTrueFalse
 132         if (!bOMP)
 133         {
 134             gmx_warning("%s=%d is set, but %s is compiled without OpenMP!",
 135                         modth_env_var[m], nth,
 136                         gmx::getProgramContext().displayName());
 137         }
 138
 139         /* with the verlet codepath, when any GMX_*_NUM_THREADS env var is set,
 140          * OMP_NUM_THREADS also has to be set */
 141         if (bFullOmpSupport && getenv("OMP_NUM_THREADS") == nullptr)
 142         {
 143             gmx_warning("%s=%d is set, the default number of threads also "
 144                         "needs to be set with OMP_NUM_THREADS!",
 145                         modth_env_var[m], nth);
 146         }
 147
 148         /* with the group scheme warn if any env var except PME is set */
 149         if (!bFullOmpSupport)
 150         {
 151             if (m != emntPME)
 152             {
 153                 gmx_warning("%s=%d is set, but OpenMP multithreading is not "
 154                             "supported in %s!",
 155                             modth_env_var[m], nth, mod_name[m]);
 156                 nth = 1;
 157             }
 158         }
 159
 160         /* only babble if we are really overriding with a different value */
 161         if ((bSepPME && m == emntPME && nth != modth.gnth_pme) || (nth != modth.gnth))
 162         {
 163             GMX_LOG(mdlog.warning).asParagraph().appendTextFormatted(
 164                     "%s=%d set, overriding the default number of %s threads",
 165                     modth_env_var[m], nth, mod_name[m]);
 166         }
 167     }
 168     else
 169     {
 170         /* pick the global PME node nthreads if we are setting the number
 171          * of threads in separate PME nodes  */
 172         nth = (bSepPME && m == emntPME) ? modth.gnth_pme : modth.gnth;
 173     }
 174
 175     gmx_omp_nthreads_set(m, nth);
 176 }
 177
 178 void gmx_omp_nthreads_read_env(const gmx::MDLogger &mdlog,
 179                                int                 *nthreads_omp)
 180 {
 181     char    *env;
 182     gmx_bool bCommandLineSetNthreadsOMP = *nthreads_omp > 0;
 183     char     buffer[STRLEN];
 184
 185     GMX_RELEASE_ASSERT(nthreads_omp, "nthreads_omp must be a non-NULL pointer");
 186
 187     if ((env = getenv("OMP_NUM_THREADS")) != nullptr)
 188     {
 189         int nt_omp;
 190
 191         sscanf(env, "%d", &nt_omp);
 192         if (nt_omp <= 0)
 193         {
 194             gmx_fatal(FARGS, "OMP_NUM_THREADS is invalid: '%s'", env);
 195         }
 196
 197         if (bCommandLineSetNthreadsOMP && nt_omp != *nthreads_omp)
 198         {
 199             gmx_fatal(FARGS, "Environment variable OMP_NUM_THREADS (%d) and the number of threads requested on the command line (%d) have different values. Either omit one, or set them both to the same value.", nt_omp, *nthreads_omp);
 200         }
 201
 202         /* Setting the number of OpenMP threads. */
 203         *nthreads_omp = nt_omp;
 204
 205         /* Output the results */
 206         sprintf(buffer,
 207                 "\nThe number of OpenMP threads was set by environment variable OMP_NUM_THREADS to %d%s\n\n",
 208                 nt_omp,
 209                 bCommandLineSetNthreadsOMP ? " (and the command-line setting agreed with that)" : "");
 210
 211         /* This prints once per simulation for multi-simulations,
 212          * which might help diagnose issues with inhomogenous
 213          * cluster setups. */
 214         GMX_LOG(mdlog.info).appendTextFormatted(buffer);
 215         if (debug)
 216         {
 217             /* This prints once per process for real MPI (i.e. once
 218              * per debug file), and once per simulation for thread MPI
 219              * (because of logic in the calling function). */
 220             fputs(buffer, debug);
 221         }
 222     }
 223 }
 224
 225 /*! \brief Helper function for parsing various input about the number
 226     of OpenMP threads to use in various modules and deciding what to
 227     do about it. */
 228 static void manage_number_of_openmp_threads(const gmx::MDLogger &mdlog,
 229                                             const t_commrec     *cr,
 230                                             bool                 bOMP,
 231                                             int                  nthreads_hw_avail,
 232                                             int                  omp_nthreads_req,
 233                                             int                  omp_nthreads_pme_req,
 234                                             gmx_bool gmx_unused  bThisNodePMEOnly,
 235                                             gmx_bool             bFullOmpSupport,
 236                                             int                  numRanksOnThisNode,
 237                                             gmx_bool             bSepPME)
 238 {
 239     int      nth;
 240     char    *env;
 241
 242 #if GMX_THREAD_MPI
 243     /* modth is shared among tMPI threads, so for thread safety, the
 244      * detection is done on the master only. It is not thread-safe
 245      * with multiple simulations, but that's anyway not supported by
 246      * tMPI. */
 247     if (!SIMMASTER(cr))
 248     {
 249         return;
 250     }
 251 #else
 252     GMX_UNUSED_VALUE(cr);
 253 #endif
 254
 255     if (modth.initialized)
 256     {
 257         /* Just return if the initialization has already been
 258            done. This could only happen if gmx_omp_nthreads_init() has
 259            already been called. */
 260         return;
 261     }
 262
 263     /* With full OpenMP support (verlet scheme) set the number of threads
 264      * per process / default:
 265      * - 1 if not compiled with OpenMP or
 266      * - OMP_NUM_THREADS if the env. var is set, or
 267      * - omp_nthreads_req = #of threads requested by the user on the mdrun
 268      *   command line, otherwise
 269      * - take the max number of available threads and distribute them
 270      *   on the processes/tMPI threads.
 271      * ~ The GMX_*_NUM_THREADS env var overrides the number of threads of
 272      *   the respective module and it has to be used in conjunction with
 273      *   OMP_NUM_THREADS.
 274      *
 275      * With the group scheme OpenMP multithreading is only supported in PME,
 276      * for all other modules nthreads is set to 1.
 277      * The number of PME threads is equal to:
 278      * - 1 if not compiled with OpenMP or
 279      * - GMX_PME_NUM_THREADS if defined, otherwise
 280      * - OMP_NUM_THREADS if defined, otherwise
 281      * - 1
 282      */
 283     nth = 1;
 284     if ((env = getenv("OMP_NUM_THREADS")) != nullptr)
 285     {
 286         if (!bOMP && (std::strncmp(env, "1", 1) != 0))
 287         {
 288             gmx_warning("OMP_NUM_THREADS is set, but %s was compiled without OpenMP support!",
 289                         gmx::getProgramContext().displayName());
 290         }
 291         else
 292         {
 293             nth = gmx_omp_get_max_threads();
 294         }
 295     }
 296     else if (omp_nthreads_req > 0)
 297     {
 298         nth = omp_nthreads_req;
 299     }
 300     else if (bFullOmpSupport && bOMP)
 301     {
 302         /* max available threads per node */
 303         nth = nthreads_hw_avail;
 304
 305         /* divide the threads among the MPI ranks */
 306         if (nth >= numRanksOnThisNode)
 307         {
 308             nth /= numRanksOnThisNode;
 309         }
 310         else
 311         {
 312             nth = 1;
 313         }
 314     }
 315
 316     /* now we have the global values, set them:
 317      * - 1 if not compiled with OpenMP and for the group scheme
 318      * - nth for the verlet scheme when compiled with OpenMP
 319      */
 320     if (bFullOmpSupport && bOMP)
 321     {
 322         modth.gnth = nth;
 323     }
 324     else
 325     {
 326         modth.gnth = 1;
 327     }
 328
 329     if (bSepPME)
 330     {
 331         if (omp_nthreads_pme_req > 0)
 332         {
 333             modth.gnth_pme = omp_nthreads_pme_req;
 334         }
 335         else
 336         {
 337             modth.gnth_pme = nth;
 338         }
 339     }
 340     else
 341     {
 342         modth.gnth_pme = 0;
 343     }
 344
 345     /* now set the per-module values */
 346     modth.nth[emntDefault] = modth.gnth;
 347     pick_module_nthreads(mdlog, emntDomdec, bFullOmpSupport, bSepPME);
 348     pick_module_nthreads(mdlog, emntPairsearch, bFullOmpSupport, bSepPME);
 349     pick_module_nthreads(mdlog, emntNonbonded, bFullOmpSupport, bSepPME);
 350     pick_module_nthreads(mdlog, emntBonded, bFullOmpSupport, bSepPME);
 351     pick_module_nthreads(mdlog, emntPME, bFullOmpSupport, bSepPME);
 352     pick_module_nthreads(mdlog, emntUpdate, bFullOmpSupport, bSepPME);
 353     pick_module_nthreads(mdlog, emntVSITE, bFullOmpSupport, bSepPME);
 354     pick_module_nthreads(mdlog, emntLINCS, bFullOmpSupport, bSepPME);
 355     pick_module_nthreads(mdlog, emntSETTLE, bFullOmpSupport, bSepPME);
 356
 357     /* set the number of threads globally */
 358     if (bOMP)
 359     {
 360 #if !GMX_THREAD_MPI
 361         if (bThisNodePMEOnly)
 362         {
 363             gmx_omp_set_num_threads(modth.gnth_pme);
 364         }
 365         else
 366 #endif      /* GMX_THREAD_MPI */
 367         {
 368             if (bFullOmpSupport)
 369             {
 370                 gmx_omp_set_num_threads(nth);
 371             }
 372             else
 373             {
 374                 gmx_omp_set_num_threads(1);
 375             }
 376         }
 377     }
 378
 379     modth.initialized = TRUE;
 380 }
 381
 382 /*! \brief Report on the OpenMP settings that will be used */
 383 static void
 384 reportOpenmpSettings(const gmx::MDLogger &mdlog,
 385                      const t_commrec     *cr,
 386                      gmx_bool             bOMP,
 387                      gmx_bool             bFullOmpSupport,
 388                      gmx_bool             bSepPME)
 389 {
 390 #if GMX_THREAD_MPI
 391     const char *mpi_str = "per tMPI thread";
 392 #else
 393     const char *mpi_str = "per MPI process";
 394 #endif
 395     int         nth_min, nth_max, nth_pme_min, nth_pme_max;
 396
 397     /* inform the user about the settings */
 398     if (!bOMP)
 399     {
 400         return;
 401     }
 402
 403 #if GMX_MPI
 404     if (cr->nnodes + cr->npmenodes > 1)
 405     {
 406         /* Get the min and max thread counts over the MPI ranks */
 407         int buf_in[4], buf_out[4];
 408
 409         buf_in[0] = -modth.gnth;
 410         buf_in[1] =  modth.gnth;
 411         buf_in[2] = -modth.gnth_pme;
 412         buf_in[3] =  modth.gnth_pme;
 413
 414         MPI_Allreduce(buf_in, buf_out, 4, MPI_INT, MPI_MAX, cr->mpi_comm_mysim);
 415
 416         nth_min     = -buf_out[0];
 417         nth_max     =  buf_out[1];
 418         nth_pme_min = -buf_out[2];
 419         nth_pme_max =  buf_out[3];
 420     }
 421     else
 422 #endif
 423     {
 424         nth_min     = modth.gnth;
 425         nth_max     = modth.gnth;
 426         nth_pme_min = modth.gnth_pme;
 427         nth_pme_max = modth.gnth_pme;
 428     }
 429
 430     /* for group scheme we print PME threads info only */
 431     if (bFullOmpSupport)
 432     {
 433         if (nth_max == nth_min)
 434         {
 435             GMX_LOG(mdlog.warning).appendTextFormatted(
 436                     "Using %d OpenMP thread%s %s",
 437                     nth_min, nth_min > 1 ? "s" : "",
 438                     cr->nnodes > 1 ? mpi_str : "");
 439         }
 440         else
 441         {
 442             GMX_LOG(mdlog.warning).appendTextFormatted(
 443                     "Using %d - %d OpenMP threads %s",
 444                     nth_min, nth_max, mpi_str);
 445         }
 446     }
 447     if (bSepPME && (nth_pme_min != nth_min || nth_pme_max != nth_max))
 448     {
 449         if (nth_pme_max == nth_pme_min)
 450         {
 451             GMX_LOG(mdlog.warning).appendTextFormatted(
 452                     "Using %d OpenMP thread%s %s for PME",
 453                     nth_pme_min, nth_pme_min > 1 ? "s" : "",
 454                     cr->nnodes > 1 ? mpi_str : "");
 455         }
 456         else
 457         {
 458             GMX_LOG(mdlog.warning).appendTextFormatted(
 459                     "Using %d - %d OpenMP threads %s for PME",
 460                     nth_pme_min, nth_pme_max, mpi_str);
 461         }
 462     }
 463     GMX_LOG(mdlog.warning);
 464 }
 465
 466 void gmx_omp_nthreads_init(const gmx::MDLogger &mdlog, t_commrec *cr,
 467                            int nthreads_hw_avail,
 468                            int numRanksOnThisNode,
 469                            int omp_nthreads_req,
 470                            int omp_nthreads_pme_req,
 471                            gmx_bool bThisNodePMEOnly,
 472                            gmx_bool bFullOmpSupport)
 473 {
 474     gmx_bool   bSepPME;
 475
 476     const bool bOMP = GMX_OPENMP;
 477
 478     bSepPME = (thisRankHasDuty(cr, DUTY_PP) != thisRankHasDuty(cr, DUTY_PME));
 479
 480     manage_number_of_openmp_threads(mdlog, cr, bOMP,
 481                                     nthreads_hw_avail,
 482                                     omp_nthreads_req, omp_nthreads_pme_req,
 483                                     bThisNodePMEOnly, bFullOmpSupport,
 484                                     numRanksOnThisNode, bSepPME);
 485 #if GMX_THREAD_MPI
 486     /* Non-master threads have to wait for the OpenMP management to be
 487      * done, so that code elsewhere that uses OpenMP can be certain
 488      * the setup is complete. */
 489     if (PAR(cr))
 490     {
 491         MPI_Barrier(cr->mpi_comm_mysim);
 492     }
 493 #endif
 494
 495     reportOpenmpSettings(mdlog, cr, bOMP, bFullOmpSupport, bSepPME);
 496 }
 497
 498 int gmx_omp_nthreads_get(int mod)
 499 {
 500     if (mod < 0 || mod >= emntNR)
 501     {
 502         /* invalid module queried */
 503         return -1;
 504     }
 505     else
 506     {
 507         return modth.nth[mod];
 508     }
 509 }
 510
 511 void
 512 gmx_omp_nthreads_set(int mod, int nthreads)
 513 {
 514     /* Catch an attempt to set the number of threads on an invalid
 515      * OpenMP module. */
 516     GMX_RELEASE_ASSERT(mod >= 0 && mod < emntNR, "Trying to set nthreads on invalid OpenMP module");
 517
 518     modth.nth[mod] = nthreads;
 519 }