#include <string.h>
#include <stdarg.h>
#include "lbm_types.h"
#include "symrepr.h"
#include "stack.h"
#include "lbm_memory.h"
#include "lbm_defines.h"
#include "lbm_channel.h"
#include "lbm_image.h"

Include dependency graph for heap.h:

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

Go to the source code of this file.

Data Structures
struct	lbm_cons_t

struct	lbm_heap_state_t

struct	lbm_const_heap_t

struct	lbm_array_header_t

struct	lbm_array_header_extended_t

Macros
#define	ERROR_SYMBOL_MASK 0xFFFFFFF0

#define	TRAV_FUN_SUBTREE_DONE 0

#define	TRAV_FUN_SUBTREE_CONTINUE 1

#define	TRAV_FUN_SUBTREE_PROCEED 2

#define	lbm_dec_as_int lbm_dec_as_i32

#define	lbm_dec_as_uint lbm_dec_as_u32

Typedefs
typedef bool(*	const_heap_write_fun) (lbm_uint w, lbm_uint ix)

typedef int(*	trav_fun) (lbm_value, bool, void *)

Enumerations
enum	lbm_flash_status { LBM_FLASH_WRITE_OK , LBM_FLASH_FULL , LBM_FLASH_WRITE_ERROR }

Functions
void	lbm_gc_lock (void)

void	lbm_gc_unlock (void)

bool	lbm_heap_init (lbm_cons_t *addr, lbm_uint num_cells, lbm_uint gc_stack_size)

void	lbm_heap_new_gc_time (lbm_uint dur)

void	lbm_heap_new_freelist_length (void)

static lbm_uint	lbm_heap_num_free (void)

lbm_uint	lbm_heap_num_allocated (void)

lbm_uint	lbm_heap_size (void)

lbm_uint	lbm_heap_size_bytes (void)

lbm_value	lbm_heap_allocate_cell (lbm_type ptr_type, lbm_value car, lbm_value cdr)

lbm_value	lbm_heap_allocate_list (lbm_uint n)

lbm_value	lbm_heap_allocate_list_init_va (unsigned int n, va_list valist)

lbm_value	lbm_heap_allocate_list_init (unsigned int n,...)

char *	lbm_dec_str (lbm_value val)

lbm_array_header_t *	lbm_dec_array_r (lbm_value val)

lbm_array_header_t *	lbm_dec_array_rw (lbm_value val)

lbm_char_channel_t *	lbm_dec_channel (lbm_value val)

lbm_uint	lbm_dec_custom (lbm_value val)

uint8_t	lbm_dec_as_char (lbm_value a)

uint32_t	lbm_dec_as_u32 (lbm_value val)

int32_t	lbm_dec_as_i32 (lbm_value val)

float	lbm_dec_as_float (lbm_value val)

uint64_t	lbm_dec_as_u64 (lbm_value val)

int64_t	lbm_dec_as_i64 (lbm_value val)

double	lbm_dec_as_double (lbm_value val)

lbm_uint	lbm_dec_as_uint (lbm_value val)

lbm_int	lbm_dec_as_int (lbm_value val)

lbm_uint	lbm_dec_raw (lbm_value v)

lbm_value	lbm_cons (lbm_value car, lbm_value cdr)

lbm_value	lbm_car (lbm_value cons)

lbm_value	lbm_caar (lbm_value c)

lbm_value	lbm_cadr (lbm_value c)

lbm_value	lbm_cdr (lbm_value cons)

lbm_value	lbm_cddr (lbm_value c)

int	lbm_set_car (lbm_value c, lbm_value v)

int	lbm_set_cdr (lbm_value c, lbm_value v)

int	lbm_set_car_and_cdr (lbm_value c, lbm_value car_val, lbm_value cdr_val)

lbm_uint	lbm_list_length (lbm_value c)

lbm_value	lbm_list_destructive_reverse (lbm_value list)

lbm_value	lbm_list_copy (int *m, lbm_value list)

lbm_value	lbm_list_append (lbm_value list1, lbm_value list2)

lbm_value	lbm_list_drop (unsigned int n, lbm_value ls)

lbm_value	lbm_index_list (lbm_value l, int32_t n)

void	lbm_get_heap_state (lbm_heap_state_t *)

lbm_uint	lbm_get_gc_stack_max (void)

lbm_uint	lbm_get_gc_stack_size (void)

void	lbm_gc_state_inc (void)

void	lbm_nil_freelist (void)

void	lbm_gc_mark_env (lbm_value)

void	lbm_gc_mark_phase (lbm_value root)

void	lbm_gc_mark_aux (lbm_uint *data, lbm_uint n)

void	lbm_gc_mark_roots (lbm_uint *roots, lbm_uint num_roots)

int	lbm_gc_sweep_phase (void)

int	lbm_heap_allocate_array (lbm_value *res, lbm_uint size)

int	lbm_heap_allocate_lisp_array (lbm_value *res, lbm_uint size)

int	lbm_lift_array (lbm_value value, char data, lbm_uint num_elt)

lbm_int	lbm_heap_array_get_size (lbm_value arr)

const uint8_t *	lbm_heap_array_get_data_ro (lbm_value arr)

int	lbm_heap_explicit_free_array (lbm_value arr)

int	lbm_const_heap_init (const_heap_write_fun w_fun, lbm_const_heap_t heap, lbm_uint addr)

lbm_flash_status	lbm_allocate_const_cell (lbm_value *res)

lbm_flash_status	lbm_write_const_raw (lbm_uint data, lbm_uint n, lbm_uint res)

lbm_flash_status	lbm_allocate_const_raw (lbm_uint nwords, lbm_uint *res)

lbm_flash_status	write_const_cdr (lbm_value cell, lbm_value val)

lbm_flash_status	write_const_car (lbm_value cell, lbm_value val)

lbm_flash_status	lbm_const_write (lbm_uint *tgt, lbm_uint val)

lbm_uint	lbm_flash_memory_usage (void)

static lbm_type	lbm_type_of (lbm_value x)

static lbm_type	lbm_type_of_functional (lbm_value x)

static lbm_value	lbm_enc_cons_ptr (lbm_uint x)

static lbm_uint	lbm_dec_ptr (lbm_value p)

static lbm_uint	lbm_dec_cons_cell_ptr (lbm_value p)

static lbm_cons_t *	lbm_dec_heap (lbm_value p)

static lbm_value	lbm_set_ptr_type (lbm_value p, lbm_type t)

static lbm_value	lbm_enc_sym (lbm_uint s)

static lbm_value	lbm_enc_i (lbm_int x)

static lbm_value	lbm_enc_u (lbm_uint x)

lbm_value	lbm_enc_i32 (int32_t x)

lbm_value	lbm_enc_u32 (uint32_t x)

lbm_value	lbm_enc_float (float x)

lbm_value	lbm_enc_i64 (int64_t x)

lbm_value	lbm_enc_u64 (uint64_t x)

lbm_value	lbm_enc_double (double x)

static lbm_value	lbm_enc_char (uint8_t x)

static lbm_int	lbm_dec_i (lbm_value x)

static lbm_uint	lbm_dec_u (lbm_value x)

static uint8_t	lbm_dec_char (lbm_value x)

static lbm_uint	lbm_dec_sym (lbm_value x)

float	lbm_dec_float (lbm_value x)

double	lbm_dec_double (lbm_value x)

static uint32_t	lbm_dec_u32 (lbm_value x)

uint64_t	lbm_dec_u64 (lbm_value x)

static int32_t	lbm_dec_i32 (lbm_value x)

int64_t	lbm_dec_i64 (lbm_value x)

static bool	lbm_is_ptr (lbm_value x)

static bool	lbm_is_constant (lbm_value x)

static bool	lbm_is_cons_rw (lbm_value x)

static bool	lbm_is_cons (lbm_value x)

static bool	lbm_is_symbol_nil (lbm_value exp)

static bool	lbm_is_number (lbm_value x)

static bool	lbm_heap_array_valid (lbm_value arr)

static bool	lbm_is_array_r (lbm_value x)

static bool	lbm_is_array_rw (lbm_value x)

static bool	lbm_is_lisp_array_r (lbm_value x)

static bool	lbm_is_lisp_array_rw (lbm_value x)

static bool	lbm_is_channel (lbm_value x)

static bool	lbm_is_char (lbm_value x)

static bool	lbm_is_special (lbm_value symrep)

static bool	lbm_is_closure (lbm_value exp)

static bool	lbm_is_continuation (lbm_value exp)

static bool	lbm_is_macro (lbm_value exp)

static bool	lbm_is_match_binder (lbm_value exp)

static bool	lbm_is_comma_qualified_symbol (lbm_value exp)

static bool	lbm_is_symbol (lbm_value exp)

static bool	lbm_is_symbol_true (lbm_value exp)

static bool	lbm_is_symbol_eval (lbm_value exp)

static bool	lbm_is_symbol_merror (lbm_value exp)

static bool	lbm_is_list (lbm_value x)

static bool	lbm_is_list_rw (lbm_value x)

static bool	lbm_is_quoted_list (lbm_value x)

static bool	lbm_is_error (lbm_value v)

static lbm_cons_t *	lbm_ref_cell (lbm_value addr)

void	lbm_ptr_rev_trav (trav_fun f, lbm_value v, void *arg)

Variables
lbm_heap_state_t	lbm_heap_state

lbm_cons_t *	lbm_heaps [2]

Macro Definition Documentation

◆ ERROR_SYMBOL_MASK

#define ERROR_SYMBOL_MASK 0xFFFFFFF0

◆ lbm_dec_as_int

#define lbm_dec_as_int lbm_dec_as_i32

◆ lbm_dec_as_uint

#define lbm_dec_as_uint lbm_dec_as_u32

◆ TRAV_FUN_SUBTREE_CONTINUE

#define TRAV_FUN_SUBTREE_CONTINUE 1

◆ TRAV_FUN_SUBTREE_DONE

#define TRAV_FUN_SUBTREE_DONE 0

◆ TRAV_FUN_SUBTREE_PROCEED

#define TRAV_FUN_SUBTREE_PROCEED 2

Typedef Documentation

◆ const_heap_write_fun

typedef bool(* const_heap_write_fun) (lbm_uint w, lbm_uint ix)

◆ trav_fun

typedef int(* trav_fun) (lbm_value, bool, void *)

Enumeration Type Documentation

◆ lbm_flash_status

enum lbm_flash_status

Enumerator
LBM_FLASH_WRITE_OK
LBM_FLASH_FULL
LBM_FLASH_WRITE_ERROR

Function Documentation

◆ lbm_allocate_const_cell()

lbm_flash_status lbm_allocate_const_cell ( lbm_value * res )

◆ lbm_allocate_const_raw()

lbm_flash_status lbm_allocate_const_raw	(	lbm_uint	nwords,
		lbm_uint *	res
	)

◆ lbm_caar()

lbm_value lbm_caar ( lbm_value c )

Accesses the car field the car field of an lbm_cons_t.

Parameters

cons Value

Returns: The car of car field or nil.

◆ lbm_cadr()

lbm_value lbm_cadr ( lbm_value c )

Accesses the car of the cdr of an cons cell

Parameters

c Value

Returns: the cdr field or type error.

◆ lbm_car()

lbm_value lbm_car ( lbm_value cons )

Accesses the car field of an lbm_cons_t.

Parameters

cons Value

Returns: The car field of the lbm_cons_t if cons is a reference to a heap cell. If cons is nil, the return value is nil. If the value is not cons or nil, the return value is enc_sym(SYM_TERROR) for type error.

◆ lbm_cddr()

lbm_value lbm_cddr ( lbm_value c )

Accesses the cdr of an cdr field of an lbm_cons_t.

Parameters

cons Value

Returns: The cdr of the cdr field of the lbm_cons_t if cons is a reference to a heap cell. If cons is nil, the return value is nil. If the value if not cons or nil, the return value is enc_sym(SYM_TERROR) for type error.

◆ lbm_cdr()

lbm_value lbm_cdr ( lbm_value cons )

Accesses the cdr field of an lbm_cons_t.

Parameters

cons Value

Returns: The cdr field of the lbm_cons_t if cons is a reference to a heap cell. If cons is nil, the return value is nil. If the value if not cons or nil, the return value is enc_sym(SYM_TERROR) for type error.

◆ lbm_cons()

lbm_value lbm_cons	(	lbm_value	car,
		lbm_value	cdr
	)

Allocates an lbm_cons_t cell from the heap and populates it.

Parameters

car	The value to put in the car field of the allocated lbm_cons_t.
cdr	The value to put in the cdr field of the allocated lbm_cons_t.

Returns: A value referencing the lbm_cons_t or enc_sym(SYM_MERROR) if heap is full.

◆ lbm_const_heap_init()

int lbm_const_heap_init	(	const_heap_write_fun	w_fun,
		lbm_const_heap_t *	heap,
		lbm_uint *	addr
	)

◆ lbm_const_write()

lbm_flash_status lbm_const_write	(	lbm_uint *	tgt,
		lbm_uint	val
	)

◆ lbm_dec_array_r()

lbm_array_header_t* lbm_dec_array_r ( lbm_value val )

Decode a readable array, if the argument is not an array the result is NULL

Parameters

val	value to decode.

Returns: array pointer or NULL.

◆ lbm_dec_array_rw()

lbm_array_header_t* lbm_dec_array_rw ( lbm_value val )

Decode an a read/write array, if the argument is not an array the result is NULL

Parameters

val	value to decode.

Returns: array pointer or NULL.

◆ lbm_dec_as_char()

uint8_t lbm_dec_as_char ( lbm_value a )

Decode a numerical value as if it is char

Parameters

val	Value to decode

Returns: The value encoded in val casted to a char. Returns 0 if val does not encode a number.

◆ lbm_dec_as_double()

double lbm_dec_as_double ( lbm_value val )

Decode a numerical value as a float.

Parameters

val	Value to decode.

Returns: The value encoded in val casted to a float. Returns 0 if val does not encode a number.

◆ lbm_dec_as_float()

float lbm_dec_as_float ( lbm_value val )

Decode a numerical value as a float.

Parameters

val	Value to decode.

Returns: The value encoded in val casted to a float. Returns 0 if val does not encode a number.

◆ lbm_dec_as_i32()

int32_t lbm_dec_as_i32 ( lbm_value val )

Decode a numerical value as a signed integer.

Parameters

val	Value to decode

Returns: The value encoded in val casted to a signed int. Returns 0 if val does not encode a number.

◆ lbm_dec_as_i64()

int64_t lbm_dec_as_i64 ( lbm_value val )

Decode a numerical value as a 64bit signed integer.

Parameters

val	Value to decode

Returns: The value encoded in val casted to a signed int. Returns 0 if val does not encode a number.

◆ lbm_dec_as_int()

lbm_int lbm_dec_as_int ( lbm_value val )

Decode a numerical value into the architecture defined signed integer type.

Parameters

val	Value to decode

Returns: The value encoded in val casted to a signed int. Returns 0 if val does not encode a number.

◆ lbm_dec_as_u32()

uint32_t lbm_dec_as_u32 ( lbm_value val )

Decode a numerical value as if it is unsigned

Parameters

val	Value to decode

Returns: The value encoded in val casted to an unsigned int. Returns 0 if val does not encode a number.

◆ lbm_dec_as_u64()

uint64_t lbm_dec_as_u64 ( lbm_value val )

Decode a numerical value as if it is a 64bit unsigned

Parameters

val	Value to decode

Returns: The value encoded in val casted to an unsigned int. Returns 0 if val does not encode a number.

◆ lbm_dec_as_uint()

lbm_uint lbm_dec_as_uint ( lbm_value val )

Decode a numerical value into the architecture defined unsigned integer type.

Parameters

val	Value to decode

Returns: The value encoded in val casted to an unsigned int. Returns 0 if val does not encode a number.

◆ lbm_dec_channel()

lbm_char_channel_t* lbm_dec_channel ( lbm_value val )

Decode an lbm_value representing a char channel into an lbm_char_channel_t pointer.

Parameters

val Value

Returns: A pointer to an lbm_char_channel_t or NULL if the value does not encode a channel.

◆ lbm_dec_char()

static uint8_t lbm_dec_char ( lbm_value x )

inlinestatic

◆ lbm_dec_cons_cell_ptr()

static lbm_uint lbm_dec_cons_cell_ptr ( lbm_value p )

inlinestatic

◆ lbm_dec_custom()

lbm_uint lbm_dec_custom ( lbm_value val )

Decode an lbm_value representing a custom type into a lbm_uint value.

Parameters

val Value.

Returns: The custom type payload.

◆ lbm_dec_double()

double lbm_dec_double ( lbm_value x )

Decode an lbm_value representing a double.

Parameters

x	Value to decode.

Returns: decoded float.

◆ lbm_dec_float()

float lbm_dec_float ( lbm_value x )

Decode an lbm_value representing a float.

Parameters

x	Value to decode.

Returns: decoded float.

◆ lbm_dec_heap()

static lbm_cons_t* lbm_dec_heap ( lbm_value p )

inlinestatic

◆ lbm_dec_i()

static lbm_int lbm_dec_i ( lbm_value x )

inlinestatic

◆ lbm_dec_i32()

static int32_t lbm_dec_i32 ( lbm_value x )

inlinestatic

◆ lbm_dec_i64()

int64_t lbm_dec_i64 ( lbm_value x )

Decode an lbm_value representing a 64 bit integer.

Parameters

x	Value to decode.

Returns: decoded int64_t.

◆ lbm_dec_ptr()

static lbm_uint lbm_dec_ptr ( lbm_value p )

inlinestatic

◆ lbm_dec_raw()

lbm_uint lbm_dec_raw ( lbm_value v )

◆ lbm_dec_str()

char* lbm_dec_str ( lbm_value val )

Decode an lbm_value representing a string into a C string

Parameters

val Value

Returns: allocated list or error symbol

◆ lbm_dec_sym()

static lbm_uint lbm_dec_sym ( lbm_value x )

inlinestatic

◆ lbm_dec_u()

static lbm_uint lbm_dec_u ( lbm_value x )

inlinestatic

◆ lbm_dec_u32()

static uint32_t lbm_dec_u32 ( lbm_value x )

inlinestatic

◆ lbm_dec_u64()

uint64_t lbm_dec_u64 ( lbm_value x )

Decode an lbm_value representing a 64 bit unsigned integer.

Parameters

x	Value to decode.

Returns: decoded uint64_t.

◆ lbm_enc_char()

static lbm_value lbm_enc_char ( uint8_t x )

inlinestatic

◆ lbm_enc_cons_ptr()

static lbm_value lbm_enc_cons_ptr ( lbm_uint x )

inlinestatic

◆ lbm_enc_double()

lbm_value lbm_enc_double ( double x )

Encode a double into an lbm_value.

Parameters

x	double to encode.

Returns: result encoded value.

◆ lbm_enc_float()

lbm_value lbm_enc_float ( float x )

Encode a float into an lbm_value.

Parameters

x	float value to encode.

Returns: result encoded value.

◆ lbm_enc_i()

static lbm_value lbm_enc_i ( lbm_int x )

inlinestatic

◆ lbm_enc_i32()

