# {py:mod}`acacia.arch` ```{py:module} acacia.arch ``` ```{autodoc2-docstring} acacia.arch :parser: myst :allowtitles: ``` ## Module Contents ### Classes ````{list-table} :class: autosummary longtable :align: left * - {py:obj}`ArchID ` - * - {py:obj}`PageSize ` - ```{autodoc2-docstring} acacia.arch.PageSize :parser: myst :summary: ``` * - {py:obj}`Arch ` - ```{autodoc2-docstring} acacia.arch.Arch :parser: myst :summary: ``` ```` ### Data ````{list-table} :class: autosummary longtable :align: left * - {py:obj}`SmallPage ` - ```{autodoc2-docstring} acacia.arch.SmallPage :parser: myst :summary: ``` * - {py:obj}`LargePage ` - ```{autodoc2-docstring} acacia.arch.LargePage :parser: myst :summary: ``` * - {py:obj}`page_sizes ` - ```{autodoc2-docstring} acacia.arch.page_sizes :parser: myst :summary: ``` * - {py:obj}`aarch64 ` - ```{autodoc2-docstring} acacia.arch.aarch64 :parser: myst :summary: ``` * - {py:obj}`riscv64 ` - ```{autodoc2-docstring} acacia.arch.riscv64 :parser: myst :summary: ``` * - {py:obj}`x86_64 ` - ```{autodoc2-docstring} acacia.arch.x86_64 :parser: myst :summary: ``` ```` ### API `````{py:class} ArchID :canonical: acacia.arch.ArchID Bases: {py:obj}`enum.Enum` ````{py:attribute} aarch64 :canonical: acacia.arch.ArchID.aarch64 :value: > 1 ```{autodoc2-docstring} acacia.arch.ArchID.aarch64 :parser: myst ``` ```` ````{py:attribute} riscv64 :canonical: acacia.arch.ArchID.riscv64 :value: > 2 ```{autodoc2-docstring} acacia.arch.ArchID.riscv64 :parser: myst ``` ```` ````{py:attribute} x86_64 :canonical: acacia.arch.ArchID.x86_64 :value: > 3 ```{autodoc2-docstring} acacia.arch.ArchID.x86_64 :parser: myst ``` ```` ````` `````{py:class} PageSize :canonical: acacia.arch.PageSize ```{autodoc2-docstring} acacia.arch.PageSize :parser: myst ``` ````{py:attribute} name :canonical: acacia.arch.PageSize.name :type: str :value: > None ```{autodoc2-docstring} acacia.arch.PageSize.name :parser: myst ``` ```` ````{py:attribute} size_bytes :canonical: acacia.arch.PageSize.size_bytes :type: int :value: > None ```{autodoc2-docstring} acacia.arch.PageSize.size_bytes :parser: myst ``` ```` ````{py:method} __post_init__() :canonical: acacia.arch.PageSize.__post_init__ ```{autodoc2-docstring} acacia.arch.PageSize.__post_init__ :parser: myst ``` ```` ````{py:method} __eq__(value: object, /) -> bool :canonical: acacia.arch.PageSize.__eq__ ```` ````{py:method} addr_is_aligned(addr: int) -> bool :canonical: acacia.arch.PageSize.addr_is_aligned ```{autodoc2-docstring} acacia.arch.PageSize.addr_is_aligned :parser: myst ``` ```` ````{py:method} roundup_to_page(addr: int) -> int :canonical: acacia.arch.PageSize.roundup_to_page ```{autodoc2-docstring} acacia.arch.PageSize.roundup_to_page :parser: myst ``` ```` ````{py:method} rounddown_to_page(addr: int) -> int :canonical: acacia.arch.PageSize.rounddown_to_page ```{autodoc2-docstring} acacia.arch.PageSize.rounddown_to_page :parser: myst ``` ```` ````` ````{py:data} SmallPage :canonical: acacia.arch.SmallPage :value: > 'PageSize(...)' ```{autodoc2-docstring} acacia.arch.SmallPage :parser: myst ``` ```` ````{py:data} LargePage :canonical: acacia.arch.LargePage :value: > 'PageSize(...)' ```{autodoc2-docstring} acacia.arch.LargePage :parser: myst ``` ```` ````{py:data} page_sizes :canonical: acacia.arch.page_sizes :value: > None ```{autodoc2-docstring} acacia.arch.page_sizes :parser: myst ``` ```` `````{py:class} Arch :canonical: acacia.arch.Arch ```{autodoc2-docstring} acacia.arch.Arch :parser: myst ``` ````{py:attribute} arch :canonical: acacia.arch.Arch.arch :type: acacia.arch.ArchID :value: > None ```{autodoc2-docstring} acacia.arch.Arch.arch :parser: myst ``` ```` ````{py:method} is_arm() -> bool :canonical: acacia.arch.Arch.is_arm ```{autodoc2-docstring} acacia.arch.Arch.is_arm :parser: myst ``` ```` ````{py:method} is_riscv() -> bool :canonical: acacia.arch.Arch.is_riscv ```{autodoc2-docstring} acacia.arch.Arch.is_riscv :parser: myst ``` ```` ````{py:method} is_x86() -> bool :canonical: acacia.arch.Arch.is_x86 ```{autodoc2-docstring} acacia.arch.Arch.is_x86 :parser: myst ``` ```` ````{py:method} default_page_size() -> acacia.arch.PageSize :canonical: acacia.arch.Arch.default_page_size ```{autodoc2-docstring} acacia.arch.Arch.default_page_size :parser: myst ``` ```` ````{py:method} default_page_size_bytes() -> int :canonical: acacia.arch.Arch.default_page_size_bytes ```{autodoc2-docstring} acacia.arch.Arch.default_page_size_bytes :parser: myst ``` ```` ````{py:method} addr_is_page_aligned(addr: int, page_size: typing.Optional[acacia.arch.PageSize] = None) -> bool :canonical: acacia.arch.Arch.addr_is_page_aligned ```{autodoc2-docstring} acacia.arch.Arch.addr_is_page_aligned :parser: myst ``` ```` ````{py:method} roundup_to_page(n: int, page_size: typing.Optional[acacia.arch.PageSize] = None) -> int :canonical: acacia.arch.Arch.roundup_to_page ```{autodoc2-docstring} acacia.arch.Arch.roundup_to_page :parser: myst ``` ```` ````{py:method} rounddown_to_page(n: int, page_size: typing.Optional[acacia.arch.PageSize] = None) -> int :canonical: acacia.arch.Arch.rounddown_to_page ```{autodoc2-docstring} acacia.arch.Arch.rounddown_to_page :parser: myst ``` ```` ````{py:method} determine_region_page_size(size: int) -> acacia.arch.PageSize :canonical: acacia.arch.Arch.determine_region_page_size ```{autodoc2-docstring} acacia.arch.Arch.determine_region_page_size :parser: myst ``` ```` ````{py:method} __repr__() -> str :canonical: acacia.arch.Arch.__repr__ ```` ````` ````{py:data} aarch64 :canonical: acacia.arch.aarch64 :value: > 'Arch(...)' ```{autodoc2-docstring} acacia.arch.aarch64 :parser: myst ``` ```` ````{py:data} riscv64 :canonical: acacia.arch.riscv64 :value: > 'Arch(...)' ```{autodoc2-docstring} acacia.arch.riscv64 :parser: myst ``` ```` ````{py:data} x86_64 :canonical: acacia.arch.x86_64 :value: > 'Arch(...)' ```{autodoc2-docstring} acacia.arch.x86_64 :parser: myst ``` ````