Class: RubyVM::InstructionSequence

Relationships & Source Files
Inherits:	Object
Defined in:	iseq.c, iseq.c

Overview

The InstructionSequence class represents a compiled sequence of instructions for the Virtual Machine used in MRI. Not all implementations of Ruby may implement this class, and for the implementations that implement it, the methods defined and behavior of the methods can change in any version.

With it, you can get a handle to the instructions that make up a method or a proc, compile strings of Ruby code down to VM instructions, and disassemble instruction sequences to strings for easy inspection. It is mostly useful if you want to learn how YARV works, but it also lets you control various settings for the Ruby iseq compiler.

You can find the source for the VM instructions in insns.def in the Ruby source.

The instruction sequence results will almost certainly change as Ruby changes, so example output in this documentation may be different from what you see.

Of course, this class is MRI specific.

Class Attribute Summary

.compile_option ⇒ options rw

Returns a hash of default options used by the Ruby iseq compiler.
.compile_option=(options) rw

Sets the default values for various optimizations in the Ruby iseq compiler.

Class Method Summary

.compile(source[, file[, path[, line[, options]]]]) ⇒ iseq

Alias for .new.
.compile_file(file[, options]) ⇒ iseq

Takes file, a ::String with the location of a Ruby source file, reads, parses and compiles the file, and returns iseq, the compiled InstructionSequence with source location metadata set.
.disasm(body) ⇒ String (also: .disassemble)

Takes body, a ::Method or ::Proc object, and returns a ::String with the human readable instructions for body.
.disassemble(body) ⇒ String

Alias for .disasm.
.load_from_binary(binary) ⇒ iseq

Load an iseq object from binary format ::String object created by #to_binary.
.load_from_binary_extra_data(binary) ⇒ String

Load extra data embed into binary format ::String object.
.new(source[, file[, path[, line[, options]]]]) ⇒ iseq (also: .compile) constructor

Takes source, a ::String of Ruby code and compiles it to an InstructionSequence.
.of(body)

Returns the instruction sequence containing the given proc or method.
.load(*args) Internal use only

Instance Method Summary

#absolute_path

Returns the absolute path of this instruction sequence.
#base_label

Returns the base label of this instruction sequence.
#disasm ⇒ String (also: #disassemble)

Returns the instruction sequence as a ::String in human readable form.
#disassemble ⇒ String

Alias for #disasm.
#each_child {|child_iseq| ... } ⇒ iseq

Iterate all direct child instruction sequences.
#eval ⇒ Object

Evaluates the instruction sequence and returns the result.
#first_lineno

Returns the number of the first source line where the instruction sequence was loaded from.
#inspect

Returns a human-readable string representation of this instruction sequence, including the #label and #path.
#label

Returns the label of this instruction sequence.
#path

Returns the path of this instruction sequence.
#to_a ⇒ Array

Returns an ::Array with 14 elements representing the instruction sequence with the following data:
#to_binary(extra_data = nil) ⇒ binary str

Returns serialized iseq binary format data as a ::String object.
#trace_points ⇒ Array

Return trace points in the instruction sequence.
#marshal_dump private
#marshal_load private

Constructor Details

.compile(source[, file[, path[, line[, options]]]]) ⇒ `iseq` .new(source[, file[, path[, line[, options]]]]) ⇒ `iseq`
Also known as: .compile

Takes source, a ::String of Ruby code and compiles it to an InstructionSequence.

Optionally takes file, #path, and line which describe the file path, real path and first line number of the ruby code in source which are metadata attached to the returned iseq.

file is used for __FILE__ and exception backtrace. #path is used for require_relative base. It is recommended these should be the same full path.

options, which can be true, false or a ::Hash, is used to modify the default behavior of the Ruby iseq compiler.

For details regarding valid compile options see .compile_option=.

RubyVM::InstructionSequence.compile("a = 1 + 2")
#=> <RubyVM::InstructionSequence:<compiled>@<compiled>>

path = "test.rb"
RubyVM::InstructionSequence.compile(File.read(path), path, File.expand_path(path))
#=> <RubyVM::InstructionSequence:<compiled>@test.rb:1>

