src/gromacs/utility/gmxomp.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014,2015,2016,2018, 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 #include "config.h"
  53
  54 #include <stdio.h>
  55
  56 #if !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 GMX_SIMD_X86_SSE2 || GMX_SIMD_X86_SSE4_1 || GMX_SIMD_X86_AVX_128_FMA || \
  62     GMX_SIMD_X86_AVX_256 || GMX_SIMD_X86_AVX2_256
  63 #    include <xmmintrin.h>
  64 #endif
  65 #else
  66 #include <windows.h>
  67 #endif
  68
  69 #include "gromacs/utility/basedefinitions.h"
  70
  71 /*! \addtogroup module_utility
  72  * \{
  73  */
  74
  75 /*! \brief
  76  * Returns an integer equal to or greater than the number of threads
  77  * that would be available if a parallel region without num_threads were
  78  * defined at that point in the code.
  79  *
  80  * Acts as a wrapper for omp_get_max_threads().
  81  */
  82 int gmx_omp_get_max_threads();
  83
  84 /*! \brief
  85  * Returns the number of processors available when the function is called.
  86  *
  87  * Acts as a wrapper around omp_get_num_procs().
  88  */
  89 int gmx_omp_get_num_procs();
  90
  91 /*! \brief
  92  * Returns the thread number of the thread executing within its thread team.
  93  *
  94  * Acts as a wrapper for omp_get_thread_num().
  95  */
  96 int gmx_omp_get_thread_num();
  97
  98 /*! \brief
  99  * Sets the number of threads in subsequent parallel regions, unless overridden
 100  * by a num_threads clause.
 101  *
 102  * Acts as a wrapper for omp_set_num_threads().
 103  */
 104 void gmx_omp_set_num_threads(int num_threads);
 105
 106 /*! \brief
 107  * Check for externally set thread affinity to avoid conflicts with \Gromacs
 108  * internal setting.
 109  *
 110  * \param[out] message  Receives the message to be shown to the user.
 111  * \returns `true` if we can set thread affinity ourselves.
 112  *
 113  * The KMP_AFFINITY environment variable is used by Intel, GOMP_CPU_AFFINITY
 114  * by the GNU compilers (Intel also honors it well).  If any of the variables
 115  * is set, we should honor it and disable the internal pinning.
 116  *
 117  * If this function returns `false`, the caller is responsible to disable the
 118  * pinning, show the message from \p *message to the user, and free the memory
 119  * allocated for \p *message.
 120  * If the return value is `true`, \p *message is NULL.
 121  */
 122 gmx_bool gmx_omp_check_thread_affinity(char **message);
 123
 124 /*! \brief
 125  * Pause for use in a spin-wait loop.
 126  */
 127 static inline void gmx_pause()
 128 {
 129 #ifndef _MSC_VER
 130     /* Ugly hack because the openmp implementation below hacks into the SIMD
 131      * settings to decide when to use _mm_pause(). This should eventually be
 132      * changed into proper detection of the intrinsics uses, not SIMD.
 133      */
 134 #if (GMX_SIMD_X86_SSE2 || GMX_SIMD_X86_SSE4_1 || GMX_SIMD_X86_AVX_128_FMA || \
 135      GMX_SIMD_X86_AVX_256 || GMX_SIMD_X86_AVX2_256) && !defined(__MINGW32__)
 136     /* Replace with tbb::internal::atomic_backoff when/if we use TBB */
 137     _mm_pause();
 138 #elif defined __MIC__
 139     _mm_delay_32(32);
 140 #else
 141     /* No wait for unknown architecture */
 142 #endif
 143 #else
 144     YieldProcessor();
 145 #endif
 146 }
 147
 148 /*! \} */
 149
 150 #endif