1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/cx/basic_mempool.h Wed Aug 03 17:27:55 2022 +0200
1.3 @@ -0,0 +1,97 @@
1.4 +/*
1.5 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
1.6 + *
1.7 + * Copyright 2021 Mike Becker, Olaf Wintermann All rights reserved.
1.8 + *
1.9 + * Redistribution and use in source and binary forms, with or without
1.10 + * modification, are permitted provided that the following conditions are met:
1.11 + *
1.12 + * 1. Redistributions of source code must retain the above copyright
1.13 + * notice, this list of conditions and the following disclaimer.
1.14 + *
1.15 + * 2. Redistributions in binary form must reproduce the above copyright
1.16 + * notice, this list of conditions and the following disclaimer in the
1.17 + * documentation and/or other materials provided with the distribution.
1.18 + *
1.19 + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
1.20 + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
1.21 + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
1.22 + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
1.23 + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
1.24 + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
1.25 + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
1.26 + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
1.27 + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
1.28 + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
1.29 + * POSSIBILITY OF SUCH DAMAGE.
1.30 + */
1.31 +/**
1.32 + * \file basic_mempool.h
1.33 + * \brief Implementation of a basic memory pool.
1.34 + * \author Mike Becker
1.35 + * \author Olaf Wintermann
1.36 + * \version 3.0
1.37 + * \copyright 2-Clause BSD License
1.38 + */
1.39 +
1.40 +#ifndef UCX_BASIC_MEMPOOL_H
1.41 +#define UCX_BASIC_MEMPOOL_H
1.42 +
1.43 +#include "mempool.h"
1.44 +
1.45 +#ifdef __cplusplus
1.46 +extern "C" {
1.47 +#endif
1.48 +
1.49 +/**
1.50 + * Basic array-based memory pool.
1.51 + */
1.52 +struct cx_basic_mempool_s {
1.53 + /** Inherit base structure members. */
1.54 + CxMempool base;
1.55 +
1.56 + /** The underlying allocator. */
1.57 + CxAllocator *allocator;
1.58 +
1.59 + /** List of pointers to pooled memory. */
1.60 + void **data;
1.61 +
1.62 + /** Number of pooled memory items. */
1.63 + size_t ndata;
1.64 +
1.65 + /** Memory pool size. */
1.66 + size_t size;
1.67 +};
1.68 +
1.69 +/**
1.70 + * Creates a basic array-based memory pool.
1.71 + *
1.72 + * @param capacity the initial capacity of the pool
1.73 + * @param allocator the underlying allocator
1.74 + * @return the created memory pool or \c NULL if allocation failed
1.75 + */
1.76 +__attribute__((__warn_unused_result__))
1.77 +CxMempool *cxBasicMempoolCreate(
1.78 + size_t capacity,
1.79 + CxAllocator *allocator
1.80 +);
1.81 +
1.82 +
1.83 +/**
1.84 + * Creates a basic array-based memory pool.
1.85 + *
1.86 + * The pool will use the default standard library allocator.
1.87 + *
1.88 + * @param capacity the initial capacity of the pool
1.89 + * @return the created memory pool or \c NULL if allocation failed
1.90 + */
1.91 +__attribute__((__warn_unused_result__))
1.92 +static inline CxMempool *cxBasicMempoolCreateSimple(size_t capacity) {
1.93 + return cxBasicMempoolCreate(capacity, cxDefaultAllocator);
1.94 +}
1.95 +
1.96 +#ifdef __cplusplus
1.97 +} // extern "C"
1.98 +#endif
1.99 +
1.100 +#endif // UCX_BASIC_MEMPOOL_H
