dynarray.h File Reference

#include "lib/posix/posix_mman.h"

Include dependency graph for dynarray.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	DynArray
	provides a memory range that can be expanded but doesn't waste physical memory or relocate itself. More...

Functions
Status	da_alloc (DynArray *da, size_t max_size)
	ready the DynArray object for use. More...
Status	da_free (DynArray *da)
	free all memory (address space + physical) that constitutes the given array. More...
Status	da_set_size (DynArray *da, size_t new_size)
	expand or shrink the array: changes the amount of currently committed (i.e. More...
Status	da_reserve (DynArray *da, size_t size)
	Make sure at least <size> bytes starting at da->pos are committed and ready for use. More...
Status	da_append (DynArray *da, const void *data_src, size_t size)
	"write" to array, i.e. More...

Function Documentation

da_alloc()

Status da_alloc	(	DynArray *	da,
		size_t	max_size
	)

ready the DynArray object for use.

no virtual memory is actually committed until calls to da_set_size.

Parameters

da	DynArray.
max_size	size [bytes] of address space to reserve (*); the DynArray can never expand beyond this. (* rounded up to next page size multiple)

Returns

Status.

da_append()

Status da_append	(	DynArray *	da,
		const void *	data_src,
		size_t	size
	)

"write" to array, i.e.

copy from the given buffer.

starts at offset DynArray.pos and advances this.

Parameters

da	DynArray.
data_src	source memory
size	[bytes] to copy

Returns

Status.

da_free()

Status da_free

(

DynArray *

da

)

free all memory (address space + physical) that constitutes the given array.

use-after-free is impossible because the memory is unmapped.

Parameters

da	DynArray* zeroed afterwards.

Returns

Status

da_reserve()

Status da_reserve	(	DynArray *	da,
		size_t	size
	)

Make sure at least <size> bytes starting at da->pos are committed and ready for use.

Parameters

da	DynArray*
size	Minimum amount to guarantee [bytes]

Returns

Status

da_set_size()

Status da_set_size	(	DynArray *	da,
		size_t	new_size
	)

expand or shrink the array: changes the amount of currently committed (i.e.

usable) memory pages.

Parameters

da	DynArray.
new_size	target size (rounded up to next page multiple). pages are added/removed until this is met.

Returns

Status.