duran 0.1.0

data/lib/duran/ir_opnd.rb

@@ -0,0 +1,329 @@
+
+module Duran
+  enum :operand_regs, [
+    :NULL, # /**< Sentinel value indicating no register, for address modes. */
+    # /* 64-bit general purpose */
+    :RAX, # /**< The "rax" register. */
+    :RCX, # /**< The "rcx" register. */
+    :RDX, # /**< The "rdx" register. */
+    :RBX, # /**< The "rbx" register. */
+    :RSP, # /**< The "rsp" register. */
+    :RBP, # /**< The "rbp" register. */
+    :RSI, # /**< The "rsi" register. */
+    :RDI, # /**< The "rdi" register. */
+    
+    :R8, # /**< The "r8" register. */
+    :R9, # /**< The "r9" register. */
+    :R10, # /**< The "r10" register. */
+    :R11, # /**< The "r11" register. */
+    :R12, # /**< The "r12" register. */
+    :R13, # /**< The "r13" register. */
+    :R14, # /**< The "r14" register. */
+    :R15, # /**< The "r15" register. */
+    
+    # /* 32-bit general purpose */
+    :EAX, # /**< The "eax" register. */
+    :ECX, # /**< The "ecx" register. */
+    :EDX, # /**< The "edx" register. */
+    :EBX, # /**< The "ebx" register. */
+    :ESP, # /**< The "esp" register. */
+    :EBP, # /**< The "ebp" register. */
+    :ESI, # /**< The "esi" register. */
+    :EDI, # /**< The "edi" register. */
+    
+    :R8D, # /**< The "r8d" register. */
+    :R9D, # /**< The "r9d" register. */
+    :R10D, # /**< The "r10d" register. */
+    :R11D, # /**< The "r11d" register. */
+    :R12D, # /**< The "r12d" register. */
+    :R13D, # /**< The "r13d" register. */
+    :R14D, # /**< The "r14d" register. */
+    :R15D, # /**< The "r15d" register. */
+    
+    # /* 16-bit general purpose */
+    :AX, # /**< The "ax" register. */
+    :CX, # /**< The "cx" register. */
+    :DX, # /**< The "dx" register. */
+    :BX, # /**< The "bx" register. */
+    :SP, # /**< The "sp" register. */
+    :BP, # /**< The "bp" register. */
+    :SI, # /**< The "si" register. */
+    :DI, # /**< The "di" register. */
+    
+    :R8W, # /**< The "r8w" register. */
+    :R9W, # /**< The "r9w" register. */
+    :R10W, # /**< The "r10w" register. */
+    :R11W, # /**< The "r11w" register. */
+    :R12W, # /**< The "r12w" register. */
+    :R13W, # /**< The "r13w" register. */
+    :R14W, # /**< The "r14w" register. */
+    :R15W, # /**< The "r15w" register. */
+    
+    # /* 8-bit general purpose */
+    :AL, # /**< The "al" register. */
+    :CL, # /**< The "cl" register. */
+    :DL, # /**< The "dl" register. */
+    :BL, # /**< The "bl" register. */
+    :AH, # /**< The "ah" register. */
+    :CH, # /**< The "ch" register. */
+    :DH, # /**< The "dh" register. */
+    :BH, # /**< The "bh" register. */
+    
+    :R8L, # /**< The "r8l" register. */
+    :R9L, # /**< The "r9l" register. */
+    :R10L, # /**< The "r10l" register. */
+    :R11L, # /**< The "r11l" register. */
+    :R12L, # /**< The "r12l" register. */
+    :R13L, # /**< The "r13l" register. */
+    :R14L, # /**< The "r14l" register. */
+    :R15L, # /**< The "r15l" register. */
+    
+    :SPL, # /**< The "spl" register. */
+    :BPL, # /**< The "bpl" register. */
+    :SIL, # /**< The "sil" register. */
+    :DIL, # /**< The "dil" register. */
+    
+    # /* 64-BIT MMX */
+    :MM0, # /**< The "mm0" register. */
+    :MM1, # /**< The "mm1" register. */
+    :MM2, # /**< The "mm2" register. */
+    :MM3, # /**< The "mm3" register. */
+    :MM4, # /**< The "mm4" register. */
+    :MM5, # /**< The "mm5" register. */
+    :MM6, # /**< The "mm6" register. */
+    :MM7, # /**< The "mm7" register. */
+    
+    # /* 128-BIT XMM */
+    :XMM0, # /**< The "xmm0" register. */
+    :XMM1, # /**< The "xmm1" register. */
+    :XMM2, # /**< The "xmm2" register. */
+    :XMM3, # /**< The "xmm3" register. */
+    :XMM4, # /**< The "xmm4" register. */
+    :XMM5, # /**< The "xmm5" register. */
+    :XMM6, # /**< The "xmm6" register. */
+    :XMM7, # /**< The "xmm7" register. */
+    
+    :XMM8, # /**< The "xmm8" register. */
+    :XMM9, # /**< The "xmm9" register. */
+    :XMM10, # /**< The "xmm10" register. */
+    :XMM11, # /**< The "xmm11" register. */
+    :XMM12, # /**< The "xmm12" register. */
+    :XMM13, # /**< The "xmm13" register. */
+    :XMM14, # /**< The "xmm14" register. */
+    :XMM15, # /**< The "xmm15" register. */
+    
+    # /* floating point registers */
+    :ST0, # /**< The "st0" register. */
+    :ST1, # /**< The "st1" register. */
+    :ST2, # /**< The "st2" register. */
+    :ST3, # /**< The "st3" register. */
+    :ST4, # /**< The "st4" register. */
+    :ST5, # /**< The "st5" register. */
+    :ST6, # /**< The "st6" register. */
+    :ST7, # /**< The "st7" register. */
+    
+    # /* segments (order from "Sreg" description in Intel manual) */
+    :SEG_ES, # /**< The "es" register. */
+    :SEG_CS, # /**< The "cs" register. */
+    :SEG_SS, # /**< The "ss" register. */
+    :SEG_DS, # /**< The "ds" register. */
+    :SEG_FS, # /**< The "fs" register. */
+    :SEG_GS, # /**< The "gs" register. */
+    
+    # /* debug & control registers (privileged access only; 8-15 for future processors) */
+    :DR0, # /**< The "dr0" register. */
+    :DR1, # /**< The "dr1" register. */
+    :DR2, # /**< The "dr2" register. */
+    :DR3, # /**< The "dr3" register. */
+    :DR4, # /**< The "dr4" register. */
+    :DR5, # /**< The "dr5" register. */
+    :DR6, # /**< The "dr6" register. */
+    :DR7, # /**< The "dr7" register. */
+    
+    :DR8, # /**< The "dr8" register. */
+    :DR9, # /**< The "dr9" register. */
+    :DR10, # /**< The "dr10" register. */
+    :DR11, # /**< The "dr11" register. */
+    :DR12, # /**< The "dr12" register. */
+    :DR13, # /**< The "dr13" register. */
+    :DR14, # /**< The "dr14" register. */
+    :DR15, # /**< The "dr15" register. */
+    
+    # /* cr9-cr15 do not yet exist on current x64 hardware */
+    :CR0, # /**< The "cr0" register. */
+    :CR1, # /**< The "cr1" register. */
+    :CR2, # /**< The "cr2" register. */
+    :CR3, # /**< The "cr3" register. */
+    :CR4, # /**< The "cr4" register. */
+    :CR5, # /**< The "cr5" register. */
+    :CR6, # /**< The "cr6" register. */
+    :CR7, # /**< The "cr7" register. */
+    
+    :CR8, # /**< The "cr8" register. */
+    :CR9, # /**< The "cr9" register. */
+    :CR10, # /**< The "cr10" register. */
+    :CR11, # /**< The "cr11" register. */
+    :CR12, # /**< The "cr12" register. */
+    :CR13, # /**< The "cr13" register. */
+    :CR14, # /**< The "cr14" register. */
+    :CR15, # /**< The "cr15" register. */
+    
+    :INVALID, # /**< Sentinel value indicating an invalid register. */
+
+    :OPSZ_NA,
+    :OPSZ_0,
+    :OPSZ_1,
+    :OPSZ_2,
+    :OPSZ_4,
+    :OPSZ_6,
+    :OPSZ_8,
+    :OPSZ_10,
+    :OPSZ_16,
+    :OPSZ_14,
+    :OPSZ_28,
+    :OPSZ_94,
+    :OPSZ_108,
+    :OPSZ_512,
+    :OPSZ_2_short1,
+    :OPSZ_4_short2,
+    :OPSZ_4_rex8_short2,
+    :OPSZ_4_rex8,
+    :OPSZ_6_irex10_short4,
+    :OPSZ_8_short2,
+    :OPSZ_8_short4,
+    :OPSZ_28_short14,
+    :OPSZ_108_short94,
+    :OPSZ_4x8,
+    :OPSZ_6x10,
+    :OPSZ_4x8_short2,
+    :OPSZ_4x8_short2xi8,
+    :OPSZ_4_short2xi4,
+    :OPSZ_1_reg4,
+    :OPSZ_2_reg4,
+    :OPSZ_4_reg16,
+  ]
+
+  attach_function :opnd_create_null, [], Operand
+  attach_function :opnd_create_reg, [:reg_id_t], Operand
+  attach_function :opnd_create_immed_int, [:ptr_int_t, :opnd_size_t], Operand
+  attach_function :opnd_create_immed_float, [:float], Operand
+  attach_function :opnd_create_pc, [:app_pc], Operand
+  attach_function :opnd_create_far_pc, [:ushort, :app_pc], Operand
+  attach_function :opnd_create_instr, [Instruction], Operand
+  attach_function :opnd_create_far_instr, [:ushort, Instruction], Operand
+
+  attach_function :opnd_create_base_disp, 
+    [:reg_id_t, :reg_id_t, :int, :int, :opnd_size_t], Operand
+
+  attach_function :opnd_create_base_disp_ex,
+    [:reg_id_t, :reg_id_t, :int, :int, :opnd_size_t, :bool, :bool, :bool], 
+    Operand
+
+  attach_function :opnd_create_far_base_disp, 
+    [:reg_id_t, :reg_id_t, :reg_id_t, :int, :int, :opnd_size_t], Operand
+
+  attach_function :opnd_create_far_base_disp_ex,
+    [:reg_id_t, :reg_id_t, :reg_id_t, :int, :int, :opnd_size_t, 
+      :bool, :bool, :bool], Operand
+
+  attach_function :opnd_create_abs_addr, [:pointer, :opnd_size_t], Operand
+
+  attach_function :opnd_create_far_abs_addr, 
+    [:reg_id_t, :pointer, :opnd_size_t], Operand
+
+  attach_function :opnd_is_null, [Operand], :bool
+  attach_function :opnd_is_reg, [Operand], :bool
+  attach_function :opnd_is_immed, [Operand], :bool
+  attach_function :opnd_is_immed_int, [Operand], :bool
+  attach_function :opnd_is_immed_float, [Operand], :bool
+  attach_function :opnd_is_pc, [Operand], :bool
+  attach_function :opnd_is_near_pc, [Operand], :bool
+  attach_function :opnd_is_far_pc, [Operand], :bool
+  attach_function :opnd_is_instr, [Operand], :bool
+  attach_function :opnd_is_near_instr, [Operand], :bool
+  attach_function :opnd_is_far_instr, [Operand], :bool
+  attach_function :opnd_is_base_disp, [Operand], :bool
+  attach_function :opnd_is_near_base_disp, [Operand], :bool
+  attach_function :opnd_is_far_base_disp, [Operand], :bool
+  attach_function :opnd_is_abs_addr, [Operand], :bool
+  attach_function :opnd_is_near_abs_addr, [Operand], :bool
+  attach_function :opnd_is_far_abs_addr, [Operand], :bool
+  attach_function :opnd_is_memory_reference, [Operand], :bool
+  attach_function :opnd_is_far_memory_reference, [Operand], :bool
+  attach_function :opnd_is_near_memory_reference, [Operand], :bool
+  attach_function :opnd_is_disp_encode_zero, [Operand], :bool
+  attach_function :opnd_is_disp_force_full, [Operand], :bool
+  attach_function :opnd_is_disp_short_addr, [Operand], :bool
+  attach_function :opnd_is_reg_32bit, [Operand], :bool
+  attach_function :opnd_is_reg_64bit, [Operand], :bool
+  attach_function :opnd_is_reg_pointer_sized, [Operand], :bool
+  attach_function :opnd_uses_reg, [Operand, :reg_id_t], :bool
+
+  attach_function :opnd_same, [Operand, Operand], :bool
+  attach_function :opnd_same_address, [Operand, Operand], :bool
+  attach_function :opnd_share_reg, [Operand, Operand], :bool
+  attach_function :opnd_defines_use, [Operand, Operand], :bool
+  attach_function :opnd_get_size, [Operand], :opnd_size_t
+  attach_function :opnd_get_immed_int, [Operand], :ptr_int_t
+  attach_function :opnd_get_immed_float, [Operand], :float
+  attach_function :opnd_get_pc, [Operand], :app_pc
+  attach_function :opnd_get_segment_selector, [Operand], :ushort
+  attach_function :opnd_get_instr, [Operand], Instruction
+  attach_function :opnd_get_base, [Operand], :reg_id_t
+  attach_function :opnd_get_disp, [Operand], :int
+  attach_function :opnd_get_index, [Operand], :reg_id_t
+  attach_function :opnd_get_scale, [Operand], :int
+  attach_function :opnd_get_segment, [Operand], :reg_id_t
+  attach_function :opnd_get_addr, [Operand], :pointer
+  attach_function :opnd_size_in_bytes, [Operand], :uint
+  attach_function :opnd_shrink_to_16_bits, [Operand], Operand
+
+  attach_function :opnd_num_regs_used, [Operand], :int
+  attach_function :opnd_get_reg_used, [Operand, :int], :reg_id_t
+  attach_function :opnd_set_size, [Operand, :opnd_size_t], :void
+  attach_function :opnd_set_disp, [Operand, :int], :void
+  attach_function :opnd_set_disp_ex, [Operand, :int, :bool, :bool, :bool], :void
+  attach_function :opnd_replace_reg, [Operand, :reg_id_t, :reg_id_t], :bool
+  attach_function :opnd_compute_address, [Operand, MachineContext], :app_pc
+  attach_function :opnd_disassemble, [:dr_ctx_t, Operand, :file_t], :void
+
+  attach_function :get_register_name, [:reg_id_t], :string
+  attach_function :reg_32_to_16, [:reg_id_t], :reg_id_t
+  attach_function :reg_32_to_8, [:reg_id_t], :reg_id_t
+  attach_function :reg_to_pointer_sized, [:reg_id_t], :reg_id_t
+
+  attach_function :reg_32_to_opsz, [:reg_id_t, :opnd_size_t], :reg_id_t
+
+  attach_function :reg_parameter_num, [:reg_id_t], :int
+
+  attach_function :reg_is_gpr, [:reg_id_t], :bool
+  attach_function :reg_is_segment, [:reg_id_t], :bool
+  attach_function :reg_is_xmm, [:reg_id_t], :bool
+  attach_function :reg_is_mmx, [:reg_id_t], :bool
+  attach_function :reg_is_fp, [:reg_id_t], :bool
+  attach_function :reg_is_32bit, [:reg_id_t], :bool
+  attach_function :reg_is_64bit, [:reg_id_t], :bool
+  attach_function :reg_is_pointer_sized, [:reg_id_t], :bool
+
+  attach_function :reg_overlap, [:reg_id_t, :reg_id_t], :bool
+  attach_function :reg_get_bits, [:reg_id_t], :byte
+  attach_function :reg_get_size, [:reg_id_t], :opnd_size_t
+  attach_function :reg_get_value, [:reg_id_t, MachineContext], :reg_t
+  attach_function :reg_set_value, [:reg_id_t, MachineContext, :reg_t], :void
+
+  # XXX TODO add #ifdef X64 enclosed stuff
+  if ::Duran::ARCH == :X64
+    attach_function :opnd_create_rel_addr, [:pointer, :opnd_size_t], Operand
+    attach_function :opnd_create_far_rel_addr, 
+      [:reg_id_t, :pointer, :opnd_size_t], Operand
+
+    attach_function :opnd_is_rel_addr, [Operand], :bool
+    attach_function :opnd_is_near_rel_addr, [Operand], :bool
+    attach_function :opnd_is_far_rel_addr, [Operand], :bool
+    attach_function :opnd_shrink_to_32_bits, [Operand], Operand
+
+    attach_function :reg_32_to_64, [:reg_id_t], :reg_id_t
+    attach_function :reg_64_to_32, [:reg_id_t], :reg_id_t
+    attach_function :reg_is_extended, [:reg_id_t], :bool
+  end
+end

