- "Terminate the current Lisp. Things are cleaned up (with UNWIND-PROTECT
- and so forth) unless RECKLESSLY-P is non-NIL. On UNIX-like systems,
- UNIX-STATUS is used as the status code."
- (declare (type (signed-byte 32) unix-code))
- ;; FIXME: UNIX-CODE was deprecated in sbcl-0.6.8, after having been
- ;; around for less than a year. It should be safe to remove it after
- ;; a year.
- (when unix-code-p
- (warn "The UNIX-CODE argument is deprecated. Use the UNIX-STATUS argument
-instead (which is another name for the same thing)."))
- (if recklessly-p
- (sb!unix:unix-exit unix-status)
- (throw '%end-of-the-world unix-status)))
+ "Terminates the process, causing SBCL to exit with CODE. CODE
+defaults to 0 when ABORT is false, and 1 when it is true.
+
+When ABORT is false (the default), current thread is first unwound,
+*EXIT-HOOKS* are run, other threads are terminated, and standard
+output streams are flushed before SBCL calls exit(3) -- at which point
+atexit(3) functions will run. If multiple threads call EXIT with ABORT
+being false, the first one to call it will complete the protocol.
+
+When ABORT is true, SBCL exits immediately by calling _exit(2) without
+unwinding stack, or calling exit hooks. Note that _exit(2) does not
+call atexit(3) functions unlike exit(3).
+
+Recursive calls to EXIT cause EXIT to behave as it ABORT was true.
+
+TIMEOUT controls waiting for other threads to terminate when ABORT is
+NIL. Once current thread has been unwound and *EXIT-HOOKS* have been
+run, spawning new threads is prevented and all other threads are
+terminated by calling TERMINATE-THREAD on them. The system then waits
+for them to finish using JOIN-THREAD, waiting at most a total TIMEOUT
+seconds for all threads to join. Those threads that do not finish
+in time are simply ignored while the exit protocol continues. TIMEOUT
+defaults to *EXIT-TIMEOUT*, which in turn defaults to 60. TIMEOUT NIL
+means to wait indefinitely.
+
+Note that TIMEOUT applies only to JOIN-THREAD, not *EXIT-HOOKS*. Since
+TERMINATE-THREAD is asynchronous, getting multithreaded application
+termination with complex cleanups right using it can be tricky. To
+perform an orderly synchronous shutdown use an exit hook instead of
+relying on implicit thread termination.
+
+Consequences are unspecified if serious conditions occur during EXIT
+excepting errors from *EXIT-HOOKS*, which cause warnings and stop
+execution of the hook that signaled, but otherwise allow the exit
+process to continue normally."
+ (if (or abort *exit-in-process*)
+ (os-exit (or code 1) :abort t)
+ (let ((code (or code 0)))
+ (with-deadline (:seconds nil :override t)
+ (sb!thread:grab-mutex *exit-lock*))
+ (setf *exit-in-process* code
+ *exit-timeout* timeout)
+ (throw '%end-of-the-world t)))
+ (critically-unreachable "After trying to die in EXIT."))