src/gromacs/ewald/tests/testhardwarecontexts.h

   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 #ifndef GMX_EWALD_TEST_HARDWARE_CONTEXTS_H
  36 #define GMX_EWALD_TEST_HARDWARE_CONTEXTS_H
  37
  38 /*! \internal \file
  39  * \brief
  40  * Describes test environment class which performs hardware enumeration for unit tests.
  41  *
  42  * \author Aleksei Iupinov <a.yupinov@gmail.com>
  43  * \ingroup module_ewald
  44  */
  45
  46 #include <map>
  47 #include <vector>
  48
  49 #include <gtest/gtest.h>
  50
  51 #include "gromacs/ewald/pme_gpu_program.h"
  52 #include "gromacs/gpu_utils/device_context.h"
  53 #include "gromacs/hardware/gpu_hw_info.h"
  54 #include "gromacs/utility/gmxassert.h"
  55
  56 struct gmx_hw_info_t;
  57
  58 namespace gmx
  59 {
  60 namespace test
  61 {
  62 //! Hardware code path being tested
  63 enum class CodePath
  64 {
  65     CPU,
  66     GPU
  67 };
  68
  69 //! Return a string useful for human-readable messages describing a \c codePath.
  70 const char* codePathToString(CodePath codePath);
  71
  72 /*! \internal \brief
  73  * A structure to describe a hardware context  that persists over the lifetime
  74  * of the test binary - an abstraction over PmeGpuProgram with a human-readable string.
  75  */
  76 struct TestHardwareContext
  77 {
  78     //! Hardware path for the code being tested.
  79     CodePath codePath_;
  80     //! Readable description
  81     std::string description_;
  82     //! Device information pointer
  83     const DeviceInformation* deviceInfo_;
  84     //! Local copy of the device context pointer
  85     DeviceContext deviceContext_;
  86     //! Persistent compiled GPU kernels for PME.
  87     PmeGpuProgramStorage program_;
  88
  89 public:
  90     //! Retuns the code path for this context.
  91     CodePath getCodePath() const { return codePath_; }
  92     //! Returns a human-readable context description line
  93     std::string getDescription() const { return description_; }
  94     //! Getter for the DeviceContext
  95     const DeviceContext& deviceContext() const { return deviceContext_; }
  96     //! Returns the device info pointer
  97     const DeviceInformation* getDeviceInfo() const { return deviceInfo_; }
  98     //! Returns the persistent PME GPU kernels
  99     const PmeGpuProgram* getPmeGpuProgram() const { return program_.get(); }
 100     //! Constructs the context for CPU builds
 101     TestHardwareContext(CodePath codePath, const char* description) :
 102         codePath_(codePath),
 103         description_(description)
 104     {
 105         GMX_RELEASE_ASSERT(codePath == CodePath::CPU,
 106                            "A GPU code path should provide DeviceInformation to the "
 107                            "TestHerdwareContext constructor.");
 108     }
 109     //! Constructs the context for GPU builds
 110     TestHardwareContext(CodePath codePath, const char* description, const DeviceInformation& deviceInfo) :
 111         codePath_(codePath),
 112         description_(description),
 113         deviceInfo_(&deviceInfo),
 114         deviceContext_(deviceInfo),
 115         program_(buildPmeGpuProgram(deviceInfo, deviceContext_))
 116     {
 117         GMX_RELEASE_ASSERT(codePath == CodePath::GPU,
 118                            "TestHerdwareContext tries to construct DeviceContext and PmeGpuProgram "
 119                            "in CPU build.");
 120     }
 121     ~TestHardwareContext();
 122 };
 123
 124 //! A container of handles to hardware contexts
 125 typedef std::vector<std::unique_ptr<TestHardwareContext>> TestHardwareContexts;
 126
 127 /*! \internal \brief
 128  * This class performs one-time test initialization (enumerating the hardware)
 129  */
 130 class PmeTestEnvironment : public ::testing::Environment
 131 {
 132 private:
 133     //! General hardware info
 134     gmx_hw_info_t* hardwareInfo_;
 135     //! Storage of hardware contexts
 136     TestHardwareContexts hardwareContexts_;
 137
 138 public:
 139     //! This is called by GTest framework once to query the hardware
 140     void SetUp() override;
 141     //! Get available hardware contexts.
 142     const TestHardwareContexts& getHardwareContexts() const { return hardwareContexts_; }
 143     //! Get available hardware information.
 144     const gmx_hw_info_t* hwinfo() const { return hardwareInfo_; }
 145 };
 146
 147 //! Get the test environment
 148 const PmeTestEnvironment* getPmeTestEnv();
 149
 150 /*! \brief This constructs the test environment during setup of the
 151  * unit test so that they can use the hardware context. */
 152 void callAddGlobalTestEnvironment();
 153
 154 } // namespace test
 155 } // namespace gmx
 156 #endif