IOKit/IOLib.h Kernel.framework

FIXME(rdar://155575647): Remove deprecated `max` and `min` macros from <IOKit/IOLib.h>

#define min(a, b) _Pragma("message \"min is deprecated. Please use IOMin instead.\"")
	IOMin(a, b)

These are opaque to the user.

typedef thread_t IOThread

__attribute__((alloc_size(1)))
void * IOMallocData(vm_size_t size)

@function IOMallocData @abstract Allocates wired memory in the kernel map, from a separate section meant for pure data. @discussion Same as IOMalloc except that this function should be used for allocating pure data. @param size Size of the memory requested. @result Pointer to the allocated memory, or zero on failure.

__attribute__((alloc_size(1)))
void * IOMallocZeroData(vm_size_t size)

@function IOMallocZeroData @abstract Allocates wired memory in the kernel map, from a separate section meant for pure data bytes that don't contain pointers. @discussion Same as IOMallocData except that the memory returned is zeroed. @param size Size of the memory requested. @result Pointer to the allocated memory, or zero on failure.

__attribute__((alloc_size(1)))
void * IOMallocDataShareable(vm_size_t size)

@function IOMallocDataShareable @abstract Allocates wired memory in the kernel map, from a separate section meant for pure data that meant to be shared. @discussion Same as IOMalloc except that this function should be used for allocating pure data. @param size Size of the memory requested. @result Pointer to the allocated memory, or zero on failure.

__attribute__((alloc_size(1)))
void * IOMallocZeroDataShareable(vm_size_t size)

@function IOMallocZeroDataShareable @abstract Allocates wired memory in the kernel map, from a separate section meant for pure data bytes that don't contain pointers and meant to be shared. @discussion Same as IOMallocDataShareable except that the memory returned is zeroed. @param size Size of the memory requested. @result Pointer to the allocated memory, or zero on failure.

void IOFreeData(void * address, vm_size_t size)

@function IOFreeData @abstract Frees memory allocated with IOMallocData or IOMallocZeroData. @discussion This function frees memory allocated with IOMallocData/IOMallocZeroData, it may block and so should not be called from interrupt level or while a simple lock is held. @param address Virtual address of the allocated memory. Passing NULL here is acceptable. @param size Size of the memory allocated. It is acceptable to pass 0 size for a NULL address.

void IOFreeDataShareable(void * address, vm_size_t size)

@function IOFreeDataShareable @abstract Frees memory allocated with IOMallocDataShareable or IOMallocZeroDataShareable. @discussion This function frees memory allocated with IOMallocDataShareable/IOMallocZeroDataShareable, it may block and so should not be called from interrupt level or while a simple lock is held. @param address Virtual address of the allocated memory. Passing NULL here is acceptable. @param size Size of the memory allocated. It is acceptable to pass 0 size for a NULL address.

IONew/IONewZero/IODelete/IOSafeDeleteNULL Those functions come in 2 variants: 1. IONew(element_type, count) IONewZero(element_type, count) IODelete(ptr, element_type, count) IOSafeDeleteNULL(ptr, element_type, count) Those allocate/free arrays of `count` elements of type `element_type`. 2. IONew(hdr_type, element_type, count) IONewZero(hdr_type, element_type, count) IODelete(ptr, hdr_type, element_type, count) IOSafeDeleteNULL(ptr, hdr_type, element_type, count) Those allocate/free arrays with `count` elements of type `element_type`, prefixed with a header of type `hdr_type`, like this: Those perform safe math with the sizes, checking for overflow. An overflow in the sizes will cause the allocation to return NULL.

#define IONew(...) __IOKIT_DISPATCH(IONew, ##__VA_ARGS__)

const char *IOFindNameForValue(int value, const IONamedValue *namedValueArray)

Convert a integer constant (typically a #define or enum) to a string via an array of IONamedValue.

IOReturn IOFindValueForName(
	const char *string,
	const IONamedValue *regValueArray,
	/* RETURNED */
	int *value
)

Convert a string to an int via an array of IONamedValue. Returns kIOReturnSuccess of string found, else returns kIOReturnBadArgument.

IOAlignment IOSizeToAlignment(unsigned int size)

Convert between size and a power-of-two alignment.

IORound and IOTrunc convenience functions, in the spirit of vm's round_page() and trunc_page().

#define IORound(value, multiple) ((((value) + (multiple) - 1) / (multiple)) * (multiple))