2 * This file is part of the GROMACS molecular simulation package.
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.
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.
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.
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.
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.
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.
37 * Implements test environment class which performs hardware enumeration for unit tests.
39 * \author Aleksei Iupinov <a.yupinov@gmail.com>
40 * \ingroup module_ewald
45 #include "testhardwarecontexts.h"
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"
63 TestHardwareContext::~TestHardwareContext() = default;
65 const char *codePathToString(CodePath codePath)
74 GMX_THROW(NotImplementedError("This CodePath should support codePathToString"));
78 /* Implements the "construct on first use" idiom to avoid any static
79 * initialization order fiasco.
81 * Note that thread-safety of the initialization is guaranteed by the
82 * C++11 language standard.
84 * The pointer itself (not the memory it points to) has no destructor,
85 * so there is no deinitialization issue. See
86 * https://isocpp.org/wiki/faq/ctors for discussion of alternatives
88 const PmeTestEnvironment *getPmeTestEnv()
90 static PmeTestEnvironment *pmeTestEnvironment = nullptr;
91 if (pmeTestEnvironment == nullptr)
93 // Ownership of the TestEnvironment is taken by GoogleTest, so nothing can leak
94 pmeTestEnvironment = static_cast<PmeTestEnvironment *>(::testing::AddGlobalTestEnvironment(new PmeTestEnvironment));
96 return pmeTestEnvironment;
99 void callAddGlobalTestEnvironment()
104 //! Simple hardware initialization
105 static gmx_hw_info_t *hardwareInit()
107 PhysicalNodeCommunicator physicalNodeComm(MPI_COMM_WORLD, gmx_physicalnode_id_hash());
108 return gmx_detect_hardware(MDLogger {}, physicalNodeComm);
111 void PmeTestEnvironment::SetUp()
113 hardwareContexts_.emplace_back(std::make_unique<TestHardwareContext>(CodePath::CPU, "", nullptr));
115 hardwareInfo_ = hardwareInit();
116 if (!pme_gpu_supports_build(nullptr) ||
117 !pme_gpu_supports_hardware(*hardwareInfo_, nullptr))
119 // PME can only run on the CPU, so don't make any more test contexts.
122 // Constructing contexts for all compatible GPUs - will be empty on non-GPU builds
123 for (int gpuIndex : getCompatibleGpus(hardwareInfo_->gpu_info))
125 const gmx_device_info_t *deviceInfo = getDeviceInfo(hardwareInfo_->gpu_info, gpuIndex);
126 init_gpu(deviceInfo);
129 get_gpu_device_info_string(stmp, hardwareInfo_->gpu_info, gpuIndex);
130 std::string description = "(GPU " + std::string(stmp) + ") ";
131 hardwareContexts_.emplace_back(std::make_unique<TestHardwareContext>
132 (CodePath::GPU, description.c_str(),
137 void PmeTestEnvironment::TearDown()
139 gmx_hardware_info_free();