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"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct {
    void *(*malloc)(
            void *data,
            size_t n
    );
 
    void *(*realloc)(
            void *data,
            void *mem,
            size_t n
    )
    __attribute__((__warn_unused_result__));
 
    void *(*calloc)(
            void *data,
            size_t nelem,
            size_t n
    );
 
    void (*free)(
            void *data,
            void *mem
    )
    __attribute__((__nonnull__));
} cx_allocator_class;
 
struct cx_allocator_s {
    cx_allocator_class *cl;
    void *data;
};
 
typedef struct cx_allocator_s CxAllocator;
 
extern CxAllocator *cxDefaultAllocator;
 
typedef void (*cx_destructor_func)(void *memory) __attribute__((__nonnull__));
 
typedef void (*cx_destructor_func2)(
        void *data,
        void *memory
) __attribute__((__nonnull__(2)));
 
int cx_reallocate(
        void **mem,
        size_t n
)
__attribute__((__nonnull__));
 
void *cxMalloc(
        CxAllocator const *allocator,
        size_t n
)
__attribute__((__malloc__))
__attribute__((__alloc_size__(2)));
 
void *cxRealloc(
        CxAllocator const *allocator,
        void *mem,
        size_t n
)
__attribute__((__warn_unused_result__))
__attribute__((__alloc_size__(3)));
 
int cxReallocate(
        CxAllocator const *allocator,
        void **mem,
        size_t n
)
__attribute__((__nonnull__));
 
void *cxCalloc(
        CxAllocator const *allocator,
        size_t nelem,
        size_t n
)
__attribute__((__malloc__))
__attribute__((__alloc_size__(2, 3)));
 
void cxFree(
        CxAllocator const *allocator,
        void *mem
)
__attribute__((__nonnull__));
 
#ifdef __cplusplus
} // extern "C"
#endif
 
#endif // UCX_ALLOCATOR_H