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,2020, 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 <memory>
  48
  49 #include "gromacs/ewald/pme.h"
  50 #include "gromacs/gpu_utils/gpu_utils.h"
  51 #include "gromacs/hardware/detecthardware.h"
  52 #include "gromacs/hardware/hw_info.h"
  53 #include "gromacs/utility/basenetwork.h"
  54 #include "gromacs/utility/exceptions.h"
  55 #include "gromacs/utility/loggerbuilder.h"
  56 #include "gromacs/utility/physicalnodecommunicator.h"
  57
  58 namespace gmx
  59 {
  60 namespace test
  61 {
  62
  63 /* Implements the "construct on first use" idiom to avoid any static
  64  * initialization order fiasco.
  65  *
  66  * Note that thread-safety of the initialization is guaranteed by the
  67  * C++11 language standard.
  68  *
  69  * The pointer itself (not the memory it points to) has no destructor,
  70  * so there is no deinitialization issue.  See
  71  * https://isocpp.org/wiki/faq/ctors for discussion of alternatives
  72  * and trade-offs. */
  73 const PmeTestEnvironment* getPmeTestEnv()
  74 {
  75     static PmeTestEnvironment* pmeTestEnvironment = nullptr;
  76     if (pmeTestEnvironment == nullptr)
  77     {
  78         // Ownership of the TestEnvironment is taken by GoogleTest, so nothing can leak
  79         pmeTestEnvironment = static_cast<PmeTestEnvironment*>(
  80                 ::testing::AddGlobalTestEnvironment(new PmeTestEnvironment));
  81     }
  82     return pmeTestEnvironment;
  83 }
  84
  85 void callAddGlobalTestEnvironment()
  86 {
  87     getPmeTestEnv();
  88 }
  89
  90 //! Simple hardware initialization
  91 static gmx_hw_info_t* hardwareInit()
  92 {
  93     PhysicalNodeCommunicator physicalNodeComm(MPI_COMM_WORLD, gmx_physicalnode_id_hash());
  94     return gmx_detect_hardware(MDLogger{}, physicalNodeComm);
  95 }
  96
  97 void PmeTestEnvironment::SetUp()
  98 {
  99     hardwareContexts_.emplace_back(std::make_unique<TestHardwareContext>(CodePath::CPU, "(CPU) "));
 100
 101     hardwareInfo_ = hardwareInit();
 102     if (!pme_gpu_supports_build(nullptr) || !pme_gpu_supports_hardware(*hardwareInfo_, nullptr))
 103     {
 104         // PME can only run on the CPU, so don't make any more test contexts.
 105         return;
 106     }
 107     // Constructing contexts for all compatible GPUs - will be empty on non-GPU builds
 108     for (int gpuIndex : getCompatibleGpus(hardwareInfo_->gpu_info))
 109     {
 110         const DeviceInformation* deviceInfo = getDeviceInfo(hardwareInfo_->gpu_info, gpuIndex);
 111         init_gpu(deviceInfo);
 112
 113         char stmp[200] = {};
 114         get_gpu_device_info_string(stmp, hardwareInfo_->gpu_info, gpuIndex);
 115         std::string description = "(GPU " + std::string(stmp) + ") ";
 116         hardwareContexts_.emplace_back(std::make_unique<TestHardwareContext>(
 117                 CodePath::GPU, description.c_str(), *deviceInfo));
 118     }
 119 }
 120
 121 void PmeTestEnvironment::TearDown()
 122 {
 123     hardwareContexts_.clear();
 124 }
 125
 126 } // namespace test
 127 } // namespace gmx