crabstone 3.0.3 → 4.0.0

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,36 @@
+# 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)
+      if reg.is_a?(Integer)
+        value?(reg) ? reg : invalid
+      else
+        dict[reg.to_s.upcase] || invalid
+      end
+    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..-1], 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/binding.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'crabstone/constants'
+require 'crabstone/binding/structs'
+
+module Crabstone
+  module Binding
+    class Instruction < FFI::ManagedStruct
+      def self.release(obj)
+        ptr = obj.pointer
+        detail_ptr = ptr.+(Instruction.offset_of(:detail)).read_pointer
+        Binding.free(detail_ptr)
+        Binding.free(ptr)
+      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/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