src/gromacs/utility/basenetwork.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2004, The GROMACS development team.
   6  * Copyright (c) 2013,2014, by the GROMACS development team, led by
   7  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   8  * and including many others, as listed in the AUTHORS file in the
   9  * top-level source directory and at http://www.gromacs.org.
  10  *
  11  * GROMACS is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU Lesser General Public License
  13  * as published by the Free Software Foundation; either version 2.1
  14  * of the License, or (at your option) any later version.
  15  *
  16  * GROMACS is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * Lesser General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Lesser General Public
  22  * License along with GROMACS; if not, see
  23  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  24  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  25  *
  26  * If you want to redistribute modifications to GROMACS, please
  27  * consider that scientific software is very special. Version
  28  * control is crucial - bugs must be traceable. We will be happy to
  29  * consider code for inclusion in the official distribution, but
  30  * derived work must not be called official GROMACS. Details are found
  31  * in the README & COPYING files - if they are missing, get the
  32  * official version at http://www.gromacs.org.
  33  *
  34  * To help us fund GROMACS development, we humbly ask that you cite
  35  * the research papers on the package. Check out http://www.gromacs.org.
  36  */
  37 #include "gmxpre.h"
  38
  39 #include "basenetwork.h"
  40
  41 #include "config.h"
  42
  43 #include <climits>
  44 #include <cstdio>
  45 #include <cstdlib>
  46 #include <cstring>
  47
  48 #include <exception>
  49
  50 #ifdef HAVE_UNISTD_H
  51 #include <unistd.h>
  52 #endif
  53
  54 #include "gromacs/utility/cstringutil.h"
  55 #include "gromacs/utility/fatalerror.h"
  56 #include "gromacs/utility/gmxmpi.h"
  57 #include "gromacs/utility/programcontext.h"
  58
  59 int gmx_gethostname(char *name, size_t len)
  60 {
  61     if (len < 8)
  62     {
  63         gmx_incons("gmx_gethostname called with len<8");
  64     }
  65 #if defined(HAVE_UNISTD_H) && !defined(__native_client__) && !defined(__MINGW32__)
  66     if (gethostname(name, len-1) != 0)
  67     {
  68         std::strncpy(name, "unknown", 8);
  69         return -1;
  70     }
  71     return 0;
  72 #else
  73     std::strncpy(name, "unknown", 8);
  74     return -1;
  75 #endif
  76 }
  77
  78 gmx_bool gmx_mpi_initialized(void)
  79 {
  80 #ifndef GMX_MPI
  81     return 0;
  82 #else
  83     int n;
  84     MPI_Initialized(&n);
  85
  86     return n;
  87 #endif
  88 }
  89
  90 int gmx_node_num(void)
  91 {
  92 #ifndef GMX_MPI
  93     return 1;
  94 #else
  95 #ifdef GMX_THREAD_MPI
  96     if (!gmx_mpi_initialized())
  97     {
  98         return 1;
  99     }
 100 #endif
 101     int i;
 102     (void) MPI_Comm_size(MPI_COMM_WORLD, &i);
 103     return i;
 104 #endif
 105 }
 106
 107 int gmx_node_rank(void)
 108 {
 109 #ifndef GMX_MPI
 110     return 0;
 111 #else
 112 #ifdef GMX_THREAD_MPI
 113     if (!gmx_mpi_initialized())
 114     {
 115         return 0;
 116     }
 117 #endif
 118     int i;
 119     (void) MPI_Comm_rank(MPI_COMM_WORLD, &i);
 120     return i;
 121 #endif
 122 }
 123
 124 static int mpi_hostname_hash(void)
 125 {
 126     int hash_int;
 127
 128 #ifndef GMX_LIB_MPI
 129     /* We have a single physical node */
 130     hash_int = 0;
 131 #else
 132     int  resultlen;
 133     char mpi_hostname[MPI_MAX_PROCESSOR_NAME];
 134
 135     /* This procedure can only differentiate nodes with different names.
 136      * Architectures where different physical nodes have identical names,
 137      * such as IBM Blue Gene, should use an architecture specific solution.
 138      */
 139     MPI_Get_processor_name(mpi_hostname, &resultlen);
 140
 141     /* The string hash function returns an unsigned int. We cast to an int.
 142      * Negative numbers are converted to positive by setting the sign bit to 0.
 143      * This makes the hash one bit smaller.
 144      * A 63-bit hash (with 64-bit int) should be enough for unique node hashes,
 145      * even on a million node machine. 31 bits might not be enough though!
 146      */
 147     hash_int =
 148         (int)gmx_string_fullhash_func(mpi_hostname, gmx_string_hash_init);
 149     if (hash_int < 0)
 150     {
 151         hash_int -= INT_MIN;
 152     }
 153 #endif
 154
 155     return hash_int;
 156 }
 157
 158 #if defined GMX_LIB_MPI && defined GMX_TARGET_BGQ
 159 #ifdef __clang__
 160 /* IBM's declaration of this function in
 161  * /bgsys/drivers/V1R2M2/ppc64/spi/include/kernel/process.h
 162  * erroneously fails to specify __INLINE__, despite
 163  * /bgsys/drivers/V1R2M2/ppc64/spi/include/kernel/cnk/process_impl.h
 164  * specifiying __INLINE__, so bgclang thinks they are different enough
 165  * to complain about. */
 166 static uint64_t Kernel_GetJobID();
 167 #endif
 168 #include <spi/include/kernel/location.h>
 169
 170 static int bgq_nodenum(void)
 171 {
 172     int           hostnum;
 173     Personality_t personality;
 174     Kernel_GetPersonality(&personality, sizeof(personality));
 175     /* Each MPI rank has a unique coordinate in a 6-dimensional space
 176        (A,B,C,D,E,T), with dimensions A-E corresponding to different
 177        physical nodes, and T within each node. Each node has sixteen
 178        physical cores, each of which can have up to four hardware
 179        threads, so 0 <= T <= 63 (but the maximum value of T depends on
 180        the confituration of ranks and OpenMP threads per
 181        node). However, T is irrelevant for computing a suitable return
 182        value for gmx_hostname_num().
 183      */
 184     hostnum  = personality.Network_Config.Acoord;
 185     hostnum *= personality.Network_Config.Bnodes;
 186     hostnum += personality.Network_Config.Bcoord;
 187     hostnum *= personality.Network_Config.Cnodes;
 188     hostnum += personality.Network_Config.Ccoord;
 189     hostnum *= personality.Network_Config.Dnodes;
 190     hostnum += personality.Network_Config.Dcoord;
 191     hostnum *= personality.Network_Config.Enodes;
 192     hostnum += personality.Network_Config.Ecoord;
 193
 194     if (debug)
 195     {
 196         std::fprintf(debug,
 197                      "Torus ID A: %d / %d B: %d / %d C: %d / %d D: %d / %d E: %d / %d\n"
 198                      "Node ID T: %d / %d core: %d / %d hardware thread: %d / %d\n",
 199                      personality.Network_Config.Acoord,
 200                      personality.Network_Config.Anodes,
 201                      personality.Network_Config.Bcoord,
 202                      personality.Network_Config.Bnodes,
 203                      personality.Network_Config.Ccoord,
 204                      personality.Network_Config.Cnodes,
 205                      personality.Network_Config.Dcoord,
 206                      personality.Network_Config.Dnodes,
 207                      personality.Network_Config.Ecoord,
 208                      personality.Network_Config.Enodes,
 209                      Kernel_ProcessorCoreID(),
 210                      16,
 211                      Kernel_ProcessorID(),
 212                      64,
 213                      Kernel_ProcessorThreadID(),
 214                      4);
 215     }
 216     return hostnum;
 217 }
 218 #endif
 219
 220 int gmx_physicalnode_id_hash(void)
 221 {
 222     int hash;
 223
 224 #ifndef GMX_MPI
 225     hash = 0;
 226 #else
 227 #ifdef GMX_THREAD_MPI
 228     /* thread-MPI currently puts the thread number in the process name,
 229      * we might want to change this, as this is inconsistent with what
 230      * most MPI implementations would do when running on a single node.
 231      */
 232     hash = 0;
 233 #else
 234 #ifdef GMX_TARGET_BGQ
 235     hash = bgq_nodenum();
 236 #else
 237     hash = mpi_hostname_hash();
 238 #endif
 239 #endif
 240 #endif
 241
 242     if (debug)
 243     {
 244         fprintf(debug, "In gmx_physicalnode_id_hash: hash %d\n", hash);
 245     }
 246
 247     return hash;
 248 }
 249
 250 #ifdef GMX_LIB_MPI
 251 void gmx_abort(int errorno)
 252 {
 253     const char *programName = "GROMACS";
 254     try
 255     {
 256         programName = gmx::getProgramContext().displayName();
 257     }
 258     catch (const std::exception &)
 259     {
 260     }
 261     const int nnodes   = gmx_node_num();
 262     const int noderank = gmx_node_rank();
 263     if (nnodes > 1)
 264     {
 265         std::fprintf(stderr, "Halting parallel program %s on rank %d out of %d\n",
 266                      programName, noderank, nnodes);
 267     }
 268     else
 269     {
 270         std::fprintf(stderr, "Halting program %s\n", programName);
 271     }
 272
 273     MPI_Abort(MPI_COMM_WORLD, errorno);
 274     std::exit(errorno);
 275 }
 276 #endif