[Inter::Binary::] Inter in Binary Files. To read or write inter between memory and binary files. @h Reading and writing inter to binary. The binary representation of Inter, saved out to a file, is portable and complete in itself. = int trace_bin = FALSE; int suppress_type_errors = FALSE; void Inter::Binary::read(inter_tree *I, filename *F) { LOGIF(INTER_FILE_READ, "(Reading binary inter file %f)\n", F); long int max_offset = BinaryFiles::size(F); FILE *fh = BinaryFiles::open_for_reading(F); inter_error_location eloc = Inter::Errors::interb_location(F, 0); inter_bookmark at = InterBookmark::at_start_of_this_repository(I); inter_warehouse *warehouse = InterTree::warehouse(I); default_ptree = I; inter_ti *grid = NULL; inter_ti grid_extent = 0; unsigned int X = 0; @; @; @; @; @; if (grid) Memory::I7_array_free(grid, INTER_BYTECODE_MREASON, (int) grid_extent, sizeof(inter_ti)); Primitives::index_primitives_in_tree(I); BinaryFiles::close(fh); default_ptree = NULL; } @ Symmetrically: = void Inter::Binary::write(filename *F, inter_tree *I) { if (trace_bin) WRITE_TO(STDOUT, "Writing binary inter file %f\n", F); LOGIF(INTER_FILE_READ, "(Writing binary inter file %f)\n", F); FILE *fh = BinaryFiles::open_for_writing(F); inter_warehouse *warehouse = InterTree::warehouse(I); @; @; @; @; @; BinaryFiles::close(fh); } @ The header is four bytes with a special value (equivalent to the ASCII for |intr|), then four zero bytes, so that we can tell this file from a text file coincidentally opening with those letters. @d INTER_SHIBBOLETH ((inter_ti) 0x696E7472) @ = if ((BinaryFiles::read_int32(fh, &X) == FALSE) || ((inter_ti) X != INTER_SHIBBOLETH) || (BinaryFiles::read_int32(fh, &X) == FALSE) || ((inter_ti) X != 0)) Inter::Binary::read_error(&eloc, 0, I"not a binary inter file"); @ = BinaryFiles::write_int32(fh, (unsigned int) INTER_SHIBBOLETH); BinaryFiles::write_int32(fh, (unsigned int) 0); @ Next we have to describe the possible range of annotations. We need these now, because they will be referred to in the symbol definitions in the resource block later on. @ = inter_ti ID = 0; while (BinaryFiles::read_int32(fh, &ID)) { if (ID == 0) break; TEMPORARY_TEXT(keyword) unsigned int L; if (BinaryFiles::read_int32(fh, &L) == FALSE) Inter::Binary::read_error(&eloc, ftell(fh), I"bytecode incomplete"); for (unsigned int i=0; i = inter_annotation_form *IAF; LOOP_OVER(IAF, inter_annotation_form) { if (IAF->annotation_ID == INVALID_IANN) continue; BinaryFiles::write_int32(fh, IAF->annotation_ID); BinaryFiles::write_int32(fh, (unsigned int) Str::len(IAF->annotation_keyword)); LOOP_THROUGH_TEXT(P, IAF->annotation_keyword) BinaryFiles::write_int32(fh, (unsigned int) Str::get(P)); } BinaryFiles::write_int32(fh, 0); @ There follows a block of resources, which is a list in which each entry opens with a word identifying which resource number is meant; when this is zero, that's the end of the list and therefore the block. (There is no resource 0.) @ = unsigned int count = 0; if (BinaryFiles::read_int32(fh, &count) == FALSE) Inter::Binary::read_error(&eloc, ftell(fh), I"bytecode incomplete"); if (count > 0) { unsigned int grid_extent = 0; if (BinaryFiles::read_int32(fh, &grid_extent) == FALSE) Inter::Binary::read_error(&eloc, ftell(fh), I"bytecode incomplete"); if (grid_extent == 0) { Inter::Binary::read_error(&eloc, ftell(fh), I"max zero"); grid_extent = 1000; } grid = (inter_ti *) Memory::calloc((int) grid_extent, sizeof(inter_ti), INTER_BYTECODE_MREASON); for (inter_ti i=0; in_index; break; case 1: n = (inter_ti) InterTree::root_package(I)->index_n; break; default: n = Inter::Warehouse::create_resource(warehouse); break; } if (trace_bin) WRITE_TO(STDOUT, "Reading resource %d <--- %d\n", n, from_N); if (from_N >= grid_extent) { from_N = grid_extent-1; Inter::Binary::read_error(&eloc, ftell(fh), I"max incorrect"); } grid[from_N] = n; } else Inter::Binary::read_error(&eloc, ftell(fh), I"bytecode incomplete"); } for (inter_ti i=0; i= grid_extent)) { Inter::Binary::read_error(&eloc, ftell(fh), I"from-N out of range"); from_N = grid_extent - 1; } inter_ti n = grid[from_N]; inter_resource_holder *res = &(warehouse->stored_resources[n]); unsigned int X = NO_IRSRC; if (BinaryFiles::read_int32(fh, &X) == FALSE) Inter::Binary::read_error(&eloc, ftell(fh), I"bytecode incomplete"); if (trace_bin) WRITE_TO(STDOUT, "Reading resource %d -> %d type %d\n", from_N, n, X); switch (X) { case STRING_IRSRC: @; break; case SYMBOLS_TABLE_IRSRC: @; break; case FRAME_LIST_IRSRC: @; break; case PACKAGE_IRSRC: @; break; } } } @ = int max = -1, count = 0; for (int n = 1; n < warehouse->size; n++) { inter_package *owner = warehouse->stored_resources[n].owning_package; if ((owner) && (Inter::Packages::tree(owner) != I)) continue; count++; if (n+1 > max) max = n+1; } BinaryFiles::write_int32(fh, (unsigned int) count); if (count >= 0) { BinaryFiles::write_int32(fh, (unsigned int) max); for (int n = 1; n < warehouse->size; n++) { inter_package *owner = warehouse->stored_resources[n].owning_package; if ((owner) && (Inter::Packages::tree(owner) != I)) continue; BinaryFiles::write_int32(fh, (unsigned int) n); } for (int n = 1; n < warehouse->size; n++) { inter_package *owner = warehouse->stored_resources[n].owning_package; if ((owner) && (Inter::Packages::tree(owner) != I)) continue; if (trace_bin) WRITE_TO(STDOUT, "Writing resource %d type %d owner %s\n", n, warehouse->stored_resources[n].irsrc, (owner)?"yes":"no"); BinaryFiles::write_int32(fh, (unsigned int) n); inter_resource_holder *res = &(warehouse->stored_resources[n]); if (res->stored_text_stream) { BinaryFiles::write_int32(fh, STRING_IRSRC); @; } else if (res->stored_symbols_table) { BinaryFiles::write_int32(fh, SYMBOLS_TABLE_IRSRC); @; } else if (res->stored_package) { BinaryFiles::write_int32(fh, PACKAGE_IRSRC); @; } else { BinaryFiles::write_int32(fh, FRAME_LIST_IRSRC); @; } } } @ = res->stored_text_stream = Str::new(); unsigned int L; if (BinaryFiles::read_int32(fh, &L) == FALSE) Inter::Binary::read_error(&eloc, ftell(fh), I"bytecode incomplete"); for (unsigned int i=0; istored_text_stream, (int) c); } @ = BinaryFiles::write_int32(fh, (unsigned int) Str::len(res->stored_text_stream)); LOOP_THROUGH_TEXT(P, res->stored_text_stream) BinaryFiles::write_int32(fh, (unsigned int) Str::get(P)); @ = if (res->stored_symbols_table == NULL) res->stored_symbols_table = InterSymbolsTables::new(); while (BinaryFiles::read_int32(fh, &X)) { if (X == 0) break; unsigned int st; if (BinaryFiles::read_int32(fh, &st) == FALSE) Inter::Binary::read_error(&eloc, ftell(fh), I"bytecode incomplete"); unsigned int sc; if (BinaryFiles::read_int32(fh, &sc) == FALSE) Inter::Binary::read_error(&eloc, ftell(fh), I"bytecode incomplete"); unsigned int uniq; if (BinaryFiles::read_int32(fh, &uniq) == FALSE) Inter::Binary::read_error(&eloc, ftell(fh), I"bytecode incomplete"); unsigned int L; if (BinaryFiles::read_int32(fh, &L) == FALSE) Inter::Binary::read_error(&eloc, ftell(fh), I"bytecode incomplete"); TEMPORARY_TEXT(name) for (unsigned int i=0; istored_symbols_table, name, X); Inter::Symbols::set_type(S, (int) st); Inter::Symbols::set_scope(S, (int) sc); if (uniq == 1) Inter::Symbols::set_flag(S, MAKE_NAME_UNIQUE); if (Str::len(trans) > 0) Inter::Symbols::set_translate(S, trans); if (BinaryFiles::read_int32(fh, &L) == FALSE) Inter::Binary::read_error(&eloc, ftell(fh), I"bytecode incomplete"); for (unsigned int i=0; i = inter_symbols_table *T = res->stored_symbols_table; if (T) { for (int i=0; isize; i++) { inter_symbol *symb = T->symbol_array[i]; if (symb) { BinaryFiles::write_int32(fh, symb->symbol_ID); BinaryFiles::write_int32(fh, (unsigned int) Inter::Symbols::get_type(symb)); BinaryFiles::write_int32(fh, (unsigned int) Inter::Symbols::get_scope(symb)); if (Inter::Symbols::get_flag(symb, MAKE_NAME_UNIQUE)) BinaryFiles::write_int32(fh, 1); else BinaryFiles::write_int32(fh, 0); BinaryFiles::write_int32(fh, (unsigned int) Str::len(symb->symbol_name)); LOOP_THROUGH_TEXT(P, symb->symbol_name) BinaryFiles::write_int32(fh, (unsigned int) Str::get(P)); BinaryFiles::write_int32(fh, (unsigned int) Str::len(symb->translate_text)); LOOP_THROUGH_TEXT(P, symb->translate_text) BinaryFiles::write_int32(fh, (unsigned int) Str::get(P)); Inter::Annotations::set_to_bytecode(fh, &(symb->ann_set)); if (Inter::Symbols::get_scope(symb) == PLUG_ISYMS) { text_stream *N = Wiring::wired_to_name(symb); LOOP_THROUGH_TEXT(pos, N) BinaryFiles::write_int32(fh, (unsigned int) Str::get(pos)); BinaryFiles::write_int32(fh, 0); } } } } BinaryFiles::write_int32(fh, 0); @ And similarly for packages. @ = unsigned int p; if (BinaryFiles::read_int32(fh, &p) == FALSE) Inter::Binary::read_error(&eloc, ftell(fh), I"bytecode incomplete"); unsigned int cl; if (BinaryFiles::read_int32(fh, &cl) == FALSE) Inter::Binary::read_error(&eloc, ftell(fh), I"bytecode incomplete"); unsigned int rl; if (BinaryFiles::read_int32(fh, &rl) == FALSE) Inter::Binary::read_error(&eloc, ftell(fh), I"bytecode incomplete"); unsigned int sc; if (BinaryFiles::read_int32(fh, &sc) == FALSE) Inter::Binary::read_error(&eloc, ftell(fh), I"bytecode incomplete"); inter_package *parent = NULL; if (p != 0) parent = Inter::Warehouse::get_package(warehouse, grid[p]); if (res->stored_package == NULL) { res->stored_package = Inter::Packages::new(I, n); } if (cl) Inter::Packages::make_codelike(res->stored_package); if (rl) Inter::Packages::make_rootlike(res->stored_package); if (sc != 0) { if (grid) sc = grid[sc]; Inter::Packages::set_scope(res->stored_package, Inter::Warehouse::get_symbols_table(warehouse, sc)); } TEMPORARY_TEXT(N) unsigned int L; if (BinaryFiles::read_int32(fh, &L) == FALSE) Inter::Binary::read_error(&eloc, ftell(fh), I"bytecode incomplete"); for (unsigned int i=0; iroot_package), res->stored_package, N); DISCARD_TEXT(N) @ = inter_package *P = res->stored_package; if (P) { inter_package *par = Inter::Packages::parent(P); if (par == NULL) BinaryFiles::write_int32(fh, 0); else BinaryFiles::write_int32(fh, (unsigned int) par->index_n); BinaryFiles::write_int32(fh, (unsigned int) Inter::Packages::is_codelike(P)); BinaryFiles::write_int32(fh, (unsigned int) Inter::Packages::is_rootlike(P)); BinaryFiles::write_int32(fh, (unsigned int) P->package_scope->n_index); BinaryFiles::write_int32(fh, (unsigned int) Str::len(P->package_name_t)); LOOP_THROUGH_TEXT(C, P->package_name_t) BinaryFiles::write_int32(fh, (unsigned int) Str::get(C)); } @ We do nothing here, because frame lists are built new on reading. It's enough that the slot exists for the eventual list to be stored in. @ = if (res->stored_frame_list == NULL) res->stored_frame_list = Inter::ListLiterals::new(); @ = ; @ = while (BinaryFiles::read_int32(fh, &X)) { if (X == 0) break; if (grid) X = grid[X]; inter_symbols_table *from_T = Inter::Warehouse::get_symbols_table(warehouse, X); if (from_T == NULL) { WRITE_TO(STDERR, "It's %d\n", X); internal_error("no from_T"); } unsigned int from_ID = 0; while (BinaryFiles::read_int32(fh, &from_ID)) { if (from_ID == 0) break; unsigned int to_T_id = 0; unsigned int to_ID = 0; if (BinaryFiles::read_int32(fh, &to_T_id) == FALSE) Inter::Binary::read_error(&eloc, ftell(fh), I"bytecode incomplete"); if (grid) to_T_id = grid[to_T_id]; if (trace_bin) WRITE_TO(STDOUT, "Read eqn %d -> %d\n", X, to_T_id); if (BinaryFiles::read_int32(fh, &to_ID) == FALSE) Inter::Binary::read_error(&eloc, ftell(fh), I"bytecode incomplete"); inter_symbols_table *to_T = Inter::Warehouse::get_symbols_table(warehouse, to_T_id); if (from_T == NULL) internal_error("no to_T"); inter_symbol *from_S = InterSymbolsTables::symbol_from_id(from_T, from_ID); if (from_S == NULL) internal_error("no from_S"); inter_symbol *to_S = InterSymbolsTables::symbol_from_id(to_T, to_ID); if (to_S == NULL) internal_error("no to_S"); Wiring::wire_to(from_S, to_S); } } @ = for (int n = 1; n < warehouse->size; n++) { inter_package *owner = warehouse->stored_resources[n].owning_package; if ((owner) && (Inter::Packages::tree(owner) != I)) continue; inter_resource_holder *res = &(warehouse->stored_resources[n]); if (res->stored_symbols_table) { inter_symbols_table *from_T = res->stored_symbols_table; BinaryFiles::write_int32(fh, (unsigned int) n); for (int i=0; isize; i++) { inter_symbol *symb = from_T->symbol_array[i]; if (Wiring::is_wired(symb)) { inter_symbol *W = Wiring::wired_to(symb); BinaryFiles::write_int32(fh, symb->symbol_ID); BinaryFiles::write_int32(fh, (unsigned int) W->owning_table->n_index); if (trace_bin) WRITE_TO(STDOUT, "Write eqn %d -> %d\n", n, W->owning_table->n_index); BinaryFiles::write_int32(fh, W->symbol_ID); } } BinaryFiles::write_int32(fh, 0); } } BinaryFiles::write_int32(fh, 0); @ = while (BinaryFiles::read_int32(fh, &X)) { eloc.error_offset = (size_t) ftell(fh) - PREFRAME_SIZE; int extent = (int) X; if ((extent < 2) || ((long int) extent >= max_offset)) Inter::Binary::read_error(&eloc, ftell(fh), I"overlarge line"); if (trace_bin) WRITE_TO(STDOUT, "Reading bytecode, extent %d\n", extent); inter_package *owner = NULL; unsigned int PID = 0; if (BinaryFiles::read_int32(fh, &PID)) { if (grid) PID = grid[PID]; if (trace_bin) WRITE_TO(STDOUT, "PID %d\n", PID); if (PID) owner = Inter::Warehouse::get_package(warehouse, PID); if (trace_bin) WRITE_TO(STDOUT, "Owner has ID %d, table %d\n", owner->index_n, owner->package_scope->n_index); } inter_tree_node *P = Inter::Warehouse::find_room(warehouse, I, extent-1, &eloc, owner); for (int i=0; iW.data[i] = word; else Inter::Binary::read_error(&eloc, ftell(fh), I"bytecode incomplete"); } unsigned int comment = 0; if (BinaryFiles::read_int32(fh, &comment)) { if (comment != 0) Inode::attach_comment(P, (inter_ti) comment); } else Inter::Binary::read_error(&eloc, ftell(fh), I"bytecode incomplete"); if (trace_bin) WRITE_TO(STDOUT, "Verify\n"); inter_error_message *E = NULL; if (grid) E = Inter::Defn::transpose_construct(owner, P, grid, grid_extent); if (E) { Inter::Errors::issue(E); exit(1); } suppress_type_errors = TRUE; E = Inter::Defn::verify_construct(owner, P); suppress_type_errors = FALSE; if (E) { Inter::Errors::issue(E); exit(1); } if (trace_bin) WRITE_TO(STDOUT, "Done\n"); NodePlacement::move_to_moving_bookmark(P, &at); } @ = InterTree::traverse_root_only(I, Inter::Binary::visitor, fh, -PACKAGE_IST); InterTree::traverse(I, Inter::Binary::visitor, fh, NULL, 0); @ = void Inter::Binary::visitor(inter_tree *I, inter_tree_node *P, void *state) { FILE *fh = (FILE *) state; BinaryFiles::write_int32(fh, (unsigned int) (P->W.extent + 1)); BinaryFiles::write_int32(fh, (unsigned int) (Inode::get_package(P)->index_n)); for (int i=0; iW.extent; i++) BinaryFiles::write_int32(fh, (unsigned int) (P->W.data[i])); BinaryFiles::write_int32(fh, (unsigned int) (Inode::get_comment(P))); } @ Errors in reading binary inter are not recoverable: = void Inter::Binary::read_error(inter_error_location *eloc, long at, text_stream *err) { eloc->error_offset = (size_t) at; Inter::Errors::issue(Inter::Errors::plain(err, eloc)); exit(1); } @ This tests a file to see if it looks like Inter binary: = int Inter::Binary::test_file(filename *F) { int verdict = TRUE; FILE *fh = BinaryFiles::open_for_reading(F); unsigned int X = 0; if ((BinaryFiles::read_int32(fh, &X) == FALSE) || ((inter_ti) X != INTER_SHIBBOLETH)) verdict = FALSE; if ((BinaryFiles::read_int32(fh, &X) == FALSE) || ((inter_ti) X != 0)) verdict = FALSE; BinaryFiles::close(fh); return verdict; }