Index ⭢ Core ⭢ asmjit::Environment

asmjit::Environment Class Reference [¶]

Represents an environment, which is usually related to a Target.

Environment has usually an 'arch-subarch-vendor-os-abi' format, which is sometimes called "Triple" (historically it used to be 3 only parts) or "Tuple", which is a convention used by Debian Linux.

AsmJit doesn't support all possible combinations or architectures and ABIs, however, it models the environment similarly to other compilers for future extensibility.

Public Members

Members

Arch _arch = Arch::kUnknown

SubArch _sub_arch = SubArch::kUnknown

Vendor _vendor = Vendor::kUnknown

Platform _platform = Platform::kUnknown

PlatformABI _platform_abi = PlatformABI::kUnknown

ObjectFormat _object_format = ObjectFormat::kUnknown

FloatABI _float_abi = FloatABI::kHardFloat

uint8_t _reserved = 0

Member Functions

Overloaded Operators

Environment& operator=(const Environment& other) noexcept = default

bool operator==(const Environment& other) const noexcept

bool operator!=(const Environment& other) const noexcept

Accessors

bool is_empty() const noexcept

bool is_initialized() const noexcept

uint64_t _packed() const noexcept

void reset() noexcept

bool equals(const Environment& other) const noexcept

Arch arch() const noexcept

SubArch sub_arch() const noexcept

Vendor vendor() const noexcept

Platform platform() const noexcept

PlatformABI platform_abi() const noexcept

ObjectFormat object_format() const noexcept

FloatABI float_abi() const noexcept

void init(Arch arch, SubArch sub_arch = SubArch::kUnknown, Vendor vendor = Vendor::kUnknown, Platform platform = Platform::kUnknown, PlatformABI platform_abi = PlatformABI::kUnknown, ObjectFormat object_format = ObjectFormat::kUnknown, FloatABI float_abi = FloatABI::kHardFloat) noexcept

bool is_arch_x86() const noexcept

bool is_arch_x64() const noexcept

bool is_arch_arm() const noexcept

bool is_arch_thumb() const noexcept

bool is_arch_aarch64() const noexcept

bool is_arch_mips32() const noexcept

bool is_arch_mips64() const noexcept

bool is_arch_riscv32() const noexcept

bool is_arch_riscv64() const noexcept

bool is_32bit() const noexcept

bool is_64bit() const noexcept

bool is_little_endian() const noexcept

bool is_big_endian() const noexcept

bool is_family_x86() const noexcept

bool is_family_arm() const noexcept

bool is_family_aarch32() const noexcept

bool is_family_aarch64() const noexcept

bool is_family_mips() const noexcept

bool is_family_riscv() const noexcept

bool is_platform_windows() const noexcept

bool is_platform_linux() const noexcept

bool is_platform_hurd() const noexcept

bool is_platform_haiku() const noexcept

bool is_platform_bsd() const noexcept

bool is_platform_apple() const noexcept

bool is_msvc_abi() const noexcept

bool is_gnu_abi() const noexcept

bool is_darwin_abi() const noexcept

uint32_t stack_alignment() const noexcept

uint32_t register_size() const noexcept

void set_arch(Arch arch) noexcept

void set_sub_arch(SubArch sub_arch) noexcept

void set_vendor(Vendor vendor) noexcept

void set_platform(Platform platform) noexcept

void set_platform_abi(PlatformABI platform_abi) noexcept

void set_object_format(ObjectFormat object_format) noexcept

void set_float_abi(FloatABI float_abi) noexcept

Static Functions

Static Utilities

static bool is_defined_arch(Arch arch) noexcept

static bool is_valid_arch(Arch arch) noexcept

static bool is_32bit(Arch arch) noexcept

static bool is_64bit(Arch arch) noexcept

static bool is_little_endian(Arch arch) noexcept

static bool is_big_endian(Arch arch) noexcept

static bool is_arch_thumb(Arch arch) noexcept

static bool is_arch_arm(Arch arch) noexcept

