source: trunk/source/level-0/l0-hash.lisp @ 15504

Last change on this file since 15504 was 15504, checked in by gz, 7 years ago

Fix lock-free hash table handling of the partially-inserted state, and took out gc handling of the partially-deleted state. Bumped image version because kernel and runtime changes need to match. This fixes ticket #993, hopefully without breaking much of anything else.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 90.9 KB
Line 
1;;;-*- Mode: Lisp; Package: CCL -*-
2;;;
3;;;   Copyright (C) 2009 Clozure Associates
4;;;   Copyright (C) 1994-2001 Digitool, Inc
5;;;   This file is part of Clozure CL. 
6;;;
7;;;   Clozure CL is licensed under the terms of the Lisp Lesser GNU Public
8;;;   License , known as the LLGPL and distributed with Clozure CL as the
9;;;   file "LICENSE".  The LLGPL consists of a preamble and the LGPL,
10;;;   which is distributed with Clozure CL as the file "LGPL".  Where these
11;;;   conflict, the preamble takes precedence. 
12;;;
13;;;   Clozure CL is referenced in the preamble as the "LIBRARY."
14;;;
15;;;   The LLGPL is also available online at
16;;;   http://opensource.franz.com/preamble.html
17
18(in-package "CCL")
19
20;;;;;;;;;;;;;
21;;
22;; See hash.lisp for documentation
23
24
25(eval-when (:compile-toplevel :execute)
26  (require "HASHENV" "ccl:xdump;hashenv")
27  (require :number-case-macro)
28  (assert (and (not (eql (%unbound-marker) (%slot-unbound-marker)))
29               (not (eql (%unbound-marker) (%illegal-marker)))
30               (not (eql (%slot-unbound-marker) (%illegal-marker)))))
31  (define-symbol-macro deleted-hash-key-marker (%slot-unbound-marker))
32  (define-symbol-macro deleted-hash-value-marker (%slot-unbound-marker))
33  (define-symbol-macro free-hash-marker (%unbound-marker))
34  (define-symbol-macro rehashing-value-marker (%illegal-marker))
35  (declaim (inline nhash.vector-size))
36  (declaim (inline mixup-hash-code))
37  (declaim (inline hash-table-p))
38  (declaim (inline %%eqhash))
39  (declaim (inline index->vector-index vector-index->index swap))
40  (declaim (inline %already-rehashed-p %set-already-rehashed-p))
41  (declaim (inline need-use-eql))
42  (declaim (inline %needs-rehashing-p))
43  (declaim (inline compute-hash-code))
44  (declaim (inline eq-hash-find eq-hash-find-for-put))
45  (declaim (inline read-lock-hash-table write-lock-hash-table  unlock-hash-table))
46  (declaim (inline %hash-symbol))
47  (declaim (inline hash-mod))
48  (declaim (inline set-hash-key-conditional set-hash-value-conditional))
49  (declaim (inline hash-lock-free-p lock-free-gethash)))
50
51#+eq-hash-monitor
52(progn
53(defparameter eq-hash-find-calls 0)
54(defparameter eq-hash-find-probes 0)
55(defparameter eq-hash-find-for-put-calls 0)
56(defparameter eq-hash-find-for-put-probes 0)
57)
58
59
60(defun %cons-hash-table (keytrans-function compare-function vector
61                         threshold rehash-ratio rehash-size find find-new owner &optional lock-free-p)
62  (%istruct
63   'HASH-TABLE                          ; type
64   keytrans-function                    ; nhash.keytransF
65   compare-function                     ; nhash.compareF
66   nil                                  ; nhash.rehash-bits
67   vector                               ; nhash.vector
68   (if lock-free-p $nhash.lock-free 0)  ; nhash.lock
69   owner                                ; nhash.owner
70   threshold                            ; nhash.grow-threshold
71   rehash-ratio                         ; nhash.rehash-ratio
72   rehash-size                          ; nhash.rehash-size
73   0                                    ; nhash.puthash-count
74   (if lock-free-p
75     (make-lock)
76     (unless owner (make-read-write-lock))) ; nhash.exclusion-lock
77   find                                 ; nhash.find
78   find-new                             ; nhash.find-new
79   nil                                  ; nhash.read-only
80   ))
81
82(defun nhash.vector-size (vector)
83  (nhash.vector.size vector))
84
85(defun hash-mod (hash entries vector)
86  (fast-mod-3 hash entries (nhash.vector.size-reciprocal vector)))
87
88;; For lock-free hash tables
89(defun set-hash-key-conditional (index vector old new)
90  (%set-hash-table-vector-key-conditional (%i+ target::misc-data-offset
91                                               (ash (the fixnum index) target::word-shift))
92                                          vector
93                                          old
94                                          new))
95
96(defun set-hash-value-conditional (index vector old new)
97  (store-gvector-conditional (%i+ index 1) vector old new))
98
99(defun hash-lock-free-p (hash)
100  (logtest $nhash.lock-free (the fixnum (nhash.lock hash))))
101 
102;;; Is KEY something which can be EQL to something it's not EQ to ?
103;;; (e.g., is it a number or macptr ?)
104;;; This can be more general than necessary but shouldn't be less so.
105(defun need-use-eql (key)
106  (let* ((typecode (typecode key)))
107    (declare (fixnum typecode))
108    (or (= typecode target::subtag-macptr)
109        (and (< typecode (- target::nbits-in-word target::fixnumshift))
110             (logbitp (the (integer 0 (#.(- target::nbits-in-word target::fixnumshift)))
111                        typecode)
112                      (logior (ash 1 target::subtag-bignum)
113                              #-64-bit-target
114                              (ash 1 target::subtag-single-float)
115                              (ash 1 target::subtag-double-float)
116                              (ash 1 target::subtag-ratio)
117                              (ash 1 target::subtag-complex)))))))
118
119;;; Don't rehash at all, unless some key is address-based (directly or
120;;; indirectly.)
121(defun %needs-rehashing-p (vector)
122  (let* ((flags (nhash.vector.flags vector)))
123    (declare (fixnum flags))
124    (if (logbitp $nhash_track_keys_bit flags)
125      ;; GC is tracking key movement
126      (logbitp $nhash_key_moved_bit flags)
127      ;; GC is not tracking key movement
128      (if (logbitp $nhash_component_address_bit flags)
129        (not (eql (the fixnum (%get-gc-count)) (the fixnum (nhash.vector.gc-count vector))))))))
130
131(defun %set-does-not-need-rehashing (vector)
132  (let* ((flags (nhash.vector.flags vector)))
133    (declare (fixnum flags))
134    (setf (nhash.vector.gc-count vector) (%get-gc-count))
135    (when (logbitp $nhash_track_keys_bit flags)
136      (setf (nhash.vector.flags vector)
137            (logand (lognot (ash 1 $nhash_key_moved_bit)) flags)))))
138
139
140;;; Tempting though it may be to remove this, a hash table loaded from
141;;; a fasl file likely needs to be rehashed, and the MAKE-LOAD-FORM
142;;; for hash tables needs to be able to call this or something similar.
143(defun %set-needs-rehashing (hash)
144  (let* ((vector (nhash.vector hash))
145         (flags (nhash.vector.flags vector)))
146    (declare (fixnum flags))
147    (setf (nhash.vector.gc-count vector) (the fixnum (1- (the fixnum (%get-gc-count)))))
148    (when (logbitp $nhash_track_keys_bit flags)
149      (setf (nhash.vector.flags vector) (logior (ash 1 $nhash_key_moved_bit) flags)))))
150
151;;;
152;;; This is a fairly straightforward translation of the "one-at-a-time"
153;;; hash function described at:
154;;; http://www.burtleburtle.net/bob/hash/doobs.html
155;;;
156(defun mixup-hash-code (fixnum)
157  (declare (fixnum fixnum)
158           (optimize (speed 3) (safety 0)))
159  (setq fixnum (logand fixnum target::most-positive-fixnum))
160  (do* ((hash 0))
161       ((zerop fixnum)
162        (setq hash (+ hash (the fixnum (ash hash 3)))
163              hash (logxor hash (the fixnum (ash hash -11))))
164        (the fixnum (+ hash (the fixnum (ash hash 15)))))
165    (declare (fixnum hash))
166    (setq hash (+ hash (the fixnum (logand fixnum #xff)))
167          fixnum (ash fixnum -8)
168          hash (+ hash (the fixnum (ash hash 10)))
169          hash (logxor hash (the fixnum (ash hash -6))))))
170         
171(defun rotate-hash-code (fixnum)
172  (declare (fixnum fixnum))
173  (let* ((low-3 (logand 7 fixnum))
174         (but-low-3 (%ilsr 3 fixnum))
175         (low-3*64K (%ilsl 13 low-3))
176         (low-3-in-high-3 (%ilsl (- 32 3 3) low-3)))
177    (declare (fixnum low-3 but-low-3 low-3*64K low-3-in-high-3))
178    (the fixnum (+ low-3-in-high-3
179                   (the fixnum (logxor low-3*64K but-low-3))))))
180
181
182
183
184(defconstant $nhash-track-keys-mask
185  #.(- (ash 1 $nhash_track_keys_bit)))
186
187(defconstant $nhash-clear-key-bits-mask #xfffff)
188
189
190(defun %hash-symbol (sym)
191  (if sym   
192    (let* ((vector (%symptr->symvector sym))
193           (cell (%svref vector target::symbol.plist-cell))
194           (consp (consp cell)))
195      (or (if consp (%car cell) cell)
196          (let* ((pname (%svref vector target::symbol.pname-cell))
197                 (hash (mixup-hash-code (%pname-hash pname (uvsize pname)))))
198            (declare (type simple-string pname) (fixnum hash))
199            (if consp
200              (setf (%car cell) hash)
201              (setf (%svref vector target::symbol.plist-cell) hash)))))
202    +nil-hash+))
203             
204;;; Hash on address, or at least on some persistent, immutable
205;;; attribute of the key.  If all keys are fixnums or immediates (or if
206;;; that attribute exists), rehashing won't ever be necessary.
207(defun %%eqhash (key)
208  (let* ((typecode (typecode key)))
209    (if (eq typecode target::tag-fixnum)
210      (values (mixup-hash-code key) nil)
211      (if (eq typecode target::subtag-instance)
212        (values (mixup-hash-code (instance.hash key)) nil)
213        (if (symbolp key)
214          (values (%hash-symbol key) nil)
215          (let ((hash (mixup-hash-code (strip-tag-to-fixnum key))))
216            (if (immediate-p-macro key)
217              (values hash nil)
218              (values hash :key ))))))))
219
220
221#+32-bit-target
222(defun swap (num)
223  (declare (fixnum num))
224  (the fixnum (+ (the fixnum (%ilsl 16 num))(the fixnum (%ilsr 13 num)))))
225
226#+64-bit-target
227(defun swap (num)
228  (declare (fixnum num))
229  (the fixnum (+ (the fixnum (%ilsl 32 num))(the fixnum (%ilsr 29 num)))))
230
231;;; teeny bit faster when nothing to do
232(defun %%eqlhash-internal (key)
233  (number-case key
234    (fixnum (mixup-hash-code key)) ; added this
235    (double-float (%dfloat-hash key))
236    (short-float (%sfloat-hash key))
237    (bignum (%bignum-hash key))
238    (ratio (logxor (swap (%%eqlhash-internal (numerator key)))
239                   (%%eqlhash-internal (denominator key))))
240    (complex
241     (logxor (swap (%%eqlhash-internal (realpart key)))
242             (%%eqlhash-internal (imagpart key))))
243    (t (cond ((macptrp key)
244              (%macptr-hash key))
245             (t key)))))
246
247               
248
249
250;;; new function
251
252(defun %%eqlhash (key)
253  ;; if key is a macptr, float, bignum, ratio, or complex, convert it
254  ;; to a fixnum
255  (if (hashed-by-identity key)
256    (%%eqhash key)
257    (let ((primary  (%%eqlhash-internal key)))
258      (if (eq primary key)
259        (%%eqhash key)
260        (mixup-hash-code (strip-tag-to-fixnum primary))))))
261
262
263(defun %%equalhash (key)
264  (let* ((id-p (hashed-by-identity key))
265         (hash (if (and key (not id-p)) (%%eqlhash-internal key)))
266         addressp)
267    (cond ((null key) (mixup-hash-code 17))
268          #+64-bit-target
269          ((and (typep key 'single-float)
270                (zerop (the single-float key)))
271           0)
272          ((immediate-p-macro key) (mixup-hash-code (strip-tag-to-fixnum key)))
273          ((and hash (neq hash key)) hash)  ; eql stuff
274          (t (typecase key
275                (simple-string (%string-hash 0 key (length key)))
276                (string
277                 (let ((length (length key)))
278                   (multiple-value-bind (data offset) (array-data-and-offset key)
279                     (%string-hash offset data length))))
280                (bit-vector (bit-vector-hash key))
281                (cons
282                 (let ((hash 0))
283                   (do* ((i 0 (1+ i))
284                         (done nil)
285                         (list key (unless done (cdr list))))
286                        ((or done (> i 11))) ; who figured 11?
287                     (declare (fixnum i))
288                     (multiple-value-bind (h1 a1) (%%equalhash
289                                                   (if (atom list)
290                                                     (progn
291                                                       (setq done t)
292                                                       list)
293                                                     (%car list)))
294                       (when a1 (setq addressp t))
295                       ; fix the case of lists of same stuff in different order
296                       ;(setq hash (%ilogxor (fixnum-rotate h1 i) hash))
297                       (setq hash (%i+ (rotate-hash-code hash) h1))
298                       ))
299                   (values (mixup-hash-code hash) addressp)))
300                (pathname (%%equalphash key))
301                (t (%%eqlhash key)))))))
302
303(defun update-hash-flags (hash vector addressp)
304  (when addressp
305    (flet ((new-flags (flags addressp)
306             (declare (fixnum flags))
307             (if (eq :key addressp)
308               ;; hash code depended on key's address
309               (if (logbitp $nhash_component_address_bit flags)
310                 flags
311                 (logior $nhash-track-keys-mask
312                         (if (logbitp $nhash_track_keys_bit flags)
313                           flags
314                           (bitclr $nhash_key_moved_bit flags))))
315               ;; hash code depended on component address
316               (bitset $nhash_component_address_bit
317                       (logand (lognot $nhash-track-keys-mask) flags)))))
318      (declare (inline new-flags))
319      (if (hash-lock-free-p hash)
320        (loop
321          (let* ((flags (nhash.vector.flags vector))
322                 (new-flags (new-flags flags addressp)))
323            (when (or (eq flags new-flags)
324                      (store-gvector-conditional nhash.vector.flags vector flags new-flags))
325              (return))))
326        (setf (nhash.vector.flags vector)
327              (new-flags (nhash.vector.flags vector) addressp))))))
328
329(defun compute-hash-code (hash key update-hash-flags &optional
330                               (vector (nhash.vector hash))) ; vectorp))
331  (let ((keytransF (nhash.keytransF hash))
332        primary addressp)
333    (if (not (fixnump keytransF))
334      ;; not EQ or EQL hash table
335      (progn
336        (multiple-value-setq (primary addressp) (funcall keytransF key))
337        (let ((immediate-p (immediate-p-macro primary)))
338          (setq primary (strip-tag-to-fixnum primary))
339          (unless immediate-p
340            (setq primary (mixup-hash-code primary))
341            (setq addressp :key))))
342      ;; EQ or EQL hash table
343      (if (and (not (eql keytransF 0))
344               (need-use-eql key))
345        ;; EQL hash table
346        (setq primary (%%eqlhash-internal key))
347        ;; EQ hash table - or something eql doesn't do
348        (multiple-value-setq (primary addressp) (%%eqhash key))))
349    (when update-hash-flags
350      (when addressp
351        (update-hash-flags hash vector addressp)))
352    (let* ((entries (nhash.vector-size vector)))
353      (declare (fixnum entries))
354      (values primary
355              (hash-mod primary entries vector)
356              entries))))
357
358(defun %already-rehashed-p (primary rehash-bits)
359  (declare (optimize (speed 3)(safety 0)))
360  (declare (type (simple-array bit (*)) rehash-bits))
361  (eql 1 (sbit rehash-bits primary)))
362
363(defun %set-already-rehashed-p (primary rehash-bits)
364  (declare (optimize (speed 3)(safety 0)))
365  (declare (type (simple-array bit (*)) rehash-bits))
366  (setf (sbit rehash-bits primary) 1))
367
368
369(defun hash-table-p (hash)
370  (istruct-typep hash 'hash-table))
371
372(defun %normalize-hash-table-count (hash)
373  (let* ((vector (nhash.vector hash))
374         (weak-deletions-count (nhash.vector.weak-deletions-count vector)))
375    (declare (fixnum weak-deletions-count))
376    (unless (eql 0 weak-deletions-count)
377      (setf (nhash.vector.weak-deletions-count vector) 0)
378      ;; lock-free hash tables don't maintain deleted-count, since would need to
379      ;; lock and it's not worth it.
380      (unless (hash-lock-free-p hash)
381        (let ((deleted-count (the fixnum
382                               (+ (the fixnum (nhash.vector.deleted-count vector))
383                                  weak-deletions-count)))
384              (count (the fixnum (- (the fixnum (nhash.vector.count vector)) weak-deletions-count))))
385          (setf (nhash.vector.deleted-count vector) deleted-count
386                (nhash.vector.count vector) count))))))
387
388
389(defparameter *shared-hash-table-default* t
390  "Be sure that you understand the implications of changing this
391before doing so.")
392
393(defparameter *lock-free-hash-table-default* :shared
394  "If NIL, hash tables default to using the standard algorithms, with locks for shared tables.
395   If :SHARED, shared hash tables default to using the \"lock-free\" algorithm,
396   which is faster for typical access but slower for rehashing or growing the table.
397   Otherwise, all hash tables default to the lock-free algorithm")
398
399(defun make-hash-table (&key (test 'eql)
400                             (size 60)
401                             (rehash-size 1.5)
402                             (rehash-threshold .85)
403                             (hash-function nil)
404                             (weak nil)
405                             (finalizeable nil)
406                             (address-based t)  ;; Ignored
407                             (lock-free *lock-free-hash-table-default*)
408                             (shared *shared-hash-table-default*))
409  "Create and return a new hash table. The keywords are as follows:
410     :TEST -- Indicates what kind of test to use.
411     :SIZE -- A hint as to how many elements will be put in this hash
412       table.
413     :REHASH-SIZE -- Indicates how to expand the table when it fills up.
414       If an integer, add space for that many elements. If a floating
415       point number (which must be greater than 1.0), multiply the size
416       by that amount.
417     :REHASH-THRESHOLD -- Indicates how dense the table can become before
418       forcing a rehash. Can be any positive number <=1, with density
419       approaching zero as the threshold approaches 0. Density 1 means an
420       average of one entry per bucket."
421  (declare (ignore address-based)) ;; TODO: could reinterpret as "warn if becomes address-based"
422  (unless (and test (or (functionp test) (symbolp test)))
423    (report-bad-arg test '(and (not null) (or symbol function))))
424  (unless (or (functionp hash-function) (symbolp hash-function))
425    (report-bad-arg hash-function '(or symbol function)))
426  (unless (and (realp rehash-threshold) (<= 0.0 rehash-threshold) (<= rehash-threshold 1.0))
427    (report-bad-arg rehash-threshold '(real 0 1)))
428  (unless (or (fixnump rehash-size) (and (realp rehash-size) (< 1.0 rehash-size)))
429    (report-bad-arg rehash-size '(or fixnum (real 1 *))))
430  (unless (fixnump size) (report-bad-arg size 'fixnum))
431  (setq rehash-threshold (/ 1.0 (max 0.01 rehash-threshold)))
432  (let* ((default-hash-function
433             (cond ((or (eq test 'eq) (eq test #'eq)) 
434                    (setq test 0))
435                   ((or (eq test 'eql) (eq test #'eql)) 
436                    (setq test -1))
437                   ((or (eq test 'equal) (eq test #'equal))
438                    (setq test #'equal) #'%%equalhash)
439                   ((or (eq test 'equalp) (eq test #'equalp))
440                    (setq test #'equalp) #'%%equalphash)
441                   (t (setq test (require-type test 'symbol))
442                      (or hash-function 
443                          (error "non-standard test specified without hash-function")))))
444         (find-function
445          (case test
446            (0 #'eq-hash-find)
447            (-1 #'eql-hash-find)
448            (t #'general-hash-find)))
449         (find-put-function
450          (case test
451            (0 #'eq-hash-find-for-put)
452            (-1 #'eql-hash-find-for-put)
453            (t #'general-hash-find-for-put))))
454    (setq hash-function
455          (if hash-function
456            (require-type hash-function 'symbol)
457            default-hash-function))
458    (when (and weak (neq weak :value) (neq test 0))
459      (error "Only EQ hash tables can be weak."))
460    (when (and finalizeable (not weak))
461      (error "Only weak hash tables can be finalizeable."))
462    (when (and (eq lock-free :shared) (not shared))
463      (setq lock-free nil))
464    (multiple-value-bind (grow-threshold total-size)
465        (compute-hash-size (1- size) 1 rehash-threshold)
466      (let* ((flags (+ (if weak (ash 1 $nhash_weak_bit) 0)
467                       (ecase weak
468                         ((t nil :key) 0)
469                         (:value (ash 1 $nhash_weak_value_bit)))
470                       (if finalizeable (ash 1 $nhash_finalizeable_bit) 0)
471                       (if lock-free (ash 1 $nhash_keys_frozen_bit) 0)))
472             (hash (%cons-hash-table 
473                    hash-function test
474                    (%cons-nhash-vector total-size flags)
475                    grow-threshold rehash-threshold rehash-size
476                    find-function find-put-function
477                    (unless shared *current-process*)
478                    lock-free)))
479        (setf (nhash.vector.hash (nhash.vector hash)) hash)
480        hash))))
481
482(defun compute-hash-size (size rehash-size rehash-ratio)
483  (let* ((new-size size))
484    (declare (fixnum size new-size))
485    (setq new-size (max 30 (if (fixnump rehash-size)
486                             (%i+ size rehash-size)
487                             (ceiling (* size rehash-size)))))
488    (if (<= new-size size)
489      (setq new-size (1+ size)))        ; God save you if you make this happen
490   
491    (let ((vector-size (%hash-size (max (+ new-size 2) (ceiling (* new-size rehash-ratio))))))
492      ; TODO: perhaps allow more entries, based on actual size:
493      ;  (values (min (floor vector-size rehash-ratio) (%i- vector-size 2)) vector-size))
494      (values new-size vector-size)
495      )))
496
497;;;  Suggested size is a fixnum: number of pairs.  Return a fixnum >=
498;;;  that size that is relatively prime to all secondary keys.
499(defun %hash-size (suggestion)
500  (declare (fixnum suggestion))
501  (declare (optimize (speed 3)(safety 0)))
502  (if (<= suggestion #.(aref secondary-keys 7))
503    (setq suggestion (+ 2 #.(aref secondary-keys 7)))
504     (setq suggestion (logior 1 suggestion)))
505  (loop
506    (dovector (key secondary-keys (return-from %hash-size suggestion))
507      (when (eql 0 (fast-mod suggestion key))
508        (return)))
509    (incf suggestion 2)))
510
511
512(defvar *continue-from-readonly-hashtable-lock-error* t)
513
514(defun signal-read-only-hash-table-error (hash)
515  (cond ((hash-lock-free-p hash)
516         ;; We don't really do anything different if this is set, so no problem
517         (cerror "Modify it anyway"
518                 "Attempt to modify readonly hash table ~s" hash))
519        (*continue-from-readonly-hashtable-lock-error*
520         (cerror "Make the hash-table writable. DANGEROUS! This could damage your lisp if another thread is acccessing this table. CONTINUE ONLY IF YOU KNOW WHAT YOU'RE DOING!"
521                 "Hash-table ~s is readonly" hash)
522         (assert-hash-table-writeable hash)
523         (write-lock-hash-table hash))
524        (t (error "Hash-table ~s is readonly" hash))))
525
526(defun read-lock-hash-table (hash)
527  (if (nhash.read-only hash)
528    :readonly
529    (let* ((lock (nhash.exclusion-lock hash)))
530      (if lock
531        (read-lock-rwlock lock)
532        (unless (eq (nhash.owner hash) *current-process*)
533          (error "Not owner of hash table ~s" hash))))))
534
535(defun write-lock-hash-table (hash)
536  (if (nhash.read-only hash)
537    (signal-read-only-hash-table-error hash)
538    (let* ((lock (nhash.exclusion-lock hash)))
539      (if lock
540        (write-lock-rwlock lock)
541        (unless (eq (nhash.owner hash) *current-process*)
542          (error "Not owner of hash table ~s" hash))))))
543
544
545(defun unlock-hash-table (hash was-readonly)
546  (unless was-readonly
547    (let* ((lock (nhash.exclusion-lock hash)))
548      (if lock
549        (unlock-rwlock lock)))))
550
551(defun index->vector-index (index)
552  (declare (fixnum index))
553  (the fixnum (+ $nhash.vector_overhead (the fixnum (+ index index)))))
554
555(defun vector-index->index (index)
556  (declare (fixnum index))
557  (the fixnum (ash (the fixnum (- index $nhash.vector_overhead)) -1)))
558
559(defun hash-table-count (hash)
560  "Return the number of entries in the given HASH-TABLE."
561  (setq hash (require-type hash 'hash-table))
562  (when (hash-lock-free-p hash)
563    ;; We don't try to maintain a running total, so just count.
564    (return-from hash-table-count (lock-free-count-entries hash)))
565  (%normalize-hash-table-count hash)
566  (the fixnum (nhash.vector.count (nhash.vector hash))))
567
568(defun hash-table-rehash-size (hash)
569  "Return the rehash-size HASH-TABLE was created with."
570  (nhash.rehash-size (require-type hash 'hash-table)))
571
572(defun hash-table-rehash-threshold (hash)
573  "Return the rehash-threshold HASH-TABLE was created with."
574  (/ 1.0 (nhash.rehash-ratio (require-type hash 'hash-table))))
575
576(defun hash-table-size (hash)
577  "Return a size that can be used with MAKE-HASH-TABLE to create a hash
578   table that can hold however many entries HASH-TABLE can hold without
579   having to be grown."
580  (let* ((hash (require-type hash 'hash-table))
581         (vector (nhash.vector hash)))
582    (values (floor (nhash.vector.size vector) (nhash.rehash-ratio hash)))))
583
584(defun hash-table-test (hash)
585  "Return the test HASH-TABLE was created with."
586  (let ((f (nhash.compareF (require-type hash 'hash-table))))
587    (if (fixnump f)
588      (if (eql 0 f) 'eq 'eql)
589      (let ((name (if (symbolp f) f (function-name f))))
590        (if (memq name '(equal equalp)) name f)))))
591
592;;; sometimes you'd rather have the function than the symbol.
593(defun hash-table-test-function (hash)
594  (let ((f (nhash.compareF (require-type hash 'hash-table))))
595    (if (fixnump f)
596      (if (eql 0 f) #'eq #'eql)
597      f)))
598
599;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
600;;
601;; nearly-lock-free hash tables
602;;
603;; A modification of the lock-free hash table algorithm described by Cliff Click Jr.  in
604;; http://blogs.azulsystems.com/cliff/2007/03/a_nonblocking_h.html.
605;;
606;; The modifications have to do with the fact that our goal is just to minimize the
607;; performance impact of thread-safety, by eliminating the need for locking on every
608;; read.  I don't bother with aspects of his algorithm that aren't relevant to that goal.
609;;
610;; The main difference from Click's algorithm is that I don't try to do rehashing
611;; concurrently.  Instead, rehashing grabs a lock, so that only one thread can be
612;; rehashing at any given time, and readers/writers will block waiting for the rehashing
613;; to finish.
614;;
615;; In our implementation the following are the possible states of a hash table entry:
616;;   (where "object" means any object other than the special markers):
617;;
618;; State      Key               Value
619;; FREE       free-hash-marker  free-hash-marker
620;; INSERTING  object            free-hash-marker
621;; IN-USE     object            object
622;; DELETING1  object            deleted-marker
623;; DELETING2  deleted-marker    object
624;; DELETED    deleted-marker    deleted-marker
625;; REHASHING  object            rehashing-value-marker
626;; REHASHING  free-hash-marker  rehashing-value-marker
627;; REHASHING  deleted-marker    rehashing-value-marker
628;;
629;; No other states are allowed - at no point in time can a hash table entry be in any
630;; other state.   In addition, the only transitions allowed on the key slot are
631;; free-hash-marker -> object/deleted-marker -> deleted-marker.  Once a key slot
632;; is claimed, it must never change to free or another key value (even after the hash
633;; vector has been discarded after rehashing, because some process might still be
634;; looking at it).
635;; In particular, rehashing in place is not an option.  All rehashing creates a new
636;; vector and copies into it.  This means it's kinda risky to use lock-free hash
637;; tables with address-based keys, because they will thrash in low-memory situations,
638;; but we don't disallow it because a particular use might not have this problem.
639;;
640;; The following operations may take place:
641;;
642;; * gethash: find matching key - if no match, return not found.  Else fetch value,
643;;   if value is rehashing-value-marker then maybe-rehash and try again;
644;;   if value is free-hash-marker or deleted-marker, return not found, else return found value.
645;; * puthash: find matching key or FREE slot.
646;;   ** If found key, fetch value.
647;;      if value is rehashing-value-marker then maybe-rehash and try again;
648;;      else store-conditional the value -> new value, if fails try again.
649;;   ** Else have FREE slot, store-key-conditional free-hash-marker -> key,
650;;      and if that succeeds, store-conditional free-hash-marker -> new value,
651;;      if either fails, maybe-rehash and try again.
652;; * remhash: find matching key - if no match, done.  Else fetch value,
653;;   if value is rehashing-value-marker then maybe-rehash and try again;
654;;   if value is free-hash-marker or deleted-marker, done.
655;;   else store-conditional the value -> deleted-marker, if fails try again.
656;;    if succeeds, clobber key with deleted-marker to allow it to get gc'd.
657;; * clrhash: grab the rehash lock, then set all slots to DELETED (transitioning through either
658;;    DELETED1 or DELETED2 state).
659;; * rehash: grab a lock, estimate number of entries, make a new vector.  loop over
660;; old vector, at each entry fetch the old value with atomic swap of
661;; rehashing-value-marker.  This prevents any further state changes involving the
662;; value.  It doesn't prevent state changes involving the key, but the only ones that
663;; can happen is FREE -> INSERTING, and DELETINGn -> DELETED, all of which are
664;; equivalent from the point of view of rehashing.  Anyway, if the old value was
665;; rehashing-value-marker then bug (because we have a lock).  If the old value is
666;; free-hash-marker or deleted-marker then do nothing, else get the entry key and
667;; rehash into the new vector -- if no more room, start over.  When done, store the
668;; new vector in the hash table and release lock.
669;;
670;; * gc: for weak tables, gc may convert IN-USE states to DELETED states.
671
672
673(defun lock-free-rehash (hash)
674  ;;(break "We think we need to rehash ~s" (nhash.vector hash))
675  (with-lock-context
676    (without-interrupts ;; not re-entrant
677      (let ((lock (nhash.exclusion-lock hash)))
678        (%lock-recursive-lock-object lock)
679        ;; TODO: might also want to rehash if deleted entries are a large percentage
680        ;; of all entries, more or less.
681        (when (or (%i<= (nhash.grow-threshold hash) 0) ;; no room
682                  (%needs-rehashing-p (nhash.vector hash))) ;; or keys moved
683          (%lock-free-rehash hash))
684        (%unlock-recursive-lock-object lock)))))
685
686
687;; TODO: This is silly.  We're implementing atomic swap using store-conditional,
688;; but internally store-conditional is probably implemented using some kind of
689;; an atomic swap!!
690(defun atomic-swap-gvector (index gvector value)
691  (loop
692    (let ((old-value (%svref gvector index)))
693      (when (store-gvector-conditional index gvector old-value value)
694        (return old-value)))))
695
696;; Interrupts are disabled and caller has the hash lock on the table, blocking other
697;; threads attempting a rehash.
698;; Other threads might be reading/writing/deleting individual entries, but they
699;; will block if they see a value = rehashing-value-marker.
700;; GC may run, updating the needs-rehashing flags and deleting weak entries in both
701;; old and new vectors.
702(defun %lock-free-rehash (hash)
703  (let* ((old-vector (nhash.vector hash))
704         (inherited-flags (logand $nhash_weak_flags_mask (nhash.vector.flags old-vector)))
705         (grow-threshold (nhash.grow-threshold hash))
706         count new-vector vector-size)
707    ;; Prevent puthash from adding new entries.  Note this doesn't keep it from undeleting
708    ;; existing entries, so we might still lose, but this makes the odds much smaller.
709    (setf (nhash.grow-threshold hash) 0)
710    (setq count (lock-free-count-entries hash))
711    (multiple-value-setq (grow-threshold vector-size)
712      (if (%i<= grow-threshold 0) ; if ran out of room, grow, else get just enough.
713        (compute-hash-size count (nhash.rehash-size hash) (nhash.rehash-ratio hash))
714        (compute-hash-size count 1 (nhash.rehash-ratio hash))))
715    (setq new-vector (%cons-nhash-vector vector-size inherited-flags))
716    (loop with full-count = grow-threshold
717          for i from $nhash.vector_overhead below (uvsize old-vector) by 2
718          do (let* ((value (atomic-swap-gvector (%i+ i 1) old-vector rehashing-value-marker))
719                    (key (%svref old-vector i)))
720               (when (eq value rehashing-value-marker) (error "Who else is doing this?"))
721               (unless (or (eq value free-hash-marker)
722                           (eq value deleted-hash-value-marker)
723                           (eq key deleted-hash-key-marker))
724                 (let* ((new-index (%growhash-probe new-vector hash key))
725                        (new-vector-index (index->vector-index new-index)))
726                   (%set-hash-table-vector-key new-vector new-vector-index key)
727                   (setf (%svref new-vector (%i+ new-vector-index 1)) value)
728                   (decf grow-threshold)
729                   (when (%i<= grow-threshold 0)
730                     ;; Too many entries got undeleted while we were rehashing (that's the
731                     ;; only way we could end up with more than COUNT entries, as adding
732                     ;; new entries is blocked).  Grow the output vector.
733                     (multiple-value-bind (bigger-threshold bigger-vector-size)
734                         (compute-hash-size full-count (nhash.rehash-size hash) (nhash.rehash-ratio hash))
735                       (assert (> bigger-vector-size vector-size))
736                       (let ((bigger-vector (%cons-nhash-vector bigger-vector-size 0)))
737                         (%copy-gvector-to-gvector new-vector
738                                                   $nhash.vector_overhead
739                                                   bigger-vector
740                                                   $nhash.vector_overhead
741                                                   (%i- (uvsize new-vector) $nhash.vector_overhead))
742                         (setf (nhash.vector.flags bigger-vector) (nhash.vector.flags new-vector))
743                         (%lock-free-rehash-in-place hash bigger-vector)
744                         (setq grow-threshold (- bigger-threshold full-count))
745                         (setq full-count bigger-threshold)
746                         (setq new-vector bigger-vector)
747                         (setq vector-size bigger-vector-size))))))))
748    (when (%needs-rehashing-p new-vector) ;; keys moved, but at least can use the same new-vector.
749      (%lock-free-rehash-in-place hash new-vector))
750    (setf (nhash.vector.hash new-vector) hash)
751    (setf (nhash.grow-threshold hash) grow-threshold)
752    ;; At this point, another thread might decrement the threshold while they're looking at the old
753    ;; vector. That's ok, just means it will be too small and we'll rehash sooner than planned,
754    ;; no big deal.
755    (setf (nhash.vector hash) new-vector)))
756
757;; This is called on a new vector that hasn't been installed yet, so no other thread is
758;; accessing it.  However, gc might be deleting stuff from it, which is why it tests
759;; key for deleted-hash-key-marker in addition to free-hash-marker value
760(defun %lock-free-rehash-in-place (hash vector)
761  (let* ((vector-index (- $nhash.vector_overhead 2))
762         (size (nhash.vector-size vector))
763         (rehash-bits (%make-rehash-bits hash size))
764         (index -1))
765    (declare (fixnum size index vector-index))
766    (%set-does-not-need-rehashing vector)
767    (loop
768      (when (>= (incf index) size) (return))
769      (setq vector-index (+ vector-index 2))
770      (unless (%already-rehashed-p index rehash-bits)
771        (let* ((value (%svref vector (%i+ vector-index 1)))
772               (key (%svref vector vector-index)))
773          (if (or (eq value free-hash-marker)
774                  (eq value deleted-hash-value-marker)
775                  (eq key deleted-hash-key-marker))
776            (unless (eq key free-hash-marker)
777              (setf (%svref vector vector-index) free-hash-marker))
778            (let* ((last-index index)
779                   (first t))
780              (loop
781                (let ((found-index (%rehash-probe rehash-bits hash key vector)))
782                  (%set-already-rehashed-p found-index rehash-bits)
783                  (when (eq last-index found-index)
784                    (return))
785                  (let* ((found-vector-index (index->vector-index found-index))
786                         (newvalue (%svref vector (the fixnum (1+ found-vector-index))))
787                         (newkey (%svref vector found-vector-index)))
788                    (declare (fixnum found-vector-index))
789                    (when first         ; or (eq last-index index) ?
790                      (setq first nil)
791                      (setf (%svref vector (the fixnum (1+ vector-index))) free-hash-marker)
792                      (setf (%svref vector vector-index) free-hash-marker))
793                    (%set-hash-table-vector-key vector found-vector-index key)
794                    (setf (%svref vector (the fixnum (1+ found-vector-index))) value)
795                    (when (or (eq newkey deleted-hash-key-marker)
796                              (eq newvalue free-hash-marker)
797                              (eq newvalue deleted-hash-value-marker))
798                      (return))
799                    (when (eq key newkey)
800                      (cerror "Delete one of the entries." "Duplicate key: ~s in ~s ~s ~s ~s ~s"
801                              key hash value newvalue index found-index)                       
802                      (return))
803                    (setq key newkey
804                          value newvalue
805                          last-index found-index))))))))))
806  t )
807
808
809(defun lock-free-gethash (key hash default)
810  (declare (optimize (speed 3) (safety 0) (debug 0)))
811  (loop
812    (let* ((vector (nhash.vector hash))
813           (vector-index (funcall (the function (nhash.find hash)) hash key)))
814      (declare (fixnum vector-index))
815      ;; Need to punt if vector changed because no way to know whether nhash.find was
816      ;; using old or new vector.
817      (when (eq vector (nhash.vector hash))
818        (cond ((eql vector-index -1)
819               (unless (%needs-rehashing-p vector)
820                 (return-from lock-free-gethash (values default nil))))
821              (t (let ((value (%svref vector (%i+ vector-index 1))))
822                   (unless (eq value rehashing-value-marker)
823                     (if (or (eq value deleted-hash-value-marker)
824                             (eq value free-hash-marker))
825                       (return-from lock-free-gethash (values default nil))
826                       (return-from lock-free-gethash (values value t)))))))))
827    ;; We're here because the table needs rehashing or it was getting rehashed while we
828    ;; were searching. Take care of it and try again.
829    (lock-free-rehash hash)))
830
831(defun lock-free-remhash (key hash)
832  (declare (optimize (speed 3) (safety 0) (debug 0)))
833  (when (nhash.read-only hash)
834    (signal-read-only-hash-table-error hash)) ;; continuable
835  (loop
836    (let* ((vector (nhash.vector hash))
837           (vector-index (funcall (the function (nhash.find hash)) hash key)))
838      (declare (fixnum vector-index))
839      ;; Need to punt if vector changed because no way to know whether nhash.find was
840      ;; using old or new vector.
841      (when (eq vector (nhash.vector hash))
842        (cond ((eql vector-index -1)
843               (unless (%needs-rehashing-p vector)
844                 (return-from lock-free-remhash nil)))
845              (t (let ((old-value (%svref vector (%i+ vector-index 1))))
846                   (unless (eq old-value rehashing-value-marker)
847                     (when (or (eq old-value deleted-hash-value-marker) ;; deleted
848                               (eq old-value free-hash-marker)) ;; or about to be added
849                       (return-from lock-free-remhash nil))
850                     (when (set-hash-value-conditional vector-index vector old-value deleted-hash-value-marker)
851                       ;; Clear the key slot so can be gc'd.
852                       (setf (%svref vector vector-index) deleted-hash-key-marker)
853                       (return-from lock-free-remhash t)))))))
854      ;; We're here because the table needs rehashing or it was getting rehashed while we
855      ;; were searching.  Take care of it and try again.
856      (lock-free-rehash hash))))
857
858;; TODO: might be better (faster, safer) to just create a new all-free vector?
859(defun lock-free-clrhash (hash)
860  (when (nhash.read-only hash)
861    (signal-read-only-hash-table-error hash)) ;;continuable
862  (with-lock-context
863    (without-interrupts
864     (let ((lock (nhash.exclusion-lock hash)))
865       (%lock-recursive-lock-object lock) ;; disallow rehashing.
866       (loop
867         with vector = (nhash.vector hash)
868         for i fixnum from (%i+ $nhash.vector_overhead 1) below (uvsize vector) by 2
869         as val = (%svref vector i)
870         unless (or (eq val free-hash-marker) (eq val deleted-hash-value-marker))
871         do (setf (%svref vector (%i- i 1)) deleted-hash-key-marker
872                  (%svref vector i) deleted-hash-value-marker))
873       (%unlock-recursive-lock-object lock))))
874  hash)
875
876(defun lock-free-puthash (key hash value)
877  (declare (optimize (speed 3) (safety 0) (debug 0)))
878  (when (or (eq value rehashing-value-marker)
879            (eq value free-hash-marker)
880            (eq value deleted-hash-value-marker))
881    (error "Illegal value ~s for storing in a hash table" value))
882  (when (nhash.read-only hash)
883    (signal-read-only-hash-table-error hash)) ;;continuable
884  (loop
885    (let* ((vector (nhash.vector  hash))
886           (vector-index (funcall (nhash.find-new hash) hash key)))
887      ;; Need to punt if vector changed because no way to know whether nhash.find-new was
888      ;; using old or new vector.
889      (when (eq vector (nhash.vector hash))
890        (cond ((or (eql vector-index -1)
891                   (eq (%svref vector vector-index) free-hash-marker))
892               (unless (or (%needs-rehashing-p vector)
893                           (%i<= (nhash.grow-threshold hash) 0))
894                 ;; Note if the puthash fails, grow-threshold will end up too small. This
895                 ;; just means we might rehash sooner than absolutely necessary, no real
896                 ;; harm done (the most likely cause of failing is that somebody is
897                 ;; already rehashing anyway).  DON'T try to incf it back on failure --
898                 ;; that risks grow-threshold ending up too big (e.g. if somebody rehashes
899                 ;; before the incf), which _could_ be harmful.
900                 (atomic-decf (nhash.grow-threshold hash))
901                 (when (set-hash-key-conditional vector-index vector free-hash-marker key)
902                   (when (set-hash-value-conditional vector-index vector free-hash-marker value)
903                     (return-from lock-free-puthash value)))))
904              (t (let ((old-value (%svref vector (%i+ vector-index 1))))
905                   (unless (or (eq old-value rehashing-value-marker)
906                               ;; In theory, could reuse the deleted slot since we know it had this key
907                               ;; initially, but that would complicate the state machine for very little gain.
908                               (eq old-value deleted-hash-value-marker))
909                     (when (set-hash-value-conditional vector-index vector old-value value)
910                       (return-from lock-free-puthash value))))))))
911    ;; We're here because the table needs rehashing or it was getting rehashed while we
912    ;; were searching, or no room for new entry, or somebody else claimed the key from
913    ;; under us (that last case doesn't need to retry, but it's unlikely enough that
914    ;; it's not worth checking for).  Take care of it and try again.
915    (lock-free-rehash hash)))
916
917(defun lock-free-count-entries (hash)
918  ;; Other threads could be adding/removing entries while we count, some of
919  ;; which will be included in the count (i.e. will be treated as if they
920  ;; happened after counting) and some won't (i.e. will be treated as if
921  ;; they happened before counting), but not necessarily in correlation
922  ;; with their temporal relationship.
923  (loop
924    with vector = (nhash.vector hash)
925    for i fixnum from $nhash.vector_overhead below (uvsize vector) by 2
926    count (let ((value (%svref vector (%i+ i 1))))
927            (when (eq value rehashing-value-marker)
928              ;; This table is being rehashed.  Wait for it to be
929              ;; done and try again.
930              (lock-free-rehash hash)
931              (return-from lock-free-count-entries (lock-free-count-entries hash)))
932            (neq value free-hash-marker))))
933
934;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
935
936
937(defun gethash (key hash &optional default)
938  "Finds the entry in HASH-TABLE whose key is KEY and returns the associated
939   value and T as multiple values, or returns DEFAULT and NIL if there is no
940   such entry. Entries can be added using SETF."
941  (unless (typep hash 'hash-table)
942    (report-bad-arg hash 'hash-table))
943  (when (or (eq key free-hash-marker)
944            (eq key deleted-hash-key-marker))
945    (return-from gethash (values default nil)))
946  (when (hash-lock-free-p hash)
947    (return-from gethash (lock-free-gethash key hash default)))
948  (let* ((value nil)
949         (gc-locked nil)
950         (readonly nil)
951         (foundp nil))
952    (with-lock-context
953      (without-interrupts
954        (setq readonly (eq (read-lock-hash-table hash) :readonly))
955        (let* ((vector (nhash.vector hash)))
956          (if (and (eq key (nhash.vector.cache-key vector))
957                   ;; Check twice: the GC might nuke the cached key/value pair
958                   (progn (setq value (nhash.vector.cache-value vector))
959                          (eq key (nhash.vector.cache-key vector))))
960            (setq foundp t)
961            (loop
962              (let* ((vector-index (funcall (nhash.find hash) hash key)))
963                (declare (fixnum vector-index))
964                (cond ((setq foundp (not (eql vector-index -1)))
965                       ;; Referencing both key and value here - and referencing
966                       ;; value first - is an attempt to compensate for the
967                       ;; possibility that the GC deletes a weak-on-key pair.
968                       (setq value (%svref vector (%i+ vector-index 1)))
969                       (when (nhash.owner hash)
970                         (setf (nhash.vector.cache-key vector)
971                               (%svref vector vector-index)
972                               (nhash.vector.cache-value vector)
973                               value
974                               (nhash.vector.cache-idx vector)
975                               (vector-index->index (the fixnum vector-index))))
976                       (return))
977                      ((%needs-rehashing-p vector)
978                       (%lock-gc-lock)
979                       (setq gc-locked t)
980                       (unless readonly
981                         (let* ((lock (nhash.exclusion-lock hash)))
982                           (when lock (%promote-rwlock lock))))
983                       (when (%needs-rehashing-p vector)
984                         (%rehash hash)))
985                      (t (return)))))))
986        (when gc-locked (%unlock-gc-lock))
987        (unlock-hash-table hash readonly)))
988    (if foundp
989      (values value t)
990      (values default nil))))
991
992(defun remhash (key hash)
993  "Remove the entry in HASH-TABLE associated with KEY. Return T if there
994   was such an entry, or NIL if not."
995  (unless (typep hash 'hash-table)
996    (setq hash (require-type hash 'hash-table)))
997  (when (hash-lock-free-p hash)
998    (return-from remhash (lock-free-remhash key hash)))
999  (let* ((foundp nil))
1000    (with-lock-context
1001      (without-interrupts
1002       (write-lock-hash-table hash)
1003       (%lock-gc-lock)
1004       (let* ((vector (nhash.vector hash)))
1005         (when (%needs-rehashing-p vector)
1006           (%rehash hash))
1007         (if (eq key (nhash.vector.cache-key vector))
1008           (progn
1009             (setf (nhash.vector.cache-key vector) free-hash-marker
1010                   (nhash.vector.cache-value vector) nil)
1011             (let ((vidx (index->vector-index (nhash.vector.cache-idx vector))))
1012               (setf (%svref vector vidx) deleted-hash-key-marker)
1013               (setf (%svref vector (the fixnum (1+ vidx))) nil))
1014             (incf (the fixnum (nhash.vector.deleted-count vector)))
1015             (decf (the fixnum (nhash.vector.count vector)))
1016             (setq foundp t))
1017           (let* ((vector-index (funcall (nhash.find hash) hash key)))
1018             (declare (fixnum vector-index))
1019             (unless (eql vector-index -1)
1020               ;; always clear the cache cause I'm too lazy to call the
1021               ;; comparison function and don't want to keep a possibly
1022               ;; deleted key from being GC'd
1023               (setf (nhash.vector.cache-key vector) free-hash-marker
1024                     (nhash.vector.cache-value vector) nil)
1025               ;; Update the count
1026               (incf (the fixnum (nhash.vector.deleted-count vector)))
1027               (decf (the fixnum (nhash.vector.count vector)))
1028               ;; Delete the value from the table.
1029               (setf (%svref vector vector-index) deleted-hash-key-marker
1030                     (%svref vector (the fixnum (1+ vector-index))) nil)
1031               (setq foundp t)))))
1032       ;; Return T if we deleted something
1033       (%unlock-gc-lock)
1034       (unlock-hash-table hash nil)))
1035    foundp))
1036
1037;;; what if somebody is mapping, growing, rehashing?
1038(defun clrhash (hash)
1039  "This removes all the entries from HASH-TABLE and returns the hash table
1040   itself."
1041  (unless (typep hash 'hash-table)
1042    (report-bad-arg hash 'hash-table))
1043  (when (hash-lock-free-p hash)
1044    (return-from clrhash (lock-free-clrhash hash)))
1045  (with-lock-context
1046    (without-interrupts
1047     (write-lock-hash-table hash)
1048     (let* ((vector (nhash.vector hash))
1049            (size (nhash.vector-size vector))
1050            (count (+ size size))
1051            (index $nhash.vector_overhead))
1052       (declare (fixnum size count index))
1053       (dotimes (i count)
1054         (setf (%svref vector index) free-hash-marker)
1055         (incf index))
1056       (incf (the fixnum (nhash.grow-threshold hash))
1057             (the fixnum (+ (the fixnum (nhash.vector.count vector))
1058                            (the fixnum (nhash.vector.deleted-count vector)))))
1059       (setf (nhash.vector.count vector) 0
1060             (nhash.vector.cache-key vector) free-hash-marker
1061             (nhash.vector.cache-value vector) nil
1062             (nhash.vector.finalization-alist vector) nil
1063             (nhash.vector.free-alist vector) nil
1064             (nhash.vector.weak-deletions-count vector) 0
1065             (nhash.vector.deleted-count vector) 0
1066             (nhash.vector.flags vector) (logand $nhash_weak_flags_mask
1067                                                 (nhash.vector.flags vector))))
1068     (unlock-hash-table hash nil)
1069     hash)))
1070
1071
1072(defun puthash (key hash default &optional (value default))
1073  (declare (optimize (speed 3) (space 0)))
1074  (unless (typep hash 'hash-table)
1075    (report-bad-arg hash 'hash-table))
1076  (when (or (eq key free-hash-marker)
1077            (eq key deleted-hash-key-marker))
1078    (error "Can't use ~s as a hash-table key" key))
1079  (when (hash-lock-free-p hash)
1080    (return-from puthash (lock-free-puthash key hash value)))
1081  (with-lock-context
1082    (without-interrupts
1083     (block protected
1084       (tagbody
1085          (write-lock-hash-table hash)
1086        AGAIN
1087          (%lock-gc-lock)
1088          (let ((vector (nhash.vector hash)))
1089            (when (%needs-rehashing-p vector)
1090              (%rehash hash))
1091            (when (eq key (nhash.vector.cache-key vector))
1092              (let* ((idx (nhash.vector.cache-idx vector)))
1093                (declare (fixnum idx))
1094                (setf (%svref vector (the fixnum (1+ (the fixnum (index->vector-index idx)))))
1095                      value)
1096                (setf (nhash.vector.cache-value vector) value)
1097                (return-from protected)))               
1098            (let* ((vector-index (funcall (nhash.find-new hash) hash key))
1099                   (old-value (%svref vector vector-index)))
1100              (declare (fixnum vector-index))
1101
1102              (cond ((eq old-value deleted-hash-key-marker)
1103                     (%set-hash-table-vector-key vector vector-index key)
1104                     (setf (%svref vector (the fixnum (1+ vector-index))) value)
1105                     (incf (the fixnum (nhash.vector.count vector)))
1106                     ;; Adjust deleted-count
1107                     (when (> 0 (the fixnum
1108                                  (decf (the fixnum
1109                                          (nhash.vector.deleted-count vector)))))
1110                       (%normalize-hash-table-count hash)))
1111                    ((eq old-value free-hash-marker)
1112                     (when (eql 0 (nhash.grow-threshold hash))
1113                       (%unlock-gc-lock)
1114                       (%grow-hash-table hash)
1115                       (go AGAIN))
1116                     (%set-hash-table-vector-key vector vector-index key)
1117                     (setf (%svref vector (the fixnum (1+ vector-index))) value)
1118                     (decf (the fixnum (nhash.grow-threshold hash)))
1119                     (incf (the fixnum (nhash.vector.count vector))))
1120                    (t
1121                     ;; Key was already there, update value.
1122                     (setf (%svref vector (the fixnum (1+ vector-index))) value)))
1123              (setf (nhash.vector.cache-idx vector) (vector-index->index vector-index)
1124                    (nhash.vector.cache-key vector) key
1125                    (nhash.vector.cache-value vector) value)))))
1126     (%unlock-gc-lock)
1127     (unlock-hash-table hash nil)))
1128  value)
1129
1130
1131(defun count-entries (hash)
1132  (if (hash-lock-free-p hash)
1133    (lock-free-count-entries hash)
1134    (let* ((vector (nhash.vector hash))
1135           (size (uvsize vector))
1136           (idx $nhash.vector_overhead)
1137           (count 0))
1138      (loop
1139        (when (neq (%svref vector idx) free-hash-marker)
1140          (incf count))
1141        (when (>= (setq idx (+ idx 2)) size)
1142          (return count))))))
1143
1144
1145
1146
1147
1148     
1149
1150(defun grow-hash-table (hash)
1151  (unless (typep hash 'hash-table)
1152    (setq hash (require-type hash 'hash-table)))
1153  (%grow-hash-table hash))
1154
1155(defun %grow-hash-table-in-place-p (hash)
1156  ;; Arbitrarily: if the number of deleted entries is > half
1157  ;; the number of used entries, do an in-place rehash.
1158  (let* ((vec (nhash.vector hash)))
1159    (> (the fixnum (nhash.vector.deleted-count vec))
1160       (the fixnum (ash (the fixnum (nhash.vector.count vec)) -1)))))
1161           
1162
1163;;; Interrupts are disabled, and the caller has an exclusive
1164;;; lock on the hash table.
1165(defun %grow-hash-table (hash)
1166  (block grow-hash-table
1167    (%normalize-hash-table-count hash)
1168    (let* ((old-vector (nhash.vector hash))
1169           (old-size (nhash.vector.count old-vector))
1170           (old-total-size (nhash.vector.size old-vector))
1171           (flags 0)
1172           (flags-sans-weak 0)
1173           (weak-flags nil))
1174      (declare (fixnum old-total-size flags flags-sans-weak))
1175      (when (%grow-hash-table-in-place-p hash)
1176        ;; There are enough deleted entries. Rehash to get rid of them
1177        (%rehash hash)
1178        (return-from grow-hash-table))
1179      (multiple-value-bind (size total-size)
1180                           (compute-hash-size 
1181                            old-size (nhash.rehash-size hash) (nhash.rehash-ratio hash))
1182        (unless (eql 0 (nhash.grow-threshold hash))       ; maybe it's done already - shouldnt happen               
1183          (return-from grow-hash-table ))
1184        (progn
1185          (unwind-protect
1186            (let ((gc-count (%get-gc-count))
1187                  vector)
1188              (setq flags (nhash.vector.flags old-vector)
1189                    flags-sans-weak (logand flags (logxor -1 $nhash_weak_flags_mask))
1190                    weak-flags (logand flags $nhash_weak_flags_mask))
1191              (setf (nhash.vector.flags old-vector) flags-sans-weak)      ; disable GC weak stuff
1192              (%normalize-hash-table-count hash)
1193              (when (%grow-hash-table-in-place-p hash)
1194                (setf (nhash.vector.flags old-vector) flags)
1195                (setq weak-flags nil)
1196                (return-from grow-hash-table (%rehash hash)))
1197              (setq vector (%cons-nhash-vector total-size 0))
1198              (do* ((index 0 (1+ index))
1199                    (vector-index (index->vector-index 0) (+ vector-index 2)))
1200                   ((>= index old-total-size))
1201                (declare (fixnum index vector-index))
1202               
1203                 (let ((key (%svref old-vector vector-index)))
1204                   (unless (or (eq key free-hash-marker)
1205                               (eq key deleted-hash-key-marker))
1206                     (let* ((new-index (%growhash-probe vector hash key))
1207                            (new-vector-index (index->vector-index new-index)))
1208                       (setf (%svref vector new-vector-index) key)
1209                       (setf (%svref vector (the fixnum (1+ new-vector-index)))
1210                             (%svref old-vector (the fixnum (1+ vector-index))))))))
1211              (progn
1212               (setf (nhash.vector.finalization-alist vector)
1213                     (nhash.vector.finalization-alist old-vector)
1214                     (nhash.vector.free-alist vector)
1215                     (nhash.vector.free-alist old-vector)
1216                     (nhash.vector.count vector) old-size
1217                     (nhash.vector.flags vector)
1218                     (logior (the fixnum weak-flags)
1219                             (the fixnum (nhash.vector.flags vector))))
1220               (setf (nhash.rehash-bits hash) nil
1221                     (nhash.vector hash) vector
1222                     (nhash.vector.hash vector) hash
1223                     (nhash.vector.cache-key vector) free-hash-marker
1224                     (nhash.vector.cache-value vector) nil
1225                     (nhash.vector.gc-count vector) gc-count
1226                     (nhash.grow-threshold hash) (- size old-size))
1227               (setq weak-flags nil)       ; tell clean-up form we finished the loop
1228               ;; If the old vector's in some static heap, zero it
1229               ;; so that less garbage is retained.
1230               (%init-misc 0 old-vector)))
1231            (when weak-flags
1232              (setf (nhash.vector.flags old-vector)
1233                    (logior (the fixnum weak-flags)
1234                            (the fixnum (nhash.vector.flags old-vector)))))))))))
1235
1236
1237
1238(defun general-hash-find (hash key)
1239  (%hash-probe hash key nil))
1240
1241(defun general-hash-find-for-put (hash key)
1242  (%hash-probe hash key (if (hash-lock-free-p hash) :free :reuse)))
1243
1244;;; returns a single value:
1245;;;   index - the index in the vector for key (where it was or where
1246;;;           to insert if the current key at that index is deleted-hash-key-marker
1247;;;           or free-hash-marker)
1248
1249
1250
1251(defun %hash-probe (hash key for-put-p)
1252  (declare (optimize (speed 3) (space 0)))
1253  (multiple-value-bind (hash-code index entries)
1254                       (compute-hash-code hash key for-put-p)
1255    (locally (declare (fixnum hash-code index entries))
1256      (let* ((compareF (nhash.compareF hash))
1257             (vector (nhash.vector hash))
1258             (vector-index 0)
1259             table-key
1260             (first-deleted-index nil))
1261        (declare (fixnum vector-index))
1262        (macrolet ((return-it (form)
1263                     `(return-from %hash-probe ,form)))
1264          (macrolet ((test-it (predicate)
1265                       (unless (listp predicate) (setq predicate (list predicate)))
1266                       `(progn
1267                          (setq vector-index (index->vector-index index)
1268                                table-key (%svref vector vector-index))
1269                          (cond ((eq table-key free-hash-marker)
1270                                 (return-it (if for-put-p
1271                                              (or first-deleted-index
1272                                                  vector-index)
1273                                              -1)))
1274                                ((eq table-key deleted-hash-key-marker)
1275                                 (when (and (eq for-put-p :reuse)
1276                                            (null first-deleted-index))
1277                                   (setq first-deleted-index vector-index)))
1278                                ((,@predicate key table-key)
1279                                 (return-it vector-index))))))
1280            (macrolet ((do-it (predicate)
1281                         `(progn
1282                            (test-it ,predicate)
1283                            ; First probe failed. Iterate on secondary key
1284                            (let ((initial-index index)
1285                                  (secondary-hash (%svref secondary-keys (logand 7 hash-code)))
1286                                  (DEBUG-COUNT 0))
1287                              (declare (fixnum secondary-hash initial-index))
1288                              (loop
1289                                (INCF DEBUG-COUNT)
1290                                (incf index secondary-hash)
1291                                (when (>= index entries)
1292                                  (decf index entries))
1293                                (when (eql index initial-index)
1294                                  (return-it (if for-put-p
1295                                               (or first-deleted-index
1296                                                   #+NOT-SO-HELPFUL (error "Bug: no room in table")
1297                                                   (bug (format nil "No room in table after ~s tests, ~%initial ~s index ~s entries ~s for-put-p ~s"
1298                                                                DEBUG-COUNT initial-index index entries for-put-p))
1299                                                   )
1300                                               -1)))
1301                                (test-it ,predicate))))))
1302              (if (fixnump comparef)
1303                ;; EQ or EQL hash table
1304                (if (or (eql 0 comparef)
1305                        (immediate-p-macro key)
1306                        (not (need-use-eql key)))
1307                  ;; EQ hash table or EQL == EQ for KEY
1308                  (do-it eq)
1309                  (do-it eql))
1310                ;; general compare function
1311                (do-it (funcall comparef))))))))))
1312
1313(defun eq-hash-find (hash key)
1314  (declare (optimize (speed 3) (safety 0)))
1315  #+eq-hash-monitor (progn
1316                      (incf eq-hash-find-calls)
1317                      (incf eq-hash-find-probes))
1318  (let* ((vector (nhash.vector hash))
1319         (hash-code
1320          (let* ((typecode (typecode key)))
1321            (if (eq typecode target::tag-fixnum)
1322              (mixup-hash-code key)
1323              (if (eq typecode target::subtag-instance)
1324                (mixup-hash-code (instance.hash key))
1325                (if (symbolp key)
1326                  (%hash-symbol key)
1327                  (mixup-hash-code (strip-tag-to-fixnum key)))))))
1328         (entries (nhash.vector-size vector))
1329         (vector-index (index->vector-index (hash-mod hash-code entries vector)))
1330         (table-key (%svref vector vector-index)))
1331    (declare (fixnum hash-code  entries vector-index))
1332    (if (eq table-key key)
1333      vector-index
1334      (if (eq table-key free-hash-marker)
1335        -1
1336        (let* ((secondary-hash (%svref secondary-keys-*-2
1337                                       (logand 7 hash-code)))
1338               (initial-index vector-index)             
1339               (count (+ entries entries))
1340               (length (+ count $nhash.vector_overhead)))
1341          (declare (fixnum secondary-hash initial-index count length))
1342          (loop
1343            #+eq-hash-monitor (incf eq-hash-find-probes)
1344            (incf vector-index secondary-hash)
1345            (when (>= vector-index length)
1346              (decf vector-index count))
1347            (setq table-key (%svref vector vector-index))
1348            (when (= vector-index initial-index)
1349              (return -1))
1350            (if (eq table-key key)
1351              (return vector-index)
1352              (when (eq table-key free-hash-marker)
1353                (return -1)))))))))
1354
1355;;; As above, but note whether the key is in some way address-based
1356;;; and update the hash-vector's flags word if so.
1357;;; This only needs to be done by PUTHASH, and it only really needs
1358;;; to be done if we're adding a new key.
1359(defun eq-hash-find-for-put (hash key)
1360  (declare (optimize (speed 3) (safety 0)))
1361  #+eq-hash-monitor (progn
1362                      (incf eq-hash-find-for-put-calls)
1363                      (incf eq-hash-find-for-put-probes))
1364  (let* ((vector (nhash.vector hash))
1365         (hash-code
1366          (let* ((typecode (typecode key)))
1367            (if (eq typecode target::tag-fixnum)
1368              (mixup-hash-code key)
1369              (if (eq typecode target::subtag-instance)
1370                (mixup-hash-code (instance.hash key))
1371                (if (symbolp key)
1372                  (%hash-symbol key)
1373                  (progn
1374                    (unless (immediate-p-macro key)
1375                      (update-hash-flags hash vector :key))
1376                    (mixup-hash-code (strip-tag-to-fixnum key))))))))
1377         (entries (nhash.vector-size vector))
1378         (vector-index (index->vector-index (hash-mod hash-code entries vector)))
1379         (table-key (%svref vector vector-index))
1380         (reuse (not (hash-lock-free-p hash))))
1381    (declare (fixnum hash-code vector-index))
1382    (if (or (eq key table-key)
1383            (eq table-key free-hash-marker))
1384      vector-index
1385      (let* ((secondary-hash (%svref secondary-keys-*-2
1386                                     (logand 7 hash-code)))
1387             (initial-index vector-index)             
1388             (first-deleted-index (and reuse
1389                                       (eq table-key deleted-hash-key-marker)
1390                                       vector-index))
1391             (count (+ entries entries))
1392             (length (+ count $nhash.vector_overhead)))
1393        (declare (fixnum secondary-hash initial-index count length))
1394        (loop
1395          #+eq-hash-monitor (incf eq-hash-find-for-put-probes)
1396          (incf vector-index secondary-hash)
1397          (when (>= vector-index length)
1398            (decf vector-index count))
1399          (setq table-key (%svref vector vector-index))
1400          (when (= vector-index initial-index)
1401            (return (or first-deleted-index
1402                        (error "Bug: no room in table"))))
1403          (if (eq table-key key)
1404            (return vector-index)
1405            (if (eq table-key free-hash-marker)
1406              (return (or first-deleted-index vector-index))
1407              (if (and reuse
1408                       (null first-deleted-index)
1409                       (eq table-key deleted-hash-key-marker))
1410                (setq first-deleted-index vector-index)))))))))
1411
1412(defun eql-hash-find (hash key)
1413  (declare (optimize (speed 3) (safety 0)))
1414  (if (need-use-eql key)
1415    (let* ((vector (nhash.vector hash))
1416           (hash-code (%%eqlhash-internal key))
1417           (entries (nhash.vector-size vector))
1418           (vector-index (index->vector-index (hash-mod hash-code entries vector)))
1419           (table-key (%svref vector vector-index)))
1420      (declare (fixnum hash-code entries vector-index))
1421      (if (eql key table-key)
1422        vector-index
1423        (if (eq table-key free-hash-marker)
1424          -1
1425          (let* ((secondary-hash (%svref secondary-keys-*-2
1426                                         (logand 7 hash-code)))
1427                 (initial-index vector-index)
1428                 (count (+ entries entries))
1429                 (length (+ count $nhash.vector_overhead)))
1430            (declare (fixnum secondary-hash initial-index count length))
1431            (loop
1432              (incf vector-index secondary-hash)
1433              (when (>= vector-index length)
1434                (decf vector-index count))
1435              (setq table-key (%svref vector vector-index))
1436              (when (= vector-index initial-index)
1437                (return -1))
1438              (if (eql table-key key)
1439                (return vector-index)
1440                (when (eq table-key free-hash-marker)
1441                  (return -1))))))))
1442    (eq-hash-find hash key)))
1443
1444(defun eql-hash-find-for-put (hash key)
1445  (declare (optimize (speed 3) (safety 0)))
1446  (if (need-use-eql key)
1447    (let* ((vector (nhash.vector hash))
1448           (hash-code (%%eqlhash-internal key))
1449           (entries (nhash.vector-size vector))
1450           (vector-index (index->vector-index (hash-mod hash-code entries vector)))
1451           (table-key (%svref vector vector-index))
1452           (reuse (not (hash-lock-free-p hash))))
1453      (declare (fixnum hash-code entries vector-index))
1454      (if (or (eql key table-key)
1455              (eq table-key free-hash-marker))
1456        vector-index
1457        (let* ((secondary-hash (%svref secondary-keys-*-2
1458                                       (logand 7 hash-code)))
1459               (initial-index vector-index)
1460               (first-deleted-index (and reuse
1461                                         (eq table-key deleted-hash-key-marker)
1462                                         vector-index))
1463               (count (+ entries entries))
1464               (length (+ count $nhash.vector_overhead)))
1465          (declare (fixnum secondary-hash initial-index count length))
1466          (loop
1467            (incf vector-index secondary-hash)
1468            (when (>= vector-index length)
1469              (decf vector-index count))
1470            (setq table-key (%svref vector vector-index))
1471            (when (= vector-index initial-index)
1472              (return (or first-deleted-index
1473                          (error "Bug: no room in table"))))
1474            (if (eql table-key key)
1475              (return vector-index)
1476              (if (eq table-key free-hash-marker)
1477                (return (or first-deleted-index vector-index))
1478                (if (and reuse
1479                         (null first-deleted-index)
1480                         (eq table-key deleted-hash-key-marker))
1481                  (setq first-deleted-index vector-index))))))))
1482    (eq-hash-find-for-put hash key)))
1483
1484(defun %make-rehash-bits (hash &optional (size (nhash.vector-size (nhash.vector hash))))
1485  (declare (fixnum size))
1486  (let ((rehash-bits (nhash.rehash-bits hash)))
1487    (unless (and rehash-bits
1488                 (>= (uvsize rehash-bits) size))
1489      (return-from %make-rehash-bits
1490        (setf (nhash.rehash-bits hash) (make-array size :element-type 'bit :initial-element 0))))
1491    (fill (the simple-bit-vector rehash-bits) 0)))
1492
1493;;; Rehash.  Caller should have exclusive access to the hash table
1494;;; and have disabled interrupts.
1495(defun %rehash (hash)
1496  (when (hash-lock-free-p hash)
1497    (error "How did we get here?"))
1498  (let* ((vector (nhash.vector hash))
1499         (flags (nhash.vector.flags vector))
1500         (vector-index (- $nhash.vector_overhead 2))
1501         (size (nhash.vector-size vector))
1502         (rehash-bits (%make-rehash-bits hash size))
1503         (index -1))
1504    (declare (fixnum size index vector-index))
1505    (setf (nhash.vector.flags vector)
1506          (logand flags $nhash-clear-key-bits-mask))
1507    (setf (nhash.vector.cache-key vector) free-hash-marker
1508          (nhash.vector.cache-value vector) nil)
1509    (%set-does-not-need-rehashing vector)
1510    (loop
1511      (when (>= (incf index) size) (return))
1512      (setq vector-index (+ vector-index 2))
1513      (unless (%already-rehashed-p index rehash-bits)
1514        (let* ((key (%svref vector vector-index))
1515               (deleted (eq key deleted-hash-key-marker)))
1516          (unless
1517            (when (or deleted (eq key free-hash-marker))
1518              (if deleted  ; one less deleted entry
1519                (let ((count (1- (nhash.vector.deleted-count vector))))
1520                  (declare (fixnum count))
1521                  (setf (nhash.vector.deleted-count vector) count)
1522                  (if (< count 0)
1523                    (let ((wdc (nhash.vector.weak-deletions-count vector)))
1524                      (setf (nhash.vector.weak-deletions-count vector) 0)
1525                      (incf (nhash.vector.deleted-count vector) wdc)
1526                      (decf (nhash.vector.count vector) wdc)))
1527                  (incf (nhash.grow-threshold hash))
1528                  ;; Change deleted to free
1529                  (setf (%svref vector vector-index) free-hash-marker)))
1530              t)
1531            (let* ((last-index index)
1532                   (value (%svref vector (the fixnum (1+ vector-index))))
1533                   (first t))
1534                (loop
1535                  (let ((vector (nhash.vector hash))
1536                        (found-index (%rehash-probe rehash-bits hash key)))
1537                    (%set-already-rehashed-p found-index rehash-bits)
1538                    (if (eq last-index found-index)
1539                      (return)
1540                      (let* ((found-vector-index (index->vector-index found-index))
1541                             (newkey (%svref vector found-vector-index))
1542                             (newvalue (%svref vector (the fixnum (1+ found-vector-index)))))
1543                        (declare (fixnum found-vector-index))
1544                        (when first ; or (eq last-index index) ?
1545                          (setq first nil)
1546                          (setf (%svref vector vector-index) free-hash-marker)
1547                          (setf (%svref vector (the fixnum (1+ vector-index))) free-hash-marker))
1548                        (%set-hash-table-vector-key vector found-vector-index key)
1549                        (setf (%svref vector (the fixnum (1+ found-vector-index))) value)                       
1550                        (when (or (eq newkey free-hash-marker)
1551                                  (setq deleted (eq newkey deleted-hash-key-marker)))
1552                          (when deleted
1553                            (let ((count (1- (nhash.vector.deleted-count vector))))
1554                              (declare (fixnum count))
1555                              (setf (nhash.vector.deleted-count vector) count)
1556                              (if (< count 0)
1557                                (let ((wdc (nhash.vector.weak-deletions-count vector)))
1558                                  (setf (nhash.vector.weak-deletions-count vector) 0)
1559                                  (incf (nhash.vector.deleted-count vector) wdc)
1560                                  (decf (nhash.vector.count vector) wdc)))
1561                              (incf (nhash.grow-threshold hash))))
1562                          (return))
1563                        (when (eq key newkey)
1564                          (cerror "Delete one of the entries." "Duplicate key: ~s in ~s ~s ~s ~s ~s"
1565                                  key hash value newvalue index found-index)                       
1566                          (decf (nhash.vector.count vector))
1567                          (incf (nhash.grow-threshold hash))
1568                          (return))
1569                        (setq key newkey
1570                              value newvalue
1571                              last-index found-index)))))))))))
1572    t )
1573
1574;;; Hash to an index that is not set in rehash-bits
1575 
1576(defun %rehash-probe (rehash-bits hash key &optional (vector (nhash.vector hash)))
1577  (declare (optimize (speed 3)(safety 0))) 
1578  (multiple-value-bind (hash-code index entries)(compute-hash-code hash key t vector)
1579    (declare (fixnum hash-code index entries))
1580    (when (null hash-code)(cerror "nuts" "Nuts"))
1581    (let* ((vector-index (index->vector-index index)))
1582      (if (or (not (%already-rehashed-p index rehash-bits))
1583              (eq key (%svref vector vector-index)))
1584        (return-from %rehash-probe index)
1585        (let ((second (%svref secondary-keys (%ilogand 7 hash-code))))
1586          (declare (fixnum second))
1587          (loop
1588            (setq index (+ index second))
1589            (when (>= index entries)
1590              (setq index (- index entries)))
1591            (when (or (not (%already-rehashed-p index rehash-bits))
1592                      (eq key (%svref vector (index->vector-index index))))
1593              (return-from %rehash-probe index))))))))
1594
1595;;; Returns one value: the index of the entry in the vector
1596;;; Since we're growing, we don't need to compare and can't find a key that's
1597;;; already there.
1598(defun %growhash-probe (vector hash key)
1599  (declare (optimize (speed 3)(safety 0)))
1600  (multiple-value-bind (hash-code index entries)(compute-hash-code hash key t vector)
1601    (declare (fixnum hash-code index entries))
1602    (let* ((vector-index (index->vector-index  index))
1603           (vector-key nil))
1604      (declare (fixnum vector-index))
1605      (if (or (eq free-hash-marker
1606                  (setq vector-key (%svref vector vector-index)))
1607              (eq deleted-hash-key-marker vector-key))
1608        (return-from %growhash-probe index)
1609        (let ((second (%svref secondary-keys (%ilogand 7 hash-code))))
1610          (declare (fixnum second))
1611          (loop
1612            (setq index (+ index second))
1613            (when (>= index entries)
1614              (setq index (- index entries)))
1615            (when (or (eq free-hash-marker
1616                          (setq vector-key (%svref vector (index->vector-index index))))
1617                      (eq deleted-hash-key-marker vector-key))
1618              (return-from %growhash-probe index))))))))
1619
1620;;;;;;;;;;;;;
1621;;
1622;; Mapping functions are in "ccl:lib;hash"
1623;;
1624
1625
1626
1627;;;;;;;;;;;;;
1628;;
1629;; Hashing functions
1630;; EQ & the EQ part of EQL are done in-line.
1631;;
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641;;; so whats so special about bit vectors as opposed to any other vectors of bytes
1642;;; For starters, it's guaranteed that they exist in the implementation; that may
1643;;; not be true of other immediate vector types.
1644(defun bit-vector-hash (bv)
1645  (declare (optimize (speed 3)(safety 0)))
1646  (let ((length (length bv)))
1647    (declare (fixnum length)) ;will this always be true? it's true of all vectors.
1648    (multiple-value-bind (data offset) (array-data-and-offset bv)
1649      (declare (type simple-bit-vector data) (fixnum offset))
1650      (let* ((hash 0)
1651             (limit (+ length offset))
1652             (nbytes (ash (the fixnum (+ length 7)) -3)))
1653        (declare (fixnum hash limit nbytes))
1654        (dotimes (i nbytes (mixup-hash-code hash))
1655          (let* ((w 0))
1656            (declare (fixnum w))
1657            (dotimes (j 8 (setq hash (+ (the fixnum (ash hash -3))  w)))
1658              (setq w (the fixnum
1659                        (logxor
1660                         (the fixnum
1661                           (ash (if (< offset limit) 
1662                                  (the fixnum (sbit data offset))
1663                                  0)
1664                                (the fixnum j)))
1665                         w)))
1666              (incf offset))))))))
1667
1668#|
1669(defun bit-vector-hash (bv)
1670  (declare (optimize (speed 3)(safety 0)))
1671  (let ((length (length bv)))
1672    (declare (fixnum length))
1673    (let* ((all (+ length 15))
1674           (nwds (ash all -4))
1675           (rem (logand all 15))
1676           (hash 0)
1677           (mask (ash (the fixnum (1- (the fixnum (expt 2 rem))))(the fixnum(- 16 rem)))))
1678      (declare (fixnum all nwds rem hash mask))
1679      (multiple-value-bind (data offset)
1680                           (array-data-and-offset bv)
1681        (declare (fixnum offset))
1682        (locally (declare (type (simple-array (unsigned-byte 16) (*)) data))
1683          (dotimes (i nwds)
1684            (setq hash (%i+ hash (aref data (the fixnum (+ i offset))))))
1685          (when (neq 0 mask)           
1686            (setq hash (%i+ hash (%ilogand mask (aref data (the fixnum (+ offset nwds)))))))
1687          (mixup-hash-code hash))))))
1688|#
1689
1690
1691;;; Same as %%equalhash, but different:
1692;;;  1) Real numbers are hashed as if they were double-floats.  The real components of complex numbers
1693;;;     are hashed as double-floats and XORed together.
1694;;;  2) Characters and strings are hashed in a case-insensitive manner.
1695;;;  3) Hash tables are hashed based on their size and type.
1696;;;  4) Structures and CL array types are hashed based on their content.
1697
1698
1699;;; check fixnum befor immediate-p. call %%eqlhash
1700
1701(defun %%equalphash (key)
1702  (cond ((or (fixnump key)(short-float-p key))
1703         (%dfloat-hash (float key 1.0d0))) 
1704        ((immediate-p-macro key)
1705         (mixup-hash-code (strip-tag-to-fixnum (if (characterp key)(char-upcase key) key))))
1706        ((bignump key)
1707         (if (<= most-negative-double-float key most-positive-double-float)
1708           (%dfloat-hash (float key 1.0d0))  ; with-stack-double-floats
1709           (%%eqlhash-internal key)))
1710        ((double-float-p key)
1711         (%dfloat-hash key))
1712        ((ratiop key)
1713         (%ilogxor (%%equalphash (numerator key)) (%%equalphash (denominator key))))
1714        ((complexp key)
1715         (%ilogxor (%%equalphash (realpart key)) (%%equalphash (imagpart key))))
1716        ((hash-table-p key)
1717         (equalphash-hash-table key))
1718        ((or (istructp key)
1719             (structurep key))  ; was (gvectorp key)
1720         (%%equalphash-structure 11 key))
1721        ((or (arrayp key)) ;(uvectorp key)) ;??
1722         (%%equalphash-array 11 key))
1723        ((consp key)
1724         (%%equalphash-aux 11 key))
1725        (t (%%eqlhash key))))
1726
1727
1728(defun equalphash-hash-table (hash-table)
1729  (let ((hash (%%equalhash "HASH-TABLE"))
1730        addressp)
1731    (declare (fixnum hash))
1732    (incf hash (the fixnum (%%eqhash (hash-table-count hash-table))))
1733    (multiple-value-bind (h ap) (%%eqhash (nhash.comparef hash-table))
1734      (declare (fixnum h))
1735      (incf hash h)
1736      (if ap (setq addressp t)))
1737    (multiple-value-bind (h ap) (%%eqhash (nhash.keytransF hash-table))
1738      (declare (fixnum h))
1739      (incf hash h)
1740      (if ap (setq addressp t)))
1741    (values hash addressp)))
1742
1743(defun %%equalphash-structure (limit key)
1744  (let* ((size (uvsize key))
1745         (hash (mixup-hash-code size))
1746         addressp)
1747    (declare (fixnum limit size hash))
1748    (dotimes (i size)
1749      (multiple-value-bind (h ap) (%%equalphash-aux limit (%svref key i))
1750        (declare (fixnum h))
1751        (setq hash (the fixnum (+ (the fixnum (rotate-hash-code hash)) h)))
1752        (if ap (setq addressp t)))
1753      (when (<= (decf limit) 0)
1754        (setq hash (the fixnum (+ (the fixnum (rotate-hash-code hash))
1755                                  (the fixnum (mixup-hash-code 11)))))
1756        (return)))
1757    (values hash addressp)))
1758
1759(defun %%equalphash-array (limit key)
1760  (multiple-value-bind (array offset) (array-data-and-offset key)
1761    (let* ((rank (array-rank key))
1762           (vectorp (eql rank 1))
1763           (size (if vectorp (length key) (array-total-size key)))
1764           (hash (mixup-hash-code rank))
1765           addressp)
1766      (declare (fixnum size hash limit rank))
1767      (if vectorp
1768        (setq hash
1769              (the fixnum
1770                   (+ (the fixnum (rotate-hash-code hash))
1771                      (the fixnum (mixup-hash-code size)))))
1772        (dotimes (i rank)
1773          (declare (fixnum i))
1774          (setq hash
1775                (the fixnum 
1776                     (+ (the fixnum (rotate-hash-code hash))
1777                        (the fixnum
1778                             (mixup-hash-code (array-dimension key i))))))))     
1779      (dotimes (i size)
1780        (declare (fixnum i))
1781        (multiple-value-bind (h ap) (%%equalphash-aux limit (uvref array offset))
1782          (declare (fixnum h))
1783          (setq hash (the fixnum (+ (the fixnum (rotate-hash-code hash)) h)))
1784          (if ap (setq addressp t)))
1785        (when (<= (decf limit) 0)
1786          (setq hash (the fixnum (+ (the fixnum (rotate-hash-code hash))
1787                                    (the fixnum (mixup-hash-code 11)))))
1788          (return))
1789        (incf offset))
1790      (values hash addressp))))
1791
1792(defun %%equalphash-aux (limit key)
1793  (if (<= limit 0) 
1794    (mixup-hash-code 11)
1795    (if (null key) (mixup-hash-code 17)
1796        (cond ((consp key)
1797               (let ((hash 0)
1798                     address-p)
1799                 (do ((l limit (1- l)))
1800                     ((eq l 0)(values hash address-p))
1801                   (multiple-value-bind (ahash ap)
1802                                        (%%equalphash-aux l (if (consp key)(car key) key))
1803                     (setq hash (mixup-hash-code (logxor ahash hash)))
1804                     (if ap (setq address-p t)))
1805                   (when (not (consp key))
1806                     (return (values hash address-p)))
1807                   (setq key (cdr key)))))
1808              ((typep key 'hash-table)
1809               (equalphash-hash-table key))
1810              ; what are the dudes called that contain bits? they are uvectors but not gvectors?
1811              ; ivectors.
1812              ((or (istructp key)
1813                   (structurep key))    ;was (gvectorp key)
1814               (%%equalphash-structure limit key))
1815              ((or (arrayp key))  ; (uvectorp key))
1816               (%%equalphash-array limit key))
1817              (t (%%equalphash key))))))
1818
1819(defun alist-hash-table (alist &rest hash-table-args)
1820  (declare (dynamic-extent hash-table-args))
1821  (if (typep alist 'hash-table)
1822    alist
1823    (let ((hash-table (apply #'make-hash-table hash-table-args)))
1824      (dolist (cons alist) (puthash (car cons) hash-table (cdr cons)))
1825      hash-table)))
1826
1827(defun %hash-table-equalp (x y)
1828  ;; X and Y are both hash tables
1829  (and (eq (hash-table-test x)
1830           (hash-table-test y))
1831       (eql (hash-table-count x)
1832            (hash-table-count y))
1833       (block nil
1834         (let* ((default (cons nil nil))
1835                (foo #'(lambda (k v)
1836                         (let ((y-value (gethash k y default)))
1837                           (unless (and (neq default y-value)
1838                                        (equalp v y-value))
1839                             (return nil))))))
1840           (declare (dynamic-extent foo default))
1841           (maphash foo x))
1842         t)))
1843
1844(defun sxhash (s-expr)
1845  "Computes a hash code for S-EXPR and returns it as an integer."
1846  (logand (sxhash-aux s-expr 7 17) target::target-most-positive-fixnum))
1847
1848(defun sxhash-aux (expr counter key)
1849  (declare (fixnum counter))
1850  (if (> counter 0)
1851    (typecase expr
1852      ((or string bit-vector number character)  (+ key (%%equalhash expr)))
1853      (logical-pathname
1854       (dotimes (i (uvsize expr) key)
1855         (declare (fixnum i))
1856         (setq key (+ key (sxhash-aux (%svref expr i) (1- counter) key)))))
1857      (pathname
1858       ;; Don't consider %PHYSICAL-PATHNAME-VERSION to be significant
1859       (dotimes (i (uvsize expr) key)
1860         (declare (fixnum i))
1861         (unless (= i %physical-pathname-version)
1862           (setq key (+ key (sxhash-aux (%svref expr i) (1- counter) key))))))
1863      (symbol (+ key (%%equalhash (symbol-name expr))))
1864      (cons (sxhash-aux
1865             (cdr expr)
1866             (the fixnum (1- counter))             
1867             (+ key (sxhash-aux (car expr) (the fixnum (1- counter)) key))))
1868      (t (+  key (%%equalhash (symbol-name (%type-of expr))))))
1869    key))
1870
1871
1872
1873#+(or ppc32-target x8632-target)
1874(defun immediate-p (thing)
1875  (let* ((tag (lisptag thing)))
1876    (declare (fixnum tag))
1877    (or (= tag target::tag-fixnum)
1878        (= tag target::tag-imm))))
1879
1880#+ppc64-target
1881(defun immediate-p (thing)
1882  (let* ((tag (lisptag thing)))
1883    (declare (fixnum tag))
1884    (or (= tag ppc64::tag-fixnum)
1885        (= (logand tag ppc64::lowtagmask) ppc64::lowtag-imm))))
1886
1887#+x8664-target
1888(defun immediate-p (thing)
1889  (let* ((tag (lisptag thing)))
1890    (declare (type (unsigned-byte 3) tag))
1891    (logbitp tag
1892             (logior (ash 1 x8664::tag-fixnum)
1893                     (ash 1 x8664::tag-imm-0)
1894                     (ash 1 x8664::tag-imm-1)))))
1895
1896
1897
1898(defun %cons-nhash-vector (size &optional (flags 0))
1899  (declare (fixnum size))
1900  (let* ((vector (%alloc-misc (+ (+ size size) $nhash.vector_overhead) target::subtag-hash-vector free-hash-marker)))
1901    (%init-nhash-vector vector flags)
1902    vector))
1903
1904(defun %init-nhash-vector (vector flags)
1905  (let ((size (vector-index->index (uvsize vector))))
1906    (declare (fixnum size))
1907    (setf (nhash.vector.link vector) 0
1908          (nhash.vector.flags vector) flags
1909          (nhash.vector.gc-count vector) (%get-gc-count)
1910          (nhash.vector.free-alist vector) nil
1911          (nhash.vector.finalization-alist vector) nil
1912          (nhash.vector.weak-deletions-count vector) 0
1913          (nhash.vector.hash vector) nil
1914          (nhash.vector.deleted-count vector) 0
1915          (nhash.vector.count vector) 0
1916          (nhash.vector.cache-key vector) free-hash-marker
1917          (nhash.vector.cache-value vector) nil
1918          (nhash.vector.cache-idx vector) nil
1919          (nhash.vector.size vector) size
1920          (nhash.vector.size-reciprocal vector) (floor (ash 1 (- target::nbits-in-word target::fixnumshift)) size))))
1921
1922(defun assert-hash-table-readonly (hash)
1923  (unless (typep hash 'hash-table)
1924    (report-bad-arg hash 'hash-table))
1925  (or (nhash.read-only hash)
1926      (when (nhash.owner hash)
1927        (error "Hash~table ~s is thread-private and can't be made read-only for that reason" hash))
1928      (if (hash-lock-free-p hash)
1929        (setf (nhash.read-only hash) t)
1930        (with-lock-context
1931          (without-interrupts
1932           (write-lock-hash-table hash)
1933           (let* ((flags (nhash.vector.flags (nhash.vector hash))))
1934             (declare (fixnum flags))
1935             (when (or (logbitp $nhash_track_keys_bit flags)
1936                       (logbitp $nhash_component_address_bit flags))
1937               (format t "~&Hash-table ~s uses address-based hashing and can't yet be made read-only for that reason." hash)
1938               (unlock-hash-table hash nil)
1939               (return-from assert-hash-table-readonly nil))
1940             (setf (nhash.read-only hash) t)
1941             (unlock-hash-table hash nil)
1942             t))))))
1943
1944;; This is dangerous, if multiple threads are accessing a read-only
1945;; hash table. Use it responsibly.
1946(defun assert-hash-table-writeable (hash)
1947  (unless (typep hash 'hash-table)
1948    (report-bad-arg hash 'hash-table))
1949  (when (nhash.read-only hash)
1950    (setf (nhash.read-only hash) nil)
1951    t))
1952
1953(defun readonly-hash-table-p (hash)
1954  (unless (typep hash 'hash-table)
1955    (report-bad-arg hash 'hash-table))
1956  (nhash.read-only hash))
1957
1958(defun hash-table-owner (hash)
1959  (unless (typep hash 'hash-table)
1960    (report-bad-arg hash 'hash-table))
1961  (nhash.owner hash))
1962
1963(defun claim-hash-table (hash &optional steal)
1964  (unless (typep hash 'hash-table)
1965    (report-bad-arg hash 'hash-table))
1966  (let* ((owner (nhash.owner hash)))
1967    (if owner
1968      (or (eq owner *current-process*)
1969          (when steal
1970            (setf (nhash.owner hash) *current-process*)))
1971      (progn
1972        (unless (hash-lock-free-p hash)
1973          (write-lock-hash-table hash)
1974          (setf (nhash.exclusion-lock hash) nil))
1975        (setf (nhash.owner hash) *current-process*)
1976        t))))
1977
1978 
1979;; ** TODO: for lock-free hash tables, maybe we don't need to copy,
1980;; we could map over the actual hash table vector, because it's
1981;; always valid.
1982(defun lock-free-enumerate-hash-keys-and-values (hash keys values)
1983  (do* ((in (nhash.vector hash))
1984        (in-idx $nhash.vector_overhead (+ in-idx 2))
1985        (insize (uvsize in))
1986        (outsize (length (or keys values)))
1987        (out-idx 0))
1988       ((or (= in-idx insize)
1989            (= out-idx outsize))
1990        out-idx)
1991    (declare (fixnum in-idx insize out-idx outsize))
1992    (let* ((key (%svref in in-idx)))
1993      (unless (eq key free-hash-marker)
1994        (let ((val (%svref in (%i+ in-idx 1))))
1995          (when (eq val rehashing-value-marker)
1996            ;; This table is being rehashed.  Wait to finish and try again
1997            (lock-free-rehash hash)
1998            (return-from lock-free-enumerate-hash-keys-and-values
1999                         (lock-free-enumerate-hash-keys-and-values hash keys values)))
2000          (unless (or (eq key deleted-hash-key-marker)
2001                      (eq val deleted-hash-value-marker)
2002                      (eq val free-hash-marker))
2003            (when keys (setf (%svref keys out-idx) key))
2004            (when values (setf (%svref values out-idx) val))
2005            (incf out-idx)))))))
2006
2007(defun enumerate-hash-keys-and-values (hash keys values)
2008  (unless (typep hash 'hash-table)
2009    (report-bad-arg hash 'hash-table))
2010  (when (hash-lock-free-p hash)
2011    (return-from enumerate-hash-keys-and-values
2012                 (lock-free-enumerate-hash-keys-and-values hash keys values)))
2013  (with-lock-context
2014    (without-interrupts
2015     (let* ((readonly (eq (read-lock-hash-table hash) :readonly)))
2016       (do* ((in (nhash.vector hash))
2017             (in-idx $nhash.vector_overhead (+ in-idx 2))
2018             (insize (uvsize in))
2019             (outsize (length (or keys values)))
2020             (out-idx 0))
2021           ((or (= in-idx insize)
2022                (= out-idx outsize))
2023              (unlock-hash-table hash readonly)
2024              out-idx)
2025         (declare (fixnum in-idx insize out-idx outsize))
2026         (let* ((key (%svref in in-idx)))
2027           (unless (or (eq key free-hash-marker)
2028                       (eq key deleted-hash-key-marker))
2029             (when keys
2030               (setf (%svref keys out-idx) key))
2031             (when values
2032               (setf (%svref values out-idx) (%svref in (%i+ in-idx 1))))
2033             (incf out-idx))))))))
2034
2035(defun enumerate-hash-keys (hash out)
2036  (enumerate-hash-keys-and-values hash out nil))
Note: See TracBrowser for help on using the repository browser.