externalterm.c

Include dependency graph for externalterm.c:

Defines

NEW_FLOAT_EXT 70

NEW_PID_EXT 88

NEWER_REFERENCE_EXT 90

SMALL_INTEGER_EXT 97

INTEGER_EXT 98

ATOM_EXT 100

PID_EXT 103

SMALL_TUPLE_EXT 104

LARGE_TUPLE_EXT 105

NIL_EXT 106

STRING_EXT 107

LIST_EXT 108

BINARY_EXT 109

SMALL_BIG_EXT 110

EXPORT_EXT 113

MAP_EXT 116

SMALL_ATOM_UTF8_EXT 119

V4_PORT_EXT 120

INVALID_TERM_SIZE -1

NEW_FLOAT_EXT_SIZE 9

SMALL_INTEGER_EXT_SIZE 2

INTEGER_EXT_SIZE 5

SMALL_BIG_EXT_BASE_SIZE 3

ATOM_EXT_BASE_SIZE 3

STRING_EXT_BASE_SIZE 3

LIST_EXT_BASE_SIZE 5

BINARY_EXT_BASE_SIZE 5

MAP_EXT_BASE_SIZE 5

SMALL_ATOM_EXT_BASE_SIZE 2

REMOVE_SIGN(val, unsigned_type) ((val) < 0 ? ~((unsigned_type) (val)) + 1 : (unsigned_type) (val))

Functions

static term parse_external_terms(const uint8_t *external_term_buf, size_t *eterm_size, bool copy, Heap *heap, GlobalContext *glb)

static int calculate_heap_usage(const uint8_t *external_term_buf, size_t remaining, size_t *eterm_size, bool copy)

static size_t compute_external_size(term t, GlobalContext *glb)

static int externalterm_from_term(uint8_t **buf, size_t *len, term t, GlobalContext *glb)

static int serialize_term(uint8_t *buf, term t, GlobalContext *glb)

term externalterm_to_term_with_roots(const void *external_term, size_t size, Context *ctx, ExternalTermFlags flags, size_t *bytes_read, size_t num_roots, term *roots)

Create a term from external term data. This variant is meant to be used for distribution or in cases where the number of bytes read is important.

Parameters:

external_term – buffer containing external term
size – size of the external_term
ctx – current context in which terms may be stored
flags – additional flags (see above)
bytes_read – the number of bytes read off external_term in order to yield a term
num_roots – number of roots when invoking GC
roots – roots to preserve when invoking GC

Returns:

the parsed term

term externalterm_to_term(const void *external_term, size_t size, Context *ctx, ExternalTermFlags flags)

Gets a term from external term data.

Deserialize an external term from external format and returns a term.

Parameters:

external_term – the external term that will be deserialized.
size – to allocate for term.
ctx – the context that owns the memory that will be allocated.
flags – options to deserialize data. The following flags are supported:
- ExternalTermToHeapFragment : use a heap fragment to store the generated terms (default is to use the heap in the provided context). Note that when using the context heap, this function may call the GC, if there is insufficient space to store the generated terms.
- ExternalTermCopy : copy (binary and atom) data. Suitable when external_term pointer is not a const literal.

Returns:

a term.

enum ExternalTermResult externalterm_from_binary(Context *ctx, term *dst, term binary, size_t *bytes_read)

Create a term from a binary.

Deserialize a binary term that stores term data in Erlang external term format, and instantiate the serialized terms. The heap from the context will be used to allocate the instantiated terms. This function is the complement of externalterm_to_binary. WARNING: This function may call the GC, which may render the input binary invalid.

Parameters:

ctx – the context that owns the memory that will be allocated.
dst – a pointer to a term that will contain the binary encoded term.
binary – the binary.
bytes_read – the number of bytes read from the input binary.

Returns:

the term deserialized from the input term, or an invalid term, if deserialization fails.

term externalterm_to_binary(Context *ctx, term t)

Create a binary from a term.

Serialize a term in Erlang external term format, and store the result in a binary term. The heap from the context will be used to allocate the hydrated terms. This function is the complement of externalterm_to_binary. WARNING: This function may call the GC, which may render the input binary invalid.

Parameters:

ctx – the context that owns the memory that will be allocated.
t – the term to return as binary.

Returns:

the term deserialized from the input term, or an invalid term, if deserialization fails.

static uint8_t get_num_bytes(avm_uint64_t val)

static void write_bytes(uint8_t *buf, avm_uint64_t val)

static avm_uint64_t read_bytes(const uint8_t *buf, uint8_t num_bytes)

enum ExternalTermResult externalterm_compute_external_size_raw(term t, size_t *size, GlobalContext *glb)

Computes the size required for a external term (tag excluded)

This function should be called in order to calculate the required buffer size to store a serialized term in external term format. This function doesn’t prepend the external term 1 byte tag.

Parameters:

t – the term for which size is calculated
size – the required buffer size (tag excluded)
glb – the global context

Returns:

EXTERNAL_TERM_OK in case of success

enum ExternalTermResult externalterm_serialize_term_raw(void *buf, term t, GlobalContext *glb)

Serialize a term (tag excluded)

This function serializes in external term format given term, and writes it to the given buffer. This function doesn’t prepend the external term 1 byte tag.

Parameters:

buf – the buffer where the external term is written
t – the term that will be serialized
glb – the global context

Returns:

EXTERNAL_TERM_OK in case of success