src/gromacs/gpu_utils/tests/devicetransfers.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2017,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 /*! \internal \file
  36  * \brief Declares helper functionality for device transfers for tests
  37  * for GPU host allocator.
  38  *
  39  * Undefined symbols in Google Test, GROMACS use of -Wundef, and the
  40  * implementation of FindCUDA.cmake and/or nvcc mean that no
  41  * compilation unit should include a gtest header while being compiled
  42  * by nvcc. None of -isystem, -Wno-undef, nor the pragma GCC
  43  * diagnostic work.
  44  *
  45  * Thus, this header isolates CUDA-specific functionality to its own
  46  * translation unit. The OpenCL and no-GPU implementations do not
  47  * require this separation, but do so for consistency.
  48  *
  49  * \author Mark Abraham <mark.j.abraham@gmail.com>
  50  */
  51 #ifndef GMX_GPU_UTILS_TESTS_DEVICETRANSFERS_H
  52 #define GMX_GPU_UTILS_TESTS_DEVICETRANSFERS_H
  53
  54 struct DeviceInformation;
  55
  56 namespace gmx
  57 {
  58 template<typename>
  59 class ArrayRef;
  60
  61 /*! \brief Helper function for GPU test code to be platform agnostic.
  62  *
  63  * Transfers \c input to device 0, if present, and transfers it back
  64  * into \c output. Both sizes must match. If no devices are present,
  65  * do a simple host-side buffer copy instead.
  66  *
  67  * \throws InternalError  Upon any GPU API error condition. */
  68 void doDeviceTransfers(const DeviceInformation& deviceInfo, ArrayRef<const char> input, ArrayRef<char> output);
  69
  70 } // namespace gmx
  71
  72 #endif