1 ;;;; garbage collection and allocation-related code
3 ;;;; This software is part of the SBCL system. See the README file for
6 ;;;; This software is derived from the CMU CL system, which was
7 ;;;; written at Carnegie Mellon University and released into the
8 ;;;; public domain. The software is in the public domain and is
9 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
10 ;;;; files for more information.
12 (in-package "SB!KERNEL")
14 ;;;; DYNAMIC-USAGE and friends
16 (declaim (special sb
!vm
:*read-only-space-free-pointer
*
17 sb
!vm
:*static-space-free-pointer
*))
19 (eval-when (:compile-toplevel
:execute
)
20 (sb!xc
:defmacro def-c-var-fun
(lisp-fun c-var-name
)
22 (sb!alien
:extern-alien
,c-var-name
(sb!alien
:unsigned
32)))))
25 (declaim (inline current-dynamic-space-start
))
27 (defun current-dynamic-space-start () sb
!vm
:dynamic-space-start
)
29 (def-c-var-fun current-dynamic-space-start
"current_dynamic_space")
32 (declaim (inline dynamic-usage
))
34 (def-c-var-fun dynamic-usage
"bytes_allocated")
36 (defun dynamic-usage ()
37 (the (unsigned-byte 32)
38 (- (sb!sys
:sap-int
(sb!c
::dynamic-space-free-pointer
))
39 (current-dynamic-space-start))))
41 (defun static-space-usage ()
42 (- (* sb
!vm
:*static-space-free-pointer
* sb
!vm
:n-word-bytes
)
43 sb
!vm
:static-space-start
))
45 (defun read-only-space-usage ()
46 (- (* sb
!vm
::*read-only-space-free-pointer
* sb
!vm
:n-word-bytes
)
47 sb
!vm
:read-only-space-start
))
49 (defun control-stack-usage ()
50 #!-stack-grows-downward-not-upward
51 (- (sb!sys
:sap-int
(sb!c
::control-stack-pointer-sap
))
52 (sb!vm
:fixnumize sb
!vm
:*control-stack-start
*))
53 #!+stack-grows-downward-not-upward
54 (- (sb!vm
:fixnumize sb
!vm
:*control-stack-end
*)
55 (sb!sys
:sap-int
(sb!c
::control-stack-pointer-sap
))))
57 (defun binding-stack-usage ()
58 (- (sb!sys
:sap-int
(sb!c
::binding-stack-pointer-sap
))
59 (sb!vm
:fixnumize sb
!vm
:*binding-stack-start
*)))
63 (defun room-minimal-info ()
64 (format t
"Dynamic space usage is: ~10:D bytes.~%" (dynamic-usage))
65 (format t
"Read-only space usage is: ~10:D bytes.~%" (read-only-space-usage))
66 (format t
"Static space usage is: ~10:D bytes.~%" (static-space-usage))
67 (format t
"Control stack usage is: ~10:D bytes.~%" (control-stack-usage))
68 (format t
"Binding stack usage is: ~10:D bytes.~%" (binding-stack-usage))
71 "Control and binding stack usage is for the current thread only.~%")
72 (format t
"Garbage collection is currently ~:[enabled~;DISABLED~].~%"
75 (defun room-intermediate-info ()
77 (sb!vm
:memory-usage
:count-spaces
'(:dynamic
)
82 (defun room-maximal-info ()
83 ;; FIXME: SB!VM:INSTANCE-USAGE calls suppressed until bug 344 is fixed
84 (room-intermediate-info)
85 ;; old way, could be restored when bug 344 fixed:
86 ;;x (room-minimal-info)
87 ;;x (sb!vm:memory-usage :count-spaces '(:static :dynamic))
88 ;;x (sb!vm:instance-usage :dynamic :top-n 10)
89 ;;x (sb!vm:instance-usage :static :top-n 10)
92 (defun room (&optional
(verbosity :default
))
94 "Print to *STANDARD-OUTPUT* information about the state of internal
95 storage and its management. The optional argument controls the
96 verbosity of output. If it is T, ROOM prints out a maximal amount of
97 information. If it is NIL, ROOM prints out a minimal amount of
98 information. If it is :DEFAULT or it is not supplied, ROOM prints out
99 an intermediate amount of information."
107 (room-intermediate-info)))
110 ;;;; GET-BYTES-CONSED
112 ;;; the total number of bytes freed so far (including any freeing
113 ;;; which goes on in PURIFY)
115 ;;; (We save this so that we can calculate the total number of bytes
116 ;;; ever allocated by adding this to the number of bytes currently
117 ;;; allocated and never freed.)
118 (declaim (type unsigned-byte
*n-bytes-freed-or-purified
*))
119 (defvar *n-bytes-freed-or-purified
* 0)
123 (setf *n-bytes-freed-or-purified
* 0))
125 (declaim (ftype (function () unsigned-byte
) get-bytes-consed
))
126 (defun get-bytes-consed ()
128 "Return the number of bytes consed since the program began. Typically
129 this result will be a consed bignum, so if you have an application (e.g.
130 profiling) which can't tolerate the overhead of consing bignums, you'll
131 probably want either to hack in at a lower level (as the code in the
132 SB-PROFILE package does), or to design a more microefficient interface
133 and submit it as a patch."
135 *n-bytes-freed-or-purified
*))
139 (defvar *after-gc-hooks
* nil
140 "Called after each garbage collection. In a multithreaded
141 environment these hooks may run in any thread.")
143 ;;;; The following specials are used to control when garbage
144 ;;;; collection occurs.
146 ;;; When the dynamic usage increases beyond this amount, the system
147 ;;; notes that a garbage collection needs to occur by setting
148 ;;; *NEED-TO-COLLECT-GARBAGE* to T. It starts out as NIL meaning
149 ;;; nobody has figured out what it should be yet.
151 ;;; FIXME: *GC-TRIGGER* seems to be denominated in bytes, not words.
152 ;;; And limiting it to INDEX is fairly reasonable in order to avoid
153 ;;; bignum arithmetic on every allocation, and to minimize the need
154 ;;; for thought about weird gotchas of the GC-control mechanism itself
155 ;;; consing as it operates. But as of sbcl-0.7.5, 512Mbytes of memory
156 ;;; costs $54.95 at Fry's in Dallas but cheap consumer 64-bit machines
157 ;;; are still over the horizon, so gratuitously limiting our heap size
158 ;;; to FIXNUM bytes seems fairly stupid. It'd be reasonable to
159 ;;; (1) allow arbitrary UNSIGNED-BYTE values of *GC-TRIGGER*, or
160 ;;; (2) redenominate this variable in words instead of bytes, postponing
161 ;;; the problem to heaps which exceed 50% of the machine's address
163 ;;; (3) redemoninate this variable in CONS-sized two-word units,
164 ;;; allowing it to cover the entire memory space at the price of
165 ;;; possible loss of clarity.
166 ;;; (And whatever is done, it'd also be good to rename the variable so
167 ;;; that it's clear what unit it's denominated in.)
168 (declaim (type (or index null
) *gc-trigger
*))
169 (defvar *gc-trigger
* nil
)
171 ;;; When T, indicates that a GC should have happened but did not due to
173 (defvar *need-to-collect-garbage
* nil
) ; initialized in cold init
177 (sb!alien
:define-alien-routine collect-garbage sb
!alien
:int
178 (#!+gencgc last-gen
#!-gencgc ignore sb
!alien
:int
))
182 (sb!alien
:define-alien-routine gc-stop-the-world sb
!alien
:void
)
183 (sb!alien
:define-alien-routine gc-start-the-world sb
!alien
:void
))
186 (defun gc-stop-the-world ())
187 (defun gc-start-the-world ()))
192 ;;; SUB-GC does a garbage collection. This is called from three places:
193 ;;; (1) The C runtime will call here when it detects that we've consed
194 ;;; enough to exceed the gc trigger threshold. This is done in
195 ;;; alloc() for gencgc or interrupt_maybe_gc() for cheneygc
196 ;;; (2) The user may request a collection using GC, below
197 ;;; (3) At the end of a WITHOUT-GCING section, we are called if
198 ;;; *NEED-TO-COLLECT-GARBAGE* is true
200 ;;; This is different from the behaviour in 0.7 and earlier: it no
201 ;;; longer decides whether to GC based on thresholds. If you call
202 ;;; SUB-GC you will definitely get a GC either now or when the
203 ;;; WITHOUT-GCING is over
205 ;;; For GENCGC all generations < GEN will be GC'ed.
207 (defvar *already-in-gc
*
208 (sb!thread
:make-mutex
:name
"GC lock") "ID of thread running SUB-GC")
210 (defun sub-gc (&key
(gen 0))
211 (unless (eql (sb!thread
:current-thread-id
)
212 (sb!thread
::mutex-value
*already-in-gc
*))
213 ;; With gencgc, unless *NEED-TO-COLLECT-GARBAGE* every allocation
214 ;; in this function triggers another gc, potentially exceeding
215 ;; maximum interrupt nesting.
216 (setf *need-to-collect-garbage
* t
)
217 (when (zerop *gc-inhibit
*)
218 (sb!thread
:with-mutex
(*already-in-gc
*)
219 (let ((old-usage (dynamic-usage))
222 ;; We need to disable interrupts for GC, but we also want
223 ;; to run as little as possible without them.
226 (collect-garbage gen
)
227 (setf *need-to-collect-garbage
* nil
228 new-usage
(dynamic-usage))
229 (gc-start-the-world))
230 ;; Interrupts re-enabled, but still inside the mutex.
231 ;; In a multithreaded environment the other threads will
232 ;; see *n-b-f-o-p* change a little late, but that's OK.
233 (let ((freed (- old-usage new-usage
)))
234 ;; GENCGC occasionally reports negative here, but the
235 ;; current belief is that it is part of the normal order
236 ;; of things and not a bug.
238 (incf *n-bytes-freed-or-purified
* freed
)))
239 (sb!thread
::reap-dead-threads
)))
240 ;; Outside the mutex, these may cause another GC. FIXME: it can
241 ;; potentially exceed maximum interrupt nesting by triggering
243 (run-pending-finalizers)
244 (dolist (hook *after-gc-hooks
*)
248 (warn "Error calling after GC hook ~S:~% ~S" hook c
)))))))
250 ;;; This is the user-advertised garbage collection function.
251 (defun gc (&key
(gen 0) (full nil
) &allow-other-keys
)
252 #!+(and sb-doc gencgc
)
253 "Initiate a garbage collection. GEN controls the number of generations
255 #!+(and sb-doc
(not gencgc
))
256 "Initiate a garbage collection. GEN may be provided for compatibility with
257 generational garbage collectors, but is ignored in this implementation."
258 (sub-gc :gen
(if full
6 gen
)))
260 (defun unsafe-clear-roots ()
261 ;; KLUDGE: Do things in an attempt to get rid of extra roots. Unsafe
262 ;; as having these cons more then we have space left leads to huge
264 (scrub-control-stack)
265 ;; FIXME: CTYPE-OF-CACHE-CLEAR isn't thread-safe.
267 (ctype-of-cache-clear))
270 ;;;; auxiliary functions
272 (defun bytes-consed-between-gcs ()
274 "Return the amount of memory that will be allocated before the next garbage
275 collection is initiated. This can be set with SETF."
276 (sb!alien
:extern-alien
"bytes_consed_between_gcs"
277 (sb!alien
:unsigned
32)))
279 (defun (setf bytes-consed-between-gcs
) (val)
280 (declare (type index val
))
281 (setf (sb!alien
:extern-alien
"bytes_consed_between_gcs"
282 (sb!alien
:unsigned
32))
285 ;;; FIXME: Aren't these utterly wrong if called inside WITHOUT-GCING?
286 ;;; Unless something that works there too can be deviced this fact
287 ;;; should be documented.
290 "Enable the garbage collector."
291 (setq *gc-inhibit
* 0)
292 (when *need-to-collect-garbage
*
298 "Disable the garbage collector."
299 (setq *gc-inhibit
* 1)