crabstone 3.0.3 → 4.0.4

data/lib/crabstone/arch/4/xcore.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+# THIS FILE WAS AUTO-GENERATED -- DO NOT EDIT!
+
+require 'ffi'
+
+require 'crabstone/arch/extension'
+require_relative 'xcore_const'
+
+module Crabstone
+  module XCore
+    class OperandMemory < FFI::Struct
+      layout(
+        :base, :uint8,
+        :index, :uint8,
+        :disp, :int,
+        :direct, :int
+      )
+    end
+
+    class OperandValue < FFI::Union
+      layout(
+        :reg, :uint,
+        :imm, :int,
+        :mem, OperandMemory
+      )
+    end
+
+    class Operand < FFI::Struct
+      layout(
+        :type, :uint,
+        :value, OperandValue
+      )
+
+      include Crabstone::Extension::Operand
+
+      def reg?
+        self[:type] == OP_REG
+      end
+
+      def imm?
+        self[:type] == OP_IMM
+      end
+
+      def mem?
+        self[:type] == OP_MEM
+      end
+    end
+
+    class Instruction < FFI::Struct
+      layout(
+        :op_count, :uint8,
+        :operands, [Operand, 8]
+      )
+
+      include Crabstone::Extension::Instruction
+    end
+  end
+end

data/lib/crabstone/arch/4/xcore_const.rb

@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+
+# THIS FILE WAS AUTO-GENERATED -- DO NOT EDIT!
+
+require 'crabstone/arch/register'
+
+module Crabstone
+  module XCore
+    OP_INVALID = 0
+    OP_REG = 1
+    OP_IMM = 2
+    OP_MEM = 3
+
+    REG_INVALID = 0
+    REG_CP = 1
+    REG_DP = 2
+    REG_LR = 3
+    REG_SP = 4
+    REG_R0 = 5
+    REG_R1 = 6
+    REG_R2 = 7
+    REG_R3 = 8
+    REG_R4 = 9
+    REG_R5 = 10
+    REG_R6 = 11
+    REG_R7 = 12
+    REG_R8 = 13
+    REG_R9 = 14
+    REG_R10 = 15
+    REG_R11 = 16
+    REG_PC = 17
+    REG_SCP = 18
+    REG_SSR = 19
+    REG_ET = 20
+    REG_ED = 21
+    REG_SED = 22
+    REG_KEP = 23
+    REG_KSP = 24
+    REG_ID = 25
+    REG_ENDING = 26
+
+    INS_INVALID = 0
+    INS_ADD = 1
+    INS_ANDNOT = 2
+    INS_AND = 3
+    INS_ASHR = 4
+    INS_BAU = 5
+    INS_BITREV = 6
+    INS_BLA = 7
+    INS_BLAT = 8
+    INS_BL = 9
+    INS_BF = 10
+    INS_BT = 11
+    INS_BU = 12
+    INS_BRU = 13
+    INS_BYTEREV = 14
+    INS_CHKCT = 15
+    INS_CLRE = 16
+    INS_CLRPT = 17
+    INS_CLRSR = 18
+    INS_CLZ = 19
+    INS_CRC8 = 20
+    INS_CRC32 = 21
+    INS_DCALL = 22
+    INS_DENTSP = 23
+    INS_DGETREG = 24
+    INS_DIVS = 25
+    INS_DIVU = 26
+    INS_DRESTSP = 27
+    INS_DRET = 28
+    INS_ECALLF = 29
+    INS_ECALLT = 30
+    INS_EDU = 31
+    INS_EEF = 32
+    INS_EET = 33
+    INS_EEU = 34
+    INS_ENDIN = 35
+    INS_ENTSP = 36
+    INS_EQ = 37
+    INS_EXTDP = 38
+    INS_EXTSP = 39
+    INS_FREER = 40
+    INS_FREET = 41
+    INS_GETD = 42
+    INS_GET = 43
+    INS_GETN = 44
+    INS_GETR = 45
+    INS_GETSR = 46
+    INS_GETST = 47
+    INS_GETTS = 48
+    INS_INCT = 49
+    INS_INIT = 50
+    INS_INPW = 51
+    INS_INSHR = 52
+    INS_INT = 53
+    INS_IN = 54
+    INS_KCALL = 55
+    INS_KENTSP = 56
+    INS_KRESTSP = 57
+    INS_KRET = 58
+    INS_LADD = 59
+    INS_LD16S = 60
+    INS_LD8U = 61
+    INS_LDA16 = 62
+    INS_LDAP = 63
+    INS_LDAW = 64
+    INS_LDC = 65
+    INS_LDW = 66
+    INS_LDIVU = 67
+    INS_LMUL = 68
+    INS_LSS = 69
+    INS_LSUB = 70
+    INS_LSU = 71
+    INS_MACCS = 72
+    INS_MACCU = 73
+    INS_MJOIN = 74
+    INS_MKMSK = 75
+    INS_MSYNC = 76
+    INS_MUL = 77
+    INS_NEG = 78
+    INS_NOT = 79
+    INS_OR = 80
+    INS_OUTCT = 81
+    INS_OUTPW = 82
+    INS_OUTSHR = 83
+    INS_OUTT = 84
+    INS_OUT = 85
+    INS_PEEK = 86
+    INS_REMS = 87
+    INS_REMU = 88
+    INS_RETSP = 89
+    INS_SETCLK = 90
+    INS_SET = 91
+    INS_SETC = 92
+    INS_SETD = 93
+    INS_SETEV = 94
+    INS_SETN = 95
+    INS_SETPSC = 96
+    INS_SETPT = 97
+    INS_SETRDY = 98
+    INS_SETSR = 99
+    INS_SETTW = 100
+    INS_SETV = 101
+    INS_SEXT = 102
+    INS_SHL = 103
+    INS_SHR = 104
+    INS_SSYNC = 105
+    INS_ST16 = 106
+    INS_ST8 = 107
+    INS_STW = 108
+    INS_SUB = 109
+    INS_SYNCR = 110
+    INS_TESTCT = 111
+    INS_TESTLCL = 112
+    INS_TESTWCT = 113
+    INS_TSETMR = 114
+    INS_START = 115
+    INS_WAITEF = 116
+    INS_WAITET = 117
+    INS_WAITEU = 118
+    INS_XOR = 119
+    INS_ZEXT = 120
+    INS_ENDING = 121
+
+    GRP_INVALID = 0
+    GRP_JUMP = 1
+    GRP_ENDING = 2
+
+    extend Register
+  end
+end

