2 * This software is part of the SBCL system. See the README file for
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.
12 #ifndef LISP_FEATURE_WIN32
13 #include <sys/types.h>
22 #if defined(LISP_FEATURE_WIN32) && defined(LISP_FEATURE_SB_THREAD)
23 #include "pthreads_win32.h"
35 #include "gc-internal.h"
38 #include "genesis/static-symbols.h"
39 #include "genesis/symbol.h"
41 #ifdef LISP_FEATURE_SB_CORE_COMPRESSION
45 /* write_runtime_options uses a simple serialization scheme that
46 * consists of one word of magic, one word indicating whether options
47 * are actually saved, and one word per struct field. */
49 write_runtime_options(FILE *file, struct runtime_options *options)
51 size_t optarray[RUNTIME_OPTIONS_WORDS];
53 memset(&optarray, 0, sizeof(optarray));
54 optarray[0] = RUNTIME_OPTIONS_MAGIC;
56 if (options != NULL) {
57 /* optarray[1] is a flag indicating that options are present */
59 optarray[2] = options->dynamic_space_size;
60 optarray[3] = options->thread_control_stack_size;
63 if (RUNTIME_OPTIONS_WORDS !=
64 fwrite(optarray, sizeof(size_t), RUNTIME_OPTIONS_WORDS, file)) {
65 perror("Error writing runtime options to file");
70 write_lispobj(lispobj obj, FILE *file)
72 if (1 != fwrite(&obj, sizeof(lispobj), 1, file)) {
73 perror("Error writing to file");
78 write_bytes_to_file(FILE * file, char *addr, long bytes, int compression)
80 if (compression == COMPRESSION_LEVEL_NONE) {
82 long count = fwrite(addr, 1, bytes, file);
88 perror("error writing to save file");
92 #ifdef LISP_FEATURE_SB_CORE_COMPRESSION
93 } else if ((compression >= -1) && (compression <= 9)) {
94 # define ZLIB_BUFFER_SIZE (1u<<16)
96 unsigned char buf[ZLIB_BUFFER_SIZE];
97 unsigned char * written, * end;
98 long total_written = 0;
100 stream.zalloc = NULL;
102 stream.opaque = NULL;
103 stream.avail_in = bytes;
104 stream.next_in = (void*)addr;
105 ret = deflateInit(&stream, compression);
107 lose("deflateInit: %i\n", ret);
109 stream.avail_out = sizeof(buf);
110 stream.next_out = buf;
111 ret = deflate(&stream, Z_FINISH);
112 if (ret < 0) lose("zlib deflate error: %i... exiting\n", ret);
114 end = buf+sizeof(buf)-stream.avail_out;
115 total_written += end - written;
116 while (written < end) {
117 long count = fwrite(written, 1, end-written, file);
121 lose("unable to write to core file\n");
124 } while (stream.avail_out == 0);
126 printf("compressed %lu bytes into %lu at level %i\n",
127 bytes, total_written, compression);
128 # undef ZLIB_BUFFER_SIZE
131 #ifdef LISP_FEATURE_SB_CORE_COMPRESSION
132 lose("Unknown core compression level %i, exiting\n", compression);
134 lose("zlib-compressed core support not built in this runtime\n");
143 write_and_compress_bytes(FILE *file, char *addr, long bytes, os_vm_offset_t file_offset,
148 bytes = (bytes+os_vm_page_size-1)&~(os_vm_page_size-1);
150 #ifdef LISP_FEATURE_WIN32
152 /* touch every single page in the space to force it to be mapped. */
153 for (count = 0; count < bytes; count += 0x1000) {
154 volatile int temp = addr[count];
160 fseek(file, 0, SEEK_END);
161 data = (ftell(file)+os_vm_page_size-1)&~(os_vm_page_size-1);
162 fseek(file, data, SEEK_SET);
163 write_bytes_to_file(file, addr, bytes, compression);
164 fseek(file, here, SEEK_SET);
165 return ((data - file_offset) / os_vm_page_size) - 1;
169 write_bytes(FILE *file, char *addr, long bytes, os_vm_offset_t file_offset)
171 return write_and_compress_bytes(file, addr, bytes, file_offset,
172 COMPRESSION_LEVEL_NONE);
176 output_space(FILE *file, int id, lispobj *addr, lispobj *end,
177 os_vm_offset_t file_offset,
178 int core_compression_level)
180 size_t words, bytes, data, compressed_flag;
181 static char *names[] = {NULL, "dynamic", "static", "read-only"};
184 = ((core_compression_level != COMPRESSION_LEVEL_NONE)
185 ? DEFLATED_CORE_SPACE_ID_FLAG : 0);
187 write_lispobj(id | compressed_flag, file);
189 write_lispobj(words, file);
191 bytes = words * sizeof(lispobj);
193 printf("writing %lu bytes from the %s space at 0x%08lx\n",
194 (unsigned long)bytes, names[id], (unsigned long)addr);
196 data = write_and_compress_bytes(file, (char *)addr, bytes, file_offset,
197 core_compression_level);
199 write_lispobj(data, file);
200 write_lispobj((long)addr / os_vm_page_size, file);
201 write_lispobj((bytes + os_vm_page_size - 1) / os_vm_page_size, file);
205 open_core_for_saving(char *filename)
207 /* Open the output file. We don't actually need the file yet, but
208 * the fopen() might fail for some reason, and we want to detect
209 * that and back out before we do anything irreversible. */
211 return fopen(filename, "wb");
215 save_to_filehandle(FILE *file, char *filename, lispobj init_function,
216 boolean make_executable,
217 boolean save_runtime_options,
218 int core_compression_level)
221 os_vm_offset_t core_start_pos;
223 /* Smash the enclosing state. (Once we do this, there's no good
224 * way to go back, which is a sufficient reason that this ends up
225 * being SAVE-LISP-AND-DIE instead of SAVE-LISP-AND-GO-ON). */
226 printf("[undoing binding stack and other enclosing state... ");
228 for_each_thread(th) { /* XXX really? */
229 unbind_to_here((lispobj *)th->binding_stack_start,th);
230 SetSymbolValue(CURRENT_CATCH_BLOCK, 0,th);
231 SetSymbolValue(CURRENT_UNWIND_PROTECT_BLOCK, 0,th);
236 /* (Now we can actually start copying ourselves into the output file.) */
238 printf("[saving current Lisp image into %s:\n", filename);
241 core_start_pos = ftell(file);
242 write_lispobj(CORE_MAGIC, file);
244 write_lispobj(VERSION_CORE_ENTRY_TYPE_CODE, file);
245 write_lispobj(3, file);
246 write_lispobj(SBCL_CORE_VERSION_INTEGER, file);
248 write_lispobj(BUILD_ID_CORE_ENTRY_TYPE_CODE, file);
249 write_lispobj(/* (We're writing the word count of the entry here, and the 2
250 * term is one word for the leading BUILD_ID_CORE_ENTRY_TYPE_CODE
251 * word and one word where we store the count itself.) */
252 2 + strlen((const char *)build_id),
256 for (p = (unsigned char *)build_id; *p; ++p)
257 write_lispobj(*p, file);
260 write_lispobj(NEW_DIRECTORY_CORE_ENTRY_TYPE_CODE, file);
261 write_lispobj(/* (word count = 3 spaces described by 5 words each, plus the
262 * entry type code, plus this count itself) */
265 READ_ONLY_CORE_SPACE_ID,
266 (lispobj *)READ_ONLY_SPACE_START,
267 (lispobj *)SymbolValue(READ_ONLY_SPACE_FREE_POINTER,0),
269 core_compression_level);
271 STATIC_CORE_SPACE_ID,
272 (lispobj *)STATIC_SPACE_START,
273 (lispobj *)SymbolValue(STATIC_SPACE_FREE_POINTER,0),
275 core_compression_level);
276 #ifdef LISP_FEATURE_GENCGC
277 /* Flush the current_region, updating the tables. */
278 gc_alloc_update_all_page_tables();
279 update_dynamic_space_free_pointer();
282 #ifdef LISP_FEATURE_GENCGC
284 DYNAMIC_CORE_SPACE_ID,
285 (lispobj *)DYNAMIC_SPACE_START,
286 dynamic_space_free_pointer,
288 core_compression_level);
291 DYNAMIC_CORE_SPACE_ID,
292 (lispobj *)current_dynamic_space,
293 dynamic_space_free_pointer,
295 core_compression_level);
299 DYNAMIC_CORE_SPACE_ID,
300 (lispobj *)DYNAMIC_SPACE_START,
301 (lispobj *)SymbolValue(ALLOCATION_POINTER,0),
303 core_compression_level);
306 write_lispobj(INITIAL_FUN_CORE_ENTRY_TYPE_CODE, file);
307 write_lispobj(3, file);
308 write_lispobj(init_function, file);
310 #ifdef LISP_FEATURE_GENCGC
312 size_t size = (last_free_page*sizeof(long)+os_vm_page_size-1)
313 &~(os_vm_page_size-1);
314 unsigned long *data = calloc(size, 1);
319 for (i = 0; i < last_free_page; i++) {
320 /* Thanks to alignment requirements, the two low bits
321 * are always zero, so we can use them to store the
322 * allocation type -- region is always closed, so only
323 * the two low bits of allocation flags matter. */
324 word = page_table[i].region_start_offset;
325 gc_assert((word & 0x03) == 0);
326 data[i] = word | (0x03 & page_table[i].allocated);
328 write_lispobj(PAGE_TABLE_CORE_ENTRY_TYPE_CODE, file);
329 write_lispobj(4, file);
330 write_lispobj(size, file);
331 offset = write_bytes(file, (char *)data, size, core_start_pos);
332 write_lispobj(offset, file);
337 write_lispobj(END_CORE_ENTRY_TYPE_CODE, file);
339 /* Write a trailing header, ignored when parsing the core normally.
340 * This is used to locate the start of the core when the runtime is
341 * prepended to it. */
342 fseek(file, 0, SEEK_END);
344 /* If NULL runtime options are passed to write_runtime_options,
345 * command-line processing is performed as normal in the SBCL
346 * executable. Otherwise, the saved runtime options are used and
347 * all command-line arguments are available to Lisp in
348 * SB-EXT:*POSIX-ARGV*. */
349 write_runtime_options(file,
350 (save_runtime_options ? runtime_options : NULL));
352 if (1 != fwrite(&core_start_pos, sizeof(os_vm_offset_t), 1, file)) {
353 perror("Error writing core starting position to file");
356 write_lispobj(CORE_MAGIC, file);
360 #ifndef LISP_FEATURE_WIN32
362 chmod (filename, 0755);
369 /* Check if the build_id for the current runtime is present in a
372 check_runtime_build_id(void *buf, size_t size)
377 idlen = strlen(build_id) - 1;
378 while ((pos = memchr(buf, build_id[0], size)) != NULL) {
379 size -= (pos + 1) - (char *)buf;
381 if (idlen <= size && memcmp(buf, build_id + 1, idlen) == 0)
388 /* Slurp the executable portion of the runtime into a malloced buffer
389 * and return it. Places the size in bytes of the runtime into
390 * 'size_out'. Returns NULL if the runtime cannot be loaded from
393 load_runtime(char *runtime_path, size_t *size_out)
398 os_vm_offset_t core_offset;
400 core_offset = search_for_embedded_core (runtime_path);
401 if ((input = fopen(runtime_path, "rb")) == NULL) {
402 fprintf(stderr, "Unable to open runtime: %s\n", runtime_path);
406 fseek(input, 0, SEEK_END);
407 size = (size_t) ftell(input);
408 fseek(input, 0, SEEK_SET);
410 if (core_offset != -1 && size > core_offset)
413 buf = successful_malloc(size);
414 if ((count = fread(buf, 1, size, input)) != size) {
415 fprintf(stderr, "Premature EOF while reading runtime.\n");
419 if (!check_runtime_build_id(buf, size)) {
420 fprintf(stderr, "Failed to locate current build_id in runtime: %s\n",
438 save_runtime_to_filehandle(FILE *output, void *runtime, size_t runtime_size)
443 if (runtime_size != fwrite(runtime, 1, runtime_size, output)) {
444 perror("Error saving runtime");
448 padding = (os_vm_page_size - (runtime_size % os_vm_page_size)) & ~os_vm_page_size;
450 padbytes = successful_malloc(padding);
451 memset(padbytes, 0, padding);
452 if (padding != fwrite(padbytes, 1, padding, output)) {
453 perror("Error saving runtime");
464 prepare_to_save(char *filename, boolean prepend_runtime, void **runtime_bytes,
465 size_t *runtime_size)
470 if (prepend_runtime) {
471 runtime_path = os_get_runtime_executable_path(0);
473 if (runtime_path == NULL && saved_runtime_path == NULL) {
474 fprintf(stderr, "Unable to get default runtime path.\n");
478 if (runtime_path == NULL)
479 *runtime_bytes = load_runtime(saved_runtime_path, runtime_size);
481 *runtime_bytes = load_runtime(runtime_path, runtime_size);
485 if (*runtime_bytes == NULL)
489 file = open_core_for_saving(filename);
491 free(*runtime_bytes);
500 save(char *filename, lispobj init_function, boolean prepend_runtime,
501 boolean save_runtime_options, boolean compressed, int compression_level)
504 void *runtime_bytes = NULL;
507 file = prepare_to_save(filename, prepend_runtime, &runtime_bytes, &runtime_size);
512 save_runtime_to_filehandle(file, runtime_bytes, runtime_size);
514 return save_to_filehandle(file, filename, init_function, prepend_runtime,
515 save_runtime_options,
516 compressed ? compressed : COMPRESSION_LEVEL_NONE);