static bool is_arch_aarch64(Arch arch) noexcept

static bool is_arch_mips32(Arch arch) noexcept

static bool is_arch_mips64(Arch arch) noexcept

static bool is_family_x86(Arch arch) noexcept

static bool is_family_aarch32(Arch arch) noexcept

static bool is_family_aarch64(Arch arch) noexcept

static bool is_family_arm(Arch arch) noexcept

static bool is_family_mips(Arch arch) noexcept

static bool is_family_riscv(Arch arch) noexcept

static uint32_t reg_size_of_arch(Arch arch) noexcept

Construction & Destruction

constexpr Environment() noexcept = default

constexpr Environment(const Environment& other) noexcept = default

constexpr Environment(Arch arch, SubArch sub_arch = SubArch::kUnknown, Vendor vendor = Vendor::kUnknown, Platform platform = Platform::kUnknown, PlatformABI platform_abi = PlatformABI::kUnknown, ObjectFormat object_format = ObjectFormat::kUnknown, FloatABI float_abi = FloatABI::kHardFloat) noexcept

static constexpr Environment host() noexcept

Environment::Environment()constexprdefaultnoexcept[1/3][¶]

Creates a default initialized environment (all values either unknown or set to safe defaults).

Environment::Environment(
const Environment& other
)constexprdefaultnoexcept[2/3][¶]

Creates a copy of other instance.

Environment::Environment(
Arch arch,
SubArch sub_arch = SubArch::kUnknown,
Vendor vendor = Vendor::kUnknown,
Platform platform = Platform::kUnknown,
PlatformABI platform_abi = PlatformABI::kUnknown,
ObjectFormat object_format = ObjectFormat::kUnknown,
FloatABI float_abi = FloatABI::kHardFloat
)explicitconstexprnoexcept[3/3][¶]

Creates Environment initialized to arch, sub_arch, vendor, platform, platform_abi, object_format, and float_abi.

Environment Environment::host()constexprstaticnoexcept[¶]

Returns the host environment constructed from preprocessor macros defined by the compiler.

The returned environment should precisely match the target host architecture, sub-architecture, platform, and ABI.

bool Environment::is_empty() constnodiscardnoexcept[¶]

Tests whether the environment is not set up.

Returns true if all members are zero, and thus unknown.

bool Environment::is_initialized() constnodiscardnoexcept[¶]

Tests whether the environment is initialized, which means it must have a valid architecture.

void Environment::reset()noexcept[¶]

Resets all members of the environment to zero / unknown.

bool Environment::equals(
const Environment& other
) constnodiscardnoexcept[¶]

Tests whether this environment is equal to other.

Arch Environment::arch() constnodiscardnoexcept[¶]

Returns the architecture.

SubArch Environment::sub_arch() constnodiscardnoexcept[¶]

Returns the sub-architecture.

Vendor Environment::vendor() constnodiscardnoexcept[¶]

Returns vendor.

Platform Environment::platform() constnodiscardnoexcept[¶]

Returns target's platform or operating system.

PlatformABI Environment::platform_abi() constnodiscardnoexcept[¶]

Returns target's ABI.

ObjectFormat Environment::object_format() constnodiscardnoexcept[¶]

Returns target's object format.

FloatABI Environment::float_abi() constnodiscardnoexcept[¶]

Returns floating point ABI.

void Environment::init(
Arch arch,
SubArch sub_arch = SubArch::kUnknown,
Vendor vendor = Vendor::kUnknown,
Platform platform = Platform::kUnknown,
PlatformABI platform_abi = PlatformABI::kUnknown,
ObjectFormat object_format = ObjectFormat::kUnknown,
FloatABI float_abi = FloatABI::kHardFloat
)noexcept[¶]

Initializes Environment to arch, sub_arch, vendor, platform, platform_abi, object_format, and float_abi.

bool Environment::is_arch_x86() constnodiscardnoexcept[¶]

Tests whether this environment describes a 32-bit X86.

bool Environment::is_arch_x64() constnodiscardnoexcept[¶]

