Fix mdrun -nb GPU on non-gpu builds
[alexxy/gromacs.git] / src / gromacs / gpu_utils / gpu_utils.cpp
1 /*
2  * This file is part of the GROMACS molecular simulation package.
3  *
4  * Copyright (c) 2014,2015,2017,2018, 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 /*! \internal \file
36  *  \brief Function definitions for non-GPU builds
37  *
38  *  \author Mark Abraham <mark.j.abraham@gmail.com>
39  */
40 #include "gmxpre.h"
41
42 #include "gpu_utils.h"
43
44 #include "config.h"
45
46 #include <cassert>
47
48 #include "gromacs/hardware/gpu_hw_info.h"
49 #include "gromacs/utility/arrayref.h"
50 #include "gromacs/utility/smalloc.h"
51 #include "gromacs/utility/stringutil.h"
52
53 #if !GMX_GPU
54 /*! \brief Set allocation functions used by the GPU host
55  *
56  * Since GPU support is not configured, there is no host memory to
57  * allocate. */
58 void gpu_set_host_malloc_and_free(bool /*unused*/,
59                                   gmx_host_alloc_t **nb_alloc,
60                                   gmx_host_free_t  **nb_free)
61 {
62     *nb_alloc = nullptr;
63     *nb_free  = nullptr;
64 }
65
66 int gpu_info_get_stat(const gmx_gpu_info_t & /*unused*/, int /*unused*/)
67 {
68     return egpuNonexistent;
69 }
70 #endif
71
72 void free_gpu_info(const gmx_gpu_info_t *gpu_info)
73 {
74     sfree(static_cast<void*>(gpu_info->gpu_dev)); //circumvent is_pod check in sfree
75 }
76
77 std::vector<int> getCompatibleGpus(const gmx_gpu_info_t &gpu_info)
78 {
79     // Possible minor over-allocation here, but not important for anything
80     std::vector<int> compatibleGpus;
81     compatibleGpus.reserve(gpu_info.n_dev);
82     for (int i = 0; i < gpu_info.n_dev; i++)
83     {
84         assert(gpu_info.gpu_dev);
85         if (gpu_info_get_stat(gpu_info, i) == egpuCompatible)
86         {
87             compatibleGpus.push_back(i);
88         }
89     }
90     return compatibleGpus;
91 }
92
93 const char *getGpuCompatibilityDescription(const gmx_gpu_info_t &gpu_info,
94                                            int                   index)
95 {
96     return (index >= gpu_info.n_dev ?
97             gpu_detect_res_str[egpuNonexistent] :
98             gpu_detect_res_str[gpu_info_get_stat(gpu_info, index)]);
99 }
100 /*! \brief Help build a descriptive message in \c error if there are
101  * \c errorReasons why nonbondeds on a GPU are not supported.
102  *
103  * \returns Whether the lack of errorReasons indicate there is support. */
104 static bool
105 addMessageIfNotSupported(gmx::ArrayRef <const std::string> errorReasons,
106                          std::string                      *error)
107 {
108     bool isSupported = errorReasons.empty();
109     if (!isSupported && error)
110     {
111         *error  = "Nonbonded interactions cannot run on GPUs: ";
112         *error += joinStrings(errorReasons, "; ") + ".";
113     }
114     return isSupported;
115 }
116
117 bool buildSupportsNonbondedOnGpu(std::string *error)
118 {
119     std::vector<std::string> errorReasons;
120     if (GMX_DOUBLE)
121     {
122         errorReasons.emplace_back("double precision");
123     }
124     if (GMX_GPU == GMX_GPU_NONE)
125     {
126         errorReasons.emplace_back("non-GPU build of GROMACS");
127     }
128     return addMessageIfNotSupported(errorReasons, error);
129 }