tmem.h File Reference

Transfer memory handling. More...

#include "../types.h"
#include "../kernel/svc.h"

Go to the source code of this file.

Data Structures
struct	TransferMemory
	Transfer memory information structure. More...

Functions
Result	tmemCreate (TransferMemory *t, size_t size, Permission perm)
	Creates a transfer memory object. More...
Result	tmemCreateFromMemory (TransferMemory *t, void *buf, size_t size, Permission perm)
	Creates a transfer memory object from existing memory. More...
void	tmemLoadRemote (TransferMemory *t, Handle handle, size_t size, Permission perm)
	Loads a transfer memory object coming from a remote process. More...
Result	tmemMap (TransferMemory *t)
	Maps a transfer memory object. More...
Result	tmemUnmap (TransferMemory *t)
	Unmaps a transfer memory object. More...
static void *	tmemGetAddr (TransferMemory *t)
	Retrieves the mapped address of a transfer memory object. More...
Result	tmemCloseHandle (TransferMemory *t)
	Closes handle of a transfer memory object. More...
Result	tmemWaitForPermission (TransferMemory *t, Permission perm)
	Waits until source backing memory permissions match perm. More...
Result	tmemClose (TransferMemory *t)
	Frees up resources used by a transfer memory object, unmapping and closing handles, etc. More...

Detailed Description

Transfer memory handling.

Author

plutoo

Copyright

libnx Authors

Remarks

Transfer memory differs from shared memory in the fact that the user process (as opposed to the kernel) allocates and owns its backing memory.

Function Documentation

tmemClose()

Result tmemClose

(

TransferMemory *

t

)

Frees up resources used by a transfer memory object, unmapping and closing handles, etc.

Parameters

t	Transfer memory information structure.

Returns

Result code.

tmemCloseHandle()

Result tmemCloseHandle

(

TransferMemory *

t

)

Closes handle of a transfer memory object.

Parameters

t	Transfer memory information structure.

Returns

Result code.

tmemCreate()

Result tmemCreate	(	TransferMemory *	t,
		size_t	size,
		Permission	perm
	)

Creates a transfer memory object.

Parameters

t	Transfer memory information structure that will be filled in.
size	Size of the transfer memory object to create.
perm	Permissions with which to protect the transfer memory in the local process.

Returns

Result code.

tmemCreateFromMemory()

Result tmemCreateFromMemory	(	TransferMemory *	t,
		void *	buf,
		size_t	size,
		Permission	perm
	)

Creates a transfer memory object from existing memory.

Parameters

t	Transfer memory information structure that will be filled in.
buf	Pointer to a page-aligned buffer.
size	Size of the transfer memory object to create.
perm	Permissions with which to protect the transfer memory in the local process.

Returns

Result code.

tmemGetAddr()

static void* tmemGetAddr ( TransferMemory *  t )

inlinestatic

Retrieves the mapped address of a transfer memory object.

Parameters

t	Transfer memory information structure.

Returns

Mapped address of the transfer memory object.

tmemLoadRemote()

void tmemLoadRemote	(	TransferMemory *	t,
		Handle	handle,
		size_t	size,
		Permission	perm
	)

Loads a transfer memory object coming from a remote process.

Parameters

t	Transfer memory information structure which will be filled in.
handle	Handle of the transfer memory object.
size	Size of the transfer memory object that is being loaded.
perm	Permissions which the transfer memory is expected to have in the process that owns the memory.

Warning

This is a privileged operation; in normal circumstances applications shouldn't use this function.

tmemMap()

Result tmemMap

(

TransferMemory *

t

)

Maps a transfer memory object.

Parameters

t	Transfer memory information structure.

Returns

Result code.

Warning

This is a privileged operation; in normal circumstances applications cannot use this function.

tmemUnmap()

Result tmemUnmap

(

TransferMemory *

t

)

Unmaps a transfer memory object.

Parameters

t	Transfer memory information structure.

Returns

Result code.

Warning

This is a privileged operation; in normal circumstances applications cannot use this function.

tmemWaitForPermission()

Result tmemWaitForPermission	(	TransferMemory *	t,
		Permission	perm
	)

Waits until source backing memory permissions match perm.

Parameters

t	Transfer memory information structure.
perm	Permissions which the source backing memory is expected to have before return.

Returns

Result code.