xpico_allocator.h

[詳解]

/*
 * License: MIT license
 * Copyright (c) <2015> <MaskedW [maskedw00@gmail.com]>
 *
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use, copy,
 * modify, merge, publish, distribute, sublicense, and/or sell copies
 * of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */


#ifndef picox_allocator_xpico_allocator_h_
#define picox_allocator_xpico_allocator_h_


#include <picox/core/xcore.h>


#ifdef __cplusplus
extern "C" {
#endif


typedef struct XPicoAllocator
{
    uint8_t*        heap;
    uint8_t*        top;
    size_t          capacity;
    size_t          reserve;
    size_t          alignment;
    size_t          max_used;
    bool            ownmemory;
} XPicoAllocator;


bool xpalloc_init(XPicoAllocator* self, void* heap, size_t size, size_t alignment);


void xpalloc_deinit(XPicoAllocator* self);


void* xpalloc_allocate(XPicoAllocator* self, size_t size);


void* xpalloc_reallocate(XPicoAllocator* self, void* old_mem, size_t size);



void xpalloc_deallocate(XPicoAllocator* self, void* ptr);


void xpalloc_clear(XPicoAllocator* self);


static inline uint8_t*
xpalloc_heap(const XPicoAllocator* self)
{
    X_ASSERT(self);
    return self->heap;
}


static inline size_t
xpalloc_reserve(const XPicoAllocator* self)
{
    X_ASSERT(self);
    return self->reserve;
}


static inline size_t
xpalloc_capacity(const XPicoAllocator* self)
{
    X_ASSERT(self);
    return self->capacity;
}

static inline size_t
xpalloc_max_used(const XPicoAllocator* self)
{
    X_ASSERT(self);
    return self->max_used;
}


size_t xpalloc_allocation_overhead(const XPicoAllocator* self, size_t n);


typedef void (*XPicoAllocatorWalker)(const uint8_t* chunk, size_t size, void* user);


void xpalloc_walk_heap(const XPicoAllocator* self, XPicoAllocatorWalker walker, void* user);


bool xpalloc_is_owner(const XPicoAllocator* self, const void* ptr);


#ifdef __cplusplus
}
#endif


#endif // picox_allocator_xpalloc_h_