source: release/1.9/source/level-0/l0-misc.lisp @ 15889

Last change on this file since 15889 was 15889, checked in by rme, 6 years ago

Merge to 1.9 from trunk.

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