Move GPU devices management into hardware subfolder
[alexxy/gromacs.git] / src / gromacs / hardware / device_management_common.cpp
1 /*
2  * This file is part of the GROMACS molecular simulation package.
3  *
4  * Copyright (c) 2012,2013,2014,2015,2017 The GROMACS development team.
5  * Copyright (c) 2018,2019,2020, by the GROMACS development team, led by
6  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
7  * and including many others, as listed in the AUTHORS file in the
8  * top-level source directory and at http://www.gromacs.org.
9  *
10  * GROMACS is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU Lesser General Public License
12  * as published by the Free Software Foundation; either version 2.1
13  * of the License, or (at your option) any later version.
14  *
15  * GROMACS is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18  * Lesser General Public License for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public
21  * License along with GROMACS; if not, see
22  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
23  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
24  *
25  * If you want to redistribute modifications to GROMACS, please
26  * consider that scientific software is very special. Version
27  * control is crucial - bugs must be traceable. We will be happy to
28  * consider code for inclusion in the official distribution, but
29  * derived work must not be called official GROMACS. Details are found
30  * in the README & COPYING files - if they are missing, get the
31  * official version at http://www.gromacs.org.
32  *
33  * To help us fund GROMACS development, we humbly ask that you cite
34  * the research papers on the package. Check out http://www.gromacs.org.
35  */
36 /*! \internal \file
37  *  \brief Defines the implementations of the device management that are common for CPU, CUDA and OpenCL.
38  *
39  *  \author Artem Zhmurov <zhmurov@gmail.com>
40  *
41  * \ingroup module_hardware
42  */
43 #include "gmxpre.h"
44
45 #include <assert.h>
46
47 #include "gromacs/hardware/device_information.h"
48 #include "gromacs/hardware/device_management.h"
49 #include "gromacs/hardware/gpu_hw_info.h"
50 #include "gromacs/utility/smalloc.h"
51
52 bool canPerformGpuDetection()
53 {
54     if (c_binarySupportsGpus && getenv("GMX_DISABLE_GPU_DETECTION") == nullptr)
55     {
56         return isGpuDetectionFunctional(nullptr);
57     }
58     else
59     {
60         return false;
61     }
62 }
63
64 std::vector<int> getCompatibleGpus(const gmx_gpu_info_t& gpu_info)
65 {
66     // Possible minor over-allocation here, but not important for anything
67     std::vector<int> compatibleGpus;
68     compatibleGpus.reserve(gpu_info.n_dev);
69     for (int i = 0; i < gpu_info.n_dev; i++)
70     {
71         assert(gpu_info.deviceInfo);
72         if (gpu_info_get_stat(gpu_info, i) == DeviceStatus::Compatible)
73         {
74             compatibleGpus.push_back(i);
75         }
76     }
77     return compatibleGpus;
78 }
79
80 const char* getGpuCompatibilityDescription(const gmx_gpu_info_t& gpu_info, int index)
81 {
82     return (index >= gpu_info.n_dev ? c_deviceStateString[DeviceStatus::Nonexistent]
83                                     : c_deviceStateString[gpu_info_get_stat(gpu_info, index)]);
84 }
85
86 void free_gpu_info(const gmx_gpu_info_t* gpu_info)
87 {
88     sfree(static_cast<void*>(gpu_info->deviceInfo)); // circumvent is_pod check in sfree
89 }