[5d4902]: src / code / toplevel.lisp Maximize Restore History

Download this file

toplevel.lisp    552 lines (505 with data), 21.5 kB

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
;;;; stuff related to the toplevel read-eval-print loop, plus some
;;;; other miscellaneous functions that we don't have any better place
;;;; for
;;;; 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.
(in-package "SB!IMPL")
;;;; magic specials initialized by GENESIS
;;; FIXME: The DEFVAR here is redundant with the (DECLAIM (SPECIAL ..))
;;; of all static symbols in early-impl.lisp.
(progn
(defvar *current-catch-block*)
(defvar *current-unwind-protect-block*)
(defvar *free-interrupt-context-index*))
;;; specials initialized by !COLD-INIT
;;; FIXME: These could be converted to DEFVARs.
(declaim (special *gc-inhibit* *already-maybe-gcing*
*need-to-collect-garbage*
*gc-notify-stream*
*before-gc-hooks* *after-gc-hooks*
#!+x86 *pseudo-atomic-atomic*
#!+x86 *pseudo-atomic-interrupted*
sb!unix::*interrupts-enabled*
sb!unix::*interrupt-pending*
*type-system-initialized*))
(defvar *cold-init-complete-p*)
;;; counts of nested errors (with internal errors double-counted)
(defvar *maximum-error-depth*)
(defvar *current-error-depth*)
;;;; miscellaneous utilities for working with with TOPLEVEL
;;; Execute BODY in a context where any %END-OF-THE-WORLD (thrown e.g.
;;; by QUIT) is caught and any final processing and return codes are
;;; handled appropriately.
(defmacro handling-end-of-the-world (&body body)
(let ((caught (gensym "CAUGHT")))
`(let ((,caught (catch '%end-of-the-world
(/show0 "inside CATCH '%END-OF-THE-WORLD")
,@body)))
(/show0 "back from CATCH '%END-OF-THE-WORLD, flushing output")
(flush-standard-output-streams)
(/show0 "calling UNIX-EXIT")
(sb!unix:unix-exit ,caught))))
;;;; working with *CURRENT-ERROR-DEPTH* and *MAXIMUM-ERROR-DEPTH*
;;; INFINITE-ERROR-PROTECT is used by ERROR and friends to keep us out
;;; of hyperspace.
(defmacro infinite-error-protect (&rest forms)
`(unless (infinite-error-protector)
(/show0 "back from INFINITE-ERROR-PROTECTOR")
(let ((*current-error-depth* (1+ *current-error-depth*)))
(/show0 "in INFINITE-ERROR-PROTECT, incremented error depth")
;; arbitrary truncation
#!+sb-show (sb!debug:backtrace 8)
,@forms)))
;;; a helper function for INFINITE-ERROR-PROTECT
(defun infinite-error-protector ()
(/show0 "entering INFINITE-ERROR-PROTECTOR, *CURRENT-ERROR-DEPTH*=..")
(/hexstr *current-error-depth*)
(cond ((not *cold-init-complete-p*)
(%primitive print "Argh! error in cold init, halting")
(%primitive sb!c:halt))
((or (not (boundp '*current-error-depth*))
(not (realp *current-error-depth*))
(not (boundp '*maximum-error-depth*))
(not (realp *maximum-error-depth*)))
(%primitive print "Argh! corrupted error depth, halting")
(%primitive sb!c:halt))
((> *current-error-depth* *maximum-error-depth*)
(/show0 "*MAXIMUM-ERROR-DEPTH*=..")
(/hexstr *maximum-error-depth*)
(/show0 "in INFINITE-ERROR-PROTECTOR, calling ERROR-ERROR")
(error-error "Help! "
*current-error-depth*
" nested errors. "
"KERNEL:*MAXIMUM-ERROR-DEPTH* exceeded.")
t)
(t
(/show0 "returning normally from INFINITE-ERROR-PROTECTOR")
nil)))
;;; FIXME: I had a badly broken version of INFINITE-ERROR-PROTECTOR at
;;; one point (shown below), and SBCL cross-compiled it without
;;; warning about FORMS being undefined. Check whether that problem
;;; (missing warning) is repeatable in the final system and if so, fix
;;; it.
#|
(defun infinite-error-protector ()
`(cond ((not *cold-init-complete-p*)
(%primitive print "Argh! error in cold init, halting")
(%primitive sb!c:halt))
((or (not (boundp '*current-error-depth*))
(not (realp *current-error-depth*))
(not (boundp '*maximum-error-depth*))
(not (realp *maximum-error-depth*)))
(%primitive print "Argh! corrupted error depth, halting")
(%primitive sb!c:halt))
((> *current-error-depth* *maximum-error-depth*)
(/show0 "in INFINITE-ERROR-PROTECTOR, calling ERROR-ERROR")
(error-error "Help! "
*current-error-depth*
" nested errors. "
"KERNEL:*MAXIMUM-ERROR-DEPTH* exceeded.")
(progn ,@forms)
t)
(t
(/show0 "in INFINITE-ERROR-PROTECTOR, returning normally")
nil)))
|#
;;;; miscellaneous external functions
(defun sleep (n)
#!+sb-doc
"This function causes execution to be suspended for N seconds. N may
be any non-negative, non-complex number."
(when (or (not (realp n))
(minusp n))
(error 'simple-type-error
:format-control "invalid argument to SLEEP: ~S"
:format-arguments (list n)
:datum n
:expected-type '(real 0)))
(multiple-value-bind (sec usec)
(if (integerp n)
(values n 0)
(multiple-value-bind (sec frac)
(truncate n)
(values sec (truncate frac 1e-6))))
(sb!unix:unix-select 0 0 0 0 sec usec))
nil)
;;;; SCRUB-CONTROL-STACK
(defconstant bytes-per-scrub-unit 2048)
;;; Zero the unused portion of the control stack so that old objects
;;; are not kept alive because of uninitialized stack variables.
;;; "To summarize the problem, since not all allocated stack frame
;;; slots are guaranteed to be written by the time you call an another
;;; function or GC, there may be garbage pointers retained in your
;;; dead stack locations. The stack scrubbing only affects the part
;;; of the stack from the SP to the end of the allocated stack."
;;; - ram, on cmucl-imp, Tue, 25 Sep 2001
;;; So, as an (admittedly lame) workaround, from time to time we call
;;; scrub-control-stack to zero out all the unused portion. This is
;;; supposed to happen when the stack is mostly empty, so that we have
;;; a chance of clearing more of it: callers are currently (2002.07.18)
;;; REPL and SUB-GC
(defun scrub-control-stack () )
;;;; the default toplevel function
(defvar / nil
#!+sb-doc
"a list of all the values returned by the most recent top level EVAL")
(defvar // nil #!+sb-doc "the previous value of /")
(defvar /// nil #!+sb-doc "the previous value of //")
(defvar * nil #!+sb-doc "the value of the most recent top level EVAL")
(defvar ** nil #!+sb-doc "the previous value of *")
(defvar *** nil #!+sb-doc "the previous value of **")
(defvar + nil #!+sb-doc "the value of the most recent top level READ")
(defvar ++ nil #!+sb-doc "the previous value of +")
(defvar +++ nil #!+sb-doc "the previous value of ++")
(defvar - nil #!+sb-doc "the form currently being evaluated")
(defun interactive-eval (form)
"Evaluate FORM, returning whatever it returns and adjusting ***, **, *,
+++, ++, +, ///, //, /, and -."
(setf - form)
(let ((results
(multiple-value-list
(eval-in-lexenv form
(make-null-interactive-lexenv)))))
(setf /// //
// /
/ results
*** **
** *
* (car results)))
(setf +++ ++
++ +
+ -)
(unless (boundp '*)
;; The bogon returned an unbound marker.
;; FIXME: It would be safer to check every one of the values in RESULTS,
;; instead of just the first one.
(setf * nil)
(cerror "Go on with * set to NIL."
"EVAL returned an unbound marker."))
(values-list /))
;;; Flush anything waiting on one of the ANSI Common Lisp standard
;;; output streams before proceeding.
(defun flush-standard-output-streams ()
(dolist (name '(*debug-io*
*error-output*
*query-io*
*standard-output*
*trace-output*))
(finish-output (symbol-value name)))
(values))
;;; the default system top level function
(defun toplevel-init ()
(/show0 "entering TOPLEVEL-INIT")
(setf sb!thread::*session-lock* (sb!thread:make-mutex :name "the terminal"))
(sb!thread::get-foreground)
(let ((sysinit nil) ; value of --sysinit option
(userinit nil) ; value of --userinit option
(reversed-evals nil) ; values of --eval options, in reverse order; and
; also --load options, translated into --eval
(noprint nil) ; Has a --noprint option been seen?
(options (rest *posix-argv*))) ; skipping program name
(declare (type list options))
(/show0 "done with outer LET in TOPLEVEL-INIT")
;; FIXME: There are lots of ways for errors to happen around here
;; (e.g. bad command line syntax, or READ-ERROR while trying to
;; READ an --eval string). Make sure that they're handled
;; reasonably. Also, perhaps all errors while parsing the command
;; line should cause the system to QUIT, instead of trying to go
;; into the Lisp debugger, since trying to go into the debugger
;; gets into various annoying issues of where we should go after
;; the user tries to return from the debugger.
;; Parse command line options.
(loop while options do
(/show0 "at head of LOOP WHILE OPTIONS DO in TOPLEVEL-INIT")
(let ((option (first options)))
(flet ((pop-option ()
(if options
(pop options)
(error "unexpected end of command line options"))))
(cond ((string= option "--sysinit")
(pop-option)
(if sysinit
(error "multiple --sysinit options")
(setf sysinit (pop-option))))
((string= option "--userinit")
(pop-option)
(if userinit
(error "multiple --userinit options")
(setf userinit (pop-option))))
((string= option "--eval")
(pop-option)
(let ((eval-as-string (pop-option)))
(with-input-from-string (eval-stream eval-as-string)
(let* ((eof-marker (cons :eof :eof))
(eval (read eval-stream nil eof-marker))
(eof (read eval-stream nil eof-marker)))
(cond ((eq eval eof-marker)
(error "unable to parse ~S"
eval-as-string))
((not (eq eof eof-marker))
(error "more than one expression in ~S"
eval-as-string))
(t
(push eval reversed-evals)))))))
((string= option "--load")
(pop-option)
(push `(load ,(pop-option)) reversed-evals))
((string= option "--noprint")
(pop-option)
(setf noprint t))
;; FIXME: --noprogrammer was deprecated in 0.7.5, and
;; in a year or so this backwards compatibility can
;; go away.
((string= option "--noprogrammer")
(warn "treating deprecated --noprogrammer as --disable-debugger")
(pop-option)
(push '(disable-debugger) reversed-evals))
((string= option "--disable-debugger")
(pop-option)
(push '(disable-debugger) reversed-evals))
((string= option "--end-toplevel-options")
(pop-option)
(return))
(t
;; Anything we don't recognize as a toplevel
;; option must be the start of user-level
;; options.. except that if we encounter
;; "--end-toplevel-options" after we gave up
;; because we didn't recognize an option as a
;; toplevel option, then the option we gave up on
;; must have been an error. (E.g. in
;; "sbcl --eval '(a)' --eval'(b)' --end-toplevel-options"
;; this test will let us detect that the string
;; "--eval(b)" is an error.)
(if (find "--end-toplevel-options" options
:test #'string=)
(error "bad toplevel option: ~S" (first options))
(return)))))))
(/show0 "done with LOOP WHILE OPTIONS DO in TOPLEVEL-INIT")
;; Excise all the options that we processed, so that only
;; user-level options are left visible to user code.
(setf (rest *posix-argv*) options)
;; Handle initialization files.
(/show0 "handling initialization files in TOPLEVEL-INIT")
(flet (;; If any of POSSIBLE-INIT-FILE-NAMES names a real file,
;; return its truename.
(probe-init-files (&rest possible-init-file-names)
(declare (type list possible-init-file-names))
(/show0 "entering PROBE-INIT-FILES")
(prog1
(find-if (lambda (x)
(and (stringp x) (probe-file x)))
possible-init-file-names)
(/show0 "leaving PROBE-INIT-FILES"))))
(let* ((sbcl-home (posix-getenv "SBCL_HOME"))
(sysinit-truename (if sbcl-home
(probe-init-files sysinit
(concatenate 'string
sbcl-home
"/sbclrc"))
(probe-init-files sysinit
"/etc/sbclrc"
"/usr/local/etc/sbclrc")))
(user-home (or (posix-getenv "HOME")
(error "The HOME environment variable is unbound, ~
so user init file can't be found.")))
(userinit-truename (probe-init-files userinit
(concatenate 'string
user-home
"/.sbclrc"))))
;; We wrap all the pre-REPL user/system customized startup code
;; in a restart.
;;
;; (Why not wrap everything, even the stuff above, in this
;; restart? Errors above here are basically command line or
;; Unix environment errors, e.g. a missing file or a typo on
;; the Unix command line, and you don't need to get into Lisp
;; to debug them, you should just start over and do it right
;; at the Unix level. Errors below here are generally errors
;; in user Lisp code, and it might be helpful to let the user
;; reach the REPL in order to help figure out what's going
;; on.)
(restart-case
(progn
(flet ((process-init-file (truename)
(when truename
(unless (load truename)
(error "~S was not successfully loaded." truename))
(flush-standard-output-streams))))
(process-init-file sysinit-truename)
(process-init-file userinit-truename))
;; Process --eval options.
(/show0 "handling --eval options in TOPLEVEL-INIT")
(dolist (eval (reverse reversed-evals))
(/show0 "handling one --eval option in TOPLEVEL-INIT")
(eval eval)
(flush-standard-output-streams)))
(continue ()
:report
"Continue anyway (skipping to toplevel read/eval/print loop)."
(/show0 "CONTINUEing from pre-REPL RESTART-CASE")
(values)) ; (no-op, just fall through)
(quit ()
:report "Quit SBCL (calling #'QUIT, killing the process)."
(/show0 "falling through to QUIT from pre-REPL RESTART-CASE")
(quit))))
;; one more time for good measure, in case we fell out of the
;; RESTART-CASE above before one of the flushes in the ordinary
;; flow of control had a chance to operate
(flush-standard-output-streams)
(/show0 "falling into TOPLEVEL-REPL from TOPLEVEL-INIT")
(toplevel-repl noprint)
;; (classic CMU CL error message: "You're certainly a clever child.":-)
(critically-unreachable "after TOPLEVEL-REPL"))))
;;; halt-on-failures and prompt-on-failures modes, suitable for
;;; noninteractive and interactive use respectively
(defun disable-debugger ()
(setf *debugger-hook* 'noprogrammer-debugger-hook-fun
*debug-io* *error-output*))
(defun enable-debugger ()
(setf *debugger-hook* nil
*debug-io* *query-io*))
;;; read-eval-print loop for the default system toplevel
(defun toplevel-repl (noprint)
(/show0 "entering TOPLEVEL-REPL")
(let ((* nil) (** nil) (*** nil)
(- nil)
(+ nil) (++ nil) (+++ nil)
(/// nil) (// nil) (/ nil))
;; WITH-SIMPLE-RESTART doesn't actually restart its body as some
;; (like WHN for an embarrassingly long time ca. 2001-12-07) might
;; think, but instead drops control back out at the end. So when a
;; TOPLEVEL or outermost-ABORT restart happens, we need this outer
;; LOOP wrapper to grab control and start over again. (And it also
;; wraps CATCH 'TOPLEVEL-CATCHER for similar reasons.)
(loop
(/show0 "about to set up restarts in TOPLEVEL-REPL")
;; There should only be one TOPLEVEL restart, and it's here, so
;; restarting at TOPLEVEL always bounces you all the way out here.
(with-simple-restart (toplevel
"Restart at toplevel READ/EVAL/PRINT loop.")
;; We add a new ABORT restart for every debugger level, so
;; restarting at ABORT in a nested debugger gets you out to the
;; innermost enclosing debugger, and only when you're in the
;; outermost, unnested debugger level does restarting at ABORT
;; get you out to here.
(with-simple-restart
(abort
"~@<Reduce debugger level (leaving debugger, returning to toplevel).~@:>")
(catch 'toplevel-catcher
#!-sunos (sb!unix:unix-sigsetmask 0) ; FIXME: What is this for?
;; in the event of a control-stack-exhausted-error, we should
;; have unwound enough stack by the time we get here that this
;; is now possible
(sb!kernel::protect-control-stack-guard-page t)
(repl noprint)
(critically-unreachable "after REPL")))))))
;;; Our default REPL prompt is the minimal traditional one.
(defun repl-prompt-fun (in out)
(declare (type stream in out) (ignore in))
(fresh-line out)
(write-string "* " out)) ; arbitrary but customary REPL prompt
;;; Our default form reader does relatively little magic, but does
;;; handle the Unix-style EOF-is-end-of-process convention.
(defun repl-read-form-fun (in out)
(declare (type stream in out) (ignore out))
(let* ((eof-marker (cons nil nil))
(form (read in nil eof-marker)))
(if (eq form eof-marker)
(quit)
form)))
;;; hooks to support customized toplevels like ACL-style toplevel
;;; from KMR on sbcl-devel 2002-12-21
(defvar *repl-read-form-fun* #'repl-read-form-fun
"a function of two stream arguments IN and OUT for the toplevel REPL to
call: Return the next Lisp form to evaluate (possibly handling other
magic -- like ACL-style keyword commands -- which precede the next
Lisp form). The OUT stream is there to support magic which requires
issuing new prompts.")
(defvar *repl-prompt-fun* #'repl-prompt-fun
"a function of two stream arguments IN and OUT for the toplevel REPL
to call: Prompt the user for input.")
(defun repl (noprint)
(/show0 "entering REPL")
(let ((eof-marker (cons :eof nil)))
(loop
;; (See comment preceding the definition of SCRUB-CONTROL-STACK.)
(scrub-control-stack)
(unless noprint
(funcall *repl-prompt-fun* *standard-input* *standard-output*)
;; (Should *REPL-PROMPT-FUN* be responsible for doing its own
;; FORCE-OUTPUT? I can't imagine a valid reason for it not to
;; be done here, so leaving it up to *REPL-PROMPT-FUN* seems
;; odd. But maybe there *is* a valid reason in some
;; circumstances? perhaps some deadlock issue when being driven
;; by another process or something...)
(force-output *standard-output*))
(let* ((form (funcall *repl-read-form-fun*
*standard-input*
*standard-output*))
(results (multiple-value-list (interactive-eval form))))
(unless noprint
(dolist (result results)
(fresh-line)
(prin1 result)))))))
;;; suitable value for *DEBUGGER-HOOK* for a noninteractive Unix-y program
(defun noprogrammer-debugger-hook-fun (condition old-debugger-hook)
(declare (ignore old-debugger-hook))
(flet ((failure-quit (&key recklessly-p)
(/show0 "in FAILURE-QUIT (in --disable-debugger debugger hook)")
(quit :unix-status 1 :recklessly-p recklessly-p)))
;; This HANDLER-CASE is here mostly to stop output immediately
;; (and fall through to QUIT) when there's an I/O error. Thus,
;; when we're run under a shell script or something, we can die
;; cleanly when the script dies (and our pipes are cut), instead
;; of falling into ldb or something messy like that.
(handler-case
(progn
(format *error-output*
"~&~@<unhandled condition (of type ~S): ~2I~_~A~:>~2%"
(type-of condition)
condition)
;; Flush *ERROR-OUTPUT* even before the BACKTRACE, so that
;; even if we hit an error within BACKTRACE (e.g. a bug in
;; the debugger's own frame-walking code, or a bug in a user
;; PRINT-OBJECT method) we'll at least have the CONDITION
;; printed out before we die.
(finish-output *error-output*)
;; (Where to truncate the BACKTRACE is of course arbitrary, but
;; it seems as though we should at least truncate it somewhere.)
(sb!debug:backtrace 128 *error-output*)
(format
*error-output*
"~%unhandled condition in --disable-debugger mode, quitting~%")
(finish-output *error-output*)
(failure-quit))
(condition ()
;; We IGNORE-ERRORS here because even %PRIMITIVE PRINT can
;; fail when our output streams are blown away, as e.g. when
;; we're running under a Unix shell script and it dies somehow
;; (e.g. because of a SIGINT). In that case, we might as well
;; just give it up for a bad job, and stop trying to notify
;; the user of anything.
;;
;; Actually, the only way I've run across to exercise the
;; problem is to have more than one layer of shell script.
;; I have a shell script which does
;; time nice -10 sh make.sh "$1" 2>&1 | tee make.tmp
;; and the problem occurs when I interrupt this with Ctrl-C
;; under Linux 2.2.14-5.0 and GNU bash, version 1.14.7(1).
;; I haven't figured out whether it's bash, time, tee, Linux, or
;; what that is responsible, but that it's possible at all
;; means that we should IGNORE-ERRORS here. -- WHN 2001-04-24
(ignore-errors
(%primitive print
"Argh! error within --disable-debugger error handling"))
(failure-quit :recklessly-p t)))))
;;; a convenient way to get into the assembly-level debugger
(defun %halt ()
(%primitive sb!c:halt))