include/gmx_thread_affinity.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012, by the GROMACS development team, led by
   5  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   6  * others, as listed in the AUTHORS file in the top-level source
   7  * 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 GMX_THREAD_AFFINITY_H_
  36 #define GMX_THREAD_AFFINITY_H_
  37 #include "visibility.h"
  38 #include "types/commrec.h"
  39 #include "typedefs.h"
  40
  41 #ifdef __cplusplus
  42 extern "C" {
  43 #endif
  44 #if 0
  45 } /* fixes auto-indentation problems */
  46 #endif
  47
  48 /* Sets the thread affinity using the requested setting stored in hw_opt.
  49  * The hardware topologu is requested from hwinfo, when present.
  50  */
  51 GMX_LIBGMX_EXPORT
  52 void
  53 gmx_set_thread_affinity(FILE                *fplog,
  54                         const t_commrec     *cr,
  55                         gmx_hw_opt_t        *hw_opt,
  56                         int                  nthreads_pme,
  57                         const gmx_hw_info_t *hwinfo,
  58                         const t_inputrec    *inputrec);
  59
  60 /* Check the process affinity mask and if it is found to be non-zero,
  61  * will honor it and disable mdrun internal affinity setting.
  62  * This function should be called first before the OpenMP library gets
  63  * initialized with the last argument FALSE (which will detect affinity
  64  * set by external tools like taskset), and later, after the OpenMP
  65  * initialization, with the last argument TRUE to detect affinity changes
  66  * made by the OpenMP library.
  67  *
  68  * Note that this will only work on Linux as we use a GNU feature.
  69  */
  70 GMX_LIBGMX_EXPORT
  71 void
  72 gmx_check_thread_affinity_set(FILE *fplog, const t_commrec *cr,
  73                               gmx_hw_opt_t *hw_opt, int ncpus,
  74                               gmx_bool bAfterOpenmpInit);
  75
  76 #ifdef __cplusplus
  77 }
  78 #endif
  79
  80 #endif /* GMX_THREAD_AFFINITY_H_ */