src/gromacs/gpu_utils/gpu_utils.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2010, The GROMACS development team.
   6  * Copyright (c) 2012,2013,2014,2015,2016,2017,2018, by the GROMACS development team, led by
   7  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   8  * and including many others, as listed in the AUTHORS file in the
   9  * top-level source directory and at http://www.gromacs.org.
  10  *
  11  * GROMACS is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU Lesser General Public License
  13  * as published by the Free Software Foundation; either version 2.1
  14  * of the License, or (at your option) any later version.
  15  *
  16  * GROMACS is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * Lesser General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Lesser General Public
  22  * License along with GROMACS; if not, see
  23  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  24  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  25  *
  26  * If you want to redistribute modifications to GROMACS, please
  27  * consider that scientific software is very special. Version
  28  * control is crucial - bugs must be traceable. We will be happy to
  29  * consider code for inclusion in the official distribution, but
  30  * derived work must not be called official GROMACS. Details are found
  31  * in the README & COPYING files - if they are missing, get the
  32  * official version at http://www.gromacs.org.
  33  *
  34  * To help us fund GROMACS development, we humbly ask that you cite
  35  * the research papers on the package. Check out http://www.gromacs.org.
  36  */
  37 /*! \libinternal \file
  38  *  \brief Declare functions for detection and initialization for GPU devices.
  39  *
  40  *  \author Szilard Pall <pall.szilard@gmail.com>
  41  *  \author Mark Abraham <mark.j.abraham@gmail.com>
  42  *
  43  *  \inlibraryapi
  44  */
  45 #ifndef GMX_GPU_UTILS_GPU_UTILS_H
  46 #define GMX_GPU_UTILS_GPU_UTILS_H
  47
  48 #include <cstdio>
  49
  50 #include <string>
  51 #include <vector>
  52
  53 #include "gromacs/gpu_utils/gpu_macros.h"
  54 #include "gromacs/utility/basedefinitions.h"
  55
  56 struct gmx_device_info_t;
  57 struct gmx_gpu_info_t;
  58
  59 namespace gmx
  60 {
  61 class MDLogger;
  62 }
  63
  64 //! Enum which is only used to describe transfer calls at the moment
  65 enum class GpuApiCallBehavior
  66 {
  67     Sync,
  68     Async
  69 };
  70
  71 //! Types of actions associated to waiting or checking the completion of GPU tasks
  72 enum class GpuTaskCompletion
  73 {
  74     Wait, /*<< Issue a blocking wait for the task */
  75     Check /*<< Only check whether the task has completed */
  76 };
  77
  78 /*! \brief Return whether GPUs can be detected
  79  *
  80  * Returns true when this is a build of \Gromacs configured to support
  81  * GPU usage, and a valid device driver, ICD, and/or runtime was detected.
  82  *
  83  * This function is not intended to be called from build
  84  * configurations that do not support GPUs, and there will be no
  85  * descriptive message in that case.
  86  *
  87  * \param[out] errorMessage  When returning false on a build configured with
  88  *                           GPU support and non-nullptr was passed,
  89  *                           the string contains a descriptive message about
  90  *                           why GPUs cannot be detected.
  91  *
  92  * Does not throw. */
  93 GPU_FUNC_QUALIFIER
  94 bool canDetectGpus(std::string *GPU_FUNC_ARGUMENT(errorMessage)) GPU_FUNC_TERM_WITH_RETURN(false);
  95
  96 /*! \brief Find all GPUs in the system.
  97  *
  98  *  Will detect every GPU supported by the device driver in use. Must
  99  *  only be called if canDetectGpus() has returned true. This routine
 100  *  also checks for the compatibility of each and fill the
 101  *  gpu_info->gpu_dev array with the required information on each the
 102  *  device: ID, device properties, status.
 103  *
 104  *  Note that this function leaves the GPU runtime API error state clean;
 105  *  this is implemented ATM in the CUDA flavor.
 106  *  TODO: check if errors do propagate in OpenCL as they do in CUDA and
 107  *  whether there is a mechanism to "clear" them.
 108  *
 109  *  \param[in] gpu_info    pointer to structure holding GPU information.
 110  *
 111  *  \throws                InternalError if a GPU API returns an unexpected failure (because
 112  *                         the call to canDetectGpus() should always prevent this occuring)
 113  */
 114 GPU_FUNC_QUALIFIER
 115 void findGpus(struct gmx_gpu_info_t *GPU_FUNC_ARGUMENT(gpu_info)) GPU_FUNC_TERM
 116
 117 /*! \brief Return a container of the detected GPUs that are compatible.
 118  *
 119  * This function filters the result of the detection for compatible
 120  * GPUs, based on the previously run compatibility tests.
 121  *
 122  * \param[in]     gpu_info    Information detected about GPUs, including compatibility.
 123  * \return                    vector of IDs of GPUs already recorded as compatible */
 124 std::vector<int> getCompatibleGpus(const gmx_gpu_info_t &gpu_info);
 125
 126 /*! \brief Return a string describing how compatible the GPU with given \c index is.
 127  *
 128  * \param[in]   gpu_info    Information about detected GPUs
 129  * \param[in]   index       index of GPU to ask about
 130  * \returns                 A null-terminated C string describing the compatibility status, useful for error messages.
 131  */
 132 const char *getGpuCompatibilityDescription(const gmx_gpu_info_t &GPU_FUNC_ARGUMENT(gpu_info),
 133                                            int GPU_FUNC_ARGUMENT(index));
 134
 135 /*! \brief Frees the gpu_dev and dev_use array fields of \p gpu_info.
 136  *
 137  * \param[in]    gpu_info    pointer to structure holding GPU information
 138  */
 139 GPU_FUNC_QUALIFIER
 140 void free_gpu_info(const struct gmx_gpu_info_t *GPU_FUNC_ARGUMENT(gpu_info)) GPU_FUNC_TERM
 141
 142 /*! \brief Initializes the GPU described by \c deviceInfo.
 143  *
 144  * TODO Doxygen complains about these - probably a Doxygen bug, since
 145  * the patterns here are the same as elsewhere in this header.
 146  *
 147  *  param[in]    mdlog        log file to write to
 148  * \param[inout] deviceInfo   device info of the GPU to initialize
 149  *
 150  * Issues a fatal error for any critical errors that occur during
 151  * initialization.
 152  */
 153 GPU_FUNC_QUALIFIER
 154 void init_gpu(const gmx::MDLogger &GPU_FUNC_ARGUMENT(mdlog),
 155               gmx_device_info_t *GPU_FUNC_ARGUMENT(deviceInfo)) GPU_FUNC_TERM
 156
 157 /*! \brief Frees up the CUDA GPU used by the active context at the time of calling.
 158  *
 159  * If \c deviceInfo is nullptr, then it is understood that no device
 160  * was selected so no context is active to be freed. Otherwise, the
 161  * context is explicitly destroyed and therefore all data uploaded to
 162  * the GPU is lost. This must only be called when none of this data is
 163  * required anymore, because subsequent attempts to free memory
 164  * associated with the context will otherwise fail.
 165  *
 166  * Calls gmx_warning upon errors.
 167  *
 168  * \param[in]  deviceInfo   device info of the GPU to clean up for
 169  *
 170  * \returns                 true if no error occurs during the freeing.
 171  */
 172 CUDA_FUNC_QUALIFIER
 173 void free_gpu(const gmx_device_info_t *CUDA_FUNC_ARGUMENT(deviceInfo)) CUDA_FUNC_TERM
 174
 175 /*! \brief Return a pointer to the device info for \c deviceId
 176  *
 177  * \param[in] gpu_info      GPU info of all detected devices in the system.
 178  * \param[in] deviceId      ID for the GPU device requested.
 179  *
 180  * \returns                 Pointer to the device info for \c deviceId.
 181  */
 182 GPU_FUNC_QUALIFIER
 183 gmx_device_info_t *getDeviceInfo(const gmx_gpu_info_t &GPU_FUNC_ARGUMENT(gpu_info),
 184                                  int GPU_FUNC_ARGUMENT(deviceId)) GPU_FUNC_TERM_WITH_RETURN(nullptr)
 185
 186 /*! \brief Returns the device ID of the CUDA GPU currently in use.
 187  *
 188  * The GPU used is the one that is active at the time of the call in the active context.
 189  *
 190  * \returns                 device ID of the GPU in use at the time of the call
 191  */
 192 CUDA_FUNC_QUALIFIER
 193 int get_current_cuda_gpu_device_id(void) CUDA_FUNC_TERM_WITH_RETURN(-1)
 194
 195 /*! \brief Formats and returns a device information string for a given GPU.
 196  *
 197  * Given an index *directly* into the array of available GPUs (gpu_dev)
 198  * returns a formatted info string for the respective GPU which includes
 199  * ID, name, compute capability, and detection status.
 200  *
 201  * \param[out]  s           pointer to output string (has to be allocated externally)
 202  * \param[in]   gpu_info    Information about detected GPUs
 203  * \param[in]   index       an index *directly* into the array of available GPUs
 204  */
 205 GPU_FUNC_QUALIFIER
 206 void get_gpu_device_info_string(char *GPU_FUNC_ARGUMENT(s),
 207                                 const struct gmx_gpu_info_t &GPU_FUNC_ARGUMENT(gpu_info),
 208                                 int GPU_FUNC_ARGUMENT(index)) GPU_FUNC_TERM
 209
 210 /*! \brief Returns the size of the gpu_dev_info struct.
 211  *
 212  * The size of gpu_dev_info can be used for allocation and communication.
 213  *
 214  * \returns                 size in bytes of gpu_dev_info
 215  */
 216 GPU_FUNC_QUALIFIER
 217 size_t sizeof_gpu_dev_info(void) GPU_FUNC_TERM_WITH_RETURN(0)
 218
 219 /*! \brief Returns a pointer *ptr to page-locked memory of size nbytes.
 220  *
 221  * The allocated memory is suitable to be used for data transfers between host
 222  * and GPU.
 223  * Error handling should be done within this function.
 224  */
 225 typedef void gmx_host_alloc_t (void **ptr, size_t nbytes);
 226
 227 /*! \brief Frees page-locked memory pointed to by *ptr.
 228  *
 229  * NULL should not be passed to this function.
 230  */
 231 typedef void gmx_host_free_t (void *ptr);
 232
 233 /*! \brief Set page-locked memory allocation functions used by the GPU host. */
 234 void gpu_set_host_malloc_and_free(bool               bUseGpuKernels,
 235                                   gmx_host_alloc_t **nb_alloc,
 236                                   gmx_host_free_t  **nb_free);
 237
 238
 239
 240 /*! \brief Starts the GPU profiler if mdrun is being profiled.
 241  *
 242  *  When a profiler run is in progress (based on the presence of the NVPROF_ID
 243  *  env. var.), the profiler is started to begin collecting data during the
 244  *  rest of the run (or until stopGpuProfiler is called).
 245  *
 246  *  Note that this is implemented only for the CUDA API.
 247  */
 248 CUDA_FUNC_QUALIFIER
 249 void startGpuProfiler(void) CUDA_FUNC_TERM
 250
 251
 252 /*! \brief Resets the GPU profiler if mdrun is being profiled.
 253  *
 254  * When a profiler run is in progress (based on the presence of the NVPROF_ID
 255  * env. var.), the profiler data is restet in order to eliminate the data collected
 256  * from the preceding part fo the run.
 257  *
 258  * This function should typically be called at the mdrun counter reset time.
 259  *
 260  * Note that this is implemented only for the CUDA API.
 261  */
 262 CUDA_FUNC_QUALIFIER
 263 void resetGpuProfiler(void) CUDA_FUNC_TERM
 264
 265
 266 /*! \brief Stops the CUDA profiler if mdrun is being profiled.
 267  *
 268  *  This function can be called at cleanup when skipping recording
 269  *  recording subsequent API calls from being traces/profiled is desired,
 270  *  e.g. before uninitialization.
 271  *
 272  *  Note that this is implemented only for the CUDA API.
 273  */
 274 CUDA_FUNC_QUALIFIER
 275 void stopGpuProfiler(void) CUDA_FUNC_TERM
 276
 277 //! Tells whether the host buffer was pinned for non-blocking transfers. Only implemented for CUDA.
 278 CUDA_FUNC_QUALIFIER
 279 bool isHostMemoryPinned(const void *CUDA_FUNC_ARGUMENT(h_ptr)) CUDA_FUNC_TERM_WITH_RETURN(false)
 280
 281 #endif