2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2017, 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/gmxlib/network.h"
50 #include "gromacs/gpu_utils/gpu_utils.h"
51 #include "gromacs/hardware/hw_info.h"
52 #include "gromacs/taskassignment/hardwareassign.h"
53 #include "gromacs/utility/exceptions.h"
54 #include "gromacs/utility/loggerbuilder.h"
55 #include "gromacs/utility/unique_cptr.h"
62 /* Implements the "construct on first use" idiom to avoid any static
63 * initialization order fiasco.
65 * Note that thread-safety of the initialization is guaranteed by the
66 * C++11 language standard.
68 * The pointer itself (not the memory it points to) has no destructor,
69 * so there is no deinitialization issue. See
70 * https://isocpp.org/wiki/faq/ctors for discussion of alternatives
72 const PmeTestEnvironment
*getPmeTestEnv()
74 static PmeTestEnvironment
*pmeTestEnvironment
= nullptr;
75 if (pmeTestEnvironment
== nullptr)
77 // Ownership of the TestEnvironment is taken by GoogleTest, so nothing can leak
78 pmeTestEnvironment
= static_cast<PmeTestEnvironment
*>(::testing::AddGlobalTestEnvironment(new PmeTestEnvironment
));
80 return pmeTestEnvironment
;
83 void callAddGlobalTestEnvironment()
88 //! Simple hardware initialization
89 static gmx_hw_info_t
*hardwareInit()
91 unique_cptr
<t_commrec
, done_commrec
> commrec(init_commrec());
92 gmx_init_intranode_counters(commrec
.get());
93 LoggerBuilder builder
;
94 LoggerOwner
logOwner(builder
.build());
95 MDLogger
log(logOwner
.logger());
96 return gmx_detect_hardware(log
, commrec
.get());
99 void PmeTestEnvironment::SetUp()
101 TestHardwareContext
emptyContext("", nullptr);
102 hardwareContextsByMode_
[CodePath::CPU
].push_back(emptyContext
);
104 hardwareInfo_
= hardwareInit();
106 // Constructing contexts for all compatible GPUs - will be empty on non-GPU builds
107 TestHardwareContexts gpuContexts
;
108 const auto compatibleGpus
= getCompatibleGpus(hardwareInfo_
->gpu_info
);
109 for (int gpuIndex
: compatibleGpus
)
112 get_gpu_device_info_string(stmp
, hardwareInfo_
->gpu_info
, gpuIndex
);
113 std::string description
= "(GPU " + std::string(stmp
) + ") ";
114 gpuContexts
.emplace_back(TestHardwareContext(description
.c_str(), getDeviceInfo(hardwareInfo_
->gpu_info
, gpuIndex
)));
116 #if GMX_GPU == GMX_GPU_CUDA
117 hardwareContextsByMode_
[CodePath::CUDA
] = gpuContexts
;
121 void PmeTestEnvironment::TearDown()
123 gmx_hardware_info_free(hardwareInfo_
);