source: branches/qres/ccl/level-0/l0-hash.lisp @ 14049

Last change on this file since 14049 was 13070, checked in by gz, 10 years ago

r13066, r13067 from trunk: copyrights etc

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