src/gromacs/gpu_utils/pmalloc_ocl.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2014,2015,2018,2019,2020,2021, 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 /*! \internal \file
  36  *  \brief Define functions for host-side memory handling when using OpenCL devices.
  37  *
  38  *  \author Anca Hamuraru <anca@streamcomputing.eu>
  39  */
  40
  41 #include "gmxpre.h"
  42
  43 #include "pmalloc.h"
  44
  45 #include "gromacs/utility/smalloc.h"
  46
  47 /*! \brief \brief Allocates nbytes of host memory. Use pfree to free memory allocated with this function.
  48  *
  49  *  \todo
  50  *  This function should allocate page-locked memory to help reduce D2H and H2D
  51  *  transfer times, similar with pmalloc from pmalloc.cu.
  52  *
  53  * \param[in,out]    h_ptr   Pointer where to store the address of the newly allocated buffer.
  54  * \param[in]        nbytes  Size in bytes of the buffer to be allocated.
  55  */
  56 void pmalloc(void** h_ptr, size_t nbytes)
  57 {
  58     /* Need a temporary type whose size is 1 byte, so that the
  59      * implementation of snew_aligned can cope without issuing
  60      * warnings. */
  61     char** temporary = reinterpret_cast<char**>(h_ptr);
  62
  63     /* 16-byte alignment is required by the neighbour-searching code,
  64      * because it uses four-wide SIMD for bounding-box calculation.
  65      * However, when we organize using page-locked memory for
  66      * device-host transfers, it will probably need to be aligned to a
  67      * 4kb page, like CUDA does. */
  68     snew_aligned(*temporary, nbytes, 16);
  69 }
  70
  71 /*! \brief Frees memory allocated with pmalloc.
  72  *
  73  * \param[in]    h_ptr   Buffer allocated with pmalloc that needs to be freed.
  74  */
  75 void pfree(void* h_ptr)
  76 {
  77
  78     if (h_ptr)
  79     {
  80         sfree_aligned(h_ptr);
  81     }
  82 }