bitstring.h

Include dependency graph for bitstring.h:

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

Defines

READ_16LE_UNALIGNED(ptr)     ((((uint8_t *) (ptr))[1] << 8) | ((uint8_t *) (ptr))[0])

WRITE_16LE_UNALIGNED(ptr, val)

do {                                                         \

((uint8_t *) (ptr))[0] = ((uint16_t) val) & 0xff;        \

((uint8_t *) (ptr))[1] = (((uint16_t) val) >> 8) & 0xff; \

} while (0)

READ_32LE_UNALIGNED(ptr)     ((((uint8_t *) (ptr))[3] << 24) | (((uint8_t *) (ptr))[2] << 16) | (((uint8_t *) (ptr))[1] << 8) | ((uint8_t *) (ptr))[0])

WRITE_32LE_UNALIGNED(ptr, val)

do {                                                          \

((uint8_t *) (ptr))[0] = ((uint32_t) val) & 0xff;         \

((uint8_t *) (ptr))[1] = (((uint32_t) val) >> 8) & 0xff;  \

((uint8_t *) (ptr))[2] = (((uint32_t) val) >> 16) & 0xff; \

((uint8_t *) (ptr))[3] = (((uint32_t) val) >> 24) & 0xff; \

} while (0)

READ_64LE_UNALIGNED(ptr)     ((((uint64_t) ((uint8_t *) (ptr))[7]) << 56) | (((uint64_t) ((uint8_t *) (ptr))[6]) << 48) | (((uint64_t) ((uint8_t *) (ptr))[5]) << 40) | (((uint64_t) ((uint8_t *) (ptr))[4]) << 32) | (((uint64_t) ((uint8_t *) (ptr))[3]) << 24) | (((uint64_t) ((uint8_t *) (ptr))[2]) << 16) | (((uint64_t) ((uint8_t *) (ptr))[1]) << 8) | (((uint64_t) ((uint8_t *) (ptr))[0])))

WRITE_64LE_UNALIGNED(ptr, val)

do {                                                          \

((uint8_t *) (ptr))[0] = ((uint64_t) val) & 0xff;         \

((uint8_t *) (ptr))[1] = (((uint64_t) val) >> 8) & 0xff;  \

((uint8_t *) (ptr))[2] = (((uint64_t) val) >> 16) & 0xff; \

((uint8_t *) (ptr))[3] = (((uint64_t) val) >> 24) & 0xff; \

((uint8_t *) (ptr))[4] = (((uint64_t) val) >> 32) & 0xff; \

((uint8_t *) (ptr))[5] = (((uint64_t) val) >> 40) & 0xff; \

((uint8_t *) (ptr))[6] = (((uint64_t) val) >> 48) & 0xff; \

((uint8_t *) (ptr))[7] = (((uint64_t) val) >> 56) & 0xff; \

} while (0)

Enums

enum BitstringFlags

Values:

enumerator BigEndianInteger = 0x0

enumerator LittleEndianInteger = 0x2

enumerator SignedInteger = 0x4

enumerator NativeEndianInteger = 0x10

enumerator LittleEndianIntegerMask = LittleEndianInteger | NativeEndianInteger

Functions

bool bitstring_extract_any_integer(const uint8_t *src, size_t offset, avm_int_t n, enum BitstringFlags bs_flags, union maybe_unsigned_int64 *dst)

bool bitstring_insert_any_integer(uint8_t *dst, avm_int_t offset, avm_int64_t value, size_t n, enum BitstringFlags bs_flags)

static inline bool bitstring_extract_integer(term src_bin, size_t offset, avm_int_t n, enum BitstringFlags bs_flags, union maybe_unsigned_int64 *dst)

static inline bool bitstring_insert_integer(term dst_bin, size_t offset, avm_int64_t value, size_t n, enum BitstringFlags bs_flags)

bool bitstring_extract_bigint_bytes(term src_bin, size_t offset, size_t n, enum BitstringFlags bs_flags, uint8_t out[256 / 8], size_t *out_size)

Extract an integer field of up to 256 bits as whole bytes for intn_from_integer_bytes, sign-extended if signed.

Parameters:

• src_bin – binary to extract from

• offset – offset, in bits, to where the field starts

• n – size of the field, in bits

• bs_flags – flags to decode the integer (little/big/native, signed)

• out – the bytes of the integer, on output

• out_size – the number of bytes written to out, on output

Returns:

true if the field was extracted, false if it is too large or out of bounds

bool bitstring_insert_bigint(term dst_bin, size_t offset, const intn_digit_t big_value[], size_t big_len, intn_integer_sign_t big_sign, size_t n, enum BitstringFlags bs_flags)

Insert a big integer, truncated or sign-extended to n bits.

Parameters:

• dst_bin – binary to insert to

• offset – offset, in bits, to where to insert the integer

• big_value – digits of the big integer

• big_len – number of digits

