src/gromacs/gpu_utils/hostallocator.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 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 /*! \internal \file
  36  * \brief Implements gmx::HostAllocationPolicy for allocating memory
  37  * suitable for e.g. GPU transfers on CUDA.
  38  *
  39  * \author Mark Abraham <mark.j.abraham@gmail.com>
  40  */
  41 #include "gmxpre.h"
  42
  43 #include "hostallocator.h"
  44
  45 #include "config.h"
  46
  47 #include <cstddef>
  48
  49 #include <memory>
  50
  51 #include "gromacs/gpu_utils/gpu_utils.h"
  52 #include "gromacs/gpu_utils/pinning.h"
  53 #include "gromacs/utility/alignedallocator.h"
  54 #include "gromacs/utility/gmxassert.h"
  55 #include "gromacs/utility/stringutil.h"
  56
  57 namespace gmx
  58 {
  59
  60 HostAllocationPolicy::HostAllocationPolicy(PinningPolicy pinningPolicy)
  61     : pinningPolicy_(pinningPolicy)
  62 {
  63     if (GMX_GPU != GMX_GPU_CUDA)
  64     {
  65         GMX_RELEASE_ASSERT(pinningPolicy == PinningPolicy::CannotBePinned,
  66                            "A suitable build of GROMACS (e.g. with CUDA) is required for a "
  67                            "HostAllocationPolicy to be set to a mode that produces pinning.");
  68     }
  69 }
  70
  71 std::size_t HostAllocationPolicy::alignment()
  72 {
  73     return (pinningPolicy_ == PinningPolicy::CanBePinned ?
  74             PageAlignedAllocationPolicy::alignment() :
  75             AlignedAllocationPolicy::alignment());
  76 }
  77
  78 void *HostAllocationPolicy::malloc(std::size_t bytes) const noexcept
  79 {
  80     if (pinningPolicy_ == PinningPolicy::CanBePinned)
  81     {
  82         void *p = PageAlignedAllocationPolicy::malloc(bytes);
  83         pin(p, bytes);
  84         return p;
  85     }
  86     else
  87     {
  88         return AlignedAllocationPolicy::malloc(bytes);
  89     }
  90 }
  91
  92 void HostAllocationPolicy::free(void *buffer) const noexcept
  93 {
  94     if (buffer == nullptr)
  95     {
  96         // Nothing to do
  97         return;
  98     }
  99     unpin(buffer);
 100     if (pinningPolicy_ == PinningPolicy::CanBePinned)
 101     {
 102         PageAlignedAllocationPolicy::free(buffer);
 103     }
 104     else
 105     {
 106         AlignedAllocationPolicy::free(buffer);
 107     }
 108 }
 109
 110 void HostAllocationPolicy::pin(void gmx_unused *p, size_t gmx_unused n) const noexcept
 111 {
 112 #if GMX_GPU == GMX_GPU_CUDA
 113     // I believe this if statement isn't required for calls from malloc. But it
 114     // is required for the unit tests. Which might not make much sense to test
 115     // cases which can't actually happen for an allocator.
 116     if (p == nullptr || n == 0 || isHostMemoryPinned(p))
 117     {
 118         return;
 119     }
 120     pinBuffer(p, n);
 121 #endif
 122 }
 123
 124 void HostAllocationPolicy::unpin(void gmx_unused *p) const noexcept
 125 {
 126 #if GMX_GPU == GMX_GPU_CUDA
 127     if (isHostMemoryPinned(p))
 128     {
 129         unpinBuffer(p);
 130     }
 131 #endif
 132 }
 133
 134 } // namespace gmx