mempool.h

Go to the documentation of this file.

/*
 * 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.
 */
#ifndef UCX_MEMPOOL_H
#define UCX_MEMPOOL_H
 
#include "common.h"
#include "allocator.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct cx_mempool_memory_s;
 
struct cx_mempool_s {
    CxAllocator const *allocator;
 
    cx_destructor_func auto_destr;
 
    struct cx_mempool_memory_s **data;
 
    size_t size;
 
    size_t capacity;
};
 
typedef struct cx_mempool_s CxMempool;
 
__attribute__((__warn_unused_result__))
CxMempool *cxMempoolCreate(size_t capacity, cx_destructor_func destr);
 
__attribute__((__warn_unused_result__))
static inline CxMempool *cxBasicMempoolCreate(size_t capacity) {
    return cxMempoolCreate(capacity, NULL);
}
 
__attribute__((__nonnull__))
void cxMempoolDestroy(CxMempool *pool);
 
__attribute__((__nonnull__))
void cxMempoolSetDestructor(
        void *memory,
        cx_destructor_func fnc
);
 
__attribute__((__nonnull__))
int cxMempoolRegister(
        CxMempool *pool,
        void *memory,
        cx_destructor_func destr
);
 
#ifdef __cplusplus
} // extern "C"
#endif
 
#endif // UCX_MEMPOOL_H