src/gromacs/gpu_utils/hostallocator.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2017,2018,2019, 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 <cstddef>
  46
  47 #include <memory>
  48
  49 #include "gromacs/gpu_utils/gpu_utils.h"
  50 #include "gromacs/gpu_utils/pinning.h"
  51 #include "gromacs/utility/alignedallocator.h"
  52 #include "gromacs/utility/gmxassert.h"
  53 #include "gromacs/utility/stringutil.h"
  54
  55 namespace gmx
  56 {
  57
  58 HostAllocationPolicy::HostAllocationPolicy(PinningPolicy pinningPolicy) :
  59     pinningPolicy_(pinningPolicy)
  60 {
  61 }
  62
  63 std::size_t HostAllocationPolicy::alignment() const noexcept
  64 {
  65     return (pinningPolicy_ == PinningPolicy::PinnedIfSupported ? PageAlignedAllocationPolicy::alignment()
  66                                                                : AlignedAllocationPolicy::alignment());
  67 }
  68
  69 void* HostAllocationPolicy::malloc(std::size_t bytes) const noexcept
  70 {
  71     if (pinningPolicy_ == PinningPolicy::PinnedIfSupported)
  72     {
  73         void* p = PageAlignedAllocationPolicy::malloc(bytes);
  74         if (p)
  75         {
  76             /* For every pin, unpin has to be called or resources will
  77              * leak.  Doing this correctly is guaranteed because for
  78              * every p!=null && pinningPolicy_ == PinnedIfSupported,
  79              * the malloc and free calls handle pinning. For very
  80              * standard-compliant containers, the allocator object
  81              * can't be changed independently of the buffer (for move,
  82              * it is propagated) and thus the allocator (and thus
  83              * pinningPolicy_) can't change between malloc and
  84              * free.
  85              *
  86              * Note that we always pin (even for size 0) so that we
  87              * can always unpin without any checks. */
  88             pinBuffer(p, bytes);
  89         }
  90         return p;
  91     }
  92     else
  93     {
  94         return AlignedAllocationPolicy::malloc(bytes);
  95     }
  96 }
  97
  98 void HostAllocationPolicy::free(void* buffer) const noexcept
  99 {
 100     if (buffer == nullptr)
 101     {
 102         // Nothing to do
 103         return;
 104     }
 105     if (pinningPolicy_ == PinningPolicy::PinnedIfSupported)
 106     {
 107         unpinBuffer(buffer);
 108         PageAlignedAllocationPolicy::free(buffer);
 109     }
 110     else
 111     {
 112         AlignedAllocationPolicy::free(buffer);
 113     }
 114 }
 115
 116 } // namespace gmx