Data Structures

Warning

doxygenstruct: Cannot find class “AtomsHashTable” in doxygen xml output for project “libatomvm” from directory: /__w/AtomVM/AtomVM/build/doc/xml/

struct AtomStringIntPair

A structure to represent atom strings and int pairs. Such as {“\x8” “universe”, 42}.

Public Members

AtomString as_val

int i_val

struct AtomTable

Collaboration diagram for AtomTable:

Public Members

size_t capacity

size_t count

int last_node_group_avail

RWLock *lock

struct HNode **buckets

struct HNodeGroup *first_node_group

struct HNodeGroup *last_node_group

struct AVMPackData

Collaboration diagram for AVMPackData:

Public Members

const struct AVMPackInfo *obj_info

struct ListHead avmpack_head

bool in_use

int name_atom_id

const void *data

struct BuiltInAtomRequestSignal

Collaboration diagram for BuiltInAtomRequestSignal:

Public Members

MailboxMessage base

int32_t sender_pid

term atom

Warning

doxygenstruct: Cannot find class “BuiltInAtomSignal” in doxygen xml output for project “libatomvm” from directory: /__w/AtomVM/AtomVM/build/doc/xml/

struct CharDataToBytesAcc

Collaboration diagram for CharDataToBytesAcc:

Public Members

enum CharDataEncoding in_encoding

enum CharDataEncoding out_encoding

uint8_t *output

term *rest

Heap *heap

bool badarg

bool incomplete_transform

struct CharDataToBytesSizeAcc

Public Members

enum CharDataEncoding in_encoding

enum CharDataEncoding out_encoding

size_t size

size_t rest_size

bool badarg

bool incomplete_transform

struct ConstAVMPack

Collaboration diagram for ConstAVMPack:

Public Members

struct AVMPackData base

struct Context

Collaboration diagram for Context:

Public Members

GlobalContext *global

Heap heap

term *e

term x[16 + 1]

term cp

avm_float_t *fr

term bs

size_t bs_offset

struct ListHead extended_x_regs

struct ListHead processes_list_head

struct ListHead processes_table_head

int32_t process_id

struct TimerListItem timer_list_head

struct ListHead monitors_head

size_t min_heap_size

size_t max_heap_size

enum HeapGrowthStrategy heap_growth_strategy

Module *saved_module

const void *saved_ip

NativeContinuation saved_function_ptr

union Context

void *restore_trap_handler

Mailbox mailbox

struct ListHead dictionary

native_handler_f native_handler

unsigned int leader

unsigned int has_min_heap_size

unsigned int has_max_heap_size

bool trap_exit

bool waiting_with_timeout

unsigned int trace_calls

unsigned int trace_call_args

unsigned int trace_returns

unsigned int trace_send

unsigned int trace_receive

enum ContextFlags flags

void *platform_data

term group_leader

term exit_reason

uintptr_t exception_class

term exception_reason

term exception_stacktrace

struct ContextAccumulator

Collaboration diagram for ContextAccumulator:

Public Members

Context *ctx

term result

struct DictEntry

Collaboration diagram for DictEntry:

Public Members

struct ListHead head

term key

term value

struct EntropyContextResource

Public Members

mbedtls_entropy_context context

struct ErlNifEnv

Collaboration diagram for ErlNifEnv:

Public Members

GlobalContext *global

Heap heap

term *stack_pointer

term x[2]

struct ErlNifResourceTypeInit

Resource callbacks.

Members should be set to 0, 1 or 2 depending on provided callbacks. Callbacks can also be NULL if not used.

Public Members

int members

ErlNifResourceDtor *dtor

ErlNifResourceStop *stop

ErlNifResourceDown *down

struct ExportedFunction

Public Members

enum FunctionType type

struct FprintfFun

Collaboration diagram for FprintfFun:

Public Members

PrinterFun base

FILE *stream

struct GenMessage

Public Members

term req

term pid

term ref

struct GlobalContext

Collaboration diagram for GlobalContext:

Public Members

struct ListHead ready_processes

struct ListHead running_processes

struct ListHead waiting_processes

SpinLock processes_spinlock

struct MessageQueueItem *message_queue

struct RefcBinaryQueueItem *refc_queue

struct SyncList refc_binaries

struct SyncList processes_table

struct SyncList registered_processes

struct SyncList listeners

struct SyncList resource_types

