wmem_core.h

Go to the documentation of this file.

 
#ifndef __WMEM_CORE_H__
#define __WMEM_CORE_H__
 
#include <stdint.h>
#include <stdbool.h>
#include <string.h>
#include <glib.h>
#include <ws_symbol_export.h>
#include <ws_attributes.h>
#include <ws_posix_compat.h>
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
struct _wmem_allocator_t;
typedef struct _wmem_allocator_t wmem_allocator_t;
 
typedef enum _wmem_allocator_type_t {
    WMEM_ALLOCATOR_SIMPLE, 
    WMEM_ALLOCATOR_BLOCK, 
    WMEM_ALLOCATOR_STRICT, 
    WMEM_ALLOCATOR_BLOCK_FAST 
} wmem_allocator_type_t;
 
WS_DLL_PUBLIC
void *
wmem_alloc(wmem_allocator_t *allocator, const size_t size)
G_GNUC_MALLOC
G_GNUC_ALLOC_SIZE(2);
 
#define wmem_new(allocator, type) \
    ((type*)wmem_alloc((allocator), sizeof(type)))
 
/*
 * Overflow-safe multiplication of the size of a type by a number of
 * items of that type, returning 0 if the result would overflow (or
 * if the number of elements is negative), and the product otherwise.
 */
#define wmem_safe_mult_type_size(type, num) \
    ((((num) <= 0) || ((size_t)sizeof(type) > (G_MAXSSIZE / (size_t)(num)))) ? 0 : (sizeof(type) * (num)))
 
#define wmem_alloc_array(allocator, type, num) \
    ((type*)wmem_alloc((allocator), wmem_safe_mult_type_size(type, (num))))
 
WS_DLL_PUBLIC
void *
wmem_alloc0(wmem_allocator_t *allocator, const size_t size)
G_GNUC_MALLOC
G_GNUC_ALLOC_SIZE(2);
 
#define wmem_new0(allocator, type) \
    ((type*)wmem_alloc0((allocator), sizeof(type)))
 
#define wmem_alloc0_array(allocator, type, num) \
    ((type*)wmem_alloc0((allocator), wmem_safe_mult_type_size(type, (num))))
 
WS_DLL_PUBLIC
void
wmem_free(wmem_allocator_t *allocator, void *ptr);
 
WS_DLL_PUBLIC
void *
wmem_realloc(wmem_allocator_t *allocator, void *ptr, const size_t size)
G_GNUC_ALLOC_SIZE(3);
 
WS_DLL_PUBLIC
void
wmem_free_all(wmem_allocator_t *allocator);
 
WS_DLL_PUBLIC
void
wmem_gc(wmem_allocator_t *allocator);
 
WS_DLL_PUBLIC
void
wmem_destroy_allocator(wmem_allocator_t *allocator);
 
WS_DLL_PUBLIC
wmem_allocator_t *
wmem_allocator_new(const wmem_allocator_type_t type);
 
WS_DLL_PUBLIC
void
wmem_init(void);
 
WS_DLL_PUBLIC
void
wmem_cleanup(void);
 
WS_DLL_PUBLIC
void
wmem_enter_scope(wmem_allocator_t *allocator);
 
WS_DLL_PUBLIC
void
wmem_leave_scope(wmem_allocator_t *allocator);
 
WS_DLL_PUBLIC
bool
wmem_in_scope(wmem_allocator_t *allocator);
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* __WMEM_CORE_H__ */
 
/*
 * Editor modelines  -  https://www.wireshark.org/tools/modelines.html
 *
 * Local variables:
 * c-basic-offset: 4
 * tab-width: 8
 * indent-tabs-mode: nil
 * End:
 *
 * vi: set shiftwidth=4 tabstop=8 expandtab:
 * :indentSize=4:tabSize=8:noTabs=true:
 */