src/gromacs/gpu_utils/device_stream.cu

   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  *
  37  * \brief Implements the DeviceStream for CUDA.
  38  *
  39  * \author Artem Zhmurov <zhmurov@gmail.com>
  40  *
  41  * \ingroup module_gpu_utils
  42  */
  43 #include "gmxpre.h"
  44
  45 #include "device_stream.h"
  46
  47 #include "gromacs/utility/exceptions.h"
  48 #include "gromacs/utility/gmxassert.h"
  49 #include "gromacs/utility/stringutil.h"
  50
  51 DeviceStream::DeviceStream()
  52 {
  53     stream_ = nullptr;
  54 }
  55
  56 void DeviceStream::init(const DeviceContext& /* deviceContext */,
  57                         DeviceStreamPriority priority,
  58                         const bool /* useTiming */)
  59 {
  60     cudaError_t stat;
  61
  62     if (priority == DeviceStreamPriority::Normal)
  63     {
  64         stat = cudaStreamCreate(&stream_);
  65         if (stat != cudaSuccess)
  66         {
  67             GMX_THROW(gmx::InternalError(gmx::formatString(
  68                     "Could not create CUDA stream (CUDA error %d: %s).", stat, cudaGetErrorString(stat))));
  69         }
  70     }
  71     else if (priority == DeviceStreamPriority::High)
  72     {
  73         // Note that the device we're running on does not have to
  74         // support priorities, because we are querying the priority
  75         // range, which in that case will be a single value.
  76         int highestPriority;
  77         stat = cudaDeviceGetStreamPriorityRange(nullptr, &highestPriority);
  78         if (stat != cudaSuccess)
  79         {
  80             GMX_THROW(gmx::InternalError(gmx::formatString(
  81                     "Could not query CUDA stream priority range (CUDA error %d: %s).", stat,
  82                     cudaGetErrorString(stat))));
  83         }
  84
  85         stat = cudaStreamCreateWithPriority(&stream_, cudaStreamDefault, highestPriority);
  86         if (stat != cudaSuccess)
  87         {
  88             GMX_THROW(gmx::InternalError(gmx::formatString(
  89                     "Could not create CUDA stream with high priority (CUDA error %d: %s).", stat,
  90                     cudaGetErrorString(stat))));
  91         }
  92     }
  93 }
  94
  95 DeviceStream::~DeviceStream()
  96 {
  97     if (isValid())
  98     {
  99         cudaError_t stat = cudaStreamDestroy(stream_);
 100         GMX_RELEASE_ASSERT(stat == cudaSuccess,
 101                            gmx::formatString("Failed to release CUDA stream (CUDA error %d: %s).",
 102                                              stat, cudaGetErrorString(stat))
 103                                    .c_str());
 104         stream_ = nullptr;
 105     }
 106 }
 107
 108 cudaStream_t DeviceStream::stream() const
 109 {
 110     return stream_;
 111 }
 112
 113 bool DeviceStream::isValid() const
 114 {
 115     return (stream_ != nullptr);
 116 }
 117
 118 void DeviceStream::synchronize() const
 119 {
 120     cudaError_t stat = cudaStreamSynchronize(stream_);
 121     GMX_RELEASE_ASSERT(stat == cudaSuccess,
 122                        gmx::formatString("cudaStreamSynchronize failed  (CUDA error %d: %s).", stat,
 123                                          cudaGetErrorString(stat))
 124                                .c_str());
 125 }