struct SyncList select_events

struct Ets ets

int32_t last_process_id

struct AtomTable *atom_table

struct ValuesHashTable *modules_table

RWLock *modules_lock

Module **modules_by_index

int loaded_modules_count

struct SyncList avmpack_data

struct TimerList timer_list

SpinLock timer_spinlock

unsigned long long ref_ticks

SpinLock ref_ticks_spinlock

int online_schedulers

int running_schedulers

bool waiting_scheduler

Mutex *schedulers_mutex

CondVar *schedulers_cv

bool scheduler_stop_all

SpinLock env_spinlock

term node_name

uint32_t creation

ErlNifResourceType *resource_binary_resource_type

ErlNifResourceType *dist_connection_resource_type

struct SyncList dist_connections

void *platform_data

struct Heap

Collaboration diagram for Heap:

Public Members

HeapFragment *root

term *heap_start

term *heap_ptr

term *heap_end

struct HNode

Public Members

struct HNode *next

AtomString key

unsigned long value

struct HNodeGroup

Collaboration diagram for HNodeGroup:

Public Members

struct HNodeGroup *next

atom_index_t first_index

uint16_t len

struct HNode nodes[]

struct IFFRecord

Public Members

const char name[4]

uint32_t size

struct InMemoryAVMPack

Collaboration diagram for InMemoryAVMPack:

Public Members

struct AVMPackData base

struct Int24

int32_t val24 : 24

struct Int40

int64_t val40 : 40

struct Int48

int64_t val48 : 48

struct Int56

int64_t val56 : 56

struct kv_pair

Public Members

term key

term value

struct LineRefOffset

Collaboration diagram for LineRefOffset:

Public Members

struct ListHead head

unsigned int offset

struct ListHead

Collaboration diagram for ListHead:

Public Members

struct ListHead *next

struct ListHead *prev

struct LiteralEntry

Public Members

uint32_t size

void const *data

struct Mailbox

Collaboration diagram for Mailbox:

Public Members

MailboxMessage *outer_first

MailboxMessage *inner_first

MailboxMessage *inner_last

MailboxMessage *receive_pointer

MailboxMessage *receive_pointer_prev

bool receive_has_match_clauses

struct Message

Collaboration diagram for Message:

Public Members

MailboxMessage base

term message

term *heap_end

term storage[]

struct Module

Collaboration diagram for Module:

Public Members

int module_index

CodeChunk *code

void *import_table

void *export_table

void *local_table

void *atom_table

void *fun_table

void *str_table

size_t str_table_len

size_t line_refs_count

const uint8_t *line_refs_table

size_t locations_count

const uint8_t *locations_table

uint8_t *binary

size_t binary_size

ModuleNativeEntryPoint native_code

unsigned int *line_refs_offsets

size_t line_refs_offsets_count

const struct ExportedFunction **imported_funcs

const uint8_t **labels

void *literals_data

struct LiteralEntry *literals_table

void *types_data

atom_index_t *local_atoms_to_global_table

void *module_platform_data

unsigned int end_instruction_ii

unsigned int free_literals_data

Mutex *mutex

struct ModuleFilename

Public Members

uint8_t *data

size_t len

struct ModuleFunction

Collaboration diagram for ModuleFunction:

Public Members

struct ExportedFunction base

Module *target

ModuleNativeEntryPoint entry_point

int label

union ModuleFunction

struct Monitor

Collaboration diagram for Monitor:

A regular monitor or a half link.

Public Members

struct ListHead monitor_list_head

enum ContextMonitorType monitor_type

struct Nif

Collaboration diagram for Nif:

Public Members

struct ExportedFunction base

NifImpl nif_ptr

struct PrinterFun

Public Members

printer_function_t print

struct RefcBinary

Collaboration diagram for RefcBinary:

Public Members

struct ListHead head

size_t ref_count

size_t size

struct ResourceType *resource_type

uint8_t data[]

struct RefcBinaryAVMPack

Collaboration diagram for RefcBinaryAVMPack:

Public Members

struct AVMPackData base

struct RefcBinary *refc

struct RefSignal

Collaboration diagram for RefSignal:

Public Members

MailboxMessage base

uint64_t ref_ticks

struct RegisteredProcess

Collaboration diagram for RegisteredProcess:

Public Members

struct ListHead registered_processes_list_head

int atom_index

term local_pid_or_port

