(in-package "SB!IMPL")
\f
-(defconstant most-positive-fixnum #.sb!vm:*target-most-positive-fixnum*
- #!+sb-doc
- "the fixnum closest in value to positive infinity")
-
-(defconstant most-negative-fixnum #.sb!vm:*target-most-negative-fixnum*
- #!+sb-doc
- "the fixnum closest in value to negative infinity")
-\f
;;;; magic specials initialized by GENESIS
;;; FIXME: The DEFVAR here is redundant with the (DECLAIM (SPECIAL ..))
(/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
\f
;;;; 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))
- (error "Invalid argument to SLEEP: ~S.~%~
- Must be a non-negative, non-complex number."
- 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))))
+ (values sec (truncate frac 1e-6))))
(sb!unix:unix-select 0 0 0 0 sec usec))
nil)
\f
;;; 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?
- #!-x86 ; machines where stack grows upwards (I guess) -- WHN 19990906
- (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))))
+ #!-stack-grows-downward-not-upward
+ (let* ((csp (sap-int (sb!c::control-stack-pointer-sap)))
+ (initial-offset (logand csp (1- bytes-per-scrub-unit)))
+ (end-of-stack
+ (- 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-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 ((>= (sap-int ptr) end-of-stack) 0)
+ ((= 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))))))
(declare (type (unsigned-byte 32) csp))
(scrub (int-sap (- csp initial-offset))
(* (floor initial-offset sb!vm:n-word-bytes) sb!vm:n-word-bytes)
0)))
- #!+x86 ;; (Stack grows downwards.)
- (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))))
+ #!+stack-grows-downward-not-upward
+ (let* ((csp (sap-int (sb!c::control-stack-pointer-sap)))
+ (end-of-stack (+ 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-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 ((< (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 (unsigned-byte 32) csp))
(scrub (int-sap (+ csp initial-offset))
(* (floor initial-offset sb!vm:n-word-bytes) sb!vm:n-word-bytes)
(defvar +++ nil #!+sb-doc "the previous value of ++")
(defvar - nil #!+sb-doc "the form currently being evaluated")
-;;; the top level prompt string, or a function of no arguments that
-;;; returns a simple-string
-(defvar *prompt* "* ")
-
(defun interactive-eval (form)
"Evaluate FORM, returning whatever it returns and adjusting ***, **, *,
+++, ++, +, ///, //, /, and -."
(setf - form)
- (let ((results (multiple-value-list (eval form))))
+ (let ((results
+ (multiple-value-list
+ (eval-in-lexenv form
+ (make-null-interactive-lexenv)))))
(setf /// //
// /
/ results
(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
+ (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 --noprogammer 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
;; 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.
+ ;; 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
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)
- (setf noprogrammer t))
+ (push '(disable-debugger) reversed-evals))
((string= option "--end-toplevel-options")
(pop-option)
(return))
;; 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*))
-
- ;; FIXME: Verify that errors in init files and/or --eval operations
- ;; lead to reasonable behavior.
-
;; 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)
(let* ((sbcl-home (posix-getenv "SBCL_HOME"))
(sysinit-truename (if sbcl-home
(probe-init-files sysinit
- (concatenate
- 'string
- sbcl-home
- "/sbclrc"))
+ (concatenate 'string
+ sbcl-home
+ "/sbclrc"))
(probe-init-files sysinit
"/etc/sbclrc"
"/usr/local/etc/sbclrc")))
(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"))))
- (/show0 "assigned SYSINIT-TRUENAME and USERINIT-TRUENAME")
-
+ (concatenate 'string
+ user-home
+ "/.sbclrc"))))
;; We wrap all the pre-REPL user/system customized startup code
;; in a restart.
;; 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 usually 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.)
+ ;; 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
- (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)
+ (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")
(eval eval)
(flush-standard-output-streams)))
(continue ()
- :report "Continue anyway (skipping to toplevel read/eval/print loop)."
- (values)) ; (no-op, just fall through)
+ :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)."
- (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
(flush-standard-output-streams)
(/show0 "falling into TOPLEVEL-REPL from TOPLEVEL-INIT")
- (toplevel-repl noprint))))
+ (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)
(- nil)
(+ nil) (++ nil) (+++ nil)
(/// nil) (// nil) (/ nil))
- (/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).")
- (catch 'toplevel-catcher
- (sb!unix:unix-sigsetmask 0) ; FIXME: What is this for?
- (repl noprint))))))
+ ;; 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 1)
+ (repl 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)))
+
+;;; 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 one argument STREAM for the toplevel REPL to call: Prompt
+ the user for input.")
(defun repl (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?
- (/show0 "at head of LOOP")
+ ;; (See comment preceding the definition of SCRUB-CONTROL-STACK.)
(scrub-control-stack)
- (/show0 "back from SCRUB-CONTROL-STACK")
(unless noprint
- (fresh-line)
- (/show0 "back from FRESH-LINE")
- (princ (if (functionp *prompt*)
- (funcall *prompt*)
- *prompt*))
- (/show0 "back from PRINC")
- (flush-standard-output-streams)
- (/show0 "back from FLUSH-STANDARD-OUTPUT-STREAMS"))
- (let ((form (read *standard-input* nil eof-marker)))
- (/show0 "back from READ")
- (if (eq form eof-marker)
- (quit)
- (let ((results (multiple-value-list (interactive-eval form))))
- (unless noprint
- (dolist (result results)
- (fresh-line)
- (prin1 result)))))))))
-
+ (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)))))))
+
+;;; 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,
;; (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~%")
+ (format
+ *error-output*
+ "~%unhandled condition in --disable-debugger mode, quitting~%")
(finish-output *error-output*)
(failure-quit))
(condition ()
;; 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"))
+ (%primitive print
+ "Argh! error within --disable-debugger error handling"))
(failure-quit :recklessly-p t)))))
\f
;;; a convenient way to get into the assembly-level debugger