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,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.
   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     {                  \
  54     }
  55 #define NULL_FUNC_TERM_WITH_RETURN(arg) \
  56     {                                   \
  57         return (arg);                   \
  58     }
  59
  60 #ifdef DOXYGEN
  61
  62 /* Doxygen build appreciates always having argument names, and doesn't
  63  * care about duplicate function definitions. */
  64 #    define GPU_FUNC_QUALIFIER REAL_FUNC_QUALIFIER
  65 #    define GPU_FUNC_ARGUMENT REAL_FUNC_ARGUMENT
  66 #    define GPU_FUNC_TERM REAL_FUNC_TERM
  67 #    define GPU_FUNC_TERM_WITH_RETURN(arg) REAL_FUNC_TERM_WITH_RETURN(arg)
  68 #    define CUDA_FUNC_QUALIFIER REAL_FUNC_QUALIFIER
  69 #    define CUDA_FUNC_ARGUMENT REAL_FUNC_ARGUMENT
  70 #    define CUDA_FUNC_TERM REAL_FUNC_TERM
  71 #    define CUDA_FUNC_TERM_WITH_RETURN(arg) REAL_FUNC_TERM_WITH_RETURN(arg)
  72 #    define OPENCL_FUNC_QUALIFIER REAL_FUNC_QUALIFIER
  73 #    define OPENCL_FUNC_ARGUMENT REAL_FUNC_ARGUMENT
  74 #    define OPENCL_FUNC_TERM REAL_FUNC_TERM
  75 #    define OPENCL_FUNC_TERM_WITH_RETURN(arg) REAL_FUNC_TERM_WITH_RETURN(arg)
  76
  77 #else // Not DOXYGEN
  78
  79 /* GPU support is enabled, so these functions will have real code defined somewhere */
  80 #    if GMX_GPU && !GMX_GPU_SYCL
  81 #        define GPU_FUNC_QUALIFIER REAL_FUNC_QUALIFIER
  82 #        define GPU_FUNC_ARGUMENT REAL_FUNC_ARGUMENT
  83 #        define GPU_FUNC_TERM REAL_FUNC_TERM
  84 #        define GPU_FUNC_TERM_WITH_RETURN(arg) REAL_FUNC_TERM_WITH_RETURN(arg)
  85 #    else
  86 #        define GPU_FUNC_QUALIFIER NULL_FUNC_QUALIFIER
  87 #        define GPU_FUNC_ARGUMENT NULL_FUNC_ARGUMENT
  88 #        define GPU_FUNC_TERM NULL_FUNC_TERM
  89 #        define GPU_FUNC_TERM_WITH_RETURN(arg) NULL_FUNC_TERM_WITH_RETURN(arg)
  90 #
  91 #    endif
  92
  93 /* Enable and disable platform-specific function implementations */
  94 #    if GMX_GPU_OPENCL
  95 #        define OPENCL_FUNC_QUALIFIER REAL_FUNC_QUALIFIER
  96 #        define OPENCL_FUNC_ARGUMENT REAL_FUNC_ARGUMENT
  97 #        define OPENCL_FUNC_TERM REAL_FUNC_TERM
  98 #        define OPENCL_FUNC_TERM_WITH_RETURN(arg) REAL_FUNC_TERM_WITH_RETURN(arg)
  99 #    else
 100 #        define OPENCL_FUNC_QUALIFIER NULL_FUNC_QUALIFIER
 101 #        define OPENCL_FUNC_ARGUMENT NULL_FUNC_ARGUMENT
 102 #        define OPENCL_FUNC_TERM NULL_FUNC_TERM
 103 #        define OPENCL_FUNC_TERM_WITH_RETURN(arg) NULL_FUNC_TERM_WITH_RETURN(arg)
 104 #    endif
 105
 106 #    if GMX_GPU_CUDA
 107 #        define CUDA_FUNC_QUALIFIER REAL_FUNC_QUALIFIER
 108 #        define CUDA_FUNC_ARGUMENT REAL_FUNC_ARGUMENT
 109 #        define CUDA_FUNC_TERM REAL_FUNC_TERM
 110 #        define CUDA_FUNC_TERM_WITH_RETURN(arg) REAL_FUNC_TERM_WITH_RETURN(arg)
 111 #    else
 112 #        define CUDA_FUNC_QUALIFIER NULL_FUNC_QUALIFIER
 113 #        define CUDA_FUNC_ARGUMENT NULL_FUNC_ARGUMENT
 114 #        define CUDA_FUNC_TERM NULL_FUNC_TERM
 115 #        define CUDA_FUNC_TERM_WITH_RETURN(arg) NULL_FUNC_TERM_WITH_RETURN(arg)
 116 #    endif
 117
 118 #endif // ifdef DOXYGEN
 119
 120 #endif // GMX_GPU_UTILS_MACROS_H