hel.h File Reference

#include <stddef.h>
#include <string.h>
#include <stdint.h>
#include "hel-types.h"

Go to the source code of this file.

Classes
struct	HelRegisterInfo
	Register-related information returned by helQueryRegisterInfo. More...
struct	HelQueue
	In-memory kernel/user-space queue. More...
struct	HelElement
	A single element of a HelQueue. More...

Functions
Logging
HEL_C_LINKAGE HelError	helLog (const char *string, size_t length)
	Writes a text message (e.g., a line of text) to the kernel's log. More...
HEL_C_LINKAGE void	helPanic (const char *string, size_t length) __attribute__((noreturn))
	Kills the current thread and writes an error message to the kernel's log. More...
Debugging
HEL_C_LINKAGE HelError	helNop ()
	Does nothing (useful only for profiling).
HEL_C_LINKAGE HelError	helSubmitAsyncNop (HelHandle queueHandle, uintptr_t context)
	Does nothing, asynchronously (useful only for profiling). More...
Management of Descriptors and Universes
HEL_C_LINKAGE HelError	helCreateUniverse (HelHandle *handle)
	Creates a new universe descriptor. More...
HEL_C_LINKAGE HelError	helTransferDescriptor (HelHandle handle, HelHandle universeHandle, HelHandle *outHandle)
	Copies descriptors from the current universe to another universe. More...
HEL_C_LINKAGE HelError	helDescriptorInfo (HelHandle handle, struct HelDescriptorInfo *info)
HEL_C_LINKAGE HelError	helGetCredentials (HelHandle handle, uint32_t flags, char *credentials)
	Returns the credentials associated with a given descriptor. More...
HEL_C_LINKAGE HelError	helCloseDescriptor (HelHandle universeHandle, HelHandle handle)
	Closes a descriptor. More...
Management of IPC Queues
HEL_C_LINKAGE HelError	helCreateQueue (struct HelQueueParameters *params, HelHandle *handle)
	Creates an IPC queue.
HEL_C_LINKAGE HelError	helCancelAsync (HelHandle queueHandle, uint64_t asyncId)
	Cancels an ongoing asynchronous operation. More...
Memory Management
HEL_C_LINKAGE HelError	helAllocateMemory (size_t size, uint32_t flags, struct HelAllocRestrictions *restrictions, HelHandle *handle)
	Creates a memory object consisting of unmanaged RAM. More...
HEL_C_LINKAGE HelError	helResizeMemory (HelHandle handle, size_t newSize)
	Resizes a memory object. More...
HEL_C_LINKAGE HelError	helCreateManagedMemory (size_t size, uint32_t flags, HelHandle *backingHandle, HelHandle *frontalHandle)
	Creates a memory object that is managed by userspace. More...
HEL_C_LINKAGE HelError	helCopyOnWrite (HelHandle memory, uintptr_t offset, size_t size, HelHandle *handle)
	Creates memory object that obtains its memory by copy-on-write from another memory object. More...
HEL_C_LINKAGE HelError	helAccessPhysical (uintptr_t physical, size_t size, HelHandle *handle)
HEL_C_LINKAGE HelError	helCreateIndirectMemory (size_t numSlots, HelHandle *handle)
	Creates a memory object that obtains its memory by delegating to other memory objects. More...
HEL_C_LINKAGE HelError	helAlterMemoryIndirection (HelHandle indirectHandle, size_t slotIndex, HelHandle memoryHandle, uintptr_t offset, size_t size)
	Modifies indirect memory objects. More...
HEL_C_LINKAGE HelError	helCreateSliceView (HelHandle bundle, uintptr_t offset, size_t size, uint32_t flags, HelHandle *handle)
HEL_C_LINKAGE HelError	helForkMemory (HelHandle handle, HelHandle *forkedHandle)
	Forks memory objects, i.e., copies them using copy-on-write. More...
