X-Git-Url: http://repo.macrolet.net/gitweb/?a=blobdiff_plain;f=src%2Fcode%2Fsave.lisp;h=1e83ab3f18e6149dadcdcda7f802b5b9a9dd86be;hb=90a83478829f33b91f6300c183b374a968bc13c6;hp=76b7b95ef7f2205b9bcff340958d37902a4885f0;hpb=9c0fdf35270405ee8384d7f6a5a4b641d5df33c4;p=sbcl.git diff --git a/src/code/save.lisp b/src/code/save.lisp index 76b7b95..1e83ab3 100644 --- a/src/code/save.lisp +++ b/src/code/save.lisp @@ -17,87 +17,143 @@ ;;;; SAVE-LISP-AND-DIE itself -(sb!alien:define-alien-routine "save" (sb!alien:boolean) - (file sb!alien:c-string) - (initial-fun (sb!alien:unsigned #.sb!vm:n-word-bits))) - -;;; FIXME: When this is run without the PURIFY option, -;;; it seems to save memory all the way up to the high-water mark, -;;; not just what's currently used; and then after loading the -;;; image to make a running Lisp, the memory never gets reclaimed. -;;; (But with the PURIFY option it seems to work OK.) +(define-alien-routine "save" (boolean) + (file c-string) + (initial-fun (unsigned #.sb!vm:n-word-bits)) + (prepend-runtime int)) + +#!+gencgc +(define-alien-routine "gc_and_save" void + (file c-string) + (prepend-runtime int)) + +#!+gencgc +(defvar sb!vm::*restart-lisp-function*) + (defun save-lisp-and-die (core-file-name &key - (toplevel #'toplevel-init) - (purify t) - (root-structures ()) - (environment-name "auxiliary")) + (toplevel #'toplevel-init) + (purify #!+gencgc nil + #!-gencgc t) + (root-structures ()) + (environment-name "auxiliary") + (executable nil)) #!+sb-doc "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. - - 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. - * It will not work if multiple threads are in use. - * 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 purpose. - 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. - - The following &KEY arguments are defined: - :TOPLEVEL - 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 should not return. - :PURIFY - If true (the default), do a purifying GC which moves all dynamically - allocated objects into static space so that they stay pure. 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. - :ROOT-STRUCTURES - 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 - PURIFY function. - :ENVIRONMENT-NAME - This is also passed to the PURIFY function when :PURIFY is T. - (rarely used) - - 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. - *DEFAULT-PATHNAME-DEFAULTS* - This is reinitialized to reflect the working directory where the - saved core is loaded." +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. - (when (fboundp 'cancel-finalization) - (cancel-finalization sb!sys:*tty*)) +The following &KEY arguments are defined: + + :TOPLEVEL + 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 should + not return. + + :EXECUTABLE + 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. + + :PURIFY + 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. For platforms that use the generational garbage collector + (x86 and x86-64) purification generally results in a loss of + performance. + + :ROOT-STRUCTURES + 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 + PURIFY function. + + :ENVIRONMENT-NAME + This is also passed to the PURIFY function when :PURIFY is T. + (rarely used) + +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. + + *DEFAULT-PATHNAME-DEFAULTS* + This is reinitialized to reflect the working directory where the + saved core is loaded. + +Foreign objects loaded with SB-ALIEN:LOAD-SHARED-OBJECT are automatically +reloaded on startup, but references to foreign symbols do not survive intact +on all platforms: in this case a WARNING is signalled when saving the core. If +no warning is signalled, then the foreign symbol references will remain +intact. Platforms where this is currently the case are x86/FreeBSD, x86/Linux, +x86/NetBSD, sparc/Linux, sparc/SunOS, and ppc/Darwin. + +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 + purpose. +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." + (deinit) ;; 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 ;; SAVE-LISP-AND-DIE.) - (if purify - (purify :root-structures root-structures - :environment-name environment-name) - #!-gencgc (gc) #!+gencgc (gc :full t)) - ;; FIXME: Wouldn't it be more correct to go through this list backwards - ;; instead of forwards? - (dolist (f *before-save-initializations*) - (funcall f)) - (flet ((restart-lisp () - (handling-end-of-the-world - (reinit) - (dolist (f *after-save-initializations*) - (funcall f)) - (funcall toplevel)))) - ;; FIXME: Perhaps WITHOUT-GCING should be wrapped around the - ;; LET as well, to avoid the off chance of an interrupt triggering - ;; GC and making our saved RESTART-LISP address invalid? - (without-gcing - (save (unix-namestring core-file-name nil) - (get-lisp-obj-address #'restart-lisp))))) + (labels ((restart-lisp () + (handling-end-of-the-world + (reinit) + (funcall toplevel))) + (save-core (gc) + (when gc + #!-gencgc (gc) + ;; 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 (unix-namestring core-file-name nil) + (if executable 1 0))) + (without-gcing + (save (unix-namestring core-file-name nil) + (get-lisp-obj-address #'restart-lisp) + (if executable 1 0))))) + ;; Save the restart function into a static symbol, to allow GC-AND-SAVE + ;; access to it even after the GC has moved it. + #!+gencgc + (setf sb!vm::*restart-lisp-function* #'restart-lisp) + (cond (purify + (purify :root-structures root-structures + :environment-name environment-name) + (save-core nil)) + (t + ;; Compact the environment even though we're skipping the + ;; other purification stages. + (sb!kernel::compact-environment-aux "Auxiliary" 200) + (save-core t))))) + +(defun deinit () + (dolist (hook *save-hooks*) + (with-simple-restart (continue "Skip this save hook.") + (funcall hook))) + (when (rest (sb!thread:list-all-threads)) + (error "Cannot save core with multiple threads running.")) + #!-win32 + (when (fboundp 'cancel-finalization) + (cancel-finalization sb!sys:*tty*)) + (float-deinit) + (profile-deinit) + (debug-deinit) + (foreign-deinit))