Memory Functions
alloc	Allocate a block of memory.
realloc	Change the size of an allocated memory block.
memset	Quickly initialize a portion of a memory block.
memcpy	Quickly copy the portion of one memory block into another.
send_memory	Quickly write the contents of a memory block to a node.

alloc

Allocate a block of memory. This will request a block of memory to be allocated an initialized. If the request block cannot be allocated, an error will be generated. The size must be greater than 0 or nothing will be allocated. The result is a handle to the block of memory which can then be used to access/change/read/write the block.

Params

size	number of bytes to allocate

Returns

A memory handle if allocated or 0 if not.

realloc

Change the size of an allocated memory block. Use this to increase or decrease the size of a memory block while retaining its contents. Any new bytes added to the end will be initialized to 0, any unused bytes will be discarded.

Params

mh	existing memory block handle
size	new size in bytes

Returns

A handle to the newly sized memory block (may be different than the memory handle originally provided).

memset

Quickly initialize a portion of a memory block. Use this to assign a value to every byte in a specified range. The value will be truncated if larger than a single byte can hold. The resulting block will have every byte in the specified range set to the given value.

Params

mh	memory handle
offset	where in the block to begin writing
value	the value use in intialization
len	the number of bytes to initialize

Returns

nothing

memcpy

Quickly copy the portion of one memory block into another. Use this to copy the bytes of one memory block into another. The destination must be large enough to contain the specified range of bytes or an error will be generated.

Params

dmh	destination memory handle
doffset	offset in the destination to begin writing
smh	source memory handle
soffset	offset in the source to begin reading
len	the number of bytes to copy

Returns

nothing

send_memory

Quickly write the contents of a memory block to a node. This will use the memory block as a source of data in performing a write to node operation.

Params

node	node to write the data to
mh	memory handle to use as the source
offset	offset in the source memory to begin reading
len	number of bytes to send to the node

Returns

nothing