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.
35 #ifndef GMX_EWALD_TEST_HARDWARE_CONTEXTS_H
36 #define GMX_EWALD_TEST_HARDWARE_CONTEXTS_H
40 * Describes test environment class which performs hardware enumeration for unit tests.
42 * \author Aleksei Iupinov <a.yupinov@gmail.com>
43 * \ingroup module_ewald
49 #include <gtest/gtest.h>
51 #include "gromacs/ewald/pme_gpu_program.h"
52 #include "gromacs/hardware/gpu_hw_info.h"
60 //! Hardware code path being tested
67 //! Return a string useful for human-readable messages describing a \c codePath.
68 const char *codePathToString(CodePath codePath);
71 * A structure to describe a hardware context that persists over the lifetime
72 * of the test binary - an abstraction over PmeGpuProgram with a human-readable string.
74 struct TestHardwareContext
76 //! Hardware path for the code being tested.
78 //! Readable description
79 std::string description_;
80 //! Device information pointer
81 const gmx_device_info_t *deviceInfo_;
82 //! Persistent compiled GPU kernels for PME.
83 PmeGpuProgramStorage program_;
86 //! Retuns the code path for this context.
87 CodePath getCodePath() const { return codePath_; }
88 //! Returns a human-readable context description line
89 std::string getDescription() const{return description_; }
90 //! Returns the device info pointer
91 const gmx_device_info_t *getDeviceInfo() const{return deviceInfo_; }
92 //! Returns the persistent PME GPU kernels
93 PmeGpuProgramHandle getPmeGpuProgram() const{return program_.get(); }
94 //! Constructs the context
95 TestHardwareContext(CodePath codePath, const char *description, const gmx_device_info_t *deviceInfo) :
96 codePath_(codePath), description_(description), deviceInfo_(deviceInfo),
97 program_(buildPmeGpuProgram(deviceInfo_)) {}
98 ~TestHardwareContext();
101 //! A container of handles to hardware contexts
102 typedef std::vector < std::unique_ptr < TestHardwareContext>> TestHardwareContexts;
105 * This class performs one-time test initialization (enumerating the hardware)
107 class PmeTestEnvironment : public ::testing::Environment
110 //! General hardware info
111 gmx_hw_info_t *hardwareInfo_;
112 //! Storage of hardware contexts
113 TestHardwareContexts hardwareContexts_;
116 //! This is called by GTest framework once to query the hardware
117 void SetUp() override;
118 //! This is called by GTest framework once to clean up
119 void TearDown() override;
120 //! Get available hardware contexts.
121 const TestHardwareContexts &getHardwareContexts() const {return hardwareContexts_; }
122 //! Get available hardware information.
123 const gmx_hw_info_t *hwinfo() const { return hardwareInfo_; }
126 //! Get the test environment
127 const PmeTestEnvironment *getPmeTestEnv();
129 /*! \brief This constructs the test environment during setup of the
130 * unit test so that they can use the hardware context. */
131 void callAddGlobalTestEnvironment();