src/gromacs/gpu_utils/gputraits_ocl.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 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 #ifndef GMX_GPU_UTILS_GPUTRAITS_OCL_H
  36 #define GMX_GPU_UTILS_GPUTRAITS_OCL_H
  37
  38 /*! \libinternal \file
  39  *  \brief Declares the OpenCL type traits.
  40  *  \author Aleksei Iupinov <a.yupinov@gmail.com>
  41  *
  42  * \inlibraryapi
  43  */
  44
  45 #include "gromacs/gpu_utils/gmxopencl.h"
  46
  47 //! \brief GPU command stream
  48 using CommandStream = cl_command_queue;
  49 //! \brief Single GPU call timing event
  50 using CommandEvent  = cl_event;
  51 //! \brief Context used explicitly in OpenCL
  52 using Context       = cl_context;
  53
  54 /*! \internal \brief
  55  * GPU kernels scheduling description. This is same in OpenCL/CUDA.
  56  * Provides reasonable defaults, one typically only needs to set the GPU stream
  57  * and non-1 work sizes.
  58  */
  59 struct KernelLaunchConfig
  60 {
  61     size_t        gridSize[3]      = {1, 1, 1}; //!< Work groups (CUDA blocks) counts
  62     size_t        blockSize[3]     = {1, 1, 1}; //!< Per work group (CUDA block) thread counts
  63     size_t        sharedMemorySize = 0;         //!< Shared memory size in bytes
  64     CommandStream stream           = nullptr;   //!< Stream to launch kernel in
  65 };
  66
  67 /*! \brief Sets whether device code can use arrays that are embedded in structs.
  68  * Note that OpenCL 2.x might be able to do this, but we use 1.2.
  69  */
  70 #define c_canEmbedBuffers false
  71
  72 #endif