hatstone 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ab8092c3f275423580c1f40f47af6480b51e5d1d6134e7270aaf8de88fa7f23e
+  data.tar.gz: 8f28d3368190326c38e15b78242768a4221c2d3f02f3e7398a9620f8c6988d6f
+SHA512:
+  metadata.gz: 3431845a6a7a634e1b88f6d8c491fc68fa0cc4f5c1c6528364354ec7b5d22b2767feb0fce240717ccfaff76043cb32902fe4b60e5c3a92317b0acd71e251d5f2
+  data.tar.gz: 0c4463a572cf9599029d6e3f200d6ca4db7c9d3d7907d5ba69a33de1fce2bd3633927df653f086fe08db6bdc85aaa8656c08ba5327ee58a1dc27827b317317b5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,77 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+Examples of representing a project or community include using an official
+project e-mail address, posting via an official social media account, or acting
+as an appointed representative at an online or offline event. Representation of
+a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at aaron.patterson at gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq
+

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2021 Aaron Patterson
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,58 @@
+# Hatstone
+
+This is a very simple wrapper around [Capstone](https://www.capstone-engine.org).
+Capstone is a library that disassembles binary data in to assembly code.  This
+library, Hatstone, offers a Ruby interface to the Capstone library.
+
+## Why a new library?
+
+[Crabstone](https://github.com/bnagy/crabstone) is a different wrapper for Capstone.
+I've been using Crabstone for quite a while and I really love it.  However,
+I've been running in to problems with libffi, and especially problems on my M1
+Mac where I have both the ARM64 installation and x86 installation of Capstone
+on the same system (via two installations of Homebrew).
+
+This C extension finds the right Capstone library at gem installation time, so
+you can be assured that if you can install this gem, you can use this gem (hopefully!!)
+
+## Installation
+
+Make sure you have Capstone installed.  On macOS this is `brew install capstone`.
+Then install this gem via the normal method `gem install hatstone`.
+
+## Example Usage
+
+In this example we'll assemble some simple ARM64 instructions and then use
+Hatstone to disassemble them.
+
+```ruby
+require "hatstone"
+
+# ARM64 movz instruction
+def movz reg, imm
+  insn = 0b0_10_100101_00_0000000000000000_00000
+  insn |= (1 << 31)  # 64 bit
+  insn |= (imm << 5) # immediate
+  insn |= reg        # reg
+end
+
+# ARM64 ret instruction
+def ret xn = 30
+  insn = 0b1101011_0_0_10_11111_0000_0_0_00000_00000
+  insn |= (xn << 5)
+  insn
+end
+
+# Assemble some instructions
+insns = [
+  movz(0, 0x2a), # mov X0, 0x2a
+  ret            # ret
+].pack("L<L<")
+
+# Now disassemble the instructions with Hatstone
+hs = Hatstone.new(Hatstone::ARCH_ARM64, Hatstone::MODE_ARM)
+
+hs.disasm(insns, 0x0).each do |insn|
+  puts "%#05x %s %s" % [insn.address, insn.mnemonic, insn.op_str]
+end
+```

data/Rakefile

@@ -0,0 +1,54 @@
+def each_node node, &block
+  yield node
+  node["inner"]&.each { |n| each_node(n, &block) }
+end
+
+def find_comment node
+end
+
+def find_enums tree, &block
+  if tree["kind"] == "EnumDecl"
+    name = tree["name"]
+    return if tree["loc"]["includedFrom"]
+
+    each_node(tree) { |n|
+      if n["kind"] == "EnumConstantDecl"
+        block.call n["name"]
+      end
+    }
+  else
+    tree["inner"]&.each { |node| find_enums node, &block }
+  end
+end
+
+ENUMS = "ext/hatstone/hatstone_enums.inc"
+
+file ENUMS do
+  require "json"
+
+  ENV["PKG_CONFIG_PATH"] = `brew --prefix`.chomp + "/lib/pkgconfig"
+  header = `pkg-config --cflags-only-I capstone`.chomp.sub(/^-I/, '') + "/capstone.h"
+  ast = JSON.parse `clang -Xclang -ast-dump=json -fsyntax-only #{header}`.chomp
+  File.open(ENUMS, "w") do |f|
+    find_enums ast do |enum|
+      f.puts "rb_define_const(klass, \"#{enum.sub(/^CS_/, '')}\", INT2NUM(#{enum}));"
+    end
+  end
+end
+
+task :gen_enums => ENUMS
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test/lib" << "test"
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+  t.warning = true
+end
+
+require 'rake/extensiontask'
+Rake::ExtensionTask.new("hatstone")
+
+task :compile => :gen_enums
+task :test => :compile

data/ext/hatstone/extconf.rb

@@ -0,0 +1,23 @@
+$LDFLAGS = RbConfig::CONFIG["LDFLAGS"] = "-L."
+
+require 'mkmf'
+
+ldflags = cppflags = nil
+
+begin
+  brew_prefix = `brew --prefix hidapi`.chomp
+  ldflags   = "#{brew_prefix}/lib"
+  cppflags  = "#{brew_prefix}/include"
+  pkg_conf  = "#{brew_prefix}/lib/pkgconfig"
+
+  ENV["PKG_CONFIG_PATH"] = pkg_conf
+rescue
+end
+
+pkg_config "capstone"
+dir_config "capstone", cppflags, ldflags
+
+raise "Install capstone!" unless have_header "capstone.h"
+raise "Install capstone!" unless have_library "capstone"
+
+create_makefile('hatstone')

data/ext/hatstone/hatstone.c

@@ -0,0 +1,72 @@
+#include <ruby.h>
+#include <capstone.h>
+
+static VALUE cInsn;
+
+static void dealloc(void * ptr)
+{
+    cs_close((csh *)ptr);
+    free(ptr);
+}
+
+static const rb_data_type_t handle_type = {
+    "Hatstone/Handle",
+    {0, dealloc, 0,},
+    0, 0,
+#ifdef RUBY_TYPED_FREE_IMMEDIATELY
+    RUBY_TYPED_FREE_IMMEDIATELY,
+#endif
+};
+
+static VALUE
+hatstone_open(VALUE klass, VALUE arch, VALUE mode)
+{
+    csh * handle = calloc(sizeof(csh), 1);
+
+    if (CS_ERR_OK == cs_open(NUM2INT(arch), NUM2INT(mode), handle)) {
+	return TypedData_Wrap_Struct(klass, &handle_type, handle);
+    } else {
+        return Qnil;
+    }
+}
+
+static VALUE
+hatstone_disasm(VALUE self, VALUE code_str, VALUE addr)
+{
+    csh * handle;
+    TypedData_Get_Struct(self, csh, &handle_type, handle);
+
+    size_t size = RSTRING_LEN(code_str);
+    const uint8_t * code = (uint8_t *)StringValuePtr(code_str);
+    uint64_t address = NUM2LONG(addr);
+
+    cs_insn * insn = cs_malloc(*handle);
+
+    VALUE list = rb_ary_new();
+
+    while (cs_disasm_iter(*handle, &code, &size, &address, insn)) {
+        VALUE vals = rb_ary_new_from_args(6,
+                INT2NUM(insn->id),
+                LONG2NUM(insn->address),
+                INT2NUM(insn->size),
+                rb_str_new((const char *)insn->bytes, insn->size),
+                rb_str_new2(insn->mnemonic),
+                rb_str_new2(insn->op_str));
+        rb_ary_push(list, rb_struct_alloc(cInsn, vals));
+    }
+
+    cs_free(insn, 1);
+    return list;
+}
+
+void Init_hatstone()
+{
+    VALUE klass = rb_define_class("Hatstone", rb_cObject);
+    rb_undef_alloc_func(klass);
+    rb_define_singleton_method(klass, "new", hatstone_open, 2);
+    rb_define_method(klass, "disasm", hatstone_disasm, 2);
+
+    cInsn = rb_struct_define_under(klass, "Insn", "id", "address", "size", "bytes", "mnemonic", "op_str", NULL);
+
+#include "hatstone_enums.inc"
+}

data/ext/hatstone/hatstone_enums.inc

@@ -0,0 +1,94 @@
+rb_define_const(klass, "ARCH_ARM", INT2NUM(CS_ARCH_ARM));
+rb_define_const(klass, "ARCH_ARM64", INT2NUM(CS_ARCH_ARM64));
+rb_define_const(klass, "ARCH_MIPS", INT2NUM(CS_ARCH_MIPS));
+rb_define_const(klass, "ARCH_X86", INT2NUM(CS_ARCH_X86));
+rb_define_const(klass, "ARCH_PPC", INT2NUM(CS_ARCH_PPC));
+rb_define_const(klass, "ARCH_SPARC", INT2NUM(CS_ARCH_SPARC));
+rb_define_const(klass, "ARCH_SYSZ", INT2NUM(CS_ARCH_SYSZ));
+rb_define_const(klass, "ARCH_XCORE", INT2NUM(CS_ARCH_XCORE));
+rb_define_const(klass, "ARCH_M68K", INT2NUM(CS_ARCH_M68K));
+rb_define_const(klass, "ARCH_TMS320C64X", INT2NUM(CS_ARCH_TMS320C64X));
+rb_define_const(klass, "ARCH_M680X", INT2NUM(CS_ARCH_M680X));
+rb_define_const(klass, "ARCH_EVM", INT2NUM(CS_ARCH_EVM));
+rb_define_const(klass, "ARCH_MAX", INT2NUM(CS_ARCH_MAX));
+rb_define_const(klass, "ARCH_ALL", INT2NUM(CS_ARCH_ALL));
+rb_define_const(klass, "MODE_LITTLE_ENDIAN", INT2NUM(CS_MODE_LITTLE_ENDIAN));
+rb_define_const(klass, "MODE_ARM", INT2NUM(CS_MODE_ARM));
+rb_define_const(klass, "MODE_16", INT2NUM(CS_MODE_16));
+rb_define_const(klass, "MODE_32", INT2NUM(CS_MODE_32));
+rb_define_const(klass, "MODE_64", INT2NUM(CS_MODE_64));
+rb_define_const(klass, "MODE_THUMB", INT2NUM(CS_MODE_THUMB));
+rb_define_const(klass, "MODE_MCLASS", INT2NUM(CS_MODE_MCLASS));
+rb_define_const(klass, "MODE_V8", INT2NUM(CS_MODE_V8));
+rb_define_const(klass, "MODE_MICRO", INT2NUM(CS_MODE_MICRO));
+rb_define_const(klass, "MODE_MIPS3", INT2NUM(CS_MODE_MIPS3));
+rb_define_const(klass, "MODE_MIPS32R6", INT2NUM(CS_MODE_MIPS32R6));
+rb_define_const(klass, "MODE_MIPS2", INT2NUM(CS_MODE_MIPS2));
+rb_define_const(klass, "MODE_V9", INT2NUM(CS_MODE_V9));
+rb_define_const(klass, "MODE_QPX", INT2NUM(CS_MODE_QPX));
+rb_define_const(klass, "MODE_M68K_000", INT2NUM(CS_MODE_M68K_000));
+rb_define_const(klass, "MODE_M68K_010", INT2NUM(CS_MODE_M68K_010));
+rb_define_const(klass, "MODE_M68K_020", INT2NUM(CS_MODE_M68K_020));
+rb_define_const(klass, "MODE_M68K_030", INT2NUM(CS_MODE_M68K_030));
+rb_define_const(klass, "MODE_M68K_040", INT2NUM(CS_MODE_M68K_040));
+rb_define_const(klass, "MODE_M68K_060", INT2NUM(CS_MODE_M68K_060));
+rb_define_const(klass, "MODE_BIG_ENDIAN", INT2NUM(CS_MODE_BIG_ENDIAN));
+rb_define_const(klass, "MODE_MIPS32", INT2NUM(CS_MODE_MIPS32));
+rb_define_const(klass, "MODE_MIPS64", INT2NUM(CS_MODE_MIPS64));
+rb_define_const(klass, "MODE_M680X_6301", INT2NUM(CS_MODE_M680X_6301));
+rb_define_const(klass, "MODE_M680X_6309", INT2NUM(CS_MODE_M680X_6309));
+rb_define_const(klass, "MODE_M680X_6800", INT2NUM(CS_MODE_M680X_6800));
+rb_define_const(klass, "MODE_M680X_6801", INT2NUM(CS_MODE_M680X_6801));
+rb_define_const(klass, "MODE_M680X_6805", INT2NUM(CS_MODE_M680X_6805));
+rb_define_const(klass, "MODE_M680X_6808", INT2NUM(CS_MODE_M680X_6808));
+rb_define_const(klass, "MODE_M680X_6809", INT2NUM(CS_MODE_M680X_6809));
+rb_define_const(klass, "MODE_M680X_6811", INT2NUM(CS_MODE_M680X_6811));
+rb_define_const(klass, "MODE_M680X_CPU12", INT2NUM(CS_MODE_M680X_CPU12));
+rb_define_const(klass, "MODE_M680X_HCS08", INT2NUM(CS_MODE_M680X_HCS08));
+rb_define_const(klass, "OPT_INVALID", INT2NUM(CS_OPT_INVALID));
+rb_define_const(klass, "OPT_SYNTAX", INT2NUM(CS_OPT_SYNTAX));
+rb_define_const(klass, "OPT_DETAIL", INT2NUM(CS_OPT_DETAIL));
+rb_define_const(klass, "OPT_MODE", INT2NUM(CS_OPT_MODE));
+rb_define_const(klass, "OPT_MEM", INT2NUM(CS_OPT_MEM));
+rb_define_const(klass, "OPT_SKIPDATA", INT2NUM(CS_OPT_SKIPDATA));
+rb_define_const(klass, "OPT_SKIPDATA_SETUP", INT2NUM(CS_OPT_SKIPDATA_SETUP));
+rb_define_const(klass, "OPT_MNEMONIC", INT2NUM(CS_OPT_MNEMONIC));
+rb_define_const(klass, "OPT_UNSIGNED", INT2NUM(CS_OPT_UNSIGNED));
+rb_define_const(klass, "OPT_OFF", INT2NUM(CS_OPT_OFF));
+rb_define_const(klass, "OPT_ON", INT2NUM(CS_OPT_ON));
+rb_define_const(klass, "OPT_SYNTAX_DEFAULT", INT2NUM(CS_OPT_SYNTAX_DEFAULT));
+rb_define_const(klass, "OPT_SYNTAX_INTEL", INT2NUM(CS_OPT_SYNTAX_INTEL));
+rb_define_const(klass, "OPT_SYNTAX_ATT", INT2NUM(CS_OPT_SYNTAX_ATT));
+rb_define_const(klass, "OPT_SYNTAX_NOREGNAME", INT2NUM(CS_OPT_SYNTAX_NOREGNAME));
+rb_define_const(klass, "OPT_SYNTAX_MASM", INT2NUM(CS_OPT_SYNTAX_MASM));
+rb_define_const(klass, "OP_INVALID", INT2NUM(CS_OP_INVALID));
+rb_define_const(klass, "OP_REG", INT2NUM(CS_OP_REG));
+rb_define_const(klass, "OP_IMM", INT2NUM(CS_OP_IMM));
+rb_define_const(klass, "OP_MEM", INT2NUM(CS_OP_MEM));
+rb_define_const(klass, "OP_FP", INT2NUM(CS_OP_FP));
+rb_define_const(klass, "AC_INVALID", INT2NUM(CS_AC_INVALID));
+rb_define_const(klass, "AC_READ", INT2NUM(CS_AC_READ));
+rb_define_const(klass, "AC_WRITE", INT2NUM(CS_AC_WRITE));
+rb_define_const(klass, "GRP_INVALID", INT2NUM(CS_GRP_INVALID));
+rb_define_const(klass, "GRP_JUMP", INT2NUM(CS_GRP_JUMP));
+rb_define_const(klass, "GRP_CALL", INT2NUM(CS_GRP_CALL));
+rb_define_const(klass, "GRP_RET", INT2NUM(CS_GRP_RET));
+rb_define_const(klass, "GRP_INT", INT2NUM(CS_GRP_INT));
+rb_define_const(klass, "GRP_IRET", INT2NUM(CS_GRP_IRET));
+rb_define_const(klass, "GRP_PRIVILEGE", INT2NUM(CS_GRP_PRIVILEGE));
+rb_define_const(klass, "GRP_BRANCH_RELATIVE", INT2NUM(CS_GRP_BRANCH_RELATIVE));
+rb_define_const(klass, "ERR_OK", INT2NUM(CS_ERR_OK));
+rb_define_const(klass, "ERR_MEM", INT2NUM(CS_ERR_MEM));
+rb_define_const(klass, "ERR_ARCH", INT2NUM(CS_ERR_ARCH));
+rb_define_const(klass, "ERR_HANDLE", INT2NUM(CS_ERR_HANDLE));
+rb_define_const(klass, "ERR_CSH", INT2NUM(CS_ERR_CSH));
+rb_define_const(klass, "ERR_MODE", INT2NUM(CS_ERR_MODE));
+rb_define_const(klass, "ERR_OPTION", INT2NUM(CS_ERR_OPTION));
+rb_define_const(klass, "ERR_DETAIL", INT2NUM(CS_ERR_DETAIL));
+rb_define_const(klass, "ERR_MEMSETUP", INT2NUM(CS_ERR_MEMSETUP));
+rb_define_const(klass, "ERR_VERSION", INT2NUM(CS_ERR_VERSION));
+rb_define_const(klass, "ERR_DIET", INT2NUM(CS_ERR_DIET));
+rb_define_const(klass, "ERR_SKIPDATA", INT2NUM(CS_ERR_SKIPDATA));
+rb_define_const(klass, "ERR_X86_ATT", INT2NUM(CS_ERR_X86_ATT));
+rb_define_const(klass, "ERR_X86_INTEL", INT2NUM(CS_ERR_X86_INTEL));
+rb_define_const(klass, "ERR_X86_MASM", INT2NUM(CS_ERR_X86_MASM));

data/hatstone.gemspec

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name          = "hatstone"
+  spec.version       = "1.0.0"
+  spec.authors       = ["Aaron Patterson"]
+  spec.email         = ["tenderlove@ruby-lang.org"]
+
+  spec.summary       = %q{A wrapper around Capstone for Ruby.}
+  spec.description   = %q{A Capstone wrapper for Ruby.}
+  spec.homepage      = "https://github.com/tenderlove/hatstone"
+  spec.licenses      = ["Apache-2.0"]
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+
+  spec.require_paths = ["lib"]
+  spec.extensions = ["ext/hatstone/extconf.rb"]
+
+  spec.add_development_dependency "rake", '~> 13.0'
+  spec.add_development_dependency "rake-compiler", '~> 1.1'
+  spec.add_development_dependency "minitest", '~> 5.15'
+end

data/test/hatstone_test.rb

@@ -0,0 +1,31 @@
+require "helper"
+
+class HatstoneTest < Hatstone::Test
+  def test_disasm
+    hs = Hatstone.new(Hatstone::ARCH_ARM64, Hatstone::MODE_ARM)
+
+    # Assemble some instructions
+    insns = [
+      movz(0, 42),  # mov X0, 42
+      ret           # ret
+    ].pack("L<L<")
+
+    disassembled = hs.disasm(insns, 0x0)
+    assert_equal "movz", disassembled[0].mnemonic
+    assert_equal "ret", disassembled[1].mnemonic
+  end
+
+  # ARM instructions
+  def movz reg, imm
+    insn = 0b0_10_100101_00_0000000000000000_00000
+    insn |= (1 << 31)  # 64 bit
+    insn |= (imm << 5) # immediate
+    insn |= reg        # reg
+  end
+
+  def ret xn = 30
+    insn = 0b1101011_0_0_10_11111_0000_0_0_00000_00000
+    insn |= (xn << 5)
+    insn
+  end
+end

data/test/helper.rb

@@ -0,0 +1,5 @@
+require "minitest/autorun"
+require "hatstone"
+
+class Hatstone::Test < Minitest::Test
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: hatstone
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Aaron Patterson
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.15'
+description: A Capstone wrapper for Ruby.
+email:
+- tenderlove@ruby-lang.org
+executables: []
+extensions:
+- ext/hatstone/extconf.rb
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- ext/hatstone/extconf.rb
+- ext/hatstone/hatstone.c
+- ext/hatstone/hatstone_enums.inc
+- hatstone.gemspec
+- test/hatstone_test.rb
+- test/helper.rb
+homepage: https://github.com/tenderlove/hatstone
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.0.dev
+signing_key:
+specification_version: 4
+summary: A wrapper around Capstone for Ruby.
+test_files:
+- test/hatstone_test.rb
+- test/helper.rb