source: branches/arm/level-0/l0-hash.lisp @ 13823

Last change on this file since 13823 was 13823, checked in by gb, 11 years ago

Indentation/formatting changes only.

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