0.9.9.12:
[sbcl.git] / src / runtime / coreparse.c
index ffcce84..07b96ae 100644 (file)
@@ -2,7 +2,7 @@
  * A saved SBCL system is a .core file; the code here helps us accept
  * such a file as input.
  */
-  
+
 /*
  * This software is part of the SBCL system. See the README file for
  * more information.
  */
 
 #include <stdio.h>
-#include <sys/types.h>
+#include <stdlib.h>
+#include <string.h>
 #include <sys/file.h>
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <fcntl.h>
+#include <unistd.h>
 
 #ifdef irix
 #include <fcntl.h>
-#include <stdlib.h>
 #endif
 
+#include "sbcl.h"
 #include "os.h"
 #include "runtime.h"
 #include "globals.h"
 #include "core.h"
 #include "arch.h"
 #include "interr.h"
-#include "sbcl.h"
+#include "thread.h"
+
+#include "validate.h"
+#include "gc-internal.h"
+
+unsigned char build_id[] =
+#include "../../output/build-id.tmp"
+;
+
+int
+open_binary(char *filename, int mode)
+{
+#ifdef LISP_FEATURE_WIN32
+    mode |= O_BINARY;
+#endif
+
+    return open(filename, mode);
+}
+
+/* Search 'filename' for an embedded core.  An SBCL core has, at the
+ * end of the file, a trailer containing the size of the core (an
+ * os_vm_offset_t) and a final signature word (the lispobj
+ * CORE_MAGIC).  If this trailer is found at the end of the file, the
+ * start of the core can be determined from the core size.
+ *
+ * If an embedded core is present, this returns the offset into the
+ * file to load the core from, or -1 if no core is present. */
+os_vm_offset_t
+search_for_embedded_core(char *filename)
+{
+    lispobj header;
+    os_vm_offset_t lispobj_size = sizeof(lispobj);
+    os_vm_offset_t trailer_size = lispobj_size + sizeof(os_vm_offset_t);
+    os_vm_offset_t core_size, pos;
+    int fd = -1;
+
+    if ((fd = open_binary(filename, O_RDONLY)) < 0)
+        goto lose;
+    if (lseek(fd, -lispobj_size, SEEK_END) < 0)
+        goto lose;
+    if (read(fd, &header, (size_t)lispobj_size) < lispobj_size)
+        goto lose;
+
+    if (header == CORE_MAGIC) {
+        if (lseek(fd, -trailer_size, SEEK_END) < 0)
+            goto lose;
+        if (read(fd, &core_size, sizeof(os_vm_offset_t)) < 0)
+            goto lose;
+
+        if (lseek(fd, -(core_size + trailer_size), SEEK_END) < 0)
+            goto lose;
+        pos = lseek(fd, 0, SEEK_CUR);
+
+        if (read(fd, &header, (size_t)lispobj_size) < lispobj_size)
+            goto lose;
 
-static void process_directory(int fd, long *ptr, int count)
+        if (header != CORE_MAGIC)
+            goto lose;
+
+        close(fd);
+        return pos;
+    }
+
+lose:
+    if (fd != -1)
+        close(fd);
+
+    return -1;
+}
+
+static void
+process_directory(int fd, u32 *ptr, int count, os_vm_offset_t file_offset)
 {
     struct ndir_entry *entry;
 
-    FSHOW((stderr, "process_directory(..), count=%d\n", count));
-    
+    FSHOW((stderr, "/process_directory(..), count=%d\n", count));
+
     for (entry = (struct ndir_entry *) ptr; --count>= 0; ++entry) {
 
-       long id = entry->identifier;
-       long offset = os_vm_page_size * (1 + entry->data_page);
-       os_vm_address_t addr =
-           (os_vm_address_t) (os_vm_page_size * entry->address);
-       lispobj *free_pointer = (lispobj *) addr + entry->nwords;
-       long len = os_vm_page_size * entry->page_count;
-       
-       if (len != 0) {
-           os_vm_address_t real_addr;
-           FSHOW((stderr, "mapping %ld bytes at 0x%lx\n", len, addr));
-           real_addr = os_map(fd, offset, addr, len);
-           if (real_addr != addr) {
-               lose("file mapped in wrong place! "
-                    "(0x%08x != 0x%08lx)",
-                    real_addr,
-                    addr);
-           }
-       }
-
-       FSHOW((stderr, "space id = %d, free pointer = 0x%08x\n",
-              id, free_pointer));
-
-       switch (id) {
-       case DYNAMIC_SPACE_ID:
-#ifdef GENCGC    
-           if (addr != (os_vm_address_t)DYNAMIC_SPACE_START) {
-               fprintf(stderr, "in core: 0x%x - in runtime: 0x%x \n",
-                       addr, (os_vm_address_t)DYNAMIC_SPACE_START);
-               fprintf(stderr,"warning: core/runtime address mismatch: DYNAMIC_SPACE_START");
-           }
+        long id = entry->identifier;
+        long offset = os_vm_page_size * (1 + entry->data_page);
+        os_vm_address_t addr =
+            (os_vm_address_t) (os_vm_page_size * entry->address);
+        lispobj *free_pointer = (lispobj *) addr + entry->nwords;
+        long len = os_vm_page_size * entry->page_count;
+
+        if (len != 0) {
+            os_vm_address_t real_addr;
+            FSHOW((stderr, "/mapping %ld(0x%lx) bytes at 0x%lx\n",
+                   (long)len, (long)len, (unsigned long)addr));
+            real_addr = os_map(fd, offset + file_offset, addr, len);
+            if (real_addr != addr) {
+                lose("file mapped in wrong place! "
+                     "(0x%08x != 0x%08lx)\n",
+                     real_addr,
+                     addr);
+            }
+        }
+
+        FSHOW((stderr, "/space id = %ld, free pointer = 0x%lx\n",
+               id, (unsigned long)free_pointer));
+
+        switch (id) {
+        case DYNAMIC_CORE_SPACE_ID:
+#ifdef LISP_FEATURE_GENCGC
+            if (addr != (os_vm_address_t)DYNAMIC_SPACE_START) {
+                fprintf(stderr, "in core: 0x%lx; in runtime: 0x%lx \n",
+                        (long)addr, (long)DYNAMIC_SPACE_START);
+                lose("core/runtime address mismatch: DYNAMIC_SPACE_START\n");
+            }
 #else
-           if ((addr != (os_vm_address_t)DYNAMIC_0_SPACE_START) &&
-               (addr != (os_vm_address_t)DYNAMIC_1_SPACE_START)) {
-               fprintf(stderr, "in core: 0x%x - in runtime: 0x%x or 0x%x\n",
-                       addr, (os_vm_address_t)DYNAMIC_0_SPACE_START,
-                       (os_vm_address_t)DYNAMIC_1_SPACE_START);
-               fprintf(stderr,"warning: core/runtime address mismatch: DYNAMIC_SPACE_START");
-           }
+            if ((addr != (os_vm_address_t)DYNAMIC_0_SPACE_START) &&
+                (addr != (os_vm_address_t)DYNAMIC_1_SPACE_START)) {
+                fprintf(stderr, "in core: 0x%lx; in runtime: 0x%lx or 0x%lx\n",
+                        (long)addr,
+                        (long)DYNAMIC_0_SPACE_START,
+                        (long)DYNAMIC_1_SPACE_START);
+                lose("warning: core/runtime address mismatch: DYNAMIC_SPACE_START\n");
+            }
 #endif
-#if defined(ibmrt) || defined(__i386__)
-           SetSymbolValue(ALLOCATION_POINTER, (lispobj)free_pointer);
+#if defined(ALLOCATION_POINTER)
+            SetSymbolValue(ALLOCATION_POINTER, (lispobj)free_pointer,0);
 #else
-           dynamic_space_free_pointer = free_pointer;
+            dynamic_space_free_pointer = free_pointer;
 #endif
-           /* on the x86, this will always be space 0 */
-           current_dynamic_space = (lispobj *)addr;
-           break;
-       case STATIC_SPACE_ID:
-           if (addr != (os_vm_address_t)STATIC_SPACE_START) {
-               fprintf(stderr, "in core: 0x%p - in runtime: 0x%x\n",
-                       addr, (os_vm_address_t)STATIC_SPACE_START);
-               lose("core/runtime address mismatch: STATIC_SPACE_START");
-           }
-           break;
-       case READ_ONLY_SPACE_ID:
-           if (addr != (os_vm_address_t)READ_ONLY_SPACE_START) {
-               fprintf(stderr, "in core: 0x%x - in runtime: 0x%x\n",
-                       addr, (os_vm_address_t)READ_ONLY_SPACE_START);
-               lose("core/runtime address mismatch: READ_ONLY_SPACE_START");
-           }
-           break;
-       default:
-           lose("unknown space ID %ld addr 0x%p", id);
-       }
+            /* For stop-and-copy GC, this will be whatever the GC was
+             * using at the time. With GENCGC, this will always be
+             * space 0. (We checked above that for GENCGC,
+             * addr==DYNAMIC_SPACE_START.) */
+            current_dynamic_space = (lispobj *)addr;
+            break;
+        case STATIC_CORE_SPACE_ID:
+            if (addr != (os_vm_address_t)STATIC_SPACE_START) {
+                fprintf(stderr, "in core: 0x%lx - in runtime: 0x%lx\n",
+                        (long)addr, (long)STATIC_SPACE_START);
+                lose("core/runtime address mismatch: STATIC_SPACE_START\n");
+            }
+            break;
+        case READ_ONLY_CORE_SPACE_ID:
+            if (addr != (os_vm_address_t)READ_ONLY_SPACE_START) {
+                fprintf(stderr, "in core: 0x%lx - in runtime: 0x%lx\n",
+                        (long)addr, (long)READ_ONLY_SPACE_START);
+                lose("core/runtime address mismatch: READ_ONLY_SPACE_START\n");
+            }
+            break;
+        default:
+            lose("unknown space ID %ld addr 0x%lx\n", id, (long)addr);
+        }
     }
 }
 
