Fix typos in docstrings and function names.
[sbcl.git] / src / code / hash-table.lisp
index 5eb7a3c..c7afa7e 100644 (file)
   ;; values: the index hashing and T if that might change with the
   ;; next GC.
   (hash-fun (missing-arg) :type function :read-only t)
-  ;; how much to grow the hash table by when it fills up. If an index,
+  ;; How much to grow the hash table by when it fills up. If an index,
   ;; then add that amount. If a floating point number, then multiply
   ;; it by that.
   (rehash-size (missing-arg) :type (or index (single-float (1.0)))
                :read-only t)
-  ;; how full the hash table has to get before we rehash
+  ;; How full the hash table has to get before we rehash
   (rehash-threshold (missing-arg) :type (single-float (0.0) 1.0) :read-only t)
   ;; The number of entries before a rehash, just one less than the
   ;; size of the next-vector, hash-vector, and half the size of the
   (cache nil :type (or null index))
   ;; The index vector. This may be larger than the hash size to help
   ;; reduce collisions.
-  (index-vector (missing-arg)
-                :type (simple-array (unsigned-byte #.sb!vm:n-word-bits) (*)))
+  (index-vector (missing-arg) :type (simple-array sb!vm:word (*)))
   ;; This table parallels the KV vector, and is used to chain together
   ;; the hash buckets and the free list. A slot will only ever be in
   ;; one of these lists.
-  (next-vector (missing-arg)
-               :type (simple-array (unsigned-byte #.sb!vm:n-word-bits) (*)))
+  (next-vector (missing-arg) :type (simple-array sb!vm:word (*)))
   ;; This table parallels the KV table, and can be used to store the
   ;; hash associated with the key, saving recalculation. Could be
   ;; useful for EQL, and EQUAL hash tables. This table is not needed
   ;; for EQ hash tables, and when present the value of
   ;; +MAGIC-HASH-VECTOR-VALUE+ represents EQ-based hashing on the
   ;; respective key.
-  (hash-vector nil :type (or null (simple-array (unsigned-byte
-                                                 #.sb!vm:n-word-bits) (*))))
+  (hash-vector nil :type (or null (simple-array sb!vm:word (*))))
   ;; Used for locking GETHASH/(SETF GETHASH)/REMHASH
-  (spinlock (sb!thread::make-spinlock :name "hash-table lock")
-            :type sb!thread::spinlock :read-only t)
+  (lock (sb!thread:make-mutex :name "hash-table lock")
+        :type sb!thread:mutex :read-only t)
   ;; The GC will set this to T if it moves an EQ-based key. This used
   ;; to be signaled by a bit in the header of the kv vector, but that
   ;; implementation caused some concurrency issues when we stopped
 ;; the generational garbage collector needs to know it.
 (defconstant +magic-hash-vector-value+ (ash 1 (1- sb!vm:n-word-bits)))
 
-(defmacro-mundanely with-hash-table-iterator ((function hash-table) &body body)
+(defmacro-mundanely with-hash-table-iterator ((name hash-table) &body body)
   #!+sb-doc
-  "WITH-HASH-TABLE-ITERATOR ((function hash-table) &body body)
+  "WITH-HASH-TABLE-ITERATOR ((name hash-table) &body body)
 
-Provides a method of manually looping over the elements of a hash-table.
-FUNCTION is bound to a generator-macro that, within the scope of the
-invocation, returns one or three values. The first value tells whether any
-objects remain in the hash table. When the first value is non-NIL, the second
-and third values are the key and the value of the next object.
+Provides a method of manually looping over the elements of a hash-table. NAME
+is bound to a generator-macro that, within the scope of the invocation,
+returns one or three values. The first value tells whether any objects remain
+in the hash table. When the first value is non-NIL, the second and third
+values are the key and the value of the next object.
 
-Consequences are undefined if HASH-TABLE is mutated during execution
-of BODY, except for changing or removing elements corresponding to the
-current key. The applies to all threads, not just the curren one --
-even for synchronized hash-tables. If the table may be mutated by
-another thread during iteration, use eg. SB-EXT:WITH-LOCKED-HASH-TABLE
-to protect the WITH-HASH-TABLE-ITERATOR for."
+Consequences are undefined if HASH-TABLE is mutated during execution of BODY,
+except for changing or removing elements corresponding to the current key. The
+applies to all threads, not just the current one -- even for synchronized
+hash-tables. If the table may be mutated by another thread during iteration,
+use eg. SB-EXT:WITH-LOCKED-HASH-TABLE to protect the WITH-HASH-TABLE-ITERATOR
+for."
   ;; This essentially duplicates MAPHASH, so any changes here should
   ;; be reflected there as well.
-  (let ((n-function (gensym "WITH-HASH-TABLE-ITERATOR-")))
-    `(let ((,n-function
+  (let ((function (make-symbol (concatenate 'string (symbol-name name) "-FUN"))))
+    `(let ((,function
             (let* ((table ,hash-table)
                    (length (length (hash-table-next-vector table)))
                    (index 1))
               (declare (type index/2 index))
               (labels
-                  ((,function ()
+                  ((,name ()
                      ;; (We grab the table again on each iteration just in
                      ;; case it was rehashed by a PUTHASH.)
                      (let ((kv-vector (hash-table-table table)))
@@ -130,11 +127,11 @@ to protect the WITH-HASH-TABLE-ITERATOR for."
                                (value (aref kv-vector (1+ (* 2 index)))))
                            (incf index)
                            (unless (or (eq key +empty-ht-slot+)
-                                        (eq value +empty-ht-slot+))
+                                       (eq value +empty-ht-slot+))
                              (return (values t key value))))))))
-                #',function))))
-      (macrolet ((,function () '(funcall ,n-function)))
-        ,@body))))
+                #',name))))
+       (macrolet ((,name () '(funcall ,function)))
+         ,@body))))
 
 (defmacro-mundanely with-locked-hash-table ((hash-table) &body body)
   #!+sb-doc
@@ -147,5 +144,10 @@ unspecified."
   ;; Needless to say, this also excludes some internal bits, but
   ;; getting there is too much detail when "unspecified" says what
   ;; is important -- unpredictable, but harmless.
-  `(sb!thread::with-recursive-spinlock ((hash-table-spinlock ,hash-table))
+  `(sb!thread::with-recursive-lock ((hash-table-lock ,hash-table))
+     ,@body))
+
+(defmacro-mundanely with-locked-system-table ((hash-table) &body body)
+  `(sb!thread::with-recursive-system-lock
+       ((hash-table-lock ,hash-table))
      ,@body))