Merge release-4-6 into master
[alexxy/gromacs.git] / src / gromacs / utility / gmxomp.h
1 /*
2  * This file is part of the GROMACS molecular simulation package.
3  *
4  * Copyright (c) 2012,2013,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 /*! \libinternal \file
36  * \brief
37  * Declares OpenMP wrappers to avoid conditional compilation.
38  *
39  * This module defines wrappers for OpenMP API functions and enables compiling
40  * code without conditional compilation even when OpenMP is turned off in the
41  * build system.
42  * Therefore, OpenMP API functions should always be used through these wrappers
43  * and omp.h should never be directly included.  Instead, this header should be
44  * used whenever OpenMP API functions are needed.
45  *
46  * \inlibraryapi
47  * \ingroup module_utility
48  */
49 #ifndef GMX_UTILITY_OMP_H
50 #define GMX_UTILITY_OMP_H
51
52 #ifdef HAVE_CONFIG_H
53 #include "config.h"
54 #endif
55
56 /* Ugly hack because the openmp implementation below hacks into the SIMD
57  * settings to decide when to use _mm_pause(). This should eventually be
58  * changed into proper detection of the intrinsics uses, not SIMD.
59  */
60 #if (defined GMX_SIMD_X86_SSE2) || (defined GMX_SIMD_X86_SSE4_1) || \
61     (defined GMX_SIMD_X86_AVX_128_FMA) || (defined GMX_SIMD_X86_AVX_256) || \
62     (defined GMX_SIMD_X86_AVX2_256)
63 #    include <xmmintrin.h>
64 #endif
65
66 #include "types/commrec.h"
67 #include "mdrun.h"
68
69 #ifdef __cplusplus
70 extern "C"
71 {
72 #endif
73
74 /*! \addtogroup module_utility
75  * \{
76  */
77
78 /*! \brief
79  * Returns an integer equal to or greater than the number of threads
80  * that would be available if a parallel region without num_threads were
81  * defined at that point in the code.
82  *
83  * Acts as a wrapper for omp_get_max_threads().
84  */
85 int gmx_omp_get_max_threads(void);
86
87 /*! \brief
88  * Returns the number of processors available when the function is called.
89  *
90  * Acts as a wrapper around omp_get_num_procs().
91  */
92 int gmx_omp_get_num_procs(void);
93
94 /*! \brief
95  * Returns the thread number of the thread executing within its thread team.
96  *
97  * Acts as a wrapper for omp_get_thread_num().
98  */
99 int gmx_omp_get_thread_num(void);
100
101 /*! \brief
102  * Sets the number of threads in subsequent parallel regions, unless overridden
103  * by a num_threads clause.
104  *
105  * Acts as a wrapper for omp_set_num_threads().
106  */
107 void gmx_omp_set_num_threads(int num_threads);
108
109 /*! \brief
110  * Check for externally set thread affinity to avoid conflicts with \Gromacs
111  * internal setting.
112  */
113 void gmx_omp_check_thread_affinity(FILE *fplog, const t_commrec *cr,
114                                    gmx_hw_opt_t *hw_opt);
115
116 /*! \brief
117  * Pause for use in a spin-wait loop.
118  */
119 static gmx_inline void gmx_pause()
120 {
121     /* Ugly hack because the openmp implementation below hacks into the SIMD
122      * settings to decide when to use _mm_pause(). This should eventually be
123      * changed into proper detection of the intrinsics uses, not SIMD.
124      */
125 #if (defined GMX_SIMD_X86_SSE2) || (defined GMX_SIMD_X86_SSE4_1) || \
126     (defined GMX_SIMD_X86_AVX_128_FMA) || (defined GMX_SIMD_X86_AVX_256) || \
127     (defined GMX_SIMD_X86_AVX2_256)
128     /* Replace with tbb::internal::atomic_backoff when/if we use TBB */
129     _mm_pause();
130 #elif defined __MIC__
131     _mm_delay_32(32);
132 #else
133     /* No wait for unknown architecture */
134 #endif
135 }
136
137 /*! \} */
138
139 #ifdef __cplusplus
140 }
141 #endif
142
143 #endif