713a1224d473ae84cef84c27c4042c7d7b4480d5
[alexxy/gromacs.git] / src / gromacs / gpu_utils / cuda_arch_utils.cuh
1 /*
2  * This file is part of the GROMACS molecular simulation package.
3  *
4  * Copyright (c) 2012,2014,2015,2016,2017,2018,2019, 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 CUDA_ARCH_UTILS_CUH_
36 #define CUDA_ARCH_UTILS_CUH_
37
38 #include "gromacs/utility/basedefinitions.h"
39
40 /*! \file
41  *  \brief CUDA arch dependent definitions.
42  *
43  *  \author Szilard Pall <pall.szilard@gmail.com>
44  */
45
46 /* GMX_PTX_ARCH is set to the virtual arch (PTX) version targeted by
47  * the current compiler pass or zero for the host pass and it is
48  * intended to be used instead of __CUDA_ARCH__.
49  */
50 #ifndef __CUDA_ARCH__
51 #    define GMX_PTX_ARCH 0
52 #else
53 #    define GMX_PTX_ARCH __CUDA_ARCH__
54 #endif
55
56 /* Until CC 5.2 and likely for the near future all NVIDIA architectures
57    have a warp size of 32, but this could change later. If it does, the
58    following constants should depend on the value of GMX_PTX_ARCH.
59  */
60 static const int warp_size      = 32;
61 static const int warp_size_log2 = 5;
62 /*! \brief Bitmask corresponding to all threads active in a warp.
63  *  NOTE that here too we assume 32-wide warps.
64  */
65 static const unsigned int c_fullWarpMask = 0xffffffff;
66
67 /*! \brief Allow disabling CUDA textures using the GMX_DISABLE_CUDA_TEXTURES macro.
68  *
69  *  Only texture objects supported.
70  *  Disable texture support missing in clang (all versions up to <=5.0-dev as of writing).
71  *
72  *  This option will not influence functionality. All features using textures ought
73  *  to have fallback for texture-less reads (direct/LDG loads), all new code needs
74  *  to provide fallback code.
75  */
76 #if defined(GMX_DISABLE_CUDA_TEXTURES) || (defined(__clang__) && defined(__CUDA__))
77 #    define DISABLE_CUDA_TEXTURES 1
78 #else
79 #    define DISABLE_CUDA_TEXTURES 0
80 #endif
81
82 /*! \brief True if the use of texture fetch in the CUDA kernels is disabled. */
83 static const bool c_disableCudaTextures = DISABLE_CUDA_TEXTURES;
84
85
86 /* CUDA architecture technical characteristics. Needs macros because it is used
87  * in the __launch_bounds__ function qualifiers and might need it in preprocessor
88  * conditionals.
89  *
90  */
91 #if GMX_PTX_ARCH > 0
92 #    if GMX_PTX_ARCH <= 370 // CC 3.x
93 #        define GMX_CUDA_MAX_BLOCKS_PER_MP 16
94 #        define GMX_CUDA_MAX_THREADS_PER_MP 2048
95 #    else // CC 5.x, 6.x
96 /* Note that this final branch covers all future architectures (current gen
97  * is 6.x as of writing), hence assuming that these *currently defined* upper
98  * limits will not be lowered.
99  */
100 #        define GMX_CUDA_MAX_BLOCKS_PER_MP 32
101 #        define GMX_CUDA_MAX_THREADS_PER_MP 2048
102 #    endif
103 #else
104 #    define GMX_CUDA_MAX_BLOCKS_PER_MP 0
105 #    define GMX_CUDA_MAX_THREADS_PER_MP 0
106 #endif
107
108 // Macro defined for clang CUDA device compilation in the presence of debug symbols
109 // used to work around codegen bug that breaks some kernels when assertions are on
110 // at -O1 and higher (tested with clang 6-8).
111 #if defined(__clang__) && defined(__CUDA__) && defined(__CUDA_ARCH__) && !defined(NDEBUG)
112 #    define CLANG_DISABLE_OPTIMIZATION_ATTRIBUTE __attribute__((optnone))
113 #else
114 #    define CLANG_DISABLE_OPTIMIZATION_ATTRIBUTE
115 #endif
116
117
118 #endif /* CUDA_ARCH_UTILS_CUH_ */