Merge release-5-0 into master
[alexxy/gromacs.git] / src / gromacs / mdlib / nbnxn_simd.h
1 /*
2  * This file is part of the GROMACS molecular simulation package.
3  *
4  * Copyright (c) 2014, 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
36 #ifndef _nbnxn_simd_h
37 #define _nbnxn_simd_h
38
39 #include "config.h"
40
41 #include "gromacs/legacyheaders/typedefs.h"
42
43 /* Include SIMD, below we select kernels based on the SIMD width */
44 #include "gromacs/simd/simd.h"
45 #include "gromacs/simd/simd_math.h"
46
47
48 #ifdef GMX_SIMD_REFERENCE
49 #define GMX_NBNXN_SIMD
50 #endif
51
52 /* As we modularize the verlet kernels, we should remove stuff like this
53  * that checks internal SIMD implementation details.
54  */
55 #if (defined GMX_SIMD_X86_SSE2) || (defined GMX_SIMD_X86_SSE4_1) || \
56     (defined GMX_SIMD_X86_AVX_128_FMA) || (defined GMX_SIMD_X86_AVX_256) || \
57     (defined GMX_SIMD_X86_AVX2_256) || (defined GMX_SIMD_IBM_QPX)
58 /* Use SIMD accelerated nbnxn search and kernels */
59 #define GMX_NBNXN_SIMD
60 #endif
61
62 /* MIC for double is implemented in the SIMD module but so far missing in
63    mdlib/nbnxn_kernels/nbnxn_kernel_simd_utils_x86_mic.h */
64 #if defined __MIC__ && !defined GMX_DOUBLE
65 #define GMX_NBNXN_SIMD
66 #endif
67
68 #ifdef GMX_NBNXN_SIMD
69 /* The nbnxn SIMD 4xN and 2x(N+N) kernels can be added independently.
70  * Currently the 2xNN SIMD kernels only make sense with:
71  *  8-way SIMD: 4x4 setup, works with AVX-256 in single precision
72  * 16-way SIMD: 4x8 setup, works with Intel MIC in single precision
73  */
74 #if GMX_SIMD_REAL_WIDTH == 2 || GMX_SIMD_REAL_WIDTH == 4 || GMX_SIMD_REAL_WIDTH == 8
75 #define GMX_NBNXN_SIMD_4XN
76 #endif
77 #if GMX_SIMD_REAL_WIDTH == 8 || GMX_SIMD_REAL_WIDTH == 16
78 #define GMX_NBNXN_SIMD_2XNN
79 #endif
80
81 #if !(defined GMX_NBNXN_SIMD_4XN || defined GMX_NBNXN_SIMD_2XNN)
82 #error "No SIMD kernel type defined"
83 #endif
84
85 #endif /* GMX_NBNXN_SIMD */
86
87 #endif /* _nbnxn_simd_h */