allocator.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_ALLOCATOR_H
#define UCX_ALLOCATOR_H
 
#include "common.h"

typedef struct {
    void *(*malloc)(void *data, size_t n);

    void *(*realloc)(void *data, void *mem, size_t n);

    void *(*calloc)(void *data, size_t nmemb, size_t size);

    void (*free)(void *data, void *mem);
} cx_allocator_class;

struct cx_allocator_s {
    cx_allocator_class *cl;
    void *data;
};

typedef struct cx_allocator_s CxAllocator;

CX_EXPORT extern const CxAllocator * const cxStdlibAllocator;

CX_EXPORT extern const CxAllocator * cxDefaultAllocator;

typedef void (*cx_destructor_func)(void *memory);

typedef void (*cx_destructor_func2)(void *data, void *memory);
 

typedef void*(*cx_clone_func)(void *target, const void *source,
                             const CxAllocator *allocator, void *data);

CX_EXTERN CX_NODISCARD
unsigned long cx_system_page_size(void);

CX_EXTERN CX_NONNULL CX_NODISCARD
int cx_reallocate_(void **mem, size_t n);

CX_EXTERN CX_NONNULL CX_NODISCARD
int cx_reallocatearray_(void **mem, size_t nmemb, size_t size);

#define cx_reallocate(mem, n) cx_reallocate_((void**)(mem), n)

#define cx_reallocatearray(mem, nmemb, size) \
    cx_reallocatearray_((void**)(mem), nmemb, size)

#define cx_zalloc(n) calloc(1, n)

CX_EXTERN CX_NONNULL_ARG(1)
void cxFree(const CxAllocator *allocator, void *mem);

CX_EXTERN CX_NODISCARD CX_NONNULL
CX_MALLOC CX_DEALLOC_UCX CX_ALLOCSIZE(2)
void *cxMalloc(const CxAllocator *allocator, size_t n);

CX_EXTERN CX_NODISCARD CX_NONNULL_ARG(1)
CX_DEALLOC_UCX CX_ALLOCSIZE(3)
void *cxRealloc(const CxAllocator *allocator, void *mem, size_t n);

CX_EXTERN CX_NODISCARD CX_NONNULL_ARG(1)
CX_DEALLOC_UCX CX_ALLOCSIZE(3, 4)
void *cxReallocArray(const CxAllocator *allocator,
        void *mem, size_t nmemb, size_t size);

CX_EXTERN CX_NODISCARD CX_NONNULL
int cxReallocate_(const CxAllocator *allocator, void **mem, size_t n);

#define cxReallocate(allocator, mem, n) \
    cxReallocate_(allocator, (void**)(mem), n)

CX_EXTERN CX_NODISCARD CX_NONNULL
int cxReallocateArray_(const CxAllocator *allocator,
        void **mem, size_t nmemb, size_t size);

#define cxReallocateArray(allocator, mem, nmemb, size) \
        cxReallocateArray_(allocator, (void**) (mem), nmemb, size)

CX_EXTERN CX_NONNULL_ARG(1) CX_NODISCARD
CX_MALLOC CX_DEALLOC_UCX CX_ALLOCSIZE(2, 3)
void *cxCalloc(const CxAllocator *allocator, size_t nmemb, size_t size);

CX_EXTERN CX_NODISCARD CX_NONNULL
CX_MALLOC CX_DEALLOC_UCX CX_ALLOCSIZE(2)
void *cxZalloc(const CxAllocator *allocator, size_t n);

#define cxMallocDefault(n) cxMalloc(cxDefaultAllocator, n)

#define cxZallocDefault(n) cxZalloc(cxDefaultAllocator, n)

#define cxCallocDefault(nmemb, size) cxCalloc(cxDefaultAllocator, nmemb, size)

#define cxReallocDefault(mem, n) cxRealloc(cxDefaultAllocator, mem, n)

#define cxReallocateDefault(mem, n) cxReallocate(cxDefaultAllocator, mem, n)

#define cxReallocateArrayDefault(mem, nmemb, size) \
        cxReallocateArray(cxDefaultAllocator, mem, nmemb, size)

#define cxReallocArrayDefault(mem, nmemb, size) cxReallocArray(cxDefaultAllocator, mem, nmemb, size)

CX_EXTERN
void cxFreeDefault(void *mem);
 
#endif // UCX_ALLOCATOR_H