src/gromacs/ewald/tests/testhardwarecontext.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 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_CONTEXT_H
  36 #define GMX_EWALD_TEST_HARDWARE_CONTEXT_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  * \author Artem Zhmurov <zhmurov@gmail.com>
  44  * \ingroup module_ewald
  45  */
  46
  47 #include <map>
  48 #include <string>
  49 #include <vector>
  50
  51 #include "gromacs/ewald/pme_gpu_program.h"
  52 #include "gromacs/utility/gmxassert.h"
  53
  54 class DeviceContext;
  55 struct DeviceInformation;
  56 class DeviceStream;
  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 context
  83     DeviceContext* deviceContext_ = nullptr;
  84     //! Device stream
  85     DeviceStream* deviceStream_ = nullptr;
  86     //! Persistent compiled GPU kernels for PME.
  87     PmeGpuProgramStorage program_;
  88
  89 public:
  90     //! Retuns the code path for this context.
  91     CodePath codePath() const { return codePath_; }
  92     //! Returns a human-readable context description line
  93     std::string description() const { return description_; }
  94     //! Returns the device info pointer
  95     const DeviceInformation* deviceInfo() const;
  96     //! Get the device context
  97     const DeviceContext* deviceContext() const;
  98     //! Get the device stream
  99     const DeviceStream* deviceStream() const;
 100     //! Returns the persistent PME GPU kernels
 101     const PmeGpuProgram* pmeGpuProgram() const { return program_.get(); }
 102     //! Constructs the context for CPU builds
 103     TestHardwareContext(CodePath codePath, const char* description);
 104     //! Constructs the context for GPU builds
 105     TestHardwareContext(CodePath codePath, const char* description, const DeviceInformation& deviceInfo);
 106     //! Destructor
 107     ~TestHardwareContext();
 108 };
 109
 110 } // namespace test
 111 } // namespace gmx
 112 #endif