src/gromacs/selection/mempool.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2010,2011,2012,2014,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
  37  * Implements functions in mempool.h.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_selection
  41  */
  42 #include "gmxpre.h"
  43
  44 #include "mempool.h"
  45
  46 #include <cstdlib>
  47
  48 #include <new>
  49
  50 #include "gromacs/selection/indexutil.h"
  51 #include "gromacs/utility/exceptions.h"
  52 #include "gromacs/utility/gmxassert.h"
  53 #include "gromacs/utility/smalloc.h"
  54
  55 //! Alignment in bytes for all returned blocks.
  56 #define ALIGN_STEP 8
  57
  58 /*! \internal \brief
  59  * Describes a single block allocated from the memory pool.
  60  */
  61 typedef struct gmx_sel_mempool_block_t
  62 {
  63     //! Pointer to the start of the block (as returned to the user).
  64     void* ptr;
  65     //! Size of the block, including padding required to align next block.
  66     size_t size;
  67 } gmx_sel_mempool_block_t;
  68
  69 /*! \internal \brief
  70  * Describes a memory pool.
  71  */
  72 struct gmx_sel_mempool_t
  73 {
  74     //! Number of bytes currently allocated from the pool.
  75     size_t currsize;
  76     //! Number of bytes free in the pool, or 0 if \a buffer is NULL.
  77     size_t freesize;
  78     //! Memory area allocated for the pool, or NULL if not yet reserved.
  79     char* buffer;
  80     //! Pointer to the first free byte (aligned at ::ALIGN_STEP) in \a buffer.
  81     char* freeptr;
  82     //! Number of blocks allocated from the pool.
  83     int nblocks;
  84     //! Array describing the allocated blocks.
  85     gmx_sel_mempool_block_t* blockstack;
  86     //! Number of elements allocated for the \a blockstack array.
  87     int blockstack_nalloc;
  88     /*! \brief
  89      * Maximum number of bytes that have been reserved from the pool
  90      * simultaneously.
  91      */
  92     size_t maxsize;
  93 };
  94
  95 gmx_sel_mempool_t* _gmx_sel_mempool_create()
  96 {
  97     gmx_sel_mempool_t* mp;
  98
  99     snew(mp, 1);
 100     mp->currsize          = 0;
 101     mp->freesize          = 0;
 102     mp->buffer            = nullptr;
 103     mp->freeptr           = nullptr;
 104     mp->nblocks           = 0;
 105     mp->blockstack        = nullptr;
 106     mp->blockstack_nalloc = 0;
 107     mp->maxsize           = 0;
 108     return mp;
 109 }
 110
 111 void _gmx_sel_mempool_destroy(gmx_sel_mempool_t* mp)
 112 {
 113     if (!mp->buffer)
 114     {
 115         int i;
 116
 117         for (i = 0; i < mp->nblocks; ++i)
 118         {
 119             sfree(mp->blockstack[i].ptr);
 120         }
 121     }
 122     sfree(mp->buffer);
 123     sfree(mp->blockstack);
 124     sfree(mp);
 125 }
 126
 127 void* _gmx_sel_mempool_alloc(gmx_sel_mempool_t* mp, size_t size)
 128 {
 129     void*  ptr = nullptr;
 130     size_t size_walign;
 131
 132     size_walign = ((size + ALIGN_STEP - 1) / ALIGN_STEP) * ALIGN_STEP;
 133     if (mp->buffer)
 134     {
 135         if (mp->freesize < size)
 136         {
 137             GMX_THROW(gmx::InternalError("Out of memory pool memory"));
 138         }
 139         ptr = mp->freeptr;
 140         mp->freeptr += size_walign;
 141         mp->freesize -= size_walign;
 142         mp->currsize += size_walign;
 143     }
 144     else
 145     {
 146         ptr = malloc(size);
 147         if (!ptr)
 148         {
 149             throw std::bad_alloc();
 150         }
 151         mp->currsize += size_walign;
 152         if (mp->currsize > mp->maxsize)
 153         {
 154             mp->maxsize = mp->currsize;
 155         }
 156     }
 157
 158     if (mp->nblocks >= mp->blockstack_nalloc)
 159     {
 160         mp->blockstack_nalloc = mp->nblocks + 10;
 161         srenew(mp->blockstack, mp->blockstack_nalloc);
 162     }
 163     mp->blockstack[mp->nblocks].ptr  = ptr;
 164     mp->blockstack[mp->nblocks].size = size_walign;
 165     mp->nblocks++;
 166
 167     return ptr;
 168 }
 169
 170 void _gmx_sel_mempool_free(gmx_sel_mempool_t* mp, void* ptr)
 171 {
 172     int size;
 173
 174     if (ptr == nullptr)
 175     {
 176         return;
 177     }
 178     GMX_RELEASE_ASSERT(mp->nblocks > 0 && mp->blockstack[mp->nblocks - 1].ptr == ptr,
 179                        "Invalid order of memory pool free calls");
 180     mp->nblocks--;
 181     size = mp->blockstack[mp->nblocks].size;
 182     mp->currsize -= size;
 183     if (mp->buffer)
 184     {
 185         mp->freeptr = static_cast<char*>(ptr);
 186         mp->freesize += size;
 187     }
 188     else
 189     {
 190         sfree(ptr);
 191     }
 192 }
 193
 194 void _gmx_sel_mempool_reserve(gmx_sel_mempool_t* mp, size_t size)
 195 {
 196     GMX_RELEASE_ASSERT(mp->nblocks == 0,
 197                        "Cannot reserve memory pool when there is something allocated");
 198     GMX_RELEASE_ASSERT(!mp->buffer, "Cannot reserve memory pool twice");
 199     if (size == 0)
 200     {
 201         size = mp->maxsize;
 202     }
 203     mp->buffer = static_cast<char*>(malloc(size));
 204     if (!mp->buffer)
 205     {
 206         throw std::bad_alloc();
 207     }
 208     mp->freesize = size;
 209     mp->freeptr  = mp->buffer;
 210 }
 211
 212 void _gmx_sel_mempool_alloc_group(gmx_sel_mempool_t* mp, gmx_ana_index_t* g, int isize)
 213 {
 214     void* ptr = _gmx_sel_mempool_alloc(mp, sizeof(*g->index) * isize);
 215     g->index  = static_cast<int*>(ptr);
 216 }
 217
 218 void _gmx_sel_mempool_free_group(gmx_sel_mempool_t* mp, gmx_ana_index_t* g)
 219 {
 220     _gmx_sel_mempool_free(mp, g->index);
 221     g->index = nullptr;
 222 }