src/gromacs/legacyheaders/gmx_thread_affinity.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014,2015, 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 #ifndef GMX_THREAD_AFFINITY_H_
  36 #define GMX_THREAD_AFFINITY_H_
  37
  38 #include <stdio.h>
  39
  40 #include "gromacs/legacyheaders/types/hw_info.h"
  41 #include "gromacs/utility/basedefinitions.h"
  42
  43 #ifdef __cplusplus
  44 extern "C" {
  45 #endif
  46 #if 0
  47 } /* fixes auto-indentation problems */
  48 #endif
  49
  50 struct t_commrec;
  51
  52 /* Sets the thread affinity using the requested setting stored in hw_opt.
  53  * The hardware topologu is requested from hwinfo, when present.
  54  */
  55 void
  56 gmx_set_thread_affinity(FILE                       *fplog,
  57                         const struct t_commrec     *cr,
  58                         const gmx_hw_opt_t         *hw_opt,
  59                         const gmx_hw_info_t        *hwinfo);
  60
  61 /* Check the process affinity mask and if it is found to be non-zero,
  62  * will honor it and disable mdrun internal affinity setting.
  63  * This function should be called first before the OpenMP library gets
  64  * initialized with the last argument FALSE (which will detect affinity
  65  * set by external tools like taskset), and later, after the OpenMP
  66  * initialization, with the last argument TRUE to detect affinity changes
  67  * made by the OpenMP library.
  68  *
  69  * Note that this will only work on Linux as we use a GNU feature.
  70  * With bAfterOpenmpInit false, it will also detect whether OpenMP environment
  71  * variables for setting the affinity are set.
  72  */
  73 void
  74 gmx_check_thread_affinity_set(FILE *fplog, const struct t_commrec *cr,
  75                               gmx_hw_opt_t *hw_opt, int ncpus,
  76                               gmx_bool bAfterOpenmpInit);
  77
  78 #ifdef __cplusplus
  79 }
  80 #endif
  81
  82 #endif /* GMX_THREAD_AFFINITY_H_ */