src/cx/allocator.h

/*
 * 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_ALLOCATOR_H
#define UCX_ALLOCATOR_H

#include <stdlib.h>

/* LOW LEVEL API */

typedef void* cx_allocator;
typedef void*(*cx_malloc_func)(cx_allocator a, size_t n);
typedef void*(*cx_realloc_func)(cx_allocator a, void* mem, size_t n);
typedef void*(*cx_calloc_func)(cx_allocator a, size_t nelem, size_t n);
typedef void(*cx_free_func)(cx_allocator a, void* mem);

void* cx_malloc_stdlib(cx_allocator a, size_t n);
void* cx_realloc_stdlib(cx_allocator a, void* mem, size_t n);
void* cx_calloc_stdlib(cx_allocator a, size_t nelem, size_t n);
void cx_free_stdlib(cx_allocator a, void* mem);

struct cx_allocator_class {
    cx_malloc_func malloc;
    cx_realloc_func realloc;
    cx_calloc_func calloc;
    cx_free_func free;
};

/* HIGH LEVEL API */

struct cx_allocator_s {
    struct cx_allocator_class allocatorClass;
    void* data;
};
typedef struct cx_allocator_s* CxAllocator;

extern CxAllocator cxDefaultAllocator;

void* cxMalloc(CxAllocator allocator, size_t n);
void* cxRealloc(CxAllocator allocator, void* mem, size_t n);
void* cxCalloc(CxAllocator allocator, size_t nelem, size_t n);
void cxFree(CxAllocator allocator, void* mem);

#endif /* UCX_ALLOCATOR_H */