source: branches/shrink-tcr/level-0/l0-misc.lisp @ 14606

Last change on this file since 14606 was 14606, checked in by rme, 9 years ago

Checkpoint of work in progress.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 42.5 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;;; Bootstrapping for futexes
22#+(and linux-target (or x86-target arm-target))
23(eval-when (:compile-toplevel :execute)
24  (pushnew :futex *features*))
25
26#+futex
27(eval-when (:compile-toplevel :execute)
28  ;; We only need a few constants from <linux/futex.h>, which may
29  ;; not have been included in the :libc .cdb files.
30  (defconstant FUTEX-WAIT 0)
31  (defconstant FUTEX-WAKE 1)
32  (defconstant futex-avail 0)
33  (defconstant futex-locked 1)
34  (defconstant futex-contended 2)
35  (declaim (inline %lock-futex %unlock-futex)))
36
37;;; Miscellany.
38
39(defun memq (item list)
40  (do* ((tail list (%cdr tail)))
41       ((null tail))
42    (if (eq item (car tail))
43      (return tail))))
44
45(defun %copy-u8-to-string (u8-vector source-idx string dest-idx n)
46  (declare (optimize (speed 3) (safety 0))
47           (fixnum source-idx dest-idx n)
48           (type (simple-array (unsigned-byte 8) (*)) u8-vector)
49           (simple-base-string string))
50  (do* ((i 0 (1+ i)))
51       ((= i n) string)
52    (declare (fixnum i))
53    (setf (%scharcode string dest-idx) (aref u8-vector source-idx))
54    (incf source-idx)
55    (incf dest-idx)))
56
57(defun %copy-string-to-u8 (string source-idx u8-vector dest-idx n)
58  (declare (optimize (speed 3) (safety 0))
59           (fixnum source-idx dest-idx n)
60           (type (simple-array (unsigned-byte 8) (*)) u8-vector)
61           (simple-base-string string))
62  (do* ((i 0 (1+ i)))
63       ((= i n) u8-vector)
64    (declare (fixnum i))
65    (let* ((code (%scharcode string source-idx)))
66      (declare (type (mod #x11000) code))
67      (if (> code #xff)
68        (setq code (char-code #\Sub)))
69      (setf (aref u8-vector dest-idx) code)
70      (incf source-idx)
71      (incf dest-idx))))
72   
73       
74
75
76(defun append-2 (y z)
77  (if (null y)
78    z
79    (let* ((new (cons (car y) nil))
80           (tail new))
81      (declare (list new tail))
82      (dolist (head (cdr y))
83        (setq tail (cdr (rplacd tail (cons head nil)))))
84      (rplacd tail z)
85      new)))
86
87
88
89
90
91
92
93
94
95(defun dbg (&optional arg)
96  (dbg arg))
97
98
99; This takes a simple-base-string and passes a C string into
100; the kernel "Bug" routine.  Not too fancy, but neither is #_DebugStr,
101; and there's a better chance that users would see this message.
102(defun bug (arg)
103  (if (typep arg 'simple-base-string)
104    #+x86-target
105    (debug-trap-with-string arg)
106    #-x86-target
107    (let* ((len (length arg)))
108      (%stack-block ((buf (1+ len)))
109        (%cstr-pointer arg buf)
110        (ff-call 
111         (%kernel-import target::kernel-import-lisp-bug)
112         :address buf
113         :void)))
114    (bug "Bug called with non-simple-base-string.")))
115
116(defun total-bytes-allocated ()
117  (%heap-bytes-allocated)
118  #+not-any-more
119  (+ (unsignedwide->integer *total-bytes-freed*)
120     (%heap-bytes-allocated)))
121
122(defun %freebytes ()
123  (with-macptrs (p)
124    (%setf-macptr-to-object p
125                            (%fixnum-ref (%get-kernel-global 'all-areas)
126                                         target::area.succ))
127    (- (%get-natural p target::area.high)
128       (%get-natural p target::area.active))))
129
130(defun %reservedbytes ()
131  (with-macptrs (p)
132    (%setf-macptr-to-object p (%get-kernel-global 'all-areas))
133    (- #+32-bit-target
134       (%get-unsigned-long p target::area.high)
135       #+64-bit-target
136       (%%get-unsigned-longlong p target::area.high)
137       #+32-bit-target
138       (%get-unsigned-long p target::area.low)
139       #+64-bit-target
140       (%%get-unsigned-longlong p target::area.low))))
141
142(defun object-in-application-heap-p (address)
143  (declare (ignore address))
144  t)
145
146(defun frozen-space-dnodes ()
147  "Returns the current size of the frozen area."
148  (%fixnum-ref-natural (%get-kernel-global 'tenured-area)
149                       target::area.static-dnodes))
150(defun %usedbytes ()
151  (with-lock-grabbed (*kernel-exception-lock*)
152    (with-lock-grabbed (*kernel-tcr-area-lock*)
153      (%normalize-areas)
154      (let ((static 0)
155            (dynamic 0)
156            (library 0))
157        (do-consing-areas (area)
158          (let* ((active (%fixnum-ref area target::area.active))
159                 (bytes (ash (- active
160                                (%fixnum-ref area target::area.low))
161                             target::fixnumshift))
162                 (code (%fixnum-ref area target::area.code)))
163            (when (object-in-application-heap-p active)
164              (if (eql code area-dynamic)
165                (incf dynamic bytes)
166                (if (eql code area-managed-static)
167                  (incf library bytes)
168                  (incf static bytes))))))
169        (let* ((frozen-size (ash (frozen-space-dnodes) target::dnode-shift)))
170          (decf dynamic frozen-size)
171          (values dynamic static library frozen-size))))))
172
173
174
175(defun %stack-space ()
176  (%normalize-areas)
177  (let ((free 0)
178        (used 0))
179    (with-macptrs (p)
180      (do-gc-areas (area)
181        (when (member (%fixnum-ref area target::area.code)
182                      '(#.area-vstack
183                        #.area-cstack
184                      #.area-tstack))
185          (%setf-macptr-to-object p area)
186          (let ((active
187                 #+32-bit-target
188                  (%get-unsigned-long p target::area.active)
189                  #+64-bit-target
190                  (%%get-unsigned-longlong p target::area.active))
191                (high
192                 #+32-bit-target
193                  (%get-unsigned-long p target::area.high)
194                  #+64-bit-target
195                  (%%get-unsigned-longlong p target::area.high))
196                (low
197                 #+32-bit-target
198                 (%get-unsigned-long p target::area.low)
199                 #+64-bit-target
200                 (%%get-unsigned-longlong p target::area.low)))
201            (incf used (- high active))
202            (incf free (- active low))))))
203    (values (+ free used) used free)))
204
205
206
207; Returns an alist of the form:
208; ((thread cstack-free cstack-used vstack-free vstack-used tstack-free tstack-used)
209;  ...)
210(defun %stack-space-by-lisp-thread ()
211  (let* ((res nil))
212    (without-interrupts
213     (dolist (p (all-processes))
214       (let* ((thread (process-thread p)))
215         (when thread
216           (push (cons thread (multiple-value-list (%thread-stack-space thread))) res)))))
217    res))
218
219
220
221;;; Returns six values on most platforms, 4 on ARM.
222;;;   sp free
223;;;   sp used
224;;;   vsp free
225;;;   vsp used
226;;;   tsp free  (not on ARM)
227;;;   tsp used  (not on ARM)
228(defun %thread-stack-space (&optional (thread *current-lisp-thread*))
229  (when (eq thread *current-lisp-thread*)
230    (%normalize-areas))
231  (labels ((free-and-used (area)
232             (with-macptrs (p)
233               (%setf-macptr-to-object p area)
234               (let* ((low
235                       #+32-bit-target
236                       (%get-unsigned-long p target::area.low)
237                       #+64-bit-target
238                       (%%get-unsigned-longlong p target::area.low))
239                      (high
240                       #+32-bit-target
241                        (%get-unsigned-long p target::area.high)
242                        #+64-bit-target
243                        (%%get-unsigned-longlong p target::area.high))
244                      (active
245                       #+32-bit-target
246                       (%get-unsigned-long p target::area.active)
247                       #+64-bit-target
248                       (%%get-unsigned-longlong p target::area.active))
249                      (free (- active low))
250                      (used (- high active)))
251                 (loop
252                     (setq area (%fixnum-ref area target::area.older))
253                     (when (eql area 0) (return))
254                   (%setf-macptr-to-object p area)
255                   (let ((low
256                          #+32-bit-target
257                           (%get-unsigned-long p target::area.low)
258                           #+64-bit-target
259                           (%%get-unsigned-longlong p target::area.low))
260                         (high
261                          #+32-bit-target
262                           (%get-unsigned-long p target::area.high)
263                           #+64-bit-target
264                           (%%get-unsigned-longlong p target::area.high)))
265                     (declare (fixnum low high))
266                     (incf used (- high low))))
267                 (values free used)))))
268    (let* ((tcr (lisp-thread.tcr thread))
269           (cs-area #+(and windows-target x8632-target)
270                    (%fixnum-ref (%fixnum-ref tcr (- target::tcr.aux
271                                                     target::tcr-bias))
272                                 target::tcr-aux.cs-area)
273                    #-(and windows-target x8632-target)
274                    (%fixnum-ref tcr target::tcr.cs-area)))
275      (if (or (null tcr)
276              (zerop (%fixnum-ref cs-area)))
277        (values 0 0 0 0 0 0)
278        (multiple-value-bind (cf cu) (free-and-used cs-area)
279          (multiple-value-bind (vf vu) (free-and-used (%fixnum-ref tcr target::tcr.vs-area))
280            #+arm-target
281            (values cf cu vf vu)
282            #-arm-target
283            (multiple-value-bind (tf tu) (free-and-used (%fixnum-ref tcr target::tcr.ts-area ))
284              (values cf cu vf vu tf tu))))))))
285
286
287(defun room (&optional (verbose :default))
288  "Print to *STANDARD-OUTPUT* information about the state of internal
289  storage and its management. The optional argument controls the
290  verbosity of output. If it is T, ROOM prints out a maximal amount of
291  information. If it is NIL, ROOM prints out a minimal amount of
292  information. If it is :DEFAULT or it is not supplied, ROOM prints out
293  an intermediate amount of information."
294  (let* ((freebytes nil)
295         (usedbytes nil)
296         (static-used nil)
297         (staticlib-used nil)
298         (frozen-space-size nil)
299         (lispheap nil)
300         (reserved nil)
301         (static nil)
302         (stack-total)
303         (stack-used)
304         (stack-free)
305         (static-cons-reserved nil)
306         (stack-used-by-thread nil))
307    (progn
308      (progn
309        (setq freebytes (%freebytes))
310        (when verbose
311          (multiple-value-setq (usedbytes static-used staticlib-used frozen-space-size)
312            (%usedbytes))
313          (setq lispheap (+ freebytes usedbytes)
314                reserved (%reservedbytes)
315                static (+ static-used staticlib-used frozen-space-size))
316          (multiple-value-setq (stack-total stack-used stack-free)
317            (%stack-space))
318          (unless (eq verbose :default)
319            (setq stack-used-by-thread (%stack-space-by-lisp-thread))))))
320    (format t "~&Approximately ~:D bytes of memory can be allocated ~%before the next full GC is triggered. ~%" freebytes)
321    (when verbose
322      (flet ((k (n) (round n 1024)))
323        (princ "
324                   Total Size             Free                 Used")
325        (format t "~&Lisp Heap:~15t~10D (~DK)~35t~10D (~DK)~55t~10D (~DK)"
326                lispheap (k lispheap)
327                freebytes (k freebytes)
328                usedbytes (k usedbytes))
329        (format t "~&Stacks:~15t~10D (~DK)~35t~10D (~DK)~55t~10D (~DK)"
330                stack-total (k stack-total)
331                stack-free (k stack-free)
332                stack-used (k stack-used))
333        (format t "~&Static:~15t~10D (~DK)~35t~10D (~DK)~55t~10D (~DK)"
334                static (k static)
335                0 0
336                static (k static))
337        (when (and frozen-space-size (not (zerop frozen-space-size)))
338          (setq static-cons-reserved (ash (reserved-static-conses) target::dnode-shift)
339                frozen-space-size (- frozen-space-size static-cons-reserved))
340          (unless (zerop static-cons-reserved)
341            (format t "~&~,3f MB of reserved static conses (~d free, ~d reserved)"
342                    (/ static-cons-reserved (float (ash 1 20)))
343                    (free-static-conses)
344                    (reserved-static-conses)))
345
346          (unless (zerop frozen-space-size)
347                  (format t "~&~,3f MB of static memory is \"frozen\" dynamic memory"
348                          (/ frozen-space-size (float (ash 1 20))))))
349        (format t "~&~,3f MB reserved for heap expansion."
350                (/ reserved (float (ash 1 20))))
351        (unless (eq verbose :default)
352          (terpri)
353          (let* ((processes (all-processes)))
354            (dolist (thread-info stack-used-by-thread)
355              (destructuring-bind (thread sp-free sp-used vsp-free vsp-used #-arm-target tsp-free #-arm-target tsp-used)
356                  thread-info
357                (let* ((process (dolist (p processes)
358                                  (when (eq (process-thread p) thread)
359                                    (return p)))))
360                  (when process
361                    (let ((sp-total (+ sp-used sp-free))
362                          (vsp-total (+ vsp-used vsp-free))
363                          #-arm-target
364                          (tsp-total (+ tsp-used tsp-free)))
365                      (format t "~%~a(~d)~%  cstack:~12T~10D (~DK)  ~33T~10D (~DK)  ~54T~10D (~DK)~
366                               ~%  vstack:~12T~10D (~DK)  ~33T~10D (~DK)  ~54T~10D (~DK)"
367                              (process-name process)
368                              (process-serial-number process)
369                              sp-total (k sp-total) sp-free (k sp-free) sp-used (k sp-used)
370                              vsp-total (k vsp-total) vsp-free (k vsp-free) vsp-used  (k vsp-used))
371                      #-arm-target
372                      (format t
373                               "~%  tstack:~12T~10D (~DK)  ~33T~10D (~DK)  ~54T~10D (~DK)"
374
375                              tsp-total (k tsp-total) tsp-free (k tsp-free) tsp-used (k tsp-used)))))))))))))
376
377
378(defun list-length (l)
379  "Return the length of the given LIST, or NIL if the LIST is circular."
380  (do* ((n 0 (+ n 2))
381        (fast l (cddr fast))
382        (slow l (cdr slow)))
383       ((null fast) n)
384    (declare (fixnum n))
385    (if (null (cdr fast))
386      (return (the fixnum (1+ n)))
387      (if (and (eq fast slow)
388               (> n 0))
389        (return nil)))))
390
391(defun proper-list-p (l)
392  (and (typep l 'list)
393       (do* ((n 0 (+ n 2))
394             (fast l (if (and (listp fast) (listp (cdr fast)))
395                       (cddr fast)
396                       (return-from proper-list-p nil)))
397             (slow l (cdr slow)))
398            ((null fast) n)
399         (declare (fixnum n))
400         (if (atom fast)
401           (return nil)
402           (if (null (cdr fast))
403             (return t)
404             (if (and (eq fast slow)
405                      (> n 0))
406               (return nil)))))))
407
408(defun proper-sequence-p (x)
409  (cond ((typep x 'vector))
410        ((typep x 'list) (not (null (list-length x))))))
411
412
413(defun length (seq)
414  "Return an integer that is the length of SEQUENCE."
415  (seq-dispatch
416   seq
417   (or (list-length seq)
418       (%err-disp $XIMPROPERLIST seq))
419   (if (= (the fixnum (typecode seq)) target::subtag-vectorH)
420     (%svref seq target::vectorH.logsize-cell)
421     (uvsize seq))))
422
423(defun %str-from-ptr (pointer len &optional (dest (make-string len)))
424  (declare (fixnum len)
425           (optimize (speed 3) (safety 0)))
426  (dotimes (i len dest)
427    (setf (%scharcode dest i) (%get-unsigned-byte pointer i))))
428
429(defun %get-cstring (pointer)
430  (do* ((end 0 (1+ end)))
431       ((zerop (the (unsigned-byte 8) (%get-unsigned-byte pointer end)))
432        (%str-from-ptr pointer end))
433    (declare (fixnum end))))
434
435(defun %get-utf-8-cstring (pointer)
436  (do* ((end 0 (1+ end)))
437       ((zerop (the (unsigned-byte 8) (%get-unsigned-byte pointer end)))
438        (let* ((len (utf-8-length-of-memory-encoding pointer end 0))
439               (string (make-string len)))
440          (utf-8-memory-decode pointer end 0 string)
441          string))
442    (declare (fixnum end))))
443
444;;; Assumes that pointer is terminated by a 0-valued 16-bit word
445;;; and that it points to a valid utf-16 string with native endianness.
446(defun %get-native-utf-16-cstring (pointer)
447  (do* ((nchars 0 (1+ nchars))
448        (i 0 (+ i 2))
449        (code (%get-unsigned-word pointer i) (%get-unsigned-word pointer i)))
450       ((zerop code)
451        (do* ((string (make-string nchars))
452              (out 0 (1+ out))
453              (i 0 (+ i 2)))
454             ((= out nchars) string)
455          (declare (fixnum i out))
456          (let* ((code (%get-unsigned-word pointer i)))
457            (declare (type (unsigned-byte 16) code))
458            (when (and (>= code #xd800)
459                       (< code #xdc00))
460              (incf i 2)
461              (let* ((code2 (%get-unsigned-word pointer i)))
462                (declare (type (unsigned-byte 16) code2))
463                (setq code (utf-16-combine-surrogate-pairs code code2))))
464            (setf (schar string out) (code-char code)))))
465    (when (and (>= code #xd800) (< code #xdc00))
466      (incf i 2))))
467
468
469;;; This is mostly here so we can bootstrap shared libs without
470;;; having to bootstrap #_strcmp.
471;;; Return true if the cstrings are equal, false otherwise.
472(defun %cstrcmp (x y)
473  (do* ((i 0 (1+ i))
474        (bx (%get-byte x i) (%get-byte x i))
475        (by (%get-byte y i) (%get-byte y i)))
476       ((not (= bx by)))
477    (declare (fixnum i bx by))
478    (when (zerop bx)
479      (return t))))
480
481(defun %cnstrcmp (x y n)
482  (declare (fixnum n))
483  (do* ((i 0 (1+ i))
484        (bx (%get-byte x i) (%get-byte x i))
485        (by (%get-byte y i) (%get-byte y i)))
486       ((= i n) t)
487    (declare (fixnum i bx by))
488    (unless (= bx by)
489      (return))))
490
491(defvar %documentation nil)
492
493(defvar %documentation-lock% nil)
494
495(setq %documentation
496  (make-hash-table :weak t :size 100 :test 'eq :rehash-threshold .95)
497  %documentation-lock% (make-lock))
498
499(defun %put-documentation (thing doc-id doc)
500  (with-lock-grabbed (%documentation-lock%)
501    (let* ((info (gethash thing %documentation))
502           (pair (assoc doc-id info)))
503      (if doc
504        (progn
505          (unless (typep doc 'string)
506            (report-bad-arg doc 'string))
507          (if pair
508            (setf (cdr pair) doc)
509            (setf (gethash thing %documentation) (cons (cons doc-id doc) info))))
510        (when pair
511          (if (setq info (nremove pair info))
512            (setf (gethash thing %documentation) info)
513            (remhash thing %documentation))))))
514  doc)
515
516(defun %get-documentation (object doc-id)
517  (cdr (assoc doc-id (gethash object %documentation))))
518
519;;; This pretends to be (SETF DOCUMENTATION), until that generic function
520;;; is defined.  It handles a few common cases.
521(defun %set-documentation (thing doc-id doc-string)
522  (case doc-id
523    (function 
524     (if (typep thing 'function)
525       (%put-documentation thing t doc-string)
526       (if (typep thing 'symbol)
527         (let* ((def (fboundp thing)))
528           (if def
529             (%put-documentation def t doc-string)))
530         (if (setf-function-name-p thing)
531           (%set-documentation
532            (setf-function-name thing) doc-id doc-string)))))
533    (variable
534     (if (typep thing 'symbol)
535       (%put-documentation thing doc-id doc-string)))
536    (t (%put-documentation thing doc-id doc-string)))
537  doc-string)
538
539
540(%fhave 'set-documentation #'%set-documentation)
541
542
543
544;;; This is intended for use by debugging tools.  It's a horrible thing
545;;; to do otherwise.  The caller really needs to hold the heap-segment
546;;; lock; this grabs the tcr queue lock as well.
547
548
549(defparameter *spin-lock-tries* 1)
550(defparameter *spin-lock-timeouts* 0)
551
552#+(and (not futex) (not x86-target))
553(defun %get-spin-lock (p)
554  (let* ((self (%current-tcr))
555         (n *spin-lock-tries*))
556    (declare (fixnum n))
557    (loop
558      (dotimes (i n)
559        (when (eql 0 (%ptr-store-fixnum-conditional p 0 self))
560          (return-from %get-spin-lock t)))
561      (%atomic-incf-node 1 '*spin-lock-timeouts* target::symbol.vcell)
562      (yield))))
563
564(eval-when (:compile-toplevel :execute)
565  (declaim (inline note-lock-wait note-lock-held note-lock-released)))
566
567
568
569
570
571#-futex
572(defun %lock-recursive-lock-object (lock &optional flag)
573  (let* ((ptr (recursive-lock-ptr lock)))
574    (with-macptrs ((p)
575                   (owner (%get-ptr ptr target::lockptr.owner))
576                   (signal (%get-ptr ptr target::lockptr.signal))
577                   (spin (%inc-ptr ptr target::lockptr.spinlock)))
578      (%setf-macptr-to-object p (%current-tcr))
579      (if (istruct-typep flag 'lock-acquisition)
580        (setf (lock-acquisition.status flag) nil)
581        (if flag (report-bad-arg flag 'lock-acquisition)))
582      (loop
583        (without-interrupts
584         (when (eql p owner)
585           (incf (%get-natural ptr target::lockptr.count))
586           (when flag
587             (setf (lock-acquisition.status flag) t))
588           (return t))
589         (%get-spin-lock spin)
590         (when (eql 1 (incf (%get-natural ptr target::lockptr.avail)))
591           (setf (%get-ptr ptr target::lockptr.owner) p
592                 (%get-natural ptr target::lockptr.count) 1)
593           (setf (%get-natural spin 0) 0)
594           (if flag
595             (setf (lock-acquisition.status flag) t))
596           (return t))
597         (setf (%get-natural spin 0) 0))
598        (%process-wait-on-semaphore-ptr signal 1 0 (recursive-lock-whostate lock))))))
599
600
601
602#+futex
603(progn
604  #-monitor-futex-wait
605  (defun futex-wait (p val whostate)
606    (with-process-whostate (whostate)
607      (int-errno-ffcall
608       (%kernel-import target::kernel-import-lisp-futex)
609       :address p :int FUTEX-WAIT :int val :address (%null-ptr) :address (%null-ptr) :int 0 :int)))
610  #+monitor-futex-wait
611  (progn
612    (defparameter *total-futex-wait-calls* 0)
613    (defparameter *total-futex-wait-times* 0)
614    (defun futex-wait (p val whostate)
615      (with-process-whostate (whostate)
616        (let* ((start (get-internal-real-time)))
617          (incf *total-futex-wait-calls*)
618          (int-errno-ffcall
619           (%kernel-import target::kernel-import-lisp-futex)
620           :address p :int FUTEX-WAIT :int val :address (%null-ptr) :address (%null-ptr) :int 0 :int)
621          (incf *total-futex-wait-times* (- (get-internal-real-time) start)))))))
622   
623
624
625
626#+futex
627(defun futex-wake (p n)
628  (int-errno-ffcall (%kernel-import target::kernel-import-lisp-futex)
629                    :address p :int FUTEX-WAKE :int n :address (%null-ptr) :address (%null-ptr) :int 0 :int))
630
631#+futex
632(defun %lock-futex (p wait-level lock fwhostate)
633  (let* ((val (%ptr-store-conditional p futex-avail futex-locked)))
634    (declare (fixnum val))
635    (or (eql val futex-avail)
636        (loop
637          (if (eql val futex-contended)
638            (let* ((*interrupt-level* wait-level))
639              (futex-wait p val (if fwhostate (funcall fwhostate lock) "futex wait")))
640            (setq val futex-contended))
641          (when (eql futex-avail (xchgl val p))
642            (return t))))))
643
644#+futex
645(defun %unlock-futex (p)
646  (unless (eql futex-avail (%atomic-decf-ptr p))
647    (setf (%get-natural p target::lockptr.avail) futex-avail)
648    (futex-wake p #$INT_MAX)))
649
650
651
652
653#+futex
654(defun %lock-recursive-lock-object (lock &optional flag)
655  (if (istruct-typep flag 'lock-acquisition)
656    (setf (lock-acquisition.status flag) nil)
657    (if flag (report-bad-arg flag 'lock-acquisition)))
658  (let* ((self (%current-tcr))
659         (level *interrupt-level*)
660         (ptr (recursive-lock-ptr lock)))
661    (declare (fixnum self))
662    (without-interrupts
663     (cond ((eql self (%get-object ptr target::lockptr.owner))
664            (incf (%get-natural ptr target::lockptr.count)))
665           (t (%lock-futex ptr level lock #'recursive-lock-whostate)
666              (%set-object ptr target::lockptr.owner self)
667              (setf (%get-natural ptr target::lockptr.count) 1)))
668     (when flag
669       (setf (lock-acquisition.status flag) t))
670     t)))
671
672         
673
674
675
676
677#-futex
678(defun %try-recursive-lock-object (lock &optional flag)
679  (let* ((ptr (recursive-lock-ptr lock)))
680    (with-macptrs ((p)
681                   (owner (%get-ptr ptr target::lockptr.owner))
682                   (spin (%inc-ptr ptr target::lockptr.spinlock)))
683      (%setf-macptr-to-object p (%current-tcr))
684      (if flag
685        (if (istruct-typep flag 'lock-acquisition)
686          (setf (lock-acquisition.status flag) nil)
687          (report-bad-arg flag 'lock-acquisition)))
688      (without-interrupts
689       (cond ((eql p owner)
690              (incf (%get-natural ptr target::lockptr.count))
691              (if flag (setf (lock-acquisition.status flag) t))
692              t)
693             (t
694              (let* ((win nil))
695                (%get-spin-lock spin)
696                (when (setq win (eql 1 (incf (%get-natural ptr target::lockptr.avail))))
697                  (setf (%get-ptr ptr target::lockptr.owner) p
698                        (%get-natural ptr target::lockptr.count) 1)
699                  (if flag (setf (lock-acquisition.status flag) t)))
700                (setf (%get-ptr spin) (%null-ptr))
701                win)))))))
702
703
704
705#+futex
706(defun %try-recursive-lock-object (lock &optional flag)
707  (let* ((self (%current-tcr))
708         (ptr (recursive-lock-ptr lock)))
709    (declare (fixnum self))
710    (if flag
711      (if (istruct-typep flag 'lock-acquisition)
712        (setf (lock-acquisition.status flag) nil)
713        (report-bad-arg flag 'lock-acquisition)))
714    (without-interrupts
715     (cond ((eql (%get-object ptr target::lockptr.owner) self)
716            (incf (%get-natural ptr target::lockptr.count))
717            (if flag (setf (lock-acquisition.status flag) t))
718            t)
719           (t
720            (when (eql 0 (%ptr-store-conditional ptr futex-avail futex-locked))
721              (%set-object ptr target::lockptr.owner self)
722              (setf (%get-natural ptr target::lockptr.count) 1)
723              (if flag (setf (lock-acquisition.status flag) t))
724              t))))))
725
726
727
728
729
730#-futex
731(defun %unlock-recursive-lock-object (lock)
732  (let* ((ptr (%svref lock target::lock._value-cell)))
733    (with-macptrs ((signal (%get-ptr ptr target::lockptr.signal))
734                   (spin (%inc-ptr ptr target::lockptr.spinlock)))
735      (unless (eql (%get-object ptr target::lockptr.owner) (%current-tcr))
736        (error 'not-lock-owner :lock lock))
737      (without-interrupts
738       (when (eql 0 (decf (the fixnum
739                            (%get-natural ptr target::lockptr.count))))
740         (%get-spin-lock spin)
741         (setf (%get-ptr ptr target::lockptr.owner) (%null-ptr))
742         (let* ((pending (+ (the fixnum
743                              (1- (the fixnum (%get-fixnum ptr target::lockptr.avail))))
744                            (the fixnum (%get-fixnum ptr target::lockptr.waiting)))))
745           (declare (fixnum pending))
746           (setf (%get-natural ptr target::lockptr.avail) 0
747                 (%get-natural ptr target::lockptr.waiting) 0)
748           (decf pending)
749           (if (> pending 0)
750             (setf (%get-natural ptr target::lockptr.waiting) pending))
751           (setf (%get-ptr spin) (%null-ptr))
752           (if (>= pending 0)
753             (%signal-semaphore-ptr signal)))))))
754  nil)
755
756
757
758#+futex
759(defun %unlock-recursive-lock-object (lock)
760  (let* ((ptr (%svref lock target::lock._value-cell)))
761    (unless (eql (%get-object ptr target::lockptr.owner) (%current-tcr))
762      (error 'not-lock-owner :lock lock))
763    (without-interrupts
764     (when (eql 0 (decf (the fixnum
765                          (%get-natural ptr target::lockptr.count))))
766    (setf (%get-natural ptr target::lockptr.owner) 0)
767    (%unlock-futex ptr))))
768  nil)
769
770
771
772
773(defun %%lock-owner (lock)
774  "Intended for debugging only; ownership may change while this code
775   is running."
776  (let* ((tcr (%get-object (recursive-lock-ptr lock) target::lockptr.owner)))
777    (unless (zerop tcr)
778      (tcr->process tcr))))
779
780 
781 
782
783
784
785
786(defun %rplaca-conditional (cons-cell old new)
787  (%store-node-conditional target::cons.car cons-cell old new))
788
789(defun %rplacd-conditional (cons-cell old new)
790  (%store-node-conditional target::cons.cdr cons-cell old new))
791
792;;; Atomically push NEW onto the list in the I'th cell of uvector V.
793
794(defun atomic-push-uvector-cell (v i new)
795  (let* ((cell (cons new nil))
796         (offset (+ target::misc-data-offset (ash i target::word-shift))))
797    (loop
798      (let* ((old (%svref v i)))
799        (rplacd cell old)
800        (when (%store-node-conditional offset v old cell)
801          (return cell))))))
802
803(defun atomic-pop-uvector-cell (v i)
804  (let* ((offset (+ target::misc-data-offset (ash i target::word-shift))))
805    (loop
806      (let* ((old (%svref v i)))
807        (if (null old)
808          (return (values nil nil))
809          (let* ((tail (cdr old)))
810            (when (%store-node-conditional offset v old tail)
811              (return (values (car old) t)))))))))
812
813
814(defun store-gvector-conditional (index gvector old new)
815  (%store-node-conditional (+ target::misc-data-offset
816                              (ash index target::word-shift))
817                           gvector
818                           old
819                           new))
820
821(defun %atomic-incf-car (cell &optional (by 1))
822  (%atomic-incf-node (require-type by 'fixnum)
823                     (require-type cell 'cons)
824                     target::cons.car))
825
826(defun %atomic-incf-cdr (cell &optional (by 1))
827  (%atomic-incf-node (require-type by 'fixnum)
828                     (require-type cell 'cons)
829                     target::cons.cdr))
830
831(defun %atomic-incf-gvector (v i &optional (by 1))
832  (setq v (require-type v 'gvector))
833  (setq i (require-type i 'fixnum))
834  (%atomic-incf-node by v (+ target::misc-data-offset (ash i target::word-shift))))
835
836(defun %atomic-incf-symbol-value (s &optional (by 1))
837  (setq s (require-type s 'symbol))
838  (multiple-value-bind (base offset) (%symbol-binding-address s)
839    (%atomic-incf-node by base offset)))
840
841;;; What happens if there are some pending readers and another writer,
842;;; and we abort out of the semaphore wait ?  If the writer semaphore is
843;;; signaled before we abandon interest in it
844#-futex
845(defun %write-lock-rwlock-ptr (ptr lock &optional flag)
846  (with-macptrs ((write-signal (%get-ptr ptr target::rwlock.writer-signal)) )
847    (if (istruct-typep flag 'lock-acquisition)
848      (setf (lock-acquisition.status flag) nil)
849      (if flag (report-bad-arg flag 'lock-acquisition)))
850    (let* ((level *interrupt-level*)
851           (tcr (%current-tcr)))
852      (declare (fixnum tcr))
853      (without-interrupts
854       (%get-spin-lock ptr)               ;(%get-spin-lock (%inc-ptr ptr target::rwlock.spin))
855       (if (eq (%get-object ptr target::rwlock.writer) tcr)
856         (progn
857           (incf (%get-signed-natural ptr target::rwlock.state))
858           (setf (%get-natural ptr target::rwlock.spin) 0)
859           (if flag
860             (setf (lock-acquisition.status flag) t))
861           t)
862         (do* ()
863              ((eql 0 (%get-signed-natural ptr target::rwlock.state))
864               ;; That wasn't so bad, was it ?  We have the spinlock now.
865               (setf (%get-signed-natural ptr target::rwlock.state) 1
866                     (%get-natural ptr target::rwlock.spin) 0)
867               (%set-object ptr target::rwlock.writer tcr)
868               (if flag
869                 (setf (lock-acquisition.status flag) t))
870               t)
871           (incf (%get-natural ptr target::rwlock.blocked-writers))
872           (setf (%get-natural ptr target::rwlock.spin) 0)
873           (let* ((*interrupt-level* level))
874                  (%process-wait-on-semaphore-ptr write-signal 1 0 (rwlock-write-whostate lock)))
875           (%get-spin-lock ptr)))))))
876#+futex
877(defun %write-lock-rwlock-ptr (ptr lock &optional flag)
878  (with-macptrs ((write-signal (%INC-ptr ptr target::rwlock.writer-signal)) )
879    (if (istruct-typep flag 'lock-acquisition)
880      (setf (lock-acquisition.status flag) nil)
881      (if flag (report-bad-arg flag 'lock-acquisition)))
882    (let* ((level *interrupt-level*)
883           (tcr (%current-tcr)))
884      (declare (fixnum tcr))
885      (without-interrupts
886       (%lock-futex ptr level lock nil)
887       (if (eq (%get-object ptr target::rwlock.writer) tcr)
888         (progn
889           (incf (%get-signed-natural ptr target::rwlock.state))
890           (%unlock-futex ptr)
891           (if flag
892             (setf (lock-acquisition.status flag) t))
893           t)
894         (do* ()
895              ((eql 0 (%get-signed-natural ptr target::rwlock.state))
896               ;; That wasn't so bad, was it ?  We have the spinlock now.
897               (setf (%get-signed-natural ptr target::rwlock.state) 1)
898               (setf (%get-signed-long write-signal) -1)
899               (%unlock-futex ptr)
900               (%set-object ptr target::rwlock.writer tcr)
901               (if flag
902                 (setf (lock-acquisition.status flag) t))
903               t)
904           (incf (%get-natural ptr target::rwlock.blocked-writers))
905           (let* ((waitval -1))
906             (%unlock-futex ptr)
907             (with-process-whostate ((rwlock-write-whostate lock))
908               (let* ((*interrupt-level* level))
909                 (futex-wait write-signal waitval (rwlock-write-whostate lock)))))
910           (%lock-futex ptr level lock nil)
911           (decf (%get-natural ptr target::rwlock.blocked-writers))))))))
912
913
914
915(defun write-lock-rwlock (lock &optional flag)
916  (%write-lock-rwlock-ptr (read-write-lock-ptr lock) lock flag))
917
918#-futex
919(defun %read-lock-rwlock-ptr (ptr lock &optional flag)
920  (with-macptrs ((read-signal (%get-ptr ptr target::rwlock.reader-signal)))
921    (if (istruct-typep flag 'lock-acquisition)
922      (setf (lock-acquisition.status flag) nil)
923      (if flag (report-bad-arg flag 'lock-acquisition)))
924    (let* ((level *interrupt-level*)
925           (tcr (%current-tcr)))
926      (declare (fixnum tcr))
927      (without-interrupts
928       (%get-spin-lock ptr)             ;(%get-spin-lock (%inc-ptr ptr target::rwlock.spin))
929       (if (eq (%get-object ptr target::rwlock.writer) tcr)
930         (progn
931           (setf (%get-natural ptr target::rwlock.spin) 0)
932           (error 'deadlock :lock lock))
933         (do* ((state
934                (%get-signed-natural ptr target::rwlock.state)
935                (%get-signed-natural ptr target::rwlock.state)))
936              ((<= state 0)
937               ;; That wasn't so bad, was it ?  We have the spinlock now.
938               (setf (%get-signed-natural ptr target::rwlock.state)
939                     (the fixnum (1- state))
940                     (%get-natural ptr target::rwlock.spin) 0)
941               (if flag
942                 (setf (lock-acquisition.status flag) t))
943               t)
944           (declare (fixnum state))
945           (incf (%get-natural ptr target::rwlock.blocked-readers))
946           (setf (%get-natural ptr target::rwlock.spin) 0)
947           (let* ((*interrupt-level* level))
948             (%process-wait-on-semaphore-ptr read-signal 1 0 (rwlock-read-whostate lock)))
949           (%get-spin-lock ptr)))))))
950
951#+futex
952(defun %read-lock-rwlock-ptr (ptr lock &optional flag) 
953  (with-macptrs ((reader-signal (%INC-ptr ptr target::rwlock.reader-signal)))
954    (if (istruct-typep flag 'lock-acquisition)
955      (setf (lock-acquisition.status flag) nil)
956      (if flag (report-bad-arg flag 'lock-acquisition)))
957    (let* ((level *interrupt-level*)
958           (tcr (%current-tcr)))
959      (declare (fixnum tcr))
960      (without-interrupts
961       (%lock-futex ptr level lock nil)
962       (if (eq (%get-object ptr target::rwlock.writer) tcr)
963         (progn
964           (%unlock-futex ptr)
965           (error 'deadlock :lock lock))
966         (do* ((state
967                (%get-signed-natural ptr target::rwlock.state)
968                (%get-signed-natural ptr target::rwlock.state)))
969              ((<= state 0)
970               ;; That wasn't so bad, was it ?  We have the spinlock now.
971               (setf (%get-signed-natural ptr target::rwlock.state)
972                     (the fixnum (1- state)))
973               (setf (%get-signed-long reader-signal) -1) ; can happen multiple times, but that's harmless
974               (%unlock-futex ptr)
975               (if flag
976                 (setf (lock-acquisition.status flag) t))
977               t)
978           (declare (fixnum state))
979           (incf (%get-natural ptr target::rwlock.blocked-readers))
980           (let* ((waitval -1))
981             (%unlock-futex ptr)
982             (let* ((*interrupt-level* level))
983               (futex-wait reader-signal waitval (rwlock-read-whostate lock))))
984           (%lock-futex ptr level lock nil)
985           (decf (%get-natural ptr target::rwlock.blocked-readers))))))))
986
987
988
989(defun read-lock-rwlock (lock &optional flag)
990  (%read-lock-rwlock-ptr (read-write-lock-ptr lock) lock flag))
991
992
993
994#-futex
995(defun %unlock-rwlock-ptr (ptr lock)
996  (with-macptrs ((reader-signal (%get-ptr ptr target::rwlock.reader-signal))
997                 (writer-signal (%get-ptr ptr target::rwlock.writer-signal)))
998    (without-interrupts
999     (%get-spin-lock ptr)
1000     (let* ((state (%get-signed-natural ptr target::rwlock.state))
1001            (tcr (%current-tcr)))
1002       (declare (fixnum state tcr))
1003       (cond ((> state 0)
1004              (unless (eql tcr (%get-object ptr target::rwlock.writer))
1005                (setf (%get-natural ptr target::rwlock.spin) 0)
1006                (error 'not-lock-owner :lock lock))
1007              (decf state))
1008             ((< state 0) (incf state))
1009             (t (setf (%get-natural ptr target::rwlock.spin) 0)
1010                (error 'not-locked :lock lock)))
1011       (setf (%get-signed-natural ptr target::rwlock.state) state)
1012       (when (zerop state)
1013         ;; We want any thread waiting for a lock semaphore to
1014         ;; be able to wait interruptibly.  When a thread waits,
1015         ;; it increments either the "blocked-readers" or "blocked-writers"
1016         ;; field, but since it may get interrupted before obtaining
1017         ;; the semaphore that's more of "an expression of interest"
1018         ;; in taking the lock than it is "a firm commitment to take it."
1019         ;; It's generally (much) better to signal the semaphore(s)
1020         ;; too often than it would be to not signal them often
1021         ;; enough; spurious wakeups are better than deadlock.
1022         ;; So: if there are blocked writers, the writer-signal
1023         ;; is raised once for each apparent blocked writer.  (At most
1024         ;; one writer will actually succeed in taking the lock.)
1025         ;; If there are blocked readers, the reader-signal is raised
1026         ;; once for each of them.  (It's possible for both the
1027         ;; reader and writer semaphores to be raised on the same
1028         ;; unlock; the writer semaphore is raised first, so in that
1029         ;; sense, writers still have priority but it's not guaranteed.)
1030         ;; Both the "blocked-writers" and "blocked-readers" fields
1031         ;; are cleared here (they can't be changed from another thread
1032         ;; until this thread releases the spinlock.)
1033         (setf (%get-signed-natural ptr target::rwlock.writer) 0)
1034         (let* ((nwriters (%get-natural ptr target::rwlock.blocked-writers))
1035                (nreaders (%get-natural ptr target::rwlock.blocked-readers)))
1036           (declare (fixnum nreaders nwriters))
1037           (when (> nwriters 0)
1038             (setf (%get-natural ptr target::rwlock.blocked-writers) 0)
1039             (dotimes (i nwriters)
1040               (%signal-semaphore-ptr writer-signal)))
1041           (when (> nreaders 0)
1042             (setf (%get-natural ptr target::rwlock.blocked-readers) 0)
1043             (dotimes (i nreaders)
1044               (%signal-semaphore-ptr reader-signal)))))
1045       (setf (%get-natural ptr target::rwlock.spin) 0)
1046       t))))
1047
1048#+futex
1049(defun %unlock-rwlock-ptr (ptr lock)
1050  (with-macptrs ((reader-signal (%INC-ptr ptr target::rwlock.reader-signal))
1051                 (writer-signal (%INC-ptr ptr target::rwlock.writer-signal)))
1052    (let* ((signal nil)
1053           (wakeup 0))
1054    (without-interrupts
1055     (%lock-futex ptr -1 lock nil)
1056     (let* ((state (%get-signed-natural ptr target::rwlock.state))
1057            (tcr (%current-tcr)))
1058       (declare (fixnum state tcr))
1059       (cond ((> state 0)
1060              (unless (eql tcr (%get-object ptr target::rwlock.writer))
1061                (%unlock-futex ptr)
1062                (error 'not-lock-owner :lock lock))
1063              (decf state))
1064             ((< state 0) (incf state))
1065             (t (%unlock-futex ptr)
1066                (error 'not-locked :lock lock)))
1067       (setf (%get-signed-natural ptr target::rwlock.state) state)
1068       (when (zerop state)
1069         (setf (%get-signed-natural ptr target::rwlock.writer) 0)
1070         (let* ((nwriters (%get-natural ptr target::rwlock.blocked-writers))
1071                (nreaders (%get-natural ptr target::rwlock.blocked-readers)))
1072           (declare (fixnum nreaders nwriters))
1073           (if (> nwriters 0)
1074             (setq signal writer-signal wakeup 1)
1075             (if (> nreaders 0)
1076               (setq signal reader-signal wakeup #$INT_MAX)))))
1077       (when signal (setf (%get-signed-long signal) 0))
1078       (%unlock-futex ptr)
1079       (when signal (futex-wake signal wakeup))
1080       t)))))
1081
1082
1083(defun unlock-rwlock (lock)
1084  (%unlock-rwlock-ptr (read-write-lock-ptr lock) lock))
1085
1086;;; There are all kinds of ways to lose here.
1087;;; The caller must have read access to the lock exactly once,
1088;;; or have write access.
1089;;; there's currently no way to detect whether the caller has
1090;;; read access at all.
1091;;; If we have to block and get interrupted, cleanup code may
1092;;; try to unlock a lock that we don't hold. (It might be possible
1093;;; to circumvent that if we use the same notifcation object here
1094;;; that controls that cleanup process.)
1095
1096(defun %promote-rwlock (lock &optional flag)
1097  (let* ((ptr (read-write-lock-ptr lock)))
1098    (if (istruct-typep flag 'lock-acquisition)
1099      (setf (lock-acquisition.status flag) nil)
1100      (if flag (report-bad-arg flag 'lock-acquisition)))
1101    (let* ((level *interrupt-level*)
1102           (tcr (%current-tcr)))
1103      (without-interrupts
1104       #+futex
1105       (%lock-futex ptr level lock nil)
1106       #-futex
1107       (%get-spin-lock ptr)
1108       (let* ((state (%get-signed-natural ptr target::rwlock.state)))
1109         (declare (fixnum state))
1110         (cond ((> state 0)
1111                (unless (eql (%get-object ptr target::rwlock.writer) tcr)
1112                  #+futex
1113                  (%unlock-futex ptr)
1114                  #-futex
1115                  (setf (%get-natural ptr target::rwlock.spin) 0)
1116                  (error :not-lock-owner :lock lock)))
1117               ((= state 0)
1118                #+futex (%unlock-futex ptr)
1119                #-futex (setf (%get-natural ptr target::rwlock.spin) 0)
1120                (error :not-locked :lock lock))
1121               (t
1122                (if (= state -1)
1123                  (progn
1124                    (setf (%get-signed-natural ptr target::rwlock.state) 1)
1125                    (%set-object ptr target::rwlock.writer tcr)
1126                    #+futex
1127                    (%unlock-futex ptr)
1128                    #-futex
1129                    (setf (%get-natural ptr target::rwlock.spin) 0)
1130                    (if flag
1131                      (setf (lock-acquisition.status flag) t))
1132                    t)
1133                  (progn                   
1134                    #+futex
1135                    (%unlock-futex ptr)
1136                    #-futex
1137                    (setf (%get-natural ptr target::rwlock.spin) 0)
1138                    (%unlock-rwlock-ptr ptr lock)
1139                    (let* ((*interrupt-level* level))
1140                      (%write-lock-rwlock-ptr ptr lock flag)))))))))))
1141                     
1142
1143
1144(defun safe-get-ptr (p &optional dest)
1145  (if (null dest)
1146    (setq dest (%null-ptr))
1147    (unless (typep dest 'macptr)
1148      (check-type dest macptr)))
1149  (without-interrupts                   ;reentrancy
1150   (%safe-get-ptr p dest)))
1151
1152
Note: See TracBrowser for help on using the repository browser.