src/gromacs/selection/mempool.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2010,2011,2014,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 Declarations for memory pooling functions.
  37  *
  38  * \todo
  39  * Document these functions.
  40  *
  41  * This is an implementation header: there should be no need to use it outside
  42  * this directory.
  43  *
  44  * \author Teemu Murtola <teemu.murtola@gmail.com>
  45  * \ingroup module_selection
  46  */
  47 #ifndef GMX_SELECTION_MEMPOOL_H
  48 #define GMX_SELECTION_MEMPOOL_H
  49
  50 #include <cstddef>
  51
  52 struct gmx_ana_index_t;
  53
  54 /** Opaque struct for memory pooling. */
  55 typedef struct gmx_sel_mempool_t gmx_sel_mempool_t;
  56
  57 /** Create an empty memory pool. */
  58 gmx_sel_mempool_t* _gmx_sel_mempool_create();
  59 /** Destroy a memory pool. */
  60 void _gmx_sel_mempool_destroy(gmx_sel_mempool_t* mp);
  61
  62 /** Allocate memory from a memory pool. */
  63 void* _gmx_sel_mempool_alloc(gmx_sel_mempool_t* mp, size_t size);
  64 /** Release memory allocated from a memory pool. */
  65 void _gmx_sel_mempool_free(gmx_sel_mempool_t* mp, void* ptr);
  66 /** Set the size of a memory pool. */
  67 void _gmx_sel_mempool_reserve(gmx_sel_mempool_t* mp, size_t size);
  68
  69 /** Convenience function for allocating an index group from a memory pool. */
  70 void _gmx_sel_mempool_alloc_group(gmx_sel_mempool_t* mp, struct gmx_ana_index_t* g, int isize);
  71 /** Convenience function for freeing an index group from a memory pool. */
  72 void _gmx_sel_mempool_free_group(gmx_sel_mempool_t* mp, struct gmx_ana_index_t* g);
  73
  74 #endif