src/gromacs/hardware/printhardware.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014,2015,2016 by the GROMACS development team.
   5  * Copyright (c) 2017,2018,2019,2020, by the GROMACS development team, led by
   6  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   7  * and including many others, as listed in the AUTHORS file in the
   8  * top-level source directory and at http://www.gromacs.org.
   9  *
  10  * GROMACS is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Lesser General Public License
  12  * as published by the Free Software Foundation; either version 2.1
  13  * of the License, or (at your option) any later version.
  14  *
  15  * GROMACS is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public
  21  * License along with GROMACS; if not, see
  22  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  23  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  24  *
  25  * If you want to redistribute modifications to GROMACS, please
  26  * consider that scientific software is very special. Version
  27  * control is crucial - bugs must be traceable. We will be happy to
  28  * consider code for inclusion in the official distribution, but
  29  * derived work must not be called official GROMACS. Details are found
  30  * in the README & COPYING files - if they are missing, get the
  31  * official version at http://www.gromacs.org.
  32  *
  33  * To help us fund GROMACS development, we humbly ask that you cite
  34  * the research papers on the package. Check out http://www.gromacs.org.
  35  */
  36 #include "gmxpre.h"
  37
  38 #include "printhardware.h"
  39
  40 #include "config.h"
  41
  42 #include <cstdlib>
  43
  44 #include <string>
  45 #include <vector>
  46
  47 #include "gromacs/hardware/cpuinfo.h"
  48 #include "gromacs/hardware/device_management.h"
  49 #include "gromacs/hardware/hardwaretopology.h"
  50 #include "gromacs/hardware/hw_info.h"
  51 #include "gromacs/hardware/identifyavx512fmaunits.h"
  52 #include "gromacs/simd/support.h"
  53 #include "gromacs/utility/basedefinitions.h"
  54 #include "gromacs/utility/basenetwork.h"
  55 #include "gromacs/utility/cstringutil.h"
  56 #include "gromacs/utility/fatalerror.h"
  57 #include "gromacs/utility/gmxmpi.h"
  58 #include "gromacs/utility/logger.h"
  59 #include "gromacs/utility/programcontext.h"
  60 #include "gromacs/utility/stringutil.h"
  61 #include "gromacs/utility/sysinfo.h"
  62
  63 //! Constant used to help minimize preprocessed code
  64 static constexpr bool bGPUBinary = (GMX_GPU != 0);
  65
  66 /*! \internal \brief
  67  * Returns the GPU information text, one GPU per line.
  68  */
  69 static std::string sprint_gpus(const gmx_gpu_info_t& gpu_info)
  70 {
  71     char                     stmp[STRLEN];
  72     std::vector<std::string> gpuStrings;
  73     for (int i = 0; i < gpu_info.n_dev; i++)
  74     {
  75         get_gpu_device_info_string(stmp, gpu_info, i);
  76         gpuStrings.push_back(gmx::formatString("    %s", stmp));
  77     }
  78     return gmx::joinStrings(gpuStrings, "\n");
  79 }
  80
  81 /* Give a suitable fatal error or warning if the build configuration
  82    and runtime CPU do not match. */
  83 static void check_use_of_rdtscp_on_this_cpu(const gmx::MDLogger& mdlog, const gmx::CpuInfo& cpuInfo)
  84 {
  85     bool binaryUsesRdtscp = GMX_USE_RDTSCP;
  86
  87     const char* programName = gmx::getProgramContext().displayName();
  88
  89     if (cpuInfo.supportLevel() < gmx::CpuInfo::SupportLevel::Features)
  90     {
  91         if (binaryUsesRdtscp)
  92         {
  93             GMX_LOG(mdlog.warning)
  94                     .asParagraph()
  95                     .appendTextFormatted(
  96                             "The %s executable was compiled to use the rdtscp CPU instruction. "
  97                             "We cannot detect the features of your current CPU, but will proceed "
  98                             "anyway. "
  99                             "If you get a crash, rebuild GROMACS with the GMX_USE_RDTSCP=OFF CMake "
 100                             "option.",
 101                             programName);
 102         }
 103     }
 104     else
 105     {
 106         bool cpuHasRdtscp = cpuInfo.feature(gmx::CpuInfo::Feature::X86_Rdtscp);
 107
 108         if (!cpuHasRdtscp && binaryUsesRdtscp)
 109         {
 110             gmx_fatal(FARGS,
 111                       "The %s executable was compiled to use the rdtscp CPU instruction. "
 112                       "However, this is not supported by the current hardware and continuing would "
 113                       "lead to a crash. "
 114                       "Please rebuild GROMACS with the GMX_USE_RDTSCP=OFF CMake option.",
 115                       programName);
 116         }
 117
 118         if (cpuHasRdtscp && !binaryUsesRdtscp)
 119         {
 120             GMX_LOG(mdlog.warning)
 121                     .asParagraph()
 122                     .appendTextFormatted(
 123                             "The current CPU can measure timings more accurately than the code in\n"
 124                             "%s was configured to use. This might affect your simulation\n"
 125                             "speed as accurate timings are needed for load-balancing.\n"
 126                             "Please consider rebuilding %s with the GMX_USE_RDTSCP=ON CMake "
 127                             "option.",
 128                             programName, programName);
 129         }
 130     }
 131 }
 132
 133 static std::string detected_hardware_string(const gmx_hw_info_t* hwinfo, bool bFullCpuInfo)
 134 {
 135     std::string s;
 136
 137     const gmx::CpuInfo&          cpuInfo = *hwinfo->cpuInfo;
 138     const gmx::HardwareTopology& hwTop   = *hwinfo->hardwareTopology;
 139
 140     s = gmx::formatString("\n");
 141     s += gmx::formatString("Running on %d node%s with total", hwinfo->nphysicalnode,
 142                            hwinfo->nphysicalnode == 1 ? "" : "s");
 143     if (hwinfo->ncore_tot > 0)
 144     {
 145         s += gmx::formatString(" %d cores,", hwinfo->ncore_tot);
 146     }
 147     s += gmx::formatString(" %d logical cores", hwinfo->nhwthread_tot);
 148     if (hwinfo->gpu_info.bDetectGPUs)
 149     {
 150         s += gmx::formatString(", %d compatible GPU%s", hwinfo->ngpu_compatible_tot,
 151                                hwinfo->ngpu_compatible_tot == 1 ? "" : "s");
 152     }
 153     else if (bGPUBinary)
 154     {
 155         s += gmx::formatString(" (GPU detection deactivated)");
 156     }
 157     s += gmx::formatString("\n");
 158
 159     if (hwinfo->nphysicalnode > 1)
 160     {
 161         /* Print per node hardware feature counts */
 162         if (hwinfo->ncore_max > 0)
 163         {
 164             s += gmx::formatString("  Cores per node:           %2d", hwinfo->ncore_min);
 165             if (hwinfo->ncore_max > hwinfo->ncore_min)
 166             {
 167                 s += gmx::formatString(" - %2d", hwinfo->ncore_max);
 168             }
 169             s += gmx::formatString("\n");
 170         }
 171         s += gmx::formatString("  Logical cores per node:   %2d", hwinfo->nhwthread_min);
 172         if (hwinfo->nhwthread_max > hwinfo->nhwthread_min)
 173         {
 174             s += gmx::formatString(" - %2d", hwinfo->nhwthread_max);
 175         }
 176         s += gmx::formatString("\n");
 177         if (bGPUBinary)
 178         {
 179             s += gmx::formatString("  Compatible GPUs per node: %2d", hwinfo->ngpu_compatible_min);
 180             if (hwinfo->ngpu_compatible_max > hwinfo->ngpu_compatible_min)
 181             {
 182                 s += gmx::formatString(" - %2d", hwinfo->ngpu_compatible_max);
 183             }
 184             s += gmx::formatString("\n");
 185             if (hwinfo->ngpu_compatible_tot > 0)
 186             {
 187                 if (hwinfo->bIdenticalGPUs)
 188                 {
 189                     s += gmx::formatString("  All nodes have identical type(s) of GPUs\n");
 190                 }
 191                 else
 192                 {
 193                     /* This message will also appear with identical GPU types
 194                      * when at least one node has no GPU.
 195                      */
 196                     s += gmx::formatString(
 197                             "  Different nodes have different type(s) and/or order of GPUs\n");
 198                 }
 199             }
 200         }
 201     }
 202
 203 #if GMX_LIB_MPI
 204     int  rank;
 205     char host[STRLEN];
 206
 207     gmx_gethostname(host, STRLEN);
 208
 209     MPI_Comm_rank(MPI_COMM_WORLD, &rank);
 210
 211     // TODO Use a wrapper around MPI_Get_processor_name instead.
 212     s += gmx::formatString("Hardware detected on host %s (the node of MPI rank %d):\n", host, rank);
 213 #else
 214     s += gmx::formatString("Hardware detected:\n");
 215 #endif
 216     s += gmx::formatString("  CPU info:\n");
 217
 218     s += gmx::formatString("    Vendor: %s\n", cpuInfo.vendorString().c_str());
 219
 220     s += gmx::formatString("    Brand:  %s\n", cpuInfo.brandString().c_str());
 221
 222     if (bFullCpuInfo)
 223     {
 224         s += gmx::formatString("    Family: %d   Model: %d   Stepping: %d\n", cpuInfo.family(),
 225                                cpuInfo.model(), cpuInfo.stepping());
 226
 227         s += gmx::formatString("    Features:");
 228         for (auto& f : cpuInfo.featureSet())
 229         {
 230             s += gmx::formatString(" %s", gmx::CpuInfo::featureString(f).c_str());
 231         }
 232         s += gmx::formatString("\n");
 233     }
 234
 235     if (cpuInfo.feature(gmx::CpuInfo::Feature::X86_Avx512F))
 236     {
 237         int avx512fmaunits = gmx::identifyAvx512FmaUnits();
 238         s += gmx::formatString("    Number of AVX-512 FMA units:");
 239         if (avx512fmaunits > 0)
 240         {
 241             s += gmx::formatString(" %d", avx512fmaunits);
 242             if (avx512fmaunits == 1)
 243             {
 244                 s += gmx::formatString(" (AVX2 is faster w/o 2 AVX-512 FMA units)");
 245             }
 246         }
 247         else
 248         {
 249             s += gmx::formatString(" Cannot run AVX-512 detection - assuming 2");
 250         }
 251         s += gmx::formatString("\n");
 252     }
 253
 254     s += gmx::formatString("  Hardware topology: ");
 255     switch (hwTop.supportLevel())
 256     {
 257         case gmx::HardwareTopology::SupportLevel::None: s += gmx::formatString("None\n"); break;
 258         case gmx::HardwareTopology::SupportLevel::LogicalProcessorCount:
 259             s += gmx::formatString("Only logical processor count\n");
 260             break;
 261         case gmx::HardwareTopology::SupportLevel::Basic: s += gmx::formatString("Basic\n"); break;
 262         case gmx::HardwareTopology::SupportLevel::Full: s += gmx::formatString("Full\n"); break;
 263         case gmx::HardwareTopology::SupportLevel::FullWithDevices:
 264             s += gmx::formatString("Full, with devices\n");
 265             break;
 266     }
 267
 268     if (!hwTop.isThisSystem())
 269     {
 270         s += gmx::formatString("  NOTE: Hardware topology cached or synthetic, not detected.\n");
 271         if (char* p = std::getenv("HWLOC_XMLFILE"))
 272         {
 273             s += gmx::formatString("        HWLOC_XMLFILE=%s\n", p);
 274         }
 275     }
 276
 277     if (bFullCpuInfo)
 278     {
 279         if (hwTop.supportLevel() >= gmx::HardwareTopology::SupportLevel::Basic)
 280         {
 281             s += gmx::formatString("    Sockets, cores, and logical processors:\n");
 282
 283             for (auto& socket : hwTop.machine().sockets)
 284             {
 285                 s += gmx::formatString("      Socket %2d:", socket.id);
 286                 for (auto& c : socket.cores)
 287                 {
 288                     s += gmx::formatString(" [");
 289                     for (auto& t : c.hwThreads)
 290                     {
 291                         s += gmx::formatString(" %3d", t.logicalProcessorId);
 292                     }
 293                     s += gmx::formatString("]");
 294                 }
 295                 s += gmx::formatString("\n");
 296             }
 297         }
 298         if (hwTop.supportLevel() >= gmx::HardwareTopology::SupportLevel::Full)
 299         {
 300             s += gmx::formatString("    Numa nodes:\n");
 301             for (auto& n : hwTop.machine().numa.nodes)
 302             {
 303                 s += gmx::formatString("      Node %2d (%zu bytes mem):", n.id, n.memory);
 304                 for (auto& l : n.logicalProcessorId)
 305                 {
 306                     s += gmx::formatString(" %3d", l);
 307                 }
 308                 s += gmx::formatString("\n");
 309             }
 310             s += gmx::formatString("      Latency:\n          ");
 311             for (std::size_t j = 0; j < hwTop.machine().numa.nodes.size(); j++)
 312             {
 313                 s += gmx::formatString(" %5zu", j);
 314             }
 315             s += gmx::formatString("\n");
 316             for (std::size_t i = 0; i < hwTop.machine().numa.nodes.size(); i++)
 317             {
 318                 s += gmx::formatString("     %5zu", i);
 319                 for (std::size_t j = 0; j < hwTop.machine().numa.nodes.size(); j++)
 320                 {
 321                     s += gmx::formatString(" %5.2f", hwTop.machine().numa.relativeLatency[i][j]);
 322                 }
 323                 s += gmx::formatString("\n");
 324             }
 325
 326
 327             s += gmx::formatString("    Caches:\n");
 328             for (auto& c : hwTop.machine().caches)
 329             {
 330                 s += gmx::formatString(
 331                         "      L%d: %zu bytes, linesize %d bytes, assoc. %d, shared %d ways\n",
 332                         c.level, c.size, c.linesize, c.associativity, c.shared);
 333             }
 334         }
 335         if (hwTop.supportLevel() >= gmx::HardwareTopology::SupportLevel::FullWithDevices)
 336         {
 337             s += gmx::formatString("    PCI devices:\n");
 338             for (auto& d : hwTop.machine().devices)
 339             {
 340                 s += gmx::formatString(
 341                         "      %04x:%02x:%02x.%1x  Id: %04x:%04x  Class: 0x%04x  Numa: %d\n", d.domain,
 342                         d.bus, d.dev, d.func, d.vendorId, d.deviceId, d.classId, d.numaNodeId);
 343             }
 344         }
 345     }
 346
 347     if (bGPUBinary && hwinfo->gpu_info.n_dev > 0)
 348     {
 349         s += gmx::formatString("  GPU info:\n");
 350         s += gmx::formatString("    Number of GPUs detected: %d\n", hwinfo->gpu_info.n_dev);
 351         s += sprint_gpus(hwinfo->gpu_info) + "\n";
 352     }
 353     return s;
 354 }
 355
 356 void gmx_print_detected_hardware(FILE*                fplog,
 357                                  const bool           warnToStdErr,
 358                                  const gmx::MDLogger& mdlog,
 359                                  const gmx_hw_info_t* hwinfo)
 360 {
 361     const gmx::CpuInfo& cpuInfo = *hwinfo->cpuInfo;
 362
 363     if (fplog != nullptr)
 364     {
 365         std::string detected;
 366
 367         detected = detected_hardware_string(hwinfo, TRUE);
 368
 369         fprintf(fplog, "%s\n", detected.c_str());
 370     }
 371
 372     // Do not spam stderr with all our internal information unless
 373     // there was something that actually went wrong; general information
 374     // belongs in the logfile.
 375
 376     /* Check the compiled SIMD instruction set against that of the node
 377      * with the lowest SIMD level support (skip if SIMD detection did not work)
 378      */
 379     if (cpuInfo.supportLevel() >= gmx::CpuInfo::SupportLevel::Features)
 380     {
 381         gmx::simdCheck(static_cast<gmx::SimdType>(hwinfo->simd_suggest_min), fplog, warnToStdErr);
 382     }
 383
 384     /* For RDTSCP we only check on our local node and skip the MPI reduction */
 385     check_use_of_rdtscp_on_this_cpu(mdlog, cpuInfo);
 386 }