HEL_C_LINKAGE HelError	helCreateSpace (HelHandle *handle)
	Creates a virtual address space that threads can run in. More...
HEL_C_LINKAGE HelError	helMapMemory (HelHandle memoryHandle, HelHandle spaceHandle, void *pointer, uintptr_t offset, size_t size, uint32_t flags, void **actualPointer)
	Maps memory objects into an address space. More...
HEL_C_LINKAGE HelError	helSubmitProtectMemory (HelHandle spaceHandle, void *pointer, size_t size, uint32_t flags, HelHandle queueHandle, uintptr_t context)
	Changes protection attributes of a memory mapping. More...
HEL_C_LINKAGE HelError	helSubmitSynchronizeSpace (HelHandle spaceHandle, void *pointer, size_t size, HelHandle queueHandle, uintptr_t context)
	Notifies the kernel of dirty pages in a memory mapping. More...
HEL_C_LINKAGE HelError	helUnmapMemory (HelHandle spaceHandle, void *pointer, size_t size)
	Unmaps memory from an address space. More...
HEL_C_LINKAGE HelError	helPointerPhysical (const void *pointer, uintptr_t *physical)
HEL_C_LINKAGE HelError	helSubmitReadMemory (HelHandle handle, uintptr_t address, size_t length, void *buffer, HelHandle queue, uintptr_t context)
	Load memory (i.e., bytes) from a descriptor. More...
HEL_C_LINKAGE HelError	helSubmitWriteMemory (HelHandle handle, uintptr_t address, size_t length, const void *buffer, HelHandle queue, uintptr_t context)
	Store memory (i.e., bytes) to a descriptor. More...
HEL_C_LINKAGE HelError	helMemoryInfo (HelHandle handle, size_t *size)
HEL_C_LINKAGE HelError	helSubmitManageMemory (HelHandle handle, HelHandle queue, uintptr_t context)
HEL_C_LINKAGE HelError	helUpdateMemory (HelHandle handle, int type, uintptr_t offset, size_t length)
HEL_C_LINKAGE HelError	helSubmitLockMemoryView (HelHandle handle, uintptr_t offset, size_t size, HelHandle queue, uintptr_t context)
HEL_C_LINKAGE HelError	helLoadahead (HelHandle handle, uintptr_t offset, size_t length)
	Notifies the kernel that a certain range of memory should be preloaded. More...
HEL_C_LINKAGE HelError	helCreateVirtualizedSpace (HelHandle *handle)
Thread Management
HEL_C_LINKAGE HelError	helCreateThread (HelHandle universe, HelHandle spaceHandle, HelAbi abi, void *ip, void *sp, uint32_t flags, HelHandle *handle)
	Create a new thread. More...
HEL_C_LINKAGE HelError	helQueryThreadStats (HelHandle handle, struct HelThreadStats *stats)
	Query run-time statistics of a thread. More...
HEL_C_LINKAGE HelError	helSetPriority (HelHandle handle, int priority)
	Set the priority of a thread. More...
HEL_C_LINKAGE HelError	helYield ()
	Yields the current thread.
HEL_C_LINKAGE HelError	helSubmitObserve (HelHandle handle, uint64_t sequence, HelHandle queue, uintptr_t context)
	Observe whether a thread changes its state. More...
HEL_C_LINKAGE HelError	helKillThread (HelHandle handle)
	Kill (i.e., terminate) a thread. More...
HEL_C_LINKAGE HelError	helInterruptThread (HelHandle handle)
	Interrupt a thread. More...
HEL_C_LINKAGE HelError	helResume (HelHandle handle)
	Resume a suspended thread. More...
HEL_C_LINKAGE HelError	helLoadRegisters (HelHandle handle, int set, void *image)
	Load a register image (e.g., from a thread). More...
HEL_C_LINKAGE HelError	helStoreRegisters (HelHandle handle, int set, const void *image)
	Store a register image (e.g., to a thread). More...
