2 * A saved SBCL system is a .core file; the code here helps us accept
3 * such a file as input.
7 * This software is part of the SBCL system. See the README file for
10 * This software is derived from the CMU CL system, which was
11 * written at Carnegie Mellon University and released into the
12 * public domain. The software is in the public domain and is
13 * provided with absolutely no warranty. See the COPYING and CREDITS
14 * files for more information.
21 #include <sys/types.h>
36 #include "gc-internal.h"
39 #if defined(LISP_FEATURE_SB_THREAD) && defined(LISP_FEATURE_SB_LUTEX)
40 #include "genesis/sap.h"
41 #include "pthread-lutex.h"
45 unsigned char build_id[] =
46 #include "../../output/build-id.tmp"
50 open_binary(char *filename, int mode)
52 #ifdef LISP_FEATURE_WIN32
56 return open(filename, mode);
59 /* Search 'filename' for an embedded core. An SBCL core has, at the
60 * end of the file, a trailer containing the size of the core (an
61 * os_vm_offset_t) and a final signature word (the lispobj
62 * CORE_MAGIC). If this trailer is found at the end of the file, the
63 * start of the core can be determined from the core size.
65 * If an embedded core is present, this returns the offset into the
66 * file to load the core from, or -1 if no core is present. */
68 search_for_embedded_core(char *filename)
71 os_vm_offset_t lispobj_size = sizeof(lispobj);
72 os_vm_offset_t trailer_size = lispobj_size + sizeof(os_vm_offset_t);
73 os_vm_offset_t core_size, pos;
76 if ((fd = open_binary(filename, O_RDONLY)) < 0)
78 if (lseek(fd, -lispobj_size, SEEK_END) < 0)
80 if (read(fd, &header, (size_t)lispobj_size) < lispobj_size)
83 if (header == CORE_MAGIC) {
84 if (lseek(fd, -trailer_size, SEEK_END) < 0)
86 if (read(fd, &core_size, sizeof(os_vm_offset_t)) < 0)
89 if (lseek(fd, -(core_size + trailer_size), SEEK_END) < 0)
91 pos = lseek(fd, 0, SEEK_CUR);
93 if (read(fd, &header, (size_t)lispobj_size) < lispobj_size)
96 if (header != CORE_MAGIC)
111 process_directory(int fd, lispobj *ptr, int count, os_vm_offset_t file_offset)
113 struct ndir_entry *entry;
115 FSHOW((stderr, "/process_directory(..), count=%d\n", count));
117 for (entry = (struct ndir_entry *) ptr; --count>= 0; ++entry) {
119 long id = entry->identifier;
120 long offset = os_vm_page_size * (1 + entry->data_page);
121 os_vm_address_t addr =
122 (os_vm_address_t) (os_vm_page_size * entry->address);
123 lispobj *free_pointer = (lispobj *) addr + entry->nwords;
124 unsigned long len = os_vm_page_size * entry->page_count;
127 os_vm_address_t real_addr;
128 FSHOW((stderr, "/mapping %ld(0x%lx) bytes at 0x%lx\n",
129 (long)len, (long)len, (unsigned long)addr));
130 real_addr = os_map(fd, offset + file_offset, addr, len);
131 if (real_addr != addr) {
132 lose("file mapped in wrong place! "
133 "(0x%08x != 0x%08lx)\n",
139 FSHOW((stderr, "/space id = %ld, free pointer = 0x%lx\n",
140 id, (unsigned long)free_pointer));
143 case DYNAMIC_CORE_SPACE_ID:
144 if (len > dynamic_space_size) {
146 "dynamic space too small for core: %ldKiB required, %ldKiB available.\n",
148 (long)dynamic_space_size >> 10);
151 #ifdef LISP_FEATURE_GENCGC
152 if (addr != (os_vm_address_t)DYNAMIC_SPACE_START) {
153 fprintf(stderr, "in core: 0x%lx; in runtime: 0x%lx \n",
154 (long)addr, (long)DYNAMIC_SPACE_START);
155 lose("core/runtime address mismatch: DYNAMIC_SPACE_START\n");
158 if ((addr != (os_vm_address_t)DYNAMIC_0_SPACE_START) &&
159 (addr != (os_vm_address_t)DYNAMIC_1_SPACE_START)) {
160 fprintf(stderr, "in core: 0x%lx; in runtime: 0x%lx or 0x%lx\n",
162 (long)DYNAMIC_0_SPACE_START,
163 (long)DYNAMIC_1_SPACE_START);
164 lose("warning: core/runtime address mismatch: DYNAMIC_SPACE_START\n");
167 #if defined(ALLOCATION_POINTER)
168 SetSymbolValue(ALLOCATION_POINTER, (lispobj)free_pointer,0);
170 dynamic_space_free_pointer = free_pointer;
172 /* For stop-and-copy GC, this will be whatever the GC was
173 * using at the time. With GENCGC, this will always be
174 * space 0. (We checked above that for GENCGC,
175 * addr==DYNAMIC_SPACE_START.) */
176 current_dynamic_space = (lispobj *)addr;
178 case STATIC_CORE_SPACE_ID:
179 if (addr != (os_vm_address_t)STATIC_SPACE_START) {
180 fprintf(stderr, "in core: 0x%lx - in runtime: 0x%lx\n",
181 (long)addr, (long)STATIC_SPACE_START);
182 lose("core/runtime address mismatch: STATIC_SPACE_START\n");
185 case READ_ONLY_CORE_SPACE_ID:
186 if (addr != (os_vm_address_t)READ_ONLY_SPACE_START) {
187 fprintf(stderr, "in core: 0x%lx - in runtime: 0x%lx\n",
188 (long)addr, (long)READ_ONLY_SPACE_START);
189 lose("core/runtime address mismatch: READ_ONLY_SPACE_START\n");
193 lose("unknown space ID %ld addr 0x%lx\n", id, (long)addr);
199 load_core_file(char *file, os_vm_offset_t file_offset)
201 lispobj *header, val, len, *ptr, remaining_len;
202 int fd = open_binary(file, O_RDONLY);
205 lispobj initial_function = NIL;
206 FSHOW((stderr, "/entering load_core_file(%s)\n", file));
208 fprintf(stderr, "could not open file \"%s\"\n", file);
213 lseek(fd, file_offset, SEEK_SET);
214 header = calloc(os_vm_page_size / sizeof(u32), sizeof(u32));
216 count = read(fd, header, os_vm_page_size);
217 if (count < os_vm_page_size) {
218 lose("premature end of core file\n");
220 SHOW("successfully read first page of core");
225 if (val != CORE_MAGIC) {
226 lose("invalid magic number in core: 0x%lx should have been 0x%x.\n",
230 SHOW("found CORE_MAGIC");
232 while (val != END_CORE_ENTRY_TYPE_CODE) {
235 remaining_len = len - 2; /* (-2 to cancel the two ++ operations) */
236 FSHOW((stderr, "/val=0x%ld, remaining_len=0x%ld\n",
237 (long)val, (long)remaining_len));
241 case END_CORE_ENTRY_TYPE_CODE:
242 SHOW("END_CORE_ENTRY_TYPE_CODE case");
245 case VERSION_CORE_ENTRY_TYPE_CODE:
246 SHOW("VERSION_CORE_ENTRY_TYPE_CODE case");
247 if (*ptr != SBCL_CORE_VERSION_INTEGER) {
248 lose("core file version (%d) != runtime library version (%d)\n",
250 SBCL_CORE_VERSION_INTEGER);
254 case BUILD_ID_CORE_ENTRY_TYPE_CODE:
255 SHOW("BUILD_ID_CORE_ENTRY_TYPE_CODE case");
259 FSHOW((stderr, "build_id[]=\"%s\"\n", build_id));
260 FSHOW((stderr, "remaining_len = %d\n", remaining_len));
261 if (remaining_len != strlen((const char *)build_id))
262 goto losing_build_id;
263 for (i = 0; i < remaining_len; ++i) {
264 FSHOW((stderr, "ptr[%d] = char = %d, expected=%d\n",
265 i, ptr[i], build_id[i]));
266 if (ptr[i] != build_id[i])
267 goto losing_build_id;
271 /* .core files are not binary-compatible between
272 * builds because we can't easily detect whether the
273 * sources were patched between the time the
274 * dumping-the-.core runtime was built and the time
275 * that the loading-the-.core runtime was built.
277 * (We could easily detect whether version.lisp-expr
278 * was changed, but people experimenting with patches
279 * don't necessarily update version.lisp-expr.) */
281 lose("can't load .core for different runtime, sorry\n");
284 case NEW_DIRECTORY_CORE_ENTRY_TYPE_CODE:
285 SHOW("NEW_DIRECTORY_CORE_ENTRY_TYPE_CODE case");
286 process_directory(fd,
288 #ifndef LISP_FEATURE_ALPHA
289 remaining_len / (sizeof(struct ndir_entry) /
292 remaining_len / (sizeof(struct ndir_entry) /
298 case INITIAL_FUN_CORE_ENTRY_TYPE_CODE:
299 SHOW("INITIAL_FUN_CORE_ENTRY_TYPE_CODE case");
300 initial_function = (lispobj)*ptr;
303 #if defined(LISP_FEATURE_SB_THREAD) && defined(LISP_FEATURE_SB_LUTEX)
304 case LUTEX_TABLE_CORE_ENTRY_TYPE_CODE:
305 SHOW("LUTEX_TABLE_CORE_ENTRY_TYPE_CODE case");
307 size_t n_lutexes = *ptr;
308 size_t fdoffset = (*(ptr + 1) + 1) * (os_vm_page_size);
309 size_t data_length = n_lutexes * sizeof(struct sap *);
310 struct lutex **lutexes_to_resurrect = malloc(data_length);
313 lseek(fd, fdoffset + file_offset, SEEK_SET);
315 FSHOW((stderr, "attempting to read %ld lutexes from core\n", n_lutexes));
316 bytes_read = read(fd, lutexes_to_resurrect, data_length);
319 if (bytes_read != data_length) {
320 lose("Could not read the lutex table");
325 for (i=0; i<n_lutexes; ++i) {
326 struct lutex *lutex = lutexes_to_resurrect[i];
328 FSHOW((stderr, "re-init'ing lutex @ %p\n", lutex));
329 lutex_init((tagged_lutex_t) lutex);
332 free(lutexes_to_resurrect);
338 #ifdef LISP_FEATURE_GENCGC
339 case PAGE_TABLE_CORE_ENTRY_TYPE_CODE:
342 size_t fdoffset = (*(ptr+1) + 1) * (os_vm_page_size);
346 lseek(fd, fdoffset + file_offset, SEEK_SET);
347 while ((bytes_read = read(fd, data, (size < 4096 ? size : 4096 )))
353 bytes_read -= sizeof(long);
354 /* Ignore all zeroes. The size of the page table
355 * core entry was rounded up to os_vm_page_size
356 * during the save, and might now have more
357 * elements than the page table.
360 page_table[offset].first_object_offset = data[i];
367 gencgc_partial_pickup = 1;
372 lose("unknown core file entry: %ld\n", (long)val);
375 ptr += remaining_len;
376 FSHOW((stderr, "/new ptr=%lx\n", (unsigned long)ptr));
378 SHOW("about to free(header)");
380 SHOW("returning from load_core_file(..)");
381 return initial_function;