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 #ifndef GMX_NATIVE_WINDOWS
  57 /* Ugly hack because the openmp implementation below hacks into the SIMD
  58  * settings to decide when to use _mm_pause(). This should eventually be
  59  * changed into proper detection of the intrinsics uses, not SIMD.
  60  */
  61 #if (defined GMX_SIMD_X86_SSE2) || (defined GMX_SIMD_X86_SSE4_1) || \
  62     (defined GMX_SIMD_X86_AVX_128_FMA) || (defined GMX_SIMD_X86_AVX_256) || \
  63     (defined GMX_SIMD_X86_AVX2_256)
  64 #    include <xmmintrin.h>
  65 #endif
  66 #else
  67 #include <windows.h>
  68 #endif
  69
  70 #include "types/commrec.h"
  71 #include "mdrun.h"
  72
  73 #ifdef __cplusplus
  74 extern "C"
  75 {
  76 #endif
  77
  78 /*! \addtogroup module_utility
  79  * \{
  80  */
  81
  82 /*! \brief
  83  * Returns an integer equal to or greater than the number of threads
  84  * that would be available if a parallel region without num_threads were
  85  * defined at that point in the code.
  86  *
  87  * Acts as a wrapper for omp_get_max_threads().
  88  */
  89 int gmx_omp_get_max_threads(void);
  90
  91 /*! \brief
  92  * Returns the number of processors available when the function is called.
  93  *
  94  * Acts as a wrapper around omp_get_num_procs().
  95  */
  96 int gmx_omp_get_num_procs(void);
  97
  98 /*! \brief
  99  * Returns the thread number of the thread executing within its thread team.
 100  *
 101  * Acts as a wrapper for omp_get_thread_num().
 102  */
 103 int gmx_omp_get_thread_num(void);
 104
 105 /*! \brief
 106  * Sets the number of threads in subsequent parallel regions, unless overridden
 107  * by a num_threads clause.
 108  *
 109  * Acts as a wrapper for omp_set_num_threads().
 110  */
 111 void gmx_omp_set_num_threads(int num_threads);
 112
 113 /*! \brief
 114  * Check for externally set thread affinity to avoid conflicts with \Gromacs
 115  * internal setting.
 116  */
 117 void gmx_omp_check_thread_affinity(FILE *fplog, const t_commrec *cr,
 118                                    gmx_hw_opt_t *hw_opt);
 119
 120 /*! \brief
 121  * Pause for use in a spin-wait loop.
 122  */
 123 static gmx_inline void gmx_pause()
 124 {
 125 #ifndef _MSC_VER
 126     /* Ugly hack because the openmp implementation below hacks into the SIMD
 127      * settings to decide when to use _mm_pause(). This should eventually be
 128      * changed into proper detection of the intrinsics uses, not SIMD.
 129      */
 130 #if ((defined GMX_SIMD_X86_SSE2) || (defined GMX_SIMD_X86_SSE4_1) || \
 131     (defined GMX_SIMD_X86_AVX_128_FMA) || (defined GMX_SIMD_X86_AVX_256) || \
 132     (defined GMX_SIMD_X86_AVX2_256)) && !defined(__MINGW32__)
 133     /* Replace with tbb::internal::atomic_backoff when/if we use TBB */
 134     _mm_pause();
 135 #elif defined __MIC__
 136     _mm_delay_32(32);
 137 #else
 138     /* No wait for unknown architecture */
 139 #endif
 140 #else
 141     YieldProcessor();
 142 #endif
 143 }
 144
 145 /*! \} */
 146
 147 #ifdef __cplusplus
 148 }
 149 #endif
 150
 151 #endif