path = File.expand_path("test.rb")
RubyVM::InstructionSequence.compile(File.read(path), path, path)
#=> <RubyVM::InstructionSequence:<compiled>@/absolute/path/to/test.rb:1>

[ GitHub ]

# File 'iseq.c', line 1195


static VALUE
iseqw_s_compile(int argc, VALUE *argv, VALUE self)
{
    VALUE src, file = Qnil, path = Qnil, line = INT2FIX(1), opt = Qnil;
    int i;

    i = rb_scan_args(argc, argv, "1*:", &src, NULL, &opt);
    if (i > 4+NIL_P(opt)) rb_error_arity(argc, 1, 5);
    switch (i) {
      case 5: opt = argv[--i];
      case 4: line = argv[--i];
      case 3: path = argv[--i];
      case 2: file = argv[--i];
    }

    if (NIL_P(file)) file = rb_fstring_lit("<compiled>");
    if (NIL_P(path)) path = file;
    if (NIL_P(line)) line = INT2FIX(1);

    Check_Type(path, T_STRING);
    Check_Type(file, T_STRING);

    return iseqw_new(rb_iseq_compile_with_option(src, file, path, line, opt));
}

Class Attribute Details

.compile_option ⇒ `options` (rw)

Returns a hash of default options used by the Ruby iseq compiler.

For details, see .compile_option=.

[ GitHub ]

# File 'iseq.c', line 1328


static VALUE
iseqw_s_compile_option_get(VALUE self)
{
    return make_compile_option_value(&COMPILE_OPTION_DEFAULT);
}

.compile_option=(options) (rw)

Sets the default values for various optimizations in the Ruby iseq compiler.

Possible values for options include true, which enables all options, false which disables all options, and nil which leaves all options unchanged.

You can also pass a ::Hash of options that you want to change, any options not present in the hash will be left unchanged.

Possible option names (which are keys in options) which can be set to true or false include:

:inline_const_cache
:instructions_unification
:operands_unification
:peephole_optimization
:specialized_instruction
:stack_caching
:tailcall_optimization

Additionally, :debug_level can be set to an integer.

These default options can be overwritten for a single run of the iseq compiler by passing any of the above values as the options parameter to .new, .compile and .compile_file.

[ GitHub ]

# File 'iseq.c', line 1311


static VALUE
iseqw_s_compile_option_set(VALUE self, VALUE opt)
{
    rb_compile_option_t option;
    make_compile_option(&option, opt);
    COMPILE_OPTION_DEFAULT = option;
    return opt;
}

Class Method Details

.compile(source[, file[, path[, line[, options]]]]) ⇒ `iseq` .new(source[, file[, path[, line[, options]]]]) ⇒ `iseq`

Alias for .new.

.compile_file(file[, options]) ⇒ `iseq`

Takes file, a ::String with the location of a Ruby source file, reads, parses and compiles the file, and returns iseq, the compiled InstructionSequence with source location metadata set.

Optionally takes options, which can be true, false or a ::Hash, to modify the default behavior of the Ruby iseq compiler.

For details regarding valid compile options see .compile_option=.

# /tmp/hello.rb
puts "Hello, world!"

# elsewhere
RubyVM::InstructionSequence.compile_file("/tmp/hello.rb")
#=> <RubyVM::InstructionSequence:<main>@/tmp/hello.rb>

[ GitHub ]

# File 'iseq.c', line 1240


static VALUE
iseqw_s_compile_file(int argc, VALUE *argv, VALUE self)
{
    VALUE file, line = INT2FIX(1), opt = Qnil;
    VALUE parser, f, exc = Qnil, ret;
    rb_ast_t *ast;
    rb_compile_option_t option;
    int i;

    i = rb_scan_args(argc, argv, "1*:", &file, NULL, &opt);
    if (i > 1+NIL_P(opt)) rb_error_arity(argc, 1, 2);
    switch (i) {
      case 2: opt = argv[--i];
    }
    FilePathValue(file);
    file = rb_fstring(file); /* rb_io_t->pathv gets frozen anyways */

    f = rb_file_open_str(file, "r");

    parser = rb_parser_new();
    rb_parser_set_context(parser, NULL, FALSE);
    ast = rb_parser_compile_file_path(parser, file, f, NUM2INT(line));
    if (!ast->body.root) exc = GET_EC()->errinfo;

    rb_io_close(f);
    if (!ast->body.root) {
	rb_ast_dispose(ast);
	rb_exc_raise(exc);
    }

    make_compile_option(&option, opt);

    ret = iseqw_new(rb_iseq_new_with_opt(&ast->body, rb_fstring_lit("<main>"),
					 file,
					 rb_realpath_internal(Qnil, file, 1),
					 line, NULL, ISEQ_TYPE_TOP, &option));
    rb_ast_dispose(ast);
    return ret;
}

.disasm(body) ⇒ String .disassemble(body) ⇒ String
Also known as: .disassemble

Takes body, a ::Method or ::Proc object, and returns a ::String with the human readable instructions for body.

For a ::Method object:

# /tmp/method.rb
def hello
  puts "hello, world"
end

puts RubyVM::InstructionSequence.disasm(method(:hello))

Produces:

== disasm: <RubyVM::InstructionSequence:hello@/tmp/method.rb>============
0000 trace            8                                               (   1)
0002 trace            1                                               (   2)
0004 putself
0005 putstring        "hello, world"
0007 send             :puts, 1, nil, 8, <ic:0>
0013 trace            16                                              (   3)
0015 leave                                                            (   2)

For a ::Proc:

# /tmp/proc.rb
p = proc { num = 1 + 2 }
puts RubyVM::InstructionSequence.disasm(p)

Produces:

== disasm: <RubyVM::InstructionSequence:block in <main>@/tmp/proc.rb>===
== catch table
| catch type: redo   st: 0000 ed: 0012 sp: 0000 cont: 0000
| catch type: next   st: 0000 ed: 0012 sp: 0000 cont: 0012
|------------------------------------------------------------------------
local table (size: 2, argc: 0 [opts: 0, rest: -1, post: 0, block: -1] s1)
[ 2] num
0000 trace            1                                               (   1)
0002 putobject        1
0004 putobject        2
0006 opt_plus         <ic:1>
0008 dup
0009 setlocal         num, 0
0012 leave

[ GitHub ]

# File 'iseq.c', line 2526


static VALUE
iseqw_s_disasm(VALUE klass, VALUE body)
{
    VALUE iseqw = iseqw_s_of(klass, body);
    return NIL_P(iseqw) ? Qnil : rb_iseq_disasm(iseqw_check(iseqw));
}

.disasm(body) ⇒ String .disassemble(body) ⇒ String

Alias for .disasm.

.load(*args)

This method is for internal use only.

[ GitHub ]

# File 'iseq.c', line 963


static VALUE
iseq_s_load(int argc, VALUE *argv, VALUE self)
{
    VALUE data, opt=Qnil;
    rb_scan_args(argc, argv, "11", &data, &opt);
    return iseq_load(data, NULL, opt);
}

.load_from_binary(binary) ⇒ `iseq`

Load an iseq object from binary format ::String object created by #to_binary.

This loader does not have a verifier, so that loading broken/modified binary causes critical problem.

You should not load binary data provided by others. You should use binary data translated by yourself.

[ GitHub ]

# File 'iseq.c', line 3367


static VALUE
iseqw_s_load_from_binary(VALUE self, VALUE str)
{
    return iseqw_new(rb_iseq_ibf_load(str));
}

.load_from_binary_extra_data(binary) ⇒ String

Load extra data embed into binary format ::String object.

[ GitHub ]

# File 'iseq.c', line 3379


static VALUE
iseqw_s_load_from_binary_extra_data(VALUE self, VALUE str)
{
    return rb_iseq_ibf_load_extra_data(str);
}

.of(body)

Returns the instruction sequence containing the given proc or method.

For example, using irb:

# a proc
> p = proc { num = 1 + 2 }
> RubyVM::InstructionSequence.of(p)
> #=> <RubyVM::InstructionSequence:block in irb_binding@(irb)>

# for a method
> def foo(bar); puts bar; end
> RubyVM::InstructionSequence.of(method(:foo))
> #=> <RubyVM::InstructionSequence:foo@(irb)>

Using .compile_file:

# /tmp/iseq_of.rb
def hello
  puts "hello, world"
end

$a_global_proc = proc { str = 'a' + 'b' }

# in irb
> require '/tmp/iseq_of.rb'

# first the method hello
> RubyVM::InstructionSequence.of(method(:hello))
> #=> #<RubyVM::InstructionSequence:0x007fb73d7cb1d0>

# then the global proc
> RubyVM::InstructionSequence.of($a_global_proc)
> #=> #<RubyVM::InstructionSequence:0x007fb73d7caf78>

[ GitHub ]

# File 'iseq.c', line 2452


static VALUE
iseqw_s_of(VALUE klass, VALUE body)
{
    const rb_iseq_t *iseq = NULL;

    if (rb_obj_is_proc(body)) {
        iseq = vm_proc_iseq(body);

        if (!rb_obj_is_iseq((VALUE)iseq)) {
            iseq = NULL;
        }
    }
    else if (rb_obj_is_method(body)) {
        iseq = rb_method_iseq(body);
    }
    else if (rb_typeddata_is_instance_of(body, &iseqw_data_type)) {
        return body;
    }

    return iseq ? iseqw_new(iseq) : Qnil;
}

Instance Method Details

#absolute_path

Returns the absolute path of this instruction sequence.

nil if the iseq was evaluated from a string.

For example, using .compile_file:

# /tmp/method.rb
def hello
  puts "hello, world"
end

# in irb
> iseq = RubyVM::InstructionSequence.compile_file('/tmp/method.rb')
> iseq.absolute_path #=> /tmp/method.rb

[ GitHub ]

# File 'iseq.c', line 1436


static VALUE
iseqw_absolute_path(VALUE self)
{
    return rb_iseq_realpath(iseqw_check(self));
}

#base_label

Returns the base label of this instruction sequence.

For example, using irb:

iseq = RubyVM::InstructionSequence.compile('num = 1 + 2')
#=> <RubyVM::InstructionSequence:<compiled>@<compiled>>
iseq.base_label
#=> "<compiled>"

Using .compile_file:

# /tmp/method.rb
def hello
  puts "hello, world"
end

# in irb
> iseq = RubyVM::InstructionSequence.compile_file('/tmp/method.rb')
> iseq.base_label #=> <main>

[ GitHub ]

# File 'iseq.c', line 1491


static VALUE
iseqw_base_label(VALUE self)
{
    return rb_iseq_base_label(iseqw_check(self));
}

#disasm ⇒ String #disassemble ⇒ String
Also known as: #disassemble

Returns the instruction sequence as a ::String in human readable form.

puts RubyVM::InstructionSequence.compile('1 + 2').disasm

Produces:

== disasm: <RubyVM::InstructionSequence:<compiled>@<compiled>>==========
0000 trace            1                                               (   1)
0002 putobject        1
0004 putobject        2
0006 opt_plus         <ic:1>
0008 leave

[ GitHub ]

# File 'iseq.c', line 2301


static VALUE
iseqw_disasm(VALUE self)
{
    return rb_iseq_disasm(iseqw_check(self));
}

#disasm ⇒ String #disassemble ⇒ String

Alias for #disasm.

#each_child {|child_iseq| ... } ⇒ `iseq`

Iterate all direct child instruction sequences. Iteration order is implementation/version defined so that people should not rely on the order.

[ GitHub ]

# File 'iseq.c', line 2371


static VALUE
iseqw_each_child(VALUE self)
{
    const rb_iseq_t *iseq = iseqw_check(self);
    iseq_iterate_children(iseq, yield_each_children, NULL);
    return self;
}

#eval ⇒ Object

Evaluates the instruction sequence and returns the result.

RubyVM::InstructionSequence.compile("1 + 2").eval #=> 3

[ GitHub ]

# File 'iseq.c', line 1363


static VALUE
iseqw_eval(VALUE self)
{
    return rb_iseq_eval(iseqw_check(self));
}

#first_lineno

Returns the number of the first source line where the instruction sequence was loaded from.

For example, using irb:

iseq = RubyVM::InstructionSequence.compile('num = 1 + 2')
#=> <RubyVM::InstructionSequence:<compiled>@<compiled>>
iseq.first_lineno
#=> 1

[ GitHub ]

# File 'iseq.c', line 1507


static VALUE
iseqw_first_lineno(VALUE self)
{
    return rb_iseq_first_lineno(iseqw_check(self));
}

#inspect

Returns a human-readable string representation of this instruction sequence, including the #label and #path.

[ GitHub ]

# File 'iseq.c', line 1373


static VALUE
iseqw_inspect(VALUE self)
{
    const rb_iseq_t *iseq = iseqw_check(self);
    const struct rb_iseq_constant_body *const body = iseq->body;
    VALUE klass = rb_class_name(rb_obj_class(self));

    if (!body->location.label) {
	return rb_sprintf("#<%"PRIsVALUE": uninitialized>", klass);
    }
    else {
	return rb_sprintf("<%"PRIsVALUE":%"PRIsVALUE"@%"PRIsVALUE":%d>",
			  klass,
			  body->location.label, rb_iseq_path(iseq),
			  FIX2INT(rb_iseq_first_lineno(iseq)));
    }
}

#label

Returns the label of this instruction sequence.

<main> if it’s at the top level, <compiled> if it was evaluated from a string.

For example, using irb:

iseq = RubyVM::InstructionSequence.compile('num = 1 + 2')
#=> <RubyVM::InstructionSequence:<compiled>@<compiled>>
iseq.label
#=> "<compiled>"

Using .compile_file:

# /tmp/method.rb
def hello
  puts "hello, world"
end

# in irb
> iseq = RubyVM::InstructionSequence.compile_file('/tmp/method.rb')
> iseq.label #=> <main>

[ GitHub ]

# File 'iseq.c', line 1465


static VALUE
iseqw_label(VALUE self)
{
    return rb_iseq_label(iseqw_check(self));
}

#marshal_dump (private)

[ GitHub ]

#marshal_load (private)

[ GitHub ]

#path

Returns the path of this instruction sequence.

<compiled> if the iseq was evaluated from a string.

For example, using irb:

iseq = RubyVM::InstructionSequence.compile('num = 1 + 2')
#=> <RubyVM::InstructionSequence:<compiled>@<compiled>>
iseq.path
#=> "<compiled>"

Using .compile_file:

# /tmp/method.rb
def hello
  puts "hello, world"
end

# in irb
> iseq = RubyVM::InstructionSequence.compile_file('/tmp/method.rb')
> iseq.path #=> /tmp/method.rb

[ GitHub ]

# File 'iseq.c', line 1414


static VALUE
iseqw_path(VALUE self)
{
    return rb_iseq_path(iseqw_check(self));
}

#to_a ⇒ Array

Returns an ::Array with 14 elements representing the instruction sequence with the following data:

magic

A string identifying the data format. Always YARVInstructionSequence/SimpleDataFormat.

major_version

The major version of the instruction sequence.

minor_version

The minor version of the instruction sequence.

format_type

A number identifying the data format. Always 1.

misc

A hash containing:

:arg_size: the total number of arguments taken by the method or the block (0 if iseq doesn’t represent a method or block)
:local_size: the number of local variables + 1
:stack_max: used in calculating the stack depth at which a SystemStackError is thrown.

#label

The name of the context (block, method, class, module, etc.) that this instruction sequence belongs to.

<main> if it’s at the top level, <compiled> if it was evaluated from a string.

#path

The relative path to the Ruby file where the instruction sequence was loaded from.

<compiled> if the iseq was evaluated from a string.

#absolute_path

The absolute path to the Ruby file where the instruction sequence was loaded from.

nil if the iseq was evaluated from a string.

#first_lineno

The number of the first source line where the instruction sequence was loaded from.

type

The type of the instruction sequence.

Valid values are :top, :method, :block, :class, :rescue, :ensure, :eval, :main, and plain.

locals

An array containing the names of all arguments and local variables as symbols.

params

An Hash object containing parameter information.

More info about these values can be found in vm_core.h.

catch_table

