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"

enum cx_mempool_type {
    CX_MEMPOOL_TYPE_SIMPLE,
    CX_MEMPOOL_TYPE_ADVANCED,
    CX_MEMPOOL_TYPE_PURE,
};

struct cx_mempool_s {
    const CxAllocator * const base_allocator;

    const CxAllocator *allocator;

    void **data;

    size_t size;

    size_t capacity;

    struct cx_mempool_foreign_memory_s *registered;

    size_t registered_size;

    size_t registered_capacity;

    cx_destructor_func destr;

    cx_destructor_func2 destr2;

    void *destr2_data;
};

typedef struct cx_mempool_s CxMempool;

CX_EXTERN
void cxMempoolFree(CxMempool *pool);

CX_EXTERN CX_NODISCARD CX_MALLOC CX_DEALLOC(cxMempoolFree, 1)
CxMempool *cxMempoolCreate(size_t capacity, enum cx_mempool_type type);

#define cxMempoolCreateSimple(capacity) cxMempoolCreate(capacity, CX_MEMPOOL_TYPE_SIMPLE)

#define cxMempoolCreateAdvanced(capacity) cxMempoolCreate(capacity, CX_MEMPOOL_TYPE_ADVANCED)

#define cxMempoolCreatePure(capacity) cxMempoolCreate(capacity, CX_MEMPOOL_TYPE_PURE)

CX_EXTERN CX_NONNULL_ARG(1)
void cxMempoolGlobalDestructor(CxMempool *pool, cx_destructor_func fnc);

CX_EXTERN CX_NONNULL_ARG(1)
void cxMempoolGlobalDestructor2(CxMempool *pool, cx_destructor_func2 fnc, void *data);

CX_EXTERN CX_NONNULL
void cxMempoolSetDestructor(void *memory, cx_destructor_func fnc);

CX_EXTERN CX_NONNULL
void cxMempoolSetDestructor2(void *memory, cx_destructor_func2 fnc, void *data);

CX_EXTERN CX_NONNULL
void cxMempoolRemoveDestructor(void *memory);

CX_EXTERN CX_NONNULL
void cxMempoolRemoveDestructor2(void *memory);

CX_EXTERN CX_NONNULL
int cxMempoolRegister(CxMempool *pool, void *memory, cx_destructor_func destr);

CX_EXTERN CX_NONNULL
int cxMempoolRegister2(CxMempool *pool, void *memory, cx_destructor_func2 destr, void *data);

CX_EXTERN CX_NONNULL
int cxMempoolTransfer(CxMempool *source, CxMempool *dest);

CX_EXTERN CX_NONNULL
int cxMempoolTransferObject(CxMempool *source, CxMempool *dest, const void *obj);
 
#endif // UCX_MEMPOOL_H