2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 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.
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.
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.
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.
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.
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.
37 * \brief Implements GPU stream manager.
39 * \author Mark Abraham <mark.j.abraham@gmail.com>
40 * \author Artem Zhmurov <zhmurov@gmail.com>
42 * \ingroup module_gpu_utils
46 #include "device_stream_manager.h"
48 #include "gromacs/gpu_utils/device_context.h"
49 #include "gromacs/gpu_utils/device_stream.h"
50 #include "gromacs/utility/enumerationhelpers.h"
51 #include "gromacs/utility/exceptions.h"
52 #include "gromacs/utility/gmxassert.h"
53 #include "gromacs/utility/stringutil.h"
59 * \brief Impl class to manages the lifetime of the GPU streams.
61 * If supported by the GPU API, the available runtime and the
62 * indicated device, some streams will be configured at high
63 * priority. Otherwise, all streams will share the default priority
64 * appropriate to the situation.
66 class DeviceStreamManager::Impl
69 /*! \brief Constructor.
71 * \throws InternalError If any of the required resources could not be initialized.
73 Impl(const DeviceInformation& deviceInfo,
75 bool havePpDomainDecomposition,
76 bool doGpuPmePpTransfer,
82 DeviceContext context_;
83 //! GPU command streams.
84 EnumerationArray<DeviceStreamType, DeviceStream> streams_;
87 // DeviceStreamManager::Impl
88 DeviceStreamManager::Impl::Impl(const DeviceInformation& deviceInfo,
89 const bool useGpuForPme,
90 const bool havePpDomainDecomposition,
91 const bool doGpuPmePpTransfer,
92 const bool useGpuForUpdate,
93 const bool useTiming) :
98 streams_[DeviceStreamType::NonBondedLocal].init(context_, DeviceStreamPriority::Normal, useTiming);
102 /* Creating a PME GPU stream:
103 * - default high priority with CUDA
104 * - no priorities implemented yet with OpenCL; see #2532
106 streams_[DeviceStreamType::Pme].init(context_, DeviceStreamPriority::High, useTiming);
109 if (havePpDomainDecomposition)
111 streams_[DeviceStreamType::NonBondedNonLocal].init(context_, DeviceStreamPriority::High,
114 // Update stream is used both for coordinates transfers and for GPU update/constraints
115 if (useGpuForPme || useGpuForUpdate)
117 streams_[DeviceStreamType::UpdateAndConstraints].init(
118 context_, DeviceStreamPriority::Normal, useTiming);
120 if (doGpuPmePpTransfer)
122 streams_[DeviceStreamType::PmePpTransfer].init(context_, DeviceStreamPriority::Normal, useTiming);
125 GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR
128 DeviceStreamManager::Impl::~Impl() = default;
130 // DeviceStreamManager
131 DeviceStreamManager::DeviceStreamManager(const DeviceInformation& deviceInfo,
132 const bool useGpuForPme,
133 const bool havePpDomainDecomposition,
134 const bool doGpuPmePpTransfer,
135 const bool useGpuForUpdate,
136 const bool useTiming) :
137 impl_(new Impl(deviceInfo, useGpuForPme, havePpDomainDecomposition, doGpuPmePpTransfer, useGpuForUpdate, useTiming))
141 DeviceStreamManager::~DeviceStreamManager() = default;
143 const DeviceInformation& DeviceStreamManager::deviceInfo() const
145 return impl_->context_.deviceInfo();
148 const DeviceContext& DeviceStreamManager::context() const
150 return impl_->context_;
153 const DeviceStream& DeviceStreamManager::stream(DeviceStreamType streamToGet) const
155 return impl_->streams_[streamToGet];
158 const DeviceStream& DeviceStreamManager::bondedStream(bool hasPPDomainDecomposition) const
160 if (hasPPDomainDecomposition)
162 GMX_RELEASE_ASSERT(stream(DeviceStreamType::NonBondedNonLocal).isValid(),
163 "GPU non-bonded non-local stream should be valid in order to use GPU "
164 "version of bonded forces with domain decomposition.");
165 return stream(DeviceStreamType::NonBondedNonLocal);
169 GMX_RELEASE_ASSERT(stream(DeviceStreamType::NonBondedLocal).isValid(),
170 "GPU non-bonded local stream should be valid in order to use GPU "
171 "version of bonded forces without domain decomposition.");
172 return stream(DeviceStreamType::NonBondedLocal);
176 bool DeviceStreamManager::streamIsValid(DeviceStreamType streamToCheck) const
178 return impl_->streams_[streamToCheck].isValid();