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