src/testutils/include/testutils/test_device.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2020,2021, 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_TESTUTILS_TEST_DEVICE_H
  36 #define GMX_TESTUTILS_TEST_DEVICE_H
  37
  38 /*! \internal \file
  39  * \brief
  40  * Describes test environment class which performs GPU device enumeration for unit tests.
  41  *
  42  * \author Aleksei Iupinov <a.yupinov@gmail.com>
  43  * \author Artem Zhmurov <zhmurov@gmail.com>
  44  *
  45  * \ingroup module_testutils
  46  */
  47
  48 #include <map>
  49 #include <memory>
  50 #include <string>
  51 #include <vector>
  52
  53 #include "gromacs/utility/gmxassert.h"
  54
  55 class DeviceContext;
  56 struct DeviceInformation;
  57 class DeviceStream;
  58
  59 namespace gmx
  60 {
  61 namespace test
  62 {
  63
  64 /*! \internal \brief
  65  * A structure to describe a hardware context that persists over the lifetime
  66  * of the test binary.
  67  */
  68 class TestDevice
  69 {
  70 public:
  71     //! Returns a human-readable context description line
  72     std::string description() const;
  73     //! Returns the device info pointer
  74     const DeviceInformation& deviceInfo() const;
  75     //! Get the device context
  76     const DeviceContext& deviceContext() const;
  77     //! Get the device stream
  78     const DeviceStream& deviceStream() const;
  79     //! Creates the device context and stream for tests on the GPU
  80     TestDevice(const char* description, const DeviceInformation& deviceInfo);
  81     //! Destructor
  82     ~TestDevice();
  83
  84 private:
  85     //! Implementation type.
  86     class Impl;
  87     //! Implementation object.
  88     std::unique_ptr<Impl> impl_;
  89 };
  90
  91 } // namespace test
  92 } // namespace gmx
  93
  94 #endif // GMX_TESTUTILS_TEST_DEVICE_H