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, 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 "gromacs/utility/basedefinitions.h"
  49 #include "gromacs/utility/exceptions.h"
  50 #include "gromacs/utility/mutex.h"
  51 #include "gromacs/utility/stringutil.h"
  52
  53 #if GMX_GPU_OPENCL
  54 #    include <clFFT.h>
  55 #endif
  56
  57 namespace gmx
  58 {
  59
  60 namespace
  61 {
  62
  63 #if GMX_GPU_OPENCL
  64 /*! \brief The clFFT library may only be initialized once per process,
  65  * and this is orchestrated by this shared value and mutex.
  66  *
  67  * This ensures that thread-MPI and OpenMP builds can't accidentally
  68  * initialize it more than once. */
  69 //! @{
  70 gmx_unused bool g_clfftInitialized = false;
  71 gmx::Mutex      g_clfftMutex;
  72 //! @}
  73 #endif
  74
  75 } // namespace
  76
  77 ClfftInitializer::ClfftInitializer()
  78 {
  79 #if GMX_GPU_OPENCL
  80     gmx::lock_guard<gmx::Mutex> guard(g_clfftMutex);
  81     clfftSetupData              fftSetup;
  82     int                         initErrorCode = clfftInitSetupData(&fftSetup);
  83     if (initErrorCode != 0)
  84     {
  85         GMX_THROW(InternalError(formatString(
  86                 "Failed to initialize the clFFT library, error code %d", initErrorCode)));
  87     }
  88     initErrorCode = clfftSetup(&fftSetup);
  89     if (initErrorCode != 0)
  90     {
  91         GMX_THROW(InternalError(formatString(
  92                 "Failed to initialize the clFFT library, error code %d", initErrorCode)));
  93     }
  94     g_clfftInitialized = true;
  95 #endif
  96 }
  97
  98 ClfftInitializer::~ClfftInitializer()
  99 {
 100 #if GMX_GPU_OPENCL
 101     gmx::lock_guard<gmx::Mutex> guard(g_clfftMutex);
 102     if (g_clfftInitialized)
 103     {
 104         clfftTeardown();
 105         // TODO: log non-zero return values (errors)
 106     }
 107     g_clfftInitialized = false;
 108 #endif
 109 }
 110
 111 } // namespace gmx