archinfo

9.2.209 · active · verified Mon Apr 13

archinfo is a Python library providing classes with architecture-specific information essential for cross-architecture tools. It serves as a foundational component within the larger angr binary analysis framework, defining architectural details like register mappings, endianness, and instruction set properties. The library is actively maintained, with frequent minor updates, and is currently at version 9.2.209.

Warnings

breaking Internal architecture definitions, especially register file offsets and VEX IR assumptions, are tightly coupled with PyVEX. Major updates to PyVEX or the angr framework may introduce breaking changes to how these internal structures are defined or accessed, even if the public archinfo API remains superficially similar.
Fix: Always ensure archinfo is installed with a compatible version of pyvex and other angr components. Consult angr's migration guides for specific breaking changes related to architecture definitions or register handling if issues arise after an upgrade.
gotcha archinfo is a core library within the angr ecosystem. Using mismatched versions of archinfo with other angr components (like pyvex, cle, or claripy) can lead to subtle runtime errors, incorrect architectural interpretations, or crashes due to inconsistent internal representations.
Fix: For projects leveraging angr, install 'angr' as a whole via pip, which will pull in compatible versions of its dependencies including archinfo. If using archinfo standalone, carefully manage its version to match the expectations of any dependent libraries.

Install

pip install archinfo Install stable version

Imports

ArchAMD64
```
from archinfo import ArchAMD64
```
Import a specific architecture class.
get_host_arch
```
from archinfo import get_host_arch
```
Utility function to detect and return the current host architecture.
Arch
```
from archinfo.arch import Arch
```
Import the base Arch class for custom architecture definitions or type checking.

Quickstart

This quickstart demonstrates how to obtain the host system's architecture information and how to instantiate a specific architecture class, such as AMD64. It then prints basic properties of these architecture objects, including name, bitness, endianness, and key register names.

from archinfo import get_host_arch, ArchAMD64

# Get the architecture of the host machine
host_arch = get_host_arch()
print(f"Host Architecture: {host_arch.name} ({host_arch.bits}-bit, {host_arch.memory_endness.name} endian)")

# Instantiate a specific architecture (e.g., AMD64)
x86_64_arch = ArchAMD64()
print(f"AMD64 Architecture: {x86_64_arch.name} ({x86_64_arch.bits}-bit, {x86_64_arch.memory_endness.name} endian)")
print(f"Instruction Pointer Register: {x86_64_arch.ip_name}")
print(f"Stack Pointer Register: {x86_64_arch.sp_name}")

view raw JSON →