Structural Informatics Group (SIG) logo
Home | Projects | Demos | Downloads | Publications | Local Info | About Us | New site
Go to the first, previous, next, last section, table of contents.

*gc-hook*

*gc-hook*

type: system variable 
location: built-in
source file: xldmem.c
Common LISP compatible: no
supported on: all machines

SYNTAX

*gc-hook*

DESCRIPTION

*GC-HOOK* is a system variable that allows a user function to be performed everytime garbage is collected (either explicitly with GC or automatically). The default value for *GC-HOOK* is NIL. When *GC-HOOK* is set to a non-NIL symbol, it is enabled to execute the specified user routine. The user routine can be a quoted symbol or a closure. There are two parameters to the user routine - the total number of nodes and current free nodes after the garbage collection.

EXAMPLES

*gc-hook*                               ; returns NIL
(gc)                                    ; returns NIL
(defun mygchook (&rest stuff)           ; define the hook 
        (print stuff)                   ;
        (print "my hook"))              ;
(setq *gc-hook* 'mygchook)              ; set up *GC-HOOK*
(gc)                                    ; prints (2640 232)
                                        ;        "my hook"
                                        ; returns NIL
(setq *gc-flag* T)                      ; turn on the system GC message
(gc)                                    ; prints 
                                        ;   [ gc: total 2640, (2640 241)
                                        ;   "my hook"
                                        ;   236 free ]
                                        ; returns NIL
(setq *gc-flag* NIL)                    ; turn off GC message   
(setq *gc-hook* (lambda (x y)           ; enable user routine
                    (princ "\007")))    ;   that beeps at every GC
(gc)                                    ; beeps
(defun expand-on-gc (total free)        ; define EXPAND-ON-GC
  (if (< (/ free 1.0 total) .1)         ; IF free/total < .10
      (progn (expand 2)                 ;    THEN expand memory
             (princ "\007") )           ;         and beep
      )                                 ;    ELSE do nothing
  )                                     ; NOTE: XLISP already gets more
                                        ;       nodes automatically,
                                        ;       this is just an example.
(setq *gc-hook* 'expand-on-gc)          ; enable EXPAND-ON-GC
(gc)                                    ; beeps when low on nodes

NOTE: The *GC-HOOK* and *GC-FLAG* facilities can interact. If you do printing in the *GC-HOOK* user form and enable *GC-FLAG*, the *GC-HOOK* printing will come out in the middle of the *GC-FLAG* message.

NOTE: The *GC-HOOK* user form is evaluated after the execution of the actual garbage collection code. This means that if the user form causes an error, it does not prevent a garbage collection.

NOTE: Since *GC-HOOK* is set to a symbol, the user defined form can be changed by doing another DEFUN (or whatever) to the symbol in *GC-HOOK*. Note also that you should define the symbol first and then set *GC-HOOK* to the symbol. If you don't, an automatic garbage collection might occur before you set *GC-HOOK* - generating an error and stopping your program.


Go to the first, previous, next, last section, table of contents.