• big_sign – sign of the big integer

• n – size of the field, in bits

• bs_flags – flags to encode the integer (little/big/native)

Returns:

true if the field was written, false if it does not fit in dst_bin

bool bitstring_utf8_encode(uint32_t c, uint8_t *buf, size_t *out_size)

Encode a character to UTF-8.

Parameters:

• c – character to encode

• buf – the buffer to encode the sring to or NULL to only compute the size.

• out_size – the size in bytes, on output (if not NULL)

Returns:

true if encoding was successful, false if c is not a valid unicode character

bool bitstring_utf16_encode(uint32_t c, uint8_t *buf, enum BitstringFlags bs_flags, size_t *out_size)

Encode a character to UTF-16.

Parameters:

• c – character to encode

• buf – the buffer to encode the character to or NULL to only compute the size.

• bs_flags – flags to encode the character (undefined/little/big/native)

• out_size – the size in bytes, on output (if not NULL)

Returns:

true if encoding was successful, false if c is not a valid unicode character

bool bitstring_utf16_decode(const uint8_t *buf, size_t len, int32_t *c, size_t *out_size, enum BitstringFlags bs_flags)

Decode a character from UTF-16.

Parameters:

• c – int value to decode to

• buf – the buffer froom which to decode the sring to or NULL to only compute the size.

• len – the length (in bytes) of the bytes in buf

• bs_flags – flags to decode the character (undefined/little/big/native)

• out_size – the size in bytes, on output (if not NULL)

Returns:

true if decoding was successful, false if character starting at buf is not a valid unicode character

bool bitstring_utf32_encode(uint32_t c, uint8_t *buf, enum BitstringFlags bs_flags)

Encode a character to UTF-32.

Parameters:

• c – character to encode

• buf – the buffer to encode the character

• bs_flags – flags to encode the character (undefined/little/big/native)

Returns:

true if encoding was successful, false if c is not a valid unicode character

bool bitstring_utf32_decode(const uint8_t *buf, size_t len, int32_t *c, enum BitstringFlags bs_flags)

Decode a character from UTF-32.

Parameters:

• c – int value to decode to

• buf – the buffer froom which to decode the sring to or NULL to only compute the size.

• len – the length (in bytes) of the bytes in buf

• bs_flags – flags to decode the character (undefined/little/big/native)

Returns:

true if decoding was successful, false if character starting at buf is not a valid unicode character

static inline bool bitstring_utf8_size(uint32_t c, size_t *out_size)

Compute the size of a character when UTF-8 encoded.

Parameters:

• c – character to encode

• out_size – the size in bytes, on output

Returns:

true if encoding was successful, false if c is not a valid unicode character

static inline bool bitstring_utf16_size(uint32_t c, size_t *out_size)

Compute the size of a unicode character when UTF-16 encoded.

Parameters:

• c – character to encode

• out_size – the size in bytes, on output

Returns:

true if encoding was successful, false if c is not a valid unicode character

bool bitstring_insert_utf8(term dst_bin, size_t offset, uint32_t c, size_t *out_size)

Insert a character in UTF-8 format.

Parameters:

• dst_bin – binary to insert to

• offset – offset, in bits, to where to insert the character

• c – character to encode

• out_size – the size in bytes, on output

Returns:

true if encoding was successful, false if c is not a valid unicode character

bool bitstring_match_utf8(term src_bin, size_t offset, uint32_t *c, size_t *out_size)

Match a character in UTF-8 format.

Parameters:

• src_bin – binary to match against

• offset – offset, in bits, to where to start to match the character

• c – int to decode to

• out_size – the size in bytes, on output

Returns:

true if encoding was successful, false if src_bin at offset is not a valid unicode character

bool bitstring_insert_utf16(term dst_bin, size_t offset, uint32_t c, enum BitstringFlags bs_flags, size_t *out_size)

Insert a character in UTF-&§ format.

Parameters:

• dst_bin – binary to insert to

• offset – offset, in bits, to where to insert the character

• c – character to encode

• bs_flags – flags to encode the character (undefined/little/big/native)

• out_size – the size in bytes, on output

Returns:

true if encoding was successful, false if c is not a valid unicode character

bool bitstring_match_utf16(term src_bin, size_t offset, int32_t *c, size_t *out_size, enum BitstringFlags bs_flags)

Match a character in UTF-16 format.

Parameters:

• src_bin – binary to match against

• offset – offset, in bits, to where to start to match the character

• c – int to decode to

• bs_flags – flags to decode the character (undefined/little/big/native)

• out_size – the size in bytes, on output

Returns:

true if encoding was successful, false if src_bin at offset is not a valid unicode character

bool bitstring_insert_utf32(term dst_bin, size_t offset, uint32_t c, enum BitstringFlags bs_flags)

Insert a character in UTF-32 format.

Parameters:

• dst_bin – binary to insert to

• offset – offset, in bits, to where to insert the character

