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 #include <stdio.h>
  13 #include <signal.h>
  14 #include <sys/file.h>
  15
  16 #include "runtime.h"
  17 #include "os.h"
  18 #include "sbcl.h"
  19 #include "core.h"
  20 #include "globals.h"
  21 #include "save.h"
  22 #include "dynbind.h"
  23 #include "lispregs.h"
  24 #include "validate.h"
  25
  26 #ifdef GENCGC
  27 #include "gencgc.h"
  28 #endif
  29
  30 static long
  31 write_bytes(FILE *file, char *addr, long bytes)
  32 {
  33     long count, here, data;
  34
  35     bytes = (bytes+os_vm_page_size-1)&~(os_vm_page_size-1);
  36
  37     fflush(file);
  38     here = ftell(file);
  39     fseek(file, 0, 2);
  40     data = (ftell(file)+os_vm_page_size-1)&~(os_vm_page_size-1);
  41     fseek(file, data, 0);
  42
  43     while (bytes > 0) {
  44         count = fwrite(addr, 1, bytes, file);
  45         if (count > 0) {
  46             bytes -= count;
  47             addr += count;
  48         }
  49         else {
  50             perror("error writing to save file");
  51             bytes = 0;
  52         }
  53     }
  54     fflush(file);
  55     fseek(file, here, 0);
  56     return data/os_vm_page_size - 1;
  57 }
  58
  59 static void
  60 output_space(FILE *file, int id, lispobj *addr, lispobj *end)
  61 {
  62     int words, bytes, data;
  63     static char *names[] = {NULL, "dynamic", "static", "read-only"};
  64
  65     putw(id, file);
  66     words = end - addr;
  67     putw(words, file);
  68
  69     bytes = words * sizeof(lispobj);
  70
  71     printf("writing %d bytes from the %s space at 0x%08lx\n",
  72            bytes, names[id], (unsigned long)addr);
  73
  74     data = write_bytes(file, (char *)addr, bytes);
  75
  76     putw(data, file);
  77     putw((long)addr / os_vm_page_size, file);
  78     putw((bytes + os_vm_page_size - 1) / os_vm_page_size, file);
  79 }
  80
  81 boolean
  82 save(char *filename, lispobj init_function)
  83 {
  84     FILE *file;
  85
  86     /* Open the output file. We don't actually need the file yet, but
  87      * the fopen() might fail for some reason, and we want to detect
  88      * that and back out before we do anything irreversible. */
  89     unlink(filename);
  90     file = fopen(filename, "w");
  91     if (!file) {
  92         perror(filename);
  93         return 1;
  94     }
  95
  96     /* Smash the enclosing state. (Once we do this, there's no good
  97      * way to go back, which is a sufficient reason that this ends up
  98      * being SAVE-LISP-AND-DIE instead of SAVE-LISP-AND-GO-ON). */
  99     printf("[undoing binding stack and other enclosing state... ");
 100     fflush(stdout);
 101     unbind_to_here((lispobj *)BINDING_STACK_START);
 102     SetSymbolValue(CURRENT_CATCH_BLOCK, 0);
 103     SetSymbolValue(CURRENT_UNWIND_PROTECT_BLOCK, 0);
 104     printf("done]\n");
 105     fflush(stdout);
 106
 107     /* (Now we can actually start copying ourselves into the
 108      * output file.) */
 109
 110     printf("[saving current Lisp image into %s:\n", filename);
 111     fflush(stdout);
 112
 113     putw(CORE_MAGIC, file);
 114
 115     putw(CORE_VERSION, file);
 116     putw(3, file);
 117     putw(SBCL_CORE_VERSION_INTEGER, file);
 118
 119     putw(CORE_NDIRECTORY, file);
 120     putw((5*3)+2, file);
 121
 122     output_space(file,
 123                  READ_ONLY_SPACE_ID,
 124                  (lispobj *)READ_ONLY_SPACE_START,
 125                  (lispobj *)SymbolValue(READ_ONLY_SPACE_FREE_POINTER));
 126     output_space(file,
 127                  STATIC_SPACE_ID,
 128                  (lispobj *)STATIC_SPACE_START,
 129                  (lispobj *)SymbolValue(STATIC_SPACE_FREE_POINTER));
 130 #ifdef reg_ALLOC
 131     output_space(file,
 132                  DYNAMIC_SPACE_ID,
 133                  (lispobj *)current_dynamic_space,
 134                  dynamic_space_free_pointer);
 135 #else
 136 #ifdef GENCGC
 137     /* Flush the current_region, updating the tables. */
 138     gc_alloc_update_page_tables(0,&boxed_region);
 139     gc_alloc_update_page_tables(1,&unboxed_region);
 140     update_x86_dynamic_space_free_pointer();
 141 #endif
 142     output_space(file,
 143                  DYNAMIC_SPACE_ID,
 144                  (lispobj *)DYNAMIC_SPACE_START,
 145                  (lispobj *)SymbolValue(ALLOCATION_POINTER));
 146 #endif
 147
 148     putw(CORE_INITIAL_FUNCTION, file);
 149     putw(3, file);
 150     putw(init_function, file);
 151
 152     putw(CORE_END, file);
 153
 154     fclose(file);
 155     printf("done]\n");
 156
 157     exit(0);
 158 }