/[cmucl]/src/code/save.lisp
ViewVC logotype

Contents of /src/code/save.lisp

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.33 - (show annotations)
Tue Dec 30 16:39:23 1997 UTC (16 years, 3 months ago) by dtc
Branch: MAIN
Changes since 1.32: +2 -1 lines
Ensure that multi-processing is shutdown before saving a lisp core.
1 ;;; -*- Mode: Lisp; Package: Lisp; Log: code.log -*-
2 ;;;
3 ;;; **********************************************************************
4 ;;; This code was written as part of the CMU Common Lisp project at
5 ;;; Carnegie Mellon University, and has been placed in the public domain.
6 ;;;
7 (ext:file-comment
8 "$Header: /tiger/var/lib/cvsroots/cmucl/src/code/save.lisp,v 1.33 1997/12/30 16:39:23 dtc Exp $")
9 ;;;
10 ;;; **********************************************************************
11 ;;;
12 ;;; Dump the current lisp image into a core file. All the real work is done
13 ;;; be C. Also contains various high-level initialization stuff: loading init
14 ;;; files and parsing environment variables.
15 ;;;
16 ;;; Written by William Lott.
17 ;;;
18 ;;;
19 (in-package "LISP")
20
21 (in-package "EXTENSIONS")
22 (export '(print-herald *herald-items* save-lisp *before-save-initializations*
23 *after-save-initializations* *environment-list* *editor-lisp-p*))
24 (in-package "LISP")
25
26 (defvar *before-save-initializations* nil
27 "This is a list of functions which are called before creating a saved core
28 image. These functions are executed in the child process which has no ports,
29 so they cannot do anything that tries to talk to the outside world.")
30
31 (defvar *after-save-initializations* nil
32 "This is a list of functions which are called when a saved core image starts
33 up. The system itself should be initialized at this point, but applications
34 might not be.")
35
36 (defvar *environment-list* nil
37 "An alist mapping environment variables (as keywords) to either values")
38
39 (defvar *editor-lisp-p* nil
40 "This is true if and only if the lisp was started with the -edit switch.")
41
42
43
44 ;;; Filled in by the startup code.
45 (defvar lisp-environment-list)
46
47
48 ;;; PARSE-UNIX-SEARCH-LIST -- Internal
49 ;;;
50 ;;; Returns a list of the directories that are in the specified Unix
51 ;;; environment variable. Return NIL if the variable is undefined.
52 ;;;
53 (defun parse-unix-search-list (var)
54 (let ((path (cdr (assoc var ext::*environment-list*))))
55 (when path
56 (do* ((i 0 (1+ p))
57 (p (position #\: path :start i)
58 (position #\: path :start i))
59 (pl ()))
60 ((null p)
61 (let ((s (subseq path i)))
62 (if (string= s "")
63 (push "default:" pl)
64 (push (concatenate 'simple-string s "/") pl)))
65 (nreverse pl))
66 (let ((s (subseq path i p)))
67 (if (string= s "")
68 (push "default:" pl)
69 (push (concatenate 'simple-string s "/") pl)))))))
70
71
72 ;;; ENVIRONMENT-INIT -- Internal
73 ;;;
74 ;;; Parse the LISP-ENVIRONMENT-LIST into a keyword alist. Set up default
75 ;;; search lists.
76 ;;;
77 (defun environment-init ()
78 (setq *environment-list* ())
79 (dolist (ele lisp-environment-list)
80 (let ((=pos (position #\= (the simple-string ele))))
81 (when =pos
82 (push (cons (intern (string-upcase (subseq ele 0 =pos))
83 *keyword-package*)
84 (subseq ele (1+ =pos)))
85 *environment-list*))))
86 (setf (search-list "default:") (list (default-directory)))
87 (setf (search-list "path:") (parse-unix-search-list :path))
88 (setf (search-list "home:")
89 (or (parse-unix-search-list :home)
90 (list (default-directory))))
91
92 (setf (search-list "library:")
93 (or (parse-unix-search-list :cmucllib)
94 '(#+mach "/usr/misc/.cmucl/lib/"
95 #+linux "/usr/lib/cmucl/"
96 #-(or mach linux) "/usr/local/lib/cmucl/lib/"))))
97
98
99
100 ;;;; SAVE-LISP itself.
101
102 (alien:def-alien-routine "save" (alien:boolean)
103 (file c-call:c-string)
104 (initial-function (alien:unsigned #.vm:word-bits)))
105
106 (defun save-lisp (core-file-name &key
107 (purify t)
108 (root-structures ())
109 (environment-name "Auxiliary")
110 (init-function #'%top-level)
111 (load-init-file t)
112 (site-init "library:site-init")
113 (print-herald t)
114 (process-command-line t))
115 "Saves a CMU Common Lisp core image in the file of the specified name. The
116 following keywords are defined:
117
118 :purify
119 If true (the default), do a purifying GC which moves all dynamically
120 allocated objects into static space so that they stay pure. This takes
121 somewhat longer than the normal GC which is otherwise done, but GC's will
122 done less often and take less time in the resulting core file. See
123 EXT:PURIFY.
124
125 :root-structures
126 This should be a list of the main entry points in any newly loaded
127 systems. This need not be supplied, but locality and/or GC performance
128 will be better if they are. Meaningless if :purify is NIL. See EXT:PURIFY.
129
130 :environment-name
131 Also passed to EXT:PURIFY when :PURIFY is T. Rarely used.
132
133 :init-function
134 This is the function that starts running when the created core file is
135 resumed. The default function simply invokes the top level
136 read-eval-print loop. If the function returns the lisp will exit.
137
138 :load-init-file
139 If true, then look for an init.lisp or init.fasl file when the core
140 file is resumed.
141
142 :site-init
143 If true, then the name of the site init file to load. The default is
144 library:site-init. No error if this does not exist.
145
146 :print-herald
147 If true (the default), print out the lisp system herald when starting."
148
149 #+mp (mp::shutdown-multi-processing)
150 (when (fboundp 'eval:flush-interpreted-function-cache)
151 (eval:flush-interpreted-function-cache))
152 (when (fboundp 'cancel-finalization)
153 (cancel-finalization sys:*tty*))
154 (if purify
155 (purify :root-structures root-structures
156 :environment-name environment-name)
157 #-gencgc (gc) #+gencgc (gc :full t))
158 (dolist (f *before-save-initializations*) (funcall f))
159 (flet
160 ((restart-lisp ()
161 (unix:unix-exit
162 (catch '%end-of-the-world
163 (with-simple-restart (abort "Skip remaining initializations.")
164 (catch 'top-level-catcher
165 (reinit)
166 (dolist (f *after-save-initializations*) (funcall f))
167 (environment-init)
168 (when process-command-line
169 (ext::process-command-strings))
170 (setf *editor-lisp-p* nil)
171 (macrolet ((find-switch (name)
172 `(find ,name *command-line-switches*
173 :key #'cmd-switch-name
174 :test #'(lambda (x y)
175 (declare (simple-string x y))
176 (string-equal x y)))))
177 (when site-init
178 (load site-init :if-does-not-exist nil :verbose nil))
179 (when (and process-command-line (find-switch "edit"))
180 (setf *editor-lisp-p* t))
181 (when (and load-init-file
182 (not (and process-command-line
183 (find-switch "noinit"))))
184 (let* ((cl-switch (find-switch "init"))
185 (name (and cl-switch
186 (or (cmd-switch-value cl-switch)
187 (car (cmd-switch-words
188 cl-switch))))))
189 (if name
190 (load (merge-pathnames name #p"home:")
191 :if-does-not-exist nil)
192 (or (load "home:init" :if-does-not-exist nil)
193 (load "home:.cmucl-init"
194 :if-does-not-exist nil))))))
195 (when process-command-line
196 (ext::invoke-switch-demons *command-line-switches*
197 *command-switch-demons*))
198 (when print-herald
199 (print-herald))))
200 (funcall (if (and *batch-mode* (eq init-function #'%top-level))
201 #'%handled-top-level
202 init-function))))))
203
204 (let ((initial-function (get-lisp-obj-address #'restart-lisp)))
205 (without-gcing
206 (save (unix-namestring core-file-name nil) initial-function))))
207 nil)
208
209
210
211 ;;;; PRINT-HERALD support.
212
213 (defvar *herald-items* ()
214 "Determines what PRINT-HERALD prints (the system startup banner.) This is a
215 database which can be augmented by each loaded system. The format is a
216 property list which maps from subsystem names to the banner information for
217 that system. This list can be manipulated with GETF -- entries are printed
218 in, reverse order, so the newest entry is printed last. Usually the system
219 feature keyword is used as the system name. A given banner is a list of
220 strings and functions (or function names). Strings are printed, and
221 functions are called with an output stream argument.")
222
223 (setf (getf *herald-items* :common-lisp)
224 `("CMU Common Lisp "
225 ,#'(lambda (stream)
226 (write-string (lisp-implementation-version) stream))
227 ", running on "
228 ,#'(lambda (stream) (write-string (machine-instance) stream))))
229
230 (setf (getf *herald-items* :bugs)
231 '("Send bug reports and questions to cmucl-bugs@cs.cmu.edu."
232 terpri
233 "Loaded subsystems:"))
234
235 ;;; PRINT-HERALD -- Public
236 ;;;
237 (defun print-herald (&optional (stream *standard-output*))
238 "Print some descriptive information about the Lisp system version and
239 configuration."
240 (let ((res ()))
241 (do ((item *herald-items* (cddr item)))
242 ((null item))
243 (push (second item) res))
244
245 (fresh-line stream)
246 (dolist (item res)
247 (dolist (thing item)
248 (typecase thing
249 (string
250 (write-string thing stream))
251 (function (funcall thing stream))
252 ((or symbol cons)
253 (funcall (fdefinition thing) stream))
254 (t
255 (error "Unrecognized *HERALD-ITEMS* entry: ~S." thing))))
256 (fresh-line stream)))
257
258 (values))
259
260
261 ;;;; Random functions used by worldload.
262
263 (defun assert-user-package ()
264 (unless (eq *package* (find-package "USER"))
265 (error "Change *PACKAGE* to the USER package and try again.")))
266
267 ;;; MAYBE-BYTE-LOAD -- Interface
268 ;;;
269 ;;; If Name has been byte-compiled, and :runtime is a feature, then load the
270 ;;; byte-compiled version, otherwise just do normal load.
271 ;;;
272 (defun maybe-byte-load (name &optional (load-native t))
273 (let ((bname (make-pathname
274 :defaults name
275 :type #.(c:backend-byte-fasl-file-type c:*target-backend*))))
276 (cond ((and (featurep :runtime)
277 (probe-file bname))
278 (load bname))
279 (load-native
280 (load name)))))
281
282
283 ;;; BYTE-LOAD-OVER -- Interface
284 ;;;
285 ;;; Replace a cold-loaded native object file with a byte-compiled one, if it
286 ;;; exists.
287 ;;;
288 (defun byte-load-over (name)
289 (load (make-pathname
290 :defaults name
291 :type #.(c:backend-byte-fasl-file-type c:*target-backend*))
292 :if-does-not-exist nil))

  ViewVC Help
Powered by ViewVC 1.1.5