0.9.5.58:
[sbcl.git] / src / code / hash-table.lisp
1 ;;;; the needed-on-the-cross-compilation-host part of HASH-TABLE
2 ;;;; implementation
3
4 ;;;; This software is part of the SBCL system. See the README file for
5 ;;;; more information.
6 ;;;;
7 ;;;; This software is derived from the CMU CL system, which was
8 ;;;; written at Carnegie Mellon University and released into the
9 ;;;; public domain. The software is in the public domain and is
10 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
11 ;;;; files for more information.
12
13 (in-package "SB!IMPL")
14
15 ;;; HASH-TABLE is implemented as a STRUCTURE-OBJECT.
16 (sb!xc:defstruct (hash-table (:constructor %make-hash-table))
17   ;; The type of hash table this is. Only used for printing and as
18   ;; part of the exported interface.
19   (test (missing-arg) :type symbol :read-only t)
20   ;; The function used to compare two keys. Returns T if they are the
21   ;; same and NIL if not.
22   (test-fun (missing-arg) :type function :read-only t)
23   ;; The function used to compute the hashing of a key. Returns two
24   ;; values: the index hashing and T if that might change with the
25   ;; next GC.
26   (hash-fun (missing-arg) :type function :read-only t)
27   ;; how much to grow the hash table by when it fills up. If an index,
28   ;; then add that amount. If a floating point number, then multiply
29   ;; it by that.
30   (rehash-size (missing-arg) :type (or index (single-float (1.0)))
31                :read-only t)
32   ;; how full the hash table has to get before we rehash
33   (rehash-threshold (missing-arg) :type (single-float (0.0) 1.0) :read-only t)
34   ;; The number of entries before a rehash, just one less than the
35   ;; size of the next-vector, hash-vector, and half the size of the
36   ;; kv-vector.
37   (rehash-trigger (missing-arg) :type index)
38   ;; The current number of entries in the table.
39   (number-entries 0 :type index)
40   ;; The Key-Value pair vector.
41   (table (missing-arg) :type simple-vector)
42   ;; True if this is a weak hash table, meaning that key->value
43   ;; mappings will disappear if there are no other references to the
44   ;; key. Note: this only matters if the hash function indicates that
45   ;; the hashing is EQ based.
46   (weak-p nil :type (member t nil))
47   ;; Index into the next-vector, chaining together buckets that need
48   ;; to be rehashed because their hashing is EQ based and the key has
49   ;; been moved by the garbage collector.
50   (needing-rehash 0 :type index)
51   ;; Index into the Next vector chaining together free slots in the KV
52   ;; vector.
53   (next-free-kv 0 :type index)
54   ;; A cache that is either nil or is an index into the hash table
55   ;; that should be checked first
56   (cache nil :type (or null index))
57   ;; The index vector. This may be larger than the hash size to help
58   ;; reduce collisions.
59   (index-vector (missing-arg)
60                 :type (simple-array (unsigned-byte #.sb!vm:n-word-bits) (*)))
61   ;; This table parallels the KV vector, and is used to chain together
62   ;; the hash buckets, the free list, and the values needing rehash, a
63   ;; slot will only ever be in one of these lists.
64   (next-vector (missing-arg)
65                :type (simple-array (unsigned-byte #.sb!vm:n-word-bits) (*)))
66   ;; This table parallels the KV table, and can be used to store the
67   ;; hash associated with the key, saving recalculation. Could be
68   ;; useful for EQL, and EQUAL hash tables. This table is not needed
69   ;; for EQ hash tables, and when present the value of
70   ;; +MAGIC-HASH-VECTOR-VALUE+ represents EQ-based hashing on the
71   ;; respective key.
72   (hash-vector nil :type (or null (simple-array (unsigned-byte
73                                                  #.sb!vm:n-word-bits) (*)))))
74
75 ;; as explained by pmai on openprojects #lisp IRC 2002-07-30: #x80000000
76 ;; is bigger than any possible nonEQ hash value, and thus indicates an
77 ;; empty slot; and EQ hash tables don't use HASH-TABLE-HASH-VECTOR.
78 ;; The previous sentence was written when SBCL was 32-bit only. The value
79 ;; now depends on the word size. It is propagated to C in genesis because
80 ;; the generational garbage collector needs to know it.
81 (defconstant +magic-hash-vector-value+ (ash 1 (1- sb!vm:n-word-bits)))
82
83 \f
84 (defmacro-mundanely with-hash-table-iterator ((function hash-table) &body body)
85   #!+sb-doc
86   "WITH-HASH-TABLE-ITERATOR ((function hash-table) &body body)
87    provides a method of manually looping over the elements of a hash-table.
88    FUNCTION is bound to a generator-macro that, within the scope of the
89    invocation, returns one or three values. The first value tells whether
90    any objects remain in the hash table. When the first value is non-NIL,
91    the second and third values are the key and the value of the next object."
92   (let ((n-function (gensym "WITH-HASH-TABLE-ITERATOR-")))
93     `(let ((,n-function
94             (let* ((table ,hash-table)
95                    (length (length (hash-table-next-vector table)))
96                    (index 1))
97               (declare (type (mod #.(floor most-positive-fixnum 2)) index))
98               (labels
99                   ((,function ()
100                      ;; (We grab the table again on each iteration just in
101                      ;; case it was rehashed by a PUTHASH.)
102                      (let ((kv-vector (hash-table-table table)))
103                        (do ()
104                            ((>= index length) (values nil))
105                          (let ((key (aref kv-vector (* 2 index)))
106                                (value (aref kv-vector (1+ (* 2 index)))))
107                            (incf index)
108                            (unless (and (eq key +empty-ht-slot+)
109                                         (eq value +empty-ht-slot+))
110                              (return (values t key value))))))))
111                 #',function))))
112       (macrolet ((,function () '(funcall ,n-function)))
113         ,@body))))