include/gpu_utils.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2010, The GROMACS development team,
   6  * check out http://www.gromacs.org for more information.
   7  * Copyright (c) 2012,2013, by the GROMACS development team, led by
   8  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   9  * others, as listed in the AUTHORS file in the top-level source
  10  * directory and at http://www.gromacs.org.
  11  *
  12  * GROMACS is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU Lesser General Public License
  14  * as published by the Free Software Foundation; either version 2.1
  15  * of the License, or (at your option) any later version.
  16  *
  17  * GROMACS is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public
  23  * License along with GROMACS; if not, see
  24  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  26  *
  27  * If you want to redistribute modifications to GROMACS, please
  28  * consider that scientific software is very special. Version
  29  * control is crucial - bugs must be traceable. We will be happy to
  30  * consider code for inclusion in the official distribution, but
  31  * derived work must not be called official GROMACS. Details are found
  32  * in the README & COPYING files - if they are missing, get the
  33  * official version at http://www.gromacs.org.
  34  *
  35  * To help us fund GROMACS development, we humbly ask that you cite
  36  * the research papers on the package. Check out http://www.gromacs.org.
  37  */
  38
  39 #ifndef _GPU_UTILS_H_
  40 #define _GPU_UTILS_H_
  41
  42 #include "types/simple.h"
  43 #include "types/hw_info.h"
  44
  45 #ifdef GMX_GPU
  46 #define FUNC_TERM_INT ;
  47 #define FUNC_TERM_VOID ;
  48 #define FUNC_QUALIFIER
  49 #else
  50 #define FUNC_TERM_INT {return -1; }
  51 #define FUNC_TERM_VOID {}
  52 #define FUNC_QUALIFIER static
  53 #endif
  54
  55 #ifdef __cplusplus
  56 extern "C" {
  57 #endif
  58
  59 FUNC_QUALIFIER
  60 int do_quick_memtest(int dev_id) FUNC_TERM_INT
  61
  62 FUNC_QUALIFIER
  63 int do_full_memtest(int dev_id) FUNC_TERM_INT
  64
  65 FUNC_QUALIFIER
  66 int do_timed_memtest(int dev_id, int time_limit) FUNC_TERM_INT
  67
  68 FUNC_QUALIFIER
  69 int detect_cuda_gpus(gmx_gpu_info_t *gpu_info, char *err_str) FUNC_TERM_INT
  70
  71 FUNC_QUALIFIER
  72 void pick_compatible_gpus(const gmx_gpu_info_t *gpu_info,
  73                           gmx_gpu_opt_t *gpu_opt) FUNC_TERM_VOID
  74
  75 FUNC_QUALIFIER
  76 gmx_bool check_selected_cuda_gpus(int *checkres,
  77                                   const gmx_gpu_info_t *gpu_info,
  78                                   gmx_gpu_opt_t *gpu_opt) FUNC_TERM_INT
  79
  80 FUNC_QUALIFIER
  81 void free_gpu_info(const gmx_gpu_info_t *gpu_info) FUNC_TERM_VOID
  82
  83 FUNC_QUALIFIER
  84 gmx_bool init_gpu(int mygpu, char *result_str,
  85                   const gmx_gpu_info_t *gpu_info,
  86                   const gmx_gpu_opt_t *gpu_opt) FUNC_TERM_INT
  87
  88 FUNC_QUALIFIER
  89 gmx_bool free_gpu(char *result_str) FUNC_TERM_INT
  90
  91 /*! \brief Returns the device ID of the GPU currently in use.*/
  92 FUNC_QUALIFIER
  93 int get_current_gpu_device_id(void) FUNC_TERM_INT
  94
  95 FUNC_QUALIFIER
  96 int get_gpu_device_id(const gmx_gpu_info_t *gpu_info,
  97                       const gmx_gpu_opt_t *gpu_opt,
  98                       int index) FUNC_TERM_INT
  99
 100 FUNC_QUALIFIER
 101 void get_gpu_device_info_string(char *s, const gmx_gpu_info_t *gpu_info, int index) FUNC_TERM_VOID
 102
 103 FUNC_QUALIFIER
 104 size_t sizeof_cuda_dev_info(void) FUNC_TERM_INT
 105
 106 #ifdef __cplusplus
 107 }
 108 #endif
 109
 110 #undef FUNC_TERM_INT
 111 #undef FUNC_TERM_VOID
 112 #undef FUNC_QUALIFIER
 113
 114 #endif /* _GPU_UTILS_H_ */