data/lib/crabstone/arch/extension.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Crabstone
+  # These modules is for +class Operand+ and +class Instruction+ to extend.
+  # @private
+  module Extension
+    # For +class Operand+.
+    module Operand
+      def value
+        self[:value].class.members.find do |s|
+          return self[:value][s] if __send__("#{s}?".to_sym)
+        end
+      end
+
+      def valid?
+        !value.nil?
+      end
+    end
+
+    # For +class Instruction+.
+    module Instruction
+      def operands
+        self[:operands].take_while { |op| op[:type] != OP_INVALID }
+      end
+    end
+  end
+end

data/lib/crabstone/arch/register.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'set'
+
+module Crabstone
+  # Module for arch/<version>/<arch>_const.rb to extend.
+  module Register
+    # @param [Integer, String, Symbol] reg
+    # @return [Integer]
+    def register(reg)
+      return reg if value?(reg)
+
+      dict[reg.to_s.upcase] || invalid
+    end
+
+    private
+
+    def dict
+      return @dict if defined?(@dict)
+
+      keys = constants.select { |k| k.to_s.start_with?('REG_') }
+      @dict = keys.map { |k| [k.to_s[4..], const_get(k)] }.to_h.freeze
+    end
+
+    def value?(val)
+      @val_set ||= Set.new(dict.values)
+      @val_set.member?(val)
+    end
+
+    def invalid
+      dict['INVALID']
+    end
+  end
+end

data/lib/crabstone/arch.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'crabstone/constants'
+require 'crabstone/cs_version'
+
+# require all files under 'crabstone/arch/<cs_major_version>'
+Dir.glob(File.join(__dir__, 'arch', Crabstone.cs_major_version.to_s, '*.rb')).sort.each do |f|
+  require f
+end
+
+module Crabstone
+  module Arch
+    module_function
+
+    # @param [Integer] arch
+    # @return [Module]
+    # @example
+    #   Arch.module_of(Crabstone::ARCH_X86)
+    #   #=> Crabstone::X86
+    def module_of(arch)
+      case arch
+      when ARCH_ARM then ARM
+      when ARCH_ARM64 then ARM64
+      when ARCH_X86 then X86
+      when ARCH_MIPS then MIPS
+      when ARCH_PPC then PPC
+      when ARCH_SPARC then Sparc
+      when ARCH_SYSZ then SysZ
+      when ARCH_XCORE then XCore
+      when ARCH_M68K then M68K
+      when ARCH_TMS320C64X then TMS320C64X
+      when ARCH_M680X then M680X
+      when ARCH_EVM then EVM
+      end
+    end
+  end
+end

