ucx/cx/mempool.h

   1 /*
   2  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
   3  *
   4  * Copyright 2021 Mike Becker, Olaf Wintermann All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions are met:
   8  *
   9  *   1. Redistributions of source code must retain the above copyright
  10  *      notice, this list of conditions and the following disclaimer.
  11  *
  12  *   2. Redistributions in binary form must reproduce the above copyright
  13  *      notice, this list of conditions and the following disclaimer in the
  14  *      documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  17  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  20  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  21  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  22  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  23  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  24  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  25  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  26  * POSSIBILITY OF SUCH DAMAGE.
  27  */
  28 /**
  29  * \file mempool.h
  30  * \brief Interface for memory pool implementations.
  31  * \author Mike Becker
  32  * \author Olaf Wintermann
  33  * \version 3.0
  34  * \copyright 2-Clause BSD License
  35  */
  36
  37 #ifndef UCX_MEMPOOL_H
  38 #define UCX_MEMPOOL_H
  39
  40 #include "allocator.h"
  41
  42 #ifdef __cplusplus
  43 extern "C" {
  44 #endif
  45
  46 /**
  47  * Memory pool class type.
  48  */
  49 typedef struct cx_mempool_class_s cx_mempool_class;
  50
  51 /**
  52  * The basic structure of a memory pool.
  53  * Should be the first member of an actual memory pool implementation.
  54  */
  55 struct cx_mempool_s {
  56     /**
  57      * The pool class definition.
  58      */
  59     cx_mempool_class *cl;
  60     /**
  61      * The provided allocator.
  62      */
  63     CxAllocator const *allocator;
  64 };
  65
  66 /**
  67  * Common type for all memory pool implementations.
  68  */
  69 typedef struct cx_mempool_s CxMempool;
  70
  71 /**
  72  * The class definition for a memory pool.
  73  */
  74 struct cx_mempool_class_s {
  75     /** Member function for destroying the pool. */
  76     __attribute__((__nonnull__))
  77     void (*destroy)(CxMempool *pool);
  78
  79     /** Member function for setting a destructor. */
  80     __attribute__((__nonnull__))
  81     void (*set_destructor)(
  82             CxMempool *pool,
  83             void *memory,
  84             cx_destructor_func fnc
  85     );
  86 };
  87
  88
  89 /**
  90  * Destroys a memory pool including their contents.
  91  *
  92  * @param pool the memory pool to destroy
  93  */
  94 __attribute__((__nonnull__))
  95 static inline void cxMempoolDestroy(CxMempool *pool) {
  96     pool->cl->destroy(pool);
  97 }
  98
  99 /**
 100  * Sets a destructor function for an allocated memory object.
 101  *
 102  * If the memory is not managed by the pool, the behavior is undefined.
 103  *
 104  * @param pool the pool
 105  * @param memory the objected allocated in the pool
 106  * @param fnc the destructor function
 107  */
 108 __attribute__((__nonnull__))
 109 static inline void cxMempoolSetDestructor(
 110         CxMempool *pool,
 111         void *memory,
 112         cx_destructor_func fnc
 113 ) {
 114     pool->cl->set_destructor(pool, memory, fnc);
 115 }
 116
 117 #ifdef __cplusplus
 118 } // extern "C"
 119 #endif
 120
 121 #endif // UCX_MEMPOOL_H