include/gmx_detect_hardware.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013, 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
  36 #ifndef GMX_HARDWARE_DETECT_H
  37 #define GMX_HARDWARE_DETECT_H
  38 #include "visibility.h"
  39 #include "types/hw_info.h"
  40
  41 #ifdef __cplusplus
  42 extern "C" {
  43 #endif
  44 #if 0
  45 } /* fixes auto-indentation problems */
  46 #endif
  47
  48 /* the init and consistency functions depend on commrec that may not be
  49    consistent in cuda because MPI types don't exist there.  */
  50 #ifndef __CUDACC__
  51 #include "types/commrec.h"
  52 /* return a pointer to a global hwinfo structure. */
  53 GMX_LIBGMX_EXPORT
  54 gmx_hw_info_t *gmx_detect_hardware(FILE *fplog, const t_commrec *cr,
  55                                    gmx_bool bForceUseGPU, gmx_bool bTryUseGPU,
  56                                    const char *gpu_id);
  57
  58 GMX_LIBGMX_EXPORT
  59 void gmx_hardware_info_free(gmx_hw_info_t *hwinfo);
  60
  61 /* Check the thread count + GPU assignment. This function must
  62    either be run by all threads that persist (i.e. all tmpi threads),
  63    or be run before they are created.  */
  64 GMX_LIBGMX_EXPORT
  65 void gmx_check_hw_runconf_consistency(FILE *fplog, gmx_hw_info_t *hwinfo,
  66                                       const t_commrec *cr, int ntmpi_requsted,
  67                                       gmx_bool bUseGPU);
  68 #endif
  69
  70
  71 /* Check whether a GPU is shared among ranks, and return the number of shared
  72    gpus
  73
  74    hwinfo        = the hwinfo struct
  75
  76    returns: The number of GPUs shared among ranks, or 0 */
  77 GMX_LIBGMX_EXPORT
  78 int gmx_count_gpu_dev_shared(const gmx_gpu_info_t *gpu_info);
  79
  80
  81 #ifdef __cplusplus
  82 }
  83 #endif
  84
  85
  86 #endif /* GMX_HARDWARE_DETECT_H */