src/gromacs/ewald/tests/testhardwarecontexts.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   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.
   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 <list>
  47 #include <map>
  48
  49 #include <gtest/gtest.h>
  50
  51 #include "gromacs/hardware/detecthardware.h"
  52 #include "gromacs/hardware/gpu_hw_info.h"
  53 #include "gromacs/utility/unique_cptr.h"
  54
  55 namespace gmx
  56 {
  57 namespace test
  58 {
  59 //! Hardware code path being tested
  60 enum class CodePath
  61 {
  62     CPU,
  63     CUDA
  64 };
  65
  66 /*! \internal \brief
  67  * A structure to describe a hardware context - an abstraction over
  68  * gmx_device_info_t with a human-readable string.
  69  * TODO: currently this does not know which CodePath it belongs too.
  70  * It probably should! That would save us one loop in all the PME tests.
  71  */
  72 struct TestHardwareContext
  73 {
  74     //! Readable description
  75     std::string        description_;
  76     //! Device information pointer
  77     gmx_device_info_t *deviceInfo_;
  78
  79     public:
  80         //! Returns a human-readable context description line
  81         std::string getDescription() const{return description_; }
  82 //! Returns the device info pointer
  83         gmx_device_info_t *getDeviceInfo() const{return deviceInfo_; }
  84         //! Constructs the context
  85         TestHardwareContext(const char *description, gmx_device_info_t *deviceInfo) : description_(description), deviceInfo_(deviceInfo){}
  86 };
  87
  88 //! A list of hardware contexts
  89 typedef std::list<TestHardwareContext> TestHardwareContexts;
  90
  91 /*! \internal \brief
  92  * This class performs one-time test initialization (enumerating the hardware)
  93  */
  94 class PmeTestEnvironment : public ::testing::Environment
  95 {
  96     private:
  97         //! General hardware info
  98         unique_cptr<gmx_hw_info_t, gmx_hardware_info_free> hardwareInfo_;
  99         //! Storage of hardware contexts
 100         std::map<CodePath, TestHardwareContexts>           hardwareContextsByMode_;
 101         //! Simple GPU initialization, allowing for PME to work on GPU
 102         void hardwareInit();
 103
 104     public:
 105         //! Default
 106         ~PmeTestEnvironment() = default;
 107         //! This is called by GTest framework once to query the hardware
 108         void SetUp();
 109         //! Get available hardware contexts for given code path
 110         const TestHardwareContexts &getHardwareContexts(CodePath mode){return hardwareContextsByMode_.at(mode); }
 111 };
 112
 113 //! The test environment
 114 extern PmeTestEnvironment * const pmeEnv;
 115 }
 116 }
 117 #endif