X-Git-Url: http://repo.macrolet.net/gitweb/?a=blobdiff_plain;f=src%2Fcode%2Ftoplevel.lisp;h=eddb5f88010fc503d74ab7a38179545c54a945b2;hb=c548f73e8dd676d6ec4576eba6ab661a5061bdfe;hp=381a2b2d0bc0b88ec5b25088e2094e688101c294;hpb=0d669e68a1ffbea42af6216f2ae8c7d7ca12ffb6;p=sbcl.git diff --git a/src/code/toplevel.lisp b/src/code/toplevel.lisp index 381a2b2..eddb5f8 100644 --- a/src/code/toplevel.lisp +++ b/src/code/toplevel.lisp @@ -18,28 +18,54 @@ ;;; 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 sb!vm::*current-catch-block*) + (defvar sb!vm::*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*)) +(declaim (special #!+(or x86 x86-64) *pseudo-atomic-bits* + *allow-with-interrupts* + *interrupts-enabled* + *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*) + +;;;; default initfiles + +(defun sysinit-pathname () + (or (let ((sbcl-homedir (sbcl-homedir-pathname))) + (when sbcl-homedir + (probe-file (merge-pathnames "sbclrc" sbcl-homedir)))) + #!+win32 + (merge-pathnames "sbcl\\sbclrc" + (sb!win32::get-folder-pathname + sb!win32::csidl_common_appdata)) + #!-win32 + "/etc/sbclrc")) + +(defun userinit-pathname () + (merge-pathnames ".sbclrc" (user-homedir-pathname))) + +(defvar *sysinit-pathname-function* #'sysinit-pathname + #!+sb-doc + "Designator for a function of zero arguments called to obtain a pathname +designator for the default sysinit file, or NIL. If the function returns NIL, +no sysinit file is used unless one has been specified on the command-line.") + +(defvar *userinit-pathname-function* #'userinit-pathname + #!+sb-doc + "Designator for a function of zero arguments called to obtain a pathname +designator or a stream for the default userinit file, or NIL. If the function +returns NIL, no userinit file is used unless one has been specified on the +command-line.") + ;;;; miscellaneous utilities for working with with TOPLEVEL @@ -47,14 +73,15 @@ ;;; 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"))) + (with-unique-names (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)))) + (/show0 "inside CATCH '%END-OF-THE-WORLD") + ,@body))) + (/show0 "back from CATCH '%END-OF-THE-WORLD, flushing output") + (flush-standard-output-streams) + (sb!thread::terminate-session) + (/show0 "calling UNIX-EXIT") + (sb!unix:unix-exit ,caught)))) ;;;; working with *CURRENT-ERROR-DEPTH* and *MAXIMUM-ERROR-DEPTH* @@ -65,7 +92,8 @@ (/show0 "back from INFINITE-ERROR-PROTECTOR") (let ((*current-error-depth* (1+ *current-error-depth*))) (/show0 "in INFINITE-ERROR-PROTECT, incremented error depth") - #+sb-show (sb-debug:backtrace) + ;; arbitrary truncation + #!+sb-show (sb!debug:backtrace 8) ,@forms))) ;;; a helper function for INFINITE-ERROR-PROTECT @@ -73,26 +101,26 @@ (/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))) + (%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. " + "SB-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 @@ -102,48 +130,50 @@ #| (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))) + (%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. " + "SB-KERNEL:*MAXIMUM-ERROR-DEPTH* exceeded.") + (progn ,@forms) + t) + (t + (/show0 "in INFINITE-ERROR-PROTECTOR, returning normally") + nil))) |# ;;;; miscellaneous external functions -#!-mp ; The multi-processing version is defined in multi-proc.lisp. (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)) + (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) + #!-win32 + (multiple-value-bind (sec nsec) (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)) + (values n 0) + (multiple-value-bind (sec frac) + (truncate n) + (values sec (truncate frac 1e-9)))) + (sb!unix:nanosleep sec nsec)) + #!+win32 + (sb!win32:millisleep (truncate (* n 1000))) nil) ;;;; SCRUB-CONTROL-STACK @@ -152,79 +182,95 @@ ;;; Zero the unused portion of the control stack so that old objects ;;; are not kept alive because of uninitialized stack variables. -;;; -;;; FIXME: Why do we need to do this instead of just letting GC read -;;; the stack pointer and avoid messing with the unused portion of -;;; the control stack? (Is this a multithreading thing where there's -;;; one control stack and stack pointer per thread, and it might not -;;; be easy to tell what a thread's stack pointer value is when -;;; looking in from another thread?) + +;;; "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 () (declare (optimize (speed 3) (safety 0)) - (values (unsigned-byte 20))) ; FIXME: DECLARE VALUES? + (values (unsigned-byte 20))) ; FIXME: DECLARE VALUES? #!-stack-grows-downward-not-upward - (labels - ((scrub (ptr offset count) - (declare (type system-area-pointer ptr) - (type (unsigned-byte 16) offset) - (type (unsigned-byte 20) count) - (values (unsigned-byte 20))) - (cond ((= offset bytes-per-scrub-unit) - (look (sap+ ptr bytes-per-scrub-unit) 0 count)) - (t - (setf (sap-ref-32 ptr offset) 0) - (scrub ptr (+ offset sb!vm:n-word-bytes) count)))) - (look (ptr offset count) - (declare (type system-area-pointer ptr) - (type (unsigned-byte 16) offset) - (type (unsigned-byte 20) count) - (values (unsigned-byte 20))) - (cond ((= offset bytes-per-scrub-unit) - count) - ((zerop (sap-ref-32 ptr offset)) - (look ptr (+ offset sb!vm:n-word-bytes) count)) - (t - (scrub ptr offset (+ count sb!vm:n-word-bytes)))))) - (let* ((csp (sap-int (sb!c::control-stack-pointer-sap))) - (initial-offset (logand csp (1- bytes-per-scrub-unit)))) - (declare (type (unsigned-byte 32) csp)) + (let* ((csp (sap-int (sb!c::control-stack-pointer-sap))) + (initial-offset (logand csp (1- bytes-per-scrub-unit))) + (end-of-stack + (- (sap-int (sb!di::descriptor-sap sb!vm:*control-stack-end*)) + sb!c:*backend-page-size*))) + (labels + ((scrub (ptr offset count) + (declare (type system-area-pointer ptr) + (type (unsigned-byte 16) offset) + (type (unsigned-byte 20) count) + (values (unsigned-byte 20))) + (cond ((>= (sap-int ptr) end-of-stack) 0) + ((= offset bytes-per-scrub-unit) + (look (sap+ ptr bytes-per-scrub-unit) 0 count)) + (t + (setf (sap-ref-word ptr offset) 0) + (scrub ptr (+ offset sb!vm:n-word-bytes) count)))) + (look (ptr offset count) + (declare (type system-area-pointer ptr) + (type (unsigned-byte 16) offset) + (type (unsigned-byte 20) count) + (values (unsigned-byte 20))) + (cond ((>= (sap-int ptr) end-of-stack) 0) + ((= offset bytes-per-scrub-unit) + count) + ((zerop (sap-ref-word ptr offset)) + (look ptr (+ offset sb!vm:n-word-bytes) count)) + (t + (scrub ptr offset (+ count sb!vm:n-word-bytes)))))) + (declare (type sb!vm::word csp)) (scrub (int-sap (- csp initial-offset)) - (* (floor initial-offset sb!vm:n-word-bytes) sb!vm:n-word-bytes) - 0))) + (* (floor initial-offset sb!vm:n-word-bytes) sb!vm:n-word-bytes) + 0))) #!+stack-grows-downward-not-upward - (labels - ((scrub (ptr offset count) - (declare (type system-area-pointer ptr) - (type (unsigned-byte 16) offset) - (type (unsigned-byte 20) count) - (values (unsigned-byte 20))) - (let ((loc (int-sap (- (sap-int ptr) (+ offset sb!vm:n-word-bytes))))) - (cond ((= offset bytes-per-scrub-unit) - (look (int-sap (- (sap-int ptr) bytes-per-scrub-unit)) - 0 count)) - (t ;; need to fix bug in %SET-STACK-REF - (setf (sap-ref-32 loc 0) 0) - (scrub ptr (+ offset sb!vm:n-word-bytes) count))))) - (look (ptr offset count) - (declare (type system-area-pointer ptr) - (type (unsigned-byte 16) offset) - (type (unsigned-byte 20) count) - (values (unsigned-byte 20))) - (let ((loc (int-sap (- (sap-int ptr) offset)))) - (cond ((= offset bytes-per-scrub-unit) - count) - ((zerop (sb!kernel::get-lisp-obj-address (stack-ref loc 0))) - (look ptr (+ offset sb!vm:n-word-bytes) count)) - (t - (scrub ptr offset (+ count sb!vm:n-word-bytes))))))) - (let* ((csp (sap-int (sb!c::control-stack-pointer-sap))) - (initial-offset (logand csp (1- bytes-per-scrub-unit)))) - (declare (type (unsigned-byte 32) csp)) + (let* ((csp (sap-int (sb!c::control-stack-pointer-sap))) + (end-of-stack (+ (sap-int (sb!di::descriptor-sap sb!vm:*control-stack-start*)) + sb!c:*backend-page-size*)) + (initial-offset (logand csp (1- bytes-per-scrub-unit)))) + (labels + ((scrub (ptr offset count) + (declare (type system-area-pointer ptr) + (type (unsigned-byte 16) offset) + (type (unsigned-byte 20) count) + (values (unsigned-byte 20))) + (let ((loc (int-sap (- (sap-int ptr) (+ offset sb!vm:n-word-bytes))))) + (cond ((< (sap-int loc) end-of-stack) 0) + ((= offset bytes-per-scrub-unit) + (look (int-sap (- (sap-int ptr) bytes-per-scrub-unit)) + 0 count)) + (t ;; need to fix bug in %SET-STACK-REF + (setf (sap-ref-word loc 0) 0) + (scrub ptr (+ offset sb!vm:n-word-bytes) count))))) + (look (ptr offset count) + (declare (type system-area-pointer ptr) + (type (unsigned-byte 16) offset) + (type (unsigned-byte 20) count) + (values (unsigned-byte 20))) + (let ((loc (int-sap (- (sap-int ptr) offset)))) + (cond ((< (sap-int loc) end-of-stack) 0) + ((= offset bytes-per-scrub-unit) + count) + ((zerop (sb!kernel::get-lisp-obj-address (stack-ref loc 0))) + (look ptr (+ offset sb!vm:n-word-bytes) count)) + (t + (scrub ptr offset (+ count sb!vm:n-word-bytes))))))) + (declare (type sb!vm::word csp)) (scrub (int-sap (+ csp initial-offset)) - (* (floor initial-offset sb!vm:n-word-bytes) sb!vm:n-word-bytes) - 0)))) + (* (floor initial-offset sb!vm:n-word-bytes) sb!vm:n-word-bytes) + 0)))) ;;;; the default toplevel function @@ -242,318 +288,349 @@ (defvar - nil #!+sb-doc "the form currently being evaluated") (defun interactive-eval (form) + #!+sb-doc "Evaluate FORM, returning whatever it returns and adjusting ***, **, *, - +++, ++, +, ///, //, /, and -." ++++, ++, +, ///, //, /, and -." (setf - form) - (let ((results (multiple-value-list (eval form)))) - (setf /// // - // / - / results - *** ** - ** * - * (car results))) - (setf +++ ++ - ++ + - + -) + (unwind-protect + (let ((results (multiple-value-list (eval form)))) + (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.")) + "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))) + *error-output* + *query-io* + *standard-output* + *trace-output* + *terminal-io*)) + ;; FINISH-OUTPUT may block more easily than FORCE-OUTPUT + (force-output (symbol-value name))) (values)) +(defun process-init-file (specified-pathname default-function) + (restart-case + (let ((cookie (list))) + (flet ((process-stream (stream &optional pathname) + (loop + (restart-case + (handler-bind + ((error (lambda (e) + (error "Error during processing of ~ + initialization file ~A:~%~% ~A" + (or pathname stream) e)))) + (let ((form (read stream nil cookie))) + (if (eq cookie form) + (return-from process-init-file nil) + (eval form)))) + (continue () + :report "Ignore and continue processing."))))) + (if specified-pathname + (with-open-file (stream (parse-native-namestring specified-pathname) + :if-does-not-exist nil) + (if stream + (process-stream stream (pathname stream)) + (error "The specified init file ~S was not found." + specified-pathname))) + (let ((default (funcall default-function))) + (when default + (with-open-file (stream (pathname default) :if-does-not-exist nil) + (when stream + (process-stream stream (pathname stream))))))))) + (abort () + :report "Skip this initialization file."))) + +(defun process-eval-options (eval-strings-or-forms) + (/show0 "handling --eval options") + (flet ((process-1 (string-or-form) + (etypecase string-or-form + (string + (multiple-value-bind (expr pos) (read-from-string string-or-form) + (unless (eq string-or-form + (read-from-string string-or-form nil string-or-form + :start pos)) + (error "More than one expression in ~S" string-or-form)) + (eval expr) + (flush-standard-output-streams))) + (cons (eval string-or-form) (flush-standard-output-streams))))) + (restart-case + (dolist (expr-as-string-or-form eval-strings-or-forms) + (/show0 "handling one --eval option") + (restart-case + (handler-bind + ((error (lambda (e) + (error "Error during processing of --eval ~ + option ~S:~%~% ~A" + expr-as-string-or-form e)))) + (process-1 expr-as-string-or-form)) + (continue () + :report "Ignore and continue with next --eval option."))) + (abort () + :report "Skip rest of --eval options.")))) + +;; Errors while processing the command line cause the system to QUIT, +;; instead of trying to go into the Lisp debugger, because trying to +;; go into the Lisp debugger would get into various annoying issues of +;; where we should go after the user tries to return from the +;; debugger. +(defun startup-error (control-string &rest args) + (format *error-output* + "fatal error before reaching READ-EVAL-PRINT loop: ~% ~?~%" + control-string + args) + (quit :unix-status 1)) + ;;; the default system top level function (defun toplevel-init () - (/show0 "entering TOPLEVEL-INIT") - - (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? - (noprogrammer nil) ; Has a --noprogrammer option been seen? - (options (rest *posix-argv*))) ; skipping program name + (let ( ;; value of --sysinit option + (sysinit nil) + ;; t if --no-sysinit option given + (no-sysinit nil) + ;; value of --userinit option + (userinit nil) + ;; t if --no-userinit option given + (no-userinit nil) + ;; values of --eval options, in reverse order; and also any + ;; other options (like --load) which're translated into --eval + ;; + ;; The values are stored as strings, so that they can be + ;; passed to READ only after their predecessors have been + ;; EVALed, so that things work when e.g. REQUIRE in one EVAL + ;; form creates a package referred to in the next EVAL form, + ;; except for forms transformed from syntactically-sugary + ;; switches like --load and --disable-debugger. + (reversed-evals nil) + ;; Has a --noprint option been seen? + (noprint nil) + ;; everything in *POSIX-ARGV* except for argv[0]=programname + (options (rest *posix-argv*))) + + (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. + ;; reasonably. + + ;; Process 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)) - ((string= option "--noprogrammer") - (pop-option) - (setf noprogrammer t)) - ((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 "at head of LOOP WHILE OPTIONS DO in TOPLEVEL-INIT") + (let ((option (first options))) + (flet ((pop-option () + (if options + (pop options) + (startup-error + "unexpected end of command line options")))) + (cond ((string= option "--sysinit") + (pop-option) + (if sysinit + (startup-error "multiple --sysinit options") + (setf sysinit (pop-option)))) + ((string= option "--no-sysinit") + (pop-option) + (setf no-sysinit t)) + ((string= option "--userinit") + (pop-option) + (if userinit + (startup-error "multiple --userinit options") + (setf userinit (pop-option)))) + ((string= option "--no-userinit") + (pop-option) + (setf no-userinit t)) + ((string= option "--eval") + (pop-option) + (push (pop-option) reversed-evals)) + ((string= option "--load") + (pop-option) + (push + (list 'cl:load (native-pathname (pop-option))) + reversed-evals)) + ((string= option "--noprint") + (pop-option) + (setf noprint t)) + ((string= option "--disable-debugger") + (pop-option) + (push (list 'sb!ext: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=) + (startup-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 + ;; Delete all the options that we processed, so that only ;; user-level options are left visible to user code. (setf (rest *posix-argv*) options) - ;; Handle --noprogrammer option. We intentionally do this - ;; early so that it will affect the handling of initialization - ;; files and --eval options. - (/show0 "handling --noprogrammer option in TOPLEVEL-INIT") - (when noprogrammer - (setf *debugger-hook* 'noprogrammer-debugger-hook-fun - *debug-io* *error-output*)) - ;; 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) - (/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) + ;; This CATCH is needed for the debugger command TOPLEVEL to + ;; work. + (catch 'toplevel-catcher + ;; 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 + (unless no-sysinit + (process-init-file sysinit *sysinit-pathname-function*)) + (unless no-userinit + (process-init-file userinit *userinit-pathname-function*)) + (process-eval-options (nreverse reversed-evals))) + (abort () + :report "Skip 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 :unix-status 1)))) + + ;; 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")))) + (/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"))) + +;;; hooks to support customized toplevels like ACL-style toplevel from +;;; KMR on sbcl-devel 2002-12-21. Altered by CSR 2003-11-16 for +;;; threaded operation: altered *REPL-FUN* to *REPL-FUN-GENERATOR*. +(defvar *repl-read-form-fun* #'repl-read-form-fun + #!+sb-doc + "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 + #!+sb-doc + "A function of one argument STREAM for the toplevel REPL to call: Prompt +the user for input.") +(defvar *repl-fun-generator* (constantly #'repl-fun) + #!+sb-doc + "A function of no arguments returning a function of one argument NOPRINT +that provides the REPL for the system. Assumes that *STANDARD-INPUT* and +*STANDARD-OUTPUT* are set up.") ;;; 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? - (repl noprint) - (critically-unreachable "after REPL"))))))) - -(defun repl (noprint) + (- nil) + (+ nil) (++ nil) (+++ nil) + (/// nil) (// nil) (/ nil)) + (/show0 "about to funcall *REPL-FUN-GENERATOR*") + (let ((repl-fun (funcall *repl-fun-generator*))) + ;; Each REPL in a multithreaded world should have bindings of + ;; most CL specials (most critically *PACKAGE*). + (with-rebound-io-syntax + (handler-bind ((step-condition 'invoke-stepper)) + (loop + (/show0 "about to set up restarts in TOPLEVEL-REPL") + ;; CLHS recommends that there should always be an + ;; ABORT restart; we have this one here, and one per + ;; debugger level. + (with-simple-restart + (abort "~@") + (catch 'toplevel-catcher + #!-win32 (sb!unix::reset-signal-mask) + ;; 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. + #!-win32 + (sb!kernel::protect-control-stack-guard-page 1) + (funcall repl-fun noprint) + (critically-unreachable "after REPL"))))))))) + +;;; Our default REPL prompt is the minimal traditional one. +(defun repl-prompt-fun (stream) + (fresh-line stream) + (write-string "* " stream)) ; 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))) + +(defun repl-fun (noprint) (/show0 "entering REPL") - (let ((eof-marker (cons :eof nil))) - (loop - ;; FIXME: It seems bad to have GC behavior depend on scrubbing the - ;; control stack before each interactive command. Isn't there some - ;; way we can convince the GC to just ignore dead areas of the - ;; control stack, so that we don't need to rely on this half-measure? - (scrub-control-stack) - (unless noprint - (fresh-line) - (write-string "* ") ; arbitrary but customary REPL prompt - (flush-standard-output-streams)) - (let ((form (read *standard-input* nil eof-marker))) - (cond ((eq form eof-marker) - (/show0 "doing QUIT for EOF in REPL") - (quit)) - (t - (let ((results (multiple-value-list (interactive-eval form)))) - (unless noprint - (dolist (result results) - (fresh-line) - (prin1 result)))))))))) - -(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 noprogrammer 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* - "~&~@~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 --noprogrammer 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 --noprogrammer error handling")) - (failure-quit :recklessly-p t))))) + (loop + (unwind-protect + (progn + ;; (See comment preceding the definition of SCRUB-CONTROL-STACK.) + (scrub-control-stack) + (sb!thread::get-foreground) + (unless noprint + (flush-standard-output-streams) + (funcall *repl-prompt-fun* *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))))) + ;; If we started stepping in the debugger we want to stop now. + (disable-stepping)))) ;;; a convenient way to get into the assembly-level debugger (defun %halt ()