src/gromacs/gpu_utils/ocl_compiler.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014,2015,2016,2017,2018, 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 Declare infrastructure for OpenCL JIT compilation
  37  *
  38  *  \author Dimitrios Karkoulis <dimitris.karkoulis@gmail.com>
  39  *  \author Anca Hamuraru <anca@streamcomputing.eu>
  40  *  \author Teemu Virolainen <teemu@streamcomputing.eu>
  41  *  \author Mark Abraham <mark.j.abraham@gmail.com>
  42  *  \inlibraryapi
  43  */
  44 #ifndef GMX_GPU_UTILS_OCL_COMPILER_H
  45 #define GMX_GPU_UTILS_OCL_COMPILER_H
  46
  47 #include <string>
  48
  49 #include "gromacs/gpu_utils/oclutils.h"
  50
  51 namespace gmx
  52 {
  53 namespace ocl
  54 {
  55
  56 /*! \brief Compile the specified kernel for the context and device.
  57  *
  58  * \param[out] fplog                 Open file pointer for log output
  59  * \param[in]  kernelRelativePath    Relative path to the kernel in the source tree,
  60  *                                   e.g. "src/gromacs/mdlib/nbnxn_ocl" for NB kernels.
  61  * \param[in]  kernelBaseFilename    The name of the kernel source file to compile, e.g. "nbnxn_ocl_kernels.cl"
  62  * \param[in]  extraDefines          Preprocessor defines required by the calling code, e.g. for configuring the kernels
  63  * \param[in]  context               OpenCL context on the device to compile for
  64  * \param[in]  deviceId              OpenCL device id of the device to compile for
  65  * \param[in]  deviceVendorId        Enumerator of the device vendor to compile for
  66  *
  67  * \returns The compiled OpenCL program
  68  *
  69  * \todo Consider whether we can parallelize the compilation of all
  70  * the kernels by compiling them in separate programs - but since the
  71  * resulting programs can't refer to each other, that might lead to
  72  * bloat of util code?
  73  *
  74  * \throws std::bad_alloc  if out of memory.
  75  *         FileIOError     if a file I/O error prevents returning a valid compiled program.
  76  *         InternalError   if an OpenCL API error prevents returning a valid compiled program. */
  77 cl_program
  78 compileProgram(FILE              *fplog,
  79                const std::string &kernelRelativePath,
  80                const std::string &kernelBaseFilename,
  81                const std::string &extraDefines,
  82                cl_context         context,
  83                cl_device_id       deviceId,
  84                ocl_vendor_id_t    deviceVendorId);
  85
  86 } // namespace
  87 } // namespace
  88
  89 #endif