docs/api-2.1/allocator_8h_source.html

 /*
  * 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 */

ucx.h
Main UCX Header providing most common definitions.

universe@390: ucx_default_malloc
void * ucx_default_malloc(void *ignore, size_t n)
A wrapper for the standard libc malloc() function.
Definition: allocator.c:46

universe@390: UcxAllocator
UCX allocator data structure containing memory management functions.
Definition: allocator.h:88

universe@390: UcxAllocator::malloc
ucx_allocator_malloc malloc
The malloc() function for this allocator.
Definition: allocator.h:97

universe@390: ucx_allocator_calloc
void *(* ucx_allocator_calloc)(void *pool, size_t n, size_t size)
A function pointer to the allocators calloc() function.
Definition: allocator.h:71

universe@390: UcxAllocator::free
ucx_allocator_free free
The free() function for this allocator.
Definition: allocator.h:109

universe@390: ucx_allocator_malloc
void *(* ucx_allocator_malloc)(void *pool, size_t n)
A function pointer to the allocators malloc() function.
Definition: allocator.h:65

universe@390: ucx_default_allocator
UcxAllocator * ucx_default_allocator()
Returns a pointer to the default allocator.
Definition: allocator.c:41

universe@390: ucx_default_calloc
void * ucx_default_calloc(void *ignore, size_t n, size_t size)
A wrapper for the standard libc calloc() function.
Definition: allocator.c:50

universe@390: ucx_allocator_realloc
void *(* ucx_allocator_realloc)(void *pool, void *data, size_t n)
A function pointer to the allocators realloc() function.
Definition: allocator.h:77

universe@390: ucx_default_realloc
void * ucx_default_realloc(void *ignore, void *data, size_t n)
A wrapper for the standard libc realloc() function.
Definition: allocator.c:54

universe@390: ucx_allocator_free
void(* ucx_allocator_free)(void *pool, void *data)
A function pointer to the allocators free() function.
Definition: allocator.h:83

universe@390: UcxAllocator::calloc
ucx_allocator_calloc calloc
The calloc() function for this allocator.
Definition: allocator.h:101

universe@390: ucx_default_free
void ucx_default_free(void *ignore, void *data)
A wrapper for the standard libc free() function.
Definition: allocator.c:58

universe@390: UcxAllocator::realloc
ucx_allocator_realloc realloc
The realloc() function for this allocator.
Definition: allocator.h:105

universe@390: UcxAllocator::pool
void * pool
Pointer to an area of memory or a complex memory pool.
Definition: allocator.h:93

universe@390: