;;;; DYNAMIC-USAGE and friends
(declaim (special sb!vm:*read-only-space-free-pointer*
- sb!vm:*static-space-free-pointer*))
+ sb!vm:*static-space-free-pointer*))
(eval-when (:compile-toplevel :execute)
- (sb!xc:defmacro def-c-var-frob (lisp-fun c-var-name)
- `(progn
- #!-sb-fluid (declaim (inline ,lisp-fun))
- (defun ,lisp-fun ()
- (sb!alien:extern-alien ,c-var-name (sb!alien:unsigned 32))))))
+ (sb!xc:defmacro def-c-var-fun (lisp-fun c-var-name)
+ `(defun ,lisp-fun ()
+ (sb!alien:extern-alien ,c-var-name (sb!alien:unsigned 32)))))
+#!-sb-fluid
+(declaim (inline current-dynamic-space-start))
+#!+gencgc
+(defun current-dynamic-space-start () sb!vm:dynamic-space-start)
#!-gencgc
-(progn
- ;; This is called once per PROFILEd function call, so it's worth a
- ;; little possible space cost to reduce its time cost.
- #!-sb-fluid
- (declaim (inline current-dynamic-space-start))
- (def-c-var-frob current-dynamic-space-start "current_dynamic_space"))
+(def-c-var-fun current-dynamic-space-start "current_dynamic_space")
#!-sb-fluid
-(declaim (inline dynamic-usage)) ; to reduce PROFILEd call overhead
+(declaim (inline dynamic-usage))
#!+gencgc
-(def-c-var-frob dynamic-usage "bytes_allocated")
+(def-c-var-fun dynamic-usage "bytes_allocated")
#!-gencgc
(defun dynamic-usage ()
(the (unsigned-byte 32)
(defun control-stack-usage ()
#!-stack-grows-downward-not-upward
(- (sb!sys:sap-int (sb!c::control-stack-pointer-sap))
- (sb!vm:fixnumize sb!vm:*control-stack-start*))
+ (sb!sys:sap-int (sb!di::descriptor-sap sb!vm:*control-stack-start*)))
#!+stack-grows-downward-not-upward
- (- (sb!vm:fixnumize sb!vm:*control-stack-end*)
+ (- (sb!sys:sap-int (sb!di::descriptor-sap sb!vm:*control-stack-end*))
(sb!sys:sap-int (sb!c::control-stack-pointer-sap))))
(defun binding-stack-usage ()
(- (sb!sys:sap-int (sb!c::binding-stack-pointer-sap))
- (sb!vm:fixnumize sb!vm:*binding-stack-start*)))
+ (sb!sys:sap-int (sb!di::descriptor-sap sb!vm:*binding-stack-start*))))
\f
;;;; ROOM
(format t "Control stack usage is: ~10:D bytes.~%" (control-stack-usage))
(format t "Binding stack usage is: ~10:D bytes.~%" (binding-stack-usage))
#!+sb-thread
- (format t
- "Control and binding stack usage is for the current thread only.~%")
+ (format t
+ "Control and binding stack usage is for the current thread only.~%")
(format t "Garbage collection is currently ~:[enabled~;DISABLED~].~%"
- (> *gc-inhibit* 0)))
+ *gc-inhibit*))
(defun room-intermediate-info ()
(room-minimal-info)
(sb!vm:memory-usage :count-spaces '(:dynamic)
- :print-spaces t
- :cutoff 0.05f0
- :print-summary nil))
+ :print-spaces t
+ :cutoff 0.05f0
+ :print-summary nil))
(defun room-maximal-info ()
- (room-minimal-info)
- (sb!vm:memory-usage :count-spaces '(:static :dynamic))
- (sb!vm:instance-usage :dynamic :top-n 10)
- (sb!vm:instance-usage :static :top-n 10))
+ ;; FIXME: SB!VM:INSTANCE-USAGE calls suppressed until bug 344 is fixed
+ (room-intermediate-info)
+ ;; old way, could be restored when bug 344 fixed:
+ ;;x (room-minimal-info)
+ ;;x (sb!vm:memory-usage :count-spaces '(:static :dynamic))
+ ;;x (sb!vm:instance-usage :dynamic :top-n 10)
+ ;;x (sb!vm:instance-usage :static :top-n 10)
+ )
(defun room (&optional (verbosity :default))
#!+sb-doc
;;; allocated and never freed.)
(declaim (type unsigned-byte *n-bytes-freed-or-purified*))
(defvar *n-bytes-freed-or-purified* 0)
-(push (lambda ()
- (setf *n-bytes-freed-or-purified* 0))
- ;; KLUDGE: It's probably not quite safely right either to do
- ;; this in *BEFORE-SAVE-INITIALIZATIONS* (since consing, or even
- ;; worse, something which depended on (GET-BYTES-CONSED), might
- ;; happen after that) or in *AFTER-SAVE-INITIALIZATIONS*. But
- ;; it's probably not a big problem, and there seems to be no
- ;; other obvious time to do it. -- WHN 2001-07-30
- *after-save-initializations*)
-
-(declaim (ftype (function () unsigned-byte) get-bytes-consed))
+(defun gc-reinit ()
+ (setq *gc-inhibit* nil)
+ (gc)
+ (setf *n-bytes-freed-or-purified* 0
+ *gc-run-time* 0
+ ;; See comment in interr.lisp
+ *heap-exhausted-error-condition* (make-condition 'heap-exhausted-error)))
+
+(declaim (ftype (sfunction () unsigned-byte) get-bytes-consed))
(defun get-bytes-consed ()
#!+sb-doc
"Return the number of bytes consed since the program began. Typically
\f
;;;; GC hooks
-(defvar *before-gc-hooks* nil ; actually initialized in cold init
- #!+sb-doc
- "A list of functions that are called before garbage collection occurs.
- The functions are run with interrupts disabled and all other threads
- paused. They should take no arguments.")
+(defvar *after-gc-hooks* nil
+ "Called after each garbage collection, except for garbage collections
+triggered during thread exits. In a multithreaded environment these hooks may
+run in any thread.")
-(defvar *after-gc-hooks* nil ; actually initialized in cold init
- #!+sb-doc
- "A list of functions that are called after garbage collection occurs.
- The functions are run with interrupts disabled and all other threads
- paused. They should take no arguments.")
-
-(defvar *gc-run-time* 0
- #!+sb-doc
- "the total CPU time spent doing garbage collection (as reported by
- GET-INTERNAL-RUN-TIME)")
-(declaim (type index *gc-run-time*))
-
-;;;; The following specials are used to control when garbage
-;;;; collection occurs.
-
-;;; When the dynamic usage increases beyond this amount, the system
-;;; notes that a garbage collection needs to occur by setting
-;;; *NEED-TO-COLLECT-GARBAGE* to T. It starts out as NIL meaning
-;;; nobody has figured out what it should be yet.
-;;;
-;;; FIXME: *GC-TRIGGER* seems to be denominated in bytes, not words.
-;;; And limiting it to INDEX is fairly reasonable in order to avoid
-;;; bignum arithmetic on every allocation, and to minimize the need
-;;; for thought about weird gotchas of the GC-control mechanism itself
-;;; consing as it operates. But as of sbcl-0.7.5, 512Mbytes of memory
-;;; costs $54.95 at Fry's in Dallas but cheap consumer 64-bit machines
-;;; are still over the horizon, so gratuitously limiting our heap size
-;;; to FIXNUM bytes seems fairly stupid. It'd be reasonable to
-;;; (1) allow arbitrary UNSIGNED-BYTE values of *GC-TRIGGER*, or
-;;; (2) redenominate this variable in words instead of bytes, postponing
-;;; the problem to heaps which exceed 50% of the machine's address
-;;; space, or even
-;;; (3) redemoninate this variable in CONS-sized two-word units,
-;;; allowing it to cover the entire memory space at the price of
-;;; possible loss of clarity.
-;;; (And whatever is done, it'd also be good to rename the variable so
-;;; that it's clear what unit it's denominated in.)
-(declaim (type (or index null) *gc-trigger*))
-(defvar *gc-trigger* nil)
-
-;;; When T, indicates that a GC should have happened but did not due to
-;;; *GC-INHIBIT*.
-(defvar *need-to-collect-garbage* nil) ; initialized in cold init
\f
;;;; internal GC
\f
;;;; SUB-GC
-;;; This is used to carefully invoke hooks.
-(eval-when (:compile-toplevel :execute)
- (sb!xc:defmacro carefully-funcall (function &rest args)
- `(handler-case (funcall ,function ,@args)
- (error (cond)
- (warn "(FUNCALL ~S~{ ~S~}) lost:~%~A" ',function ',args cond)
- nil))))
-
;;; SUB-GC does a garbage collection. This is called from three places:
-;;; (1) The C runtime will call here when it detects that we've consed
+;;; (1) The C runtime will call here when it detects that we've consed
;;; enough to exceed the gc trigger threshold. This is done in
;;; alloc() for gencgc or interrupt_maybe_gc() for cheneygc
;;; (2) The user may request a collection using GC, below
;;; For GENCGC all generations < GEN will be GC'ed.
-(defvar *already-in-gc*
- (sb!thread:make-mutex :name "GC lock") "ID of thread running SUB-GC")
-
-(defun sub-gc (&key (gen 0) &aux (pre-gc-dynamic-usage (dynamic-usage)))
- (let ((me (sb!thread:current-thread-id)))
- (when (eql (sb!thread::mutex-value *already-in-gc*) me)
- (return-from sub-gc nil))
- (setf *need-to-collect-garbage* t)
- (when (zerop *gc-inhibit*)
- (loop
- (sb!thread:with-mutex (*already-in-gc*)
- (unless *need-to-collect-garbage* (return-from sub-gc nil))
- (without-interrupts
- (gc-stop-the-world)
- (collect-garbage gen)
- (incf *n-bytes-freed-or-purified*
- (max 0 (- pre-gc-dynamic-usage (dynamic-usage))))
- (scrub-control-stack)
- (setf *need-to-collect-garbage* nil)
- (dolist (h *after-gc-hooks*) (carefully-funcall h))
- (gc-start-the-world)))))))
+(defvar *already-in-gc* (sb!thread:make-mutex :name "GC lock"))
+
+;;; A unique GC id. This is supplied for code that needs to detect
+;;; whether a GC has happened since some earlier point in time. For
+;;; example:
+;;;
+;;; (let ((epoch *gc-epoch*))
+;;; ...
+;;; (unless (eql epoch *gc-epoch)
+;;; ....))
+;;;
+;;; This isn't just a fixnum counter since then we'd have theoretical
+;;; problems when exactly 2^29 GCs happen between epoch
+;;; comparisons. Unlikely, but the cost of using a cons instead is too
+;;; small to measure. -- JES, 2007-09-30
+(declaim (type cons *gc-epoch*))
+(defvar *gc-epoch* (cons nil nil))
+
+(defun sub-gc (&key (gen 0))
+ (cond (*gc-inhibit*
+ (setf *gc-pending* t)
+ nil)
+ (t
+ (without-interrupts
+ (setf *gc-pending* :in-progress)
+ ;; Tricks to to prevent triggerring a recursive gc. This is
+ ;; like a WITHOUT-GCING inside the lock except that we
+ ;; cannot call MAYBE-HANDLE-PENDING-GC at the end, because
+ ;; that would lead to a recursive attempt on the lock. In
+ ;; case you are wondering, wrapping the lock in a
+ ;; WITHOUT-GCING would also deadlock. The
+ ;; *IN-WITHOUT-GCING* part is used to tell the runtime that
+ ;; it's ok to have a pending gc even though *GC-INHIBIT* is
+ ;; NIL.
+ ;;
+ ;; Now, if GET-MUTEX did not cons, that would be enough.
+ ;; Because it does, we need the :IN-PROGRESS bit above to
+ ;; tell the runtime not to trigger gcs.
+ (let ((sb!impl::*in-without-gcing* t))
+ (sb!thread:with-mutex (*already-in-gc*)
+ (let ((*gc-inhibit* t))
+ (let ((old-usage (dynamic-usage))
+ (new-usage 0))
+ (unsafe-clear-roots)
+ (gc-stop-the-world)
+ (let ((start-time (get-internal-run-time)))
+ (collect-garbage gen)
+ (setf *gc-epoch* (cons nil nil))
+ (incf *gc-run-time*
+ (- (get-internal-run-time) start-time)))
+ (setf *gc-pending* nil
+ new-usage (dynamic-usage))
+ #!+sb-thread
+ (assert (not *stop-for-gc-pending*))
+ (gc-start-the-world)
+ ;; In a multithreaded environment the other threads
+ ;; will see *n-b-f-o-p* change a little late, but
+ ;; that's OK.
+ (let ((freed (- old-usage new-usage)))
+ ;; GENCGC occasionally reports negative here, but
+ ;; the current belief is that it is part of the
+ ;; normal order of things and not a bug.
+ (when (plusp freed)
+ (incf *n-bytes-freed-or-purified* freed)))))))
+ ;; While holding the mutex we were protected from
+ ;; SIG_STOP_FOR_GC and recursive GCs. Now, in order to
+ ;; preserve the invariant (*GC-PENDING* ->
+ ;; pseudo-atomic-interrupted or *GC-INHIBIT*), let's check
+ ;; explicitly for a pending gc before interrupts are
+ ;; enabled again.
+ (maybe-handle-pending-gc))
+ t)))
+
+(defun post-gc ()
+ ;; Outside the mutex, interrupts may be enabled: these may cause
+ ;; another GC. FIXME: it can potentially exceed maximum interrupt
+ ;; nesting by triggering GCs.
+ ;;
+ ;; Can that be avoided by having the finalizers and hooks run only
+ ;; from the outermost SUB-GC? If the nested GCs happen in interrupt
+ ;; handlers that's not enough.
+ ;;
+ ;; KLUDGE: Don't run the hooks in GC's if:
+ ;;
+ ;; A) this thread is dying, so that user-code never runs with
+ ;; (thread-alive-p *current-thread*) => nil
+ ;;
+ ;; B) interrupts are disabled somewhere up the call chain since we
+ ;; don't want to run user code in such a case.
+ ;;
+ ;; The long-term solution will be to keep a separate thread for
+ ;; finalizers and after-gc hooks.
+ (when (sb!thread:thread-alive-p sb!thread:*current-thread*)
+ (when *allow-with-interrupts*
+ (with-interrupts
+ (run-pending-finalizers)
+ (call-hooks "after-GC" *after-gc-hooks* :on-error :warn)))))
;;; This is the user-advertised garbage collection function.
(defun gc (&key (gen 0) (full nil) &allow-other-keys)
#!+(and sb-doc (not gencgc))
"Initiate a garbage collection. GEN may be provided for compatibility with
generational garbage collectors, but is ignored in this implementation."
- (sub-gc :gen (if full 6 gen)))
+ (when (sub-gc :gen (if full 6 gen))
+ (post-gc)))
+
+(defun unsafe-clear-roots ()
+ ;; KLUDGE: Do things in an attempt to get rid of extra roots. Unsafe
+ ;; as having these cons more then we have space left leads to huge
+ ;; badness.
+ (scrub-control-stack)
+ ;; Power cache of the bignum printer: drops overly large bignums and
+ ;; removes duplicate entries.
+ (scrub-power-cache)
+ ;; FIXME: CTYPE-OF-CACHE-CLEAR isn't thread-safe.
+ #!-sb-thread
+ (ctype-of-cache-clear))
\f
;;;; auxiliary functions
"Return the amount of memory that will be allocated before the next garbage
collection is initiated. This can be set with SETF."
(sb!alien:extern-alien "bytes_consed_between_gcs"
- (sb!alien:unsigned 32)))
+ (sb!alien:unsigned 32)))
(defun (setf bytes-consed-between-gcs) (val)
(declare (type index val))
(setf (sb!alien:extern-alien "bytes_consed_between_gcs"
- (sb!alien:unsigned 32))
- val))
-
-(defun gc-on ()
- #!+sb-doc
- "Enable the garbage collector."
- (setq *gc-inhibit* 0)
- (when *need-to-collect-garbage*
- (sub-gc))
- nil)
-
-(defun gc-off ()
- #!+sb-doc
- "Disable the garbage collector."
- (setq *gc-inhibit* 1)
- nil)
-
+ (sb!alien:unsigned 32))
+ val))
+
+(declaim (inline maybe-handle-pending-gc))
+(defun maybe-handle-pending-gc ()
+ (when (and (not *gc-inhibit*)
+ (or #!+sb-thread *stop-for-gc-pending*
+ *gc-pending*))
+ (sb!unix::receive-pending-interrupt)))