image.lisp 16 KB
Newer Older
1
2
3
;;;; -------------------------------------------------------------------------
;;;; Starting, Stopping, Dumping a Lisp image

4
5
6
7
(uiop/package:define-package :uiop/image
  (:nicknames :asdf/image)
  (:recycle :uiop/image :asdf/image :xcvb-driver)
  (:use :uiop/common-lisp :uiop/package :uiop/utility :uiop/pathname :uiop/stream :uiop/os)
8
  (:export
9
   #:*image-dumped-p* #:raw-command-line-arguments #:*command-line-arguments*
10
   #:command-line-arguments #:raw-command-line-arguments #:setup-command-line-arguments
11
   #:*lisp-interaction*
12
   #:*fatal-conditions* #:fatal-condition-p #:handle-fatal-condition
13
14
15
   #:call-with-fatal-condition-handler #:with-fatal-condition-handler
   #:*image-restore-hook* #:*image-prelude* #:*image-entry-point*
   #:*image-postlude* #:*image-dump-hook*
16
   #:quit #:die #:raw-print-backtrace #:print-backtrace #:print-condition-backtrace
17
18
19
   #:shell-boolean-exit
   #:register-image-restore-hook #:register-image-dump-hook
   #:call-image-restore-hook #:call-image-dump-hook
20
   #:restore-image #:dump-image #:create-image
21
))
22
(in-package :uiop/image)
23