• c – character to encode

• bs_flags – flags to encode the character (undefined/little/big/native)

Returns:

true if encoding was successful, false if c is not a valid unicode character

bool bitstring_match_utf32(term src_bin, size_t offset, int32_t *c, enum BitstringFlags bs_flags)

Match a character in UTF-32 format.

Parameters:

• src_bin – binary to match against

• offset – offset, in bits, to where to start to match the character

• c – int to decode to

• bs_flags – flags to decode the character (undefined/little/big/native)

Returns:

true if encoding was successful, false if src_bin at offset is not a valid unicode character

void bitstring_copy_bits_incomplete_bytes(uint8_t *dst, size_t bits_offset, const uint8_t *src, size_t bits_count)

Copy bits_count bits from src to dst[bits_offset..].

Called by bitstring_copy_bits when bytes are not complete.

Parameters:

• dst – destination buffer

• bits_offset – offset in bits in destination buffer

• src – source buffer

• bits_count – number of bits

void bitstring_copy_bits_from(uint8_t *dst, const uint8_t *src, size_t src_offset, size_t bits_count)

Copy bits_count bits starting at bit src_offset of src into dst[0..].

Used to materialize a non-byte-aligned bitstring slice (e.g. a matched tail whose start is not a byte boundary) into a fresh byte-aligned buffer. The destination must be pre-zeroed; only set bits are written.

Parameters:

• dst – destination buffer (pre-zeroed), receiving bits at offset 0

• src – source buffer

• src_offset – offset in bits in the source buffer

• bits_count – number of bits to copy

static inline void bitstring_copy_bits(uint8_t *dst, size_t bits_offset, const uint8_t *src, size_t bits_count)

Copy bits_count bits from src to dst[bits_offset..].

Parameters:

• dst – destination buffer

• bits_offset – offset in bits in destination buffer

• src – source buffer

• bits_count – number of bits

bool bitstring_extract_f16(term src_bin, size_t offset, avm_int_t n, enum BitstringFlags bs_flags, avm_float_t *dst)

bool bitstring_extract_f32(term src_bin, size_t offset, avm_int_t n, enum BitstringFlags bs_flags, avm_float_t *dst)

bool bitstring_extract_f64(term src_bin, size_t offset, avm_int_t n, enum BitstringFlags bs_flags, avm_float_t *dst)

intn_from_integer_options_t bitstring_flags_to_intn_opts(enum BitstringFlags bf)

bool bitstring_insert_f16(term dst_bin, size_t offset, avm_float_t value, enum BitstringFlags bs_flags)

bool bitstring_insert_f32(term dst_bin, size_t offset, avm_float_t value, enum BitstringFlags bs_flags)

bool bitstring_insert_f64(term dst_bin, size_t offset, avm_float_t value, enum BitstringFlags bs_flags)

size_t bitstring_slice_heap_size(term bs_bin, size_t offset, size_t len_bits)

Heap words needed to extract a len_bits slice at bit offset offset.

Worst case: a byte-aligned offset and length shares storage via a sub-binary; otherwise the bits are copied into a fresh (possibly bitstring) binary. Pair with bitstring_slice.

term bitstring_slice(term bs_bin, size_t offset, size_t len_bits, Heap *heap, GlobalContext *glb)

Extract a len_bits slice of bs_bin starting at bit offset offset.

Byte-aligned offset+length shares storage via a sub-binary; a non-byte-aligned offset or length copies the bits into a fresh bitstring. Heap must already be reserved (see bitstring_slice_heap_size).

Returns:

the extracted slice, or term_invalid_term() if a refc binary buffer could not be allocated for a copied slice.

static inline size_t bitstring_get_tail_heap_size(term bs_bin, size_t bs_offset)

Heap words needed to extract the tail of a match at bit offset bs_offset.

Worst case: a byte-aligned start and length shares storage via a sub-binary; otherwise the remaining bits are copied into a fresh (possibly bitstring) binary. Pair with bitstring_get_tail.

static inline term bitstring_get_tail(term bs_bin, size_t bs_offset, Heap *heap, GlobalContext *glb)

Materialize the tail of a match at bit offset bs_offset.

Byte-aligned start+length shares storage via a sub-binary; a non-byte-aligned start or length copies the remaining bits into a fresh bitstring. Heap must already be reserved (see bitstring_get_tail_heap_size).

Returns:

the tail, or term_invalid_term() if a refc binary buffer could not be allocated for a copied tail.

union maybe_unsigned_int8

#include <bitstring.h>

Public Members

uint8_t u

int8_t s

union maybe_unsigned_int16

#include <bitstring.h>

Public Members

uint16_t u

int16_t s

union maybe_unsigned_int32

#include <bitstring.h>

Public Members

uint32_t u

int32_t s

union maybe_unsigned_int64

#include <bitstring.h>

Public Members

uint64_t u

int64_t s