# {py:mod}`acacia.pd` ```{py:module} acacia.pd ``` ```{autodoc2-docstring} acacia.pd :parser: myst :allowtitles: ``` ## Module Contents ### Classes ````{list-table} :class: autosummary longtable :align: left * - {py:obj}`SchedulingProperties ` - ```{autodoc2-docstring} acacia.pd.SchedulingProperties :parser: myst :summary: ``` * - {py:obj}`Entity ` - ```{autodoc2-docstring} acacia.pd.Entity :parser: myst :summary: ``` * - {py:obj}`VirtualMachine ` - ```{autodoc2-docstring} acacia.pd.VirtualMachine :parser: myst :summary: ``` * - {py:obj}`ProtectionDomain ` - ```{autodoc2-docstring} acacia.pd.ProtectionDomain :parser: myst :summary: ``` ```` ### Data ````{list-table} :class: autosummary longtable :align: left * - {py:obj}`MAX_IDS ` - ```{autodoc2-docstring} acacia.pd.MAX_IDS :parser: myst :summary: ``` ```` ### API ````{py:data} MAX_IDS :canonical: acacia.pd.MAX_IDS :value: > 62 ```{autodoc2-docstring} acacia.pd.MAX_IDS :parser: myst ``` ```` `````{py:class} SchedulingProperties :canonical: acacia.pd.SchedulingProperties ```{autodoc2-docstring} acacia.pd.SchedulingProperties :parser: myst ``` ````{py:attribute} priority :canonical: acacia.pd.SchedulingProperties.priority :type: int :value: > None ```{autodoc2-docstring} acacia.pd.SchedulingProperties.priority :parser: myst ``` ```` ````{py:attribute} period :canonical: acacia.pd.SchedulingProperties.period :type: typing.Optional[int] :value: > None ```{autodoc2-docstring} acacia.pd.SchedulingProperties.period :parser: myst ``` ```` ````{py:attribute} budget :canonical: acacia.pd.SchedulingProperties.budget :type: typing.Optional[int] :value: > None ```{autodoc2-docstring} acacia.pd.SchedulingProperties.budget :parser: myst ``` ```` ````{py:attribute} passive :canonical: acacia.pd.SchedulingProperties.passive :type: bool :value: > False ```{autodoc2-docstring} acacia.pd.SchedulingProperties.passive :parser: myst ``` ```` ````{py:method} __post_init__() :canonical: acacia.pd.SchedulingProperties.__post_init__ ```{autodoc2-docstring} acacia.pd.SchedulingProperties.__post_init__ :parser: myst ``` ```` ````{py:method} __repr__() -> str :canonical: acacia.pd.SchedulingProperties.__repr__ ```` ````` `````{py:class} Entity(name: str, scheduling: typing.Optional[acacia.pd.SchedulingProperties], map_start_vaddr: int = 536870912) :canonical: acacia.pd.Entity ```{autodoc2-docstring} acacia.pd.Entity :parser: myst ``` ```{rubric} Initialization ``` ```{autodoc2-docstring} acacia.pd.Entity.__init__ :parser: myst ``` ````{py:property} priority :canonical: acacia.pd.Entity.priority ```{autodoc2-docstring} acacia.pd.Entity.priority :parser: myst ``` ```` ````{py:property} budget :canonical: acacia.pd.Entity.budget ```{autodoc2-docstring} acacia.pd.Entity.budget :parser: myst ``` ```` ````{py:property} period :canonical: acacia.pd.Entity.period ```{autodoc2-docstring} acacia.pd.Entity.period :parser: myst ``` ```` ````{py:method} add_map(map: acacia.memory.Map) :canonical: acacia.pd.Entity.add_map ```{autodoc2-docstring} acacia.pd.Entity.add_map :parser: myst ``` ```` ````{py:method} create_automap(mr: acacia.memory.MemoryRegion, perms: typing.Union[acacia.memory.Map.Permissions, str]) -> acacia.memory.Map :canonical: acacia.pd.Entity.create_automap ```{autodoc2-docstring} acacia.pd.Entity.create_automap :parser: myst ``` ```` ````{py:method} render(parent: xml.etree.ElementTree.Element, elem_name: str) :canonical: acacia.pd.Entity.render ```{autodoc2-docstring} acacia.pd.Entity.render :parser: myst ``` ```` ````` ``````{py:class} VirtualMachine(name: str, vcpus: typing.Sequence[VCPU], scheduling: typing.Optional[acacia.pd.SchedulingProperties] = None) :canonical: acacia.pd.VirtualMachine Bases: {py:obj}`acacia.pd.Entity` ```{autodoc2-docstring} acacia.pd.VirtualMachine :parser: myst ``` ```{rubric} Initialization ``` ```{autodoc2-docstring} acacia.pd.VirtualMachine.__init__ :parser: myst ``` `````{py:class} VCPU :canonical: acacia.pd.VirtualMachine.VCPU ```{autodoc2-docstring} acacia.pd.VirtualMachine.VCPU :parser: myst ``` ````{py:attribute} id :canonical: acacia.pd.VirtualMachine.VCPU.id :type: int :value: > None ```{autodoc2-docstring} acacia.pd.VirtualMachine.VCPU.id :parser: myst ``` ```` ````{py:attribute} cpu :canonical: acacia.pd.VirtualMachine.VCPU.cpu :type: typing.Optional[int] :value: > None ```{autodoc2-docstring} acacia.pd.VirtualMachine.VCPU.cpu :parser: myst ``` ```` ````{py:method} __post_init__() :canonical: acacia.pd.VirtualMachine.VCPU.__post_init__ ```{autodoc2-docstring} acacia.pd.VirtualMachine.VCPU.__post_init__ :parser: myst ``` ```` ````{py:method} render(parent: xml.etree.ElementTree.Element) :canonical: acacia.pd.VirtualMachine.VCPU.render ```{autodoc2-docstring} acacia.pd.VirtualMachine.VCPU.render :parser: myst ``` ```` ````` ````{py:method} render(parent: xml.etree.ElementTree.Element, elem_name: str = 'virtual_machine') -> xml.etree.ElementTree.Element :canonical: acacia.pd.VirtualMachine.render ```` `````` `````{py:class} ProtectionDomain(sdf: acacia.system.System, name: str, prog_image: str, stack_size: typing.Optional[int] = None, cpu: typing.Optional[int] = None, smc: bool = False, scheduling: typing.Optional[acacia.pd.SchedulingProperties] = None, priority: typing.Optional[int] = None) :canonical: acacia.pd.ProtectionDomain Bases: {py:obj}`acacia.pd.Entity` ```{autodoc2-docstring} acacia.pd.ProtectionDomain :parser: myst ``` ```{rubric} Initialization ``` ```{autodoc2-docstring} acacia.pd.ProtectionDomain.__init__ :parser: myst ``` ````{py:method} render(parent: xml.etree.ElementTree.Element, elem_name: str = 'protection_domain') :canonical: acacia.pd.ProtectionDomain.render ```{autodoc2-docstring} acacia.pd.ProtectionDomain.render :parser: myst ``` ```` ````{py:method} allocate_id(requested_id: typing.Optional[int] = None) :canonical: acacia.pd.ProtectionDomain.allocate_id ```{autodoc2-docstring} acacia.pd.ProtectionDomain.allocate_id :parser: myst ``` ```` ````{py:method} add_irq(irq: acacia.irq.IRQ) :canonical: acacia.pd.ProtectionDomain.add_irq ```{autodoc2-docstring} acacia.pd.ProtectionDomain.add_irq :parser: myst ``` ```` ````{py:method} add_ioport(ioport: acacia.x86.IOPort) :canonical: acacia.pd.ProtectionDomain.add_ioport ```{autodoc2-docstring} acacia.pd.ProtectionDomain.add_ioport :parser: myst ``` ```` ````{py:method} add_child_pd(child, child_id: typing.Optional[int] = None) :canonical: acacia.pd.ProtectionDomain.add_child_pd ```{autodoc2-docstring} acacia.pd.ProtectionDomain.add_child_pd :parser: myst ``` ```` ````{py:method} add_vm(vm: acacia.pd.VirtualMachine) :canonical: acacia.pd.ProtectionDomain.add_vm ```{autodoc2-docstring} acacia.pd.ProtectionDomain.add_vm :parser: myst ``` ```` ````{py:method} add_cap_map(cap_map: acacia.cspace.CapMap) :canonical: acacia.pd.ProtectionDomain.add_cap_map ```{autodoc2-docstring} acacia.pd.ProtectionDomain.add_cap_map :parser: myst ``` ```` ````{py:method} __repr__() :canonical: acacia.pd.ProtectionDomain.__repr__ ```` `````