HEL_C_LINKAGE HelError	helQueryRegisterInfo (int set, struct HelRegisterInfo *info)
	Query register-related information. More...
HEL_C_LINKAGE HelError	helWriteFsBase (void *pointer)
HEL_C_LINKAGE HelError	helReadFsBase (void **pointer)
HEL_C_LINKAGE HelError	helWriteGsBase (void *pointer)
HEL_C_LINKAGE HelError	helReadGsBase (void **pointer)
HEL_C_LINKAGE HelError	helGetCurrentCpu (int *cpu)
	Gets the index of the cpu which the calling thread is running on.
HEL_C_LINKAGE HelError	helGetClock (uint64_t *counter)
	Read the system-wide monotone clock. More...
HEL_C_LINKAGE HelError	helSubmitAwaitClock (uint64_t counter, HelHandle queue, uintptr_t context, uint64_t *asyncId)
	Wait until time passes. More...
HEL_C_LINKAGE HelError	helCreateVirtualizedCpu (HelHandle handle, HelHandle *out_handle)
HEL_C_LINKAGE HelError	helRunVirtualizedCpu (HelHandle handle, struct HelVmexitReason *reason)
HEL_C_LINKAGE HelError	helGetRandomBytes (void *buffer, size_t wantedSize, size_t *actualSize)
HEL_C_LINKAGE HelError	helGetAffinity (HelHandle handle, uint8_t *mask, size_t size, size_t *actualSize)
	Get a thread's CPU affinity mask. More...
HEL_C_LINKAGE HelError	helSetAffinity (HelHandle handle, uint8_t *mask, size_t size)
	Set a thread's CPU affinity mask. More...
Message Passing
HEL_C_LINKAGE HelError	helCreateStream (HelHandle *lane1, HelHandle *lane2)
	Create a stream (which always consists of two lanes). More...
HEL_C_LINKAGE HelError	helSubmitAsync (HelHandle handle, const struct HelAction *actions, size_t count, HelHandle queue, uintptr_t context, uint32_t flags)
	Pass messages on a stream. More...
HEL_C_LINKAGE HelError	helShutdownLane (HelHandle handle)
HEL_C_LINKAGE HelError	helCreateToken (HelHandle *handle)
	Create a token object. More...
Inter-Thread Synchronization
HEL_C_LINKAGE HelError	helFutexWait (int *pointer, int expected, int64_t deadline)
	Waits on a futex. More...
HEL_C_LINKAGE HelError	helFutexWake (int *pointer)
	Wakes up all waiters of a futex. More...
Event Handling
HEL_C_LINKAGE HelError	helCreateOneshotEvent (HelHandle *handle)
	Create an event that fires at most once. More...
HEL_C_LINKAGE HelError	helCreateBitsetEvent (HelHandle *handle)
	Create an event consisting of multiple bits that can fire independently. More...
HEL_C_LINKAGE HelError	helRaiseEvent (HelHandle handle)
	Raise an event. More...
HEL_C_LINKAGE HelError	helAccessIrq (int number, HelHandle *handle)
HEL_C_LINKAGE HelError	helAcknowledgeIrq (HelHandle handle, uint32_t flags, uint64_t sequence)
HEL_C_LINKAGE HelError	helSubmitAwaitEvent (HelHandle handle, uint64_t sequence, HelHandle queue, uintptr_t context)
	Wait for an event. More...
HEL_C_LINKAGE HelError	helAutomateIrq (HelHandle handle, uint32_t flags, HelHandle kernlet)
Input/Output
HEL_C_LINKAGE HelError	helAccessIo (uintptr_t *port_array, size_t num_ports, HelHandle *handle)
HEL_C_LINKAGE HelError	helEnableIo (HelHandle handle)
	Enable userspace access to hardware I/O resources. More...