Tests whether this environment describes a 64-bit X86.

bool Environment::is_arch_arm() constnodiscardnoexcept[1/2][¶]

Tests whether this environment describes a 32-bit ARM.

bool Environment::is_arch_thumb() constnodiscardnoexcept[1/2][¶]

Tests whether this environment describes a 32-bit ARM in THUMB mode.

bool Environment::is_arch_aarch64() constnodiscardnoexcept[1/2][¶]

Tests whether this environment describes a 64-bit X86.

bool Environment::is_arch_mips32() constnodiscardnoexcept[1/2][¶]

Tests whether this environment describes a 32-bit MIPS.

bool Environment::is_arch_mips64() constnodiscardnoexcept[1/2][¶]

Tests whether this environment describes a 64-bit MIPS.

bool Environment::is_arch_riscv32() constnodiscardnoexcept[¶]

Tests whether this environment describes a 32-bit RISC-V.

bool Environment::is_arch_riscv64() constnodiscardnoexcept[¶]

Tests whether this environment describes a 64-bit RISC-V.

bool Environment::is_32bit() constnodiscardnoexcept[1/2][¶]

Tests whether the architecture is 32-bit.

bool Environment::is_64bit() constnodiscardnoexcept[1/2][¶]

Tests whether the architecture is 64-bit.

bool Environment::is_little_endian() constnodiscardnoexcept[1/2][¶]

Tests whether the architecture is little endian.

bool Environment::is_big_endian() constnodiscardnoexcept[1/2][¶]

Tests whether the architecture is big endian.

bool Environment::is_family_x86() constnodiscardnoexcept[1/2][¶]

Tests whether this architecture is of X86 family.

bool Environment::is_family_arm() constnodiscardnoexcept[1/2][¶]

Tests whether this architecture family is ARM, THUMB, or AArch64.

bool Environment::is_family_aarch32() constnodiscardnoexcept[1/2][¶]

Tests whether this architecture family is AArch32 (ARM or THUMB).

bool Environment::is_family_aarch64() constnodiscardnoexcept[1/2][¶]

Tests whether this architecture family is AArch64.

bool Environment::is_family_mips() constnodiscardnoexcept[1/2][¶]

Tests whether this architecture family is MISP or MIPS64.

bool Environment::is_family_riscv() constnodiscardnoexcept[1/2][¶]

Tests whether this architecture family is RISC-V (both 32-bit and 64-bit).

bool Environment::is_platform_windows() constnodiscardnoexcept[¶]

Tests whether the environment platform is Windows.

bool Environment::is_platform_linux() constnodiscardnoexcept[¶]

Tests whether the environment platform is Linux.

bool Environment::is_platform_hurd() constnodiscardnoexcept[¶]

Tests whether the environment platform is Hurd.

bool Environment::is_platform_haiku() constnodiscardnoexcept[¶]

Tests whether the environment platform is Haiku.

bool Environment::is_platform_bsd() constnodiscardnoexcept[¶]

Tests whether the environment platform is any BSD.

bool Environment::is_platform_apple() constnodiscardnoexcept[¶]

Tests whether the environment platform is any Apple platform (OSX, iOS, TVOS, WatchOS).

bool Environment::is_msvc_abi() constnodiscardnoexcept[¶]

Tests whether the ABI is MSVC.

bool Environment::is_gnu_abi() constnodiscardnoexcept[¶]

Tests whether the ABI is GNU.

bool Environment::is_darwin_abi() constnodiscardnoexcept[¶]

Tests whether the ABI is GNU.

uint32_t Environment::stack_alignment() constnodiscardnoexcept[¶]

Returns a calculated stack alignment for this environment.

uint32_t Environment::register_size() constnodiscardnoexcept[¶]

Returns a native register size of this architecture.

void Environment::set_arch(
Arch arch
)noexcept[¶]

Sets the architecture to arch.

void Environment::set_sub_arch(
SubArch sub_arch
)noexcept[¶]

Sets the sub-architecture to sub_arch.

