Merge branch 'master' into boehm-demers-weiser-gc
[bpt/guile.git] / test-suite / tests / guardians.test
index 342568a..e6a4203 100644 (file)
@@ -1,7 +1,7 @@
 ;;;; guardians.test --- test suite for Guile Guardians     -*- scheme -*-
 ;;;; Jim Blandy <jimb@red-bean.com> --- July 1999
 ;;;;
-;;;;   Copyright (C) 1999, 2001 Free Software Foundation, Inc.
+;;;;   Copyright (C) 1999, 2001, 2006 Free Software Foundation, Inc.
 ;;;; 
 ;;;; This program is free software; you can redistribute it and/or modify
 ;;;; it under the terms of the GNU General Public License as published by
@@ -15,8 +15,8 @@
 ;;;; 
 ;;;; You should have received a copy of the GNU General Public License
 ;;;; along with this software; see the file COPYING.  If not, write to
-;;;; the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
-;;;; Boston, MA 02111-1307 USA
+;;;; the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;;;; Boston, MA 02110-1301 USA
 
 ;;; These tests make some questionable assumptions.
 ;;; - They assume that a GC will find all dead objects, so they
@@ -25,7 +25,8 @@
 ;;;   they explicitly invoke GC --- in other words, they assume that GC
 ;;;   won't happen too often.
 