data/lib/duran/ir_utils.rb

@@ -0,0 +1,133 @@
+
+module Duran
+
+  if ARCH == :x86
+    attach_function :set_x86_mode, [:dr_ctx_t, :bool], :bool
+    attach_function :get_x86_mode, [:dr_ctx_t], :bool
+    SPILL_SLOT_MAX = 17
+  else
+    SPILL_SLOT_MAX = 9
+  end
+
+  attach_function :dr_save_reg, 
+    [:dr_ctx_t, :instrlist_t, Instruction, :reg_id_t, :spill_slot_t], :void
+
+  attach_function :dr_restore_reg, 
+    [:dr_ctx_t, :instrlist_t, Instruction, :reg_id_t, :spill_slot_t], :void
+
+  attach_function :dr_max_opnd_accessible_spill_slot, [], :spill_slot_t
+
+  attach_function :dr_reg_spill_slot_opnd, 
+    [:dr_ctx_t, :spill_slot_t], Operand
+
+  attach_function :dr_read_saved_reg, 
+    [:dr_ctx_t, :spill_slot_t], :reg_t
+
+  attach_function :dr_write_saved_reg, 
+    [:dr_ctx_t, :spill_slot_t, :reg_t], :void
+
+  attach_function :dr_save_arith_flags, 
+    [:dr_ctx_t, :instrlist_t, Instruction, :spill_slot_t], :void
+
+  attach_function :dr_restore_arith_flags, 
+    [:dr_ctx_t, :instrlist_t, Instruction, :spill_slot_t], :void
+
+  attach_function :dr_insert_read_tls_field,
+    [:dr_ctx_t, :instrlist_t, Instruction, :reg_t], :void
+
+  attach_function :dr_insert_write_tls_field,
+    [:dr_ctx_t, :instrlist_t, Instruction, :reg_t], :void
+
+  attach_function :instrlist_meta_preinsert, 
+    [:instrlist_t, Instruction, Instruction], :void
+
+  attach_function :instrlist_meta_postinsert, 
+    [:instrlist_t, Instruction, Instruction], :void
+
+  attach_function :instrlist_meta_append,
+    [:instrlist_t, Instruction], :void
+
+  attach_function :instrlist_meta_fault_preinsert, 
+    [:instrlist_t, Instruction, Instruction], :void
+
+  attach_function :instrlist_meta_fault_postinsert, 
+    [:instrlist_t, Instruction, Instruction], :void
+
+  attach_function :instrlist_meta_fault_append,
+    [:instrlist_t, Instruction], :void
+
+  attach_function :dr_insert_clean_call,
+    [:dr_ctx_t, :instrlist_t, Instruction, :pointer, :bool, :uint, :varargs], 
+    :void
+
+  attach_function :dr_insert_call,
+    [:dr_ctx_t, :instrlist_t, Instruction, :pointer, :uint, :varargs], :void
+
+  attach_function :dr_prepare_for_call, 
+    [:dr_ctx_t, :instrlist_t, Instruction], :uint
+
+  attach_function :dr_cleanup_after_call,
+    [:dr_ctx_t, :instrlist_t, Instruction, :uint], :void
+
+  attach_function :dr_swap_to_clean_stack, 
+    [:dr_ctx_t, :instrlist_t, Instruction], :void
+
+  attach_function :dr_restore_app_stack,
+    [:dr_ctx_t, :instrlist_t, Instruction], :void
+
+  attach_function :dr_insert_call_instrumentation,
+    [:dr_ctx_t, :instrlist_t, Instruction, :pointer], :void
+
+  attach_function :dr_insert_mbr_instrumentation,
+    [:dr_ctx_t, :instrlist_t, Instruction, :pointer, :spill_slot_t], :void
+
+  attach_function :dr_insert_cbr_instrumentation,
+    [:dr_ctx_t, :instrlist_t, Instruction, :pointer], :void
+
+  attach_function :dr_insert_ubr_instrumentation,
+    [:dr_ctx_t, :instrlist_t, Instruction, :pointer], :void
+
+  attach_function :dr_mcontext_xmm_fields_valid, [], :bool
+
+  attach_function :dr_get_mcontext, 
+    [:dr_ctx_t, MachineContext, :pointer], :void
+  attach_function :dr_set_mcontext, 
+    [:dr_ctx_t, MachineContext, :pointer], :void
+
+  attach_function :dr_redirect_execution, [MachineContext, :int], :void
+
+  attach_function :decode_memory_reference_size, 
+    [:dr_ctx_t, :app_pc, :pointer], :app_pc
+
+  attach_function :decode_eflags_usage, 
+    [:dr_ctx_t, :pointer, :pointer], :pointer
+
+  attach_function :decode, [:dr_ctx_t, :pointer, Instruction], :pointer
+
+  attach_function :decode_from_copy, 
+    [:dr_ctx_t, :pointer, :pointer, Instruction], :pointer
+
+  attach_function :decode_as_bb,  [:dr_ctx_t, :pointer], :instrlist_t
+
+  attach_function :decode_trace,  [:dr_ctx_t, :dr_tag_t], :instrlist_t
+
+  attach_function :decode_first_opcode_byte, [:int], :byte
+
+  attach_function :decode_opcode_name, [:int], :string
+
+  attach_function :decode_sizeof, 
+      (ARCH==:x64 ?  [:dr_ctx_t, :pointer, :pointer, :pointer] :
+                     [:dr_ctx_t, :pointer, :pointer]), :int
+
+  attach_function :decode_next_pc, [:dr_ctx_t, :pointer], :pointer
+
+  attach_function :disassemble, 
+    [:dr_ctx_t, :pointer, :file_t], :pointer
+
+  attach_function :disassemble_with_info, 
+    [:dr_ctx_t, :pointer, :file_t, :bool, :bool], :pointer
+
+  attach_function :disassemble_from_copy,
+    [:dr_ctx_t, :pointer, :pointer, :file_t, :bool, :bool], :pointer
+
+end