data/lib/crabstone/binding/3/detail.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# THIS FILE WAS AUTO-GENERATED -- DO NOT EDIT!
+
+require 'ffi'
+
+require 'crabstone/arch'
+
+module Crabstone
+  module Binding
+    class Architecture < FFI::Union
+      layout(
+        :arm, ARM::Instruction,
+        :arm64, ARM64::Instruction,
+        :mips, MIPS::Instruction,
+        :ppc, PPC::Instruction,
+        :sparc, Sparc::Instruction,
+        :sysz, SysZ::Instruction,
+        :x86, X86::Instruction,
+        :xcore, XCore::Instruction
+      )
+    end
+
+    class Detail < FFI::Struct
+      layout(
+        :regs_read, [:uint8, 12],
+        :regs_read_count, :uint8,
+        :regs_write, [:uint8, 20],
+        :regs_write_count, :uint8,
+        :groups, [:uint8, 8],
+        :groups_count, :uint8,
+        :arch, Architecture
+      )
+    end
+  end
+end

data/lib/crabstone/binding/3/instruction.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# THIS FILE WAS AUTO-GENERATED -- DO NOT EDIT!
+
+require 'ffi'
+
+require_relative 'detail'
+
+module Crabstone
+  module Binding
+    class Instruction < FFI::ManagedStruct
+      layout(
+        :id, :uint32,
+        :address, :uint64,
+        :size, :uint16,
+        :bytes, [:uint8, 16],
+        :mnemonic, [:char, 32],
+        :op_str, [:char, 160],
+        :detail, Detail.by_ref
+      )
+    end
+  end
+end

data/lib/crabstone/binding/4/detail.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# THIS FILE WAS AUTO-GENERATED -- DO NOT EDIT!
+
+require 'ffi'
+
+require 'crabstone/arch'
+
+module Crabstone
+  module Binding
+    class Architecture < FFI::Union
+      layout(
+        :arm, ARM::Instruction,
+        :arm64, ARM64::Instruction,
+        :evm, EVM::Instruction,
+        :m680x, M680X::Instruction,
+        :m68k, M68K::Instruction,
+        :mips, MIPS::Instruction,
+        :ppc, PPC::Instruction,
+        :sparc, Sparc::Instruction,
+        :sysz, SysZ::Instruction,
+        :tms320c64x, TMS320C64X::Instruction,
+        :x86, X86::Instruction,
+        :xcore, XCore::Instruction
+      )
+    end
+
+    class Detail < FFI::Struct
+      layout(
+        :regs_read, [:uint16, 12],
+        :regs_read_count, :uint8,
+        :regs_write, [:uint16, 20],
+        :regs_write_count, :uint8,
+        :groups, [:uint8, 8],
+        :groups_count, :uint8,
+        :arch, Architecture
+      )
+    end
+  end
+end

data/lib/crabstone/binding/4/instruction.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# THIS FILE WAS AUTO-GENERATED -- DO NOT EDIT!
+
+require 'ffi'
+
+require_relative 'detail'
+
+module Crabstone
+  module Binding
+    class Instruction < FFI::ManagedStruct
+      layout(
+        :id, :uint32,
+        :address, :uint64,
+        :size, :uint16,
+        :bytes, [:uint8, 16],
+        :mnemonic, [:char, 32],
+        :op_str, [:char, 160],
+        :detail, Detail.by_ref
+      )
+    end
+  end
+end

data/lib/crabstone/binding/structs.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'ffi'
+
+require 'crabstone/cs_version'
+Crabstone.version_require 'crabstone/binding/%v/instruction'
+
+module Crabstone
+  module Binding
+    # This is because JRuby FFI on x64 Windows thinks size_t is 32 bit
+    typedef(FFI::Platform::ADDRESS_SIZE == 32 ? :ulong : :ulong_long, :size_t)
+
+    # If one day these definitions change, move them to <version>/ dir.
+
+    typedef :size_t, :csh
+    typedef :size_t, :cs_opt_value
+    typedef :uint, :cs_opt_type
+    typedef :uint, :cs_err
+    typedef :uint, :cs_arch
+    typedef :uint, :cs_mode
+
+    callback :skipdata_cb, %i[pointer size_t size_t pointer], :size_t
+
+    class SkipdataConfig < FFI::Struct
+      layout(
+        :mnemonic, :pointer,
+        :callback, :skipdata_cb,
+        :unused, :pointer
+      )
+    end
+  end
+end

