src/gromacs/gmxlib/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, 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 for Gromacs
  37  *
  38  *  \author Dimitrios Karkoulis <dimitris.karkoulis@gmail.com>
  39  *  \author Anca Hamuraru <anca@streamcomputing.eu>
  40  *  \author Teemu Virolainen <teemu@streamcomputing.eu>
  41  *  \inlibraryapi
  42  *
  43  * TODO Currently this file handles compilation of NBNXN kernels,
  44  * but e.g. organizing the defines for various physics models
  45  * is leaking in here a bit.
  46  */
  47
  48 #ifndef GMX_GMXLIB_GPU_UTILS_OCL_COMPILER_H
  49 #define GMX_GMXLIB_GPU_UTILS_OCL_COMPILER_H
  50
  51 #include "gromacs/gmxlib/ocl_tools/oclutils.h"
  52 #include "gromacs/legacyheaders/types/hw_info.h"
  53
  54 /*! \brief Vendor specific kernel sources
  55  *
  56  * Only affects the bottom level kernel sources (nbnxn_ocl_kernel_[spec].cl)
  57  */
  58 typedef enum {
  59     generic_vendor_kernels = 0, /**< Standard (warp-less) source file with generated methods/energy/prune */
  60     nvidia_vendor_kernels,      /**< Nvidia source file with generated methods/energy/prune */
  61     amd_vendor_kernels,         /**< AMD source file with generated methods/energy/prune */
  62     auto_vendor_kernels         /**< Compiler will select source based on vendor id*/
  63 } kernel_vendor_spec_t;
  64
  65 /*! \brief Kernel sources index
  66  *
  67  * For now there is only default source. One may add here future kernel versions etc.
  68  * This affect the top level kernel sources (nbnxn_ocl_kernels.cl)
  69  */
  70 typedef enum {
  71     default_source = 0  /* The default top-level source  */
  72 } kernel_source_index_t;
  73
  74 cl_int
  75 ocl_compile_program(
  76         kernel_source_index_t kernel_source_file,
  77         kernel_vendor_spec_t  kernel_vendor_spec,
  78         const char *          defines_for_kernel_types,
  79         char *                result_str,
  80         cl_context            context,
  81         cl_device_id          device_id,
  82         ocl_vendor_id_t       ocl_device_vendor,
  83         cl_program *          p_program,
  84         const char *          custom_build_options
  85         );
  86
  87 #endif