src/runtime/save.c

   1 /*
   2  * This software is part of the SBCL system. See the README file for
   3  * more information.
   4  *
   5  * This software is derived from the CMU CL system, which was
   6  * written at Carnegie Mellon University and released into the
   7  * public domain. The software is in the public domain and is
   8  * provided with absolutely no warranty. See the COPYING and CREDITS
   9  * files for more information.
  10  */
  11
  12 #ifndef LISP_FEATURE_WIN32
  13 #include <sys/types.h>
  14 #include <sys/stat.h>
  15 #endif
  16 #include <stdlib.h>
  17 #include <stdio.h>
  18 #include <string.h>
  19 #include <sys/file.h>
  20
  21 #include "sbcl.h"
  22 #if defined(LISP_FEATURE_WIN32) && defined(LISP_FEATURE_SB_THREAD)
  23 #include "pthreads_win32.h"
  24 #else
  25 #include <signal.h>
  26 #endif
  27 #include "runtime.h"
  28 #include "os.h"
  29 #include "core.h"
  30 #include "globals.h"
  31 #include "save.h"
  32 #include "dynbind.h"
  33 #include "lispregs.h"
  34 #include "validate.h"
  35 #include "gc-internal.h"
  36 #include "thread.h"
  37 #include "arch.h"
  38
  39 #include "genesis/static-symbols.h"
  40 #include "genesis/symbol.h"
  41
  42 #ifdef LISP_FEATURE_SB_CORE_COMPRESSION
  43 # include <zlib.h>
  44 #endif
  45
  46 /* write_runtime_options uses a simple serialization scheme that
  47  * consists of one word of magic, one word indicating whether options
  48  * are actually saved, and one word per struct field. */
  49 static void
  50 write_runtime_options(FILE *file, struct runtime_options *options)
  51 {
  52     size_t optarray[RUNTIME_OPTIONS_WORDS];
  53
  54     memset(&optarray, 0, sizeof(optarray));
  55     optarray[0] = RUNTIME_OPTIONS_MAGIC;
  56
  57     if (options != NULL) {
  58         /* optarray[1] is a flag indicating that options are present */
  59         optarray[1] = 1;
  60         optarray[2] = options->dynamic_space_size;
  61         optarray[3] = options->thread_control_stack_size;
  62     }
  63
  64     if (RUNTIME_OPTIONS_WORDS !=
  65         fwrite(optarray, sizeof(size_t), RUNTIME_OPTIONS_WORDS, file)) {
  66         perror("Error writing runtime options to file");
  67     }
  68 }
  69
  70 static void
  71 write_lispobj(lispobj obj, FILE *file)
  72 {
  73     if (1 != fwrite(&obj, sizeof(lispobj), 1, file)) {
  74         perror("Error writing to file");
  75     }
  76 }
  77
  78 static void
  79 write_bytes_to_file(FILE * file, char *addr, long bytes, int compression)
  80 {
  81     if (compression == COMPRESSION_LEVEL_NONE) {
  82         while (bytes > 0) {
  83             sword_t count = fwrite(addr, 1, bytes, file);
  84             if (count > 0) {
  85                 bytes -= count;
  86                 addr += count;
  87             }
  88             else {
  89                 perror("error writing to core file");
  90                 lose("core file is incomplete or corrupt\n");
  91             }
  92         }
  93 #ifdef LISP_FEATURE_SB_CORE_COMPRESSION
  94     } else if ((compression >= -1) && (compression <= 9)) {
  95 # define ZLIB_BUFFER_SIZE (1u<<16)
  96         z_stream stream;
  97         unsigned char* buf = successful_malloc(ZLIB_BUFFER_SIZE);
  98         unsigned char * written, * end;
  99         long total_written = 0;
 100         int ret;
 101         stream.zalloc = NULL;
 102         stream.zfree = NULL;
 103         stream.opaque = NULL;
 104         stream.avail_in = bytes;
 105         stream.next_in  = (void*)addr;
 106         ret = deflateInit(&stream, compression);
 107         if (ret != Z_OK)
 108             lose("deflateInit: %i\n", ret);
 109         do {
 110             stream.avail_out = ZLIB_BUFFER_SIZE;
 111             stream.next_out = buf;
 112             ret = deflate(&stream, Z_FINISH);
 113             if (ret < 0) lose("zlib deflate error: %i... exiting\n", ret);
 114             written = buf;
 115             end     = buf+ZLIB_BUFFER_SIZE-stream.avail_out;
 116             total_written += end - written;
 117             while (written < end) {
 118                 long count = fwrite(written, 1, end-written, file);
 119                 if (count > 0) {
 120                     written += count;
 121                 } else {
 122                     perror("error writing to core file");
 123                     lose("core file is incomplete or corrupt\n");
 124                 }
 125             }
 126         } while (stream.avail_out == 0);
 127         deflateEnd(&stream);
 128         free(buf);
 129         printf("compressed %lu bytes into %lu at level %i\n",
 130                bytes, total_written, compression);
 131 # undef ZLIB_BUFFER_SIZE
 132 #endif
 133     } else {
 134 #ifdef LISP_FEATURE_SB_CORE_COMPRESSION
 135         lose("Unknown core compression level %i, exiting\n", compression);
 136 #else
 137         lose("zlib-compressed core support not built in this runtime\n");
 138 #endif
 139     }
 140
 141     if (fflush(file) != 0) {
 142       perror("error writing to core file");
 143       lose("core file is incomplete or corrupt\n");
 144     }
 145 };
 146
 147
 148 static long
 149 write_and_compress_bytes(FILE *file, char *addr, long bytes, os_vm_offset_t file_offset,
 150                          int compression)
 151 {
 152     long here, data;
 153
 154     bytes = (bytes+os_vm_page_size-1)&~(os_vm_page_size-1);
 155
 156 #ifdef LISP_FEATURE_WIN32
 157     long count;
 158     /* touch every single page in the space to force it to be mapped. */
 159     for (count = 0; count < bytes; count += 0x1000) {
 160         volatile int temp = addr[count];
 161     }
 162 #endif
 163
 164     fflush(file);
 165     here = ftell(file);
 166     fseek(file, 0, SEEK_END);
 167     data = (ftell(file)+os_vm_page_size-1)&~(os_vm_page_size-1);
 168     fseek(file, data, SEEK_SET);
 169     write_bytes_to_file(file, addr, bytes, compression);
 170     fseek(file, here, SEEK_SET);
 171     return ((data - file_offset) / os_vm_page_size) - 1;
 172 }
 173
 174 static long __attribute__((__unused__))
 175 write_bytes(FILE *file, char *addr, long bytes, os_vm_offset_t file_offset)
 176 {
 177     return write_and_compress_bytes(file, addr, bytes, file_offset,
 178                                     COMPRESSION_LEVEL_NONE);
 179 }
 180
 181 extern struct lisp_startup_options lisp_startup_options;
 182
 183 static void
 184 output_space(FILE *file, int id, lispobj *addr, lispobj *end,
 185              os_vm_offset_t file_offset,
 186              int core_compression_level)
 187 {
 188     size_t words, bytes, data, compressed_flag;
 189     static char *names[] = {NULL, "dynamic", "static", "read-only",
 190                             "immobile", "immobile"};
 191
 192     compressed_flag
 193             = ((core_compression_level != COMPRESSION_LEVEL_NONE)
 194                ? DEFLATED_CORE_SPACE_ID_FLAG : 0);
 195
 196     write_lispobj(id | compressed_flag, file);
 197     words = end - addr;
 198     write_lispobj(words, file);
 199
 200     bytes = words * sizeof(lispobj);
 201
 202     if (!lisp_startup_options.noinform)
 203         printf("writing %lu bytes from the %s space at %p\n",
 204                (long unsigned)bytes, names[id], addr);
 205
 206     data = write_and_compress_bytes(file, (char *)addr, bytes, file_offset,
 207                                     core_compression_level);
 208
 209     write_lispobj(data, file);
 210     write_lispobj((uword_t)addr / os_vm_page_size, file);
 211     write_lispobj((bytes + os_vm_page_size - 1) / os_vm_page_size, file);
 212 }
 213
 214 FILE *
 215 open_core_for_saving(char *filename)
 216 {
 217     /* Open the output file. We don't actually need the file yet, but
 218      * the fopen() might fail for some reason, and we want to detect
 219      * that and back out before we do anything irreversible. */
 220     unlink(filename);
 221     return fopen(filename, "wb");
 222 }
 223
 224 #ifdef LISP_FEATURE_IMMOBILE_SPACE
 225 extern void prepare_immobile_space_for_save();
 226 #  define N_SPACES_TO_SAVE 5
 227 #  ifdef LISP_FEATURE_IMMOBILE_CODE
 228 lispobj code_component_order;
 229 extern void defrag_immobile_space(lispobj,boolean);
 230 #  endif
 231 #else
 232 #  define N_SPACES_TO_SAVE 3
 233 #endif
 234 boolean
 235 save_to_filehandle(FILE *file, char *filename, lispobj init_function,
 236                    boolean make_executable,
 237                    boolean save_runtime_options,
 238                    int core_compression_level)
 239 {
 240     struct thread *th;
 241     os_vm_offset_t core_start_pos;
 242     boolean verbose = !lisp_startup_options.noinform;
 243
 244 #ifdef LISP_FEATURE_X86_64
 245     untune_asm_routines_for_microarch();
 246 #endif
 247
 248     /* Smash the enclosing state. (Once we do this, there's no good
 249      * way to go back, which is a sufficient reason that this ends up
 250      * being SAVE-LISP-AND-DIE instead of SAVE-LISP-AND-GO-ON). */
 251     if (verbose) {
 252         printf("[undoing binding stack and other enclosing state... ");
 253         fflush(stdout);
 254     }
 255     for_each_thread(th) {       /* XXX really? */
 256         unbind_to_here((lispobj *)th->binding_stack_start,th);
 257         SetSymbolValue(CURRENT_CATCH_BLOCK, 0,th);
 258         SetSymbolValue(CURRENT_UNWIND_PROTECT_BLOCK, 0,th);
 259     }
 260     if (verbose) printf("done]\n");
 261 #ifdef LISP_FEATURE_IMMOBILE_CODE
 262     // It's better to wait to defrag until after the binding stack is undone,
 263     // because we explicitly don't fixup code refs from stacks.
 264     // i.e. if there *were* something on the binding stack that cared that code
 265     // moved, it would be wrong. This way we can be sure we don't care.
 266     if (code_component_order) {
 267         // Assert that defrag will not move the init_function
 268         gc_assert(!immobile_space_p(init_function));
 269         if (verbose) {
 270             printf("[defragmenting immobile space... ");
 271             fflush(stdout);
 272         }
 273         defrag_immobile_space(code_component_order, verbose);
 274         if (verbose) printf("done]\n");
 275     }
 276 #endif
 277
 278     /* (Now we can actually start copying ourselves into the output file.) */
 279
 280     if (verbose) {
 281         printf("[saving current Lisp image into %s:\n", filename);
 282         fflush(stdout);
 283     }
 284
 285     core_start_pos = ftell(file);
 286     write_lispobj(CORE_MAGIC, file);
 287
 288     write_lispobj(BUILD_ID_CORE_ENTRY_TYPE_CODE, file);
 289     write_lispobj(/* (We're writing the word count of the entry here, and the 2
 290           * term is one word for the leading BUILD_ID_CORE_ENTRY_TYPE_CODE
 291           * word and one word where we store the count itself.) */
 292          2 + strlen((const char *)build_id),
 293          file);
 294     {
 295         unsigned char *p;
 296         for (p = (unsigned char *)build_id; *p; ++p)
 297             write_lispobj(*p, file);
 298     }
 299
 300     write_lispobj(NEW_DIRECTORY_CORE_ENTRY_TYPE_CODE, file);
 301     write_lispobj(/* (word count = N spaces described by 5 words each, plus the
 302           * entry type code, plus this count itself) */
 303          (5*N_SPACES_TO_SAVE)+2, file);
 304     output_space(file,
 305                  READ_ONLY_CORE_SPACE_ID,
 306                  (lispobj *)READ_ONLY_SPACE_START,
 307                  read_only_space_free_pointer,
 308                  core_start_pos,
 309                  core_compression_level);
 310     output_space(file,
 311                  STATIC_CORE_SPACE_ID,
 312                  (lispobj *)STATIC_SPACE_START,
 313                  static_space_free_pointer,
 314                  core_start_pos,
 315                  core_compression_level);
 316 #ifdef LISP_FEATURE_GENCGC
 317     /* Flush the current_region, updating the tables. */
 318     gc_alloc_update_all_page_tables(1);
 319     update_dynamic_space_free_pointer();
 320 #endif
 321 #ifdef LISP_FEATURE_IMMOBILE_SPACE
 322     prepare_immobile_space_for_save();
 323     output_space(file,
 324                  IMMOBILE_FIXEDOBJ_CORE_SPACE_ID,
 325                  (lispobj *)IMMOBILE_SPACE_START,
 326                  immobile_fixedobj_free_pointer,
 327                  core_start_pos,
 328                  core_compression_level);
 329     output_space(file,
 330                  IMMOBILE_VARYOBJ_CORE_SPACE_ID,
 331                  (lispobj *)IMMOBILE_VARYOBJ_SUBSPACE_START,
 332                  immobile_space_free_pointer,
 333                  core_start_pos,
 334                  core_compression_level);
 335 #endif
 336 #ifdef reg_ALLOC
 337 #ifdef LISP_FEATURE_GENCGC
 338     output_space(file,
 339                  DYNAMIC_CORE_SPACE_ID,
 340                  (lispobj *)DYNAMIC_SPACE_START,
 341                  dynamic_space_free_pointer,
 342                  core_start_pos,
 343                  core_compression_level);
 344 #else
 345     output_space(file,
 346                  DYNAMIC_CORE_SPACE_ID,
 347                  (lispobj *)current_dynamic_space,
 348                  dynamic_space_free_pointer,
 349                  core_start_pos,
 350                  core_compression_level);
 351 #endif
 352 #else
 353     output_space(file,
 354                  DYNAMIC_CORE_SPACE_ID,
 355                  (lispobj *)DYNAMIC_SPACE_START,
 356                  (lispobj *)SymbolValue(ALLOCATION_POINTER,0),
 357                  core_start_pos,
 358                  core_compression_level);
 359 #endif
 360
 361     write_lispobj(INITIAL_FUN_CORE_ENTRY_TYPE_CODE, file);
 362     write_lispobj(3, file);
 363     write_lispobj(init_function, file);
 364
 365 #ifdef LISP_FEATURE_GENCGC
 366     {
 367         size_t true_size = sizeof last_free_page
 368             + (last_free_page * sizeof(struct corefile_pte));
 369         size_t rounded_size = CEILING(true_size, os_vm_page_size);
 370         char* data = successful_malloc(rounded_size);
 371         *(page_index_t*)data = last_free_page;
 372         struct corefile_pte *ptes = (struct corefile_pte*)(data + sizeof(page_index_t));
 373         page_index_t i;
 374         for (i = 0; i < last_free_page; i++) {
 375                 /* Thanks to alignment requirements, the two low bits
 376                  * are always zero, so we can use them to store the
 377                  * allocation type -- region is always closed, so only
 378                  * the two low bits of allocation flags matter. */
 379                 uword_t word = page_scan_start_offset(i);
 380                 gc_assert((word & 0x03) == 0);
 381                 ptes[i].sso = word | (0x03 & page_table[i].allocated);
 382                 ptes[i].bytes_used = page_bytes_used(i);
 383         }
 384         write_lispobj(PAGE_TABLE_CORE_ENTRY_TYPE_CODE, file);
 385         write_lispobj(4, file);
 386         write_lispobj(rounded_size, file);
 387         sword_t offset = write_bytes(file, data, rounded_size, core_start_pos);
 388         write_lispobj(offset, file);
 389     }
 390 #endif
 391
 392     write_lispobj(END_CORE_ENTRY_TYPE_CODE, file);
 393
 394     /* Write a trailing header, ignored when parsing the core normally.
 395      * This is used to locate the start of the core when the runtime is
 396      * prepended to it. */
 397     fseek(file, 0, SEEK_END);
 398
 399     /* If NULL runtime options are passed to write_runtime_options,
 400      * command-line processing is performed as normal in the SBCL
 401      * executable. Otherwise, the saved runtime options are used and
 402      * all command-line arguments are available to Lisp in
 403      * SB-EXT:*POSIX-ARGV*. */
 404     write_runtime_options(file,
 405                           (save_runtime_options ? runtime_options : NULL));
 406
 407     if (1 != fwrite(&core_start_pos, sizeof(os_vm_offset_t), 1, file)) {
 408         perror("Error writing core starting position to file");
 409         fclose(file);
 410     } else {
 411         write_lispobj(CORE_MAGIC, file);
 412         fclose(file);
 413     }
 414
 415 #ifndef LISP_FEATURE_WIN32
 416     if (make_executable)
 417         chmod (filename, 0755);
 418 #endif
 419
 420     if (verbose) printf("done]\n");
 421     exit(0);
 422 }
 423 #undef N_SPACES_TO_SAVE
 424
 425 /* Check if the build_id for the current runtime is present in a
 426  * buffer. */
 427 int
 428 check_runtime_build_id(void *buf, size_t size)
 429 {
 430     size_t idlen;
 431     char *pos;
 432
 433     idlen = strlen((const char*)build_id) - 1;
 434     while ((pos = memchr(buf, build_id[0], size)) != NULL) {
 435         size -= (pos + 1) - (char *)buf;
 436         buf = (pos + 1);
 437         if (idlen <= size && memcmp(buf, build_id + 1, idlen) == 0)
 438             return 1;
 439     }
 440
 441     return 0;
 442 }
 443
 444 /* Slurp the executable portion of the runtime into a malloced buffer
 445  * and return it.  Places the size in bytes of the runtime into
 446  * 'size_out'.  Returns NULL if the runtime cannot be loaded from
 447  * 'runtime_path'. */
 448 void *
 449 load_runtime(char *runtime_path, size_t *size_out)
 450 {
 451     void *buf = NULL;
 452     FILE *input = NULL;
 453     size_t size, count;
 454     os_vm_offset_t core_offset;
 455
 456     core_offset = search_for_embedded_core (runtime_path);
 457     if ((input = fopen(runtime_path, "rb")) == NULL) {
 458         fprintf(stderr, "Unable to open runtime: %s\n", runtime_path);
 459         goto lose;
 460     }
 461
 462     fseek(input, 0, SEEK_END);
 463     size = (size_t) ftell(input);
 464     fseek(input, 0, SEEK_SET);
 465
 466     if (core_offset != -1 && size > (size_t) core_offset)
 467         size = core_offset;
 468
 469     buf = successful_malloc(size);
 470     if ((count = fread(buf, 1, size, input)) != size) {
 471         fprintf(stderr, "Premature EOF while reading runtime.\n");
 472         goto lose;
 473     }
 474
 475     if (!check_runtime_build_id(buf, size)) {
 476         fprintf(stderr, "Failed to locate current build_id in runtime: %s\n",
 477             runtime_path);
 478         goto lose;
 479     }
 480
 481     fclose(input);
 482     *size_out = size;
 483     return buf;
 484
 485 lose:
 486     if (input != NULL)
 487         fclose(input);
 488     if (buf != NULL)
 489         free(buf);
 490     return NULL;
 491 }
 492
 493 boolean
 494 save_runtime_to_filehandle(FILE *output, void *runtime, size_t runtime_size,
 495                            int application_type)
 496 {
 497     size_t padding;
 498     void *padbytes;
 499
 500 #ifdef LISP_FEATURE_WIN32
 501     {
 502         PIMAGE_DOS_HEADER dos_header = (PIMAGE_DOS_HEADER)runtime;
 503         PIMAGE_NT_HEADERS nt_header = (PIMAGE_NT_HEADERS)((char *)dos_header +
 504                                                           dos_header->e_lfanew);
 505
 506         int sub_system;
 507         switch (application_type) {
 508         case 0:
 509             sub_system = IMAGE_SUBSYSTEM_WINDOWS_CUI;
 510             break;
 511         case 1:
 512             sub_system = IMAGE_SUBSYSTEM_WINDOWS_GUI;
 513             break;
 514         default:
 515             fprintf(stderr, "Invalid application type %d\n", application_type);
 516             return 0;
 517         }
 518
 519         nt_header->OptionalHeader.Subsystem = sub_system;
 520     }
 521 #endif
 522
 523     if (runtime_size != fwrite(runtime, 1, runtime_size, output)) {
 524         perror("Error saving runtime");
 525         return 0;
 526     }
 527
 528     padding = (os_vm_page_size - (runtime_size % os_vm_page_size)) & ~os_vm_page_size;
 529     if (padding > 0) {
 530         padbytes = successful_malloc(padding);
 531         memset(padbytes, 0, padding);
 532         if (padding != fwrite(padbytes, 1, padding, output)) {
 533             perror("Error saving runtime");
 534             free(padbytes);
 535             return 0;
 536         }
 537         free(padbytes);
 538     }
 539
 540     return 1;
 541 }
 542
 543 FILE *
 544 prepare_to_save(char *filename, boolean prepend_runtime, void **runtime_bytes,
 545                 size_t *runtime_size)
 546 {
 547     FILE *file;
 548     char *runtime_path;
 549
 550     if (prepend_runtime) {
 551         runtime_path = os_get_runtime_executable_path(0);
 552
 553         if (runtime_path == NULL && saved_runtime_path == NULL) {
 554             fprintf(stderr, "Unable to get default runtime path.\n");
 555             return NULL;
 556         }
 557
 558         if (runtime_path == NULL)
 559             *runtime_bytes = load_runtime(saved_runtime_path, runtime_size);
 560         else {
 561             *runtime_bytes = load_runtime(runtime_path, runtime_size);
 562             free(runtime_path);
 563         }
 564
 565         if (*runtime_bytes == NULL)
 566             return 0;
 567     }
 568
 569     file = open_core_for_saving(filename);
 570     if (file == NULL) {
 571         free(*runtime_bytes);
 572         perror(filename);
 573         return NULL;
 574     }
 575
 576     return file;
 577 }
 578
 579 #ifdef LISP_FEATURE_CHENEYGC
 580 boolean
 581 save(char *filename, lispobj init_function, boolean prepend_runtime,
 582      boolean save_runtime_options, boolean compressed, int compression_level,
 583      int application_type)
 584 {
 585     FILE *file;
 586     void *runtime_bytes = NULL;
 587     size_t runtime_size;
 588
 589     file = prepare_to_save(filename, prepend_runtime, &runtime_bytes, &runtime_size);
 590     if (file == NULL)
 591         return 1;
 592
 593     if (prepend_runtime)
 594         save_runtime_to_filehandle(file, runtime_bytes, runtime_size, application_type);
 595
 596     return save_to_filehandle(file, filename, init_function, prepend_runtime,
 597                               save_runtime_options,
 598                               compressed ? compressed : COMPRESSION_LEVEL_NONE);
 599 }
 600 #endif