HEL_C_LINKAGE HelError	helEnableFullIo ()
Kernlet Management
HEL_C_LINKAGE HelError	helBindKernlet (HelHandle handle, const union HelKernletData *data, size_t numData, HelHandle *boundHandle)
	Bind parameters to a kernlet. More...

Variables
static const int	kHelHeadMask = 0xFFFFFF
	Mask to extract the current queue head.
static const int	kHelHeadWaiters = (1 << 24)
	Can be set by the kernel to request a FutexWake on update.
static const int	kHelProgressMask = 0xFFFFFF
	Mask to extract the number of valid bytes in the chunk.
static const int	kHelProgressWaiters = (1 << 24)
	Can be set by userspace to request a FutexWake on update.
static const int	kHelProgressDone = (1 << 25)
	Set by the kernel once it retires the chunk.

Function Documentation

helAllocateMemory()

HEL_C_LINKAGE HelError helAllocateMemory	(	size_t	size,
		uint32_t	flags,
		struct HelAllocRestrictions *	restrictions,
		HelHandle *	handle
	)

Creates a memory object consisting of unmanaged RAM.

Parameters

[in]	size	Size of the memory object in bytes. Must be aligned to the system's page size.
[in]	restrictions	Specifies restrictions for the kernel's memory allocator. May be NULL if there are no restrictions.
[out]	handle	Handle to the new memory object.

helAlterMemoryIndirection()

HEL_C_LINKAGE HelError helAlterMemoryIndirection	(	HelHandle	indirectHandle,
		size_t	slotIndex,
		HelHandle	memoryHandle,
		uintptr_t	offset,
		size_t	size
	)

Modifies indirect memory objects.

Parameters

[in]	indirectHandle	Handle to the indirect memory object to be modified. Must refer to a memory object created by helCreateIndirectMemory.
[in]	slotIndex	Index of the slot to be modified. Must be a non-negative integer smaller than numSlots (see helCreateIndirectMemory).
[in]	memoryHandle	Handle to the memory object that indirectHandle should delegate to.
[in]	offset	Offset in bytes, relative to memoryHandle. Must be aligned to the system's page size.
[in]	size	Size of the indirection in bytes. Must be aligned to the system's page size.

helBindKernlet()

HEL_C_LINKAGE HelError helBindKernlet	(	HelHandle	handle,
		const union HelKernletData *	data,
		size_t	numData,
		HelHandle *	boundHandle
	)

Bind parameters to a kernlet.

Parameters

[in]	handle	Handle to the unbound kernlet.
[in]	data	Pointer to an array of binding parameters.
[in]	numData	Number of binding parameters in data.
[out]	boundHandle	Handle to the bound kernlet.

helCancelAsync()

HEL_C_LINKAGE HelError helCancelAsync	(	HelHandle	queueHandle,
		uint64_t	asyncId
	)

Cancels an ongoing asynchronous operation.

Parameters

[in]	queueHandle	Handle to the queue that the operation was submitted to.
[in]	asyncId	ID identifying the operation.

helCloseDescriptor()

HEL_C_LINKAGE HelError helCloseDescriptor	(	HelHandle	universeHandle,
		HelHandle	handle
	)

Closes a descriptor.

Parameters

[in]	universeHandle	Handle to the universe containing handle.
[in]	handle	Handle to be closed.

helCopyOnWrite()

HEL_C_LINKAGE HelError helCopyOnWrite	(	HelHandle	memory,
		uintptr_t	offset,
		size_t	size,
		HelHandle *	handle
	)

Creates memory object that obtains its memory by copy-on-write from another memory object.

Parameters

[in]	memory	Handle to the source memory object.
[in]	offset	Offset in byte relative to memory.
[in]	size	Size of the memory object in bytes. Must be aligned to the system's page size.
[out]	handle	Handle to the new memory object.

helCreateBitsetEvent()

HEL_C_LINKAGE HelError helCreateBitsetEvent

(

HelHandle *

handle

)

Create an event consisting of multiple bits that can fire independently.

Parameters

[out]

handle

