xstack_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_xstack_allocator_h_
#define picox_allocator_xstack_allocator_h_


#include <picox/core/xcore.h>


#ifdef __cplusplus
extern "C" {
#endif


typedef struct XStackAllocator
{
    uint8_t*    heap;
    uint8_t*    begin;
    uint8_t*    end;
    size_t      capacity;
    size_t      alignment;
    bool        growth_upward;
} XStackAllocator;


void xsalloc_init(XStackAllocator* self, void* heap, size_t size, size_t alignment);


void* xsalloc_allocate(XStackAllocator* self, size_t size);


void xsalloc_clear(XStackAllocator* self);


void xsalloc_rewind(XStackAllocator* self, void* begin, void* end);


static inline bool
xsalloc_growth_direction(XStackAllocator* self)
{
    X_ASSERT(self);
    return self->growth_upward;
}


static inline void
xsalloc_set_growth_direction(XStackAllocator* self, bool growth_upward)
{
    X_ASSERT(self);
    self->growth_upward = growth_upward;
}


static inline size_t
xsalloc_reserve(const XStackAllocator* self)
{
    X_ASSERT(self);
    return self->end - self->begin;
}


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


static inline size_t
xsalloc_alignment(const XStackAllocator* self)
{
    X_ASSERT(self);
    return self->alignment;
}


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


static inline uint8_t*
xsalloc_bedin(const XStackAllocator* self)
{
    X_ASSERT(self);
    return self->begin;
}


static inline uint8_t*
xsalloc_end(const XStackAllocator* self)
{
    X_ASSERT(self);
    return self->end;
}


#ifdef __cplusplus
}
#endif


#endif // picox_allocator_xsalloc_h_