# {py:mod}`acacia.memory` ```{py:module} acacia.memory ``` ```{autodoc2-docstring} acacia.memory :parser: myst :allowtitles: ``` ## Module Contents ### Classes ````{list-table} :class: autosummary longtable :align: left * - {py:obj}`MemoryRegion ` - ```{autodoc2-docstring} acacia.memory.MemoryRegion :parser: myst :summary: ``` * - {py:obj}`Map ` - ```{autodoc2-docstring} acacia.memory.Map :parser: myst :summary: ``` * - {py:obj}`IOMap ` - ```{autodoc2-docstring} acacia.memory.IOMap :parser: myst :summary: ``` * - {py:obj}`IOAddressSpace ` - ```{autodoc2-docstring} acacia.memory.IOAddressSpace :parser: myst :summary: ``` ```` ### API `````{py:class} MemoryRegion(sdf: acacia.system.System, name: str, size: int, paddr: typing.Optional[int] = None, cached: bool = True, physical: bool = False, prefill_bootinfo: typing.Optional[str] = None) :canonical: acacia.memory.MemoryRegion ```{autodoc2-docstring} acacia.memory.MemoryRegion :parser: myst ``` ```{rubric} Initialization ``` ```{autodoc2-docstring} acacia.memory.MemoryRegion.__init__ :parser: myst ``` ````{py:method} can_be_largepage_optimised() -> bool :canonical: acacia.memory.MemoryRegion.can_be_largepage_optimised ```{autodoc2-docstring} acacia.memory.MemoryRegion.can_be_largepage_optimised :parser: myst ``` ```` ````{py:method} find_best_page_size() -> acacia.arch.PageSize :canonical: acacia.memory.MemoryRegion.find_best_page_size ```{autodoc2-docstring} acacia.memory.MemoryRegion.find_best_page_size :parser: myst ``` ```` ````{py:method} render(system_root: xml.etree.ElementTree.Element) :canonical: acacia.memory.MemoryRegion.render ```{autodoc2-docstring} acacia.memory.MemoryRegion.render :parser: myst ``` ```` ````{py:method} __repr__() -> str :canonical: acacia.memory.MemoryRegion.__repr__ ```` ````` ``````{py:class} Map(mr: acacia.memory.MemoryRegion, vaddr: int, permissions: typing.Union[Permissions, str], setvar_vaddr: typing.Optional[str] = None) :canonical: acacia.memory.Map ```{autodoc2-docstring} acacia.memory.Map :parser: myst ``` ```{rubric} Initialization ``` ```{autodoc2-docstring} acacia.memory.Map.__init__ :parser: myst ``` `````{py:class} Permissions :canonical: acacia.memory.Map.Permissions ```{autodoc2-docstring} acacia.memory.Map.Permissions :parser: myst ``` ````{py:attribute} r :canonical: acacia.memory.Map.Permissions.r :type: bool :value: > False ```{autodoc2-docstring} acacia.memory.Map.Permissions.r :parser: myst ``` ```` ````{py:attribute} w :canonical: acacia.memory.Map.Permissions.w :type: bool :value: > False ```{autodoc2-docstring} acacia.memory.Map.Permissions.w :parser: myst ``` ```` ````{py:attribute} x :canonical: acacia.memory.Map.Permissions.x :type: bool :value: > False ```{autodoc2-docstring} acacia.memory.Map.Permissions.x :parser: myst ``` ```` ````{py:method} __str__() :canonical: acacia.memory.Map.Permissions.__str__ ```` ````{py:method} __post_init__() :canonical: acacia.memory.Map.Permissions.__post_init__ ```{autodoc2-docstring} acacia.memory.Map.Permissions.__post_init__ :parser: myst ``` ```` ````{py:method} __repr__() -> str :canonical: acacia.memory.Map.Permissions.__repr__ ```` ````` ````{py:property} size :canonical: acacia.memory.Map.size ```{autodoc2-docstring} acacia.memory.Map.size :parser: myst ``` ```` ````{py:method} render(parent: xml.etree.ElementTree.Element) -> xml.etree.ElementTree.Element :canonical: acacia.memory.Map.render ```{autodoc2-docstring} acacia.memory.Map.render :parser: myst ``` ```` ````{py:property} end_vaddr :canonical: acacia.memory.Map.end_vaddr :type: int ```{autodoc2-docstring} acacia.memory.Map.end_vaddr :parser: myst ``` ```` ````{py:method} vaddr_in_map(vaddr: int) -> bool :canonical: acacia.memory.Map.vaddr_in_map ```{autodoc2-docstring} acacia.memory.Map.vaddr_in_map :parser: myst ``` ```` ````{py:method} __repr__() -> str :canonical: acacia.memory.Map.__repr__ ```` `````` `````{py:class} IOMap(mr: acacia.memory.MemoryRegion, iovaddr: int, allow_reads: bool = True, allow_writes: bool = True) :canonical: acacia.memory.IOMap ```{autodoc2-docstring} acacia.memory.IOMap :parser: myst ``` ```{rubric} Initialization ``` ```{autodoc2-docstring} acacia.memory.IOMap.__init__ :parser: myst ``` ````{py:method} render(parent: xml.etree.ElementTree.Element) -> xml.etree.ElementTree.Element :canonical: acacia.memory.IOMap.render ```{autodoc2-docstring} acacia.memory.IOMap.render :parser: myst ``` ```` ````{py:property} perms :canonical: acacia.memory.IOMap.perms :type: str ```{autodoc2-docstring} acacia.memory.IOMap.perms :parser: myst ``` ```` ````{py:method} __repr__() -> str :canonical: acacia.memory.IOMap.__repr__ ```` ````` `````{py:class} IOAddressSpace(sdf: acacia.system.System, name: str, peripheral_id: str, domain_id: str) :canonical: acacia.memory.IOAddressSpace ```{autodoc2-docstring} acacia.memory.IOAddressSpace :parser: myst ``` ```{rubric} Initialization ``` ```{autodoc2-docstring} acacia.memory.IOAddressSpace.__init__ :parser: myst ``` ````{py:method} add_io_map(iomap: acacia.memory.IOMap) :canonical: acacia.memory.IOAddressSpace.add_io_map ```{autodoc2-docstring} acacia.memory.IOAddressSpace.add_io_map :parser: myst ``` ```` ````{py:method} render(system_root: xml.etree.ElementTree.Element) -> xml.etree.ElementTree.Element :canonical: acacia.memory.IOAddressSpace.render ```{autodoc2-docstring} acacia.memory.IOAddressSpace.render :parser: myst ``` ```` ````{py:method} __repr__() -> str :canonical: acacia.memory.IOAddressSpace.__repr__ ```` `````