2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2017,2018, 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/detecthardware.h"
53 #include "gromacs/hardware/gpu_hw_info.h"
59 //! Hardware code path being tested
66 //! Return a string useful for human-readable messages describing a \c codePath.
67 const char *codePathToString(CodePath codePath);
70 * A structure to describe a hardware context that persists over the lifetime
71 * of the test binary - an abstraction over PmeGpuProgram with a human-readable string.
73 struct TestHardwareContext
75 //! Hardware path for the code being tested.
77 //! Readable description
78 std::string description_;
79 //! Device information pointer
80 gmx_device_info_t *deviceInfo_;
81 //! Persistent compiled GPU kernels for PME.
82 PmeGpuProgramStorage program_;
85 //! Retuns the code path for this context.
86 CodePath getCodePath() const { return codePath_; }
87 //! Returns a human-readable context description line
88 std::string getDescription() const{return description_; }
89 //! Returns the device info pointer
90 gmx_device_info_t *getDeviceInfo() const{return deviceInfo_; }
91 //! Returns the persistent PME GPU kernels
92 PmeGpuProgramHandle getPmeGpuProgram() const{return program_.get(); }
93 //! Constructs the context
94 TestHardwareContext(CodePath codePath, const char *description, gmx_device_info_t *deviceInfo) :
95 codePath_(codePath), description_(description), deviceInfo_(deviceInfo),
96 program_(buildPmeGpuProgram(deviceInfo_)) {}
97 ~TestHardwareContext();
100 //! A container of handles to hardware contexts
101 typedef std::vector < std::unique_ptr < TestHardwareContext>> TestHardwareContexts;
104 * This class performs one-time test initialization (enumerating the hardware)
106 class PmeTestEnvironment : public ::testing::Environment
109 //! General hardware info
110 gmx_hw_info_t *hardwareInfo_;
111 //! Storage of hardware contexts
112 TestHardwareContexts hardwareContexts_;
115 //! This is called by GTest framework once to query the hardware
116 virtual void SetUp();
117 //! This is called by GTest framework once to clean up
118 virtual void TearDown();
119 //! Get available hardware contexts.
120 const TestHardwareContexts &getHardwareContexts() const {return hardwareContexts_; }
123 //! Get the test environment
124 const PmeTestEnvironment *getPmeTestEnv();
126 /*! \brief This constructs the test environment during setup of the
127 * unit test so that they can use the hardware context. */
128 void callAddGlobalTestEnvironment();