src/gromacs/gpu_utils/pmalloc_sycl.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 utility routines for SYCL
  37  *
  38  *  \author Andrey Alekseenko <al42and@gmail.com>
  39  */
  40 #include "gmxpre.h"
  41
  42 #include "pmalloc.h"
  43
  44 #include "gromacs/utility/smalloc.h"
  45
  46 /*! \brief Allocates \p nbytes of host memory. Use \c pfree to free memory allocated with this function.
  47  *
  48  *  \todo
  49  *  This function was copied from OpenCL implementation, not tuned for SYCL at all.
  50  *  Once SYCL2020 is out, might be worthwhile to look into USM and sycl::malloc_host / sycl::aligned_alloc_host.
  51  *  Overall, it is better to directly use sycl::buffer instead of pinned arrays. But this function
  52  *  is needed to compile some PME code with SYCL enabled, even if it is never used.
  53  *
  54  * \param[in,out]    h_ptr   Pointer where to store the address of the newly allocated buffer.
  55  * \param[in]        nbytes  Size in bytes of the buffer to be allocated.
  56  */
  57 void pmalloc(void** h_ptr, size_t nbytes)
  58 {
  59     /* Need a temporary type whose size is 1 byte, so that the
  60      * implementation of snew_aligned can cope without issuing
  61      * warnings. */
  62     auto** temporary = reinterpret_cast<std::byte**>(h_ptr);
  63
  64     /* 16-byte alignment inherited from OpenCL and does not sound unreasonable */
  65     snew_aligned(*temporary, nbytes, 16);
  66 }
  67
  68 /*! \brief Frees memory allocated with pmalloc.
  69  *
  70  * \param[in]    h_ptr   Buffer allocated with pmalloc that needs to be freed.
  71  */
  72 void pfree(void* h_ptr)
  73 {
  74     if (h_ptr)
  75     {
  76         sfree_aligned(h_ptr);
  77     }
  78 }