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