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/hardware/gpu_hw_info.h"
  53 #include "gromacs/utility/gmxassert.h"
  54
  55 #include "testhardwarecontext.h"
  56
  57 struct gmx_hw_info_t;
  58
  59 namespace gmx
  60 {
  61 namespace test
  62 {
  63
  64 //! A container of handles to hardware contexts
  65 typedef std::vector<std::unique_ptr<TestHardwareContext>> TestHardwareContexts;
  66
  67 /*! \internal \brief
  68  * This class performs one-time test initialization (enumerating the hardware)
  69  */
  70 class PmeTestEnvironment : public ::testing::Environment
  71 {
  72 private:
  73     //! General hardware info
  74     gmx_hw_info_t* hardwareInfo_;
  75     //! Storage of hardware contexts
  76     TestHardwareContexts hardwareContexts_;
  77
  78 public:
  79     //! This is called by GTest framework once to query the hardware
  80     void SetUp() override;
  81     //! This is called by GTest framework once release the hardware
  82     void TearDown() override;
  83     //! Get available hardware contexts.
  84     const TestHardwareContexts& getHardwareContexts() const { return hardwareContexts_; }
  85     //! Get available hardware information.
  86     const gmx_hw_info_t* hwinfo() const { return hardwareInfo_; }
  87 };
  88
  89 //! Get the test environment
  90 const PmeTestEnvironment* getPmeTestEnv();
  91
  92 /*! \brief This constructs the test environment during setup of the
  93  * unit test so that they can use the hardware context. */
  94 void callAddGlobalTestEnvironment();
  95
  96 } // namespace test
  97 } // namespace gmx
  98 #endif