src/gromacs/gpu_utils/gpu_macros.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2014,2015,2017,2018, 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_MACROS_H
  36 #define GMX_GPU_UTILS_MACROS_H
  37
  38 #include "config.h"
  39
  40 #include "gromacs/utility/basedefinitions.h" // for gmx_unused
  41
  42 /* These macros that let us define inlineable null implementations so
  43    that non-GPU Gromacs can run with no overhead without conditionality
  44    everywhere a GPU function is called. */
  45 #define REAL_FUNC_QUALIFIER
  46 #define REAL_FUNC_ARGUMENT(arg) arg
  47 #define REAL_FUNC_TERM ;
  48 #define REAL_FUNC_TERM_WITH_RETURN(arg) ;
  49
  50 #define NULL_FUNC_QUALIFIER gmx_unused static
  51 #define NULL_FUNC_ARGUMENT(arg) arg gmx_unused
  52 #define NULL_FUNC_TERM {}
  53 #define NULL_FUNC_TERM_WITH_RETURN(arg) { return (arg); }
  54
  55 #ifdef DOXYGEN
  56
  57 /* Doxygen build appreciates always having argument names, and doesn't
  58  * care about duplicate function definitions. */
  59 #define GPU_FUNC_QUALIFIER REAL_FUNC_QUALIFIER
  60 #define GPU_FUNC_ARGUMENT REAL_FUNC_ARGUMENT
  61 #define GPU_FUNC_TERM REAL_FUNC_TERM
  62 #define GPU_FUNC_TERM_WITH_RETURN(arg) REAL_FUNC_TERM_WITH_RETURN(arg)
  63 #define CUDA_FUNC_QUALIFIER REAL_FUNC_QUALIFIER
  64 #define CUDA_FUNC_ARGUMENT REAL_FUNC_ARGUMENT
  65 #define CUDA_FUNC_TERM REAL_FUNC_TERM
  66 #define CUDA_FUNC_TERM_WITH_RETURN(arg) REAL_FUNC_TERM_WITH_RETURN(arg)
  67 #define OPENCL_FUNC_QUALIFIER REAL_FUNC_QUALIFIER
  68 #define OPENCL_FUNC_ARGUMENT REAL_FUNC_ARGUMENT
  69 #define OPENCL_FUNC_TERM REAL_FUNC_TERM
  70 #define OPENCL_FUNC_TERM_WITH_RETURN(arg) REAL_FUNC_TERM_WITH_RETURN(arg)
  71
  72 #elif GMX_GPU != GMX_GPU_NONE
  73
  74 /* GPU support is enabled, so these functions will have real code
  75  * defined somewhere */
  76 #define GPU_FUNC_QUALIFIER REAL_FUNC_QUALIFIER
  77 #define GPU_FUNC_ARGUMENT REAL_FUNC_ARGUMENT
  78 #define GPU_FUNC_TERM REAL_FUNC_TERM
  79 #define GPU_FUNC_TERM_WITH_RETURN(arg) REAL_FUNC_TERM_WITH_RETURN(arg)
  80
  81 #  if GMX_GPU == GMX_GPU_OPENCL
  82
  83 /* OpenCL support is enabled, so CUDA-specific functions need empty
  84  * implementations, while OpenCL-specific functions will have real
  85  * code defined somewhere. */
  86 #define CUDA_FUNC_QUALIFIER NULL_FUNC_QUALIFIER
  87 #define CUDA_FUNC_ARGUMENT NULL_FUNC_ARGUMENT
  88 #define CUDA_FUNC_TERM NULL_FUNC_TERM
  89 #define CUDA_FUNC_TERM_WITH_RETURN(arg) NULL_FUNC_TERM_WITH_RETURN(arg)
  90 #define OPENCL_FUNC_QUALIFIER REAL_FUNC_QUALIFIER
  91 #define OPENCL_FUNC_ARGUMENT REAL_FUNC_ARGUMENT
  92 #define OPENCL_FUNC_TERM REAL_FUNC_TERM
  93 #define OPENCL_FUNC_TERM_WITH_RETURN(arg) REAL_FUNC_TERM_WITH_RETURN(arg)
  94
  95 #  endif
  96 #  if GMX_GPU == GMX_GPU_CUDA
  97
  98 /* CUDA support is enabled, so OpenCL-specific functions need empty
  99  * implementations, while CUDA-specific functions will have real
 100  * code defined somewhere. */
 101 #define CUDA_FUNC_QUALIFIER REAL_FUNC_QUALIFIER
 102 #define CUDA_FUNC_ARGUMENT REAL_FUNC_ARGUMENT
 103 #define CUDA_FUNC_TERM REAL_FUNC_TERM
 104 #define CUDA_FUNC_TERM_WITH_RETURN(arg) REAL_FUNC_TERM_WITH_RETURN(arg)
 105 #define OPENCL_FUNC_QUALIFIER NULL_FUNC_QUALIFIER
 106 #define OPENCL_FUNC_ARGUMENT NULL_FUNC_ARGUMENT
 107 #define OPENCL_FUNC_TERM NULL_FUNC_TERM
 108 #define OPENCL_FUNC_TERM_WITH_RETURN(arg) NULL_FUNC_TERM_WITH_RETURN(arg)
 109
 110 #  endif
 111
 112 #elif GMX_GPU == GMX_GPU_NONE
 113
 114 /* No GPU support is configured, so none of these functions will have
 115  * real definitions. */
 116 #define GPU_FUNC_QUALIFIER NULL_FUNC_QUALIFIER
 117 #define GPU_FUNC_ARGUMENT NULL_FUNC_ARGUMENT
 118 #define GPU_FUNC_TERM NULL_FUNC_TERM
 119 #define GPU_FUNC_TERM_WITH_RETURN(arg) NULL_FUNC_TERM_WITH_RETURN(arg)
 120 #define CUDA_FUNC_QUALIFIER NULL_FUNC_QUALIFIER
 121 #define CUDA_FUNC_ARGUMENT NULL_FUNC_ARGUMENT
 122 #define CUDA_FUNC_TERM NULL_FUNC_TERM
 123 #define CUDA_FUNC_TERM_WITH_RETURN(arg) NULL_FUNC_TERM_WITH_RETURN(arg)
 124 #define OPENCL_FUNC_QUALIFIER NULL_FUNC_QUALIFIER
 125 #define OPENCL_FUNC_ARGUMENT NULL_FUNC_ARGUMENT
 126 #define OPENCL_FUNC_TERM NULL_FUNC_TERM
 127 #define OPENCL_FUNC_TERM_WITH_RETURN(arg) NULL_FUNC_TERM_WITH_RETURN(arg)
 128
 129 #endif
 130
 131 #endif