src/testutils/test_hardware_environment.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  * \author Artem Zhmurov <zhmurov@gmail.com>
  41  *
  42  * \ingroup module_testutils
  43  */
  44
  45 #include "gmxpre.h"
  46
  47 #include "test_hardware_environment.h"
  48
  49 #include <memory>
  50
  51 #include "gromacs/gpu_utils/gpu_utils.h"
  52 #include "gromacs/hardware/detecthardware.h"
  53 #include "gromacs/hardware/device_management.h"
  54 #include "gromacs/hardware/hw_info.h"
  55 #include "gromacs/utility/basenetwork.h"
  56 #include "gromacs/utility/exceptions.h"
  57 #include "gromacs/utility/physicalnodecommunicator.h"
  58
  59 namespace gmx
  60 {
  61 namespace test
  62 {
  63
  64 /* Implements the "construct on first use" idiom to avoid any static
  65  * initialization order fiasco.
  66  *
  67  * Note that thread-safety of the initialization is guaranteed by the
  68  * C++11 language standard.
  69  *
  70  * The pointer itself (not the memory it points to) has no destructor,
  71  * so there is no deinitialization issue.  See
  72  * https://isocpp.org/wiki/faq/ctors for discussion of alternatives
  73  * and trade-offs. */
  74 const TestHardwareEnvironment* getTestHardwareEnvironment()
  75 {
  76     static TestHardwareEnvironment* testHardwareEnvironment = nullptr;
  77     if (testHardwareEnvironment == nullptr)
  78     {
  79         // Ownership of the TestEnvironment is taken by GoogleTest, so nothing can leak
  80         testHardwareEnvironment = static_cast<TestHardwareEnvironment*>(
  81                 ::testing::AddGlobalTestEnvironment(new TestHardwareEnvironment));
  82     }
  83     return testHardwareEnvironment;
  84 }
  85
  86 void callAddGlobalTestEnvironment()
  87 {
  88     getTestHardwareEnvironment();
  89 }
  90
  91 TestHardwareEnvironment::TestHardwareEnvironment() :
  92     hardwareInfo_(gmx_detect_hardware(PhysicalNodeCommunicator{ MPI_COMM_WORLD, gmx_physicalnode_id_hash() }))
  93 {
  94 }
  95
  96 void TestHardwareEnvironment::SetUp()
  97 {
  98     testDeviceList_.clear();
  99     // Constructing contexts for all compatible GPUs - will be empty on non-GPU builds
 100     for (const DeviceInformation& compatibleDeviceInfo : getCompatibleDevices(hardwareInfo_->deviceInfoList))
 101     {
 102         setActiveDevice(compatibleDeviceInfo);
 103         std::string description = getDeviceInformationString(compatibleDeviceInfo);
 104         testDeviceList_.emplace_back(std::make_unique<TestDevice>(description.c_str(), compatibleDeviceInfo));
 105     }
 106 }
 107
 108 void TestHardwareEnvironment::TearDown()
 109 {
 110     testDeviceList_.clear();
 111     /* In OneAPI 2021.1-beta9 and beta10, there is a bug that cause a
 112      * segfault when a sycl::device is destructed too late. So, we
 113      * explicitly destroy device handles here by resetting
 114      * hardwareInfo_, which does no harm to anything else. */
 115     hardwareInfo_.reset(nullptr);
 116 }
 117
 118 } // namespace test
 119 } // namespace gmx