source: trunk/source/lib/dumplisp.lisp @ 11301

Last change on this file since 11301 was 11301, checked in by gb, 11 years ago

Since we documented the :TOPLEVEL-FUNCTION option to SAVE-APPLICATION,
might as well make it actually do something (without requiring that
the user know how to do low-level lisp initialization.)

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 11.0 KB
Line 
1;;;-*-Mode: LISP; Package: CCL -*-
2;;;
3;;;   Copyright (C) 1994-2001 Digitool, Inc
4;;;   This file is part of OpenMCL. 
5;;;
6;;;   OpenMCL is licensed under the terms of the Lisp Lesser GNU Public
7;;;   License , known as the LLGPL and distributed with OpenMCL as the
8;;;   file "LICENSE".  The LLGPL consists of a preamble and the LGPL,
9;;;   which is distributed with OpenMCL as the file "LGPL".  Where these
10;;;   conflict, the preamble takes precedence. 
11;;;
12;;;   OpenMCL is referenced in the preamble as the "LIBRARY."
13;;;
14;;;   The LLGPL is also available online at
15;;;   http://opensource.franz.com/preamble.html
16
17; Dumplisp.lisp
18
19(in-package "CCL")
20
21(defvar *save-exit-functions* nil 
22  "List of (0-arg)functions to call before saving memory image")
23
24(defvar *restore-lisp-functions* nil
25  "List of (0-arg)functions to call after restoring saved image")
26
27
28(declaim (special *lisp-system-pointer-functions*)) ; defined in l1-init.
29
30(defun kill-lisp-pointers ()
31  (setq * nil ** nil *** nil + nil ++ nil +++ nil - nil
32        / nil // nil /// nil
33         @ nil)
34  (clear-open-file-streams)
35  (setf (*%saved-method-var%*) nil)
36  (setq *%periodic-tasks%* nil)
37  (setq *event-dispatch-task* nil)
38  (setq *interactive-abort-process* nil)
39  )
40
41(defun clear-ioblock-streams ()
42  (%map-areas (lambda (o)
43                  (if (typep o 'basic-stream)
44                    (let ((s (basic-stream.state o)))
45                      (when (and (typep s 'ioblock)
46                                 (ioblock-device s)
47                                 (>= (ioblock-device s) 0))
48                        (setf (basic-stream.state o) nil)))
49                    ;; Have to be careful with use of TYPEP here (and
50                    ;; in the little bit of Lisp code that runs before
51                    ;; the image is saved.)  We may have just done
52                    ;; things to forget about (per-session) foreign
53                    ;; class addresses, and calling TYPEP on a pointer
54                    ;; to such a class might cause us to remember
55                    ;; those per-session addresses and confuse the
56                    ;; startup code.
57                    (if (and (eql (typecode o) target::subtag-instance)
58                             (typep o 'buffered-stream-mixin))
59                      (let ((s (slot-value o 'ioblock)))
60                        (when (and (typep s 'ioblock)
61                                   (ioblock-device s)
62                                   (>= (ioblock-device s) 0))
63                          (setf (slot-value o 'ioblock) nil))))))))
64
65(defun save-application (filename
66                         &rest rest
67                         &key toplevel-function
68                         init-file
69                         error-handler application-class
70                         clear-clos-caches
71                         (purify t)
72                         impurify
73                         (mode #o644)
74                         prepend-kernel
75                         )
76  (declare (ignore toplevel-function error-handler application-class
77                   clear-clos-caches init-file impurify
78                   mode prepend-kernel))
79  (unless (probe-file (make-pathname :defaults nil
80                                     :directory (pathname-directory (translate-logical-pathname filename))))
81    (error "Directory containing ~s does not exist." filename))
82  (let* ((kind (%unix-file-kind (native-translated-namestring filename))))
83    (when (and kind (not (eq kind :file )))
84      (error "~S is not a regular file." filename)))
85  (let* ((ip *initial-process*)
86         (cp *current-process*))
87    (when (process-verify-quit ip)
88      (process-interrupt ip
89                         #'(lambda ()
90                             (process-exit-application
91                              *current-process*
92                              #'(lambda ()
93                                  (apply #'%save-application-internal
94                                         filename
95                                         :purify purify
96                                         rest)))))
97      (unless (eq cp ip)
98        (process-kill cp)))))
99
100(defun %save-application-internal (filename &key
101                                            toplevel-function  ;????
102                                            error-handler ; meaningless unless application-class or *application* not lisp-development..
103                                            application-class
104                                            (mode #o644)
105                                            (purify t)
106                                            (impurify nil)
107                                            (init-file nil init-file-p)
108                                            (clear-clos-caches t)
109                                            (prepend-kernel nil))
110  (when (and application-class (neq  (class-of *application*)
111                                     (if (symbolp application-class)
112                                       (find-class application-class)
113                                       application-class)))
114    (setq *application* (make-instance application-class)))
115  (if (not toplevel-function)
116    (setq toplevel-function 
117          #'(lambda ()
118              (toplevel-function *application*
119                                 (if init-file-p
120                                   init-file
121                                   (application-init-file *application*)))))
122        (let* ((user-toplevel-function (coerce-to-function toplevel-function)))
123      (setq toplevel-function
124            (lambda ()
125              (restore-lisp-pointers)
126              ;; Shouldn't be necessary post 1.2
127              ;;(initialize-interactive-streams)
128              (process-run-function "toplevel" (lambda ()
129                                                 (funcall user-toplevel-function)
130                                                 (quit)))
131              (%set-toplevel #'housekeeping-loop)
132              (toplevel)))))
133  (when error-handler
134    (make-application-error-handler *application* error-handler))
135 
136  (if clear-clos-caches (clear-clos-caches))
137  (save-image (let ((fd (open-dumplisp-file filename
138                                            :mode mode
139                                            :prepend-kernel prepend-kernel)))
140                #'(lambda () (%save-application fd
141                                                (logior (if impurify 2 0)
142                                                        (if purify 1 0)))))
143              toplevel-function))
144
145(defun save-image (save-function toplevel-function)
146  (let ((toplevel #'(lambda () (#_exit -1))))
147      (%set-toplevel #'(lambda ()
148                         (setf (interrupt-level) -1)
149                         (%set-toplevel toplevel)       ; in case *save-exit-functions* error
150                         (dolist (f *save-exit-functions*)
151                           (funcall f))
152                         (kill-lisp-pointers)
153                         (clear-ioblock-streams)
154                         (with-deferred-gc
155                             (let* ((pop *termination-population*))
156                               (with-lock-grabbed (*termination-population-lock*)
157                                 (setf (population.data pop) nil
158                                       (population.termination-list pop) nil))))
159                         (%set-toplevel
160                          #'(lambda ()
161                              (%set-toplevel #'(lambda ()
162                                                 (setf (interrupt-level) 0)
163                                                 (funcall toplevel-function)))
164                              (restore-lisp-pointers)))   ; do startup stuff
165                         (funcall save-function)))
166      (toplevel)))
167
168;;; If file in-fd contains an embedded lisp image, return the file position
169;;; of the start of that image; otherwise, return the file's length.
170(defun skip-embedded-image (in-fd)
171  (let* ((len (fd-lseek in-fd 0 #$SEEK_END)))
172    (if (< len 0)
173      (%errno-disp len)
174      (%stack-block ((trailer 16))
175        (let* ((trailer-pos (fd-lseek in-fd -16 #$SEEK_CUR)))
176          (if (< trailer-pos 0)
177            len
178            (if (not (= 16 (the fixnum (fd-read in-fd trailer 16))))
179              len
180              (if (not (dotimes (i 12 t)
181                         (unless (eql (char-code (schar "OpenMCLImage" i))
182                                      (%get-unsigned-byte trailer i))
183                           (return nil))))
184                len
185                (let* ((header-pos (fd-lseek in-fd
186                                             (%get-signed-long
187                                              trailer
188                                              12)
189                                             #$SEEK_CUR)))
190                  (if (< header-pos 0)
191                    len
192                    header-pos))))))))))
193                 
194 
195(defun %prepend-file (out-fd in-fd len)
196  (declare (fixnum out-fd in-fd len))
197  (fd-lseek in-fd 0 #$SEEK_SET)
198  (let* ((bufsize (ash 1 15)))
199    (%stack-block ((buf bufsize))
200      (loop
201          (when (zerop len) (return))
202          (let* ((nread (fd-read in-fd buf (min len bufsize))))
203            (declare (fixnum nread))
204            (if (< nread 0)
205              (%errno-disp nread))
206            (let* ((nwritten (fd-write out-fd buf nread)))
207              (declare (fixnum nwritten))
208              (unless (= nwritten nread)
209                (error "I/O error writing to fd ~d" out-fd)))
210            (decf len nread))))))
211   
212(defun open-dumplisp-file (path &key (mode #o666) prepend-kernel)
213  (let* ((prepend-fd (if prepend-kernel (fd-open
214                                         (if (eq prepend-kernel t)
215                                           (car *command-line-argument-list*)
216                                           (native-translated-namestring
217                                            (pathname prepend-kernel)))
218                                         #$O_RDONLY)))
219         (prepend-len (if (and prepend-fd (>= prepend-fd 0))
220                        (skip-embedded-image prepend-fd)))
221         (filename (native-translated-namestring path)))
222    (when (probe-file filename)
223      (%delete-file filename))
224    (when prepend-fd
225      (setq mode (logior #o111 mode)))
226    (let* ((image-fd (fd-open filename (logior #$O_WRONLY #$O_CREAT) mode)))
227      (unless (>= image-fd 0) (signal-file-error image-fd filename))
228      (fd-chmod image-fd mode)
229      (when prepend-fd
230        (%prepend-file image-fd prepend-fd prepend-len))
231      image-fd)))
232
233
234(defun %save-application (fd &optional (flags 1))
235  (let* ((err (%%save-application flags fd)))
236    (unless (eql err 0)
237      (%err-disp err))))
238 
239
240(defun restore-lisp-pointers ()
241  (setq *interactive-streams-initialized* nil)
242  (%revive-system-locks)
243  (refresh-external-entrypoints)
244  (restore-pascal-functions)
245  (initialize-interactive-streams)
246  (let ((system-ptr-fns (reverse *lisp-system-pointer-functions*))
247        (restore-lisp-fns *restore-lisp-functions*)
248        (user-pointer-fns *lisp-user-pointer-functions*)
249        (lisp-startup-fns *lisp-startup-functions*))
250    (unwind-protect
251      (with-simple-restart (abort "Abort (possibly crucial) startup functions.")
252        (let ((call-with-restart
253               #'(lambda (f)
254                   (with-simple-restart 
255                     (continue "Skip (possibly crucial) startup function ~s."
256                               (if (symbolp f) f (function-name f)))
257                     (funcall f)))))
258          (dolist (f system-ptr-fns) (funcall call-with-restart f))
259          (dolist (f restore-lisp-fns) (funcall call-with-restart f))
260          (dolist (f (reverse user-pointer-fns)) (funcall call-with-restart f))
261          (dolist (f (reverse lisp-startup-fns)) (funcall call-with-restart f))))
262      (setf (interrupt-level) 0)))
263  nil)
264
265
266(defun restore-pascal-functions ()
267  (reset-callback-storage)
268  (when (simple-vector-p %pascal-functions%)
269    (dotimes (i (length %pascal-functions%))
270      (let ((pfe (%svref %pascal-functions% i)))
271        (when (vectorp pfe)
272          (let* ((name (pfe.sym pfe))
273                 (descriptor (pfe.routine-descriptor pfe)))
274            (%revive-macptr descriptor)
275            (%setf-macptr descriptor (make-callback-trampoline i (pfe.proc-info pfe)))
276            (when name
277              (set name descriptor))))))))
278
Note: See TracBrowser for help on using the repository browser.