Handle to the new event.

helCreateIndirectMemory()

HEL_C_LINKAGE HelError helCreateIndirectMemory	(	size_t	numSlots,
		HelHandle *	handle
	)

Creates a memory object that obtains its memory by delegating to other memory objects.

Parameters

[in]	numSlots	Number of slots, i.e., other memory objects that the indirect memory object refers to.
[out]	handle	Handle to the new memory object.

helCreateManagedMemory()

HEL_C_LINKAGE HelError helCreateManagedMemory	(	size_t	size,
		uint32_t	flags,
		HelHandle *	backingHandle,
		HelHandle *	frontalHandle
	)

Creates a memory object that is managed by userspace.

The backingHandle is used to manage the memory object, while the frontalHandle provides a view on the memory object for consumers.

Parameters

[in]	size	Size of the memory object in bytes. Must be aligned to the system's page size.
[out]	backingHandle	Handle to the new memory object (for management)
[out]	frontalHandle	Handle to the new memory object (for consumers).

helCreateOneshotEvent()

HEL_C_LINKAGE HelError helCreateOneshotEvent

(

HelHandle *

handle

)

Create an event that fires at most once.

Parameters

[out]

handle

Handle to the new event.

helCreateSpace()

HEL_C_LINKAGE HelError helCreateSpace

(

HelHandle *

handle

)

Creates a virtual address space that threads can run in.

Parameters

[out]

handle

Handle to the new address space.

helCreateStream()

HEL_C_LINKAGE HelError helCreateStream	(	HelHandle *	lane1,
		HelHandle *	lane2
	)

Create a stream (which always consists of two lanes).

Parameters

[out]	lane1	Handle to the first lane of the new stream.
[out]	lane2	Handle to the second lane of the new stream.

helCreateThread()

HEL_C_LINKAGE HelError helCreateThread	(	HelHandle	universe,
		HelHandle	spaceHandle,
		HelAbi	abi,
		void *	ip,
		void *	sp,
		uint32_t	flags,
		HelHandle *	handle
	)

Create a new thread.

Parameters

[in]	universeHandle	Handle to universe of the new thread.
[in]	spaceHandle	Handle to universe of the new thread.
[in]	abi	ABI that the new thread should adhere to.
[in]	ip	Instruction pointer of the new thread.
[in]	sp	Stack pointer of the new thread.
[out]	handle	Handle to the new thread.

helCreateToken()

HEL_C_LINKAGE HelError helCreateToken

(

HelHandle *

handle

)

Create a token object.

A token object represents some unnamed credentials which can be shared. Token objects can be passed to ImbueCredentials to send the credentials they hold instead of the thread's credentials.

Parameters

[out]

handle

Handle to the token object

helCreateUniverse()

HEL_C_LINKAGE HelError helCreateUniverse

(

HelHandle *

handle

)

Creates a new universe descriptor.

Parameters

[out]

handle

Handle to the new universe descriptor.

helEnableIo()

HEL_C_LINKAGE HelError helEnableIo

(

HelHandle

handle

)

Enable userspace access to hardware I/O resources.

Parameters

[in]

handle

Handle to the hardware I/O resource.

helForkMemory()

HEL_C_LINKAGE HelError helForkMemory	(	HelHandle	handle,
		HelHandle *	forkedHandle
	)

Forks memory objects, i.e., copies them using copy-on-write.

Parameters

[in]	indirectHandle	Handle to the memory object to be forked. Must refer to a memory object created by helCopyOnWrite.
[out]	handle	Handle to the new (i.e., forked) memory object.

helFutexWait()

HEL_C_LINKAGE HelError helFutexWait	(	int *	pointer,
		int	expected,
		int64_t	deadline
	)

Waits on a futex.

Parameters

[in]	pointer	Pointer that identifies the futex.
[in]	expected	Expected value of the futex. This function does nothing unless the futex pointed to by @pointer matches this value.
[in]	deadline	Timeout (in absolute monotone time, see helGetClock).

