src/gromacs/ewald/tests/testhardwarecontexts.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2017,2018,2019, 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 /*! \internal \file
  36  * \brief
  37  * Implements test environment class which performs hardware enumeration for unit tests.
  38  *
  39  * \author Aleksei Iupinov <a.yupinov@gmail.com>
  40  * \ingroup module_ewald
  41  */
  42
  43 #include "gmxpre.h"
  44
  45 #include "testhardwarecontexts.h"
  46
  47 #include "gromacs/compat/make_unique.h"
  48 #include "gromacs/ewald/pme.h"
  49 #include "gromacs/gpu_utils/gpu_utils.h"
  50 #include "gromacs/hardware/detecthardware.h"
  51 #include "gromacs/hardware/hw_info.h"
  52 #include "gromacs/utility/basenetwork.h"
  53 #include "gromacs/utility/exceptions.h"
  54 #include "gromacs/utility/loggerbuilder.h"
  55 #include "gromacs/utility/physicalnodecommunicator.h"
  56
  57 namespace gmx
  58 {
  59 namespace test
  60 {
  61
  62 TestHardwareContext::~TestHardwareContext() = default;
  63
  64 const char *codePathToString(CodePath codePath)
  65 {
  66     switch (codePath)
  67     {
  68         case CodePath::CPU:
  69             return "CPU";
  70         case CodePath::GPU:
  71             return "GPU";
  72         default:
  73             GMX_THROW(NotImplementedError("This CodePath should support codePathToString"));
  74     }
  75 }
  76
  77 /* Implements the "construct on first use" idiom to avoid any static
  78  * initialization order fiasco.
  79  *
  80  * Note that thread-safety of the initialization is guaranteed by the
  81  * C++11 language standard.
  82  *
  83  * The pointer itself (not the memory it points to) has no destructor,
  84  * so there is no deinitialization issue.  See
  85  * https://isocpp.org/wiki/faq/ctors for discussion of alternatives
  86  * and trade-offs. */
  87 const PmeTestEnvironment *getPmeTestEnv()
  88 {
  89     static PmeTestEnvironment *pmeTestEnvironment = nullptr;
  90     if (pmeTestEnvironment == nullptr)
  91     {
  92         // Ownership of the TestEnvironment is taken by GoogleTest, so nothing can leak
  93         pmeTestEnvironment = static_cast<PmeTestEnvironment *>(::testing::AddGlobalTestEnvironment(new PmeTestEnvironment));
  94     }
  95     return pmeTestEnvironment;
  96 }
  97
  98 void callAddGlobalTestEnvironment()
  99 {
 100     getPmeTestEnv();
 101 }
 102
 103 //! Simple hardware initialization
 104 static gmx_hw_info_t *hardwareInit()
 105 {
 106     PhysicalNodeCommunicator             physicalNodeComm(MPI_COMM_WORLD, gmx_physicalnode_id_hash());
 107     return gmx_detect_hardware(MDLogger {}, physicalNodeComm);
 108 }
 109
 110 void PmeTestEnvironment::SetUp()
 111 {
 112     hardwareContexts_.emplace_back(compat::make_unique<TestHardwareContext>(CodePath::CPU, "", nullptr));
 113
 114     hardwareInfo_ = hardwareInit();
 115     if (!pme_gpu_supports_build(nullptr) ||
 116         !pme_gpu_supports_hardware(*hardwareInfo_, nullptr))
 117     {
 118         // PME can only run on the CPU, so don't make any more test contexts.
 119         return;
 120     }
 121     // Constructing contexts for all compatible GPUs - will be empty on non-GPU builds
 122     for (int gpuIndex : getCompatibleGpus(hardwareInfo_->gpu_info))
 123     {
 124         const gmx_device_info_t *deviceInfo = getDeviceInfo(hardwareInfo_->gpu_info, gpuIndex);
 125         init_gpu(deviceInfo);
 126
 127         char        stmp[200] = {};
 128         get_gpu_device_info_string(stmp, hardwareInfo_->gpu_info, gpuIndex);
 129         std::string description = "(GPU " + std::string(stmp) + ") ";
 130         hardwareContexts_.emplace_back(compat::make_unique<TestHardwareContext>
 131                                            (CodePath::GPU, description.c_str(),
 132                                            deviceInfo));
 133     }
 134 }
 135
 136 void PmeTestEnvironment::TearDown()
 137 {
 138     gmx_hardware_info_free();
 139 }
 140
 141 }  // namespace test
 142 }  // namespace gmx