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

Last change on this file since 16085 was 16085, checked in by gb, 8 years ago

First attempt to merge acode-rewrite branch into trunk.

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