-lispobj load_core_file(char *file)
+lispobj
+load_core_file(char *file, os_vm_offset_t file_offset)
 {
-    int fd = open(file, O_RDONLY), count;
-
-    /* KLUDGE: This kind of conditionalization everywhere that 32-bit
-     * ints are used is really nasty. It would be much nicer to define
-     * a typedef like addr_as_int once and for all in each
-     * architecture file, then use that everywhere. -- WHN 19990904 */
-#ifndef alpha
-    long *header,  val, len, *ptr;
-    long remaining_len;
-#else
-    u32 *header, val, len, *ptr;
-    u32 remaining_len;
-#endif
+    lispobj *header, val, len, *ptr, remaining_len;
+    int fd = open_binary(file, O_RDONLY), count;
 
     lispobj initial_function = NIL;
+    FSHOW((stderr, "/entering load_core_file(%s)\n", file));
     if (fd < 0) {
-       fprintf(stderr, "could not open file \"%s\"\n", file);
-       perror("open");
-       exit(1);
+        fprintf(stderr, "could not open file \"%s\"\n", file);
+        perror("open");
+        exit(1);
     }
 
-    header=calloc(os_vm_page_size / sizeof(u32),sizeof(u32));
+    lseek(fd, file_offset, SEEK_SET);
+    header = calloc(os_vm_page_size / sizeof(u32), sizeof(u32));
 
     count = read(fd, header, os_vm_page_size);
     if (count < os_vm_page_size) {
-       lose("premature end of core file");
+        lose("premature end of core file\n");
     }
+    SHOW("successfully read first page of core");
 
     ptr = header;
     val = *ptr++;
 
     if (val != CORE_MAGIC) {
-       lose("invalid magic number in core: 0x%lx should have been 0x%x.",
-            val,
-            CORE_MAGIC);
+        lose("invalid magic number in core: 0x%lx should have been 0x%x.\n",
+             val,
+             CORE_MAGIC);
     }
+    SHOW("found CORE_MAGIC");
+
+    while (val != END_CORE_ENTRY_TYPE_CODE) {
+        val = *ptr++;
+        len = *ptr++;
+        remaining_len = len - 2; /* (-2 to cancel the two ++ operations) */
+        FSHOW((stderr, "/val=0x%ld, remaining_len=0x%ld\n",
+               (long)val, (long)remaining_len));
+
+        switch (val) {
+
+        case END_CORE_ENTRY_TYPE_CODE:
+            SHOW("END_CORE_ENTRY_TYPE_CODE case");
+            break;
+
+        case VERSION_CORE_ENTRY_TYPE_CODE:
+            SHOW("VERSION_CORE_ENTRY_TYPE_CODE case");
+            if (*ptr != SBCL_CORE_VERSION_INTEGER) {
+                lose("core file version (%d) != runtime library version (%d)\n",
+                     *ptr,
+                     SBCL_CORE_VERSION_INTEGER);
+            }
+            break;
+
+        case BUILD_ID_CORE_ENTRY_TYPE_CODE:
+            SHOW("BUILD_ID_CORE_ENTRY_TYPE_CODE case");
+            {
+                int i;
 
-    while (val != CORE_END) {
-       val = *ptr++;
-       len = *ptr++;
-       remaining_len = len - 2; /* (-2 to cancel the two ++ operations) */
-
-       switch (val) {
-
-       case CORE_END:
-           break;
-
-       case CORE_VERSION:
-           if (*ptr != SBCL_CORE_VERSION_INTEGER) {
-               lose("core file version (%d) != runtime library version (%d)",
-                    *ptr,
-                    SBCL_CORE_VERSION_INTEGER);
-           }
-           break;
-
-       case CORE_NDIRECTORY:
-           process_directory(fd,
-                             ptr,
-#ifndef alpha
-                             remaining_len / (sizeof(struct ndir_entry) /
-                                              sizeof(long))
+                FSHOW((stderr, "build_id[]=\"%s\"\n", build_id));
+                FSHOW((stderr, "remaining_len = %d\n", remaining_len));
+                if (remaining_len != strlen((const char *)build_id))
+                    goto losing_build_id;
+                for (i = 0; i < remaining_len; ++i) {
+                    FSHOW((stderr, "ptr[%d] = char = %d, expected=%d\n",
+                           i, ptr[i], build_id[i]));
+                    if (ptr[i] != build_id[i])
+                        goto losing_build_id;
+                }
+                break;
+            losing_build_id:
+                /* .core files are not binary-compatible between
+                 * builds because we can't easily detect whether the
+                 * sources were patched between the time the
+                 * dumping-the-.core runtime was built and the time
+                 * that the loading-the-.core runtime was built.
+                 *
+                 * (We could easily detect whether version.lisp-expr
+                 * was changed, but people experimenting with patches
+                 * don't necessarily update version.lisp-expr.) */
+
+                lose("can't load .core for different runtime, sorry\n");
+            }
+
+        case NEW_DIRECTORY_CORE_ENTRY_TYPE_CODE:
+            SHOW("NEW_DIRECTORY_CORE_ENTRY_TYPE_CODE case");
+            process_directory(fd,
+                              ptr,
+#ifndef LISP_FEATURE_ALPHA
+                              remaining_len / (sizeof(struct ndir_entry) /
+                                               sizeof(long)),
 #else
-                             remaining_len / (sizeof(struct ndir_entry) /
-                                              sizeof(u32))
+                              remaining_len / (sizeof(struct ndir_entry) /
+                                               sizeof(u32)),
 #endif
-                             );
-           break;
+                              file_offset);
+            break;
 
-       case CORE_INITIAL_FUNCTION:
-           initial_function = (lispobj)*ptr;
-           break;
+        case INITIAL_FUN_CORE_ENTRY_TYPE_CODE:
+            SHOW("INITIAL_FUN_CORE_ENTRY_TYPE_CODE case");
+            initial_function = (lispobj)*ptr;
+            break;
 
-       default:
-           lose("unknown core file entry: %ld", val);
-       }
+#ifdef LISP_FEATURE_GENCGC
+        case PAGE_TABLE_CORE_ENTRY_TYPE_CODE:
+        {
+            size_t size = *ptr;
+            size_t fdoffset = (*(ptr+1) + 1) * (os_vm_page_size);
+            size_t offset = 0;
+            long bytes_read;
+            long data[4096];
+            lseek(fd, fdoffset + file_offset, SEEK_SET);
+            while ((bytes_read = read(fd, data, (size < 4096 ? size : 4096 )))
+                    > 0)
+            {
+                int i = 0;
+                size -= bytes_read;
+                while (bytes_read) {
+                    bytes_read -= sizeof(long);
+                    page_table[offset++].first_object_offset = data[i++];
+                }
+            }
 
-       ptr += remaining_len;
+            gencgc_partial_pickup = 1;
+            break;
+        }
+#endif
+        default:
+            lose("unknown core file entry: %ld\n", (long)val);
+        }
+
+        ptr += remaining_len;
+        FSHOW((stderr, "/new ptr=%lx\n", (unsigned long)ptr));
     }
+    SHOW("about to free(header)");
     free(header);
+    SHOW("returning from load_core_file(..)");
     return initial_function;
 }
+