include/gpu_utils.h

   1 /* -*- mode: c; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; c-file-style: "stroustrup"; -*-
   2  *
   3  *
   4  *                This source code is part of
   5  *
   6  *                 G   R   O   M   A   C   S
   7  *
   8  *          GROningen MAchine for Chemical Simulations
   9  *
  10  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  11  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  12  * Copyright (c) 2001-2010, The GROMACS development team,
  13  * check out http://www.gromacs.org for more information.
  14
  15  * This program is free software; you can redistribute it and/or
  16  * modify it under the terms of the GNU General Public License
  17  * as published by the Free Software Foundation; either version 2
  18  * of the License, or (at your option) any later version.
  19  *
  20  * If you want to redistribute modifications, please consider that
  21  * scientific software is very special. Version control is crucial -
  22  * bugs must be traceable. We will be happy to consider code for
  23  * inclusion in the official distribution, but derived work must not
  24  * be called official GROMACS. Details are found in the README & COPYING
  25  * files - if they are missing, get the official version at www.gromacs.org.
  26  *
  27  * To help us fund GROMACS development, we humbly ask that you cite
  28  * the papers on the package - you can find them in the top README file.
  29  *
  30  * For more info, check our website at http://www.gromacs.org
  31  *
  32  * And Hey:
  33  * Gallium Rubidium Oxygen Manganese Argon Carbon Silicon
  34  */
  35
  36 #ifndef _GPU_UTILS_H_
  37 #define _GPU_UTILS_H_
  38
  39 #include "types/simple.h"
  40 #include "types/hw_info.h"
  41
  42 #ifdef GMX_GPU
  43 #define FUNC_TERM_INT ;
  44 #define FUNC_TERM_VOID ;
  45 #define FUNC_QUALIFIER
  46 #else
  47 #define FUNC_TERM_INT {return -1;}
  48 #define FUNC_TERM_VOID {}
  49 #define FUNC_QUALIFIER static
  50 #endif
  51
  52 #ifdef __cplusplus
  53 extern "C" {
  54 #endif
  55
  56 FUNC_QUALIFIER
  57 int do_quick_memtest(int dev_id) FUNC_TERM_INT
  58
  59 FUNC_QUALIFIER
  60 int do_full_memtest(int dev_id) FUNC_TERM_INT
  61
  62 FUNC_QUALIFIER
  63 int do_timed_memtest(int dev_id, int time_limit) FUNC_TERM_INT
  64
  65 FUNC_QUALIFIER
  66 gmx_bool is_gmx_openmm_supported_gpu(int dev_id, char *gpu_name) FUNC_TERM_INT
  67
  68 FUNC_QUALIFIER
  69 void detect_cuda_gpus(gmx_gpu_info_t *gpu_info) FUNC_TERM_VOID
  70
  71 FUNC_QUALIFIER
  72 void pick_compatible_gpus(gmx_gpu_info_t *gpu_info) FUNC_TERM_VOID
  73
  74 FUNC_QUALIFIER
  75 gmx_bool check_select_cuda_gpus(int *checkres, gmx_gpu_info_t *gpu_info,
  76                                 const int *requested_devs, int count) FUNC_TERM_INT
  77
  78 FUNC_QUALIFIER
  79 void free_gpu_info(const gmx_gpu_info_t *gpu_info) FUNC_TERM_VOID
  80
  81 FUNC_QUALIFIER
  82 gmx_bool init_gpu(int mygpu, char *result_str, const gmx_gpu_info_t *gpu_info) FUNC_TERM_INT
  83
  84 FUNC_QUALIFIER
  85 gmx_bool free_gpu(char *result_str) FUNC_TERM_INT
  86
  87 /*! \brief Returns the device ID of the GPU currently in use.*/
  88 FUNC_QUALIFIER
  89 int get_current_gpu_device_id(void) FUNC_TERM_INT
  90
  91 FUNC_QUALIFIER
  92 int get_gpu_device_id(const gmx_gpu_info_t *gpu_info, int index) FUNC_TERM_INT
  93
  94 FUNC_QUALIFIER
  95 void get_gpu_device_info_string(char *s, const gmx_gpu_info_t *gpu_info, int index) FUNC_TERM_VOID
  96
  97 #ifdef __cplusplus
  98 }
  99 #endif
 100
 101 #undef FUNC_TERM_INT
 102 #undef FUNC_TERM_VOID
 103 #undef FUNC_QUALIFIER
 104
 105 #endif /* _GPU_UTILS_H_ */