crabstone 4.0.4 → 5.0.0

data/lib/crabstone/arch/5/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/5/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

@@ -8,7 +8,8 @@ module Crabstone
     module Operand
       def value
         self[:value].class.members.find do |s|
-          return self[:value][s] if __send__("#{s}?".to_sym)
+          sym = "#{s}?".to_sym
+          return self[:value][s] if respond_to?(sym) && __send__(sym)
         end
       end
 

data/lib/crabstone/arch/register.rb

@@ -19,7 +19,7 @@ module Crabstone
       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
+      @dict = keys.to_h { |k| [k.to_s[4..], const_get(k)] }.freeze
     end
 
     def value?(val)

data/lib/crabstone/arch.rb

@@ -31,6 +31,12 @@ module Crabstone
       when ARCH_TMS320C64X then TMS320C64X
       when ARCH_M680X then M680X
       when ARCH_EVM then EVM
+      when ARCH_MOS65XX then MOS65XX
+      when ARCH_WASM then WASM
+      when ARCH_BPF then BPF
+      when ARCH_RISCV then RISCV
+      when ARCH_SH then SH
+      when ARCH_TRICORE then TRICORE
       end
     end
   end

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

@@ -0,0 +1,47 @@
+# 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,
+        :bpf, BPF::Instruction,
+        :evm, EVM::Instruction,
+        :m680x, M680X::Instruction,
+        :m68k, M68K::Instruction,
+        :mips, MIPS::Instruction,
+        :mos65xx, MOS65XX::Instruction,
+        :ppc, PPC::Instruction,
+        :riscv, RISCV::Instruction,
+        :sh, SH::Instruction,
+        :sparc, Sparc::Instruction,
+        :sysz, SysZ::Instruction,
+        :tms320c64x, TMS320C64X::Instruction,
+        :tricore, TRICORE::Instruction,
+        :wasm, WASM::Instruction,
+        :x86, X86::Instruction,
+        :xcore, XCore::Instruction
+      )
+    end
+
+    class Detail < FFI::Struct
+      layout(
+        :regs_read, [:uint16, 20],
+        :regs_read_count, :uint8,
+        :regs_write, [:uint16, 20],
+        :regs_write_count, :uint8,
+        :groups, [:uint8, 8],
+        :groups_count, :uint8,
+        :writeback, :bool,
+        :arch, Architecture
+      )
+    end
+  end
+end

data/lib/crabstone/binding/5/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, 24],
+        :mnemonic, [:char, 32],
+        :op_str, [:char, 160],
+        :detail, Detail.by_ref
+      )
+    end
+  end
+end

data/lib/crabstone/binding.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'crabstone/constants'
 require 'crabstone/binding/structs'
+require 'crabstone/constants'
 
 module Crabstone
   module Binding
@@ -41,7 +41,7 @@ module Crabstone
     # Wrap to prevent function not found in elder Capstone.
     def self.safe_attach(*args)
       attach_function(*args)
-    rescue FFI::NotFoundError
+    rescue FFI::NotFoundError # rubocop: disable Lint/SuppressedException
     end
 
     # New APIs since Capstone 4.

data/lib/crabstone/constants.rb

@@ -1,110 +1,5 @@
 # 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/cs_version'
 
-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
+require File.join(__dir__, 'arch', Crabstone.cs_major_version.to_s, 'constants.rb')

data/lib/crabstone/cs_version.rb

@@ -2,7 +2,6 @@
 
 require 'ffi'
 
-require 'crabstone/constants'
 require 'crabstone/version'
 
 module Crabstone
@@ -42,7 +41,7 @@ module Crabstone
   # Checks the cs_major is less or equal to Crabstone::VERSION.
   def version_compatitable!
     @version_compatitable ||=
-      cs_major_version <= Crabstone::BINDING_MAJ && cs_major_version >= 3
+      cs_major_version <= VERSION.split('.').first.to_i && cs_major_version >= 3
     maj, min = cs_version
     raise "FATAL: Crabstone v#{VERSION} doesn't support binding Capstone v#{maj}.#{min}" unless @version_compatitable
   end
@@ -50,7 +49,7 @@ module Crabstone
   # @private
   module Binding
     extend FFI::Library
-    ffi_lib ['capstone', 'libcapstone.so.4', 'libcapstone.so.3']
+    ffi_lib ['capstone', 'libcapstone.so.5', 'libcapstone.so.4', 'libcapstone.so.3']
 
     attach_function :cs_version, %i[pointer pointer], :uint
   end

data/lib/crabstone/disassembler.rb

@@ -81,9 +81,8 @@ module Crabstone
           code = code.read_array_of_uchar(sz).pack('c*')
           begin
             Integer(yield(code, offset))