data/lib/crabstone/binding.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'crabstone/constants'
+require 'crabstone/binding/structs'
+
+module Crabstone
+  module Binding
+    class Instruction < FFI::ManagedStruct
+      def self.release(obj)
+        detail_ptr = obj.+(Instruction.offset_of(:detail)).read_pointer
+        Binding.free(detail_ptr)
+        Binding.free(obj)
+      end
+    end
+
+    # These APIs still might be changed in a new Capstone version.
+    attach_function(
+      :cs_disasm,
+      %i[csh pointer size_t ulong_long size_t pointer],
+      :size_t
+    )
+    attach_function :cs_close, [:pointer], :cs_err
+    attach_function :cs_errno, [:csh], :cs_err
+    attach_function :cs_group_name, %i[csh uint], :string
+    attach_function :cs_insn_group, [:csh, Instruction, :uint], :bool
+    attach_function :cs_insn_name, %i[csh uint], :string
+    attach_function :cs_op_count, [:csh, Instruction, :uint], :cs_err
+    attach_function :cs_open, %i[cs_arch cs_mode pointer], :cs_err
+    attach_function :cs_option, %i[csh cs_opt_type cs_opt_value], :cs_err
+    attach_function :cs_reg_name, %i[csh uint], :string
+    attach_function :cs_reg_read, [:csh, Instruction, :uint], :bool
+    attach_function :cs_reg_write, [:csh, Instruction, :uint], :bool
+    attach_function :cs_strerror, [:cs_err], :string
+    attach_function :cs_support, [:cs_arch], :bool
+    # Already defined in cs_version.rb
+    # attach_function :cs_version, %i[pointer pointer], :uint
+    attach_function :memcpy, %i[pointer pointer size_t], :pointer
+    attach_function :malloc, [:size_t], :pointer
+    attach_function :free, [:pointer], :void
+
+    # Wrap to prevent function not found in elder Capstone.
+    def self.safe_attach(*args)
+      attach_function(*args)
+    rescue FFI::NotFoundError
+    end
+
+    # New APIs since Capstone 4.
+    safe_attach :cs_regs_access, [:csh, Instruction, :pointer, :pointer, :pointer, :pointer], :cs_err
+  end
+
+  # This is a C engine build option, so we can set it here, not when we
+  # instantiate a new Disassembler.
+  # Diet mode means:
+  # - No op_str or mnemonic in Instruction
+  # - No regs_read, regs_write or groups ( even with detail on )
+  # - No reg_name or insn_name id2str convenience functions
+  # - detail mode CAN still be on - so the arch insn operands MAY be available
+  DIET_MODE = Binding.cs_support(SUPPORT_DIET)
+end

