0.8.5.44:
[sbcl.git] / src / code / toplevel.lisp
index 1348ad7..5aadeec 100644 (file)
@@ -25,9 +25,7 @@
 ;;; 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*
+(declaim (special *gc-inhibit* *need-to-collect-garbage*
                  *before-gc-hooks* *after-gc-hooks*
                  #!+x86 *pseudo-atomic-atomic*
                  #!+x86 *pseudo-atomic-interrupted*
@@ -47,7 +45,7 @@
 ;;; 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)))
@@ -65,7 +63,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
@@ -88,7 +87,7 @@
         (error-error "Help! "
                      *current-error-depth*
                      " nested errors. "
-                     "KERNEL:*MAXIMUM-ERROR-DEPTH* exceeded.")
+                     "SB-KERNEL:*MAXIMUM-ERROR-DEPTH* exceeded.")
         t)
        (t
         (/show0 "returning normally from INFINITE-ERROR-PROTECTOR")
          (error-error "Help! "
                       *current-error-depth*
                       " nested errors. "
-                      "KERNEL:*MAXIMUM-ERROR-DEPTH* exceeded.")
+                      "SB-KERNEL:*MAXIMUM-ERROR-DEPTH* exceeded.")
          (progn ,@forms)
          t)
         (t
 \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
   (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*)))
+         (- (sb!vm:fixnumize sb!vm:*control-stack-end*)
+            sb!c:*backend-page-size*)))
     (labels
        ((scrub (ptr offset count)
           (declare (type system-area-pointer ptr)
 
   #!+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*))
+        (end-of-stack (+ (sb!vm:fixnumize sb!vm:*control-stack-start*)
+                         sb!c:*backend-page-size*))
         (initial-offset (logand csp (1- bytes-per-scrub-unit))))
     (labels
        ((scrub (ptr offset count)
                    (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)
+            (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))
                    (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)
+            (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)))
   "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")
-  
-  (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
+  (setf sb!thread::*session-lock* (sb!thread:make-mutex :name "the terminal"))
+  (sb!thread::get-foreground)
+  (let (;; value of --sysinit option
+       (sysinit nil)
+       ;; value of --userinit option
+       (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.
+       (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")
   
                         (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)))))))
+                    (push (pop-option) reversed-evals))
                    ((string= option "--load")
                     (pop-option)
-                    (push `(load ,(pop-option)) reversed-evals))
+                    (push
+                     ;; FIXME: see BUG 296
+                     (concatenate 'string "(|LOAD| \"" (pop-option) "\")")
+                     reversed-evals))
                    ((string= option "--noprint")
                     (pop-option)
                     (setf noprint t))
                    ((string= option "--noprogrammer")
                     (warn "treating deprecated --noprogrammer as --disable-debugger")
                     (pop-option)
-                    (push '(disable-debugger) reversed-evals))
+                    (push "(|DISABLE-DEBUGGER|)" reversed-evals))
                    ((string= option "--disable-debugger")
                     (pop-option)
-                    (push '(disable-debugger) reversed-evals))
+                    (push "(|DISABLE-DEBUGGER|)" reversed-evals))
                    ((string= option "--end-toplevel-options")
                     (pop-option)
                     (return))
                         (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)
 
     (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)
                          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")))
+            (sysinit-truename
+             (probe-init-files sysinit
+                               (concatenate 'string sbcl-home "/sbclrc")
+                               "/etc/sbclrc"))
             (user-home (or (posix-getenv "HOME")
                            (error "The HOME environment variable is unbound, ~
                                    so user init file can't be found.")))
 
              ;; Process --eval options.
              (/show0 "handling --eval options in TOPLEVEL-INIT")
-             (dolist (eval (reverse reversed-evals))
+             (dolist (expr-as-string (reverse reversed-evals))
                (/show0 "handling one --eval option in TOPLEVEL-INIT")
-               (eval eval)
-               (flush-standard-output-streams)))
+               (let ((expr (with-input-from-string (eval-stream
+                                                    expr-as-string)
+                             (let* ((eof-marker (cons :eof :eof))
+                                    (result (read eval-stream nil eof-marker))
+                                    (eof (read eval-stream nil eof-marker)))
+                               (cond ((eq result eof-marker)
+                                      (error "unable to parse ~S"
+                                             expr-as-string))
+                                     ((not (eq eof eof-marker))
+                                      (error "more than one expression in ~S"
+                                             expr-as-string))
+                                     (t
+                                      result))))))
+                 (eval expr)
+                 (flush-standard-output-streams))))
          (continue ()
            :report
            "Continue anyway (skipping to toplevel read/eval/print loop)."
       ;; (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*))
+;;; 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
+  "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.")
+(defvar *repl-fun-generator* (constantly #'repl-fun)
+  "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)
        (- 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 1)
-          (repl noprint)
-          (critically-unreachable "after REPL")))))))
-
-(defun repl (noprint)
+    (/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
+       ;; 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
+              (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
+              (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
-     ;; see comment preceding definition of SCRUB-CONTROL-STACK
-     (scrub-control-stack)
+  (loop
+   ;; (See comment preceding the definition of SCRUB-CONTROL-STACK.)
+   (scrub-control-stack)
+   (sb!thread::get-foreground)
+   (unless noprint
+     (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
-       (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))))))))))
-
-;;; 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)))))
+       (dolist (result results)
+        (fresh-line)
+        (prin1 result))))))
 \f
 ;;; a convenient way to get into the assembly-level debugger
 (defun %halt ()