lbm_value lbm_enc_i32 ( int32_t x )

Encode 32 bit integer into an lbm_value.

Parameters

x	Value to encode.

Returns: result encoded value.

◆ lbm_enc_i64()

lbm_value lbm_enc_i64 ( int64_t x )

Encode a 64 bit integer into an lbm_value.

Parameters

x	64 bit integer to encode.

Returns: result encoded value.

◆ lbm_enc_sym()

static lbm_value lbm_enc_sym ( lbm_uint s )

inlinestatic

◆ lbm_enc_u()

static lbm_value lbm_enc_u ( lbm_uint x )

inlinestatic

◆ lbm_enc_u32()

lbm_value lbm_enc_u32 ( uint32_t x )

Encode 32 bit unsigned integer into an lbm_value.

Parameters

x	Value to encode.

Returns: result encoded value.

◆ lbm_enc_u64()

lbm_value lbm_enc_u64 ( uint64_t x )

Encode a 64 bit unsigned integer into an lbm_value.

Parameters

x	64 bit unsigned integer to encode.

Returns: result encoded value.

◆ lbm_flash_memory_usage()

lbm_uint lbm_flash_memory_usage ( void )

◆ lbm_gc_lock()

void lbm_gc_lock ( void )

Lock GC mutex Locks a mutex during GC marking when using the pointer reversal algorithm. Does nothing when using stack based GC mark.

◆ lbm_gc_mark_aux()

void lbm_gc_mark_aux	(	lbm_uint *	data,
		lbm_uint	n
	)

Performs lbm_gc_mark_phase on all the values of an array. This function is similar to lbm_gc_mark_roots but performs extra checks to not traverse into non-standard values. TODO: Check if this function is really needed.

Parameters

data	Array of roots to traverse from.
n	Number of elements in roots-array.

◆ lbm_gc_mark_env()

void lbm_gc_mark_env ( lbm_value env )

Mark all heap cells reachable from an environment.

Parameters

environment.

◆ lbm_gc_mark_phase()

void lbm_gc_mark_phase ( lbm_value root )

Mark heap cells reachable from the lbm_value v.

Parameters

root

◆ lbm_gc_mark_roots()

void lbm_gc_mark_roots	(	lbm_uint *	roots,
		lbm_uint	num_roots
	)

Performs lbm_gc_mark_phase on all the values in the roots array.

Parameters

roots	pointer to array of roots.
num_roots	size of array of roots.

◆ lbm_gc_state_inc()

void lbm_gc_state_inc ( void )

Increment the counter that is counting the number of times GC ran

◆ lbm_gc_sweep_phase()

int lbm_gc_sweep_phase ( void )

Sweep up all non marked heap cells and place them on the free list.

Returns: 1

◆ lbm_gc_unlock()

void lbm_gc_unlock ( void )

◆ lbm_get_gc_stack_max()

lbm_uint lbm_get_gc_stack_max ( void )

Get the maximum stack level of the GC stack

Returns: maximum value the gc stack sp reached so far.

◆ lbm_get_gc_stack_size()

lbm_uint lbm_get_gc_stack_size ( void )

Get the size of the GC stack.

Returns: the size of the gc stack.

◆ lbm_get_heap_state()

void lbm_get_heap_state ( lbm_heap_state_t * res )

Get a copy of the heap statistics structure.

Parameters

A	pointer to an lbm_heap_state_t to populate with the current statistics.

◆ lbm_heap_allocate_array()

int lbm_heap_allocate_array	(	lbm_value *	res,
		lbm_uint	size
	)

Allocate an bytearray in symbols and arrays memory (lispbm_memory.h) and create a heap cell that refers to this bytearray.

Parameters

res	The resulting lbm_value is returned through this argument.
size	Array size in number of 32 bit words.

Returns: 1 for success of 0 for failure.

◆ lbm_heap_allocate_cell()

lbm_value lbm_heap_allocate_cell	(	lbm_type	ptr_type,
		lbm_value	car,
		lbm_value	cdr
	)

Allocate an lbm_cons_t cell from the heap.

Parameters

type	A type that can be encoded onto the cell (most often LBM_PTR_TYPE_CONS).
car	Value to write into car position of allocated cell.
cdr	Value to write into cdr position of allocated cell.

Returns: a heap cell on success and Memory_error on failure.

◆ lbm_heap_allocate_lisp_array()

int lbm_heap_allocate_lisp_array	(	lbm_value *	res,
		lbm_uint	size
	)

Allocate an array in symbols and arrays memory (lispbm_memory.h) and create a heap cell that refers to this array.

Parameters

res	The resulting lbm_value is returned through this argument.
size	Array size in number of 32 bit words.

Returns: 1 for success of 0 for failure.

◆ lbm_heap_allocate_list()

lbm_value lbm_heap_allocate_list ( lbm_uint n )

Allocate a list of n heap-cells.

Parameters

