src/gromacs/selection/mempool.h

   1 /*
   2  *
   3  *                This source code is part of
   4  *
   5  *                 G   R   O   M   A   C   S
   6  *
   7  *          GROningen MAchine for Chemical Simulations
   8  *
   9  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  10  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  11  * Copyright (c) 2001-2009, The GROMACS development team,
  12  * check out http://www.gromacs.org for more information.
  13
  14  * This program is free software; you can redistribute it and/or
  15  * modify it under the terms of the GNU General Public License
  16  * as published by the Free Software Foundation; either version 2
  17  * of the License, or (at your option) any later version.
  18  *
  19  * If you want to redistribute modifications, please consider that
  20  * scientific software is very special. Version control is crucial -
  21  * bugs must be traceable. We will be happy to consider code for
  22  * inclusion in the official distribution, but derived work must not
  23  * be called official GROMACS. Details are found in the README & COPYING
  24  * files - if they are missing, get the official version at www.gromacs.org.
  25  *
  26  * To help us fund GROMACS development, we humbly ask that you cite
  27  * the papers on the package - you can find them in the top README file.
  28  *
  29  * For more info, check our website at http://www.gromacs.org
  30  */
  31 /*! \internal \file
  32  * \brief Declarations for memory pooling functions.
  33  *
  34  * \todo
  35  * Document these functions.
  36  *
  37  * This is an implementation header: there should be no need to use it outside
  38  * this directory.
  39  *
  40  * \author Teemu Murtola <teemu.murtola@cbr.su.se>
  41  * \ingroup module_selection
  42  */
  43 #ifndef GMX_SELECTION_MEMPOOL_H
  44 #define GMX_SELECTION_MEMPOOL_H
  45
  46 struct gmx_ana_index_t;
  47
  48 /** Opaque struct for memory pooling. */
  49 typedef struct gmx_sel_mempool_t gmx_sel_mempool_t;
  50
  51 /** Create an empty memory pool. */
  52 int
  53 _gmx_sel_mempool_create(gmx_sel_mempool_t **mpp);
  54 /** Destroy a memory pool. */
  55 void
  56 _gmx_sel_mempool_destroy(gmx_sel_mempool_t *mp);
  57
  58 /** Allocate memory from a memory pool. */
  59 int
  60 _gmx_sel_mempool_alloc(gmx_sel_mempool_t *mp, void **ptrp, size_t size);
  61 /** Release memory allocated from a memory pool. */
  62 void
  63 _gmx_sel_mempool_free(gmx_sel_mempool_t *mp, void *ptr);
  64 /** Set the size of a memory pool. */
  65 int
  66 _gmx_sel_mempool_reserve(gmx_sel_mempool_t *mp, size_t size);
  67
  68 /** Convenience function for allocating an index group from a memory pool. */
  69 int
  70 _gmx_sel_mempool_alloc_group(gmx_sel_mempool_t *mp, struct gmx_ana_index_t *g,
  71                              int isize);
  72 /** Convenience function for freeing an index group from a memory pool. */
  73 void
  74 _gmx_sel_mempool_free_group(gmx_sel_mempool_t *mp, struct gmx_ana_index_t *g);
  75
  76 #endif