2 ** load.c - mruby binary loader
4 ** See Copyright Notice in mruby.h
11 #include <mruby/dump.h>
12 #include <mruby/irep.h>
13 #include <mruby/proc.h>
14 #include <mruby/string.h>
15 #include <mruby/debug.h>
16 #include <mruby/error.h>
17 #include <mruby/data.h>
19 #if SIZE_MAX < UINT32_MAX
20 # error size_t must be at least 32 bits wide
23 #define FLAG_SRC_MALLOC 1
24 #define FLAG_SRC_STATIC 0
26 #define SIZE_ERROR_MUL(nmemb, size) ((size_t)(nmemb) > SIZE_MAX / (size))
29 skip_padding(const uint8_t *buf)
31 const size_t align = MRB_DUMP_ALIGNMENT;
32 return -(intptr_t)buf & (align-1);
38 struct rite_binary_header header;
39 return ((uint8_t *)header.binary_crc - (uint8_t *)&header) + sizeof(header.binary_crc);
42 #ifndef MRB_WITHOUT_FLOAT
43 double mrb_str_len_to_dbl(mrb_state *mrb, const char *s, size_t len, mrb_bool badcheck);
46 str_to_double(mrb_state *mrb, const char *p, size_t len)
48 /* `i`, `inf`, `infinity` */
49 if (len > 0 && p[0] == 'i') return INFINITY;
51 /* `I`, `-inf`, `-infinity` */
52 if (p[0] == 'I' || (len > 1 && p[0] == '-' && p[1] == 'i')) return -INFINITY;
53 return mrb_str_len_to_dbl(mrb, p, len, TRUE);
57 mrb_value mrb_str_len_to_inum(mrb_state *mrb, const char *str, mrb_int len, mrb_int base, int badcheck);
60 tempirep_free(mrb_state *mrb, void *p)
62 if (p) mrb_irep_decref(mrb, (mrb_irep *)p);
65 static const mrb_data_type tempirep_type = { "temporary irep", tempirep_free };
68 read_irep_record_1(mrb_state *mrb, const uint8_t *bin, size_t *len, uint8_t flags)
71 const uint8_t *src = bin;
73 uint16_t tt, pool_data_len, snl;
75 struct RData *irep_obj = mrb_data_object_alloc(mrb, mrb->object_class, NULL, &tempirep_type);
76 mrb_irep *irep = mrb_add_irep(mrb);
77 int ai = mrb_gc_arena_save(mrb);
79 irep_obj->data = irep;
81 /* skip record size */
82 src += sizeof(uint32_t);
84 /* number of local variable */
85 irep->nlocals = bin_to_uint16(src);
86 src += sizeof(uint16_t);
88 /* number of register variable */
89 irep->nregs = bin_to_uint16(src);
90 src += sizeof(uint16_t);
92 /* number of child irep */
93 irep->rlen = (size_t)bin_to_uint16(src);
94 src += sizeof(uint16_t);
96 /* Binary Data Section */
98 irep->ilen = (uint16_t)bin_to_uint32(src);
99 src += sizeof(uint32_t);
100 src += skip_padding(src);
102 if (irep->ilen > 0) {
103 if (SIZE_ERROR_MUL(irep->ilen, sizeof(mrb_code))) {
106 if ((flags & FLAG_SRC_MALLOC) == 0) {
107 irep->iseq = (mrb_code*)src;
108 src += sizeof(mrb_code) * irep->ilen;
109 irep->flags |= MRB_ISEQ_NO_FREE;
112 size_t data_len = sizeof(mrb_code) * irep->ilen;
113 void *buf = mrb_malloc(mrb, data_len);
114 irep->iseq = (mrb_code *)buf;
115 memcpy(buf, src, data_len);
121 plen = bin_to_uint32(src); /* number of pool */
122 src += sizeof(uint32_t);
124 if (SIZE_ERROR_MUL(plen, sizeof(mrb_value))) {
127 irep->pool = (mrb_value*)mrb_malloc(mrb, sizeof(mrb_value) * plen);
129 for (i = 0; i < plen; i++) {
131 mrb_bool st = (flags & FLAG_SRC_MALLOC)==0;
133 tt = *src++; /* pool TT */
134 pool_data_len = bin_to_uint16(src); /* pool data length */
135 src += sizeof(uint16_t);
136 s = (const char*)src;
137 src += pool_data_len;
138 switch (tt) { /* pool data */
139 case IREP_TT_FIXNUM: {
140 mrb_value num = mrb_str_len_to_inum(mrb, s, pool_data_len, 10, FALSE);
141 #ifdef MRB_WITHOUT_FLOAT
144 irep->pool[i] = mrb_float_p(num)? mrb_float_pool(mrb, mrb_float(num)) : num;
149 #ifndef MRB_WITHOUT_FLOAT
151 irep->pool[i] = mrb_float_pool(mrb, str_to_double(mrb, s, pool_data_len));
156 irep->pool[i] = mrb_str_pool(mrb, s, pool_data_len, st);
160 /* should not happen */
161 irep->pool[i] = mrb_nil_value();
165 mrb_gc_arena_restore(mrb, ai);
170 irep->slen = (uint16_t)bin_to_uint32(src); /* syms length */
171 src += sizeof(uint32_t);
172 if (irep->slen > 0) {
173 if (SIZE_ERROR_MUL(irep->slen, sizeof(mrb_sym))) {
176 irep->syms = (mrb_sym *)mrb_malloc(mrb, sizeof(mrb_sym) * irep->slen);
178 for (i = 0; i < irep->slen; i++) {
179 snl = bin_to_uint16(src); /* symbol name length */
180 src += sizeof(uint16_t);
182 if (snl == MRB_DUMP_NULL_SYM_LEN) {
187 if (flags & FLAG_SRC_MALLOC) {
188 irep->syms[i] = mrb_intern(mrb, (char *)src, snl);
191 irep->syms[i] = mrb_intern_static(mrb, (char *)src, snl);
195 mrb_gc_arena_restore(mrb, ai);
199 irep->reps = (mrb_irep**)mrb_calloc(mrb, irep->rlen, sizeof(mrb_irep*));
202 mrb_assert_int_fit(ptrdiff_t, diff, size_t, SIZE_MAX);
205 irep_obj->data = NULL;
211 read_irep_record(mrb_state *mrb, const uint8_t *bin, size_t *len, uint8_t flags)
213 struct RData *irep_obj = mrb_data_object_alloc(mrb, mrb->object_class, NULL, &tempirep_type);
214 int ai = mrb_gc_arena_save(mrb);
215 mrb_irep *irep = read_irep_record_1(mrb, bin, len, flags);
218 mrb_gc_arena_restore(mrb, ai);
223 irep_obj->data = irep;
226 for (i=0; i<irep->rlen; i++) {
229 irep->reps[i] = read_irep_record(mrb, bin, &rlen, flags);
230 mrb_gc_arena_restore(mrb, ai);
231 if (irep->reps[i] == NULL) {
238 irep_obj->data = NULL;
244 read_section_irep(mrb_state *mrb, const uint8_t *bin, uint8_t flags)
248 bin += sizeof(struct rite_section_irep_header);
249 return read_irep_record(mrb, bin, &len, flags);
253 read_debug_record(mrb_state *mrb, const uint8_t *start, mrb_irep* irep, size_t *record_len, const mrb_sym *filenames, size_t filenames_len)
255 const uint8_t *bin = start;
261 if (irep->debug_info) { return MRB_DUMP_INVALID_IREP; }
263 irep->debug_info = (mrb_irep_debug_info*)mrb_calloc(mrb, 1, sizeof(mrb_irep_debug_info));
264 irep->debug_info->pc_count = (uint32_t)irep->ilen;
266 record_size = (size_t)bin_to_uint32(bin);
267 bin += sizeof(uint32_t);
269 irep->debug_info->flen = bin_to_uint16(bin);
270 irep->debug_info->files = (mrb_irep_debug_info_file**)mrb_calloc(mrb, irep->debug_info->flen, sizeof(mrb_irep_debug_info*));
271 bin += sizeof(uint16_t);
273 for (f_idx = 0; f_idx < irep->debug_info->flen; ++f_idx) {
274 mrb_irep_debug_info_file *file;
275 uint16_t filename_idx;
277 file = (mrb_irep_debug_info_file *)mrb_calloc(mrb, 1, sizeof(*file));
278 irep->debug_info->files[f_idx] = file;
280 file->start_pos = bin_to_uint32(bin);
281 bin += sizeof(uint32_t);
284 filename_idx = bin_to_uint16(bin);
285 bin += sizeof(uint16_t);
286 mrb_assert(filename_idx < filenames_len);
287 file->filename_sym = filenames[filename_idx];
289 file->line_entry_count = bin_to_uint32(bin);
290 bin += sizeof(uint32_t);
291 file->line_type = (mrb_debug_line_type)bin_to_uint8(bin);
292 bin += sizeof(uint8_t);
293 switch (file->line_type) {
294 case mrb_debug_line_ary: {
297 file->lines.ary = (uint16_t *)mrb_malloc(mrb, sizeof(uint16_t) * (size_t)(file->line_entry_count));
298 for (l = 0; l < file->line_entry_count; ++l) {
299 file->lines.ary[l] = bin_to_uint16(bin);
300 bin += sizeof(uint16_t);
304 case mrb_debug_line_flat_map: {
307 file->lines.flat_map = (mrb_irep_debug_info_line*)mrb_calloc(
308 mrb, (size_t)(file->line_entry_count), sizeof(mrb_irep_debug_info_line));
309 for (l = 0; l < file->line_entry_count; ++l) {
310 file->lines.flat_map[l].start_pos = bin_to_uint32(bin);
311 bin += sizeof(uint32_t);
312 file->lines.flat_map[l].line = bin_to_uint16(bin);
313 bin += sizeof(uint16_t);
317 default: return MRB_DUMP_GENERAL_FAILURE;
322 mrb_assert_int_fit(ptrdiff_t, diff, size_t, SIZE_MAX);
324 if (record_size != (size_t)diff) {
325 return MRB_DUMP_GENERAL_FAILURE;
328 for (i = 0; i < irep->rlen; i++) {
332 ret = read_debug_record(mrb, bin, irep->reps[i], &len, filenames, filenames_len);
333 if (ret != MRB_DUMP_OK) return ret;
338 mrb_assert_int_fit(ptrdiff_t, diff, size_t, SIZE_MAX);
339 *record_len = (size_t)diff;
345 read_section_debug(mrb_state *mrb, const uint8_t *start, mrb_irep *irep, uint8_t flags)
349 struct rite_section_debug_header *header;
353 uint16_t filenames_len;
355 mrb_value filenames_obj;
358 header = (struct rite_section_debug_header *)bin;
359 bin += sizeof(struct rite_section_debug_header);
361 filenames_len = bin_to_uint16(bin);
362 bin += sizeof(uint16_t);
363 filenames_obj = mrb_str_new(mrb, NULL, sizeof(mrb_sym) * (size_t)filenames_len);
364 filenames = (mrb_sym*)RSTRING_PTR(filenames_obj);
365 for (i = 0; i < filenames_len; ++i) {
366 uint16_t f_len = bin_to_uint16(bin);
367 bin += sizeof(uint16_t);
368 if (flags & FLAG_SRC_MALLOC) {
369 filenames[i] = mrb_intern(mrb, (const char *)bin, (size_t)f_len);
372 filenames[i] = mrb_intern_static(mrb, (const char *)bin, (size_t)f_len);
377 result = read_debug_record(mrb, bin, irep, &len, filenames, filenames_len);
378 if (result != MRB_DUMP_OK) goto debug_exit;
382 mrb_assert_int_fit(ptrdiff_t, diff, size_t, SIZE_MAX);
383 if ((uint32_t)diff != bin_to_uint32(header->section_size)) {
384 result = MRB_DUMP_GENERAL_FAILURE;
388 mrb_str_resize(mrb, filenames_obj, 0);
393 read_lv_record(mrb_state *mrb, const uint8_t *start, mrb_irep *irep, size_t *record_len, mrb_sym const *syms, uint32_t syms_len)
395 const uint8_t *bin = start;
399 irep->lv = (struct mrb_locals*)mrb_malloc(mrb, sizeof(struct mrb_locals) * (irep->nlocals - 1));
401 for (i = 0; i + 1< irep->nlocals; ++i) {
402 uint16_t const sym_idx = bin_to_uint16(bin);
403 bin += sizeof(uint16_t);
404 if (sym_idx == RITE_LV_NULL_MARK) {
405 irep->lv[i].name = 0;
409 if (sym_idx >= syms_len) {
410 return MRB_DUMP_GENERAL_FAILURE;
412 irep->lv[i].name = syms[sym_idx];
414 irep->lv[i].r = bin_to_uint16(bin);
416 bin += sizeof(uint16_t);
419 for (i = 0; i < irep->rlen; ++i) {
423 ret = read_lv_record(mrb, bin, irep->reps[i], &len, syms, syms_len);
424 if (ret != MRB_DUMP_OK) return ret;
429 mrb_assert_int_fit(ptrdiff_t, diff, size_t, SIZE_MAX);
430 *record_len = (size_t)diff;
436 read_section_lv(mrb_state *mrb, const uint8_t *start, mrb_irep *irep, uint8_t flags)
440 struct rite_section_lv_header const *header;
447 mrb_sym (*intern_func)(mrb_state*, const char*, size_t) =
448 (flags & FLAG_SRC_MALLOC)? mrb_intern : mrb_intern_static;
451 header = (struct rite_section_lv_header const*)bin;
452 bin += sizeof(struct rite_section_lv_header);
454 syms_len = bin_to_uint32(bin);
455 bin += sizeof(uint32_t);
456 syms_obj = mrb_str_new(mrb, NULL, sizeof(mrb_sym) * (size_t)syms_len);
457 syms = (mrb_sym*)RSTRING_PTR(syms_obj);
458 for (i = 0; i < syms_len; ++i) {
459 uint16_t const str_len = bin_to_uint16(bin);
460 bin += sizeof(uint16_t);
462 syms[i] = intern_func(mrb, (const char*)bin, str_len);
466 result = read_lv_record(mrb, bin, irep, &len, syms, syms_len);
467 if (result != MRB_DUMP_OK) goto lv_exit;
471 mrb_assert_int_fit(ptrdiff_t, diff, size_t, SIZE_MAX);
472 if ((uint32_t)diff != bin_to_uint32(header->section_size)) {
473 result = MRB_DUMP_GENERAL_FAILURE;
477 mrb_str_resize(mrb, syms_obj, 0);
482 read_binary_header(const uint8_t *bin, size_t bufsize, size_t *bin_size, uint16_t *crc, uint8_t *flags)
484 const struct rite_binary_header *header = (const struct rite_binary_header *)bin;
486 if (bufsize < sizeof(struct rite_binary_header)) {
487 return MRB_DUMP_READ_FAULT;
490 if (memcmp(header->binary_ident, RITE_BINARY_IDENT, sizeof(header->binary_ident)) != 0) {
491 return MRB_DUMP_INVALID_FILE_HEADER;
494 if (memcmp(header->binary_version, RITE_BINARY_FORMAT_VER, sizeof(header->binary_version)) != 0) {
495 return MRB_DUMP_INVALID_FILE_HEADER;
499 *crc = bin_to_uint16(header->binary_crc);
501 *bin_size = (size_t)bin_to_uint32(header->binary_size);
503 if (bufsize < *bin_size) {
504 return MRB_DUMP_READ_FAULT;
511 read_irep(mrb_state *mrb, const uint8_t *bin, size_t bufsize, uint8_t flags)
514 struct RData *irep_obj = NULL;
515 mrb_irep *irep = NULL;
516 const struct rite_section_header *section_header;
521 if ((mrb == NULL) || (bin == NULL)) {
525 result = read_binary_header(bin, bufsize, &bin_size, &crc, &flags);
526 if (result != MRB_DUMP_OK) {
530 n = offset_crc_body();
531 if (crc != calc_crc_16_ccitt(bin + n, bin_size - n, 0)) {
535 irep_obj = mrb_data_object_alloc(mrb, mrb->object_class, NULL, &tempirep_type);
537 bin += sizeof(struct rite_binary_header);
539 section_header = (const struct rite_section_header *)bin;
540 if (memcmp(section_header->section_ident, RITE_SECTION_IREP_IDENT, sizeof(section_header->section_ident)) == 0) {
541 irep = read_section_irep(mrb, bin, flags);
542 if (!irep) return NULL;
543 irep_obj->data = irep;
545 else if (memcmp(section_header->section_ident, RITE_SECTION_DEBUG_IDENT, sizeof(section_header->section_ident)) == 0) {
546 if (!irep) return NULL; /* corrupted data */
547 result = read_section_debug(mrb, bin, irep, flags);
548 if (result < MRB_DUMP_OK) {
552 else if (memcmp(section_header->section_ident, RITE_SECTION_LV_IDENT, sizeof(section_header->section_ident)) == 0) {
553 if (!irep) return NULL;
554 result = read_section_lv(mrb, bin, irep, flags);
555 if (result < MRB_DUMP_OK) {
559 bin += bin_to_uint32(section_header->section_size);
560 } while (memcmp(section_header->section_ident, RITE_BINARY_EOF, sizeof(section_header->section_ident)) != 0);
562 irep_obj->data = NULL;
568 mrb_read_irep(mrb_state *mrb, const uint8_t *bin)
570 #if defined(MRB_USE_LINK_TIME_RO_DATA_P) || defined(MRB_USE_CUSTOM_RO_DATA_P)
571 uint8_t flags = mrb_ro_data_p((char*)bin) ? FLAG_SRC_STATIC : FLAG_SRC_MALLOC;
573 uint8_t flags = FLAG_SRC_STATIC;
576 return read_irep(mrb, bin, (size_t)-1, flags);
580 mrb_read_irep_buf(mrb_state *mrb, const void *buf, size_t bufsize)
582 return read_irep(mrb, (const uint8_t *)buf, bufsize, FLAG_SRC_MALLOC);
585 void mrb_exc_set(mrb_state *mrb, mrb_value exc);
588 irep_error(mrb_state *mrb)
590 mrb_exc_set(mrb, mrb_exc_new_str_lit(mrb, E_SCRIPT_ERROR, "irep load error"));
593 void mrb_codedump_all(mrb_state*, struct RProc*);
596 load_irep(mrb_state *mrb, mrb_irep *irep, mrbc_context *c)
602 return mrb_nil_value();
604 proc = mrb_proc_new(mrb, irep);
606 mrb_irep_decref(mrb, irep);
607 if (c && c->dump_result) mrb_codedump_all(mrb, proc);
608 if (c && c->no_exec) return mrb_obj_value(proc);
609 return mrb_top_run(mrb, proc, mrb_top_self(mrb), 0);
613 mrb_load_irep_cxt(mrb_state *mrb, const uint8_t *bin, mrbc_context *c)
615 struct RData *irep_obj = mrb_data_object_alloc(mrb, mrb->object_class, NULL, &tempirep_type);
616 mrb_irep *irep = mrb_read_irep(mrb, bin);
619 irep_obj->data = irep;
620 mrb_irep_incref(mrb, irep);
621 ret = load_irep(mrb, irep, c);
622 irep_obj->data = NULL;
623 mrb_irep_decref(mrb, irep);
628 mrb_load_irep_buf_cxt(mrb_state *mrb, const void *buf, size_t bufsize, mrbc_context *c)
630 return load_irep(mrb, mrb_read_irep_buf(mrb, buf, bufsize), c);
634 mrb_load_irep(mrb_state *mrb, const uint8_t *bin)
636 return mrb_load_irep_cxt(mrb, bin, NULL);
640 mrb_load_irep_buf(mrb_state *mrb, const void *buf, size_t bufsize)
642 return mrb_load_irep_buf_cxt(mrb, buf, bufsize, NULL);
645 #ifndef MRB_DISABLE_STDIO
648 mrb_read_irep_file(mrb_state *mrb, FILE* fp)
650 mrb_irep *irep = NULL;
652 const size_t header_size = sizeof(struct rite_binary_header);
657 if ((mrb == NULL) || (fp == NULL)) {
661 buf = (uint8_t*)mrb_malloc(mrb, header_size);
662 if (fread(buf, header_size, 1, fp) == 0) {
665 result = read_binary_header(buf, (size_t)-1, &buf_size, NULL, &flags);
666 if (result != MRB_DUMP_OK || buf_size <= header_size) {
670 buf = (uint8_t*)mrb_realloc(mrb, buf, buf_size);
671 if (fread(buf+header_size, buf_size-header_size, 1, fp) == 0) {
674 irep = read_irep(mrb, buf, (size_t)-1, FLAG_SRC_MALLOC);
682 mrb_load_irep_file_cxt(mrb_state *mrb, FILE* fp, mrbc_context *c)
684 return load_irep(mrb, mrb_read_irep_file(mrb, fp), c);
688 mrb_load_irep_file(mrb_state *mrb, FILE* fp)
690 return mrb_load_irep_file_cxt(mrb, fp, NULL);
692 #endif /* MRB_DISABLE_STDIO */