A list of exceptions and control flow operators (rescue, next, redo, break, etc.).

bytecode

An array of arrays containing the instruction names and operands that make up the body of the instruction sequence.

Note that this format is MRI specific and version dependent.

[ GitHub ]

# File 'iseq.c', line 1596


static VALUE
iseqw_to_a(VALUE self)
{
    const rb_iseq_t *iseq = iseqw_check(self);
    return iseq_data_to_ary(iseq);
}

#to_binary(extra_data = nil) ⇒ `binary` `str`

Returns serialized iseq binary format data as a ::String object. A corresponding iseq object is created by InstructionSequence.load_from_binary() method.

::String extra_data will be saved with binary data. You can access this data with InstructionSequence.load_from_binary_extra_data(binary).

Note that the translated binary data is not portable. You can not move this binary data to another machine. You can not use the binary data which is created by another version/another architecture of Ruby.

[ GitHub ]

# File 'iseq.c', line 3347


static VALUE
iseqw_to_binary(int argc, VALUE *argv, VALUE self)
{
    VALUE opt = !rb_check_arity(argc, 0, 1) ? Qnil : argv[0];
    return rb_iseq_ibf_dump(iseqw_check(self), opt);
}

#trace_points ⇒ Array

Return trace points in the instruction sequence. Return an array of [line, event_symbol] pair.

[ GitHub ]

# File 'iseq.c', line 2400


static VALUE
iseqw_trace_points(VALUE self)
{
    const rb_iseq_t *iseq = iseqw_check(self);
    const struct rb_iseq_constant_body *const body = iseq->body;
    unsigned int i;
    VALUE ary = rb_ary_new();

    for (i=0; i<body->insns_info.size; i++) {
	const struct iseq_insn_info_entry *entry = &body->insns_info.body[i];
	if (entry->events) {
	    push_event_info(iseq, entry->events, entry->line_no, ary);
	}
    }
    return ary;
}

Class: RubyVM::InstructionSequence

Overview

Class Attribute Summary

Class Method Summary

Instance Method Summary

Constructor Details

.compile(source[, file[, path[, line[, options]]]]) ⇒ iseq .new(source[, file[, path[, line[, options]]]]) ⇒ iseq Also known as: .compile

Class Attribute Details

.compile_option ⇒ options (rw)

.compile_option=(options) (rw)

Class Method Details

.compile(source[, file[, path[, line[, options]]]]) ⇒ iseq .new(source[, file[, path[, line[, options]]]]) ⇒ iseq

.compile_file(file[, options]) ⇒ iseq

.disasm(body) ⇒ String .disassemble(body) ⇒ String Also known as: .disassemble

.disasm(body) ⇒ String .disassemble(body) ⇒ String

.load(*args)

.load_from_binary(binary) ⇒ iseq

.load_from_binary_extra_data(binary) ⇒ String

.of(body)

Instance Method Details

#absolute_path

#base_label

#disasm ⇒ String #disassemble ⇒ String Also known as: #disassemble

#disasm ⇒ String #disassemble ⇒ String

#each_child {|child_iseq| ... } ⇒ iseq

#eval ⇒ Object

#first_lineno

#inspect

#label

#marshal_dump (private)

#marshal_load (private)

#path

#to_a ⇒ Array

#to_binary(extra_data = nil) ⇒ binary str

#trace_points ⇒ Array

.compile(source[, file[, path[, line[, options]]]]) ⇒ `iseq` .new(source[, file[, path[, line[, options]]]]) ⇒ `iseq`
Also known as: .compile

.compile_option ⇒ `options` (rw)

.compile(source[, file[, path[, line[, options]]]]) ⇒ `iseq` .new(source[, file[, path[, line[, options]]]]) ⇒ `iseq`

.compile_file(file[, options]) ⇒ `iseq`

.disasm(body) ⇒ String .disassemble(body) ⇒ String
Also known as: .disassemble

.load_from_binary(binary) ⇒ `iseq`

#disasm ⇒ String #disassemble ⇒ String
Also known as: #disassemble

#each_child {|child_iseq| ... } ⇒ `iseq`

#to_binary(extra_data = nil) ⇒ `binary` `str`