n	The number of heap-cells to allocate.

Returns: A list of heap-cells of Memory error if unable to allocate.

◆ lbm_heap_allocate_list_init()

lbm_value lbm_heap_allocate_list_init	(	unsigned int	n,
			...
	)

Allocate a list of n heap-cells and initialize the values.

Parameters

n	The length of list to allocate.
...	The values to initialize the list with.

Returns: allocated list or error symbol.

◆ lbm_heap_allocate_list_init_va()

lbm_value lbm_heap_allocate_list_init_va	(	unsigned int	n,
		va_list	valist
	)

Allocate a list of n heap-cells and initialize the values. \pram ls The result list is passed through this ptr.

Parameters

n	The length of list to allocate.
valist	The values in a va_list to initialize the list with.

Returns: True of False depending on success of allocation.

◆ lbm_heap_array_get_data_ro()

const uint8_t* lbm_heap_array_get_data_ro ( lbm_value arr )

Get a pointer to the data of an array for read only purposes.

Parameters

arr	lbm_value array to get pointer from.

Returns: NULL or valid pointer.

◆ lbm_heap_array_get_size()

lbm_int lbm_heap_array_get_size ( lbm_value arr )

Get the size of an array value.

Parameters

arr	lbm_value array to get size of.

Returns: -1 for failure or length of array.

◆ lbm_heap_array_valid()

static bool lbm_heap_array_valid ( lbm_value arr )

inlinestatic

◆ lbm_heap_explicit_free_array()

int lbm_heap_explicit_free_array ( lbm_value arr )

Explicitly free an array. This function needs to be used with care and knowledge.

Parameters

arr	Array value.

◆ lbm_heap_init()

bool lbm_heap_init	(	lbm_cons_t *	addr,
		lbm_uint	num_cells,
		lbm_uint	gc_stack_size
	)

Initialize heap storage.

Parameters

addr	Pointer to an array of lbm_cons_t elements. This array must at least be aligned 4.
num_cells	Number of lbm_cons_t elements in the array.
gc_stack_size	Size of the gc_stack in number of words.

Returns: true on success or false for failure.

◆ lbm_heap_new_freelist_length()

void lbm_heap_new_freelist_length ( void )

Add a new free_list length to the heap_stats. Calculates a new freelist length and updates the GC statistics.

◆ lbm_heap_new_gc_time()

void lbm_heap_new_gc_time ( lbm_uint dur )

Add GC time statistics to heap_stats

Parameters

dur	Duration as reported by the timestamp callback.

◆ lbm_heap_num_allocated()

lbm_uint lbm_heap_num_allocated ( void )

Check how many lbm_cons_t cells are allocated.

Returns: Number of lbm_cons_t cells that are currently allocated.

◆ lbm_heap_num_free()

static lbm_uint lbm_heap_num_free ( void )

inlinestatic

Check how many lbm_cons_t cells are on the free-list

Returns: Number of free lbm_cons_t cells.

◆ lbm_heap_size()

lbm_uint lbm_heap_size ( void )

Size of the heap in number of lbm_cons_t cells.

Returns: Size of the heap in number of lbm_cons_t cells.

◆ lbm_heap_size_bytes()

lbm_uint lbm_heap_size_bytes ( void )

Size of the heap in bytes.

Returns: Size of heap in bytes.

◆ lbm_index_list()

lbm_value lbm_index_list	(	lbm_value	l,
		int32_t	n
	)

Index into a list.

Parameters

l	List to index into.
n	Position to read out of the list.

Returns: Value at position n of l or nil if out of bounds.

◆ lbm_is_array_r()

static bool lbm_is_array_r ( lbm_value x )

inlinestatic

Check if value is an array that can be READ

Parameters

x	Value to check.

Returns: true if x represents a readable array and false otherwise.

◆ lbm_is_array_rw()

static bool lbm_is_array_rw ( lbm_value x )

inlinestatic

◆ lbm_is_channel()

static bool lbm_is_channel ( lbm_value x )

inlinestatic

◆ lbm_is_char()

static bool lbm_is_char ( lbm_value x )

inlinestatic

◆ lbm_is_closure()

static bool lbm_is_closure ( lbm_value exp )

inlinestatic

◆ lbm_is_comma_qualified_symbol()

static bool lbm_is_comma_qualified_symbol ( lbm_value exp )

inlinestatic

◆ lbm_is_cons()

static bool lbm_is_cons ( lbm_value x )

inlinestatic

Check if a value is a Readable cons cell

Parameters

x	Value to check

Returns: true if x is a readable cons cell, false otherwise.

◆ lbm_is_cons_rw()

static bool lbm_is_cons_rw ( lbm_value x )

inlinestatic

Check if a value is a Read/Writeable cons cell

Parameters

x	Value to check

Returns: true if x is a Read/Writeable cons cell, false otherwise.

◆ lbm_is_constant()

static bool lbm_is_constant ( lbm_value x )