data/lib/crabstone/constants.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+# XXX: Auto-gerneate this file?
+# Constants in this file might be added in a newer Capstone version,
+# but I expect they are always backward compatible.
+
+require 'crabstone/version'
+
+module Crabstone
+  # API version
+  BINDING_MAJ = VERSION.split('.').first.to_i
+
+  # architectures
+  ARCH_ARM = 0
+  ARCH_ARM64 = 1
+  ARCH_MIPS = 2
+  ARCH_X86 = 3
+  ARCH_PPC = 4
+  ARCH_SPARC = 5
+  ARCH_SYSZ = 6
+  ARCH_XCORE = 7
+  ARCH_M68K = 8
+  ARCH_TMS320C64X = 9
+  ARCH_M680X = 10
+  ARCH_EVM = 11
+  ARCH_MAX = 12
+  ARCH_ALL = 0xFFFF
+
+  # disasm mode
+  MODE_LITTLE_ENDIAN = 0 # little-endian mode (default mode)
+  MODE_ARM = 0 # 32-bit ARM
+  MODE_16 = 1 << 1 # 16-bit mode (X86)
+  MODE_32 = 1 << 2 # 32-bit mode (X86)
+  MODE_64 = 1 << 3 # 64-bit mode (X86, PPC)
+  MODE_THUMB = 1 << 4 # ARM's Thumb mode, including Thumb-2
+  MODE_MCLASS = 1 << 5 # ARM's Cortex-M series
+  MODE_V8 = 1 << 6 # ARMv8 A32 encodings for ARM
+  MODE_MICRO = 1 << 4 # MicroMips mode (MIPS)
+  MODE_MIPS3 = 1 << 5 # Mips III ISA
+  MODE_MIPS32R6 = 1 << 6 # Mips32r6 ISA
+  MODE_MIPSGP64 = 1 << 7 # General Purpose Registers are 64-bit wide (MIPS)
+  MODE_MODE_MIPS2 = 1 << 7 # Mips II ISA
+  MODE_V9 = 1 << 4 # SparcV9 mode (Sparc)
+  MODE_QPX = 1 << 4 # Quad Processing eXtensions mode (PPC)
+  MODE_M68K_000 = 1 << 1 # M68K 68000 mode
+  MODE_M68K_010 = 1 << 2 # M68K 68010 mode
+  MODE_M68K_020 = 1 << 3 # M68K 68020 mode
+  MODE_M68K_030 = 1 << 4 # M68K 68030 mode
+  MODE_M68K_040 = 1 << 5 # M68K 68040 mode
+  MODE_M68K_060 = 1 << 6 # M68K 68060 mode
+  MODE_BIG_ENDIAN = 1 << 31 # big-endian mode
+  MODE_MIPS32 = MODE_32 # Mips32 ISA (Mips)
+  MODE_MIPS64 = MODE_64 # Mips64 ISA (Mips)
+  MODE_M680X_6301 = 1 << 1 # M680X HD6301/3 mode
+  MODE_M680X_6309 = 1 << 2 # M680X HD6309 mode
+  MODE_M680X_6800 = 1 << 3 # M680X M6800/2 mode
+  MODE_M680X_6801 = 1 << 4 # M680X M6801/3 mode
+  MODE_M680X_6805 = 1 << 5 # M680X M6805 mode
+  MODE_M680X_6808 = 1 << 6 # M680X M68HC08 mode
+  MODE_M680X_6809 = 1 << 7 # M680X M6809 mode
+  MODE_M680X_6811 = 1 << 8 # M680X M68HC11 mode
+  MODE_M680X_CPU12 = 1 << 9 # M680X CPU12 mode
+  MODE_M680X_HCS08 = 1 << 10 # M680X HCS08 mode
+
+  # Capstone option type
+  OPT_SYNTAX = 1 # Intel X86 asm syntax (ARCH_X86 arch)
+  OPT_DETAIL = 2 # Break down instruction structure into details
+  OPT_MODE = 3 # Change engine's mode at run-time
+  OPT_MEM  = 4 # Change engine's mode at run-time
+  OPT_SKIPDATA = 5 # Skip data when disassembling
+  OPT_SKIPDATA_SETUP = 6 # Setup user-defined function for SKIPDATA option
+  OPT_MNEMONIC = 7 # Customize instruction mnemonic
+  OPT_UNSIGNED = 8 # Print immediate in unsigned form
+
+  # Capstone option value
+  OPT_OFF = 0 # Turn OFF an option - default option of OPT_DETAIL
+  OPT_ON = 3 # Turn ON an option (OPT_DETAIL)
+
+  # Common instruction operand types - to be consistent across all architectures.
+  OP_INVALID = 0
+  OP_REG = 1
+  OP_IMM = 2
+  OP_MEM = 3
+  OP_FP = 4
+
+  # Common instruction groups - to be consistent across all architectures.
+  GRP_INVALID = 0 # uninitialized/invalid group.
+  GRP_JUMP = 1 # all jump instructions (conditional+direct+indirect jumps)
+  GRP_CALL = 2 # all call instructions
+  GRP_RET = 3 # all return instructions
+  GRP_INT = 4 # all interrupt instructions (int+syscall)
+  GRP_IRET = 5 # all interrupt return instructions
+  GRP_PRIVILEGE = 6 # all privileged instructions
+
+  # Access types for instruction operands.
+  AC_INVALID = 0 # Invalid/unitialized access type.
+  AC_READ = 1 << 0 # Operand that is read from.
+  AC_WRITE = 1 << 1 # Operand that is written to.
+
+  # Capstone syntax value
+  OPT_SYNTAX_DEFAULT = 0 # Default assembly syntax of all platforms (OPT_SYNTAX)
+  OPT_SYNTAX_INTEL = 1 # Intel X86 asm syntax - default syntax on X86 (OPT_SYNTAX, ARCH_X86)
+  OPT_SYNTAX_ATT = 2 # ATT asm syntax (OPT_SYNTAX, ARCH_X86)
+  OPT_SYNTAX_NOREGNAME = 3 # Asm syntax prints register name with only number - (OPT_SYNTAX, ARCH_PPC, ARCH_ARM)
+  OPT_SYNTAX_MASM = 4 # MASM syntax (CS_OPT_SYNTAX, CS_ARCH_X86)
+
+  # query id for cs_support()
+  SUPPORT_DIET = ARCH_ALL + 1
+  SUPPORT_X86_REDUCE = ARCH_ALL + 2
+end