xfixed_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 self 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 self 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_xfixed_allocator_h_
#define picox_allocator_xfixed_allocator_h_


#include <picox/core/xcore.h>


#ifdef __cplusplus
extern "C" {
#endif


typedef struct XFixedAllocator
{
    uint8_t*    heap;
    uint8_t*    top;
    uint8_t*    next;
    size_t      block_size;
    size_t      num_blocks;
    size_t      remain_blocks;
    size_t      alignment;
} XFixedAllocator;


#define XFALLOC_MIN_ALIGNMENT   (X_ALIGN_OF(size_t))


void xfalloc_init(XFixedAllocator* self, void* heap, size_t heap_size, size_t block_size);


void* xfalloc_allocate(XFixedAllocator* self);


void xfalloc_deallocate(XFixedAllocator* self, void* ptr);


void xfalloc_clear(XFixedAllocator* self);


static inline void*
xfalloc_heap(const XFixedAllocator* self)
{
    X_ASSERT(self);
    return self->heap;
}


static inline size_t
xfalloc_block_size(const XFixedAllocator* self)
{
    X_ASSERT(self);
    return self->block_size;
}


static inline size_t
xfalloc_num_blocks(const XFixedAllocator* self)
{
    X_ASSERT(self);
    return self->num_blocks;
}


static inline size_t
xfalloc_remain_blocks(const XFixedAllocator* self)
{
    X_ASSERT(self);
    return self->remain_blocks;
}


#ifdef __cplusplus
}
#endif


#endif // picox_allocator_xfixed_allocator_h_