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,2019, by the GROMACS development team.
   5  * Copyright (c) 2020,2021, 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 Function definitions for non-GPU builds
  38  *
  39  *  \author Mark Abraham <mark.j.abraham@gmail.com>
  40  */
  41 #include "gmxpre.h"
  42
  43 #include "gpu_utils.h"
  44
  45 #include "config.h"
  46
  47 #include "gromacs/utility/arrayref.h"
  48 #include "gromacs/utility/enumerationhelpers.h"
  49 #include "gromacs/utility/stringutil.h"
  50
  51 #ifdef _MSC_VER
  52 #    pragma warning(disable : 6237)
  53 #endif
  54
  55 const char* enumValueToString(GpuApiCallBehavior enumValue)
  56 {
  57     static constexpr gmx::EnumerationArray<GpuApiCallBehavior, const char*> s_gpuApiCallBehaviorNames = {
  58         "Synchronous", "Asynchronous"
  59     };
  60     return s_gpuApiCallBehaviorNames[enumValue];
  61 }
  62
  63 bool decideGpuTimingsUsage()
  64 {
  65     if (GMX_GPU_CUDA || GMX_GPU_SYCL)
  66     {
  67         /* CUDA: timings are incorrect with multiple streams.
  68          * This is the main reason why they are disabled by default.
  69          * TODO: Consider turning on by default when we can detect nr of streams.
  70          *
  71          * SYCL: compilers and runtimes change rapidly, so we disable timings by default
  72          * to avoid any possible overhead. */
  73         return (getenv("GMX_ENABLE_GPU_TIMING") != nullptr);
  74     }
  75     else if (GMX_GPU_OPENCL)
  76     {
  77         return (getenv("GMX_DISABLE_GPU_TIMING") == nullptr);
  78     }
  79     else
  80     {
  81         // CPU-only build
  82         return false;
  83     }
  84 }