bson_aligned_alloc(3)

bson_aligned_alloc()

Section 3 libbson-doc bookworm source

Description

bson_aligned_alloc - bson_aligned_alloc()

void *
bson_aligned_alloc (size_t alignment, size_t num_bytes);

	•		alignment: The alignment of the allocated bytes of memory. Must be a power of 2 and a multiple of *sizeof (void )**.
	•		num_bytes: The number of bytes to allocate. Must be a multiple of alignment.

This is a portable aligned_alloc() wrapper.

In general, this function will return an allocation at least sizeof(void*) bytes or bigger with an alignment of at least alignment.

If there was a failure to allocate num_bytes bytes aligned to alignment, the process will be aborted.

WARNING:

This function will abort on failure to allocate memory.

A pointer to a memory region which HAS NOT been zeroed.

MongoDB, Inc

2017-present, MongoDB, Inc