src/gromacs/gpu_utils/cudautils.cuh

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2014,2015, 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 #ifndef GMX_GPU_UTILS_CUDAUTILS_CUH
  36 #define GMX_GPU_UTILS_CUDAUTILS_CUH
  37
  38 #include "config.h"
  39
  40 #include <stdio.h>
  41 #ifdef HAVE_NVML
  42 #include <nvml.h>
  43 #endif /* HAVE_NVML */
  44
  45 #include "gromacs/utility/fatalerror.h"
  46
  47 /* CUDA library and hardware related defines */
  48 /* TODO list some constants instead that can be used for consistency checks to
  49    detect future devices with features that make the currect code incompatible
  50    with them (e.g. expected warp size = 32, check against the dev_info->props.warpsize). */
  51 #define WARP_SIZE           32
  52
  53 /* TODO error checking needs to be rewritten. We have 2 types of error checks needed
  54    based on where they occur in the code:
  55    - non performance-critical: these errors are unsafe to be ignored and must be
  56      _always_ checked for, e.g. initializations
  57    - performance critical: handling errors might hurt performance so care need to be taken
  58      when/if we should check for them at all, e.g. in cu_upload_X. However, we should be
  59      able to turn the check for these errors on!
  60
  61    Probably we'll need two sets of the macros below...
  62
  63  */
  64 #define CHECK_CUDA_ERRORS
  65
  66 #ifdef CHECK_CUDA_ERRORS
  67
  68 /*! Check for CUDA error on the return status of a CUDA RT API call. */
  69 #define CU_RET_ERR(status, msg) \
  70     do { \
  71         if (status != cudaSuccess) \
  72         { \
  73             gmx_fatal(FARGS, "%s: %s\n", msg, cudaGetErrorString(status)); \
  74         } \
  75     } while (0)
  76
  77 /*! Check for any previously occurred uncaught CUDA error. */
  78 #define CU_CHECK_PREV_ERR() \
  79     do { \
  80         cudaError_t _CU_CHECK_PREV_ERR_status = cudaGetLastError(); \
  81         if (_CU_CHECK_PREV_ERR_status != cudaSuccess) { \
  82             gmx_warning("Just caught a previously occurred CUDA error (%s), will try to continue.", cudaGetErrorString(_CU_CHECK_PREV_ERR_status)); \
  83         } \
  84     } while (0)
  85
  86 /*! Check for any previously occurred uncaught CUDA error
  87    -- aimed at use after kernel calls. */
  88 #define CU_LAUNCH_ERR(msg) \
  89     do { \
  90         cudaError_t _CU_LAUNCH_ERR_status = cudaGetLastError(); \
  91         if (_CU_LAUNCH_ERR_status != cudaSuccess) { \
  92             gmx_fatal(FARGS, "Error while launching kernel %s: %s\n", msg, cudaGetErrorString(_CU_LAUNCH_ERR_status)); \
  93         } \
  94     } while (0)
  95
  96 /*! Synchronize with GPU and check for any previously occurred uncaught CUDA error
  97    -- aimed at use after kernel calls. */
  98 #define CU_LAUNCH_ERR_SYNC(msg) \
  99     do { \
 100         cudaError_t _CU_SYNC_LAUNCH_ERR_status = cudaThreadSynchronize(); \
 101         if (_CU_SYNC_LAUNCH_ERR_status != cudaSuccess) { \
 102             gmx_fatal(FARGS, "Error while launching kernel %s: %s\n", msg, cudaGetErrorString(_CU_SYNC_LAUNCH_ERR_status)); \
 103         } \
 104     } while (0)
 105
 106 #else /* CHECK_CUDA_ERRORS */
 107
 108 #define CU_RET_ERR(status, msg) do { } while (0)
 109 #define CU_CHECK_PREV_ERR()     do { } while (0)
 110 #define CU_LAUNCH_ERR(msg)      do { } while (0)
 111 #define CU_LAUNCH_ERR_SYNC(msg) do { } while (0)
 112 #define HANDLE_NVML_RET_ERR(status, msg) do { } while (0)
 113
 114 #endif /* CHECK_CUDA_ERRORS */
 115
 116 /*! CUDA device information. */
 117 struct gmx_device_info_t
 118 {
 119     int                 id;                     /* id of the CUDA device */
 120     cudaDeviceProp      prop;                   /* CUDA device properties */
 121     int                 stat;                   /* result of the device check */
 122     gmx_bool            nvml_initialized;       /* If NVML was initialized */
 123     gmx_bool            nvml_ap_clocks_changed; /* If application clocks have been changed */
 124 #ifdef HAVE_NVML
 125     nvmlDevice_t        nvml_device_id;         /* NVML device id */
 126     nvmlEnableState_t   nvml_is_restricted;     /* Status of application clocks permission */
 127 #endif                                          /* HAVE_NVML */
 128 };
 129
 130
 131 /*! Launches asynchronous host to device memory copy in stream 0. */
 132 int cu_copy_D2H(void * /*h_dest*/, void * /*d_src*/, size_t /*bytes*/);
 133
 134 /*! Launches asynchronous host to device memory copy in stream s. */
 135 int cu_copy_D2H_async(void * /*h_dest*/, void * /*d_src*/, size_t /*bytes*/, cudaStream_t /*s = 0*/);
 136
 137 /*! Allocates host memory and launches synchronous host to device memory copy. */
 138 int cu_copy_D2H_alloc(void ** /*h_dest*/, void * /*d_src*/, size_t /*bytes*/);
 139
 140
 141 /*! Launches synchronous host to device memory copy. */
 142 int cu_copy_H2D(void * /*d_dest*/, void * /*h_src*/, size_t /*bytes*/);
 143
 144 /*! Launches asynchronous host to device memory copy in stream s. */
 145 int cu_copy_H2D_async(void * /*d_dest*/, void * /*h_src*/, size_t /*bytes*/, cudaStream_t /*s = 0*/);
 146
 147 /*! Allocates device memory and launches synchronous host to device memory copy. */
 148 int cu_copy_H2D_alloc(void ** /*d_dest*/, void * /*h_src*/, size_t /*bytes*/);
 149
 150 /*! Frees device memory and resets the size and allocation size to -1. */
 151 void cu_free_buffered(void *d_ptr, int *n = NULL, int *nalloc = NULL);
 152
 153 /*! Reallocates the device memory and copies data from the host. */
 154 void cu_realloc_buffered(void **d_dest, void *h_src,
 155                          size_t type_size,
 156                          int *curr_size, int *curr_alloc_size,
 157                          int req_size,
 158                          cudaStream_t s,
 159                          bool bAsync);
 160
 161 /*! Waits for event e to complete, */
 162 int cu_wait_event(cudaEvent_t /*e*/);
 163
 164 /*! Calculates and returns the time elapsed between event start and end. */
 165 float cu_event_elapsed(cudaEvent_t /*start*/, cudaEvent_t /*end*/);
 166
 167 /*! Waits for event end to complete and calculates the time between start and end. */
 168 int cu_wait_event_time(cudaEvent_t /*end*/, cudaEvent_t /*begin*/, float * /*time*/);
 169
 170 #endif