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 std::vector<std::unique_ptr<DeviceInformation>>& deviceInfoList)
  70 {
  71     std::vector<std::string> gpuStrings(0);
  72     for (const auto& deviceInfo : deviceInfoList)
  73     {
  74         gpuStrings.emplace_back("    " + getDeviceInformationString(*deviceInfo));
  75     }
  76     return gmx::joinStrings(gpuStrings, "\n");
  77 }
  78
  79 /* Give a suitable fatal error or warning if the build configuration
  80    and runtime CPU do not match. */
  81 static void check_use_of_rdtscp_on_this_cpu(const gmx::MDLogger& mdlog, const gmx::CpuInfo& cpuInfo)
  82 {
  83     bool binaryUsesRdtscp = GMX_USE_RDTSCP;
  84
  85     const char* programName = gmx::getProgramContext().displayName();
  86
  87     if (cpuInfo.supportLevel() < gmx::CpuInfo::SupportLevel::Features)
  88     {
  89         if (binaryUsesRdtscp)
  90         {
  91             GMX_LOG(mdlog.warning)
  92                     .asParagraph()
  93                     .appendTextFormatted(
  94                             "The %s executable was compiled to use the rdtscp CPU instruction. "
  95                             "We cannot detect the features of your current CPU, but will proceed "
  96                             "anyway. "
  97                             "If you get a crash, rebuild GROMACS with the GMX_USE_RDTSCP=OFF CMake "
  98                             "option.",
  99                             programName);
 100         }
 101     }
 102     else
 103     {
 104         bool cpuHasRdtscp = cpuInfo.feature(gmx::CpuInfo::Feature::X86_Rdtscp);
 105
 106         if (!cpuHasRdtscp && binaryUsesRdtscp)
 107         {
 108             gmx_fatal(FARGS,
 109                       "The %s executable was compiled to use the rdtscp CPU instruction. "
 110                       "However, this is not supported by the current hardware and continuing would "
 111                       "lead to a crash. "
 112                       "Please rebuild GROMACS with the GMX_USE_RDTSCP=OFF CMake option.",
 113                       programName);
 114         }
 115
 116         if (cpuHasRdtscp && !binaryUsesRdtscp)
 117         {
 118             GMX_LOG(mdlog.warning)
 119                     .asParagraph()
 120                     .appendTextFormatted(
 121                             "The current CPU can measure timings more accurately than the code in\n"
 122                             "%s was configured to use. This might affect your simulation\n"
 123                             "speed as accurate timings are needed for load-balancing.\n"
 124                             "Please consider rebuilding %s with the GMX_USE_RDTSCP=ON CMake "
 125                             "option.",
 126                             programName, programName);
 127         }
 128     }
 129 }
 130
 131 static std::string detected_hardware_string(const gmx_hw_info_t* hwinfo, bool bFullCpuInfo)
 132 {
 133     std::string s;
 134
 135     const gmx::CpuInfo&          cpuInfo = *hwinfo->cpuInfo;
 136     const gmx::HardwareTopology& hwTop   = *hwinfo->hardwareTopology;
 137
 138     s = gmx::formatString("\n");
 139     s += gmx::formatString("Running on %d node%s with total", hwinfo->nphysicalnode,
 140                            hwinfo->nphysicalnode == 1 ? "" : "s");
 141     if (hwinfo->ncore_tot > 0)
 142     {
 143         s += gmx::formatString(" %d cores,", hwinfo->ncore_tot);
 144     }
 145     s += gmx::formatString(" %d logical cores", hwinfo->nhwthread_tot);
 146     if (canPerformDeviceDetection(nullptr))
 147     {
 148         s += gmx::formatString(", %d compatible GPU%s", hwinfo->ngpu_compatible_tot,
 149                                hwinfo->ngpu_compatible_tot == 1 ? "" : "s");
 150     }
 151     else if (bGPUBinary)
 152     {
 153         s += gmx::formatString(" (GPU detection deactivated)");
 154     }
 155     s += gmx::formatString("\n");
 156
 157     if (hwinfo->nphysicalnode > 1)
 158     {
 159         /* Print per node hardware feature counts */
 160         if (hwinfo->ncore_max > 0)
 161         {
 162             s += gmx::formatString("  Cores per node:           %2d", hwinfo->ncore_min);
 163             if (hwinfo->ncore_max > hwinfo->ncore_min)
 164             {
 165                 s += gmx::formatString(" - %2d", hwinfo->ncore_max);
 166             }
 167             s += gmx::formatString("\n");
 168         }
 169         s += gmx::formatString("  Logical cores per node:   %2d", hwinfo->nhwthread_min);
 170         if (hwinfo->nhwthread_max > hwinfo->nhwthread_min)
 171         {
 172             s += gmx::formatString(" - %2d", hwinfo->nhwthread_max);
 173         }
 174         s += gmx::formatString("\n");
 175         if (bGPUBinary)
 176         {
 177             s += gmx::formatString("  Compatible GPUs per node: %2d", hwinfo->ngpu_compatible_min);
 178             if (hwinfo->ngpu_compatible_max > hwinfo->ngpu_compatible_min)
 179             {
 180                 s += gmx::formatString(" - %2d", hwinfo->ngpu_compatible_max);
 181             }
 182             s += gmx::formatString("\n");
 183             if (hwinfo->ngpu_compatible_tot > 0)
 184             {
 185                 if (hwinfo->bIdenticalGPUs)
 186                 {
 187                     s += gmx::formatString("  All nodes have identical type(s) of GPUs\n");
 188                 }
 189                 else
 190                 {
 191                     /* This message will also appear with identical GPU types
 192                      * when at least one node has no GPU.
 193                      */
 194                     s += gmx::formatString(
 195                             "  Different nodes have different type(s) and/or order of GPUs\n");
 196                 }
 197             }
 198         }
 199     }
 200
 201 #if GMX_LIB_MPI
 202     int  rank;
 203     char host[STRLEN];
 204
 205     gmx_gethostname(host, STRLEN);
 206
 207     MPI_Comm_rank(MPI_COMM_WORLD, &rank);
 208
 209     // TODO Use a wrapper around MPI_Get_processor_name instead.
 210     s += gmx::formatString("Hardware detected on host %s (the node of MPI rank %d):\n", host, rank);
 211 #else
 212     s += gmx::formatString("Hardware detected:\n");
 213 #endif
 214     s += gmx::formatString("  CPU info:\n");
 215
 216     s += gmx::formatString("    Vendor: %s\n", cpuInfo.vendorString().c_str());
 217
 218     s += gmx::formatString("    Brand:  %s\n", cpuInfo.brandString().c_str());
 219
 220     if (bFullCpuInfo)
 221     {
 222         s += gmx::formatString("    Family: %d   Model: %d   Stepping: %d\n", cpuInfo.family(),
 223                                cpuInfo.model(), cpuInfo.stepping());
 224
 225         s += gmx::formatString("    Features:");
 226         for (auto& f : cpuInfo.featureSet())
 227         {
 228             s += gmx::formatString(" %s", gmx::CpuInfo::featureString(f).c_str());
 229         }
 230         s += gmx::formatString("\n");
 231     }
 232
 233     if (cpuInfo.feature(gmx::CpuInfo::Feature::X86_Avx512F))
 234     {
 235         int avx512fmaunits = gmx::identifyAvx512FmaUnits();
 236         s += gmx::formatString("    Number of AVX-512 FMA units:");
 237         if (avx512fmaunits > 0)
 238         {
 239             s += gmx::formatString(" %d", avx512fmaunits);
 240             if (avx512fmaunits == 1)
 241             {
 242                 s += gmx::formatString(" (AVX2 is faster w/o 2 AVX-512 FMA units)");
 243             }
 244         }
 245         else
 246         {
 247             s += gmx::formatString(" Cannot run AVX-512 detection - assuming 2");
 248         }
 249         s += gmx::formatString("\n");
 250     }
 251
 252     s += gmx::formatString("  Hardware topology: ");
 253     switch (hwTop.supportLevel())
 254     {
 255         case gmx::HardwareTopology::SupportLevel::None: s += gmx::formatString("None\n"); break;
 256         case gmx::HardwareTopology::SupportLevel::LogicalProcessorCount:
 257             s += gmx::formatString("Only logical processor count\n");
 258             break;
 259         case gmx::HardwareTopology::SupportLevel::Basic: s += gmx::formatString("Basic\n"); break;
 260         case gmx::HardwareTopology::SupportLevel::Full: s += gmx::formatString("Full\n"); break;
 261         case gmx::HardwareTopology::SupportLevel::FullWithDevices:
 262             s += gmx::formatString("Full, with devices\n");
 263             break;
 264     }
 265
 266     if (!hwTop.isThisSystem())
 267     {
 268         s += gmx::formatString("  NOTE: Hardware topology cached or synthetic, not detected.\n");
 269         if (char* p = std::getenv("HWLOC_XMLFILE"))
 270         {
 271             s += gmx::formatString("        HWLOC_XMLFILE=%s\n", p);
 272         }
 273     }
 274
 275     if (bFullCpuInfo)
 276     {
 277         if (hwTop.supportLevel() >= gmx::HardwareTopology::SupportLevel::Basic)
 278         {
 279             s += gmx::formatString("    Sockets, cores, and logical processors:\n");
 280
 281             for (auto& socket : hwTop.machine().sockets)
 282             {
 283                 s += gmx::formatString("      Socket %2d:", socket.id);
 284                 for (auto& c : socket.cores)
 285                 {
 286                     s += gmx::formatString(" [");
 287                     for (auto& t : c.hwThreads)
 288                     {
 289                         s += gmx::formatString(" %3d", t.logicalProcessorId);
 290                     }
 291                     s += gmx::formatString("]");
 292                 }
 293                 s += gmx::formatString("\n");
 294             }
 295         }
 296         if (hwTop.supportLevel() >= gmx::HardwareTopology::SupportLevel::Full)
 297         {
 298             s += gmx::formatString("    Numa nodes:\n");
 299             for (auto& n : hwTop.machine().numa.nodes)
 300             {
 301                 s += gmx::formatString("      Node %2d (%zu bytes mem):", n.id, n.memory);
 302                 for (auto& l : n.logicalProcessorId)
 303                 {
 304                     s += gmx::formatString(" %3d", l);
 305                 }
 306                 s += gmx::formatString("\n");
 307             }
 308             s += gmx::formatString("      Latency:\n          ");
 309             for (std::size_t j = 0; j < hwTop.machine().numa.nodes.size(); j++)
 310             {
 311                 s += gmx::formatString(" %5zu", j);
 312             }
 313             s += gmx::formatString("\n");
 314             for (std::size_t i = 0; i < hwTop.machine().numa.nodes.size(); i++)
 315             {
 316                 s += gmx::formatString("     %5zu", i);
 317                 for (std::size_t j = 0; j < hwTop.machine().numa.nodes.size(); j++)
 318                 {
 319                     s += gmx::formatString(" %5.2f", hwTop.machine().numa.relativeLatency[i][j]);
 320                 }
 321                 s += gmx::formatString("\n");
 322             }
 323
 324
 325             s += gmx::formatString("    Caches:\n");
 326             for (auto& c : hwTop.machine().caches)
 327             {
 328                 s += gmx::formatString(
 329                         "      L%d: %zu bytes, linesize %d bytes, assoc. %d, shared %d ways\n",
 330                         c.level, c.size, c.linesize, c.associativity, c.shared);
 331             }
 332         }
 333         if (hwTop.supportLevel() >= gmx::HardwareTopology::SupportLevel::FullWithDevices)
 334         {
 335             s += gmx::formatString("    PCI devices:\n");
 336             for (auto& d : hwTop.machine().devices)
 337             {
 338                 s += gmx::formatString(
 339                         "      %04x:%02x:%02x.%1x  Id: %04x:%04x  Class: 0x%04x  Numa: %d\n", d.domain,
 340                         d.bus, d.dev, d.func, d.vendorId, d.deviceId, d.classId, d.numaNodeId);
 341             }
 342         }
 343     }
 344
 345     if (bGPUBinary && !hwinfo->deviceInfoList.empty())
 346     {
 347         s += gmx::formatString("  GPU info:\n");
 348         s += gmx::formatString("    Number of GPUs detected: %d\n",
 349                                static_cast<int>(hwinfo->deviceInfoList.size()));
 350         s += sprint_gpus(hwinfo->deviceInfoList) + "\n";
 351     }
 352     return s;
 353 }
 354
 355 void gmx_print_detected_hardware(FILE*                fplog,
 356                                  const bool           warnToStdErr,
 357                                  const gmx::MDLogger& mdlog,
 358                                  const gmx_hw_info_t* hwinfo)
 359 {
 360     const gmx::CpuInfo& cpuInfo = *hwinfo->cpuInfo;
 361
 362     if (fplog != nullptr)
 363     {
 364         std::string detected;
 365
 366         detected = detected_hardware_string(hwinfo, TRUE);
 367
 368         fprintf(fplog, "%s\n", detected.c_str());
 369     }
 370
 371     // Do not spam stderr with all our internal information unless
 372     // there was something that actually went wrong; general information
 373     // belongs in the logfile.
 374
 375     /* Check the compiled SIMD instruction set against that of the node
 376      * with the lowest SIMD level support (skip if SIMD detection did not work)
 377      */
 378     if (cpuInfo.supportLevel() >= gmx::CpuInfo::SupportLevel::Features)
 379     {
 380         gmx::simdCheck(static_cast<gmx::SimdType>(hwinfo->simd_suggest_min), fplog, warnToStdErr);
 381     }
 382
 383     /* For RDTSCP we only check on our local node and skip the MPI reduction */
 384     check_use_of_rdtscp_on_this_cpu(mdlog, cpuInfo);
 385 }