1 ;;;; stuff related to the toplevel read-eval-print loop, plus some
2 ;;;; other miscellaneous functions that we don't have any better place
5 ;;;; This software is part of the SBCL system. See the README file for
8 ;;;; This software is derived from the CMU CL system, which was
9 ;;;; written at Carnegie Mellon University and released into the
10 ;;;; public domain. The software is in the public domain and is
11 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
12 ;;;; files for more information.
14 (in-package "SB!IMPL")
16 ;;;; magic specials initialized by GENESIS
18 ;;; FIXME: The DEFVAR here is redundant with the (DECLAIM (SPECIAL ..))
19 ;;; of all static symbols in early-impl.lisp.
21 (defvar *current-catch-block*)
22 (defvar *current-unwind-protect-block*)
23 (defvar *free-interrupt-context-index*))
25 ;;; specials initialized by !COLD-INIT
27 ;;; FIXME: These could be converted to DEFVARs.
28 (declaim (special *gc-inhibit* *already-maybe-gcing*
29 *need-to-collect-garbage*
31 *before-gc-hooks* *after-gc-hooks*
32 #!+x86 *pseudo-atomic-atomic*
33 #!+x86 *pseudo-atomic-interrupted*
34 sb!unix::*interrupts-enabled*
35 sb!unix::*interrupt-pending*
36 *type-system-initialized*))
38 (defvar *cold-init-complete-p*)
40 ;;; counts of nested errors (with internal errors double-counted)
41 (defvar *maximum-error-depth*)
42 (defvar *current-error-depth*)
44 ;;;; miscellaneous utilities for working with with TOPLEVEL
46 ;;; Execute BODY in a context where any %END-OF-THE-WORLD (thrown e.g.
47 ;;; by QUIT) is caught and any final processing and return codes are
48 ;;; handled appropriately.
49 (defmacro handling-end-of-the-world (&body body)
50 (let ((caught (gensym "CAUGHT")))
51 `(let ((,caught (catch '%end-of-the-world
52 (/show0 "inside CATCH '%END-OF-THE-WORLD")
54 (/show0 "back from CATCH '%END-OF-THE-WORLD, flushing output")
55 (flush-standard-output-streams)
56 (/show0 "calling UNIX-EXIT")
57 (sb!unix:unix-exit ,caught))))
59 ;;;; working with *CURRENT-ERROR-DEPTH* and *MAXIMUM-ERROR-DEPTH*
61 ;;; INFINITE-ERROR-PROTECT is used by ERROR and friends to keep us out
63 (defmacro infinite-error-protect (&rest forms)
64 `(unless (infinite-error-protector)
65 (/show0 "back from INFINITE-ERROR-PROTECTOR")
66 (let ((*current-error-depth* (1+ *current-error-depth*)))
67 (/show0 "in INFINITE-ERROR-PROTECT, incremented error depth")
68 #+sb-show (sb-debug:backtrace)
71 ;;; a helper function for INFINITE-ERROR-PROTECT
72 (defun infinite-error-protector ()
73 (/show0 "entering INFINITE-ERROR-PROTECTOR, *CURRENT-ERROR-DEPTH*=..")
74 (/hexstr *current-error-depth*)
75 (cond ((not *cold-init-complete-p*)
76 (%primitive print "Argh! error in cold init, halting")
77 (%primitive sb!c:halt))
78 ((or (not (boundp '*current-error-depth*))
79 (not (realp *current-error-depth*))
80 (not (boundp '*maximum-error-depth*))
81 (not (realp *maximum-error-depth*)))
82 (%primitive print "Argh! corrupted error depth, halting")
83 (%primitive sb!c:halt))
84 ((> *current-error-depth* *maximum-error-depth*)
85 (/show0 "*MAXIMUM-ERROR-DEPTH*=..")
86 (/hexstr *maximum-error-depth*)
87 (/show0 "in INFINITE-ERROR-PROTECTOR, calling ERROR-ERROR")
91 "KERNEL:*MAXIMUM-ERROR-DEPTH* exceeded.")
94 (/show0 "returning normally from INFINITE-ERROR-PROTECTOR")
97 ;;; FIXME: I had a badly broken version of INFINITE-ERROR-PROTECTOR at
98 ;;; one point (shown below), and SBCL cross-compiled it without
99 ;;; warning about FORMS being undefined. Check whether that problem
100 ;;; (missing warning) is repeatable in the final system and if so, fix
103 (defun infinite-error-protector ()
104 `(cond ((not *cold-init-complete-p*)
105 (%primitive print "Argh! error in cold init, halting")
106 (%primitive sb!c:halt))
107 ((or (not (boundp '*current-error-depth*))
108 (not (realp *current-error-depth*))
109 (not (boundp '*maximum-error-depth*))
110 (not (realp *maximum-error-depth*)))
111 (%primitive print "Argh! corrupted error depth, halting")
112 (%primitive sb!c:halt))
113 ((> *current-error-depth* *maximum-error-depth*)
114 (/show0 "in INFINITE-ERROR-PROTECTOR, calling ERROR-ERROR")
115 (error-error "Help! "
116 *current-error-depth*
118 "KERNEL:*MAXIMUM-ERROR-DEPTH* exceeded.")
122 (/show0 "in INFINITE-ERROR-PROTECTOR, returning normally")
126 ;;;; miscellaneous external functions
128 #!-mp ; The multi-processing version is defined in multi-proc.lisp.
131 "This function causes execution to be suspended for N seconds. N may
132 be any non-negative, non-complex number."
133 (when (or (not (realp n))
135 (error 'simple-type-error
136 :format-control "invalid argument to SLEEP: ~S"
137 :format-arguments (list n)
139 :expected-type '(real 0)))
140 (multiple-value-bind (sec usec)
143 (multiple-value-bind (sec frac)
145 (values sec (truncate frac 1e-6))))
146 (sb!unix:unix-select 0 0 0 0 sec usec))
149 ;;;; SCRUB-CONTROL-STACK
151 (defconstant bytes-per-scrub-unit 2048)
153 ;;; Zero the unused portion of the control stack so that old objects
154 ;;; are not kept alive because of uninitialized stack variables.
156 ;;; FIXME: Why do we need to do this instead of just letting GC read
157 ;;; the stack pointer and avoid messing with the unused portion of
158 ;;; the control stack? (Is this a multithreading thing where there's
159 ;;; one control stack and stack pointer per thread, and it might not
160 ;;; be easy to tell what a thread's stack pointer value is when
161 ;;; looking in from another thread?)
162 (defun scrub-control-stack ()
163 (declare (optimize (speed 3) (safety 0))
164 (values (unsigned-byte 20))) ; FIXME: DECLARE VALUES?
166 #!-stack-grows-downward-not-upward
168 ((scrub (ptr offset count)
169 (declare (type system-area-pointer ptr)
170 (type (unsigned-byte 16) offset)
171 (type (unsigned-byte 20) count)
172 (values (unsigned-byte 20)))
173 (cond ((= offset bytes-per-scrub-unit)
174 (look (sap+ ptr bytes-per-scrub-unit) 0 count))
176 (setf (sap-ref-32 ptr offset) 0)
177 (scrub ptr (+ offset sb!vm:n-word-bytes) count))))
178 (look (ptr offset count)
179 (declare (type system-area-pointer ptr)
180 (type (unsigned-byte 16) offset)
181 (type (unsigned-byte 20) count)
182 (values (unsigned-byte 20)))
183 (cond ((= offset bytes-per-scrub-unit)
185 ((zerop (sap-ref-32 ptr offset))
186 (look ptr (+ offset sb!vm:n-word-bytes) count))
188 (scrub ptr offset (+ count sb!vm:n-word-bytes))))))
189 (let* ((csp (sap-int (sb!c::control-stack-pointer-sap)))
190 (initial-offset (logand csp (1- bytes-per-scrub-unit))))
191 (declare (type (unsigned-byte 32) csp))
192 (scrub (int-sap (- csp initial-offset))
193 (* (floor initial-offset sb!vm:n-word-bytes) sb!vm:n-word-bytes)
196 #!+stack-grows-downward-not-upward
198 ((scrub (ptr offset count)
199 (declare (type system-area-pointer ptr)
200 (type (unsigned-byte 16) offset)
201 (type (unsigned-byte 20) count)
202 (values (unsigned-byte 20)))
203 (let ((loc (int-sap (- (sap-int ptr) (+ offset sb!vm:n-word-bytes)))))
204 (cond ((= offset bytes-per-scrub-unit)
205 (look (int-sap (- (sap-int ptr) bytes-per-scrub-unit))
207 (t ;; need to fix bug in %SET-STACK-REF
208 (setf (sap-ref-32 loc 0) 0)
209 (scrub ptr (+ offset sb!vm:n-word-bytes) count)))))
210 (look (ptr offset count)
211 (declare (type system-area-pointer ptr)
212 (type (unsigned-byte 16) offset)
213 (type (unsigned-byte 20) count)
214 (values (unsigned-byte 20)))
215 (let ((loc (int-sap (- (sap-int ptr) offset))))
216 (cond ((= offset bytes-per-scrub-unit)
218 ((zerop (sb!kernel::get-lisp-obj-address (stack-ref loc 0)))
219 (look ptr (+ offset sb!vm:n-word-bytes) count))
221 (scrub ptr offset (+ count sb!vm:n-word-bytes)))))))
222 (let* ((csp (sap-int (sb!c::control-stack-pointer-sap)))
223 (initial-offset (logand csp (1- bytes-per-scrub-unit))))
224 (declare (type (unsigned-byte 32) csp))
225 (scrub (int-sap (+ csp initial-offset))
226 (* (floor initial-offset sb!vm:n-word-bytes) sb!vm:n-word-bytes)
229 ;;;; the default toplevel function
233 "a list of all the values returned by the most recent top level EVAL")
234 (defvar // nil #!+sb-doc "the previous value of /")
235 (defvar /// nil #!+sb-doc "the previous value of //")
236 (defvar * nil #!+sb-doc "the value of the most recent top level EVAL")
237 (defvar ** nil #!+sb-doc "the previous value of *")
238 (defvar *** nil #!+sb-doc "the previous value of **")
239 (defvar + nil #!+sb-doc "the value of the most recent top level READ")
240 (defvar ++ nil #!+sb-doc "the previous value of +")
241 (defvar +++ nil #!+sb-doc "the previous value of ++")
242 (defvar - nil #!+sb-doc "the form currently being evaluated")
244 (defun interactive-eval (form)
245 "Evaluate FORM, returning whatever it returns and adjusting ***, **, *,
246 +++, ++, +, ///, //, /, and -."
248 (let ((results (multiple-value-list (eval form))))
259 ;; The bogon returned an unbound marker.
260 ;; FIXME: It would be safer to check every one of the values in RESULTS,
261 ;; instead of just the first one.
263 (cerror "Go on with * set to NIL."
264 "EVAL returned an unbound marker."))
267 ;;; Flush anything waiting on one of the ANSI Common Lisp standard
268 ;;; output streams before proceeding.
269 (defun flush-standard-output-streams ()
270 (dolist (name '(*debug-io*
275 (finish-output (symbol-value name)))
278 ;;; the default system top level function
279 (defun toplevel-init ()
281 (/show0 "entering TOPLEVEL-INIT")
283 (let ((sysinit nil) ; value of --sysinit option
284 (userinit nil) ; value of --userinit option
285 (reversed-evals nil) ; values of --eval options, in reverse order; and
286 ; also --load options, translated into --eval
287 (noprint nil) ; Has a --noprint option been seen?
288 (options (rest *posix-argv*))) ; skipping program name
290 (/show0 "done with outer LET in TOPLEVEL-INIT")
292 ;; FIXME: There are lots of ways for errors to happen around here
293 ;; (e.g. bad command line syntax, or READ-ERROR while trying to
294 ;; READ an --eval string). Make sure that they're handled
295 ;; reasonably. Also, perhaps all errors while parsing the command
296 ;; line should cause the system to QUIT, instead of trying to go
297 ;; into the Lisp debugger, since trying to go into the debugger
298 ;; gets into various annoying issues of where we should go after
299 ;; the user tries to return from the debugger.
301 ;; Parse command line options.
302 (loop while options do
303 (/show0 "at head of LOOP WHILE OPTIONS DO in TOPLEVEL-INIT")
304 (let ((option (first options)))
305 (flet ((pop-option ()
308 (error "unexpected end of command line options"))))
309 (cond ((string= option "--sysinit")
312 (error "multiple --sysinit options")
313 (setf sysinit (pop-option))))
314 ((string= option "--userinit")
317 (error "multiple --userinit options")
318 (setf userinit (pop-option))))
319 ((string= option "--eval")
321 (let ((eval-as-string (pop-option)))
322 (with-input-from-string (eval-stream eval-as-string)
323 (let* ((eof-marker (cons :eof :eof))
324 (eval (read eval-stream nil eof-marker))
325 (eof (read eval-stream nil eof-marker)))
326 (cond ((eq eval eof-marker)
327 (error "unable to parse ~S"
329 ((not (eq eof eof-marker))
330 (error "more than one expression in ~S"
333 (push eval reversed-evals)))))))
334 ((string= option "--load")
336 (push `(load ,(pop-option)) reversed-evals))
337 ((string= option "--noprint")
340 ;; FIXME: --noprogrammer was deprecated in 0.7.5, and
341 ;; in a year or so this backwards compatibility can
343 ((string= option "--noprogrammer")
344 (warn "treating deprecated --noprogrammer as --disable-debugger")
346 (push '(disable-debugger) reversed-evals))
347 ((string= option "--disable-debugger")
349 (push '(disable-debugger) reversed-evals))
350 ((string= option "--end-toplevel-options")
354 ;; Anything we don't recognize as a toplevel
355 ;; option must be the start of user-level
356 ;; options.. except that if we encounter
357 ;; "--end-toplevel-options" after we gave up
358 ;; because we didn't recognize an option as a
359 ;; toplevel option, then the option we gave up on
360 ;; must have been an error. (E.g. in
361 ;; "sbcl --eval '(a)' --eval'(b)' --end-toplevel-options"
362 ;; this test will let us detect that the string
363 ;; "--eval(b)" is an error.)
364 (if (find "--end-toplevel-options" options
366 (error "bad toplevel option: ~S" (first options))
368 (/show0 "done with LOOP WHILE OPTIONS DO in TOPLEVEL-INIT")
370 ;; Excise all the options that we processed, so that only
371 ;; user-level options are left visible to user code.
372 (setf (rest *posix-argv*) options)
374 ;; Handle initialization files.
375 (/show0 "handling initialization files in TOPLEVEL-INIT")
376 (flet (;; If any of POSSIBLE-INIT-FILE-NAMES names a real file,
377 ;; return its truename.
378 (probe-init-files (&rest possible-init-file-names)
379 (/show0 "entering PROBE-INIT-FILES")
382 (and (stringp x) (probe-file x)))
383 possible-init-file-names)
384 (/show0 "leaving PROBE-INIT-FILES"))))
385 (let* ((sbcl-home (posix-getenv "SBCL_HOME"))
386 (sysinit-truename (if sbcl-home
387 (probe-init-files sysinit
391 (probe-init-files sysinit
393 "/usr/local/etc/sbclrc")))
394 (user-home (or (posix-getenv "HOME")
395 (error "The HOME environment variable is unbound, ~
396 so user init file can't be found.")))
397 (userinit-truename (probe-init-files userinit
402 ;; We wrap all the pre-REPL user/system customized startup code
405 ;; (Why not wrap everything, even the stuff above, in this
406 ;; restart? Errors above here are basically command line or
407 ;; Unix environment errors, e.g. a missing file or a typo on
408 ;; the Unix command line, and you don't need to get into Lisp
409 ;; to debug them, you should just start over and do it right
410 ;; at the Unix level. Errors below here are generally errors
411 ;; in user Lisp code, and it might be helpful to let the user
412 ;; reach the REPL in order to help figure out what's going
416 (flet ((process-init-file (truename)
418 (unless (load truename)
419 (error "~S was not successfully loaded." truename))
420 (flush-standard-output-streams))))
421 (process-init-file sysinit-truename)
422 (process-init-file userinit-truename))
424 ;; Process --eval options.
425 (/show0 "handling --eval options in TOPLEVEL-INIT")
426 (dolist (eval (reverse reversed-evals))
427 (/show0 "handling one --eval option in TOPLEVEL-INIT")
429 (flush-standard-output-streams)))
432 "Continue anyway (skipping to toplevel read/eval/print loop)."
433 (/show0 "CONTINUEing from pre-REPL RESTART-CASE")
434 (values)) ; (no-op, just fall through)
436 :report "Quit SBCL (calling #'QUIT, killing the process)."
437 (/show0 "falling through to QUIT from pre-REPL RESTART-CASE")
440 ;; one more time for good measure, in case we fell out of the
441 ;; RESTART-CASE above before one of the flushes in the ordinary
442 ;; flow of control had a chance to operate
443 (flush-standard-output-streams)
445 (/show0 "falling into TOPLEVEL-REPL from TOPLEVEL-INIT")
446 (toplevel-repl noprint)
447 ;; (classic CMU CL error message: "You're certainly a clever child.":-)
448 (critically-unreachable "after TOPLEVEL-REPL"))))
450 ;;; halt-on-failures and prompt-on-failures modes, suitable for
451 ;;; noninteractive and interactive use respectively
452 (defun disable-debugger ()
453 (setf *debugger-hook* 'noprogrammer-debugger-hook-fun
454 *debug-io* *error-output*))
455 (defun enable-debugger ()
456 (setf *debugger-hook* nil
457 *debug-io* *query-io*))
459 ;;; read-eval-print loop for the default system toplevel
460 (defun toplevel-repl (noprint)
461 (/show0 "entering TOPLEVEL-REPL")
462 (let ((* nil) (** nil) (*** nil)
464 (+ nil) (++ nil) (+++ nil)
465 (/// nil) (// nil) (/ nil))
466 ;; WITH-SIMPLE-RESTART doesn't actually restart its body as some
467 ;; (like WHN for an embarrassingly long time ca. 2001-12-07) might
468 ;; think, but instead drops control back out at the end. So when a
469 ;; TOPLEVEL or outermost-ABORT restart happens, we need this outer
470 ;; LOOP wrapper to grab control and start over again. (And it also
471 ;; wraps CATCH 'TOPLEVEL-CATCHER for similar reasons.)
473 (/show0 "about to set up restarts in TOPLEVEL-REPL")
474 ;; There should only be one TOPLEVEL restart, and it's here, so
475 ;; restarting at TOPLEVEL always bounces you all the way out here.
476 (with-simple-restart (toplevel
477 "Restart at toplevel READ/EVAL/PRINT loop.")
478 ;; We add a new ABORT restart for every debugger level, so
479 ;; restarting at ABORT in a nested debugger gets you out to the
480 ;; innermost enclosing debugger, and only when you're in the
481 ;; outermost, unnested debugger level does restarting at ABORT
482 ;; get you out to here.
485 "Reduce debugger level (leaving debugger, returning to toplevel).")
486 (catch 'toplevel-catcher
487 #!-sunos (sb!unix:unix-sigsetmask 0) ; FIXME: What is this for?
489 (critically-unreachable "after REPL")))))))
491 (defun repl (noprint)
492 (/show0 "entering REPL")
493 (let ((eof-marker (cons :eof nil)))
495 ;; FIXME: It seems bad to have GC behavior depend on scrubbing the
496 ;; control stack before each interactive command. Isn't there some
497 ;; way we can convince the GC to just ignore dead areas of the
498 ;; control stack, so that we don't need to rely on this half-measure?
499 (scrub-control-stack)
502 (write-string "* ") ; arbitrary but customary REPL prompt
503 (flush-standard-output-streams))
504 (let ((form (read *standard-input* nil eof-marker)))
505 (cond ((eq form eof-marker)
506 (/show0 "doing QUIT for EOF in REPL")
509 (let ((results (multiple-value-list (interactive-eval form))))
511 (dolist (result results)
513 (prin1 result))))))))))
515 ;;; suitable value for *DEBUGGER-HOOK* for a noninteractive Unix-y program
516 (defun noprogrammer-debugger-hook-fun (condition old-debugger-hook)
517 (declare (ignore old-debugger-hook))
518 (flet ((failure-quit (&key recklessly-p)
519 (/show0 "in FAILURE-QUIT (in --disable-debugger debugger hook)")
520 (quit :unix-status 1 :recklessly-p recklessly-p)))
521 ;; This HANDLER-CASE is here mostly to stop output immediately
522 ;; (and fall through to QUIT) when there's an I/O error. Thus,
523 ;; when we're run under a shell script or something, we can die
524 ;; cleanly when the script dies (and our pipes are cut), instead
525 ;; of falling into ldb or something messy like that.
528 (format *error-output*
529 "~&~@<unhandled condition (of type ~S): ~2I~_~A~:>~2%"
532 ;; Flush *ERROR-OUTPUT* even before the BACKTRACE, so that
533 ;; even if we hit an error within BACKTRACE (e.g. a bug in
534 ;; the debugger's own frame-walking code, or a bug in a user
535 ;; PRINT-OBJECT method) we'll at least have the CONDITION
536 ;; printed out before we die.
537 (finish-output *error-output*)
538 ;; (Where to truncate the BACKTRACE is of course arbitrary, but
539 ;; it seems as though we should at least truncate it somewhere.)
540 (sb!debug:backtrace 128 *error-output*)
543 "~%unhandled condition in --disable-debugger mode, quitting~%")
544 (finish-output *error-output*)
547 ;; We IGNORE-ERRORS here because even %PRIMITIVE PRINT can
548 ;; fail when our output streams are blown away, as e.g. when
549 ;; we're running under a Unix shell script and it dies somehow
550 ;; (e.g. because of a SIGINT). In that case, we might as well
551 ;; just give it up for a bad job, and stop trying to notify
552 ;; the user of anything.
554 ;; Actually, the only way I've run across to exercise the
555 ;; problem is to have more than one layer of shell script.
556 ;; I have a shell script which does
557 ;; time nice -10 sh make.sh "$1" 2>&1 | tee make.tmp
558 ;; and the problem occurs when I interrupt this with Ctrl-C
559 ;; under Linux 2.2.14-5.0 and GNU bash, version 1.14.7(1).
560 ;; I haven't figured out whether it's bash, time, tee, Linux, or
561 ;; what that is responsible, but that it's possible at all
562 ;; means that we should IGNORE-ERRORS here. -- WHN 2001-04-24
565 "Argh! error within --disable-debugger error handling"))
566 (failure-quit :recklessly-p t)))))
568 ;;; a convenient way to get into the assembly-level debugger
570 (%primitive sb!c:halt))