src/testutils/test_device.cpp

   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 /*! \internal \file
  36  * \brief
  37  * Implements test environment class which performs hardware enumeration for unit tests.
  38  *
  39  * \author Aleksei Iupinov <a.yupinov@gmail.com>
  40  * \author Artem Zhmurov <zhmurov@gmail.com>
  41  *
  42  * \ingroup module_testutils
  43  */
  44 #include "gmxpre.h"
  45
  46 #include "testutils/test_device.h"
  47
  48 #include <memory>
  49
  50 #include "gromacs/gpu_utils/device_context.h"
  51 #include "gromacs/gpu_utils/device_stream.h"
  52 #include "gromacs/gpu_utils/gpu_utils.h"
  53 #include "gromacs/gpu_utils/gputraits.h"
  54 #include "gromacs/hardware/detecthardware.h"
  55 #include "gromacs/hardware/hw_info.h"
  56 #include "gromacs/utility/basenetwork.h"
  57 #include "gromacs/utility/exceptions.h"
  58 #include "gromacs/utility/loggerbuilder.h"
  59 #include "gromacs/utility/physicalnodecommunicator.h"
  60
  61 namespace gmx
  62 {
  63 namespace test
  64 {
  65
  66 class TestDevice::Impl
  67 {
  68 public:
  69     Impl(const char* description);
  70     Impl(const char* description, const DeviceInformation& deviceInfo);
  71     ~Impl();
  72     //! Returns a human-readable context description line
  73     std::string description() const { return description_; }
  74     //! Returns the device info pointer
  75     const DeviceInformation& deviceInfo() const { return deviceContext_.deviceInfo(); }
  76     //! Get the device context
  77     const DeviceContext& deviceContext() const { return deviceContext_; }
  78     //! Get the device stream
  79     const DeviceStream& deviceStream() const { return deviceStream_; }
  80
  81 private:
  82     //! Readable description
  83     std::string description_;
  84     //! Device context
  85     DeviceContext deviceContext_;
  86     //! Device stream
  87     DeviceStream deviceStream_;
  88 };
  89
  90 TestDevice::Impl::Impl(const char* description, const DeviceInformation& deviceInfo) :
  91     description_(description),
  92     deviceContext_(deviceInfo),
  93     deviceStream_(deviceContext_, DeviceStreamPriority::Normal, false)
  94 {
  95 }
  96
  97 TestDevice::Impl::~Impl() = default;
  98
  99 TestDevice::TestDevice(const char* description, const DeviceInformation& deviceInfo) :
 100     impl_(new Impl(description, deviceInfo))
 101 {
 102 }
 103
 104 TestDevice::~TestDevice() = default;
 105
 106 std::string TestDevice::description() const
 107 {
 108     return impl_->description();
 109 }
 110
 111 const DeviceInformation& TestDevice::deviceInfo() const
 112 {
 113     return impl_->deviceInfo();
 114 }
 115
 116 const DeviceContext& TestDevice::deviceContext() const
 117 {
 118     return impl_->deviceContext();
 119 }
 120
 121 const DeviceStream& TestDevice::deviceStream() const
 122 {
 123     return impl_->deviceStream();
 124 }
 125
 126 } // namespace test
 127 } // namespace gmx