src/gromacs/gpu_utils/ocl_caching.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014,2015,2016 by 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 Declare infrastructure for managing caching of OpenCL
  38  *  JIT-ted binaries
  39  *
  40  *  This functionality is currently disabled in compileProgram()
  41  *
  42  *  \author Dimitrios Karkoulis <dimitris.karkoulis@gmail.com>
  43  *  \author Anca Hamuraru <anca@streamcomputing.eu>
  44  *  \author Teemu Virolainen <teemu@streamcomputing.eu>
  45  *  \author Mark Abraham <mark.j.abraham@gmail.com>
  46  */
  47 #ifndef GMX_GPU_UTILS_OCL_CACHING_H
  48 #define GMX_GPU_UTILS_OCL_CACHING_H
  49
  50 #include <string>
  51
  52 #include "gromacs/gpu_utils/oclutils.h"
  53
  54 namespace gmx
  55 {
  56 namespace ocl
  57 {
  58
  59 /*! \brief Construct the name for the binary cache file
  60  *
  61  * \param[in]  kernelFilename  Name of the kernel from which the binary will be compiled.
  62  * \param[in]  deviceId        ID of the device upon which the binary is used.
  63  *
  64  * \todo The set of preprocessor options should also form part of the
  65  * identification of the cached binary. Also perhaps compiler, runtime
  66  * and device version info?
  67  *
  68  * \todo Mutual exclusion of ranks and nodes should also be implemented
  69  * if/when caching is re-enabled.
  70  *
  71  * \returns The name of the cache file.
  72  */
  73 std::string makeBinaryCacheFilename(const std::string& kernelFilename, cl_device_id deviceId);
  74
  75 /*! \brief Check if there's a valid cache available, and return it if so
  76  *
  77  * \param[in]  filename   Name of valid file containing the binary cache
  78  * \param[in]  context    The OpenCL context
  79  * \param[in]  deviceId   The ID of the device on which to use the program
  80  *
  81  * \returns The OpenCL program read from the cache
  82  *
  83  * \throws InternalError  if an OpenCL error was encountered
  84  *         FileIOError    if the file could not be opened
  85  */
  86 cl_program makeProgramFromCache(const std::string& filename, cl_context context, cl_device_id deviceId);
  87
  88 /*! \brief Implement caching of OpenCL binaries
  89  *
  90  * \param[in] program     Index of program to cache
  91  * \param[in] filename    Name of file to use for the cache
  92  *
  93  * \throws InternalError  if an OpenCL error was encountered
  94  *         FileIOError    if the file could not be opened
  95  */
  96 void writeBinaryToCache(cl_program program, const std::string& filename);
  97
  98 } // namespace ocl
  99 } // namespace gmx
 100
 101 #endif