L4::Ipc::Gen_fpage Class Reference

Generic RPC base for L4 flex-pages. More...

#include <ipc_types>

Inheritance diagram for L4::Ipc::Gen_fpage:

Collaboration diagram for L4::Ipc::Gen_fpage:

Public Types
enum	Type
	Type of mapping object, see L4_fpage_type.
enum	Map_type
	Kind of mapping.
enum	Cacheopt
	Caching options, see l4_fpage_cacheability_opt_t.

Public Member Functions
bool	is_valid () const noexcept
	Check if the capability is valid.
bool	cap_received () const noexcept
	Check if at least one capability has been mapped.
bool	id_received () const noexcept
	Check if a label was received instead of a mapping.
bool	local_id_received () const noexcept
	Check if a local capability id has been received.
bool	is_compound () const noexcept
	Check if the received item has the compound bit set.
l4_umword_t	data () const noexcept
	Return the raw flex page descriptor.
l4_umword_t	base_x () const noexcept
	Return the raw base descriptor.

Detailed Description

Generic RPC base for L4 flex-pages.

Definition at line 296 of file ipc_types.

Member Function Documentation

cap_received()

bool L4::Ipc::Gen_fpage::cap_received ( ) const

inlinenoexcept

Check if at least one capability has been mapped.

The capabilities themselves can then be retrieved from the cap slots that have been provided in the receive operation.

Note

If this function returns true and the receive window covers more than one capability slot, then it is not possible to determine which slots actually got capabilities mapped from the sender.

Definition at line 365 of file ipc_types.

id_received()

bool L4::Ipc::Gen_fpage::id_received ( ) const

inlinenoexcept

Check if a label was received instead of a mapping.

For IPC gates, if the L4_RCV_ITEM_LOCAL_ID has been set, then only the label of the IPC gate will be provided if the gate is local to the receiver, i.e. the target thread of the IPC gate is in the same task as the receiving thread.

The label can be retrieved with Gen_fpage::data().

Definition at line 377 of file ipc_types.

is_compound()

bool L4::Ipc::Gen_fpage::is_compound ( ) const

inlinenoexcept

Check if the received item has the compound bit set.

A set compound bit means the next message item of the same type will be mapped to the same receive buffer as this message item.

Definition at line 395 of file ipc_types.

local_id_received()

bool L4::Ipc::Gen_fpage::local_id_received ( ) const

inlinenoexcept

Check if a local capability id has been received.

If the L4_RCV_ITEM_LOCAL_ID flag has been set by the receiver, and sender and receiver are in the same task, then only the capability index is transferred.

The capability can be retrieved with Gen_fpage::data().

Definition at line 387 of file ipc_types.

---

The documentation for this class was generated from the following file:

• l4/sys/cxx/ipc_types