avmpack.h

Include dependency graph for avmpack.h:

This graph shows which files directly or indirectly include avmpack.h:

AVM Pack file format parsing function.

Defines

END_OF_FILE 0

BEAM_START_FLAG 1

BEAM_CODE_FLAG 2

END_OF_FILE_MASK 255

Typedefs

typedef void *(*avmpack_fold_fun)(void *accum, const void *section_ptr, uint32_t section_size, const void *beam_ptr, uint32_t flags, const char *section_name)

callback function for AVMPack section fold.

Instances of this function are supplied to the avmpack_fold function, in order to provide a callback mechanism for folding over the contents of the AVM binary.

Param accum:

The accumulator supplied by the application.

Param section_ptr:

a pointer to the start of the AVM section (including the module header).

Param section_size:

the size of the entire section (including the module header).

Param beam_ptr:

the start of the beam module portion of the section. This pointers starts immediately after the (aligned) header.

Param flags:

the section flags, as defined in the module header.

Param section_name:

the section name, as defined in the module header.

Return:

an accumulator, which will be supplied to the next call to this function, and eventually returned from the avmpack_fold function.

Functions

static inline void avmpack_data_init(struct AVMPackData *avm_pack_data, const struct AVMPackInfo *info, uint32_t size)

static inline void avmpack_data_destroy(struct AVMPackData *avm_pack_data, GlobalContext *global)

int avmpack_find_section_by_flag(const void *avmpack_binary, uint32_t avmpack_size, uint32_t flags_mask, uint32_t flags_value, const void **ptr, uint32_t *size, const char **name)

Finds an AVM Pack section that has certain flags set.

Finds an AVM Pack section that has certain flags set and returns a pointer to it, its size and its name. The scan is bounded by avmpack_size.

Parameters:

• avmpack_binary – a pointer to valid AVM Pack file data.

• avmpack_size – the size in bytes of the AVM Pack.

• flags_mask – that will be matched against file sections.

• flags_value – that will be matched against file sections.

• ptr – [out] will point to the found file section.

• size – [out] the payload size at ptr, without the section header and the padded name; not updated if the section has not been found.

• name – [out] the section name, as defined in the module header.

Returns:

1 if the file section has been found, 0 otherwise.

int avmpack_find_section_by_name(const void *avmpack_binary, uint32_t avmpack_size, const char *name, const void **ptr, uint32_t *size)

Finds an AVM Pack section that has certain name.

Finds an AVM Pack section with a certain name and returns a pointer to it and its size. The scan is bounded by avmpack_size.

Parameters:

• avmpack_binary – a pointer to valid AVM Pack file data.

• avmpack_size – the size in bytes of the AVM Pack.

• name – the file section name that will be searched.

• ptr – [out] will point to the found file section; not updated if the section has not been found.

• size – [out] the payload size at ptr, without the section header and the padded name; not updated if the section has not been found.

Returns:

1 if the file section has been found, 0 otherwise.

bool avmpack_is_valid(const void *avmpack_binary, uint32_t size)

Returns true if the pointed binary starts with a valid AVM Pack header.

Checks the 24-byte magic header only; see avmpack_is_complete and avmpack_compute_size for truncation.

Parameters:

• avmpack_binary – a pointer to an AVM Pack binary.

• size – the size of AVM Pack binary.

Returns:

true if it is a valid AVM Pack binary, false otherwise.

bool avmpack_is_complete(const void *avmpack_binary, size_t exact_size)

Returns true if an AVM Pack of exactly known size ends with its end terminator.

Reads the header and the last 16 bytes only, so a memory-mapped pack stays lazily paged. Trailing bytes after the terminator and sizes above UINT32_MAX are rejected.

Parameters:

• avmpack_binary – a pointer to an AVM Pack binary.

• exact_size – the exact size in bytes of the AVM Pack.

Returns:

true if the pack is complete, false otherwise.

bool avmpack_compute_size(const void *avmpack_binary, uint32_t max_size, uint32_t *real_size)

Finds the end of an AVM Pack within a region and returns its real size.

Walks the section chain, validating every header, until the end terminator or max_size is reached.

Parameters:

• avmpack_binary – a pointer to an AVM Pack binary.

• max_size – the size in bytes of the region containing the AVM Pack.

• real_size – [out] set to the size in bytes of the AVM Pack on success.

Returns:

true if the terminator was found within max_size, false otherwise.

void *avmpack_fold(void *accum, const void *avmpack_binary, uint32_t avmpack_size, avmpack_fold_fun fold_fun)

Fold over all the sections in an AVM Pack.

This function will call the callback on each section of the AVM Pack, passing in the current section of each module in the AVM binary to the supplied fold function. The scan is bounded by avmpack_size and stops on the terminator or on the first invalid section header.

Parameters:

• accum – The accumulator supplied by the application.

• avmpack_binary – a pointer to an AVM Pack binary.

• avmpack_size – the size in bytes of the AVM Pack.

• fold_fun – function that will be called for each AVM section.

Variables

const struct AVMPackInfo in_memory_avm_pack_info

const struct AVMPackInfo const_avm_pack_info

struct AVMPackInfo

#include <avmpack.h>

Public Members

void (*destructor)(struct AVMPackData *obj, GlobalContext *global)

struct AVMPackData

#include <avmpack.h>

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

uint32_t size

struct InMemoryAVMPack

#include <avmpack.h>

Collaboration diagram for InMemoryAVMPack:

Public Members

struct AVMPackData base

struct ConstAVMPack

#include <avmpack.h>

Collaboration diagram for ConstAVMPack:

Public Members

struct AVMPackData base