inlinestatic

◆ lbm_is_continuation()

static bool lbm_is_continuation ( lbm_value exp )

inlinestatic

◆ lbm_is_error()

static bool lbm_is_error ( lbm_value v )

inlinestatic

◆ lbm_is_lisp_array_r()

static bool lbm_is_lisp_array_r ( lbm_value x )

inlinestatic

◆ lbm_is_lisp_array_rw()

static bool lbm_is_lisp_array_rw ( lbm_value x )

inlinestatic

◆ lbm_is_list()

static bool lbm_is_list ( lbm_value x )

inlinestatic

◆ lbm_is_list_rw()

static bool lbm_is_list_rw ( lbm_value x )

inlinestatic

◆ lbm_is_macro()

static bool lbm_is_macro ( lbm_value exp )

inlinestatic

◆ lbm_is_match_binder()

static bool lbm_is_match_binder ( lbm_value exp )

inlinestatic

◆ lbm_is_number()

static bool lbm_is_number ( lbm_value x )

inlinestatic

Check if a value represents a number

Parameters

x	Value to check.

Returns: true is x represents a number and false otherwise.

◆ lbm_is_ptr()

static bool lbm_is_ptr ( lbm_value x )

inlinestatic

Check if a value is a heap pointer

Parameters

x	Value to check

Returns: true if x is a pointer to a heap cell, false otherwise.

◆ lbm_is_quoted_list()

static bool lbm_is_quoted_list ( lbm_value x )

inlinestatic

◆ lbm_is_special()

static bool lbm_is_special ( lbm_value symrep )

inlinestatic

◆ lbm_is_symbol()

static bool lbm_is_symbol ( lbm_value exp )

inlinestatic

◆ lbm_is_symbol_eval()

static bool lbm_is_symbol_eval ( lbm_value exp )

inlinestatic

◆ lbm_is_symbol_merror()

static bool lbm_is_symbol_merror ( lbm_value exp )

inlinestatic

◆ lbm_is_symbol_nil()

static bool lbm_is_symbol_nil ( lbm_value exp )

inlinestatic

◆ lbm_is_symbol_true()

static bool lbm_is_symbol_true ( lbm_value exp )

inlinestatic

◆ lbm_lift_array()

int lbm_lift_array	(	lbm_value *	value,
		char *	data,
		lbm_uint	num_elt
	)

Convert a C array into an lbm array. If the C array is allocated in LBM MEMORY the lifetime of the array will be managed by GC.

Parameters

res	lbm_value result pointer for storage of the result array.
data	C array.
type	The type tag to assign to the resulting LBM array.
num_elt	Number of elements in the array.

Returns: 1 for success and 0 for failure.

◆ lbm_list_append()

lbm_value lbm_list_append	(	lbm_value	list1,
		lbm_value	list2
	)

A destructive append of two lists

Parameters

list1	A list
list2	A list

Returns: list1 with list2 appended at the end.

◆ lbm_list_copy()

lbm_value lbm_list_copy	(	int *	m,
		lbm_value	list
	)

Copy a list

Warning: This is a dangerous function that should be used carefully. Cyclic structures on the heap may lead to the function not terminating.

Parameters

m	Number of elements to copy or -1 for all. If 1, m will be updated with the length of the list
list	A list.

Returns: Reversed list or enc_sym(SYM_MERROR) if heap is full.

◆ lbm_list_destructive_reverse()

lbm_value lbm_list_destructive_reverse ( lbm_value list )

Reverse a proper list destroying the original.

Warning: This is a dangerous function that should be used carefully. Cyclic structures on the heap may lead to the function not terminating.

Parameters

list A list

Returns: The list reversed

◆ lbm_list_drop()

lbm_value lbm_list_drop	(	unsigned int	n,
		lbm_value	ls
	)

Drop values from the head of a list.

Parameters

n	Number of values to drop.
ls	List to drop values from.

Returns: The list with the n first elements removed.

◆ lbm_list_length()

lbm_uint lbm_list_length ( lbm_value c )

Calculate the length of a proper list

Warning: This is a dangerous function that should be used carefully. Cyclic structures on the heap may lead to the function not terminating.

Parameters

c A list

Returns: The length of the list. Unless the value is a cyclic structure on the heap, this function will terminate.

◆ lbm_nil_freelist()

void lbm_nil_freelist ( void )

Set the freelist to NIL. Means that no memory will be available until after a garbage collection.

◆ lbm_ptr_rev_trav()

void lbm_ptr_rev_trav	(	trav_fun	f,
		lbm_value	v,
		void *	arg
	)

Parameters

f	pointer to function to execute at each node in tree.
v	Tree to traverses.
arg	Extra argument to pass to f when applied.

◆ lbm_ref_cell()

static lbm_cons_t* lbm_ref_cell ( lbm_value addr )

inlinestatic

◆ lbm_set_car()

int lbm_set_car	(	lbm_value	c,
		lbm_value	v
	)

