allocator.h

Go to the documentation of this file.

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2017 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 "ucx.h"

#ifdef  __cplusplus
extern "C" {
#endif

typedef void*(*ucx_allocator_malloc)(void *pool, size_t n);

typedef void*(*ucx_allocator_calloc)(void *pool, size_t n, size_t size);

typedef void*(*ucx_allocator_realloc)(void *pool, void *data, size_t n);

typedef void(*ucx_allocator_free)(void *pool, void *data);

typedef struct {
    void *pool;
    ucx_allocator_malloc  malloc;
    ucx_allocator_calloc  calloc;
    ucx_allocator_realloc realloc;
    ucx_allocator_free    free;
} UcxAllocator;

UcxAllocator *ucx_default_allocator();

void *ucx_default_malloc(void *ignore, size_t n);
void *ucx_default_calloc(void *ignore, size_t n, size_t size);
void *ucx_default_realloc(void *ignore, void *data, size_t n);
void ucx_default_free(void *ignore, void *data);

#define almalloc(allocator, n) ((allocator)->malloc((allocator)->pool, n))

#define alcalloc(allocator, n, size) \
        ((allocator)->calloc((allocator)->pool, n, size))

#define alrealloc(allocator, ptr, n) \
        ((allocator)->realloc((allocator)->pool, ptr, n))

#define alfree(allocator, ptr) ((allocator)->free((allocator)->pool, ptr))

#define UCX_ALLOCATOR_DEFAULT {NULL, \
        ucx_default_malloc, ucx_default_calloc, ucx_default_realloc, \
        ucx_default_free }

#ifdef  __cplusplus
}
#endif

#endif  /* UCX_ALLOCATOR_H */