87 lines
2.3 KiB
C
87 lines
2.3 KiB
C
|
/* SPDX-License-Identifier: GPL-3.0-or-later
|
||
|
|
* Copyright © 2016-2018 The TokTok team.
|
||
|
|
* Copyright © 2013 Tox project.
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Memory allocation and deallocation functions.
|
||
|
|
*/
|
||
|
|
#ifndef C_TOXCORE_TOXCORE_MEM_H
|
||
|
|
#define C_TOXCORE_TOXCORE_MEM_H
|
||
|
|
|
||
|
|
#include <stdint.h> // uint*_t
|
||
|
|
|
||
|
|
#include "attributes.h"
|
||
|
|
|
||
|
|
#ifdef __cplusplus
|
||
|
|
extern "C" {
|
||
|
|
#endif
|
||
|
|
|
||
|
|
typedef void *mem_malloc_cb(void *obj, uint32_t size);
|
||
|
|
typedef void *mem_calloc_cb(void *obj, uint32_t nmemb, uint32_t size);
|
||
|
|
typedef void *mem_realloc_cb(void *obj, void *ptr, uint32_t size);
|
||
|
|
typedef void mem_free_cb(void *obj, void *ptr);
|
||
|
|
|
||
|
|
/** @brief Functions wrapping standard C memory allocation functions. */
|
||
|
|
typedef struct Memory_Funcs {
|
||
|
|
mem_malloc_cb *malloc;
|
||
|
|
mem_calloc_cb *calloc;
|
||
|
|
mem_realloc_cb *realloc;
|
||
|
|
mem_free_cb *free;
|
||
|
|
} Memory_Funcs;
|
||
|
|
|
||
|
|
typedef struct Memory {
|
||
|
|
const Memory_Funcs *funcs;
|
||
|
|
void *obj;
|
||
|
|
} Memory;
|
||
|
|
|
||
|
|
const Memory *system_memory(void);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Allocate an array of a given size for built-in types.
|
||
|
|
*
|
||
|
|
* The array will not be initialised. Supported built-in types are
|
||
|
|
* `uint8_t`, `int8_t`, and `int16_t`.
|
||
|
|
*/
|
||
|
|
non_null() void *mem_balloc(const Memory *mem, uint32_t size);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Allocate a single object.
|
||
|
|
*
|
||
|
|
* Always use as `(T *)mem_alloc(mem, sizeof(T))`.
|
||
|
|
*/
|
||
|
|
non_null() void *mem_alloc(const Memory *mem, uint32_t size);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Allocate a vector (array) of objects.
|
||
|
|
*
|
||
|
|
* Always use as `(T *)mem_valloc(mem, N, sizeof(T))`.
|
||
|
|
*/
|
||
|
|
non_null() void *mem_valloc(const Memory *mem, uint32_t nmemb, uint32_t size);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Resize an object vector.
|
||
|
|
*
|
||
|
|
* Changes the size of (and possibly moves) the memory block pointed to by
|
||
|
|
* @p ptr to be large enough for an array of @p nmemb elements, each of which
|
||
|
|
* is @p size bytes. It is similar to the call
|
||
|
|
*
|
||
|
|
* @code
|
||
|
|
* realloc(ptr, nmemb * size);
|
||
|
|
* @endcode
|
||
|
|
*
|
||
|
|
* However, unlike that `realloc()` call, `mem_vrealloc()` fails safely in the
|
||
|
|
* case where the multiplication would overflow. If such an overflow occurs,
|
||
|
|
* `mem_vrealloc()` returns `nullptr`.
|
||
|
|
*/
|
||
|
|
non_null(1) nullable(2) void *mem_vrealloc(const Memory *mem, void *ptr, uint32_t nmemb, uint32_t size);
|
||
|
|
|
||
|
|
/** @brief Free an array, object, or object vector. */
|
||
|
|
non_null(1) nullable(2) void mem_delete(const Memory *mem, void *ptr);
|
||
|
|
|
||
|
|
#ifdef __cplusplus
|
||
|
|
} // extern "C"
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#endif
|