// This file is part of AsmJit project // // See asmjit.h or LICENSE.md for license and copyright information // SPDX-License-Identifier: Zlib #ifndef ASMJIT_CORE_OPERAND_H_INCLUDED #define ASMJIT_CORE_OPERAND_H_INCLUDED #include "../core/archcommons.h" #include "../core/support.h" #include "../core/type.h" ASMJIT_BEGIN_NAMESPACE //! \addtogroup asmjit_assembler //! \{ //! Operand type used by \ref Operand_. enum class OperandType : uint32_t { //! Not an operand or not initialized. kNone = 0, //! Operand is a register. kReg = 1, //! Operand is a memory. kMem = 2, //! Operand is an immediate value. kImm = 3, //! Operand is a label. kLabel = 4, //! Maximum value of `OperandType`. kMaxValue = kLabel }; static_assert(uint32_t(OperandType::kMem) == uint32_t(OperandType::kReg) + 1, "AsmJit requires that `OperandType::kMem` equals to `OperandType::kReg + 1`"); //! Register mask is a convenience typedef that describes a mask where each bit describes a physical register id //! in the same \ref RegGroup. At the moment 32 bits are enough as AsmJit doesn't support any architecture that //! would provide more than 32 registers for a register group. typedef uint32_t RegMask; //! Register type. //! //! Provides a unique type that can be used to identify a register or its view. enum class RegType : uint8_t { //! No register - unused, invalid, multiple meanings. kNone = 0, //! This is not a register type. This value is reserved for a \ref Label that used in \ref BaseMem as a base. //! //! Label tag is used as a sub-type, forming a unique signature across all operand types as 0x1 is never associated //! with any register type. This means that a memory operand's BASE register can be constructed from virtually any //! operand (register vs. label) by just assigning its type (register type or label-tag) and operand id. kLabelTag = 1, //! Universal type describing program counter (PC) or instruction pointer (IP) register, if the target architecture //! actually exposes it as a separate register type, which most modern targets do. kPC = 2, //! 8-bit low general purpose register (X86). kGp8Lo = 3, //! 8-bit high general purpose register (X86). kGp8Hi = 4, //! 16-bit general purpose register (X86). kGp16 = 5, //! 32-bit general purpose register (X86|ARM). kGp32 = 6, //! 64-bit general purpose register (X86|ARM). kGp64 = 7, //! 8-bit view of a vector register (ARM). kVec8 = 8, //! 16-bit view of a vector register (ARM). kVec16 = 9, //! 32-bit view of a vector register (ARM). kVec32 = 10, //! 64-bit view of a vector register (ARM). //! //! \note This is never used for MMX registers on X86, MMX registers have its own category. kVec64 = 11, //! 128-bit view of a vector register (X86|ARM). kVec128 = 12, //! 256-bit view of a vector register (X86). kVec256 = 13, //! 512-bit view of a vector register (X86). kVec512 = 14, //! 1024-bit view of a vector register (future). kVec1024 = 15, //! View of a vector register, which width is implementation specific (AArch64). kVecNLen = 16, //! Mask register (X86). kMask = 17, //! Start of architecture dependent register types. kExtra = 18, // X86 Specific Register Types // --------------------------- // X86 Specific Register Types // =========================== //! Instruction pointer (RIP), only addressable in \ref x86::Mem in 64-bit targets. kX86_Rip = kPC, //! Low GPB register (AL, BL, CL, DL, ...). kX86_GpbLo = kGp8Lo, //! High GPB register (AH, BH, CH, DH only). kX86_GpbHi = kGp8Hi, //! GPW register. kX86_Gpw = kGp16, //! GPD register. kX86_Gpd = kGp32, //! GPQ register (64-bit). kX86_Gpq = kGp64, //! XMM register (SSE+). kX86_Xmm = kVec128, //! YMM register (AVX+). kX86_Ymm = kVec256, //! ZMM register (AVX512+). kX86_Zmm = kVec512, //! K register (AVX512+). kX86_KReg = kMask, //! MMX register. kX86_Mm = kExtra + 0, //! Segment register (None, ES, CS, SS, DS, FS, GS). kX86_SReg = kExtra + 1, //! Control register (CR). kX86_CReg = kExtra + 2, //! Debug register (DR). kX86_DReg = kExtra + 3, //! FPU (x87) register. kX86_St = kExtra + 4, //! Bound register (BND). kX86_Bnd = kExtra + 5, //! TMM register (AMX_TILE) kX86_Tmm = kExtra + 6, // ARM Specific Register Types // =========================== //! Program pointer (PC) register (AArch64). kARM_PC = kPC, //! 32-bit general purpose register (R or W). kARM_GpW = kGp32, //! 64-bit general purpose register (X). kARM_GpX = kGp64, //! 8-bit view of VFP/ASIMD register (B). kARM_VecB = kVec8, //! 16-bit view of VFP/ASIMD register (H). kARM_VecH = kVec16, //! 32-bit view of VFP/ASIMD register (S). kARM_VecS = kVec32, //! 64-bit view of VFP/ASIMD register (D). kARM_VecD = kVec64, //! 128-bit view of VFP/ASIMD register (Q|V). kARM_VecV = kVec128, //! Maximum value of `RegType`. kMaxValue = 31 }; ASMJIT_DEFINE_ENUM_COMPARE(RegType) //! Register group. //! //! Provides a unique value that identifies groups of registers and their views. enum class RegGroup : uint8_t { //! General purpose register group compatible with all backends. kGp = 0, //! Vector register group compatible with all backends. //! //! Describes X86 XMM|YMM|ZMM registers ARM/AArch64 V registers. kVec = 1, //! Extra virtual group #2 that can be used by Compiler for register allocation. kExtraVirt2 = 2, //! Extra virtual group #3 that can be used by Compiler for register allocation. kExtraVirt3 = 3, //! Program counter group. kPC = 4, //! Extra non-virtual group that can be used by registers not managed by Compiler. kExtraNonVirt = 5, // X86 Specific Register Groups // ---------------------------- //! K register group (KReg) - maps to \ref RegGroup::kExtraVirt2 (X86, X86_64). kX86_K = kExtraVirt2, //! MMX register group (MM) - maps to \ref RegGroup::kExtraVirt3 (X86, X86_64). kX86_MM = kExtraVirt3, //! Instruction pointer (X86, X86_64). kX86_Rip = kPC, //! Segment register group (X86, X86_64). kX86_SReg = kExtraNonVirt + 0, //! CR register group (X86, X86_64). kX86_CReg = kExtraNonVirt + 1, //! DR register group (X86, X86_64). kX86_DReg = kExtraNonVirt + 2, //! FPU register group (X86, X86_64). kX86_St = kExtraNonVirt + 3, //! BND register group (X86, X86_64). kX86_Bnd = kExtraNonVirt + 4, //! TMM register group (X86, X86_64). kX86_Tmm = kExtraNonVirt + 5, //! First group - only used in loops. k0 = 0, //! Last value of a virtual register that is managed by \ref BaseCompiler. kMaxVirt = Globals::kNumVirtGroups - 1, //! Maximum value of `RegGroup`. kMaxValue = 15 }; ASMJIT_DEFINE_ENUM_COMPARE(RegGroup) typedef Support::EnumValues RegGroupVirtValues; //! Operand signature is a 32-bit number describing \ref Operand and some of its payload. //! //! In AsmJit operand signature is used to store additional payload of register, memory, and immediate operands. //! In practice the biggest pressure on OperandSignature is from \ref BaseMem and architecture specific memory //! operands that need to store additional payload that cannot be stored elsewhere as values of all other members //! are fully specified by \ref BaseMem. struct OperandSignature { //! \name Constants //! \{ enum : uint32_t { // Operand type (3 least significant bits). // |........|........|........|.....XXX| kOpTypeShift = 0, kOpTypeMask = 0x07u << kOpTypeShift, // Register type (5 bits). // |........|........|........|XXXXX...| kRegTypeShift = 3, kRegTypeMask = 0x1Fu << kRegTypeShift, // Register group (4 bits). // |........|........|....XXXX|........| kRegGroupShift = 8, kRegGroupMask = 0x0Fu << kRegGroupShift, // Memory base type (5 bits). // |........|........|........|XXXXX...| kMemBaseTypeShift = 3, kMemBaseTypeMask = 0x1Fu << kMemBaseTypeShift, // Memory index type (5 bits). // |........|........|...XXXXX|........| kMemIndexTypeShift = 8, kMemIndexTypeMask = 0x1Fu << kMemIndexTypeShift, // Memory base+index combined (10 bits). // |........|........|...XXXXX|XXXXX...| kMemBaseIndexShift = 3, kMemBaseIndexMask = 0x3FFu << kMemBaseIndexShift, // This memory operand represents a home-slot or stack (Compiler) (1 bit). // |........|........|..X.....|........| kMemRegHomeShift = 13, kMemRegHomeFlag = 0x01u << kMemRegHomeShift, // Immediate type (1 bit). // |........|........|........|....X...| kImmTypeShift = 3, kImmTypeMask = 0x01u << kImmTypeShift, // Predicate used by either registers or immediate values (4 bits). // |........|XXXX....|........|........| kPredicateShift = 20, kPredicateMask = 0x0Fu << kPredicateShift, // Operand size (8 most significant bits). // |XXXXXXXX|........|........|........| kSizeShift = 24, kSizeMask = 0xFFu << kSizeShift }; //! \} //! \name Members //! \{ uint32_t _bits; //! \} //! \name Overloaded Operators //! //! Overloaded operators make `OperandSignature` behave like regular integer. //! //! \{ inline constexpr bool operator!() const noexcept { return _bits != 0; } inline constexpr explicit operator bool() const noexcept { return _bits != 0; } inline OperandSignature& operator|=(uint32_t x) noexcept { _bits |= x; return *this; } inline OperandSignature& operator&=(uint32_t x) noexcept { _bits &= x; return *this; } inline OperandSignature& operator^=(uint32_t x) noexcept { _bits ^= x; return *this; } inline OperandSignature& operator|=(const OperandSignature& other) noexcept { return operator|=(other._bits); } inline OperandSignature& operator&=(const OperandSignature& other) noexcept { return operator&=(other._bits); } inline OperandSignature& operator^=(const OperandSignature& other) noexcept { return operator^=(other._bits); } inline constexpr OperandSignature operator~() const noexcept { return OperandSignature{~_bits}; } inline constexpr OperandSignature operator|(uint32_t x) const noexcept { return OperandSignature{_bits | x}; } inline constexpr OperandSignature operator&(uint32_t x) const noexcept { return OperandSignature{_bits & x}; } inline constexpr OperandSignature operator^(uint32_t x) const noexcept { return OperandSignature{_bits ^ x}; } inline constexpr OperandSignature operator|(const OperandSignature& other) const noexcept { return OperandSignature{_bits | other._bits}; } inline constexpr OperandSignature operator&(const OperandSignature& other) const noexcept { return OperandSignature{_bits & other._bits}; } inline constexpr OperandSignature operator^(const OperandSignature& other) const noexcept { return OperandSignature{_bits ^ other._bits}; } inline constexpr bool operator==(uint32_t x) const noexcept { return _bits == x; } inline constexpr bool operator!=(uint32_t x) const noexcept { return _bits != x; } inline constexpr bool operator==(const OperandSignature& other) const noexcept { return _bits == other._bits; } inline constexpr bool operator!=(const OperandSignature& other) const noexcept { return _bits != other._bits; } //! \} //! \name Accessors //! \{ inline void reset() noexcept { _bits = 0; } inline constexpr uint32_t bits() const noexcept { return _bits; } inline void setBits(uint32_t bits) noexcept { _bits = bits; } template::value> inline constexpr bool hasField() const noexcept { return (_bits & kFieldMask) != 0; } template::value> inline constexpr bool hasField(uint32_t value) const noexcept { return (_bits & kFieldMask) != value << kFieldShift; } template::value> inline constexpr uint32_t getField() const noexcept { return (_bits >> kFieldShift) & (kFieldMask >> kFieldShift); } template::value> inline void setField(uint32_t value) noexcept { ASMJIT_ASSERT((value & ~(kFieldMask >> kFieldShift)) == 0); _bits = (_bits & ~kFieldMask) | (value << kFieldShift); } inline constexpr OperandSignature subset(uint32_t mask) const noexcept { return OperandSignature{_bits & mask}; } template inline constexpr bool matchesSignature(const OperandSignature& signature) const noexcept { return (_bits & kFieldMask) == signature._bits; } template inline constexpr bool matchesFields(uint32_t bits) const noexcept { return (_bits & kFieldMask) == bits; } template inline constexpr bool matchesFields(const OperandSignature& fields) const noexcept { return (_bits & kFieldMask) == fields._bits; } inline constexpr bool isValid() const noexcept { return _bits != 0; } inline constexpr OperandType opType() const noexcept { return (OperandType)getField(); } inline constexpr RegType regType() const noexcept { return (RegType)getField(); } inline constexpr RegGroup regGroup() const noexcept { return (RegGroup)getField(); } inline constexpr RegType memBaseType() const noexcept { return (RegType)getField(); } inline constexpr RegType memIndexType() const noexcept { return (RegType)getField(); } inline constexpr uint32_t predicate() const noexcept { return getField(); } inline constexpr uint32_t size() const noexcept { return getField(); } inline void setOpType(OperandType opType) noexcept { setField(uint32_t(opType)); } inline void setRegType(RegType regType) noexcept { setField(uint32_t(regType)); } inline void setRegGroup(RegGroup regGroup) noexcept { setField(uint32_t(regGroup)); } inline void setMemBaseType(RegGroup baseType) noexcept { setField(uint32_t(baseType)); } inline void setMemIndexType(RegGroup indexType) noexcept { setField(uint32_t(indexType)); } inline void setPredicate(uint32_t predicate) noexcept { setField(predicate); } inline void setSize(uint32_t size) noexcept { setField(size); } //! \} //! \name Static Constructors //! \{ static inline constexpr OperandSignature fromBits(uint32_t bits) noexcept { return OperandSignature{bits}; } template static inline constexpr OperandSignature fromValue(const T& value) noexcept { return OperandSignature{uint32_t(value) << Support::ConstCTZ::value}; } static inline constexpr OperandSignature fromOpType(OperandType opType) noexcept { return OperandSignature{uint32_t(opType) << kOpTypeShift}; } static inline constexpr OperandSignature fromRegType(RegType regType) noexcept { return OperandSignature{uint32_t(regType) << kRegTypeShift}; } static inline constexpr OperandSignature fromRegGroup(RegGroup regGroup) noexcept { return OperandSignature{uint32_t(regGroup) << kRegGroupShift}; } static inline constexpr OperandSignature fromRegTypeAndGroup(RegType regType, RegGroup regGroup) noexcept { return fromRegType(regType) | fromRegGroup(regGroup); } static inline constexpr OperandSignature fromMemBaseType(RegType baseType) noexcept { return OperandSignature{uint32_t(baseType) << kMemBaseTypeShift}; } static inline constexpr OperandSignature fromMemIndexType(RegType indexType) noexcept { return OperandSignature{uint32_t(indexType) << kMemIndexTypeShift}; } static inline constexpr OperandSignature fromPredicate(uint32_t predicate) noexcept { return OperandSignature{predicate << kPredicateShift}; } static inline constexpr OperandSignature fromSize(uint32_t size) noexcept { return OperandSignature{size << kSizeShift}; } //! \} }; //! Base class representing an operand in AsmJit (non-default constructed version). //! //! Contains no initialization code and can be used safely to define an array of operands that won't be initialized. //! This is a \ref Operand base structure designed to be statically initialized, static const, or to be used by user //! code to define an array of operands without having them default initialized at construction time. //! //! The key difference between \ref Operand and \ref Operand_ is: //! //! ``` //! Operand_ xArray[10]; // Not initialized, contains garbage. //! Operand_ yArray[10] {}; // All operands initialized to none explicitly (zero initialized). //! Operand yArray[10]; // All operands initialized to none implicitly (zero initialized). //! ``` struct Operand_ { //! \name Types //! \{ typedef OperandSignature Signature; //! \} //! \name Constants //! \{ // Indexes to `_data` array. enum DataIndex : uint32_t { kDataMemIndexId = 0, kDataMemOffsetLo = 1, kDataImmValueLo = ASMJIT_ARCH_LE ? 0 : 1, kDataImmValueHi = ASMJIT_ARCH_LE ? 1 : 0 }; //! Constants useful for VirtId <-> Index translation. enum VirtIdConstants : uint32_t { //! Minimum valid packed-id. kVirtIdMin = 256, //! Maximum valid packed-id, excludes Globals::kInvalidId. kVirtIdMax = Globals::kInvalidId - 1, //! Count of valid packed-ids. kVirtIdCount = uint32_t(kVirtIdMax - kVirtIdMin + 1) }; //! \} //! \name Members //! \{ //! Provides operand type and additional payload. Signature _signature; //! Either base id as used by memory operand or any id as used by others. uint32_t _baseId; //! Data specific to the operand type. //! //! The reason we don't use union is that we have `constexpr` constructors that construct operands and other //!`constexpr` functions that return whether another Operand or something else. These cannot generally work with //! unions so we also cannot use `union` if we want to be standard compliant. uint32_t _data[2]; //! \} //! Tests whether the given `id` is a valid virtual register id. Since AsmJit supports both physical and virtual //! registers it must be able to distinguish between these two. The idea is that physical registers are always //! limited in size, so virtual identifiers start from `kVirtIdMin` and end at `kVirtIdMax`. static inline bool isVirtId(uint32_t id) noexcept { return id - kVirtIdMin < uint32_t(kVirtIdCount); } //! Converts a real-id into a packed-id that can be stored in Operand. static inline uint32_t indexToVirtId(uint32_t id) noexcept { return id + kVirtIdMin; } //! Converts a packed-id back to real-id. static inline uint32_t virtIdToIndex(uint32_t id) noexcept { return id - kVirtIdMin; } //! \name Construction & Destruction //! \{ //! \cond INTERNAL //! Initializes a `BaseReg` operand from `signature` and register `id`. inline void _initReg(const Signature& signature, uint32_t id) noexcept { _signature = signature; _baseId = id; _data[0] = 0; _data[1] = 0; } //! \endcond //! Initializes the operand from `other` operand (used by operator overloads). inline void copyFrom(const Operand_& other) noexcept { memcpy(this, &other, sizeof(Operand_)); } //! Resets the `Operand` to none. //! //! None operand is defined the following way: //! - Its signature is zero (OperandType::kNone, and the rest zero as well). //! - Its id is `0`. //! - The reserved8_4 field is set to `0`. //! - The reserved12_4 field is set to zero. //! //! In other words, reset operands have all members set to zero. Reset operand must match the Operand state //! right after its construction. Alternatively, if you have an array of operands, you can simply use `memset()`. //! //! ``` //! using namespace asmjit; //! //! Operand a; //! Operand b; //! assert(a == b); //! //! b = x86::eax; //! assert(a != b); //! //! b.reset(); //! assert(a == b); //! //! memset(&b, 0, sizeof(Operand)); //! assert(a == b); //! ``` inline void reset() noexcept { _signature.reset(); _baseId = 0; _data[0] = 0; _data[1] = 0; } //! \} //! \name Overloaded Operators //! \{ //! Tests whether this operand is the same as `other`. inline constexpr bool operator==(const Operand_& other) const noexcept { return equals(other); } //! Tests whether this operand is not the same as `other`. inline constexpr bool operator!=(const Operand_& other) const noexcept { return !equals(other); } //! \} //! \name Cast //! \{ //! Casts this operand to `T` type. template inline T& as() noexcept { return static_cast(*this); } //! Casts this operand to `T` type (const). template inline const T& as() const noexcept { return static_cast(*this); } //! \} //! \name Accessors //! \{ //! Tests whether the operand's signature matches the signature of the `other` operand. inline constexpr bool hasSignature(const Operand_& other) const noexcept { return _signature == other._signature; } //! Tests whether the operand's signature matches the given signature `sign`. inline constexpr bool hasSignature(const Signature& other) const noexcept { return _signature == other; } //! Returns operand signature as unsigned 32-bit integer. //! //! Signature is first 4 bytes of the operand data. It's used mostly for operand checking as it's //! much faster to check packed 4 bytes at once than having to check these bytes individually. inline constexpr Signature signature() const noexcept { return _signature; } //! Sets the operand signature, see `signature()`. //! //! \note Improper use of `setSignature()` can lead to hard-to-debug errors. inline void setSignature(const Signature& signature) noexcept { _signature = signature; } //! Returns the type of the operand, see `OpType`. inline constexpr OperandType opType() const noexcept { return _signature.opType(); } //! Tests whether the operand is none (`OperandType::kNone`). inline constexpr bool isNone() const noexcept { return _signature == Signature::fromBits(0); } //! Tests whether the operand is a register (`OperandType::kReg`). inline constexpr bool isReg() const noexcept { return opType() == OperandType::kReg; } //! Tests whether the operand is a memory location (`OperandType::kMem`). inline constexpr bool isMem() const noexcept { return opType() == OperandType::kMem; } //! Tests whether the operand is an immediate (`OperandType::kImm`). inline constexpr bool isImm() const noexcept { return opType() == OperandType::kImm; } //! Tests whether the operand is a label (`OperandType::kLabel`). inline constexpr bool isLabel() const noexcept { return opType() == OperandType::kLabel; } //! Tests whether the operand is a physical register. inline constexpr bool isPhysReg() const noexcept { return isReg() && _baseId < 0xFFu; } //! Tests whether the operand is a virtual register. inline constexpr bool isVirtReg() const noexcept { return isReg() && _baseId > 0xFFu; } //! Tests whether the operand specifies a size (i.e. the size is not zero). inline constexpr bool hasSize() const noexcept { return _signature.hasField(); } //! Tests whether the size of the operand matches `size`. inline constexpr bool hasSize(uint32_t s) const noexcept { return size() == s; } //! Returns the size of the operand in bytes. //! //! The value returned depends on the operand type: //! * None - Should always return zero size. //! * Reg - Should always return the size of the register. If the register size depends on architecture //! (like `x86::CReg` and `x86::DReg`) the size returned should be the greatest possible (so it //! should return 64-bit size in such case). //! * Mem - Size is optional and will be in most cases zero. //! * Imm - Should always return zero size. //! * Label - Should always return zero size. inline constexpr uint32_t size() const noexcept { return _signature.getField(); } //! Returns the operand id. //! //! The value returned should be interpreted accordingly to the operand type: //! * None - Should be `0`. //! * Reg - Physical or virtual register id. //! * Mem - Multiple meanings - BASE address (register or label id), or high value of a 64-bit absolute address. //! * Imm - Should be `0`. //! * Label - Label id if it was created by using `newLabel()` or `Globals::kInvalidId` if the label is invalid or //! not initialized. inline constexpr uint32_t id() const noexcept { return _baseId; } //! Tests whether the operand is 100% equal to `other` operand. //! //! \note This basically performs a binary comparison, if aby bit is //! different the operands are not equal. inline constexpr bool equals(const Operand_& other) const noexcept { return (_signature == other._signature) & (_baseId == other._baseId ) & (_data[0] == other._data[0] ) & (_data[1] == other._data[1] ) ; } //! Tests whether the operand is a register matching the given register `type`. inline constexpr bool isReg(RegType type) const noexcept { return _signature.subset(Signature::kOpTypeMask | Signature::kRegTypeMask) == (Signature::fromOpType(OperandType::kReg) | Signature::fromRegType(type)); } //! Tests whether the operand is register and of register `type` and `id`. inline constexpr bool isReg(RegType type, uint32_t id) const noexcept { return isReg(type) && this->id() == id; } //! Tests whether the operand is a register or memory. inline constexpr bool isRegOrMem() const noexcept { return Support::isBetween(uint32_t(opType()), uint32_t(OperandType::kReg), uint32_t(OperandType::kMem)); } //! \} }; //! Base class representing an operand in AsmJit (default constructed version). class Operand : public Operand_ { public: //! \name Construction & Destruction //! \{ //! Creates `kOpNone` operand having all members initialized to zero. inline constexpr Operand() noexcept : Operand_{ Signature::fromOpType(OperandType::kNone), 0u, { 0u, 0u }} {} //! Creates a cloned `other` operand. inline constexpr Operand(const Operand& other) noexcept = default; //! Creates a cloned `other` operand. inline constexpr explicit Operand(const Operand_& other) : Operand_(other) {} //! Creates an operand initialized to raw `[u0, u1, u2, u3]` values. inline constexpr Operand(Globals::Init_, const Signature& u0, uint32_t u1, uint32_t u2, uint32_t u3) noexcept : Operand_{ u0, u1, { u2, u3 }} {} //! Creates an uninitialized operand (dangerous). inline explicit Operand(Globals::NoInit_) noexcept {} //! \} //! \name Overloaded Operators //! \{ inline Operand& operator=(const Operand& other) noexcept = default; inline Operand& operator=(const Operand_& other) noexcept { return operator=(static_cast(other)); } //! \} //! \name Clone //! \{ //! Clones this operand and returns its copy. inline constexpr Operand clone() const noexcept { return Operand(*this); } //! \} }; static_assert(sizeof(Operand) == 16, "asmjit::Operand must be exactly 16 bytes long"); //! Label (jump target or data location). //! //! Label represents a location in code typically used as a jump target, but may be also a reference to some data or //! a static variable. Label has to be explicitly created by BaseEmitter. //! //! Example of using labels: //! //! ``` //! // Create some emitter (for example x86::Assembler). //! x86::Assembler a; //! //! // Create Label instance. //! Label L1 = a.newLabel(); //! //! // ... your code ... //! //! // Using label. //! a.jump(L1); //! //! // ... your code ... //! //! // Bind label to the current position, see `BaseEmitter::bind()`. //! a.bind(L1); //! ``` class Label : public Operand { public: //! \name Construction & Destruction //! \{ //! Creates a label operand without ID (you must set the ID to make it valid). inline constexpr Label() noexcept : Operand(Globals::Init, Signature::fromOpType(OperandType::kLabel), Globals::kInvalidId, 0, 0) {} //! Creates a cloned label operand of `other`. inline constexpr Label(const Label& other) noexcept : Operand(other) {} //! Creates a label operand of the given `id`. inline constexpr explicit Label(uint32_t id) noexcept : Operand(Globals::Init, Signature::fromOpType(OperandType::kLabel), id, 0, 0) {} inline explicit Label(Globals::NoInit_) noexcept : Operand(Globals::NoInit) {} //! Resets the label, will reset all properties and set its ID to `Globals::kInvalidId`. inline void reset() noexcept { _signature = Signature::fromOpType(OperandType::kLabel); _baseId = Globals::kInvalidId; _data[0] = 0; _data[1] = 0; } //! \} //! \name Overloaded Operators //! \{ inline Label& operator=(const Label& other) noexcept = default; //! \} //! \name Accessors //! \{ //! Tests whether the label was created by CodeHolder and/or an attached emitter. inline constexpr bool isValid() const noexcept { return _baseId != Globals::kInvalidId; } //! Sets the label `id`. inline void setId(uint32_t id) noexcept { _baseId = id; } //! \} }; //! \cond INTERNAL //! Default register traits. struct BaseRegTraits { enum : uint32_t { //! \ref TypeId representing this register type, could be \ref TypeId::kVoid if such type doesn't exist. kTypeId = uint32_t(TypeId::kVoid), //! RegType is not valid by default. kValid = 0, //! Count of registers (0 if none). kCount = 0, //! Zero type by default (defeaults to None). kType = uint32_t(RegType::kNone), //! Zero group by default (defaults to GP). kGroup = uint32_t(RegGroup::kGp), //! No size by default. kSize = 0, //! Empty signature by default (not even having operand type set to register). kSignature = 0 }; }; //! \endcond //! Physical or virtual register operand. class BaseReg : public Operand { public: //! \name Constants //! \{ enum : uint32_t { //! None or any register (mostly internal). kIdBad = 0xFFu, kBaseSignatureMask = Signature::kOpTypeMask | Signature::kRegTypeMask | Signature::kRegGroupMask | Signature::kSizeMask, kTypeNone = uint32_t(RegType::kNone), kSignature = Signature::fromOpType(OperandType::kReg).bits() }; //! \} //! \name Construction & Destruction //! \{ //! Creates a dummy register operand. inline constexpr BaseReg() noexcept : Operand(Globals::Init, Signature::fromOpType(OperandType::kReg), kIdBad, 0, 0) {} //! Creates a new register operand which is the same as `other` . inline constexpr BaseReg(const BaseReg& other) noexcept : Operand(other) {} //! Creates a new register operand compatible with `other`, but with a different `id`. inline constexpr BaseReg(const BaseReg& other, uint32_t id) noexcept : Operand(Globals::Init, other._signature, id, 0, 0) {} //! Creates a register initialized to the given `signature` and `id`. inline constexpr BaseReg(const Signature& signature, uint32_t id) noexcept : Operand(Globals::Init, signature, id, 0, 0) {} inline explicit BaseReg(Globals::NoInit_) noexcept : Operand(Globals::NoInit) {} //! \} //! \name Overloaded Operators //! \{ inline BaseReg& operator=(const BaseReg& other) noexcept = default; //! \} //! \name Accessors //! \{ //! Returns base signature of the register associated with each register type. //! //! Base signature only contains the operand type, register type, register group, and register size. It doesn't //! contain element type, predicate, or other architecture-specific data. Base signature is a signature that is //! provided by architecture-specific `RegTraits`, like \ref x86::RegTraits. inline constexpr OperandSignature baseSignature() const noexcept { return _signature & kBaseSignatureMask; } //! Tests whether the operand's base signature matches the given signature `sign`. inline constexpr bool hasBaseSignature(uint32_t signature) const noexcept { return baseSignature() == signature; } //! Tests whether the operand's base signature matches the given signature `sign`. inline constexpr bool hasBaseSignature(const OperandSignature& signature) const noexcept { return baseSignature() == signature; } //! Tests whether the operand's base signature matches the base signature of the `other` operand. inline constexpr bool hasBaseSignature(const BaseReg& other) const noexcept { return baseSignature() == other.baseSignature(); } //! Tests whether this register is the same as `other`. //! //! This is just an optimization. Registers by default only use the first 8 bytes of Operand data, so this method //! takes advantage of this knowledge and only compares these 8 bytes. If both operands were created correctly //! both \ref equals() and \ref isSame() should give the same answer, however, if any of these two contains garbage //! or other metadata in the upper 8 bytes then \ref isSame() may return `true` in cases in which \ref equals() //! returns false. inline constexpr bool isSame(const BaseReg& other) const noexcept { return (_signature == other._signature) & (_baseId == other._baseId); } //! Tests whether the register is valid (either virtual or physical). inline constexpr bool isValid() const noexcept { return (_signature != 0) & (_baseId != kIdBad); } //! Tests whether this is a physical register. inline constexpr bool isPhysReg() const noexcept { return _baseId < kIdBad; } //! Tests whether this is a virtual register. inline constexpr bool isVirtReg() const noexcept { return _baseId > kIdBad; } //! Tests whether the register type matches `type` - same as `isReg(type)`, provided for convenience. inline constexpr bool isType(RegType type) const noexcept { return _signature.subset(Signature::kRegTypeMask) == Signature::fromRegType(type); } //! Tests whether the register group matches `group`. inline constexpr bool isGroup(RegGroup group) const noexcept { return _signature.subset(Signature::kRegGroupMask) == Signature::fromRegGroup(group); } //! Tests whether the register is a general purpose register (any size). inline constexpr bool isGp() const noexcept { return isGroup(RegGroup::kGp); } //! Tests whether the register is a vector register. inline constexpr bool isVec() const noexcept { return isGroup(RegGroup::kVec); } using Operand_::isReg; //! Same as `isType()`, provided for convenience. inline constexpr bool isReg(RegType rType) const noexcept { return isType(rType); } //! Tests whether the register type matches `type` and register id matches `id`. inline constexpr bool isReg(RegType rType, uint32_t id) const noexcept { return isType(rType) && this->id() == id; } //! Returns the register type. inline constexpr RegType type() const noexcept { return _signature.regType(); } //! Returns the register group. inline constexpr RegGroup group() const noexcept { return _signature.regGroup(); } //! Returns operation predicate of the register (ARM/AArch64). //! //! The meaning depends on architecture, for example on ARM hardware this describes \ref arm::ShiftOp //! of the register. inline constexpr uint32_t predicate() const noexcept { return _signature.getField(); } //! Sets operation predicate of the register to `predicate` (ARM/AArch64). //! //! The meaning depends on architecture, for example on ARM hardware this describes \ref arm::ShiftOp //! of the register. inline void setPredicate(uint32_t predicate) noexcept { _signature.setField(predicate); } //! Resets shift operation type of the register to the default value (ARM/AArch64). inline void resetPredicate() noexcept { _signature.setField(0); } //! Clones the register operand. inline constexpr BaseReg clone() const noexcept { return BaseReg(*this); } //! Casts this register to `RegT` by also changing its signature. //! //! \note Improper use of `cloneAs()` can lead to hard-to-debug errors. template inline constexpr RegT cloneAs() const noexcept { return RegT(Signature(RegT::kSignature), id()); } //! Casts this register to `other` by also changing its signature. //! //! \note Improper use of `cloneAs()` can lead to hard-to-debug errors. template inline constexpr RegT cloneAs(const RegT& other) const noexcept { return RegT(other.signature(), id()); } //! Sets the register id to `id`. inline void setId(uint32_t id) noexcept { _baseId = id; } //! Sets a 32-bit operand signature based on traits of `RegT`. template inline void setSignatureT() noexcept { _signature = RegT::kSignature; } //! Sets the register `signature` and `id`. inline void setSignatureAndId(const OperandSignature& signature, uint32_t id) noexcept { _signature = signature; _baseId = id; } //! \} //! \name Static Functions //! \{ //! Tests whether the `op` operand is a general purpose register. static inline bool isGp(const Operand_& op) noexcept { // Check operand type and register group. Not interested in register type and size. return op.signature().subset(Signature::kOpTypeMask | Signature::kRegGroupMask) == (Signature::fromOpType(OperandType::kReg) | Signature::fromRegGroup(RegGroup::kGp)); } //! Tests whether the `op` operand is a vector register. static inline bool isVec(const Operand_& op) noexcept { // Check operand type and register group. Not interested in register type and size. return op.signature().subset(Signature::kOpTypeMask | Signature::kRegGroupMask) == (Signature::fromOpType(OperandType::kReg) | Signature::fromRegGroup(RegGroup::kVec)); } //! Tests whether the `op` is a general purpose register of the given `id`. static inline bool isGp(const Operand_& op, uint32_t id) noexcept { return bool(unsigned(isGp(op)) & unsigned(op.id() == id)); } //! Tests whether the `op` is a vector register of the given `id`. static inline bool isVec(const Operand_& op, uint32_t id) noexcept { return bool(unsigned(isVec(op)) & unsigned(op.id() == id)); } //! \} }; //! RegOnly is 8-byte version of `BaseReg` that allows to store either register or nothing. //! //! It's designed to decrease the space consumed by an extra "operand" in \ref BaseEmitter and \ref InstNode. struct RegOnly { //! \name Types //! \{ typedef OperandSignature Signature; //! \} //! Operand signature - only \ref OperandType::kNone and \ref OperandType::kReg are supported. Signature _signature; //! Physical or virtual register id. uint32_t _id; //! \name Construction & Destruction //! \{ //! Initializes the `RegOnly` instance to hold register `signature` and `id`. inline void init(const OperandSignature& signature, uint32_t id) noexcept { _signature = signature; _id = id; } inline void init(const BaseReg& reg) noexcept { init(reg.signature(), reg.id()); } inline void init(const RegOnly& reg) noexcept { init(reg.signature(), reg.id()); } //! Resets the `RegOnly` members to zeros (none). inline void reset() noexcept { init(Signature::fromBits(0), 0); } //! \} //! \name Accessors //! \{ //! Tests whether this ExtraReg is none (same as calling `Operand_::isNone()`). inline constexpr bool isNone() const noexcept { return _signature == 0; } //! Tests whether the register is valid (either virtual or physical). inline constexpr bool isReg() const noexcept { return _signature != 0; } //! Tests whether this is a physical register. inline constexpr bool isPhysReg() const noexcept { return _id < BaseReg::kIdBad; } //! Tests whether this is a virtual register (used by `BaseCompiler`). inline constexpr bool isVirtReg() const noexcept { return _id > BaseReg::kIdBad; } //! Returns the register signature or 0 if no register is assigned. inline constexpr OperandSignature signature() const noexcept { return _signature; } //! Returns the register id. //! //! \note Always check whether the register is assigned before using the returned identifier as //! non-assigned `RegOnly` instance would return zero id, which is still a valid register id. inline constexpr uint32_t id() const noexcept { return _id; } //! Sets the register id. inline void setId(uint32_t id) noexcept { _id = id; } //! Returns the register type. inline constexpr RegType type() const noexcept { return _signature.regType(); } //! Returns the register group. inline constexpr RegGroup group() const noexcept { return _signature.regGroup(); } //! \} //! \name Utilities //! \{ //! Converts this ExtraReg to a real `RegT` operand. template inline constexpr RegT toReg() const noexcept { return RegT(_signature, _id); } //! \} }; //! \cond INTERNAL //! Adds a template specialization for `REG_TYPE` into the local `RegTraits`. #define ASMJIT_DEFINE_REG_TRAITS(REG, REG_TYPE, GROUP, SIZE, COUNT, TYPE_ID) \ template<> \ struct RegTraits { \ typedef REG RegT; \ \ static constexpr uint32_t kValid = 1; \ static constexpr uint32_t kCount = COUNT; \ static constexpr RegType kType = REG_TYPE; \ static constexpr RegGroup kGroup = GROUP; \ static constexpr uint32_t kSize = SIZE; \ static constexpr TypeId kTypeId = TYPE_ID; \ \ static constexpr uint32_t kSignature = \ (OperandSignature::fromOpType(OperandType::kReg) | \ OperandSignature::fromRegType(kType) | \ OperandSignature::fromRegGroup(kGroup) | \ OperandSignature::fromSize(kSize)).bits(); \ \ } //! Adds constructors and member functions to a class that implements abstract register. Abstract register is register //! that doesn't have type or signature yet, it's a base class like `x86::Reg` or `arm::Reg`. #define ASMJIT_DEFINE_ABSTRACT_REG(REG, BASE) \ public: \ /*! Default constructor that only setups basics. */ \ inline constexpr REG() noexcept \ : BASE(Signature{kSignature}, kIdBad) {} \ \ /*! Makes a copy of the `other` register operand. */ \ inline constexpr REG(const REG& other) noexcept \ : BASE(other) {} \ \ /*! Makes a copy of the `other` register having id set to `id` */ \ inline constexpr REG(const BaseReg& other, uint32_t id) noexcept \ : BASE(other, id) {} \ \ /*! Creates a register based on `signature` and `id`. */ \ inline constexpr REG(const OperandSignature& sgn, uint32_t id) noexcept \ : BASE(sgn, id) {} \ \ /*! Creates a completely uninitialized REG register operand (garbage). */ \ inline explicit REG(Globals::NoInit_) noexcept \ : BASE(Globals::NoInit) {} \ \ /*! Creates a new register from register type and id. */ \ static inline REG fromTypeAndId(RegType type, uint32_t id) noexcept { \ return REG(signatureOf(type), id); \ } \ \ /*! Clones the register operand. */ \ inline constexpr REG clone() const noexcept { return REG(*this); } \ \ inline REG& operator=(const REG& other) noexcept = default; //! Adds constructors and member functions to a class that implements final register. Final registers MUST HAVE a valid //! signature. #define ASMJIT_DEFINE_FINAL_REG(REG, BASE, TRAITS) \ public: \ static constexpr RegType kThisType = TRAITS::kType; \ static constexpr RegGroup kThisGroup = TRAITS::kGroup; \ static constexpr uint32_t kThisSize = TRAITS::kSize; \ static constexpr uint32_t kSignature = TRAITS::kSignature; \ \ ASMJIT_DEFINE_ABSTRACT_REG(REG, BASE) \ \ /*! Creates a register operand having its id set to `id`. */ \ inline constexpr explicit REG(uint32_t id) noexcept \ : BASE(Signature{kSignature}, id) {} //! \endcond //! Base class for all memory operands. //! //! The data is split into the following parts: //! //! - BASE - Base register or label - requires 36 bits total. 4 bits are used to encode the type of the BASE operand //! (label vs. register type) and the remaining 32 bits define the BASE id, which can be a physical or virtual //! register index. If BASE type is zero, which is never used as a register type and label doesn't use it as well //! then BASE field contains a high DWORD of a possible 64-bit absolute address, which is possible on X64. //! //! - INDEX - Index register (or theoretically Label, which doesn't make sense). Encoding is similar to BASE - it //! also requires 36 bits and splits the encoding to INDEX type (4 bits defining the register type) and 32-bit id. //! //! - OFFSET - A relative offset of the address. Basically if BASE is specified the relative displacement adjusts //! BASE and an optional INDEX. if BASE is not specified then the OFFSET should be considered as ABSOLUTE address //! (at least on X86). In that case its low 32 bits are stored in DISPLACEMENT field and the remaining high 32 //! bits are stored in BASE. //! //! - OTHER - There is rest 8 bits that can be used for whatever purpose. For example \ref x86::Mem operand uses //! these bits to store segment override prefix and index shift (or scale). class BaseMem : public Operand { public: //! \name Construction & Destruction //! \{ //! Creates a default `BaseMem` operand, that points to [0]. inline constexpr BaseMem() noexcept : Operand(Globals::Init, Signature::fromOpType(OperandType::kMem), 0, 0, 0) {} //! Creates a `BaseMem` operand that is a clone of `other`. inline constexpr BaseMem(const BaseMem& other) noexcept : Operand(other) {} //! Creates a `BaseMem` operand from `baseReg` and `offset`. //! //! \note This is an architecture independent constructor that can be used to create an architecture //! independent memory operand to be used in portable code that can handle multiple architectures. inline constexpr explicit BaseMem(const BaseReg& baseReg, int32_t offset = 0) noexcept : Operand(Globals::Init, Signature::fromOpType(OperandType::kMem) | Signature::fromMemBaseType(baseReg.type()), baseReg.id(), 0, uint32_t(offset)) {} //! \cond INTERNAL //! Creates a `BaseMem` operand from 4 integers as used by `Operand_` struct. inline constexpr BaseMem(const OperandSignature& u0, uint32_t baseId, uint32_t indexId, int32_t offset) noexcept : Operand(Globals::Init, u0, baseId, indexId, uint32_t(offset)) {} //! \endcond //! Creates a completely uninitialized `BaseMem` operand. inline explicit BaseMem(Globals::NoInit_) noexcept : Operand(Globals::NoInit) {} //! Resets the memory operand - after the reset the memory points to [0]. inline void reset() noexcept { _signature = Signature::fromOpType(OperandType::kMem); _baseId = 0; _data[0] = 0; _data[1] = 0; } //! \} //! \name Overloaded Operators //! \{ inline BaseMem& operator=(const BaseMem& other) noexcept { copyFrom(other); return *this; } //! \} //! \name Accessors //! \{ //! Clones the memory operand. inline constexpr BaseMem clone() const noexcept { return BaseMem(*this); } //! Creates a new copy of this memory operand adjusted by `off`. inline BaseMem cloneAdjusted(int64_t off) const noexcept { BaseMem result(*this); result.addOffset(off); return result; } //! Tests whether this memory operand is a register home (only used by \ref asmjit_compiler) inline constexpr bool isRegHome() const noexcept { return _signature.hasField(); } //! Mark this memory operand as register home (only used by \ref asmjit_compiler). inline void setRegHome() noexcept { _signature |= Signature::kMemRegHomeFlag; } //! Marks this operand to not be a register home (only used by \ref asmjit_compiler). inline void clearRegHome() noexcept { _signature &= ~Signature::kMemRegHomeFlag; } //! Tests whether the memory operand has a BASE register or label specified. inline constexpr bool hasBase() const noexcept { return (_signature & Signature::kMemBaseTypeMask) != 0; } //! Tests whether the memory operand has an INDEX register specified. inline constexpr bool hasIndex() const noexcept { return (_signature & Signature::kMemIndexTypeMask) != 0; } //! Tests whether the memory operand has BASE or INDEX register. inline constexpr bool hasBaseOrIndex() const noexcept { return (_signature & Signature::kMemBaseIndexMask) != 0; } //! Tests whether the memory operand has BASE and INDEX register. inline constexpr bool hasBaseAndIndex() const noexcept { return (_signature & Signature::kMemBaseTypeMask) != 0 && (_signature & Signature::kMemIndexTypeMask) != 0; } //! Tests whether the BASE operand is a label. inline constexpr bool hasBaseLabel() const noexcept { return _signature.subset(Signature::kMemBaseTypeMask) == Signature::fromMemBaseType(RegType::kLabelTag); } //! Tests whether the BASE operand is a register (registers start after `RegType::kLabelTag`). inline constexpr bool hasBaseReg() const noexcept { return _signature.subset(Signature::kMemBaseTypeMask).bits() > Signature::fromMemBaseType(RegType::kLabelTag).bits(); } //! Tests whether the INDEX operand is a register (registers start after `RegType::kLabelTag`). inline constexpr bool hasIndexReg() const noexcept { return _signature.subset(Signature::kMemIndexTypeMask).bits() > Signature::fromMemIndexType(RegType::kLabelTag).bits(); } //! Returns the type of the BASE register (0 if this memory operand doesn't use the BASE register). //! //! \note If the returned type is one (a value never associated to a register type) the BASE is not register, but it //! is a label. One equals to `kLabelTag`. You should always check `hasBaseLabel()` before using `baseId()` result. inline constexpr RegType baseType() const noexcept { return _signature.memBaseType(); } //! Returns the type of an INDEX register (0 if this memory operand doesn't //! use the INDEX register). inline constexpr RegType indexType() const noexcept { return _signature.memIndexType(); } //! This is used internally for BASE+INDEX validation. inline constexpr uint32_t baseAndIndexTypes() const noexcept { return _signature.getField(); } //! Returns both BASE (4:0 bits) and INDEX (9:5 bits) types combined into a single value. //! //! \remarks Returns id of the BASE register or label (if the BASE was specified as label). inline constexpr uint32_t baseId() const noexcept { return _baseId; } //! Returns the id of the INDEX register. inline constexpr uint32_t indexId() const noexcept { return _data[kDataMemIndexId]; } //! Sets the id of the BASE register (without modifying its type). inline void setBaseId(uint32_t id) noexcept { _baseId = id; } //! Sets the id of the INDEX register (without modifying its type). inline void setIndexId(uint32_t id) noexcept { _data[kDataMemIndexId] = id; } //! Sets the base register to type and id of the given `base` operand. inline void setBase(const BaseReg& base) noexcept { return _setBase(base.type(), base.id()); } //! Sets the index register to type and id of the given `index` operand. inline void setIndex(const BaseReg& index) noexcept { return _setIndex(index.type(), index.id()); } //! \cond INTERNAL inline void _setBase(RegType type, uint32_t id) noexcept { _signature.setField(uint32_t(type)); _baseId = id; } inline void _setIndex(RegType type, uint32_t id) noexcept { _signature.setField(uint32_t(type)); _data[kDataMemIndexId] = id; } //! \endcond //! Resets the memory operand's BASE register or label. inline void resetBase() noexcept { _setBase(RegType::kNone, 0); } //! Resets the memory operand's INDEX register. inline void resetIndex() noexcept { _setIndex(RegType::kNone, 0); } //! Sets the memory operand size (in bytes). inline void setSize(uint32_t size) noexcept { _signature.setField(size); } //! Tests whether the memory operand has a 64-bit offset or absolute address. //! //! If this is true then `hasBase()` must always report false. inline constexpr bool isOffset64Bit() const noexcept { return baseType() == RegType::kNone; } //! Tests whether the memory operand has a non-zero offset or absolute address. inline constexpr bool hasOffset() const noexcept { return (_data[kDataMemOffsetLo] | uint32_t(_baseId & Support::bitMaskFromBool(isOffset64Bit()))) != 0; } //! Returns either relative offset or absolute address as 64-bit integer. inline constexpr int64_t offset() const noexcept { return isOffset64Bit() ? int64_t(uint64_t(_data[kDataMemOffsetLo]) | (uint64_t(_baseId) << 32)) : int64_t(int32_t(_data[kDataMemOffsetLo])); // Sign extend 32-bit offset. } //! Returns a 32-bit low part of a 64-bit offset or absolute address. inline constexpr int32_t offsetLo32() const noexcept { return int32_t(_data[kDataMemOffsetLo]); } //! Returns a 32-but high part of a 64-bit offset or absolute address. //! //! \note This function is UNSAFE and returns garbage if `isOffset64Bit()` //! returns false. Never use it blindly without checking it first. inline constexpr int32_t offsetHi32() const noexcept { return int32_t(_baseId); } //! Sets a 64-bit offset or an absolute address to `offset`. //! //! \note This functions attempts to set both high and low parts of a 64-bit offset, however, if the operand has //! a BASE register it will store only the low 32 bits of the offset / address as there is no way to store both //! BASE and 64-bit offset, and there is currently no architecture that has such capability targeted by AsmJit. inline void setOffset(int64_t offset) noexcept { uint32_t lo = uint32_t(uint64_t(offset) & 0xFFFFFFFFu); uint32_t hi = uint32_t(uint64_t(offset) >> 32); uint32_t hiMsk = Support::bitMaskFromBool(isOffset64Bit()); _data[kDataMemOffsetLo] = lo; _baseId = (hi & hiMsk) | (_baseId & ~hiMsk); } //! Sets a low 32-bit offset to `offset` (don't use without knowing how BaseMem works). inline void setOffsetLo32(int32_t offset) noexcept { _data[kDataMemOffsetLo] = uint32_t(offset); } //! Adjusts the offset by `offset`. //! //! \note This is a fast function that doesn't use the HI 32-bits of a 64-bit offset. Use it only if you know that //! there is a BASE register and the offset is only 32 bits anyway. //! Adjusts the memory operand offset by a `offset`. inline void addOffset(int64_t offset) noexcept { if (isOffset64Bit()) { int64_t result = offset + int64_t(uint64_t(_data[kDataMemOffsetLo]) | (uint64_t(_baseId) << 32)); _data[kDataMemOffsetLo] = uint32_t(uint64_t(result) & 0xFFFFFFFFu); _baseId = uint32_t(uint64_t(result) >> 32); } else { _data[kDataMemOffsetLo] += uint32_t(uint64_t(offset) & 0xFFFFFFFFu); } } //! Adds `offset` to a low 32-bit offset part (don't use without knowing how BaseMem works). inline void addOffsetLo32(int32_t offset) noexcept { _data[kDataMemOffsetLo] += uint32_t(offset); } //! Resets the memory offset to zero. inline void resetOffset() noexcept { setOffset(0); } //! Resets the lo part of the memory offset to zero (don't use without knowing how BaseMem works). inline void resetOffsetLo32() noexcept { setOffsetLo32(0); } //! \} }; //! Type of the an immediate value. enum class ImmType : uint32_t { //! Immediate is integer. kInt = 0, //! Immediate is a floating point stored as double-precision. kDouble = 1 }; //! Immediate operands are encoded with instruction data. class Imm : public Operand { public: //! \cond INTERNAL template struct IsConstexprConstructibleAsImmType : public std::integral_constant::value || std::is_pointer::value || std::is_integral::value || std::is_function::value> {}; template struct IsConvertibleToImmType : public std::integral_constant::value || std::is_floating_point::value> {}; //! \endcond //! \name Construction & Destruction //! \{ //! Creates a new immediate value (initial value is 0). inline constexpr Imm() noexcept : Operand(Globals::Init, Signature::fromOpType(OperandType::kImm), 0, 0, 0) {} //! Creates a new immediate value from `other`. inline constexpr Imm(const Imm& other) noexcept : Operand(other) {} //! Creates a new immediate value from ARM/AArch64 specific `shift`. inline constexpr Imm(const arm::Shift& shift) noexcept : Operand(Globals::Init, Signature::fromOpType(OperandType::kImm) | Signature::fromPredicate(uint32_t(shift.op())), 0, Support::unpackU32At0(shift.value()), Support::unpackU32At1(shift.value())) {} //! Creates a new signed immediate value, assigning the value to `val` and an architecture-specific predicate //! to `predicate`. //! //! \note Predicate is currently only used by ARM architectures. template::type>::value>::type> inline constexpr Imm(const T& val, const uint32_t predicate = 0) noexcept : Operand(Globals::Init, Signature::fromOpType(OperandType::kImm) | Signature::fromPredicate(predicate), 0, Support::unpackU32At0(int64_t(val)), Support::unpackU32At1(int64_t(val))) {} inline Imm(const float& val, const uint32_t predicate = 0) noexcept : Operand(Globals::Init, Signature::fromOpType(OperandType::kImm) | Signature::fromPredicate(predicate), 0, 0, 0) { setValue(val); } inline Imm(const double& val, const uint32_t predicate = 0) noexcept : Operand(Globals::Init, Signature::fromOpType(OperandType::kImm) | Signature::fromPredicate(predicate), 0, 0, 0) { setValue(val); } inline explicit Imm(Globals::NoInit_) noexcept : Operand(Globals::NoInit) {} //! \} //! \name Overloaded Operators //! \{ //! Assigns the value of the `other` operand to this immediate. inline Imm& operator=(const Imm& other) noexcept { copyFrom(other); return *this; } //! \} //! \name Accessors //! \{ //! Returns immediate type. inline constexpr ImmType type() const noexcept { return (ImmType)_signature.getField(); } //! Sets the immediate type to `type`. inline void setType(ImmType type) noexcept { _signature.setField(uint32_t(type)); } //! Resets immediate type to \ref ImmType::kInt. inline void resetType() noexcept { setType(ImmType::kInt); } //! Returns operation predicate of the immediate. //! //! The meaning depends on architecture, for example on ARM hardware this describes \ref arm::ShiftOp //! of the immediate. inline constexpr uint32_t predicate() const noexcept { return _signature.getField(); } //! Sets operation predicate of the immediate to `predicate`. //! //! The meaning depends on architecture, for example on ARM hardware this describes \ref arm::ShiftOp //! of the immediate. inline void setPredicate(uint32_t predicate) noexcept { _signature.setField(predicate); } //! Resets the shift operation type of the immediate to the default value (no operation). inline void resetPredicate() noexcept { _signature.setField(0); } //! Returns the immediate value as `int64_t`, which is the internal format Imm uses. inline constexpr int64_t value() const noexcept { return int64_t((uint64_t(_data[kDataImmValueHi]) << 32) | _data[kDataImmValueLo]); } //! Tests whether this immediate value is integer of any size. inline constexpr uint32_t isInt() const noexcept { return type() == ImmType::kInt; } //! Tests whether this immediate value is a double precision floating point value. inline constexpr uint32_t isDouble() const noexcept { return type() == ImmType::kDouble; } //! Tests whether the immediate can be casted to 8-bit signed integer. inline constexpr bool isInt8() const noexcept { return type() == ImmType::kInt && Support::isInt8(value()); } //! Tests whether the immediate can be casted to 8-bit unsigned integer. inline constexpr bool isUInt8() const noexcept { return type() == ImmType::kInt && Support::isUInt8(value()); } //! Tests whether the immediate can be casted to 16-bit signed integer. inline constexpr bool isInt16() const noexcept { return type() == ImmType::kInt && Support::isInt16(value()); } //! Tests whether the immediate can be casted to 16-bit unsigned integer. inline constexpr bool isUInt16() const noexcept { return type() == ImmType::kInt && Support::isUInt16(value()); } //! Tests whether the immediate can be casted to 32-bit signed integer. inline constexpr bool isInt32() const noexcept { return type() == ImmType::kInt && Support::isInt32(value()); } //! Tests whether the immediate can be casted to 32-bit unsigned integer. inline constexpr bool isUInt32() const noexcept { return type() == ImmType::kInt && _data[kDataImmValueHi] == 0; } //! Returns the immediate value casted to `T`. //! //! The value is masked before it's casted to `T` so the returned value is simply the representation of `T` //! considering the original value's lowest bits. template inline T valueAs() const noexcept { return Support::immediateToT(value()); } //! Returns low 32-bit signed integer. inline constexpr int32_t int32Lo() const noexcept { return int32_t(_data[kDataImmValueLo]); } //! Returns high 32-bit signed integer. inline constexpr int32_t int32Hi() const noexcept { return int32_t(_data[kDataImmValueHi]); } //! Returns low 32-bit signed integer. inline constexpr uint32_t uint32Lo() const noexcept { return _data[kDataImmValueLo]; } //! Returns high 32-bit signed integer. inline constexpr uint32_t uint32Hi() const noexcept { return _data[kDataImmValueHi]; } //! Sets immediate value to `val`, the value is casted to a signed 64-bit integer. template inline void setValue(const T& val) noexcept { _setValueInternal(Support::immediateFromT(val), std::is_floating_point::value ? ImmType::kDouble : ImmType::kInt); } inline void _setValueInternal(int64_t val, ImmType type) noexcept { setType(type); _data[kDataImmValueHi] = uint32_t(uint64_t(val) >> 32); _data[kDataImmValueLo] = uint32_t(uint64_t(val) & 0xFFFFFFFFu); } //! \} //! \name Utilities //! \{ //! Clones the immediate operand. inline constexpr Imm clone() const noexcept { return Imm(*this); } inline void signExtend8Bits() noexcept { setValue(int64_t(valueAs())); } inline void signExtend16Bits() noexcept { setValue(int64_t(valueAs())); } inline void signExtend32Bits() noexcept { setValue(int64_t(valueAs())); } inline void zeroExtend8Bits() noexcept { setValue(valueAs()); } inline void zeroExtend16Bits() noexcept { setValue(valueAs()); } inline void zeroExtend32Bits() noexcept { _data[kDataImmValueHi] = 0u; } //! \} }; //! Creates a new immediate operand. template static inline constexpr Imm imm(const T& val) noexcept { return Imm(val); } //! \} namespace Globals { //! \ingroup asmjit_assembler //! //! A default-constructed operand of `Operand_::kOpNone` type. static constexpr const Operand none; } //! \cond INTERNAL namespace Support { template struct ForwardOpImpl { static inline const T& forward(const T& value) noexcept { return value; } }; template struct ForwardOpImpl { static inline Imm forward(const T& value) noexcept { return Imm(value); } }; //! Either forwards operand T or returns a new operand that wraps it if T is a type convertible to operand. //! At the moment this is only used to convert integers, floats, and enumarations to \ref Imm operands. template struct ForwardOp : public ForwardOpImpl::type>::value> {}; } // {Support} //! \endcond ASMJIT_END_NAMESPACE #endif // ASMJIT_CORE_OPERAND_H_INCLUDED