;;;; Dump the current Lisp image into a core file. Also contains
;;;; various high-level initialization stuff: loading init files and
;;;; parsing environment variables.
;;;; (All the real work is done by C.)
;;;; This software is part of the SBCL system. See the README file for
;;;; more information.
;;;; This software is derived from the CMU CL system, which was
;;;; written at Carnegie Mellon University and released into the
;;;; public domain. The software is in the public domain and is
;;;; provided with absolutely no warranty. See the COPYING and CREDITS
;;;; files for more information.
;;;; SAVE-LISP-AND-DIE itself
(define-alien-routine "save" (boolean)
(initial-fun (unsigned #.sb!vm:n-word-bits))
(define-alien-routine "gc_and_save" void
(defun save-lisp-and-die (core-file-name &key
"Save a \"core image\", i.e. enough information to restart a Lisp
process later in the same state, in the file of the specified name.
Only global state is preserved: the stack is unwound in the process.
The following &KEY arguments are defined:
The function to run when the created core file is resumed. The
default function handles command line toplevel option processing
and runs the top level read-eval-print loop. This function returning
is equivalent to (SB-EXT:EXIT :CODE 0) being called.
TOPLEVEL functions should always provide an ABORT restart: otherwise
code they call will run without one.
If true, arrange to combine the SBCL runtime and the core image
to create a standalone executable. If false (the default), the
core image will not be executable on its own. Executable images
always behave as if they were passed the --noinform runtime option.
If true, values of runtime options --dynamic-space-size and
--control-stack-size that were used to start SBCL are stored in
the standalone executable, and restored when the executable is
run. This also inhibits normal runtime option processing, causing
all command line arguments to be passed to the toplevel.
Meaningless if :EXECUTABLE is NIL.
If true (the default on cheneygc), do a purifying GC which moves all
dynamically allocated objects into static space. This takes
somewhat longer than the normal GC which is otherwise done, but
it's only done once, and subsequent GC's will be done less often
and will take less time in the resulting core file. See the PURIFY
function. This parameter has no effect on platforms using the
generational garbage collector.
This should be a list of the main entry points in any newly loaded
systems. This need not be supplied, but locality and/or GC performance
may be better if they are. Meaningless if :PURIFY is NIL. See the
This is also passed to the PURIFY function when :PURIFY is T.
This is only meaningful if the runtime was built with the :SB-CORE-COMPRESSION
feature enabled. If NIL (the default), saves to uncompressed core files. If
:SB-CORE-COMPRESSION was enabled at build-time, the argument may also be
an integer from -1 to 9, corresponding to zlib compression levels, or T
(which is equivalent to the default compression level, -1).
The save/load process changes the values of some global variables:
*STANDARD-OUTPUT*, *DEBUG-IO*, etc.
Everything related to open streams is necessarily changed, since
the OS won't let us preserve a stream across save and load.
This is reinitialized to reflect the working directory where the
saved core is loaded.
SAVE-LISP-AND-DIE interacts with SB-ALIEN:LOAD-SHARED-OBJECT: see its
documentation for details.
On threaded platforms only a single thread may remain running after
SB-EXT:*SAVE-HOOKS* have run. Applications using multiple threads can
be SAVE-LISP-AND-DIE friendly by registering a save-hook that quits
any additional threads, and an init-hook that restarts them.
This implementation is not as polished and painless as you might like:
* It corrupts the current Lisp image enough that the current process
needs to be killed afterwards. This can be worked around by forking
another process that saves the core.
* There is absolutely no binary compatibility of core images between
different runtime support programs. Even runtimes built from the same
sources at different times are treated as incompatible for this
This isn't because we like it this way, but just because there don't
seem to be good quick fixes for either limitation and no one has been
sufficiently motivated to do lengthy fixes."
(declare (ignore purify root-structures environment-name))
(check-type compression (or boolean (integer -1 9)))
(error "Unable to save compressed core: this runtime was not built with zlib support"))
(when (eql t compression)
(setf compression -1))
;; FIXME: Would it be possible to unmix the PURIFY logic from this
;; function, and just do a GC :FULL T here? (Then if the user wanted
;; a PURIFYed image, he'd just run PURIFY immediately before calling
(labels ((restart-lisp ()
#!+hpux (sb!sys:%primitive sb!vm::setup-return-from-lisp-stub)
(if value 1 0))
(let ((name (native-namestring
;; Do a destructive non-conservative GC, and then save a core.
;; A normal GC will leave huge amounts of storage unreclaimed
;; (over 50% on x86). This needs to be done by a single function
;; since the GC will invalidate the stack.
#!+gencgc (gc-and-save name
(or compression 0)))
(or compression 0))))))
;; Save the restart function into a static symbol, to allow GC-AND-SAVE
;; access to it even after the GC has moved it.
(setf sb!vm::*restart-lisp-function* #'restart-lisp)
(purify :root-structures root-structures
;; Compact the environment even though we're skipping the
;; other purification stages.
(sb!kernel::compact-environment-aux "Auxiliary" 200)
;; Something went very wrong -- reinitialize to have a prayer
;; of being able to report the error.
(error "Could not save core.")))
(defun deinit ()
(call-hooks "save" *save-hooks*)
(when (rest (sb!thread:list-all-threads))
(error "Cannot save core with multiple threads running."))