acacia.channel

Module Contents

Classes

Channel

Acacia representation of a Microkit Channel object. https://docs.sel4.systems/projects/microkit/manual/latest/#channels

API

class acacia.channel.Channel(sdf: acacia.system.System, end_a: End, end_b: End)

Acacia representation of a Microkit Channel object. https://docs.sel4.systems/projects/microkit/manual/latest/#channels

Initialising an instance of this class will register a channel with Acacia, causing it to be created when rendering the XML.

Channels have two Ends representing the ProtectionDomains on either side.

Acacia will prevent you from creating channels that either have no effect or are invalid (e.g. if PPCs go from a high priority -> low priority, not allowed in Microkit).

Channel ends will automatically be assigned channel IDs from the pool of IRQ/Channel IDs available for each PD at __init__().

  • In almost all cases, you should allow these to be automatically assigned.

  • WARNING: manual assignment currently will conflict with automatic assignment. E.g. an automatically created channel can take ID=0, preventing a manual assignment of ID=0. We may defer automatic assignment to Acacia build time (as is the case with MR paddrs) in the future.

Initialization

class End

One of the two ends of a channel where a ProtectionDomain interacts with it. By default:

  • Ends allow notifications

  • Ends prohibit protected procedure calls.

You may optionally specify the channel ID of the end, although it will be automatically assigned when handed to a Channel if you do not.

If using this class in a subsystem build hook, you should NEVER manually assign IDs.

pd: acacia.pd.ProtectionDomain

None

can_notify: bool

True

can_pp: bool

False

ch_id: Optional[int]

None

__post_init__()
__repr__() → str
render(system_root: xml.etree.ElementTree.Element)

Return the Microkit XML representing this element. This is called automatically by Acacia and should not need to be manually called under normal circumstances.

id_for_pd(end_pd) → Optional[int]

Return the channel ID for this channel for the given PD. I.e. the channel number ch which end_pd can `microkit_notify()”-ed to send a notification to the other end of the channel.

This is a convenience function to make config serialisation less ambiguous. We can also avoid programming errors related to remembering end_a vs. end_b this way.

__repr__() → str