void Environment::set_vendor(
Vendor vendor
)noexcept[¶]

Sets the vendor to vendor.

void Environment::set_platform(
Platform platform
)noexcept[¶]

Sets the platform to platform.

void Environment::set_platform_abi(
PlatformABI platform_abi
)noexcept[¶]

Sets the ABI to platform_abi.

void Environment::set_object_format(
ObjectFormat object_format
)noexcept[¶]

Sets the object format to object_format.

void Environment::set_float_abi(
FloatABI float_abi
)noexcept[¶]

Sets floating point ABI to float_abi.

bool Environment::is_32bit(
Arch arch
)staticnodiscardnoexcept[2/2][¶]

Tests whether the given architecture arch is 32-bit.

bool Environment::is_64bit(
Arch arch
)staticnodiscardnoexcept[2/2][¶]

Tests whether the given architecture arch is 64-bit.

bool Environment::is_little_endian(
Arch arch
)staticnodiscardnoexcept[2/2][¶]

Tests whether the given architecture arch is little endian.

bool Environment::is_big_endian(
Arch arch
)staticnodiscardnoexcept[2/2][¶]

Tests whether the given architecture arch is big endian.

bool Environment::is_arch_thumb(
Arch arch
)staticnodiscardnoexcept[2/2][¶]

Tests whether the given architecture is Thumb or Thumb_BE.

bool Environment::is_arch_arm(
Arch arch
)staticnodiscardnoexcept[2/2][¶]

Tests whether the given architecture is ARM or ARM_BE.

bool Environment::is_arch_aarch64(
Arch arch
)staticnodiscardnoexcept[2/2][¶]

Tests whether the given architecture is AArch64 or AArch64_BE.

bool Environment::is_arch_mips32(
Arch arch
)staticnodiscardnoexcept[2/2][¶]

Tests whether the given architecture is MIPS32_LE or MIPS32_BE.

bool Environment::is_arch_mips64(
Arch arch
)staticnodiscardnoexcept[2/2][¶]

Tests whether the given architecture is MIPS64_LE or MIPS64_BE.

bool Environment::is_family_x86(
Arch arch
)staticnodiscardnoexcept[2/2][¶]

Tests whether the given architecture family is X86 or X64.

bool Environment::is_family_aarch32(
Arch arch
)staticnodiscardnoexcept[2/2][¶]

Tests whether the given architecture family is AArch32 (ARM or THUMB).

bool Environment::is_family_aarch64(
Arch arch
)staticnodiscardnoexcept[2/2][¶]

Tests whether the given architecture family is AArch64.

bool Environment::is_family_arm(
Arch arch
)staticnodiscardnoexcept[2/2][¶]

Tests whether the given architecture family is ARM, THUMB, or AArch64.

bool Environment::is_family_mips(
Arch arch
)staticnodiscardnoexcept[2/2][¶]

Tests whether the given architecture family is MIPS or MIPS64.

bool Environment::is_family_riscv(
Arch arch
)staticnodiscardnoexcept[2/2][¶]

Tests whether the given architecture family is RISC-V (both 32-bit and 64-bit).

uint32_t Environment::reg_size_of_arch(
Arch arch
)staticnodiscardnoexcept[¶]

Returns a native general purpose register size from the given architecture.

Arch Environment::_arch = Arch::kUnknown[¶]

Architecture.

SubArch Environment::_sub_arch = SubArch::kUnknown[¶]

Sub-architecture type.

Vendor Environment::_vendor = Vendor::kUnknown[¶]

Vendor type.

Platform Environment::_platform = Platform::kUnknown[¶]

Platform.

PlatformABI Environment::_platform_abi = PlatformABI::kUnknown[¶]

Platform ABI.

ObjectFormat Environment::_object_format = ObjectFormat::kUnknown[¶]

Object format.

FloatABI Environment::_float_abi = FloatABI::kHardFloat[¶]

Floating point ABI.

uint8_t Environment::_reserved = 0[¶]

Reserved for future use, must be zero.