/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 2021 Mike Becker, Olaf Wintermann All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
/**
* \file mempool.h
* \brief Interface for memory pool implementations.
* \author Mike Becker
* \author Olaf Wintermann
* \version 3.0
* \copyright 2-Clause BSD License
*/
#ifndef UCX_MEMPOOL_H
#define UCX_MEMPOOL_H
#include "common.h"
#include "allocator.h"
#ifdef __cplusplus
extern "C" {
#endif
/**
* Memory pool class type.
*/
typedef struct cx_mempool_class_s cx_mempool_class;
/**
* The basic structure of a memory pool.
* Should be the first member of an actual memory pool implementation.
*/
struct cx_mempool_s {
/**
* The pool class definition.
*/
cx_mempool_class *cl;
/**
* The provided allocator.
*/
CxAllocator const *allocator;
};
/**
* Common type for all memory pool implementations.
*/
typedef struct cx_mempool_s CxMempool;
/**
* The class definition for a memory pool.
*/
struct cx_mempool_class_s {
/** Member function for destroying the pool. */
__attribute__((__nonnull__))
void (*destroy)(CxMempool *pool);
/** Member function for setting a destructor. */
__attribute__((__nonnull__))
void (*set_destructor)(
CxMempool *pool,
void *memory,
cx_destructor_func fnc
);
};
/**
* Destroys a memory pool including their contents.
*
* @param pool the memory pool to destroy
*/
__attribute__((__nonnull__))
static inline void cxMempoolDestroy(CxMempool *pool) {
pool->cl->destroy(pool);
}
/**
* Sets a destructor function for an allocated memory object.
*
* If the memory is not managed by the pool, the behavior is undefined.
*
* @param pool the pool
* @param memory the objected allocated in the pool
* @param fnc the destructor function
*/
__attribute__((__nonnull__))
static inline void cxMempoolSetDestructor(
CxMempool *pool,
void *memory,
cx_destructor_func fnc
) {
pool->cl->set_destructor(pool, memory, fnc);
}
#ifdef __cplusplus
} // extern "C"
#endif
#endif // UCX_MEMPOOL_H