docs/api-2.1/mempool_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_MEMPOOL_H
 #define UCX_MEMPOOL_H

 #include "ucx.h"
 #include "allocator.h"
 #include <stddef.h>

 #ifdef  __cplusplus
 extern "C" {
 #endif

 typedef struct {
     UcxAllocator *allocator;

     void         **data;

     size_t       ndata;

     size_t       size;
 } UcxMempool;

 #define ucx_mempool_new_default() ucx_mempool_new(16)


 UcxMempool *ucx_mempool_new(size_t n);

 int ucx_mempool_chcap(UcxMempool *pool, size_t newcap);

 void *ucx_mempool_malloc(UcxMempool *pool, size_t n);
 void *ucx_mempool_calloc(UcxMempool *pool, size_t nelem, size_t elsize);

 void *ucx_mempool_realloc(UcxMempool *pool, void *ptr, size_t n);

 void ucx_mempool_free(UcxMempool *pool, void *ptr);

 void ucx_mempool_destroy(UcxMempool *pool);

 void ucx_mempool_set_destr(void *ptr, ucx_destructor func);

 void ucx_mempool_reg_destr(UcxMempool *pool, void *ptr, ucx_destructor destr);

 #ifdef  __cplusplus
 }
 #endif

 #endif  /* UCX_MEMPOOL_H */

ucx_mempool_free
void ucx_mempool_free(UcxMempool *pool, void *ptr)
Frees pooled memory.
Definition: mempool.c:187

UcxMempool
UCX mempool structure.
Definition: mempool.h:52

ucx_mempool_destroy
void ucx_mempool_destroy(UcxMempool *pool)
Destroys a memory pool.
Definition: mempool.c:209

ucx.h
Main UCX Header providing most common definitions.

ucx_mempool_chcap
int ucx_mempool_chcap(UcxMempool *pool, size_t newcap)
Resizes a memory pool.
Definition: mempool.c:103

ucx_mempool_reg_destr
void ucx_mempool_reg_destr(UcxMempool *pool, void *ptr, ucx_destructor destr)
Registers a destructor function for the specified (non-pooled) memory.
Definition: mempool.c:229

ucx_mempool_malloc
void * ucx_mempool_malloc(UcxMempool *pool, size_t n)
Allocates pooled memory.
Definition: mempool.c:123

UcxMempool::size
size_t size
Memory pool size.
Definition: mempool.h:63

UcxMempool::ndata
size_t ndata
Count of pooled memory items.
Definition: mempool.h:60

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

ucx_mempool_calloc
void * ucx_mempool_calloc(UcxMempool *pool, size_t nelem, size_t elsize)
Allocates a pooled memory array.
Definition: mempool.c:148

UcxMempool::data
void ** data
List of pointers to pooled memory.
Definition: mempool.h:57

ucx_mempool_new
UcxMempool * ucx_mempool_new(size_t n)
Creates a memory pool with the specified initial size.
Definition: mempool.c:67

ucx_mempool_realloc
void * ucx_mempool_realloc(UcxMempool *pool, void *ptr, size_t n)
Reallocates pooled memory.
Definition: mempool.c:162

allocator.h
Allocator for custom memory management.

UcxMempool::allocator
UcxAllocator * allocator
UcxAllocator based on this pool.
Definition: mempool.h:54

ucx_mempool_set_destr
void ucx_mempool_set_destr(void *ptr, ucx_destructor func)
Sets a destructor function for the specified memory.
Definition: mempool.c:225

ucx_destructor
void(* ucx_destructor)(void *)
A function pointer to a destructor function.
Definition: ucx.h:72