24
25
26
(with-upgradability ()
  (defvar *lisp-interaction* t
    "Is this an interactive Lisp environment, or is it batch processing?")
27

28
29
  (defvar *command-line-arguments* nil
    "Command-line arguments")
30

31
32
  (defvar *image-dumped-p* nil ; may matter as to how to get to command-line-arguments
    "Is this a dumped image? As a standalone executable?")
33

34
35
  (defvar *image-restore-hook* nil
    "Functions to call (in reverse order) when the image is restored")
36

37
38
39
  (defvar *image-restored-p* nil
    "Has the image been restored? A boolean, or :in-progress while restoring, :in-regress while dumping")

40
41
  (defvar *image-prelude* nil
    "a form to evaluate, or string containing forms to read and evaluate
42
43
when the image is restarted, but before the entry point is called.")

44
45
  (defvar *image-entry-point* nil
    "a function with which to restart the dumped image when execution is restored from it.")
46

47
48
  (defvar *image-postlude* nil
    "a form to evaluate, or string containing forms to read and evaluate
49
before the image dump hooks are called and before the image is dumped.")
50

51
52
  (defvar *image-dump-hook* nil
    "Functions to call (in order) when before an image is dumped")
53

54
55
56
  (defvar *fatal-conditions* '(error)
    "conditions that cause the Lisp image to enter the debugger if interactive,
or to die if not interactive"))
57
58
59


;;; Exiting properly or im-
60
61
62
(with-upgradability ()
  (defun quit (&optional (code 0) (finish-output t))
    "Quits from the Lisp world, with the given exit status if provided.
63
This is designed to abstract away the implementation specific quit forms."
64
65
66
67
68
69
70
71
72
    (when finish-output ;; essential, for ClozureCL, and for standard compliance.
      (finish-outputs))
    #+(or abcl xcl) (ext:quit :status code)
    #+allegro (excl:exit code :quiet t)
    #+clisp (ext:quit code)
    #+clozure (ccl:quit code)
    #+cormanlisp (win32:exitprocess code)
    #+(or cmu scl) (unix:unix-exit code)
    #+ecl (si:quit code)
73
    #+gcl (#+gcl2.6 lisp:quit #-gcl2.6 system:quit code)
74
75
    #+genera (error "You probably don't want to Halt the Machine. (code: ~S)" code)
    #+lispworks (lispworks:quit :status code :confirm nil :return nil :ignore-errors-p t)
76
    #+mcl (progn code (ccl:quit)) ;; or should we use FFI to call libc's exit(3) ?
77
78
79
80
81
82
83
84
85
86
87
88
89
    #+mkcl (mk-ext:quit :exit-code code)
    #+sbcl #.(let ((exit (find-symbol* :exit :sb-ext nil))
                   (quit (find-symbol* :quit :sb-ext nil)))
               (cond
                 (exit `(,exit :code code :abort (not finish-output)))
                 (quit `(,quit :unix-status code :recklessly-p (not finish-output)))))
    #-(or abcl allegro clisp clozure cmu ecl gcl genera lispworks mcl mkcl sbcl scl xcl)
    (error "~S called with exit code ~S but there's no quitting on this implementation" 'quit code))

  (defun die (code format &rest arguments)
    "Die in error with some error message"
    (with-safe-io-syntax ()
      (ignore-errors
90
       (format! *stderr* "~&~?~&" format arguments)))
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
    (quit code))

  (defun raw-print-backtrace (&key (stream *debug-io*) count)
    "Print a backtrace, directly accessing the implementation"
    (declare (ignorable stream count))
    #+abcl
    (let ((*debug-io* stream)) (top-level::backtrace-command count))
    #+allegro
    (let ((*terminal-io* stream)
          (*standard-output* stream)
          (tpl:*zoom-print-circle* *print-circle*)
          (tpl:*zoom-print-level* *print-level*)
          (tpl:*zoom-print-length* *print-length*))
      (tpl:do-command "zoom"
        :from-read-eval-print-loop nil
        :count t
        :all t))
    #+clisp
    (system::print-backtrace :out stream :limit count)
    #+(or clozure mcl)
    (let ((*debug-io* stream))
112
113
      #+clozure (ccl:print-call-history :count count :start-frame-number 1)
      #+mcl (ccl:print-call-history :detailed-p nil)
114
      (finish-output stream))
115
    #+(or cmu scl)
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
    (let ((debug:*debug-print-level* *print-level*)
          (debug:*debug-print-length* *print-length*))
      (debug:backtrace most-positive-fixnum stream))
    #+ecl
    (si::tpl-backtrace)
    #+lispworks
    (let ((dbg::*debugger-stack*
            (dbg::grab-stack nil :how-many (or count most-positive-fixnum)))
          (*debug-io* stream)
          (dbg:*debug-print-level* *print-level*)
          (dbg:*debug-print-length* *print-length*))
      (dbg:bug-backtrace nil))
    #+sbcl
    (sb-debug:backtrace
     #.(if (find-symbol* "*VERBOSITY*" "SB-DEBUG" nil) :stream '(or count most-positive-fixnum))
     stream))

  (defun print-backtrace (&rest keys &key stream count)
134
    "Print a backtrace"
135
136
137
138
139
140
141
142
143
144
145
    (declare (ignore stream count))
    (with-safe-io-syntax (:package :cl)
      (let ((*print-readably* nil)
            (*print-circle* t)
            (*print-miser-width* 75)
            (*print-length* nil)
            (*print-level* nil)
            (*print-pretty* t))
        (ignore-errors (apply 'raw-print-backtrace keys)))))

  (defun print-condition-backtrace (condition &key (stream *stderr*) count)
146
    "Print a condition after a backtrace triggered by that condition"
147
148
149
150
151
152
153
154
155
    ;; We print the condition *after* the backtrace,
    ;; for the sake of who sees the backtrace at a terminal.
    ;; It is up to the caller to print the condition *before*, with some context.
    (print-backtrace :stream stream :count count)
    (when condition
      (safe-format! stream "~&Above backtrace due to this condition:~%~A~&"
                    condition)))

  (defun fatal-condition-p (condition)
156
    "Is the CONDITION fatal? It is if it matches any in *FATAL-CONDITIONS*"
157
158
159
    (match-any-condition-p condition *fatal-conditions*))

  (defun handle-fatal-condition (condition)
160
161
    "Handle a fatal CONDITION:
depending on whether *LISP-INTERACTION* is set, enter debugger or die"
162
163
164
165
166
167
168
169
170
    (cond
      (*lisp-interaction*
       (invoke-debugger condition))
      (t
       (safe-format! *stderr* "~&Fatal condition:~%~A~%" condition)
       (print-condition-backtrace condition :stream *stderr*)
       (die 99 "~A" condition))))

  (defun call-with-fatal-condition-handler (thunk)
171
    "Call THUNK in a context where fatal conditions are appropriately handled"
172
173
174
175
    (handler-bind (((satisfies fatal-condition-p) #'handle-fatal-condition))
      (funcall thunk)))

  (defmacro with-fatal-condition-handler ((&optional) &body body)
176
    "Execute BODY in a context where fatal conditions are appropriately handled"
177
178
179
180
181
    `(call-with-fatal-condition-handler #'(lambda () ,@body)))

  (defun shell-boolean-exit (x)
    "Quit with a return code that is 0 iff argument X is true"
    (quit (if x 0 1))))
182
183


184
;;; Using image hooks
185
186
(with-upgradability ()
  (defun register-image-restore-hook (hook &optional (call-now-p t))
187
    "Regiter a hook function to be run when restoring a dumped image"
188
    (register-hook-function '*image-restore-hook* hook call-now-p))
189

190
  (defun register-image-dump-hook (hook &optional (call-now-p nil))
191
    "Register a the hook function to be run before to dump an image"
192
    (register-hook-function '*image-dump-hook* hook call-now-p))
193

194
  (defun call-image-restore-hook ()
195
    "Call the hook functions registered to be run when restoring a dumped image"
196
    (call-functions (reverse *image-restore-hook*)))
197

198
  (defun call-image-dump-hook ()
199
    "Call the hook functions registered to be run before to dump an image"
200
    (call-functions *image-dump-hook*)))
201
202
203


;;; Proper command-line arguments
204
205
206
207
208
209
210
211
212
213
(with-upgradability ()
  (defun raw-command-line-arguments ()
    "Find what the actual command line for this process was."
    #+abcl ext:*command-line-argument-list* ; Use 1.0.0 or later!
    #+allegro (sys:command-line-arguments) ; default: :application t
    #+clisp (coerce (ext:argv) 'list)
    #+clozure (ccl::command-line-arguments)
    #+(or cmu scl) extensions:*command-line-strings*
    #+ecl (loop :for i :from 0 :below (si:argc) :collect (si:argv i))
    #+gcl si:*command-args*
214
    #+(or genera mcl) nil
215
216
217
    #+lispworks sys:*line-arguments-list*
    #+sbcl sb-ext:*posix-argv*
    #+xcl system:*argv*
218
    #-(or abcl allegro clisp clozure cmu ecl gcl genera lispworks mcl sbcl scl xcl)
219
220
221
222
    (error "raw-command-line-arguments not implemented yet"))

  (defun command-line-arguments (&optional (arguments (raw-command-line-arguments)))
    "Extract user arguments from command-line invocation of current process.
223
224
Assume the calling conventions of a generated script that uses --
if we are not called from a directly executable image."
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
    #+abcl arguments
    #-abcl
    (let* (#-(or sbcl allegro)
           (arguments
             (if (eq *image-dumped-p* :executable)
                 arguments
                 (member "--" arguments :test 'string-equal))))
      (rest arguments)))

  (defun setup-command-line-arguments ()
    (setf *command-line-arguments* (command-line-arguments)))

  (defun restore-image (&key
                          ((:lisp-interaction *lisp-interaction*) *lisp-interaction*)
                          ((:restore-hook *image-restore-hook*) *image-restore-hook*)
                          ((:prelude *image-prelude*) *image-prelude*)
241
242
                          ((:entry-point *image-entry-point*) *image-entry-point*)
                          (if-already-restored '(cerror "RUN RESTORE-IMAGE ANYWAY")))
243
244
    "From a freshly restarted Lisp image, restore the saved Lisp environment
by setting appropriate variables, running various hooks, and calling any specified entry point."
245
246
247
248
    (when *image-restored-p*
      (if if-already-restored
          (call-function if-already-restored "Image already ~:[being ~;~]restored" (eq *image-restored-p* t))
          (return-from restore-image)))
249
    (with-fatal-condition-handler ()
250
      (setf *image-restored-p* :in-progress)
251
252
      (call-image-restore-hook)
      (standard-eval-thunk *image-prelude*)
253
      (setf *image-restored-p* t)
254
255
256
257
258
259
260
      (let ((results (multiple-value-list
                      (if *image-entry-point*
                          (call-function *image-entry-point*)
                          t))))
        (if *lisp-interaction*
            (apply 'values results)
            (shell-boolean-exit (first results)))))))
261

262
263
264

;;; Dumping an image

265
266
267
(with-upgradability ()
  (defun dump-image (filename &key output-name executable
                                ((:postlude *image-postlude*) *image-postlude*)
268
                                ((:dump-hook *image-dump-hook*) *image-dump-hook*)
269
                                #+clozure prepend-symbols #+clozure (purify t))
270
    "Dump an image of the current Lisp environment at pathname FILENAME, with various options"
271
272
    (declare (ignorable filename output-name executable))
    (setf *image-dumped-p* (if executable :executable t))
273
    (setf *image-restored-p* :in-regress)
274
275
    (standard-eval-thunk *image-postlude*)
    (call-image-dump-hook)
276
    (setf *image-restored-p* nil)
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
    #-(or clisp clozure cmu lispworks sbcl scl)
    (when executable
      (error "Dumping an executable is not supported on this implementation! Aborting."))
    #+allegro
    (progn
      (sys:resize-areas :global-gc t :pack-heap t :sift-old-areas t :tenure t) ; :new 5000000
      (excl:dumplisp :name filename :suppress-allegro-cl-banner t))
    #+clisp
    (apply #'ext:saveinitmem filename
           :quiet t
           :start-package *package*
           :keep-global-handlers nil
           :executable (if executable 0 t) ;--- requires clisp 2.48 or later, still catches --clisp-x
           (when executable
             (list
              ;; :parse-options nil ;--- requires a non-standard patch to clisp.
              :norc t :script nil :init-function #'restore-image)))
    #+clozure
295
    (flet ((dump (prepend-kernel)
296
             (ccl:save-application filename :prepend-kernel prepend-kernel :purify purify
297
298
299
300
301
                                            :toplevel-function (when executable #'restore-image))))
      ;;(setf ccl::*application* (make-instance 'ccl::lisp-development-system))
      (if prepend-symbols
          (with-temporary-file (:prefix "ccl-symbols-" :direction :output :pathname path)
            (require 'elf)
302
            (funcall (fdefinition 'ccl::write-elf-symbols-to-file) path)
303
304
            (dump path))
          (dump t)))
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
    #+(or cmu scl)
    (progn
      (ext:gc :full t)
      (setf ext:*batch-mode* nil)
      (setf ext::*gc-run-time* 0)
      (apply 'ext:save-lisp filename #+cmu :executable #+cmu t
                                     (when executable '(:init-function restore-image :process-command-line nil))))
    #+gcl
    (progn
      (si::set-hole-size 500) (si::gbc nil) (si::sgc-on t)
      (si::save-system filename))
    #+lispworks
    (if executable
        (lispworks:deliver 'restore-image filename 0 :interface nil)
        (hcl:save-image filename :environment nil))
    #+sbcl
    (progn
      ;;(sb-pcl::precompile-random-code-segments) ;--- it is ugly slow at compile-time (!) when the initial core is a big CLOS program. If you want it, do it yourself
      (setf sb-ext::*gc-run-time* 0)
      (apply 'sb-ext:save-lisp-and-die filename
             :executable t ;--- always include the runtime that goes with the core
             (when executable (list :toplevel #'restore-image :save-runtime-options t)))) ;--- only save runtime-options for standalone executables
    #-(or allegro clisp clozure cmu gcl lispworks sbcl scl)
328
329
    (error "Can't ~S ~S: UIOP doesn't support image dumping with ~A.~%"
           'dump-image filename (nth-value 1 (implementation-type))))
330
331

  (defun create-image (destination object-files
332
                       &key kind output-name prologue-code epilogue-code
333
334
                         (prelude () preludep) (postlude () postludep)
                         (entry-point () entry-point-p) build-args)
335
    (declare (ignorable destination object-files kind output-name prologue-code epilogue-code
336
                        prelude preludep postlude postludep entry-point entry-point-p build-args))
337
    "On ECL, create an executable at pathname DESTINATION from the specified OBJECT-FILES and options"
338
339
340
    ;; Is it meaningful to run these in the current environment?
    ;; only if we also track the object files that constitute the "current" image,
    ;; and otherwise simulate dump-image, including quitting at the end.
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
    #-ecl (error "~S not implemented for your implementation (yet)" 'create-image)
    #+ecl
    (progn
      (check-type kind (member :binary :dll :lib :static-library :program :object :fasl :program))
      (apply 'c::builder
             kind (pathname destination)
             :lisp-files object-files
             :init-name (c::compute-init-name (or output-name destination) :kind kind)
             :prologue-code prologue-code
             :epilogue-code
             `(progn
                ,epilogue-code
                ,@(when (eq kind :program)
                    `((setf *image-dumped-p* :executable)
                      (restore-image ;; default behavior would be (si::top-level)
                       ,@(when preludep `(:prelude ',prelude))
                       ,@(when entry-point-p `(:entry-point ',entry-point))))))
             build-args))))
359
360


361
;;; Some universal image restore hooks
362
363
(with-upgradability ()
  (map () 'register-image-restore-hook
364
365
       '(setup-stdin setup-stdout setup-stderr
         setup-command-line-arguments setup-temporary-directory
366
         #+abcl detect-os)))