-          rescue StandardError
-            warn "Error in skipdata callback: #{$ERROR_INFO}"
-            # It will go on to crash, but now at least there's more info :)
+          rescue StandardError => e
+            raise Crabstone::ErrSkipData, "Error in skipdata callback: #{e.message}"
           end
         end
       end

data/lib/crabstone/instruction.rb

@@ -2,7 +2,6 @@
 
 require 'crabstone/arch'
 require 'crabstone/binding'
-require 'crabstone/constants'
 require 'crabstone/error'
 
 module Crabstone

data/lib/crabstone/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Crabstone
-  VERSION = '4.0.4'
+  VERSION = '5.0.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: crabstone
 version: !ruby/object:Gem::Version
-  version: 4.0.4
+  version: 5.0.0
 platform: ruby
 authors:
 - Ben Nagy
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-14 00:00:00.000000000 Z
+date: 2024-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -123,6 +123,7 @@ files:
 - lib/crabstone/arch/3/arm64.rb
 - lib/crabstone/arch/3/arm64_const.rb
 - lib/crabstone/arch/3/arm_const.rb
+- lib/crabstone/arch/3/constants.rb
 - lib/crabstone/arch/3/mips.rb
 - lib/crabstone/arch/3/mips_const.rb
 - lib/crabstone/arch/3/ppc.rb
@@ -139,6 +140,7 @@ files:
 - lib/crabstone/arch/4/arm64.rb
 - lib/crabstone/arch/4/arm64_const.rb
 - lib/crabstone/arch/4/arm_const.rb
+- lib/crabstone/arch/4/constants.rb
 - lib/crabstone/arch/4/evm.rb
 - lib/crabstone/arch/4/evm_const.rb
 - lib/crabstone/arch/4/m680x.rb
@@ -159,6 +161,43 @@ files:
 - lib/crabstone/arch/4/x86_const.rb
 - lib/crabstone/arch/4/xcore.rb
 - lib/crabstone/arch/4/xcore_const.rb
+- lib/crabstone/arch/5/arm.rb
+- lib/crabstone/arch/5/arm64.rb
+- lib/crabstone/arch/5/arm64_const.rb
+- lib/crabstone/arch/5/arm_const.rb
+- lib/crabstone/arch/5/bpf.rb
+- lib/crabstone/arch/5/bpf_const.rb
+- lib/crabstone/arch/5/constants.rb
+- lib/crabstone/arch/5/evm.rb
+- lib/crabstone/arch/5/evm_const.rb
+- lib/crabstone/arch/5/m680x.rb
+- lib/crabstone/arch/5/m680x_const.rb
+- lib/crabstone/arch/5/m68k.rb
+- lib/crabstone/arch/5/m68k_const.rb
+- lib/crabstone/arch/5/mips.rb
+- lib/crabstone/arch/5/mips_const.rb
+- lib/crabstone/arch/5/mos65xx.rb
+- lib/crabstone/arch/5/mos65xx_const.rb
+- lib/crabstone/arch/5/ppc.rb
+- lib/crabstone/arch/5/ppc_const.rb
+- lib/crabstone/arch/5/riscv.rb
+- lib/crabstone/arch/5/riscv_const.rb
+- lib/crabstone/arch/5/sh.rb
+- lib/crabstone/arch/5/sh_const.rb
+- lib/crabstone/arch/5/sparc.rb
+- lib/crabstone/arch/5/sparc_const.rb
+- lib/crabstone/arch/5/sysz.rb
+- lib/crabstone/arch/5/sysz_const.rb
+- lib/crabstone/arch/5/tms320c64x.rb
+- lib/crabstone/arch/5/tms320c64x_const.rb
+- lib/crabstone/arch/5/tricore.rb
+- lib/crabstone/arch/5/tricore_const.rb
+- lib/crabstone/arch/5/wasm.rb
+- lib/crabstone/arch/5/wasm_const.rb
+- lib/crabstone/arch/5/x86.rb
+- lib/crabstone/arch/5/x86_const.rb
+- lib/crabstone/arch/5/xcore.rb
+- lib/crabstone/arch/5/xcore_const.rb
 - lib/crabstone/arch/extension.rb
 - lib/crabstone/arch/register.rb
 - lib/crabstone/binding.rb
@@ -166,6 +205,8 @@ files:
 - lib/crabstone/binding/3/instruction.rb
 - lib/crabstone/binding/4/detail.rb
 - lib/crabstone/binding/4/instruction.rb
+- lib/crabstone/binding/5/detail.rb
+- lib/crabstone/binding/5/instruction.rb
 - lib/crabstone/binding/structs.rb
 - lib/crabstone/constants.rb
 - lib/crabstone/cs_version.rb
@@ -190,14 +231,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.5.3
 signing_key: 
 specification_version: 4
 summary: Ruby FFI bindings for the capstone disassembly engine