struct ResourceMonitor

Collaboration diagram for ResourceMonitor:

A resource monitor.

Public Members

struct ListHead resource_list_head

struct RefcBinary *resource

uint64_t ref_ticks

int32_t process_id

struct ResourceType

Collaboration diagram for ResourceType:

A resource type.

we need a reference to the global context as enif_release_resource needs to access the synchronized list of refc_binaries

Public Members

struct ListHead head

const char *name

GlobalContext *global

struct SyncList monitors

struct SyncList serialized

ErlNifResourceDtor *dtor

ErlNifResourceStop *stop

ErlNifResourceDown *down

struct SelectEvent

Collaboration diagram for SelectEvent:

A selectable event.

Public Members

struct ListHead head

ErlNifEvent event

struct RefcBinary *resource

bool read

bool write

bool close

int32_t local_pid

uint64_t ref_ticks

Message *message

struct SnprintfFun

Collaboration diagram for SnprintfFun:

Public Members

PrinterFun base

int size

char *buf

struct SSLConfigResource

Public Members

mbedtls_ssl_config config

struct SSLContextResource

Public Members

mbedtls_ssl_context context

struct SyncList

Collaboration diagram for SyncList:

Public Members

RWLock *lock

struct ListHead head

struct TermSignal

Collaboration diagram for TermSignal:

Public Members

MailboxMessage base

term signal_term

term *heap_end

term storage[]

struct TimerList

Collaboration diagram for TimerList:

Public Members

struct ListHead head

int timers

uint64_t next_timer

struct TimerListItem

Collaboration diagram for TimerListItem:

Public Members

uint64_t expiry_time

struct ListHead head

struct UnresolvedFunctionCall

Collaboration diagram for UnresolvedFunctionCall:

Public Members

struct ExportedFunction base

atom_index_t module_atom_index

atom_index_t function_atom_index

int arity

struct ValuesHashTable

Collaboration diagram for ValuesHashTable:

Public Members

size_t capacity

size_t count

RWLock *lock

struct HNode **buckets

Enumerations

enum AtomTableCopyOpt

Values:

enumerator AtomTableNoOpts = 0

enumerator AtomTableCopyAtom = 1

enumerator AtomTableAlreadyExisting = 2

enum BitstringFlags

Values:

enumerator BigEndianInteger = 0x0

enumerator LittleEndianInteger = 0x2

enumerator SignedInteger = 0x4

enumerator NativeEndianInteger = 0x10

enumerator LittleEndianIntegerMask = LittleEndianInteger | NativeEndianInteger 

enum CharDataEncoding

Values:

enumerator Latin1Encoding

enumerator UTF8Encoding

enumerator UCS4NativeEncoding

enum ContextFlags

Values:

enumerator NoFlags = 0

enumerator WaitingTimeout = 1

enumerator WaitingTimeoutExpired = 2

enumerator Running = 4

enumerator Ready = 8

enumerator Killed = 16

enumerator Trap = 32

enumerator Distribution = 64

enumerator Spawning = 128

enum DictionaryFunctionResult

Values:

enumerator DictionaryOk

enumerator DictionaryMemoryAllocFail

enum ErlNifResourceFlags

resource flags

Values:

enumerator ERL_NIF_RT_CREATE = 1

enum ErlNifSelectFlags

enif_select mode flags

ERL_NIF_SELECT_CANCEL which was introduced with OTP-22, is unimplemented.

Values:

enumerator ERL_NIF_SELECT_READ = 1

enumerator ERL_NIF_SELECT_WRITE = 2

enumerator ERL_NIF_SELECT_STOP = 4

enum external_term_read_opts_t

Options for external term read operations.

Passed to validate and deserialize functions to control their behavior. Values are bit flags and can be combined with bitwise OR.

ExternalTermReadSafe matches the OTP safe option of binary_to_term/2: it forbids creation of new atoms (directly or embedded in pids/ports/refs/funs).

Values:

enumerator ExternalTermReadNoOpts = 0

enumerator ExternalTermReadSafe = 1

enum external_term_read_result_t

Result of an external term read operation.

Returned by validate and deserialize functions to indicate whether the operation succeeded or the input was malformed.

Values:

enumerator ExternalTermReadOk

enumerator ExternalTermReadInvalid

enum external_term_write_result_t

Result of an external term write operation.

Returned by serialize and compute-size functions to indicate whether the operation succeeded.

