mirror of
https://github.com/odin-lang/Odin.git
synced 2025-12-30 18:02:02 +00:00
[mem]: API for using small stack allocator directly
This commit is contained in:
@@ -33,6 +33,14 @@ Arena_Temp_Memory :: struct {
|
||||
prev_offset: int,
|
||||
}
|
||||
|
||||
@(require_results)
|
||||
arena_allocator :: proc(arena: ^Arena) -> Allocator {
|
||||
return Allocator{
|
||||
procedure = arena_allocator_proc,
|
||||
data = arena,
|
||||
}
|
||||
}
|
||||
|
||||
arena_init :: proc(a: ^Arena, data: []byte) {
|
||||
a.data = data
|
||||
a.offset = 0
|
||||
@@ -48,14 +56,6 @@ init_arena :: proc(a: ^Arena, data: []byte) {
|
||||
a.temp_count = 0
|
||||
}
|
||||
|
||||
@(require_results)
|
||||
arena_allocator :: proc(arena: ^Arena) -> Allocator {
|
||||
return Allocator{
|
||||
procedure = arena_allocator_proc,
|
||||
data = arena,
|
||||
}
|
||||
}
|
||||
|
||||
arena_alloc :: proc(a: ^Arena, size: int, alignment := DEFAULT_ALIGNMENT) -> ([]byte, Allocator_Error) {
|
||||
bytes, err := arena_alloc_non_zeroed(a, size, alignment)
|
||||
if bytes != nil {
|
||||
@@ -144,6 +144,14 @@ Scratch :: struct {
|
||||
leaked_allocations: [dynamic][]byte,
|
||||
}
|
||||
|
||||
@(require_results)
|
||||
scratch_allocator :: proc(allocator: ^Scratch) -> Allocator {
|
||||
return Allocator{
|
||||
procedure = scratch_allocator_proc,
|
||||
data = allocator,
|
||||
}
|
||||
}
|
||||
|
||||
scratch_init :: proc(s: ^Scratch, size: int, backup_allocator := context.allocator) -> Allocator_Error {
|
||||
s.data = make_aligned([]byte, size, 2*align_of(rawptr), backup_allocator) or_return
|
||||
s.curr_offset = 0
|
||||
@@ -275,6 +283,21 @@ scratch_free_all :: proc(s: ^Scratch, loc := #caller_location) {
|
||||
clear(&s.leaked_allocations)
|
||||
}
|
||||
|
||||
scratch_resize :: proc(
|
||||
s: ^Scratch,
|
||||
old_memory: rawptr,
|
||||
old_size: int,
|
||||
size: int,
|
||||
alignment := DEFAULT_ALIGNMENT,
|
||||
loc := #caller_location
|
||||
) -> ([]byte, Allocator_Error) {
|
||||
bytes, err := scratch_resize_non_zeroed(s, old_memory, old_size, size, alignment, loc)
|
||||
if bytes != nil && size > old_size {
|
||||
zero_slice(bytes[size:])
|
||||
}
|
||||
return bytes, err
|
||||
}
|
||||
|
||||
scratch_resize_non_zeroed :: proc(
|
||||
s: ^Scratch,
|
||||
old_memory: rawptr,
|
||||
@@ -308,21 +331,6 @@ scratch_resize_non_zeroed :: proc(
|
||||
return data, err
|
||||
}
|
||||
|
||||
scratch_resize :: proc(
|
||||
s: ^Scratch,
|
||||
old_memory: rawptr,
|
||||
old_size: int,
|
||||
size: int,
|
||||
alignment := DEFAULT_ALIGNMENT,
|
||||
loc := #caller_location
|
||||
) -> ([]byte, Allocator_Error) {
|
||||
bytes, err := scratch_resize_non_zeroed(s, old_memory, old_size, size, alignment, loc)
|
||||
if bytes != nil && size > old_size {
|
||||
zero_slice(bytes[size:])
|
||||
}
|
||||
return bytes, err
|
||||
}
|
||||
|
||||
scratch_allocator_proc :: proc(
|
||||
allocator_data: rawptr,
|
||||
mode: Allocator_Mode,
|
||||
@@ -358,14 +366,6 @@ scratch_allocator_proc :: proc(
|
||||
return nil, nil
|
||||
}
|
||||
|
||||
@(require_results)
|
||||
scratch_allocator :: proc(allocator: ^Scratch) -> Allocator {
|
||||
return Allocator{
|
||||
procedure = scratch_allocator_proc,
|
||||
data = allocator,
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
// Stack is a stack-like allocator which has a strict memory freeing order
|
||||
@@ -381,6 +381,14 @@ Stack_Allocation_Header :: struct {
|
||||
padding: int,
|
||||
}
|
||||
|
||||
@(require_results)
|
||||
stack_allocator :: proc(stack: ^Stack) -> Allocator {
|
||||
return Allocator{
|
||||
procedure = stack_allocator_proc,
|
||||
data = stack,
|
||||
}
|
||||
}
|
||||
|
||||
stack_init :: proc(s: ^Stack, data: []byte) {
|
||||
s.data = data
|
||||
s.prev_offset = 0
|
||||
@@ -396,12 +404,17 @@ init_stack :: proc(s: ^Stack, data: []byte) {
|
||||
s.peak_used = 0
|
||||
}
|
||||
|
||||
@(require_results)
|
||||
stack_allocator :: proc(stack: ^Stack) -> Allocator {
|
||||
return Allocator{
|
||||
procedure = stack_allocator_proc,
|
||||
data = stack,
|
||||
stack_alloc :: proc(
|
||||
s: ^Stack,
|
||||
size: int,
|
||||
alignment := DEFAULT_ALIGNMENT,
|
||||
loc := #caller_location
|
||||
) -> ([]byte, Allocator_Error) {
|
||||
bytes, err := stack_alloc_non_zeroed(s, size, alignment, loc)
|
||||
if bytes != nil {
|
||||
zero_slice(bytes)
|
||||
}
|
||||
return bytes, err
|
||||
}
|
||||
|
||||
stack_alloc_non_zeroed :: proc(
|
||||
@@ -433,19 +446,6 @@ stack_alloc_non_zeroed :: proc(
|
||||
return byte_slice(rawptr(next_addr), size), nil
|
||||
}
|
||||
|
||||
stack_alloc :: proc(
|
||||
s: ^Stack,
|
||||
size: int,
|
||||
alignment := DEFAULT_ALIGNMENT,
|
||||
loc := #caller_location
|
||||
) -> ([]byte, Allocator_Error) {
|
||||
bytes, err := stack_alloc_non_zeroed(s, size, alignment, loc)
|
||||
if bytes != nil {
|
||||
zero_slice(bytes)
|
||||
}
|
||||
return bytes, err
|
||||
}
|
||||
|
||||
stack_free :: proc(
|
||||
s: ^Stack,
|
||||
old_memory: rawptr,
|
||||
@@ -486,6 +486,25 @@ stack_free_all :: proc(s: ^Stack, loc := #caller_location) {
|
||||
s.curr_offset = 0
|
||||
}
|
||||
|
||||
stack_resize :: proc(
|
||||
s: ^Stack,
|
||||
old_memory: rawptr,
|
||||
old_size: int,
|
||||
size: int,
|
||||
alignment := DEFAULT_ALIGNMENT,
|
||||
loc := #caller_location,
|
||||
) -> ([]byte, Allocator_Error) {
|
||||
bytes, err := stack_alloc_non_zeroed(s, size, alignment, loc)
|
||||
if bytes != nil {
|
||||
if old_memory == nil {
|
||||
zero_slice(bytes)
|
||||
} else if size > old_size {
|
||||
zero_slice(bytes[old_size:])
|
||||
}
|
||||
}
|
||||
return bytes, err
|
||||
}
|
||||
|
||||
stack_resize_non_zeroed :: proc(
|
||||
s: ^Stack,
|
||||
old_memory: rawptr,
|
||||
@@ -535,25 +554,6 @@ stack_resize_non_zeroed :: proc(
|
||||
return byte_slice(old_memory, size), nil
|
||||
}
|
||||
|
||||
stack_resize :: proc(
|
||||
s: ^Stack,
|
||||
old_memory: rawptr,
|
||||
old_size: int,
|
||||
size: int,
|
||||
alignment := DEFAULT_ALIGNMENT,
|
||||
loc := #caller_location,
|
||||
) -> ([]byte, Allocator_Error) {
|
||||
bytes, err := stack_alloc_non_zeroed(s, size, alignment, loc)
|
||||
if bytes != nil {
|
||||
if old_memory == nil {
|
||||
zero_slice(bytes)
|
||||
} else if size > old_size {
|
||||
zero_slice(bytes[old_size:])
|
||||
}
|
||||
}
|
||||
return bytes, err
|
||||
}
|
||||
|
||||
stack_allocator_proc :: proc(
|
||||
allocator_data: rawptr,
|
||||
mode: Allocator_Mode,
|
||||
@@ -626,6 +626,129 @@ small_stack_allocator :: proc(stack: ^Small_Stack) -> Allocator {
|
||||
}
|
||||
}
|
||||
|
||||
small_stack_alloc :: proc(
|
||||
s: ^Small_Stack,
|
||||
size: int,
|
||||
alignment := DEFAULT_ALIGNMENT,
|
||||
loc := #caller_location,
|
||||
) -> ([]byte, Allocator_Error) {
|
||||
bytes, err := small_stack_alloc_non_zeroed(s, size, alignment, loc)
|
||||
if bytes != nil {
|
||||
zero_slice(bytes)
|
||||
}
|
||||
return bytes, err
|
||||
}
|
||||
|
||||
small_stack_alloc_non_zeroed :: proc(
|
||||
s: ^Small_Stack,
|
||||
size: int,
|
||||
alignment := DEFAULT_ALIGNMENT,
|
||||
loc := #caller_location,
|
||||
) -> ([]byte, Allocator_Error) {
|
||||
if s.data == nil {
|
||||
return nil, .Invalid_Argument
|
||||
}
|
||||
alignment := alignment
|
||||
alignment := clamp(alignment, 1, 8*size_of(Stack_Allocation_Header{}.padding)/2)
|
||||
curr_addr := uintptr(raw_data(s.data)) + uintptr(s.offset)
|
||||
padding := calc_padding_with_header(curr_addr, uintptr(alignment), size_of(Small_Stack_Allocation_Header))
|
||||
if s.offset + padding + size > len(s.data) {
|
||||
return nil, .Out_Of_Memory
|
||||
}
|
||||
s.offset += padding
|
||||
next_addr := curr_addr + uintptr(padding)
|
||||
header := (^Small_Stack_Allocation_Header)(next_addr - size_of(Small_Stack_Allocation_Header))
|
||||
header.padding = auto_cast padding
|
||||
s.offset += size
|
||||
s.peak_used = max(s.peak_used, s.offset)
|
||||
return byte_slice(rawptr(next_addr), size), nil
|
||||
}
|
||||
|
||||
small_stack_free :: proc(
|
||||
s: ^Small_Stack,
|
||||
old_memory: rawptr,
|
||||
loc := #caller_location,
|
||||
) -> Allocator_Error {
|
||||
if old_memory == nil {
|
||||
return nil, nil
|
||||
}
|
||||
start := uintptr(raw_data(s.data))
|
||||
end := start + uintptr(len(s.data))
|
||||
curr_addr := uintptr(old_memory)
|
||||
if !(start <= curr_addr && curr_addr < end) {
|
||||
// panic("Out of bounds memory address passed to stack allocator (free)");
|
||||
return nil, .Invalid_Pointer
|
||||
}
|
||||
if curr_addr >= start+uintptr(s.offset) {
|
||||
// NOTE(bill): Allow double frees
|
||||
return nil, nil
|
||||
}
|
||||
header := (^Small_Stack_Allocation_Header)(curr_addr - size_of(Small_Stack_Allocation_Header))
|
||||
old_offset := int(curr_addr - uintptr(header.padding) - uintptr(raw_data(s.data)))
|
||||
s.offset = old_offset
|
||||
}
|
||||
|
||||
small_stack_free_all :: proc(s: ^Small_Stack) {
|
||||
s.offset = 0
|
||||
}
|
||||
|
||||
small_stack_resize :: proc(
|
||||
s: ^Small_Stack,
|
||||
old_memory: rawptr,
|
||||
old_size: int,
|
||||
size: int,
|
||||
alignment := DEFAULT_ALIGNMENT,
|
||||
loc := #caller_location,
|
||||
) -> ([]byte, Allocator_Error) {
|
||||
bytes, err := small_stack_resize_non_zeroed(s, old_memory, old_size, size, alignment, loc)
|
||||
if bytes != nil {
|
||||
if old_memory == nil {
|
||||
zero_slice(bytes)
|
||||
} else if size > old_size {
|
||||
zero_slice(bytes[old_size:])
|
||||
}
|
||||
}
|
||||
return bytes, err
|
||||
}
|
||||
|
||||
small_stack_resize_non_zeroed :: proc(
|
||||
s: ^Small_Stack,
|
||||
old_memory: rawptr,
|
||||
old_size: int,
|
||||
size: int,
|
||||
alignment := DEFAULT_ALIGNMENT,
|
||||
loc := #caller_location,
|
||||
) -> ([]byte, Allocator_Error) {
|
||||
if old_memory == nil {
|
||||
return small_stack_alloc_non_zeroed(s, size, align, loc)
|
||||
}
|
||||
if size == 0 {
|
||||
return nil, nil
|
||||
}
|
||||
alignment := alignment
|
||||
alignment := clamp(alignment, 1, 8*size_of(Stack_Allocation_Header{}.padding)/2)
|
||||
start := uintptr(raw_data(s.data))
|
||||
end := start + uintptr(len(s.data))
|
||||
curr_addr := uintptr(old_memory)
|
||||
if !(start <= curr_addr && curr_addr < end) {
|
||||
// panic("Out of bounds memory address passed to stack allocator (resize)");
|
||||
return nil, .Invalid_Pointer
|
||||
}
|
||||
if curr_addr >= start+uintptr(s.offset) {
|
||||
// NOTE(bill): Treat as a double free
|
||||
return nil, nil
|
||||
}
|
||||
if old_size == size {
|
||||
return byte_slice(old_memory, size), nil
|
||||
}
|
||||
data, err := small_stack_alloc_non_zeroed(s, size, alignment, loc)
|
||||
if err == nil {
|
||||
runtime.copy(data, byte_slice(old_memory, old_size))
|
||||
}
|
||||
return data, err
|
||||
|
||||
}
|
||||
|
||||
small_stack_allocator_proc :: proc(
|
||||
allocator_data: rawptr,
|
||||
mode: Allocator_Mode,
|
||||
@@ -635,109 +758,36 @@ small_stack_allocator_proc :: proc(
|
||||
location := #caller_location,
|
||||
) -> ([]byte, Allocator_Error) {
|
||||
s := cast(^Small_Stack)allocator_data
|
||||
|
||||
if s.data == nil {
|
||||
return nil, .Invalid_Argument
|
||||
}
|
||||
|
||||
align := clamp(alignment, 1, 8*size_of(Stack_Allocation_Header{}.padding)/2)
|
||||
|
||||
raw_alloc :: proc(s: ^Small_Stack, size, alignment: int, zero_memory: bool) -> ([]byte, Allocator_Error) {
|
||||
curr_addr := uintptr(raw_data(s.data)) + uintptr(s.offset)
|
||||
padding := calc_padding_with_header(curr_addr, uintptr(alignment), size_of(Small_Stack_Allocation_Header))
|
||||
if s.offset + padding + size > len(s.data) {
|
||||
return nil, .Out_Of_Memory
|
||||
}
|
||||
s.offset += padding
|
||||
|
||||
next_addr := curr_addr + uintptr(padding)
|
||||
header := (^Small_Stack_Allocation_Header)(next_addr - size_of(Small_Stack_Allocation_Header))
|
||||
header.padding = auto_cast padding
|
||||
|
||||
s.offset += size
|
||||
|
||||
s.peak_used = max(s.peak_used, s.offset)
|
||||
|
||||
if zero_memory {
|
||||
zero(rawptr(next_addr), size)
|
||||
}
|
||||
return byte_slice(rawptr(next_addr), size), nil
|
||||
}
|
||||
|
||||
switch mode {
|
||||
case .Alloc, .Alloc_Non_Zeroed:
|
||||
return raw_alloc(s, size, align, mode == .Alloc)
|
||||
case .Alloc:
|
||||
return small_stack_alloc(s, size, alignment, loc)
|
||||
case .Alloc_Non_Zeroed:
|
||||
return small_stack_alloc_non_zeroed(s, size, alignment, loc)
|
||||
case .Free:
|
||||
if old_memory == nil {
|
||||
return nil, nil
|
||||
}
|
||||
start := uintptr(raw_data(s.data))
|
||||
end := start + uintptr(len(s.data))
|
||||
curr_addr := uintptr(old_memory)
|
||||
|
||||
if !(start <= curr_addr && curr_addr < end) {
|
||||
// panic("Out of bounds memory address passed to stack allocator (free)");
|
||||
return nil, .Invalid_Pointer
|
||||
}
|
||||
|
||||
if curr_addr >= start+uintptr(s.offset) {
|
||||
// NOTE(bill): Allow double frees
|
||||
return nil, nil
|
||||
}
|
||||
|
||||
header := (^Small_Stack_Allocation_Header)(curr_addr - size_of(Small_Stack_Allocation_Header))
|
||||
old_offset := int(curr_addr - uintptr(header.padding) - uintptr(raw_data(s.data)))
|
||||
|
||||
s.offset = old_offset
|
||||
|
||||
return nil, small_stack_free(s, old_memory, loc)
|
||||
case .Free_All:
|
||||
s.offset = 0
|
||||
|
||||
case .Resize, .Resize_Non_Zeroed:
|
||||
if old_memory == nil {
|
||||
return raw_alloc(s, size, align, mode == .Resize)
|
||||
}
|
||||
if size == 0 {
|
||||
return nil, nil
|
||||
}
|
||||
|
||||
start := uintptr(raw_data(s.data))
|
||||
end := start + uintptr(len(s.data))
|
||||
curr_addr := uintptr(old_memory)
|
||||
if !(start <= curr_addr && curr_addr < end) {
|
||||
// panic("Out of bounds memory address passed to stack allocator (resize)");
|
||||
return nil, .Invalid_Pointer
|
||||
}
|
||||
|
||||
if curr_addr >= start+uintptr(s.offset) {
|
||||
// NOTE(bill): Treat as a double free
|
||||
return nil, nil
|
||||
}
|
||||
|
||||
if old_size == size {
|
||||
return byte_slice(old_memory, size), nil
|
||||
}
|
||||
|
||||
data, err := raw_alloc(s, size, align, mode == .Resize)
|
||||
if err == nil {
|
||||
runtime.copy(data, byte_slice(old_memory, old_size))
|
||||
}
|
||||
return data, err
|
||||
|
||||
small_stack_free_all(s)
|
||||
case .Resize:
|
||||
return small_stack_resize(s, old_memory, old_size, size, alignment, loc)
|
||||
case .Resize_Non_Zeroed:
|
||||
return small_stack_resize_non_zeroed(s, old_memory, old_size, size, alignment, loc)
|
||||
case .Query_Features:
|
||||
set := (^Allocator_Mode_Set)(old_memory)
|
||||
if set != nil {
|
||||
set^ = {.Alloc, .Alloc_Non_Zeroed, .Free, .Free_All, .Resize, .Resize_Non_Zeroed, .Query_Features}
|
||||
}
|
||||
return nil, nil
|
||||
|
||||
case .Query_Info:
|
||||
return nil, .Mode_Not_Implemented
|
||||
}
|
||||
|
||||
return nil, nil
|
||||
}
|
||||
|
||||
|
||||
|
||||
Dynamic_Pool :: struct {
|
||||
block_size: int,
|
||||
out_band_size: int,
|
||||
|
||||
Reference in New Issue
Block a user