e427fdff0a
This lets us use libcapstone directly from miniruby so we don't need a
Ruby Gem to to dev work.
Example usage:
```ruby
def foo(x)
if x < 1
"wow"
else
"neat"
end
end
iseq = RubyVM::InstructionSequence.of(method(:foo))
puts UJIT.disasm(iseq)
100.times { foo 1 }
puts UJIT.disasm(iseq)
```
Then in the terminal
```
$ ./miniruby test.rb
== disasm: #<ISeq:foo@test.rb:1 (1,0)-(7,3)> (catch: FALSE)
local table (size: 1, argc: 1 [opts: 0, rest: -1, post: 0, block: -1, kw: -1@-1, kwrest: -1])
[ 1] x@0<Arg>
0000 getlocal_WC_0 x@0 ( 2)[LiCa]
0002 putobject_INT2FIX_1_
0003 opt_lt <calldata!mid:<, argc:1, ARGS_SIMPLE>
0005 branchunless 10
0007 putstring "wow" ( 3)[Li]
0009 leave ( 7)[Re]
0010 putstring "neat" ( 5)[Li]
0012 leave ( 7)[Re]
== ISEQ RANGE: 10 -> 10 ========================================================
0x0: movabs rax, 0x7fe816e2d1a0
0xa: mov qword ptr [rdi], rax
0xd: mov r8, rax
0x10: mov r9, rax
0x13: mov r11, r12
0x16: jmp qword ptr [rax]
== ISEQ RANGE: 0 -> 7 ==========================================================
0x0: mov rax, qword ptr [rdi + 0x20]
0x4: mov rax, qword ptr [rax - 0x18]
0x8: mov qword ptr [rdx], rax
0xb: mov qword ptr [rdx + 8], 3
0x13: movabs rax, 0x7fe817808200
0x1d: test byte ptr [rax + 0x3e6], 1
0x24: jne 0x3ffff7b
0x2a: test byte ptr [rdx], 1
0x2d: je 0x3ffff7b
0x33: test byte ptr [rdx + 8], 1
0x37: je 0x3ffff7b
0x3d: mov rax, qword ptr [rdx]
0x40: cmp rax, qword ptr [rdx + 8]
0x44: movabs rax, 0
0x4e: movabs rcx, 0x14
0x58: cmovl rax, rcx
0x5c: mov qword ptr [rdx], rax
0x5f: test qword ptr [rdx], -9
0x66: jne 0x3ffffd5
```
Make sure to `brew install pkg-config capstone`
|
||
|---|---|---|
| .github | ||
| basictest | ||
| benchmark | ||
| bin | ||
| bootstraptest | ||
| ccan | ||
| coroutine | ||
| coverage | ||
| cygwin | ||
| defs | ||
| doc | ||
| enc | ||
| ext | ||
| gems | ||
| include | ||
| internal | ||
| lib | ||
| libexec | ||
| man | ||
| misc | ||
| missing | ||
| sample | ||
| spec | ||
| template | ||
| test | ||
| tool | ||
| win32 | ||
| .appveyor.yml | ||
| .cirrus.yml | ||
| .dir-locals.el | ||
| .document | ||
| .editorconfig | ||
| .gdbinit | ||
| .gitattributes | ||
| .gitignore | ||
| .rspec_parallel | ||
| .travis.yml | ||
| aclocal.m4 | ||
| addr2line.c | ||
| addr2line.h | ||
| array.c | ||
| array.rb | ||
| ast.c | ||
| ast.rb | ||
| autogen.sh | ||
| bignum.c | ||
| BSDL | ||
| builtin.c | ||
| builtin.h | ||
| class.c | ||
| common.mk | ||
| compar.c | ||
| compile.c | ||
| complex.c | ||
| configure.ac | ||
| constant.h | ||
| cont.c | ||
| CONTRIBUTING.md | ||
| COPYING | ||
| COPYING.ja | ||
| debug.c | ||
| debug_counter.c | ||
| debug_counter.h | ||
| dir.c | ||
| dir.rb | ||
| dln.c | ||
| dln.h | ||
| dln_find.c | ||
| dmydln.c | ||
| dmyenc.c | ||
| dmyext.c | ||
| encindex.h | ||
| encoding.c | ||
| enum.c | ||
| enumerator.c | ||
| error.c | ||
| eval.c | ||
| eval_error.c | ||
| eval_intern.h | ||
| eval_jump.c | ||
| file.c | ||
| gc.c | ||
| gc.h | ||
| gc.rb | ||
| gem_prelude.rb | ||
| golf_prelude.rb | ||
| goruby.c | ||
| GPL | ||
| hash.c | ||
| hrtime.h | ||
| id_table.c | ||
| id_table.h | ||
| inits.c | ||
| insns.def | ||
| internal.h | ||
| io.c | ||
| io.rb | ||
| iseq.c | ||
| iseq.h | ||
| kernel.rb | ||
| KNOWNBUGS.rb | ||
| LEGAL | ||
| lex.c.blt | ||
| load.c | ||
| loadpath.c | ||
| localeinit.c | ||
| main.c | ||
| marshal.c | ||
| marshal.rb | ||
| math.c | ||
| memory_view.c | ||
| method.h | ||
| mini_builtin.c | ||
| miniinit.c | ||
| mjit.c | ||
| mjit.h | ||
| mjit_compile.c | ||
| mjit_worker.c | ||
| NEWS.md | ||
| nilclass.rb | ||
| node.c | ||
| node.h | ||
| numeric.c | ||
| numeric.rb | ||
| object.c | ||
| pack.c | ||
| pack.rb | ||
| parse.y | ||
| prelude.rb | ||
| probes.d | ||
| probes_helper.h | ||
| proc.c | ||
| process.c | ||
| ractor.c | ||
| ractor.rb | ||
| ractor_core.h | ||
| random.c | ||
| range.c | ||
| rational.c | ||
| re.c | ||
| README.EXT | ||
| README.EXT.ja | ||
| README.ja.md | ||
| README.md | ||
| regcomp.c | ||
| regenc.c | ||
| regenc.h | ||
| regerror.c | ||
| regexec.c | ||
| regint.h | ||
| regparse.c | ||
| regparse.h | ||
| regsyntax.c | ||
| ruby-runner.c | ||
| ruby.c | ||
| ruby_assert.h | ||
| ruby_atomic.h | ||
| rubystub.c | ||
| scheduler.c | ||
| signal.c | ||
| siphash.c | ||
| siphash.h | ||
| sparc.c | ||
| sprintf.c | ||
| st.c | ||
| strftime.c | ||
| string.c | ||
| struct.c | ||
| symbol.c | ||
| symbol.h | ||
| test_asm.sh | ||
| thread.c | ||
| thread_pthread.c | ||
| thread_pthread.h | ||
| thread_sync.c | ||
| thread_win32.c | ||
| thread_win32.h | ||
| time.c | ||
| timev.h | ||
| timev.rb | ||
| trace_point.rb | ||
| transcode.c | ||
| transcode_data.h | ||
| transient_heap.c | ||
| transient_heap.h | ||
| ujit.h | ||
| ujit.rb | ||
| ujit_asm.c | ||
| ujit_asm.h | ||
| ujit_asm_tests.c | ||
| ujit_codegen.c | ||
| ujit_codegen.h | ||
| ujit_core.c | ||
| ujit_core.h | ||
| ujit_iface.c | ||
| ujit_iface.h | ||
| ujit_utils.c | ||
| ujit_utils.h | ||
| util.c | ||
| variable.c | ||
| variable.h | ||
| version.c | ||
| version.h | ||
| vm.c | ||
| vm_args.c | ||
| vm_backtrace.c | ||
| vm_callinfo.h | ||
| vm_core.h | ||
| vm_debug.h | ||
| vm_dump.c | ||
| vm_eval.c | ||
| vm_exec.c | ||
| vm_exec.h | ||
| vm_insnhelper.c | ||
| vm_insnhelper.h | ||
| vm_method.c | ||
| vm_opts.h | ||
| vm_sync.c | ||
| vm_sync.h | ||
| vm_trace.c | ||
| vsnprintf.c | ||
| warning.rb | ||
What's Ruby
Ruby is an interpreted object-oriented programming language often used for web development. It also offers many scripting features to process plain text and serialized files, or manage system tasks. It is simple, straightforward, and extensible.
Features of Ruby
- Simple Syntax
- Normal Object-oriented Features (e.g. class, method calls)
- Advanced Object-oriented Features (e.g. mix-in, singleton-method)
- Operator Overloading
- Exception Handling
- Iterators and Closures
- Garbage Collection
- Dynamic Loading of Object Files (on some architectures)
- Highly Portable (works on many Unix-like/POSIX compatible platforms as well as Windows, macOS, etc.) cf. https://github.com/ruby/ruby/blob/master/doc/contributing.rdoc#label-Platform+Maintainers
How to get Ruby
For a complete list of ways to install Ruby, including using third-party tools like rvm, see:
https://www.ruby-lang.org/en/downloads/
Git
The mirror of the Ruby source tree can be checked out with the following command:
$ git clone https://github.com/ruby/ruby.git
There are some other branches under development. Try the following command to see the list of branches:
$ git ls-remote https://github.com/ruby/ruby.git
You may also want to use https://git.ruby-lang.org/ruby.git (actual master of Ruby source) if you are a committer.
Subversion
Stable branches for older Ruby versions can be checked out with also the following command:
$ svn co https://svn.ruby-lang.org/repos/ruby/branches/ruby_2_6/ ruby
Try the following command to see the list of branches:
$ svn ls https://svn.ruby-lang.org/repos/ruby/branches/
Ruby home page
Mailing list
There is a mailing list to discuss Ruby. To subscribe to this list, please send the following phrase:
subscribe
in the mail body (not subject) to the address ruby-talk-request@ruby-lang.org.
Requirements to build from repository
- GNU or BSD make
- C99 compiler
- autoconf 2.67 or higher
- automake 1.15 or higher
- bison 2.3 or higher
- Ruby 2.2 or higher
When building from a released version, only a C99 compiler and GNU or BSD make is required.
How to compile and install
-
If you want to use Microsoft Visual C++ to compile Ruby, read win32/README.win32 instead of this document.
-
Run
./autogen.shto generate configure, when you build the source checked out from the Git repository. -
Run
./configure, which will generateconfig.handMakefile.Some C compiler flags may be added by default depending on your environment. Specify
optflags=..andwarnflags=..as necessary to override them. -
Edit
include/ruby/defines.hif you need. Usually this step will not be needed. -
Optional: Remove comment mark(
#) before the module names fromext/Setup.This step is only necessary if you want to link modules statically.
If you don't want to compile dynamic extensions (probably on architectures which do not allow dynamic loading), remove comment mark from the line "
#option nodynamic" inext/Setup.Usually this step will not be needed.
-
Run
make.- On Mac, set RUBY_CODESIGN environment variable with a signing identity.
It uses the identity to sign
rubybinary. See also codesign(1).
- On Mac, set RUBY_CODESIGN environment variable with a signing identity.
It uses the identity to sign
-
Optionally, run '
make check' to check whether the compiled Ruby interpreter works well. If you see the message "check succeeded", your Ruby works as it should (hopefully). -
Run '
make install'.This command will create the following directories and install files into them.
${DESTDIR}${prefix}/bin${DESTDIR}${prefix}/include/ruby-${MAJOR}.${MINOR}.${TEENY}${DESTDIR}${prefix}/include/ruby-${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}${DESTDIR}${prefix}/lib${DESTDIR}${prefix}/lib/ruby${DESTDIR}${prefix}/lib/ruby/${MAJOR}.${MINOR}.${TEENY}${DESTDIR}${prefix}/lib/ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}${DESTDIR}${prefix}/lib/ruby/site_ruby${DESTDIR}${prefix}/lib/ruby/site_ruby/${MAJOR}.${MINOR}.${TEENY}${DESTDIR}${prefix}/lib/ruby/site_ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}${DESTDIR}${prefix}/lib/ruby/vendor_ruby${DESTDIR}${prefix}/lib/ruby/vendor_ruby/${MAJOR}.${MINOR}.${TEENY}${DESTDIR}${prefix}/lib/ruby/vendor_ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}${DESTDIR}${prefix}/lib/ruby/gems/${MAJOR}.${MINOR}.${TEENY}${DESTDIR}${prefix}/share/man/man1${DESTDIR}${prefix}/share/ri/${MAJOR}.${MINOR}.${TEENY}/system
If Ruby's API version is 'x.y.z', the
${MAJOR}is 'x', the${MINOR}is 'y', and the${TEENY}is 'z'.NOTE: teeny of the API version may be different from one of Ruby's program version
You may have to be a super user to install Ruby.
If you fail to compile Ruby, please send the detailed error report with the error log and machine/OS type, to help others.
Some extension libraries may not get compiled because of lack of necessary
external libraries and/or headers, then you will need to run 'make distclean-ext'
to remove old configuration after installing them in such case.
Copying
See the file COPYING.
Feedback
Questions about the Ruby language can be asked on the Ruby-Talk mailing list or on websites like https://stackoverflow.com.
Bugs should be reported at https://bugs.ruby-lang.org. Read HowToReport for more information.
Contributing
See the file CONTRIBUTING.md
The Author
Ruby was originally designed and developed by Yukihiro Matsumoto (Matz) in 1995.