-(use-modules (ice-9 documentation)
+(use-modules (test-suite lib)
+            (ice-9 documentation)
              (ice-9 weak-vector))
 
 
 (gc)
 
 ;;; Who guards the guardian?
+
+;;; Note: We use strings rather than symbols because symbols are usually
+;;; ``interned'', i.e., kept in a weakly-keyed hash table, thus making them
+;;; inappropriate for the tests below.  Furthermore, we use `string-copy' in
+;;; order to make sure that no string is kept around in the interpreter
+;;; unwillingly (e.g., in the source-property weak hash table).
+
 (gc)
 (define g2 (make-guardian))
-(g2 (list 'g2-garbage))
+(g2 (list (string-copy "g2-garbage")))
 (define g3 (make-guardian))
-(g3 (list 'g3-garbage))
+(g3 (list (string-copy "g3-garbage")))
 (g3 g2)
 (pass-if "g2-garbage not collected yet" (equal? (g2) #f))
 (pass-if "g3-garbage not collected yet" (equal? (g3) #f))
       (if saved
          (begin
            (cond
-            ((equal? saved '(g3-garbage)) (set! seen-g3-garbage #t))
+            ((equal? saved (list (string-copy "g3-garbage")))
+             (set! seen-g3-garbage #t))
             ((procedure? saved) (set! seen-g2 saved))
-            (else (set! seen-something-else #t)))
+            (else (pk 'junk saved) (set! seen-something-else #t)))
            (loop)))))
-  (pass-if "g3-garbage saved" seen-g3-garbage)
-  (pass-if "g2-saved" (procedure? seen-g2))
+  (pass-if "g3-garbage saved" (or seen-g3-garbage (throw 'unresolved)))
+  (pass-if "g2-saved" (or (procedure? seen-g2) (throw 'unresolved)))
   (pass-if "nothing else saved" (not seen-something-else))
-  (pass-if "g2-garbage saved" (and (procedure? seen-g2)
-                                  (equal? (seen-g2) '(g2-garbage)))))
+  (pass-if "g2-garbage saved" (or (and (procedure? seen-g2)
+                                      (equal? (seen-g2)
+                                              (list (string-copy
+                                                     "g2-garbage"))))
+                                 (throw 'unresolved))))
 
 (with-test-prefix "standard guardian functionality"
 
                  (throw 'unresolved)
                  (eq? (g) #f))))))
 
-    (pass-if "guarded element of weak vector gets removed from weak vector"
-      ;; How should this be handled?  Should weak objects be removed from
-      ;; their containers before they become zombies?  Let's take a look at
-      ;; the possible scenarios:  a) Weak objects that are also guarded are
-      ;; not removed from their containers as long as they are guarded.
-      ;; However, they still can become zombies.  The consequence is, that the
-      ;; object can be retrieved from its container, thus being alive, while
-      ;; on the other hand it can at the same time be retrieved from a
-      ;; guardian.  This is unfortunate, since when retrieving an object from
-      ;; a guardian one would not expect any other reference to the object.
-      ;; b) Weak objects are removed from their containers if they are not
-      ;; referenced any more or if the only references are from guardians.
-      ;; That means that it is guaranteed that there are no other references
-      ;; to an object that is retrieved from a guardian.  However, this means
-      ;; that there is no chance to update containers like weak hash tables
-      ;; using the information that one of their contained objects will be
-      ;; removed.  It may be however, that this is not necessary anyway.
+    (pass-if "guarded element of weak vector gets eventually removed from weak vector"
       (let ((g (make-guardian))
            (v (weak-vector #f)))
        (gc)
        (let ((p (cons #f #f)))
          (g p)
          (vector-set! v 0 p))
-       (if (not (equal? (vector-ref v 0) (cons #f #f)))
-           (throw 'unresolved)
-           (begin
-             (gc)
-             (if (equal? (vector-ref v 0) (cons #f #f))
-                 (throw 'unresolved)
-                 #t))))))
+       (begin
+         (gc)
+         (if (not (equal? (g) (cons #f #f)))
+             (throw 'unresolved)
+             (begin
+               (gc)
+               (or (not (vector-ref v 0))
+                   (throw 'unresolved))))))))
 
   (with-test-prefix "guarding weak containers"
 
            #t))))
 
   (with-test-prefix "guarding guardians"
-    #t))
-
-(with-test-prefix "guile guardian functionality"
+    #t)
 
   (with-test-prefix "guarding dependent objects"
 
-    (pass-if "guarding vector and element"
-      (let ((g (make-guardian)))
-       (gc)
-       (let ((p (cons #f #f)))
-         (g p)
-         (g (vector p)))
-       (if (not (eq? (g) #f))
-           (throw 'unresolved)
-           (begin
-             (gc)
-             (if (not (equal? (g) (vector (cons #f #f))))
-                 (throw 'unresolved)
-                 (if (not (eq? (g) #f))
+    ;; We don't make any guarantees about the order objects are
+    ;; returned from guardians and therefore we skip the following
+    ;; test.
+
+    (if #f
+       (pass-if "guarding vector and element"
+          (let ((g (make-guardian)))
+           (gc)
+           (let ((p (cons #f #f)))
+             (g p)
+             (g (vector p)))
+           (if (not (eq? (g) #f))
+               (throw 'unresolved)
+               (begin
+                 (gc)
+                 (if (not (equal? (g) (vector (cons #f #f))))
                      (throw 'unresolved)
-                     (begin
-                       (gc)
-                       (if (not (equal? (g) (cons #f #f)))
-                           (throw 'unresolved)
-                           (eq? (g) #f)))))))))
-
-    )
+                     (if (not (eq? (g) #f))
+                         (throw 'unresolved)
+                         (begin
+                           (gc)
+                           (if (not (equal? (g) (cons #f #f)))
+                               (throw 'unresolved)
+                               (eq? (g) #f)))))))))))
 
   (with-test-prefix "guarding objects more than once"
-    #t)
+
+    (pass-if "guarding twice in one guardian"
+       (let ((g (make-guardian)))
+        (gc)
+        (let ((p (cons #f #f)))
+          (g p)
+          (g p))
+        (if (not (eq? (g) #f))
+            (throw 'unresolved)
+            (begin
+              (gc)
+              (or (and (and=> (g) (lambda (o) (equal? o (cons #f #f))))
+                       (and=> (g) (lambda (o) (equal? o (cons #f #f)))))
+                  (throw 'unresolved))))))
+
+    (pass-if "guarding twice in two guardians"
+       (let ((g (make-guardian))
+            (h (make-guardian)))
+        (gc)
+        (let ((p (cons #f #f)))
+          (g p)
+          (h p))
+        (if (not (eq? (g) #f))
+            (throw 'unresolved)
+            (begin
+              (gc)
+              (or (and (and=> (g) (lambda (o) (equal? o (cons #f #f))))
+                       (and=> (h) (lambda (o) (equal? o (cons #f #f)))))
+                  (throw 'unresolved)))))))
 
   (with-test-prefix "guarding cyclic dependencies"
     #t)