Allocating and freeing memory (alloc.h)

Support

Support for KasperskyOS

KasperskyOS Community Edition

KasperskyOS API

libkos library

Allocating and freeing memory (alloc.h)

May 21, 2024

ID libkos_alloc_api

Get as PDF

The API is defined in the header file sysroot-*-kos/include/kos/alloc.h from the KasperskyOS SDK.

The API is intended for allocating and freeing memory. Allocated memory is a committed virtual memory region that can be accessed for read-and-write operations.

Information about API functions is provided in the table below.

alloc.h functions

Function	Information about the function
`KosMemAllocEx()`	Purpose Allocates memory. Parameters [in] `size` – size (in bytes) of the allocated memory. [in] `align` – value defining the alignment of the allocated memory. It must be a power of two. The address of allocated memory can be unaligned (align=1) or aligned (align=2,4,...,2^N) to the boundary of a 2^N-byte sequence (for example, two-byte or four-byte). When an address is aligned, the size of the allocated memory may be rounded up to the nearest multiple of 2^N. [in] `zeroed` – value defining the initialization of the allocated memory (`1` – initialize with zeros, `0` – do not initialize). Returned values If successful, the function returns the pointer to the allocated memory, otherwise it returns `RTL_NULL`.
`KosMemAlloc()`	Purpose Allocates memory. Parameters [in] `size` – size (in bytes) of the allocated memory. Returned values If successful, the function returns the pointer to the allocated memory, otherwise it returns `RTL_NULL`.
`KosMemZalloc()`	Purpose Allocates memory and initializes it with zeros. Parameters [in] `size` – size (in bytes) of the allocated memory. Returned values If successful, the function returns the pointer to the allocated memory, otherwise it returns `RTL_NULL`.
`KosMemFree()`	Purpose Deallocates memory. Parameters [in] `ptr` – pointer to the freed memory. Returned values N/A
`KosMemGetSize()`	Purpose Gets the actual size of allocated memory. The actual size of allocated memory exceeds the requested size because it includes the size of service data and also may be increased due to alignment when the `KosMemAllocEx()` function is called. Parameters [in] `ptr` – pointer to the allocated memory. Returned values Actual size of allocated memory (in bytes).
`KosMemGetOrigSize()`	Purpose Gets the size of memory that was requested when it is allocated. The actual size of allocated memory exceeds the requested size because it includes the size of service data and also may be increased due to alignment when the `KosMemAllocEx()` function is called. Parameters [in] `ptr` – pointer to the allocated memory. Returned values Size (in bytes) of memory that was requested when it is allocated.

Did you find this article helpful?

What can we do better?

Thank you for your feedback! You're helping us improve.