?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
* process.c (rb_spawn_internal): new function to specify
[ruby-svn.git] / iseq.c
blobf475ca7a3789e77fac05f4f9634bb1ebacd583ae
1 /**********************************************************************
2
3 iseq.c -
4
5 $Author$
6 created at: 2006-07-11(Tue) 09:00:03 +0900
7
8 Copyright (C) 2006 Koichi Sasada
9
10 **********************************************************************/
11
12 #include "ruby/ruby.h"
13 #include "ruby/node.h"
14
15 /* #define MARK_FREE_DEBUG 1 */
16 #include "gc.h"
17 #include "vm_core.h"
18
19 #include "insns.inc"
20 #include "insns_info.inc"
21
22 /* compile.c */
23 void iseq_compile(VALUE self, NODE *node);
24 int iseq_translate_threaded_code(rb_iseq_t *iseq);
25
26 VALUE rb_cISeq;
27
28 static void
29 compile_data_free(struct iseq_compile_data *compile_data)
30 {
31 if (compile_data) {
32 struct iseq_compile_data_storage *cur, *next;
33 cur = compile_data->storage_head;
34 while (cur) {
35 next = cur->next;
36 ruby_xfree(cur);
37 cur = next;
38 }
39 ruby_xfree(compile_data);
40 }
41 }
42
43 static void
44 iseq_free(void *ptr)
45 {
46 rb_iseq_t *iseq;
47 RUBY_FREE_ENTER("iseq");
48
49 if (ptr) {
50 iseq = ptr;
51 /* It's possible that strings are freed
52 * GC_INFO("%s @ %s\n", RSTRING_PTR(iseq->name),
53 * RSTRING_PTR(iseq->filename));
54 */
55 if (iseq->iseq != iseq->iseq_encoded) {
56 RUBY_FREE_UNLESS_NULL(iseq->iseq_encoded);
57 }
58
59 RUBY_FREE_UNLESS_NULL(iseq->iseq);
60 RUBY_FREE_UNLESS_NULL(iseq->insn_info_table);
61 RUBY_FREE_UNLESS_NULL(iseq->local_table);
62 RUBY_FREE_UNLESS_NULL(iseq->catch_table);
63 RUBY_FREE_UNLESS_NULL(iseq->arg_opt_table);
64 compile_data_free(iseq->compile_data);
65 ruby_xfree(ptr);
66 }
67 RUBY_FREE_LEAVE("iseq");
68 }
69
70 static void
71 iseq_mark(void *ptr)
72 {
73 rb_iseq_t *iseq;
74 RUBY_MARK_ENTER("iseq");
75
76 if (ptr) {
77 iseq = ptr;
78 RUBY_GC_INFO("%s @ %s\n", RSTRING_PTR(iseq->name), RSTRING_PTR(iseq->filename));
79 RUBY_MARK_UNLESS_NULL(iseq->mark_ary);
80 RUBY_MARK_UNLESS_NULL(iseq->name);
81 RUBY_MARK_UNLESS_NULL(iseq->filename);
82 RUBY_MARK_UNLESS_NULL((VALUE)iseq->cref_stack);
83 RUBY_MARK_UNLESS_NULL(iseq->klass);
84 /* RUBY_MARK_UNLESS_NULL((VALUE)iseq->node); */
85 /* RUBY_MARK_UNLESS_NULL(iseq->cached_special_block); */
86
87 if (iseq->compile_data != 0) {
88 RUBY_MARK_UNLESS_NULL(iseq->compile_data->mark_ary);
89 RUBY_MARK_UNLESS_NULL(iseq->compile_data->err_info);
90 RUBY_MARK_UNLESS_NULL(iseq->compile_data->catch_table_ary);
91 }
92 }
93 RUBY_MARK_LEAVE("iseq");
94 }
95
96 static VALUE
97 iseq_alloc(VALUE klass)
98 {
99 VALUE volatile obj;
100 rb_iseq_t *iseq;
101
102 obj = Data_Make_Struct(klass, rb_iseq_t, iseq_mark, iseq_free, iseq);
103 MEMZERO(iseq, rb_iseq_t, 1);
104 return obj;
105 }
106
107 static void
108 set_relation(rb_iseq_t *iseq, const VALUE parent)
109 {
110 const int type = iseq->type;
111 rb_thread_t *th = GET_THREAD();
112
113 /* set class nest stack */
114 if (type == ISEQ_TYPE_TOP) {
115 /* toplevel is private */
116 iseq->cref_stack = NEW_BLOCK(th->top_wrapper ? th->top_wrapper : rb_cObject);
117 iseq->cref_stack->nd_file = 0;
118 iseq->cref_stack->nd_visi = NOEX_PRIVATE;
119 }
120 else if (type == ISEQ_TYPE_METHOD || type == ISEQ_TYPE_CLASS) {
121 iseq->cref_stack = NEW_BLOCK(0); /* place holder */
122 iseq->cref_stack->nd_file = 0;
123 }
124 else if (RTEST(parent)) {
125 rb_iseq_t *piseq;
126 GetISeqPtr(parent, piseq);
127 iseq->cref_stack = piseq->cref_stack;
128 }
129
130 if (type == ISEQ_TYPE_TOP ||
131 type == ISEQ_TYPE_METHOD || type == ISEQ_TYPE_CLASS) {
132 iseq->local_iseq = iseq;
133 }
134 else if (RTEST(parent)) {
135 rb_iseq_t *piseq;
136 GetISeqPtr(parent, piseq);
137 iseq->local_iseq = piseq->local_iseq;
138 }
139
140 if (RTEST(parent)) {
141 rb_iseq_t *piseq;
142 GetISeqPtr(parent, piseq);
143 iseq->parent_iseq = piseq;
144 }
145 }
146
147 static VALUE
148 prepare_iseq_build(rb_iseq_t *iseq,
149 VALUE name, VALUE filename,
150 VALUE parent, VALUE type, VALUE block_opt,
151 const rb_compile_option_t *option)
152 {
153 OBJ_FREEZE(name);
154 OBJ_FREEZE(filename);
155
156 iseq->name = name;
157 iseq->filename = filename;
158 iseq->defined_method_id = 0;
159 iseq->mark_ary = rb_ary_new();
160 RBASIC(iseq->mark_ary)->klass = 0;
161
162 iseq->type = type;
163 iseq->arg_rest = -1;
164 iseq->arg_block = -1;
165 iseq->klass = 0;
166
167 /*
168 * iseq->special_block_builder = GC_GUARDED_PTR_REF(block_opt);
169 * iseq->cached_special_block_builder = 0;
170 * iseq->cached_special_block = 0;
171 */
172
173 iseq->compile_data = ALLOC(struct iseq_compile_data);
174 MEMZERO(iseq->compile_data, struct iseq_compile_data, 1);
175 iseq->compile_data->mark_ary = rb_ary_new();
176 RBASIC(iseq->compile_data->mark_ary)->klass = 0;
177
178 iseq->compile_data->storage_head = iseq->compile_data->storage_current =
179 (struct iseq_compile_data_storage *)
180 ALLOC_N(char, INITIAL_ISEQ_COMPILE_DATA_STORAGE_BUFF_SIZE +
181 sizeof(struct iseq_compile_data_storage));
182
183 iseq->compile_data->catch_table_ary = rb_ary_new();
184 iseq->compile_data->storage_head->pos = 0;
185 iseq->compile_data->storage_head->next = 0;
186 iseq->compile_data->storage_head->size =
187 INITIAL_ISEQ_COMPILE_DATA_STORAGE_BUFF_SIZE;
188 iseq->compile_data->storage_head->buff =
189 (char *)(&iseq->compile_data->storage_head->buff + 1);
190 iseq->compile_data->option = option;
191
192 set_relation(iseq, parent);
193
194 return Qtrue;
195 }
196
197 static VALUE
198 cleanup_iseq_build(rb_iseq_t *iseq)
199 {
200 struct iseq_compile_data *data = iseq->compile_data;
201 VALUE err = data->err_info;
202 iseq->compile_data = 0;
203 compile_data_free(data);
204
205 if (RTEST(err)) {
206 rb_funcall2(err, rb_intern("set_backtrace"), 1, &iseq->filename);
207 rb_exc_raise(err);
208 }
209 return Qtrue;
210 }
211
212 static rb_compile_option_t COMPILE_OPTION_DEFAULT = {
213 OPT_INLINE_CONST_CACHE, /* int inline_const_cache; */
214 OPT_PEEPHOLE_OPTIMIZATION, /* int peephole_optimization; */
215 OPT_TAILCALL_OPTIMIZATION, /* int tailcall_optimization */
216 OPT_SPECIALISED_INSTRUCTION, /* int specialized_instruction; */
217 OPT_OPERANDS_UNIFICATION, /* int operands_unification; */
218 OPT_INSTRUCTIONS_UNIFICATION, /* int instructions_unification; */
219 OPT_STACK_CACHING, /* int stack_caching; */
220 OPT_TRACE_INSTRUCTION, /* int trace_instruction */
221 };
222 static const rb_compile_option_t COMPILE_OPTION_FALSE;
223
224 static void
225 make_compile_option(rb_compile_option_t *option, VALUE opt)
226 {
227 if (opt == Qnil) {
228 *option = COMPILE_OPTION_DEFAULT;
229 }
230 else if (opt == Qfalse) {
231 *option = COMPILE_OPTION_FALSE;
232 }
233 else if (opt == Qtrue) {
234 memset(option, 1, sizeof(rb_compile_option_t));
235 }
236 else if (CLASS_OF(opt) == rb_cHash) {
237 *option = COMPILE_OPTION_DEFAULT;
238
239 #define SET_COMPILE_OPTION(o, h, mem) \
240 { VALUE flag = rb_hash_aref(h, ID2SYM(rb_intern(#mem))); \
241 if (flag == Qtrue) { o->mem = 1; } \
242 else if (flag == Qfalse) { o->mem = 0; } \
243 }
244 #define SET_COMPILE_OPTION_NUM(o, h, mem) \
245 { VALUE num = rb_hash_aref(opt, ID2SYM(rb_intern(#mem))); \
246 if (!NIL_P(num)) o->mem = NUM2INT(num); \
247 }
248 SET_COMPILE_OPTION(option, opt, inline_const_cache);
249 SET_COMPILE_OPTION(option, opt, peephole_optimization);
250 SET_COMPILE_OPTION(option, opt, tailcall_optimization);
251 SET_COMPILE_OPTION(option, opt, specialized_instruction);
252 SET_COMPILE_OPTION(option, opt, operands_unification);
253 SET_COMPILE_OPTION(option, opt, instructions_unification);
254 SET_COMPILE_OPTION(option, opt, stack_caching);
255 SET_COMPILE_OPTION(option, opt, trace_instruction);
256 SET_COMPILE_OPTION_NUM(option, opt, debug_level);
257 #undef SET_COMPILE_OPTION
258 #undef SET_COMPILE_OPTION_NUM
259 }
260 else {
261 rb_raise(rb_eTypeError, "Compile option must be Hash/true/false/nil");
262 }
263 }
264
265 static VALUE
266 make_compile_option_value(rb_compile_option_t *option)
267 {
268 VALUE opt = rb_hash_new();
269 #define SET_COMPILE_OPTION(o, h, mem) \
270 rb_hash_aset(h, ID2SYM(rb_intern(#mem)), o->mem ? Qtrue : Qfalse)
271 #define SET_COMPILE_OPTION_NUM(o, h, mem) \
272 rb_hash_aset(h, ID2SYM(rb_intern(#mem)), INT2NUM(o->mem))
273 {
274 SET_COMPILE_OPTION(option, opt, inline_const_cache);
275 SET_COMPILE_OPTION(option, opt, peephole_optimization);
276 SET_COMPILE_OPTION(option, opt, tailcall_optimization);
277 SET_COMPILE_OPTION(option, opt, specialized_instruction);
278 SET_COMPILE_OPTION(option, opt, operands_unification);
279 SET_COMPILE_OPTION(option, opt, instructions_unification);
280 SET_COMPILE_OPTION(option, opt, stack_caching);
281 SET_COMPILE_OPTION_NUM(option, opt, debug_level);
282 }
283 #undef SET_COMPILE_OPTION
284 #undef SET_COMPILE_OPTION_NUM
285 return opt;
286 }
287
288 VALUE
289 rb_iseq_new(NODE *node, VALUE name, VALUE filename,
290 VALUE parent, VALUE type)
291 {
292 return rb_iseq_new_with_opt(node, name, filename, parent, type,
293 &COMPILE_OPTION_DEFAULT);
294 }
295
296 static VALUE
297 rb_iseq_new_with_bopt_and_opt(NODE *node, VALUE name, VALUE filename,
298 VALUE parent, VALUE type, VALUE bopt,
299 const rb_compile_option_t *option)
300 {
301 rb_iseq_t *iseq;
302 VALUE self = iseq_alloc(rb_cISeq);
303
304 GetISeqPtr(self, iseq);
305 iseq->self = self;
306
307 prepare_iseq_build(iseq, name, filename, parent, type, bopt, option);
308 iseq_compile(self, node);
309 cleanup_iseq_build(iseq);
310 return self;
311 }
312
313 VALUE
314 rb_iseq_new_with_opt(NODE *node, VALUE name, VALUE filename,
315 VALUE parent, VALUE type,
316 const rb_compile_option_t *option)
317 {
318 return rb_iseq_new_with_bopt_and_opt(node, name, filename, parent, type,
319 Qfalse, option);
320 }
321
322 VALUE
323 rb_iseq_new_with_bopt(NODE *node, VALUE name, VALUE filename,
324 VALUE parent, VALUE type, VALUE bopt)
325 {
326 return rb_iseq_new_with_bopt_and_opt(node, name, filename, parent, type,
327 bopt, &COMPILE_OPTION_DEFAULT);
328 }
329
330 VALUE iseq_build_from_ary(rb_iseq_t *iseq, VALUE locals, VALUE args,
331 VALUE exception, VALUE body);
332
333 #define CHECK_ARRAY(v) rb_convert_type(v, T_ARRAY, "Array", "to_ary")
334 #define CHECK_STRING(v) rb_convert_type(v, T_STRING, "String", "to_str")
335 #define CHECK_SYMBOL(v) rb_convert_type(v, T_SYMBOL, "Symbol", "to_sym")
336 static inline VALUE CHECK_INTEGER(VALUE v) {NUM2LONG(v); return v;}
337 VALUE
338 iseq_load(VALUE self, VALUE data, VALUE parent, VALUE opt)
339 {
340 VALUE iseqval = iseq_alloc(rb_cISeq);
341
342 VALUE magic, version1, version2, format_type, misc;
343 VALUE name, filename;
344 VALUE type, body, locals, args, exception;
345
346 VALUE iseq_type;
347 struct st_table *type_map = 0;
348 rb_iseq_t *iseq;
349 rb_compile_option_t option;
350 int i = 0;
351
352 /* [magic, major_version, minor_version, format_type, misc,
353 * name, filename,
354 * type, locals, args, exception_table, body]
355 */
356
357 data = CHECK_ARRAY(data);
358
359 magic = CHECK_STRING(rb_ary_entry(data, i++));
360 version1 = CHECK_INTEGER(rb_ary_entry(data, i++));
361 version2 = CHECK_INTEGER(rb_ary_entry(data, i++));
362 format_type = CHECK_INTEGER(rb_ary_entry(data, i++));
363 misc = rb_ary_entry(data, i++); /* TODO */
364
365 name = CHECK_STRING(rb_ary_entry(data, i++));
366 filename = CHECK_STRING(rb_ary_entry(data, i++));
367
368 type = CHECK_SYMBOL(rb_ary_entry(data, i++));
369 locals = CHECK_ARRAY(rb_ary_entry(data, i++));
370
371 args = rb_ary_entry(data, i++);
372 if (FIXNUM_P(args) || (args = CHECK_ARRAY(args))) {
373 /* */
374 }
375
376 exception = CHECK_ARRAY(rb_ary_entry(data, i++));
377 body = CHECK_ARRAY(rb_ary_entry(data, i++));
378
379 GetISeqPtr(iseqval, iseq);
380 iseq->self = iseqval;
381
382 if (type_map == 0) {
383 type_map = st_init_numtable();
384 st_insert(type_map, ID2SYM(rb_intern("top")), ISEQ_TYPE_TOP);
385 st_insert(type_map, ID2SYM(rb_intern("method")), ISEQ_TYPE_METHOD);
386 st_insert(type_map, ID2SYM(rb_intern("block")), ISEQ_TYPE_BLOCK);
387 st_insert(type_map, ID2SYM(rb_intern("class")), ISEQ_TYPE_CLASS);
388 st_insert(type_map, ID2SYM(rb_intern("rescue")), ISEQ_TYPE_RESCUE);
389 st_insert(type_map, ID2SYM(rb_intern("ensure")), ISEQ_TYPE_ENSURE);
390 st_insert(type_map, ID2SYM(rb_intern("eval")), ISEQ_TYPE_EVAL);
391 }
392
393 if (st_lookup(type_map, type, &iseq_type) == 0) {
394 const char *typename = rb_id2name(type);
395 if (typename)
396 rb_raise(rb_eTypeError, "unsupport type: :%s", typename);
397 else
398 rb_raise(rb_eTypeError, "unsupport type: %p", (void *)type);
399 }
400
401 if (parent == Qnil) {
402 parent = 0;
403 }
404
405 make_compile_option(&option, opt);
406 prepare_iseq_build(iseq, name, filename,
407 parent, iseq_type, 0, &option);
408
409 iseq_build_from_ary(iseq, locals, args, exception, body);
410
411 cleanup_iseq_build(iseq);
412 return iseqval;
413 }
414
415 static VALUE
416 iseq_s_load(int argc, VALUE *argv, VALUE self)
417 {
418 VALUE data, opt=Qnil;
419 rb_scan_args(argc, argv, "11", &data, &opt);
420
421 return iseq_load(self, data, 0, opt);
422 }
423
424 static NODE *
425 compile_string(VALUE str, VALUE file, VALUE line)
426 {
427 VALUE parser = rb_parser_new();
428 NODE *node = rb_parser_compile_string(parser, StringValueCStr(file),
429 str, NUM2INT(line));
430
431 if (!node) {
432 rb_exc_raise(GET_THREAD()->errinfo); /* TODO: check err */
433 }
434 return node;
435 }
436
437 VALUE
438 rb_iseq_compile_with_option(VALUE src, VALUE file, VALUE line, VALUE opt)
439 {
440 rb_compile_option_t option;
441 NODE *node = compile_string(StringValue(src), file, line);
442 rb_thread_t *th = GET_THREAD();
443 make_compile_option(&option, opt);
444
445 if (th->base_block) {
446 return rb_iseq_new_with_opt(node, th->base_block->iseq->name,
447 file, th->base_block->iseq->self,
448 ISEQ_TYPE_EVAL, &option);
449 }
450 else {
451 return rb_iseq_new_with_opt(node, rb_str_new2("<compiled>"), file, Qfalse,
452 ISEQ_TYPE_TOP, &option);
453 }
454 }
455
456 VALUE
457 rb_iseq_compile(VALUE src, VALUE file, VALUE line)
458 {
459 return rb_iseq_compile_with_option(src, file, line, Qnil);
460 }
461
462 static VALUE
463 iseq_s_compile(int argc, VALUE *argv, VALUE self)
464 {
465 VALUE src, file = Qnil, line = INT2FIX(1), opt = Qnil;
466
467 rb_secure(1);
468
469 rb_scan_args(argc, argv, "13", &src, &file, &line, &opt);
470 file = file == Qnil ? rb_str_new2("<compiled>") : file;
471 line = line == Qnil ? INT2FIX(1) : line;
472
473 return rb_iseq_compile_with_option(src, file, line, opt);
474 }
475
476 static VALUE
477 iseq_s_compile_file(int argc, VALUE *argv, VALUE self)
478 {
479 VALUE file, line = INT2FIX(1), opt = Qnil;
480 VALUE parser;
481 VALUE f;
482 NODE *node;
483 const char *fname;
484 rb_compile_option_t option;
485
486 rb_secure(1);
487 rb_scan_args(argc, argv, "11", &file, &opt);
488 fname = StringValueCStr(file);
489
490 f = rb_file_open(fname, "r");
491
492 parser = rb_parser_new();
493 node = rb_parser_compile_file(parser, fname, f, NUM2INT(line));
494 make_compile_option(&option, opt);
495 return rb_iseq_new_with_opt(node, rb_str_new2("<main>"), file, Qfalse,
496 ISEQ_TYPE_TOP, &option);
497 }
498
499 static VALUE
500 iseq_s_compile_option_set(VALUE self, VALUE opt)
501 {
502 rb_compile_option_t option;
503 rb_secure(1);
504 make_compile_option(&option, opt);
505 COMPILE_OPTION_DEFAULT = option;
506 return opt;
507 }
508
509 static VALUE
510 iseq_s_compile_option_get(VALUE self)
511 {
512 return make_compile_option_value(&COMPILE_OPTION_DEFAULT);
513 }
514
515 static rb_iseq_t *
516 iseq_check(VALUE val)
517 {
518 rb_iseq_t *iseq;
519 GetISeqPtr(val, iseq);
520 if (!iseq->name) {
521 rb_raise(rb_eTypeError, "uninitialized InstructionSequence");
522 }
523 return iseq;
524 }
525
526 static VALUE
527 iseq_eval(VALUE self)
528 {
529 rb_secure(1);
530 return rb_iseq_eval(self);
531 }
532
533 static VALUE
534 iseq_inspect(VALUE self)
535 {
536 char buff[0x100];
537 rb_iseq_t *iseq = iseq_check(self);
538
539 snprintf(buff, sizeof(buff), "<ISeq:%s@%s>",
540 RSTRING_PTR(iseq->name), RSTRING_PTR(iseq->filename));
541
542 return rb_str_new2(buff);
543 }
544
545 VALUE iseq_data_to_ary(rb_iseq_t *iseq);
546
547 static VALUE
548 iseq_to_a(VALUE self)
549 {
550 rb_iseq_t *iseq = iseq_check(self);
551 rb_secure(1);
552 return iseq_data_to_ary(iseq);
553 }
554
555 /* TODO: search algorithm is brute force.
556 this should be binary search or so. */
557
558 static struct iseq_insn_info_entry *
559 get_insn_info(const rb_iseq_t *iseq, const unsigned long pos)
560 {
561 unsigned long i, size = iseq->insn_info_size;
562 struct iseq_insn_info_entry *table = iseq->insn_info_table;
563
564 for (i = 0; i < size; i++) {
565 if (table[i].position == pos) {
566 return &table[i];
567 }
568 }
569
570 return 0;
571 }
572
573 static unsigned short
574 find_line_no(rb_iseq_t *iseq, unsigned long pos)
575 {
576 struct iseq_insn_info_entry *entry = get_insn_info(iseq, pos);
577 if (entry) {
578 return entry->line_no;
579 }
580 else {
581 return 0;
582 }
583 }
584
585 static unsigned short
586 find_prev_line_no(rb_iseq_t *iseqdat, unsigned long pos)
587 {
588 unsigned long i, size = iseqdat->insn_info_size;
589 struct iseq_insn_info_entry *iiary = iseqdat->insn_info_table;
590
591 for (i = 0; i < size; i++) {
592 if (iiary[i].position == pos) {
593 if (i > 0) {
594 return iiary[i - 1].line_no;
595 }
596 else {
597 return 0;
598 }
599 }
600 }
601
602 return 0;
603 }
604
605 static VALUE
606 insn_operand_intern(rb_iseq_t *iseq,
607 int insn, int op_no, VALUE op,
608 int len, int pos, VALUE *pnop, VALUE child)
609 {
610 const char *types = insn_op_types(insn);
611 char type = types[op_no];
612 VALUE ret;
613 char buff[0x100];
614
615 switch (type) {
616 case TS_OFFSET: /* LONG */
617 snprintf(buff, sizeof(buff), "%ld", pos + len + op);
618 ret = rb_str_new2(buff);
619 break;
620
621 case TS_NUM: /* ULONG */
622 snprintf(buff, sizeof(buff), "%lu", op);
623 ret = rb_str_new2(buff);
624 break;
625
626 case TS_LINDEX:
627 {
628 rb_iseq_t *ip = iseq->local_iseq;
629 int lidx = ip->local_size - op;
630 const char *name = rb_id2name(ip->local_table[lidx]);
631
632 if (name) {
633 ret = rb_str_new2(name);
634 }
635 else {
636 ret = rb_str_new2("*");
637 }
638 break;
639 }
640 case TS_DINDEX:{
641 if (insn == BIN(getdynamic) || insn == BIN(setdynamic)) {
642 rb_iseq_t *ip = iseq;
643 int level = *pnop, i;
644 const char *name;
645 for (i = 0; i < level; i++) {
646 ip = ip->parent_iseq;
647 }
648 name = rb_id2name(ip->local_table[ip->local_size - op]);
649
650 if (!name) {
651 name = "*";
652 }
653 ret = rb_str_new2(name);
654 }
655 else {
656 ret = rb_inspect(INT2FIX(op));
657 }
658 break;
659 }
660 case TS_ID: /* ID (symbol) */
661 op = ID2SYM(op);
662 case TS_VALUE: /* VALUE */
663 ret = rb_inspect(op);
664 if (CLASS_OF(op) == rb_cISeq) {
665 rb_ary_push(child, op);
666 }
667 break;
668
669 case TS_ISEQ: /* iseq */
670 {
671 rb_iseq_t *iseq = (rb_iseq_t *)op;
672 if (iseq) {
673 ret = iseq->name;
674 if (child) {
675 rb_ary_push(child, iseq->self);
676 }
677 }
678 else {
679 ret = rb_str_new2("nil");
680 }
681 break;
682 }
683 case TS_GENTRY:
684 {
685 struct global_entry *entry = (struct global_entry *)op;
686 ret = rb_str_dup(rb_id2str(entry->id));
687 }
688 break;
689
690 case TS_IC:
691 ret = rb_str_new2("<ic>");
692 break;
693
694 case TS_CDHASH:
695 ret = rb_str_new2("<cdhash>");
696 break;
697
698 case TS_FUNCPTR:
699 ret = rb_str_new2("<funcptr>");
700 break;
701
702 default:
703 rb_bug("ruby_iseq_disasm: unknown operand type: %c", type);
704 }
705 return ret;
706 }
707
708 /**
709 * Disassemble a instruction
710 * Iseq -> Iseq inspect object
711 */
712 VALUE
713 ruby_iseq_disasm_insn(VALUE ret, VALUE *iseq, int pos,
714 rb_iseq_t *iseqdat, VALUE child)
715 {
716 int insn = iseq[pos];
717 int len = insn_len(insn);
718 int i, j;
719 const char *types = insn_op_types(insn);
720 VALUE str = rb_str_new(0, 0);
721 char buff[0x100];
722 char insn_name_buff[0x100];
723
724 strcpy(insn_name_buff, insn_name(insn));
725 if (0) {
726 for (i = 0; insn_name_buff[i]; i++) {
727 if (insn_name_buff[i] == '_') {
728 insn_name_buff[i] = 0;
729 }
730 }
731 }
732
733 snprintf(buff, sizeof(buff), "%04d %-16s ", pos, insn_name_buff);
734 rb_str_cat2(str, buff);
735
736 for (j = 0; types[j]; j++) {
737 const char *types = insn_op_types(insn);
738 VALUE opstr = insn_operand_intern(iseqdat, insn, j, iseq[pos + j + 1],
739 len, pos, &iseq[pos + j + 2],
740 child);
741 rb_str_concat(str, opstr);
742
743 if (types[j + 1]) {
744 rb_str_cat2(str, ", ");
745 }
746 }
747
748 if (1) {
749 int line_no = find_line_no(iseqdat, pos);
750 int prev = find_prev_line_no(iseqdat, pos);
751 if (line_no && line_no != prev) {
752 snprintf(buff, sizeof(buff), "%-70s(%4d)", RSTRING_PTR(str),
753 line_no);
754 str = rb_str_new2(buff);
755 }
756 }
757 else {
758 /* for debug */
759 struct iseq_insn_info_entry *entry = get_insn_info(iseqdat, pos);
760 snprintf(buff, sizeof(buff), "%-60s(line: %d, sp: %d)",
761 RSTRING_PTR(str), entry->line_no, entry->sp);
762 str = rb_str_new2(buff);
763 }
764
765 if (ret) {
766 rb_str_cat2(str, "\n");
767 rb_str_concat(ret, str);
768 }
769 else {
770 printf("%s\n", RSTRING_PTR(str));
771 }
772 return len;
773 }
774
775 static char *
776 catch_type(int type)
777 {
778 switch (type) {
779 case CATCH_TYPE_RESCUE:
780 return "rescue";
781 case CATCH_TYPE_ENSURE:
782 return "ensure";
783 case CATCH_TYPE_RETRY:
784 return "retry";
785 case CATCH_TYPE_BREAK:
786 return "break";
787 case CATCH_TYPE_REDO:
788 return "redo";
789 case CATCH_TYPE_NEXT:
790 return "next";
791 default:
792 rb_bug("unknown catch type (%d)", type);
793 return 0;
794 }
795 }
796
797 VALUE
798 ruby_iseq_disasm(VALUE self)
799 {
800 rb_iseq_t *iseqdat = iseq_check(self);
801 VALUE *iseq;
802 VALUE str = rb_str_new(0, 0);
803 VALUE child = rb_ary_new();
804 unsigned long size;
805 int i;
806 ID *tbl;
807 char buff[0x200];
808 enum {header_minlen = 72};
809
810 rb_secure(1);
811
812 iseq = iseqdat->iseq;
813 size = iseqdat->iseq_size;
814
815 rb_str_cat2(str, "== disasm: ");
816
817 rb_str_concat(str, iseq_inspect(iseqdat->self));
818 if ((i = RSTRING_LEN(str)) < header_minlen) {
819 rb_str_resize(str, header_minlen);
820 memset(RSTRING_PTR(str) + i, '=', header_minlen - i);
821 }
822 rb_str_cat2(str, "\n");
823
824 /* show catch table information */
825 if (iseqdat->catch_table_size != 0) {
826 rb_str_cat2(str, "== catch table\n");
827 }
828 for (i = 0; i < iseqdat->catch_table_size; i++) {
829 struct iseq_catch_table_entry *entry = &iseqdat->catch_table[i];
830 sprintf(buff,
831 "| catch type: %-6s st: %04d ed: %04d sp: %04d cont: %04d\n",
832 catch_type((int)entry->type), (int)entry->start,
833 (int)entry->end, (int)entry->sp, (int)entry->cont);
834 rb_str_cat2(str, buff);
835 if (entry->iseq) {
836 rb_str_concat(str, ruby_iseq_disasm(entry->iseq));
837 }
838 }
839 if (iseqdat->catch_table_size != 0) {
840 rb_str_cat2(str, "|-------------------------------------"
841 "-----------------------------------\n");
842 }
843
844 /* show local table information */
845 tbl = iseqdat->local_table;
846
847 if (tbl) {
848 snprintf(buff, sizeof(buff),
849 "local table (size: %d, argc: %d "
850 "[opts: %d, rest: %d, post: %d, block: %d] s%d)\n",
851 iseqdat->local_size, iseqdat->argc,
852 iseqdat->arg_opts, iseqdat->arg_rest,
853 iseqdat->arg_post_len, iseqdat->arg_block,
854 iseqdat->arg_simple);
855 rb_str_cat2(str, buff);
856
857 for (i = 0; i < iseqdat->local_table_size; i++) {
858 const char *name = rb_id2name(tbl[i]);
859 char info[0x100];
860 char argi[0x100] = "";
861 char opti[0x100] = "";
862
863 if (iseqdat->arg_opts) {
864 int argc = iseqdat->argc;
865 int opts = iseqdat->arg_opts;
866 if (i >= argc && i < argc + opts - 1) {
867 snprintf(opti, sizeof(opti), "Opt=%ld",
868 iseqdat->arg_opt_table[i - argc]);
869 }
870 }
871
872 snprintf(argi, sizeof(argi), "%s%s%s%s%s", /* arg, opts, rest, post block */
873 iseqdat->argc > i ? "Arg" : "",
874 opti,
875 iseqdat->arg_rest == i ? "Rest" : "",
876 (iseqdat->arg_post_start <= i &&
877 i < iseqdat->arg_post_start + iseqdat->arg_post_len) ? "Post" : "",
878 iseqdat->arg_block == i ? "Block" : "");
879
880 snprintf(info, sizeof(info), "%s%s%s%s", name ? name : "?",
881 *argi ? "<" : "", argi, *argi ? ">" : "");
882
883 snprintf(buff, sizeof(buff), "[%2d] %-11s",
884 iseqdat->local_size - i, info);
885
886 rb_str_cat2(str, buff);
887 }
888 rb_str_cat2(str, "\n");
889 }
890
891 /* show each line */
892 for (i = 0; i < size;) {
893 i += ruby_iseq_disasm_insn(str, iseq, i, iseqdat, child);
894 }
895
896 for (i = 0; i < RARRAY_LEN(child); i++) {
897 VALUE isv = rb_ary_entry(child, i);
898 rb_str_concat(str, ruby_iseq_disasm(isv));
899 }
900
901 return str;
902 }
903
904 static VALUE
905 iseq_s_disasm(VALUE klass, VALUE body)
906 {
907 extern NODE *rb_method_body(VALUE body);
908 NODE *node;
909 VALUE ret = Qnil;
910
911 rb_secure(1);
912
913 if ((node = rb_method_body(body)) != 0) {
914 if (nd_type(node) == RUBY_VM_METHOD_NODE) {
915 VALUE iseqval = (VALUE)node->nd_body;
916 ret = ruby_iseq_disasm(iseqval);
917 }
918 }
919
920 return ret;
921 }
922
923 const char *
924 ruby_node_name(int node)
925 {
926 switch (node) {
927 #include "node_name.inc"
928 default:
929 rb_bug("unknown node (%d)", node);
930 return 0;
931 }
932 }
933
934 #define DECL_SYMBOL(name) \
935 static VALUE sym_##name
936
937 #define INIT_SYMBOL(name) \
938 sym_##name = ID2SYM(rb_intern(#name))
939
940 static VALUE
941 register_label(struct st_table *table, int idx)
942 {
943 VALUE sym;
944 char buff[0x20];
945
946 snprintf(buff, 0x20, "label_%u", idx);
947 sym = ID2SYM(rb_intern(buff));
948 st_insert(table, idx, sym);
949 return sym;
950 }
951
952 static VALUE
953 exception_type2symbol(VALUE type)
954 {
955 ID id;
956 switch(type) {
957 case CATCH_TYPE_RESCUE: id = rb_intern("rescue"); break;
958 case CATCH_TYPE_ENSURE: id = rb_intern("ensure"); break;
959 case CATCH_TYPE_RETRY: id = rb_intern("retry"); break;
960 case CATCH_TYPE_BREAK: id = rb_intern("break"); break;
961 case CATCH_TYPE_REDO: id = rb_intern("redo"); break;
962 case CATCH_TYPE_NEXT: id = rb_intern("next"); break;
963 default:
964 rb_bug("...");
965 }
966 return ID2SYM(id);
967 }
968
969 static int
970 cdhash_each(VALUE key, VALUE value, VALUE ary)
971 {
972 rb_ary_push(ary, key);
973 rb_ary_push(ary, value);
974 return ST_CONTINUE;
975 }
976
977 VALUE
978 iseq_data_to_ary(rb_iseq_t *iseq)
979 {
980 int i, pos, line = 0;
981 VALUE *seq;
982
983 VALUE val = rb_ary_new();
984 VALUE type; /* Symbol */
985 VALUE locals = rb_ary_new();
986 VALUE args = rb_ary_new();
987 VALUE body = rb_ary_new(); /* [[:insn1, ...], ...] */
988 VALUE nbody;
989 VALUE exception = rb_ary_new(); /* [[....]] */
990 VALUE misc = rb_hash_new();
991
992 static VALUE insn_syms[VM_INSTRUCTION_SIZE];
993 struct st_table *labels_table = st_init_numtable();
994
995 DECL_SYMBOL(top);
996 DECL_SYMBOL(method);
997 DECL_SYMBOL(block);
998 DECL_SYMBOL(class);
999 DECL_SYMBOL(rescue);
1000 DECL_SYMBOL(ensure);
1001 DECL_SYMBOL(eval);
1002
1003 if (sym_top == 0) {
1004 int i;
1005 for (i=0; i<VM_INSTRUCTION_SIZE; i++) {
1006 insn_syms[i] = ID2SYM(rb_intern(insn_name(i)));
1007 }
1008 INIT_SYMBOL(top);
1009 INIT_SYMBOL(method);
1010 INIT_SYMBOL(block);
1011 INIT_SYMBOL(class);
1012 INIT_SYMBOL(rescue);
1013 INIT_SYMBOL(ensure);
1014 INIT_SYMBOL(eval);
1015 }
1016
1017 /* type */
1018 switch(iseq->type) {
1019 case ISEQ_TYPE_TOP: type = sym_top; break;
1020 case ISEQ_TYPE_METHOD: type = sym_method; break;
1021 case ISEQ_TYPE_BLOCK: type = sym_block; break;
1022 case ISEQ_TYPE_CLASS: type = sym_class; break;
1023 case ISEQ_TYPE_RESCUE: type = sym_rescue; break;
1024 case ISEQ_TYPE_ENSURE: type = sym_ensure; break;
1025 case ISEQ_TYPE_EVAL: type = sym_eval; break;
1026 default: rb_bug("unsupported iseq type");
1027 };
1028
1029 /* locals */
1030 for (i=0; i<iseq->local_table_size; i++) {
1031 ID lid = iseq->local_table[i];
1032 if (lid) {
1033 if (rb_id2str(lid)) rb_ary_push(locals, ID2SYM(lid));
1034 }
1035 else {
1036 rb_ary_push(locals, ID2SYM(rb_intern("#arg_rest")));
1037 }
1038 }
1039
1040 /* args */
1041 {
1042 /*
1043 * [argc, # argc
1044 * [label1, label2, ...] # opts
1045 * rest index,
1046 * post_len
1047 * post_start
1048 * block index,
1049 * simple,
1050 * ]
1051 */
1052 VALUE arg_opt_labels = rb_ary_new();
1053 int j;
1054
1055 for (j=0; j<iseq->arg_opts; j++) {
1056 rb_ary_push(arg_opt_labels,
1057 register_label(labels_table, iseq->arg_opt_table[j]));
1058 }
1059
1060 /* commit */
1061 if (iseq->arg_simple == 1) {
1062 args = INT2FIX(iseq->argc);
1063 }
1064 else {
1065 rb_ary_push(args, INT2FIX(iseq->argc));
1066 rb_ary_push(args, arg_opt_labels);
1067 rb_ary_push(args, INT2FIX(iseq->arg_post_len));
1068 rb_ary_push(args, INT2FIX(iseq->arg_post_start));
1069 rb_ary_push(args, INT2FIX(iseq->arg_rest));
1070 rb_ary_push(args, INT2FIX(iseq->arg_block));
1071 rb_ary_push(args, INT2FIX(iseq->arg_simple));
1072 }
1073 }
1074
1075 /* body */
1076 for (seq = iseq->iseq; seq < iseq->iseq + iseq->iseq_size; ) {
1077 VALUE insn = *seq++;
1078 int j, len = insn_len(insn);
1079 VALUE *nseq = seq + len - 1;
1080 VALUE ary = rb_ary_new2(len);
1081
1082 rb_ary_push(ary, insn_syms[insn]);
1083 for (j=0; j<len-1; j++, seq++) {
1084 switch (insn_op_type(insn, j)) {
1085 case TS_OFFSET: {
1086 unsigned int idx = nseq - iseq->iseq + *seq;
1087 rb_ary_push(ary, register_label(labels_table, idx));
1088 break;
1089 }
1090 case TS_LINDEX:
1091 case TS_DINDEX:
1092 case TS_NUM:
1093 rb_ary_push(ary, INT2FIX(*seq));
1094 break;
1095 case TS_VALUE:
1096 rb_ary_push(ary, *seq);
1097 break;
1098 case TS_ISEQ:
1099 {
1100 rb_iseq_t *iseq = (rb_iseq_t *)*seq;
1101 if (iseq) {
1102 VALUE val = iseq_data_to_ary(iseq);
1103 rb_ary_push(ary, val);
1104 }
1105 else {
1106 rb_ary_push(ary, Qnil);
1107 }
1108 }
1109 break;
1110 case TS_GENTRY:
1111 {
1112 struct global_entry *entry = (struct global_entry *)*seq;
1113 rb_ary_push(ary, ID2SYM(entry->id));
1114 }
1115 break;
1116 case TS_IC:
1117 rb_ary_push(ary, Qnil);
1118 break;
1119 case TS_ID:
1120 rb_ary_push(ary, ID2SYM(*seq));
1121 break;
1122 case TS_CDHASH:
1123 {
1124 VALUE hash = *seq;
1125 VALUE val = rb_ary_new();
1126 int i;
1127
1128 rb_hash_foreach(hash, cdhash_each, val);
1129
1130 for (i=0; i<RARRAY_LEN(val); i+=2) {
1131 VALUE pos = FIX2INT(rb_ary_entry(val, i+1));
1132 unsigned int idx = nseq - iseq->iseq + pos;
1133
1134 rb_ary_store(val, i+1,
1135 register_label(labels_table, idx));
1136 }
1137 rb_ary_push(ary, val);
1138 }
1139 break;
1140 default:
1141 rb_bug("unknown operand: %c", insn_op_type(insn, j));
1142 }
1143 }
1144 rb_ary_push(body, ary);
1145 }
1146
1147 nbody = body;
1148
1149 /* exception */
1150 for (i=0; i<iseq->catch_table_size; i++) {
1151 VALUE ary = rb_ary_new();
1152 struct iseq_catch_table_entry *entry = &iseq->catch_table[i];
1153 rb_ary_push(ary, exception_type2symbol(entry->type));
1154 if (entry->iseq) {
1155 rb_iseq_t *eiseq;
1156 GetISeqPtr(entry->iseq, eiseq);
1157 rb_ary_push(ary, iseq_data_to_ary(eiseq));
1158 }
1159 else {
1160 rb_ary_push(ary, Qnil);
1161 }
1162 rb_ary_push(ary, register_label(labels_table, entry->start));
1163 rb_ary_push(ary, register_label(labels_table, entry->end));
1164 rb_ary_push(ary, register_label(labels_table, entry->cont));
1165 rb_ary_push(ary, INT2FIX(entry->sp));
1166 rb_ary_push(exception, ary);
1167 }
1168
1169 /* make body with labels and insert line number */
1170 body = rb_ary_new();
1171
1172 for (i=0, pos=0; i<RARRAY_LEN(nbody); i++) {
1173 VALUE ary = RARRAY_PTR(nbody)[i];
1174 VALUE label;
1175
1176 if (st_lookup(labels_table, pos, &label)) {
1177 rb_ary_push(body, label);
1178 }
1179
1180 if (iseq->insn_info_table[i].line_no != line) {
1181 line = iseq->insn_info_table[i].line_no;
1182 rb_ary_push(body, INT2FIX(line));
1183 }
1184
1185 rb_ary_push(body, ary);
1186 pos += RARRAY_LEN(ary);
1187 }
1188
1189 st_free_table(labels_table);
1190
1191 rb_hash_aset(misc, ID2SYM(rb_intern("arg_size")), INT2FIX(iseq->arg_size));
1192 rb_hash_aset(misc, ID2SYM(rb_intern("local_size")), INT2FIX(iseq->local_size));
1193 rb_hash_aset(misc, ID2SYM(rb_intern("stack_max")), INT2FIX(iseq->stack_max));
1194
1195 /*
1196 * [:magic, :major_version, :minor_version, :format_type, :misc,
1197 * :name, :filename, :type, :locals, :args,
1198 * :catch_table, :bytecode]
1199 */
1200 rb_ary_push(val, rb_str_new2("YARVInstructionSequence/SimpleDataFormat"));
1201 rb_ary_push(val, INT2FIX(1));
1202 rb_ary_push(val, INT2FIX(1));
1203 rb_ary_push(val, INT2FIX(1));
1204 rb_ary_push(val, misc);
1205 rb_ary_push(val, iseq->name);
1206 rb_ary_push(val, iseq->filename);
1207 rb_ary_push(val, type);
1208 rb_ary_push(val, locals);
1209 rb_ary_push(val, args);
1210 rb_ary_push(val, exception);
1211 rb_ary_push(val, body);
1212 return val;
1213 }
1214
1215 struct st_table *
1216 insn_make_insn_table(void)
1217 {
1218 struct st_table *table;
1219 int i;
1220 table = st_init_numtable();
1221
1222 for (i=0; i<VM_INSTRUCTION_SIZE; i++) {
1223 st_insert(table, ID2SYM(rb_intern(insn_name(i))), i);
1224 }
1225
1226 return table;
1227 }
1228
1229 /* ruby2cext */
1230
1231 VALUE
1232 rb_iseq_build_for_ruby2cext(
1233 const rb_iseq_t *iseq_template,
1234 const rb_insn_func_t *func,
1235 const struct iseq_insn_info_entry *insn_info_table,
1236 const char **local_table,
1237 const VALUE *arg_opt_table,
1238 const struct iseq_catch_table_entry *catch_table,
1239 const char *name,
1240 const char *filename)
1241 {
1242 int i;
1243 VALUE iseqval = iseq_alloc(rb_cISeq);
1244 rb_iseq_t *iseq;
1245 GetISeqPtr(iseqval, iseq);
1246
1247 /* copy iseq */
1248 *iseq = *iseq_template;
1249 iseq->name = rb_str_new2(name);
1250 iseq->filename = rb_str_new2(filename);
1251 iseq->mark_ary = rb_ary_new();
1252 iseq->self = iseqval;
1253
1254 iseq->iseq = ALLOC_N(VALUE, iseq->iseq_size);
1255
1256 for (i=0; i<iseq->iseq_size; i+=2) {
1257 iseq->iseq[i] = BIN(opt_call_c_function);
1258 iseq->iseq[i+1] = (VALUE)func;
1259 }
1260
1261 iseq_translate_threaded_code(iseq);
1262
1263 #define ALLOC_AND_COPY(dst, src, type, size) do { \
1264 if (size) { \
1265 (dst) = ALLOC_N(type, (size)); \
1266 MEMCPY((dst), (src), type, (size)); \
1267 } \
1268 } while (0)
1269
1270 ALLOC_AND_COPY(iseq->insn_info_table, insn_info_table,
1271 struct iseq_insn_info_entry, iseq->insn_info_size);
1272
1273 ALLOC_AND_COPY(iseq->catch_table, catch_table,
1274 struct iseq_catch_table_entry, iseq->catch_table_size);
1275
1276 ALLOC_AND_COPY(iseq->arg_opt_table, arg_opt_table,
1277 VALUE, iseq->arg_opts);
1278
1279 set_relation(iseq, 0);
1280
1281 return iseqval;
1282 }
1283
1284 void
1285 Init_ISeq(void)
1286 {
1287 /* declare ::VM::InstructionSequence */
1288 rb_cISeq = rb_define_class_under(rb_cVM, "InstructionSequence", rb_cObject);
1289 rb_define_alloc_func(rb_cISeq, iseq_alloc);
1290 rb_define_method(rb_cISeq, "inspect", iseq_inspect, 0);
1291 rb_define_method(rb_cISeq, "disasm", ruby_iseq_disasm, 0);
1292 rb_define_method(rb_cISeq, "disassemble", ruby_iseq_disasm, 0);
1293 rb_define_method(rb_cISeq, "to_a", iseq_to_a, 0);
1294 rb_define_method(rb_cISeq, "eval", iseq_eval, 0);
1295
1296 /* disable this feature because there is no verifier. */
1297 /* rb_define_singleton_method(rb_cISeq, "load", iseq_s_load, -1); */
1298
1299 rb_define_singleton_method(rb_cISeq, "compile", iseq_s_compile, -1);
1300 rb_define_singleton_method(rb_cISeq, "new", iseq_s_compile, -1);
1301 rb_define_singleton_method(rb_cISeq, "compile_file", iseq_s_compile_file, -1);
1302 rb_define_singleton_method(rb_cISeq, "compile_option", iseq_s_compile_option_get, 0);
1303 rb_define_singleton_method(rb_cISeq, "compile_option=", iseq_s_compile_option_set, 1);
1304 rb_define_singleton_method(rb_cISeq, "disasm", iseq_s_disasm, 1);
1305 rb_define_singleton_method(rb_cISeq, "disassemble", iseq_s_disasm, 1);
1306 }
1307
ruby svn mirror