1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
|
// SPDX-License-Identifier: GPL-2.0-or-later
/*
* linear_allocator.h
*
* @copyright Copyright (C) 2016 Sproute Networks, Inc.
*
* @author Avneesh Sachdev <avneesh@sproute.com>
*/
/*
* Header file for the linear allocator.
*
* An allocator that allocates memory by walking down towards the end
* of a buffer. No attempt is made to reuse blocks that are freed
* subsequently. The assumption is that the buffer is big enough to
* cover allocations for a given purpose.
*/
#include <assert.h>
#include <string.h>
#include <stdint.h>
#include <stddef.h>
/*
* Alignment for block allocated by the allocator. Must be a power of 2.
*/
#define LINEAR_ALLOCATOR_ALIGNMENT 8
#define LINEAR_ALLOCATOR_ALIGN(value) \
(((value) + LINEAR_ALLOCATOR_ALIGNMENT - 1) \
& ~(LINEAR_ALLOCATOR_ALIGNMENT - 1));
/*
* linear_allocator_align_ptr
*/
static inline char *linear_allocator_align_ptr(char *ptr)
{
return (char *)LINEAR_ALLOCATOR_ALIGN((intptr_t)ptr);
}
typedef struct linear_allocator_t_ {
char *buf;
/*
* Current location in the buffer.
*/
char *cur;
/*
* End of buffer.
*/
char *end;
/*
* Version number of the allocator, this is bumped up when the allocator
* is reset and helps identifies bad frees.
*/
uint32_t version;
/*
* The number of blocks that are currently allocated.
*/
int num_allocated;
} linear_allocator_t;
/*
* linear_allocator_block_t
*
* Header structure at the begining of each block.
*/
typedef struct linear_allocator_block_t_ {
uint32_t flags;
/*
* The version of the allocator when this block was allocated.
*/
uint32_t version;
char data[0];
} linear_allocator_block_t;
#define LINEAR_ALLOCATOR_BLOCK_IN_USE 0x01
#define LINEAR_ALLOCATOR_HDR_SIZE (sizeof(linear_allocator_block_t))
/*
* linear_allocator_block_size
*
* The total amount of space a block will take in the buffer,
* including the size of the header.
*/
static inline size_t linear_allocator_block_size(size_t user_size)
{
return LINEAR_ALLOCATOR_ALIGN(LINEAR_ALLOCATOR_HDR_SIZE + user_size);
}
/*
* linear_allocator_ptr_to_block
*/
static inline linear_allocator_block_t *linear_allocator_ptr_to_block(void *ptr)
{
void *block_ptr;
block_ptr = ((char *)ptr) - offsetof(linear_allocator_block_t, data);
return block_ptr;
}
/*
* linear_allocator_init
*/
static inline void linear_allocator_init(linear_allocator_t *allocator,
char *buf, size_t buf_len)
{
memset(allocator, 0, sizeof(*allocator));
assert(linear_allocator_align_ptr(buf) == buf);
allocator->buf = buf;
allocator->cur = buf;
allocator->end = buf + buf_len;
}
/*
* linear_allocator_reset
*
* Prepare an allocator for reuse.
*
* *** NOTE ** This implicitly frees all the blocks in the allocator.
*/
static inline void linear_allocator_reset(linear_allocator_t *allocator)
{
allocator->num_allocated = 0;
allocator->version++;
allocator->cur = allocator->buf;
}
/*
* linear_allocator_alloc
*/
static inline void *linear_allocator_alloc(linear_allocator_t *allocator,
size_t user_size)
{
size_t block_size;
linear_allocator_block_t *block;
block_size = linear_allocator_block_size(user_size);
if (allocator->cur + block_size > allocator->end) {
return NULL;
}
block = (linear_allocator_block_t *)allocator->cur;
allocator->cur += block_size;
block->flags = LINEAR_ALLOCATOR_BLOCK_IN_USE;
block->version = allocator->version;
allocator->num_allocated++;
return block->data;
}
/*
* linear_allocator_free
*/
static inline void linear_allocator_free(linear_allocator_t *allocator,
void *ptr)
{
linear_allocator_block_t *block;
if (((char *)ptr) < allocator->buf || ((char *)ptr) >= allocator->end) {
assert(0);
return;
}
block = linear_allocator_ptr_to_block(ptr);
if (block->version != allocator->version) {
assert(0);
return;
}
block->flags = block->flags & ~LINEAR_ALLOCATOR_BLOCK_IN_USE;
if (--allocator->num_allocated < 0) {
assert(0);
}
}
|