helFutexWake()

HEL_C_LINKAGE HelError helFutexWake

(

int *

pointer

)

Wakes up all waiters of a futex.

Parameters

[in]

pointer

Pointer that identifies the futex.

helGetAffinity()

HEL_C_LINKAGE HelError helGetAffinity	(	HelHandle	handle,
		uint8_t *	mask,
		size_t	size,
		size_t *	actualSize
	)

Get a thread's CPU affinity mask.

Parameters

[in]	handle	Handle to the thread.
[out]	mask	Buffer to write the affinity bitmask to.
[in]	size	Size of bit mask buffer.
[out]	actual_size	Amount of bytes actually written to mask.

helGetClock()

HEL_C_LINKAGE HelError helGetClock

(

uint64_t *

counter

)

Read the system-wide monotone clock.

Parameters

[out]

counter

Current value of the system-wide clock in nanoseconds since boot.

helGetCredentials()

HEL_C_LINKAGE HelError helGetCredentials	(	HelHandle	handle,
		uint32_t	flags,
		char *	credentials
	)

Returns the credentials associated with a given descriptor.

Parameters

[in]	handle	Handle to the descriptor.
[out]	credentials	Credentials, i.e., a 16-byte binary string.

helInterruptThread()

HEL_C_LINKAGE HelError helInterruptThread

(

HelHandle

handle

)

Interrupt a thread.

This system call temporarily suspends a thread. The thread can later be resumed through the use of helResume.

Parameters

[in]

handle

Handle to the thread.

helKillThread()

HEL_C_LINKAGE HelError helKillThread

(

HelHandle

handle

)

Kill (i.e., terminate) a thread.

Parameters

[in]

handle

Handle to the thread.

helLoadahead()

HEL_C_LINKAGE HelError helLoadahead	(	HelHandle	handle,
		uintptr_t	offset,
		size_t	length
	)

Notifies the kernel that a certain range of memory should be preloaded.

This acts as a hint to the kernel and is meant purely as a performance optimization. The kernel is free to ignore it.

Parameters

[in]	handle	Handle to the memory object.
[in]	offset	Offset in bytes, relative to handle.
[in]	length	Length of the memory range that is preloaded.

helLoadRegisters()

HEL_C_LINKAGE HelError helLoadRegisters	(	HelHandle	handle,
		int	set,
		void *	image
	)

Load a register image (e.g., from a thread).

Parameters

[in]	handle	Handle to the thread.
[in]	set	Register set that will be accessed.
[out]	image	Copy of the register image.

helLog()

HEL_C_LINKAGE HelError helLog	(	const char *	string,
		size_t	length
	)

Writes a text message (e.g., a line of text) to the kernel's log.

Parameters

[in]	string	Text to be written.
[in]	length	Size of the text in bytes.

helMapMemory()

HEL_C_LINKAGE HelError helMapMemory	(	HelHandle	memoryHandle,
		HelHandle	spaceHandle,
		void *	pointer,
		uintptr_t	offset,
		size_t	size,
		uint32_t	flags,
		void **	actualPointer
	)

Maps memory objects into an address space.

Parameters

[in]	memoryHandle	Handle to the memory object.
[in]	spaceHandle	Handle to the address space (see helCreateSpace).
[in]	pointer	Pointer to which the memory is mapped. Can be specified as NULL to let the kernel pick a pointer.
[in]	offset	Offset in bytes, relative to memoryHandle. Must be aligned to the system's page size.
[in]	size	Size of the mappping in bytes. Must be aligned to the system's page size.
[out]	actualPointer	Pointer to which the memory is mapped. Differs from pointer only if pointer was specified as NULL.

helPanic()

HEL_C_LINKAGE void helPanic	(	const char *	string,
		size_t	length
	)

Kills the current thread and writes an error message to the kernel's log.

Parameters

