src/gromacs/gpu_utils/clfftinitializer.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2018,2019, 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 /*! \libinternal \file
  36  * \brief
  37  * Declares ClfftInitializer class, which initializes and
  38  * tears down the clFFT library resources in OpenCL builds,
  39  * and does nothing in other builds, and a factory function for it.
  40  *
  41  * clFFT itself is used in the OpenCL implementation of PME
  42  * for 3D R2C/C2R transforms. It is know to work with NVidia
  43  * OpenCL, AMD fglrx and AMDGPU-PRO drivers, and to not work with
  44  * AMD Rocm dev preview as of May 2018 (#2515).
  45  * TODO: find out compatibility with Intel once the rest of PME
  46  * gets there (#2516), or by building clFFT own tests.
  47  *
  48  * \inlibraryapi
  49  * \author Aleksei Iupinov <a.yupinov@gmail.com>
  50  */
  51 #ifndef GMX_GPU_UTILS_CLFFTINITIALIZER_H
  52 #define GMX_GPU_UTILS_CLFFTINITIALIZER_H
  53
  54 #include <memory>
  55
  56 #include "gromacs/utility/classhelpers.h"
  57
  58 namespace gmx
  59 {
  60
  61 /*! \libinternal
  62  * \brief Handle clFFT library init and tear down in RAII style also
  63  * with mutual exclusion.
  64  *
  65  * Only one thread per process needs to attempt to set up and tear
  66  * down the clFFT library, but this wrapper object ensures that it is
  67  * safe to do so more than once, or from any thread. It is the
  68  * responsibility of the caller to ensure that no use of the clFFT
  69  * library is made before making an object of this type, or after the
  70  * first such object is destroyed. If no more objects remain to be
  71  * destroyed, then it is safe to create another and resume clFFT work.
  72  *
  73  * \todo Consider making a composite object that also handles
  74  * on-demand compilation, managing lifetime of PME FFT kernel programs
  75  * to avoid exhausting resources and/or recompiling kernels previously
  76  * used.  See Redmine #2535.
  77  *
  78  * \todo Consider implementing an appropriate flavor of the nifty
  79  * counter idiom so that both static initialization and
  80  * deinitialization can work in a fast, leak-free, and thread-safe way
  81  * without imposing constraints on the calling code.
  82  * See Redmine #2535. */
  83 class ClfftInitializer
  84 {
  85 public:
  86     /*! \brief Constructor
  87      *
  88      * This initializers the clFFT library if there is a
  89      * possibility of an FFT task on the device, and preserves it
  90      * until destruction. Any time required for this
  91      * initialization or tear down should not be accrued to
  92      * per-MD-step counters. */
  93     ClfftInitializer();
  94     //! Destructor
  95     ~ClfftInitializer();
  96
  97     GMX_DISALLOW_COPY_AND_ASSIGN(ClfftInitializer);
  98 };
  99
 100 } // namespace gmx
 101
 102 #endif