src/gromacs/gpu_utils/clfftinitializer.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2018,2019,2020,2021, 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
  37  * Implements ClfftInitializer class.
  38  *
  39  * \author Aleksei Iupinov <a.yupinov@gmail.com>
  40  */
  41
  42 #include "gmxpre.h"
  43
  44 #include "clfftinitializer.h"
  45
  46 #include "config.h"
  47
  48 #include <mutex>
  49
  50 #include "gromacs/utility/basedefinitions.h"
  51 #include "gromacs/utility/exceptions.h"
  52 #include "gromacs/utility/stringutil.h"
  53
  54 #if GMX_GPU_OPENCL
  55 #    include <clFFT.h>
  56 #endif
  57
  58 namespace gmx
  59 {
  60
  61 namespace
  62 {
  63
  64 #if GMX_GPU_OPENCL
  65 /*! \brief The clFFT library may only be initialized once per process,
  66  * and this is orchestrated by this shared value and mutex.
  67  *
  68  * This ensures that thread-MPI and OpenMP builds can't accidentally
  69  * initialize it more than once. */
  70 //! @{
  71 bool       g_clfftInitialized = false;
  72 std::mutex g_clfftMutex;
  73 //! @}
  74 #endif
  75
  76 } // namespace
  77
  78 ClfftInitializer::ClfftInitializer()
  79 {
  80 #if GMX_GPU_OPENCL
  81     std::lock_guard<std::mutex> guard(g_clfftMutex);
  82     clfftSetupData              fftSetup;
  83     int                         initErrorCode = clfftInitSetupData(&fftSetup);
  84     if (initErrorCode != 0)
  85     {
  86         GMX_THROW(InternalError(formatString(
  87                 "Failed to initialize the clFFT library, error code %d", initErrorCode)));
  88     }
  89     initErrorCode = clfftSetup(&fftSetup);
  90     if (initErrorCode != 0)
  91     {
  92         GMX_THROW(InternalError(formatString(
  93                 "Failed to initialize the clFFT library, error code %d", initErrorCode)));
  94     }
  95     g_clfftInitialized = true;
  96 #endif
  97 }
  98
  99 ClfftInitializer::~ClfftInitializer()
 100 {
 101 #if GMX_GPU_OPENCL
 102     std::lock_guard<std::mutex> guard(g_clfftMutex);
 103     if (g_clfftInitialized)
 104     {
 105         clfftTeardown();
 106         // TODO: log non-zero return values (errors)
 107     }
 108     g_clfftInitialized = false;
 109 #endif
 110 }
 111
 112 } // namespace gmx