[in]	string	Text to be written.
[in]	length	Size of the text in bytes.

helQueryRegisterInfo()

HEL_C_LINKAGE HelError helQueryRegisterInfo	(	int	set,
		struct HelRegisterInfo *	info
	)

Query register-related information.

Parameters

[in]	set
[out]	info	Returned information.

helQueryThreadStats()

HEL_C_LINKAGE HelError helQueryThreadStats	(	HelHandle	handle,
		struct HelThreadStats *	stats
	)

Query run-time statistics of a thread.

Parameters

[in]	handle	Handle to the thread.
[out]	stats	Statistics related to the thread.

helRaiseEvent()

HEL_C_LINKAGE HelError helRaiseEvent

(

HelHandle

handle

)

Raise an event.

Parameters

[in]

handle

Handle to the event that will be raised.

helResizeMemory()

HEL_C_LINKAGE HelError helResizeMemory	(	HelHandle	handle,
		size_t	newSize
	)

Resizes a memory object.

Parameters

[in]	handle	Handle to the memory object. Must be aligned to the system's page size.
[in]	newSize	New size in bytes.

helResume()

HEL_C_LINKAGE HelError helResume

(

HelHandle

handle

)

Resume a suspended thread.

Threads can explicitly be suspended through the use of helInterruptThread. They are also suspended on faults and supercalls.

Parameters

[in]

handle

Handle to the thread.

helSetAffinity()

HEL_C_LINKAGE HelError helSetAffinity	(	HelHandle	handle,
		uint8_t *	mask,
		size_t	size
	)

Set a thread's CPU affinity mask.

Parameters

[in]	handle	Handle to the thread.
[in]	mask	Pointer to a bit mask of CPUs to schedule on.
[in]	size	Size of bit mask.

helSetPriority()

HEL_C_LINKAGE HelError helSetPriority	(	HelHandle	handle,
		int	priority
	)

Set the priority of a thread.

Managarm always runs the runnable thread with highest priority. The default priority of a thread is zero.

Parameters

[in]	handle	Handle to the thread.
[in]	priority	New priority value of the thread.

helStoreRegisters()

HEL_C_LINKAGE HelError helStoreRegisters	(	HelHandle	handle,
		int	set,
		const void *	image
	)

Store a register image (e.g., to a thread).

Parameters

[in]	handle	Handle to the thread.
[in]	set	Register set that will be accessed.
[in]	image	Copy of the register image.

helSubmitAsync()

HEL_C_LINKAGE HelError helSubmitAsync	(	HelHandle	handle,
		const struct HelAction *	actions,
		size_t	count,
		HelHandle	queue,
		uintptr_t	context,
		uint32_t	flags
	)

Pass messages on a stream.

Parameters

[in]	handle	Handle to the lane that messages will be passed to.
[in]	actions	Pointer to array of message items.
[in]	count	Number of elements in actions.

helSubmitAsyncNop()

HEL_C_LINKAGE HelError helSubmitAsyncNop	(	HelHandle	queueHandle,
		uintptr_t	context
	)

Does nothing, asynchronously (useful only for profiling).

This is an asynchronous operation.

helSubmitAwaitClock()

HEL_C_LINKAGE HelError helSubmitAwaitClock	(	uint64_t	counter,
		HelHandle	queue,
		uintptr_t	context,
		uint64_t *	asyncId
	)

Wait until time passes.

This is an asynchronous operation.

Parameters

[in]	counter	Deadline (absolute, see helGetClock).
[out]	asyncId	ID to identify the asynchronous operation (absolute, see helCancelAsync).

helSubmitAwaitEvent()

HEL_C_LINKAGE HelError helSubmitAwaitEvent	(	HelHandle	handle,
		uint64_t	sequence,
		HelHandle	queue,
		uintptr_t	context
	)

Wait for an event.

This is an asynchronous operation.

Parameters

[in]	handle	Handle to the event that will be awaited.
[in]	sequence	Previous sequence number.

