ucx/cx/basic_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 basic_mempool.h
  30  * \brief Implementation of a basic memory pool.
  31  * \author Mike Becker
  32  * \author Olaf Wintermann
  33  * \version 3.0
  34  * \copyright 2-Clause BSD License
  35  */
  36
  37 #ifndef UCX_BASIC_MEMPOOL_H
  38 #define UCX_BASIC_MEMPOOL_H
  39
  40 #include "mempool.h"
  41
  42 #ifdef __cplusplus
  43 extern "C" {
  44 #endif
  45
  46 /**
  47  * Basic array-based memory pool.
  48  */
  49 struct cx_basic_mempool_s {
  50     /** Inherit base structure members. */
  51     CxMempool base;
  52
  53     /** List of pointers to pooled memory. */
  54     void **data;
  55
  56     /** Number of pooled memory items. */
  57     size_t ndata;
  58
  59     /** Memory pool size. */
  60     size_t size;
  61 };
  62
  63 /**
  64  * Creates a basic array-based memory pool.
  65  *
  66  * @param capacity the initial capacity of the pool
  67  * @return the created memory pool or \c NULL if allocation failed
  68  */
  69 __attribute__((__warn_unused_result__))
  70 CxMempool *cxBasicMempoolCreate(size_t capacity);
  71
  72 #ifdef __cplusplus
  73 } // extern "C"
  74 #endif
  75
  76 #endif // UCX_BASIC_MEMPOOL_H