Update the value stored in the car field of a heap cell.

Parameters

c	Value referring to a heap cell.
v	Value to replace the car field with.

Returns: 1 on success and 0 if the c value does not refer to a heap cell.

◆ lbm_set_car_and_cdr()

int lbm_set_car_and_cdr	(	lbm_value	c,
		lbm_value	car_val,
		lbm_value	cdr_val
	)

Update the value stored in the car and cdr fields of a heap cell.

Parameters

c	Value referring to a heap cell.
car_val	Value to replace the car field with.
cdr_val	Value to replace the cdr field with.

Returns: 1 on success and 0 if the c value does not refer to a heap cell.

◆ lbm_set_cdr()

int lbm_set_cdr	(	lbm_value	c,
		lbm_value	v
	)

Update the value stored in the cdr field of a heap cell.

Parameters

c	Value referring to a heap cell.
v	Value to replace the cdr field with.

Returns: 1 on success and 0 if the c value does not refer to a heap cell.

◆ lbm_set_ptr_type()

static lbm_value lbm_set_ptr_type	(	lbm_value	p,
		lbm_type	t
	)

inlinestatic

◆ lbm_type_of()

static lbm_type lbm_type_of ( lbm_value x )

inlinestatic

Query the type information of a value.

Parameters

x	Value to check the type of.

Returns: The type information.

◆ lbm_type_of_functional()

static lbm_type lbm_type_of_functional ( lbm_value x )

inlinestatic

◆ lbm_write_const_raw()

lbm_flash_status lbm_write_const_raw	(	lbm_uint *	data,
		lbm_uint	n,
		lbm_uint *	res
	)

◆ write_const_car()

lbm_flash_status write_const_car	(	lbm_value	cell,
		lbm_value	val
	)

◆ write_const_cdr()

lbm_flash_status write_const_cdr	(	lbm_value	cell,
		lbm_value	val
	)

Variable Documentation

◆ lbm_heap_state

lbm_heap_state_t lbm_heap_state

extern

◆ lbm_heaps

lbm_cons_t* lbm_heaps[2]

extern

Data Structures

Macros

Typedefs

Enumerations

Functions

Variables

Macro Definition Documentation

◆ ERROR_SYMBOL_MASK

◆ lbm_dec_as_int

◆ lbm_dec_as_uint

◆ TRAV_FUN_SUBTREE_CONTINUE

◆ TRAV_FUN_SUBTREE_DONE

◆ TRAV_FUN_SUBTREE_PROCEED

Typedef Documentation

◆ const_heap_write_fun

◆ trav_fun

Enumeration Type Documentation

◆ lbm_flash_status

Function Documentation

◆ lbm_allocate_const_cell()

◆ lbm_allocate_const_raw()

◆ lbm_caar()

◆ lbm_cadr()

◆ lbm_car()

◆ lbm_cddr()

◆ lbm_cdr()

◆ lbm_cons()

◆ lbm_const_heap_init()

◆ lbm_const_write()

◆ lbm_dec_array_r()

◆ lbm_dec_array_rw()

◆ lbm_dec_as_char()

◆ lbm_dec_as_double()

◆ lbm_dec_as_float()

◆ lbm_dec_as_i32()

◆ lbm_dec_as_i64()

◆ lbm_dec_as_int()

◆ lbm_dec_as_u32()

◆ lbm_dec_as_u64()

◆ lbm_dec_as_uint()

◆ lbm_dec_channel()

◆ lbm_dec_char()

◆ lbm_dec_cons_cell_ptr()

◆ lbm_dec_custom()

◆ lbm_dec_double()

◆ lbm_dec_float()

◆ lbm_dec_heap()

◆ lbm_dec_i()

◆ lbm_dec_i32()

◆ lbm_dec_i64()

◆ lbm_dec_ptr()

◆ lbm_dec_raw()

◆ lbm_dec_str()

◆ lbm_dec_sym()

◆ lbm_dec_u()

◆ lbm_dec_u32()

◆ lbm_dec_u64()

◆ lbm_enc_char()

◆ lbm_enc_cons_ptr()

◆ lbm_enc_double()

◆ lbm_enc_float()

◆ lbm_enc_i()

◆ lbm_enc_i32()

◆ lbm_enc_i64()

◆ lbm_enc_sym()

◆ lbm_enc_u()

◆ lbm_enc_u32()

◆ lbm_enc_u64()

◆ lbm_flash_memory_usage()

◆ lbm_gc_lock()

◆ lbm_gc_mark_aux()

◆ lbm_gc_mark_env()

◆ lbm_gc_mark_phase()

◆ lbm_gc_mark_roots()

◆ lbm_gc_state_inc()

◆ lbm_gc_sweep_phase()

◆ lbm_gc_unlock()

◆ lbm_get_gc_stack_max()

◆ lbm_get_gc_stack_size()

◆ lbm_get_heap_state()