helSubmitObserve()

HEL_C_LINKAGE HelError helSubmitObserve	(	HelHandle	handle,
		uint64_t	sequence,
		HelHandle	queue,
		uintptr_t	context
	)

Observe whether a thread changes its state.

This is an asynchronous operation.

Parameters

[in]	handle	Handle to the thread.
[in]	sequence	Previous sequence number.

helSubmitProtectMemory()

HEL_C_LINKAGE HelError helSubmitProtectMemory	(	HelHandle	spaceHandle,
		void *	pointer,
		size_t	size,
		uint32_t	flags,
		HelHandle	queueHandle,
		uintptr_t	context
	)

Changes protection attributes of a memory mapping.

This is an asynchronous operation.

Parameters

[in]	spaceHandle	Handle to the address space containing pointer.
[in]	pointer	Pointer to the mapping that is modified. Must be aligned to the system's page size.
[in]	size	Size of the mapping that is modified. Must be aligned to the system's page size.

helSubmitReadMemory()

HEL_C_LINKAGE HelError helSubmitReadMemory	(	HelHandle	handle,
		uintptr_t	address,
		size_t	length,
		void *	buffer,
		HelHandle	queue,
		uintptr_t	context
	)

Load memory (i.e., bytes) from a descriptor.

This is an asynchronous operation.

Parameters

[in]	handle	Handle to the descriptor. This system call supports address spaces (see ::helCreateAddressSpace) and virtualized spaces (see ::helCreateVirtualizedSpace).
[in]	address	Address that is accessed, relative to handle.
[in]	length	Length of the copied memory region.

helSubmitSynchronizeSpace()

HEL_C_LINKAGE HelError helSubmitSynchronizeSpace	(	HelHandle	spaceHandle,
		void *	pointer,
		size_t	size,
		HelHandle	queueHandle,
		uintptr_t	context
	)

Notifies the kernel of dirty pages in a memory mapping.

This system call returns after the kernel has scanned all specified pages and determined whether they are dirty or not. It does not wait until the pages are clean again.

This is an asynchronous operation.

Parameters

[in]	spaceHandle	Handle to the address space containing pointer.
[in]	pointer	Pointer to the mapping that is synchronized. Must be aligned to the system's page size.
[in]	size	Size of the mapping that is synchronized. Must be aligned to the system's page size.

helSubmitWriteMemory()

HEL_C_LINKAGE HelError helSubmitWriteMemory	(	HelHandle	handle,
		uintptr_t	address,
		size_t	length,
		const void *	buffer,
		HelHandle	queue,
		uintptr_t	context
	)

Store memory (i.e., bytes) to a descriptor.

This is an asynchronous operation.

Parameters

[in]	handle	Handle to the descriptor. This system call supports address spaces (see ::helCreateAddressSpace) and virtualized spaces (see ::helCreateVirtualizedSpace).
[in]	address	Address that is accessed, relative to handle.
[in]	length	Length of the copied memory region.

helTransferDescriptor()

HEL_C_LINKAGE HelError helTransferDescriptor	(	HelHandle	handle,
		HelHandle	universeHandle,
		HelHandle *	outHandle
	)

Copies descriptors from the current universe to another universe.

Parameters

[in]	handle	Handle the descriptor to transfer.
[in]	universeHandle	Handle to the destination universe.
[out]	outHandle	Handle to the copied descriptor (valid in the universe specified by universeHandle).

helUnmapMemory()

HEL_C_LINKAGE HelError helUnmapMemory	(	HelHandle	spaceHandle,
		void *	pointer,
		size_t	size
	)

Unmaps memory from an address space.

Parameters

[in]	spaceHandle	Handle to the address space containing pointer.
[in]	pointer	Pointer to the mapping that is unmapped. Must be aligned to the system's page size.
[in]	size	Size of the mapping that is unmapped. Must be aligned to the system's page size.