Values:

enumerator ExternalTermWriteOk

enum FunctionType

Values:

enumerator InvalidFunctionType = 0

enumerator NIFFunctionType = 2

enumerator UnresolvedFunctionCall = 3

enumerator ModuleFunction = 4

enumerator BIFFunctionType = 5

enumerator GCBIFFunctionType = 6

enumerator ModuleNativeFunction = 7

enum GenMessageParseResult

Values:

enumerator GenCallMessage

enumerator GenMessageParseError

enum HeapGrowthStrategy

Values:

enumerator BoundedFreeHeapGrowth = 0

enumerator MinimumHeapGrowth

enumerator FibonacciHeapGrowth

enum inet_domain

Values:

enumerator InetInvalidDomain = 0

enumerator InetDomain

enum inet_protocol

Values:

enumerator InetInvalidProtocol = 0

enumerator InetIpProtocol

enumerator InetTcpProtocol

enumerator InetUdpProtocol

enum inet_type

Values:

enumerator InetInvalidType = 0

enumerator InetStreamType

enumerator InetDgramType

enum InteropFunctionResult

Values:

enumerator InteropOk

enumerator InteropMemoryAllocFail

enumerator InteropBadArg

enum MemoryAllocMode

Values:

enumerator MEMORY_NO_SHRINK = 0

enumerator MEMORY_CAN_SHRINK = 1

enumerator MEMORY_FORCE_SHRINK = 2

enumerator MEMORY_NO_GC = 3

enum MemoryGCResult

Values:

enumerator MEMORY_GC_OK = 0

enumerator MEMORY_GC_ERROR_FAILED_ALLOCATION = 1

enumerator MEMORY_GC_DENIED_ALLOCATION = 2

enum MessageType

Values:

enumerator NormalMessage

enumerator KillSignal

enumerator GCSignal

enumerator ProcessInfoRequestSignal

enumerator TrapAnswerSignal

enumerator TrapExceptionSignal

enumerator FlushMonitorSignal

enumerator FlushInfoMonitorSignal

enumerator SetGroupLeaderSignal

enumerator MonitorSignal

enumerator UnlinkIDSignal

enumerator UnlinkIDAckSignal

enumerator UnlinkRemoteIDSignal

enumerator UnlinkRemoteIDAckSignal

enumerator LinkExitSignal

enumerator DemonitorSignal

enumerator MonitorDownSignal

enumerator CodeServerResumeSignal

enum ModuleLoadResult

Values:

enumerator MODULE_LOAD_OK = 0

enumerator MODULE_ERROR_FAILED_ALLOCATION = 1

enumerator MODULE_ERROR_INVALID = 2

enum NativeHandlerResult

Values:

enumerator NativeTerminate = 1

enumerator NativeContinue

enum OpenAVMResult

Values:

enumerator AVM_OPEN_OK = 0

enumerator AVM_OPEN_FAILED_ALLOC = 1

enumerator AVM_OPEN_INVALID = 2

enumerator AVM_OPEN_CANNOT_OPEN = 3

enumerator AVM_OPEN_CANNOT_READ = 4

enumerator AVM_OPEN_NOT_SUPPORTED = 5

enum RefcBinaryFlags

Values:

enumerator RefcNoFlags = 0

enumerator RefcBinaryIsConst = 1

enumerator RefcBinaryIsResourceManaged = 2

enum SocketErrors

Values:

enumerator SocketClosed = 0

enumerator SocketWouldBlock = -1

enumerator SocketOtherError = -2

enum TermCompareOpts

Values:

enumerator TermCompareNoOpts = 0

enumerator TermCompareExact = 1

enum TermCompareResult

Values:

enumerator TermCompareMemoryAllocFail = 0

enumerator TermEquals = 1

enumerator TermLessThan = 2

enumerator TermGreaterThan = 4

enum UnicodeConversionResult

Values:

enumerator UnicodeOk = InteropOk 

enumerator UnicodeMemoryAllocFail = InteropMemoryAllocFail 

enumerator UnicodeBadArg = InteropBadArg 

enumerator UnicodeError

enumerator UnicodeIncompleteTransform

enum UnicodeTransformDecodeResult

Values:

enumerator UnicodeTransformDecodeSuccess

enumerator UnicodeTransformDecodeFail

enumerator UnicodeTransformDecodeIncomplete