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

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

More tweaks; a cross-compiled Windows x86 lisp now bootstraps on Windows x64.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 42.6 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)
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            (when (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                (setq code (utf-16-combine-surrogate-pairs code code2))))
468            (setf (schar string out) (code-char code)))))
469    (when (and (>= code #xd800) (< code #xdc00))
470      (incf i 2))))
471
472
473;;; This is mostly here so we can bootstrap shared libs without
474;;; having to bootstrap #_strcmp.
475;;; Return true if the cstrings are equal, false otherwise.
476(defun %cstrcmp (x y)
477  (do* ((i 0 (1+ i))
478        (bx (%get-byte x i) (%get-byte x i))
479        (by (%get-byte y i) (%get-byte y i)))
480       ((not (= bx by)))
481    (declare (fixnum i bx by))
482    (when (zerop bx)
483      (return t))))
484
485(defun %cnstrcmp (x y n)
486  (declare (fixnum n))
487  (do* ((i 0 (1+ i))
488        (bx (%get-byte x i) (%get-byte x i))
489        (by (%get-byte y i) (%get-byte y i)))
490       ((= i n) t)
491    (declare (fixnum i bx by))
492    (unless (= bx by)
493      (return))))
494
495(defvar %documentation nil)
496
497(defvar %documentation-lock% nil)
498
499(setq %documentation
500  (make-hash-table :weak t :size 100 :test 'eq :rehash-threshold .95)
501  %documentation-lock% (make-lock))
502
503(defun %put-documentation (thing doc-id doc)
504  (with-lock-grabbed (%documentation-lock%)
505    (let* ((info (gethash thing %documentation))
506           (pair (assoc doc-id info)))
507      (if doc
508        (progn
509          (unless (typep doc 'string)
510            (report-bad-arg doc 'string))
511          (if pair
512            (setf (cdr pair) doc)
513            (setf (gethash thing %documentation) (cons (cons doc-id doc) info))))
514        (when pair
515          (if (setq info (nremove pair info))
516            (setf (gethash thing %documentation) info)
517            (remhash thing %documentation))))))
518  doc)
519
520(defun %get-documentation (object doc-id)
521  (cdr (assoc doc-id (gethash object %documentation))))
522
523;;; This pretends to be (SETF DOCUMENTATION), until that generic function
524;;; is defined.  It handles a few common cases.
525(defun %set-documentation (thing doc-id doc-string)
526  (case doc-id
527    (function 
528     (if (typep thing 'function)
529       (%put-documentation thing t doc-string)
530       (if (typep thing 'symbol)
531         (let* ((def (fboundp thing)))
532           (if def
533             (%put-documentation def t doc-string)))
534         (if (setf-function-name-p thing)
535           (%set-documentation
536            (setf-function-name thing) doc-id doc-string)))))
537    (variable
538     (if (typep thing 'symbol)
539       (%put-documentation thing doc-id doc-string)))
540    (t (%put-documentation thing doc-id doc-string)))
541  doc-string)
542
543
544(%fhave 'set-documentation #'%set-documentation)
545
546
547
548;;; This is intended for use by debugging tools.  It's a horrible thing
549;;; to do otherwise.  The caller really needs to hold the heap-segment
550;;; lock; this grabs the tcr queue lock as well.
551
552
553(defparameter *spin-lock-tries* 1)
554(defparameter *spin-lock-timeouts* 0)
555
556#+(and (not futex) (not x86-target))
557(defun %get-spin-lock (p)
558  (let* ((self (%current-tcr))
559         (n *spin-lock-tries*))
560    (declare (fixnum n))
561    (loop
562      (dotimes (i n)
563        (when (eql 0 (%ptr-store-fixnum-conditional p 0 self))
564          (return-from %get-spin-lock t)))
565      (%atomic-incf-node 1 '*spin-lock-timeouts* target::symbol.vcell)
566      (yield))))
567
568(eval-when (:compile-toplevel :execute)
569  (declaim (inline note-lock-wait note-lock-held note-lock-released)))
570
571
572
573
574
575#-futex
576(defun %lock-recursive-lock-object (lock &optional flag)
577  (let* ((ptr (recursive-lock-ptr lock)))
578    (with-macptrs ((p)
579                   (owner (%get-ptr ptr target::lockptr.owner))
580                   (signal (%get-ptr ptr target::lockptr.signal))
581                   (spin (%inc-ptr ptr target::lockptr.spinlock)))
582      (%setf-macptr-to-object p (%current-tcr))
583      (if (istruct-typep flag 'lock-acquisition)
584        (setf (lock-acquisition.status flag) nil)
585        (if flag (report-bad-arg flag 'lock-acquisition)))
586      (loop
587        (without-interrupts
588         (when (eql p owner)
589           (incf (%get-natural ptr target::lockptr.count))
590           (when flag
591             (setf (lock-acquisition.status flag) t))
592           (return t))
593         (%get-spin-lock spin)
594         (when (eql 1 (incf (%get-natural ptr target::lockptr.avail)))
595           (setf (%get-ptr ptr target::lockptr.owner) p
596                 (%get-natural ptr target::lockptr.count) 1)
597           (setf (%get-natural spin 0) 0)
598           (if flag
599             (setf (lock-acquisition.status flag) t))
600           (return t))
601         (setf (%get-natural spin 0) 0))
602        (%process-wait-on-semaphore-ptr signal 1 0 (recursive-lock-whostate lock))))))
603
604
605
606#+futex
607(progn
608  #-monitor-futex-wait
609  (defun futex-wait (p val whostate)
610    (with-process-whostate (whostate)
611      (int-errno-ffcall
612       (%kernel-import target::kernel-import-lisp-futex)
613       :address p :int FUTEX-WAIT :int val :address (%null-ptr) :address (%null-ptr) :int 0 :int)))
614  #+monitor-futex-wait
615  (progn
616    (defparameter *total-futex-wait-calls* 0)
617    (defparameter *total-futex-wait-times* 0)
618    (defun futex-wait (p val whostate)
619      (with-process-whostate (whostate)
620        (let* ((start (get-internal-real-time)))
621          (incf *total-futex-wait-calls*)
622          (int-errno-ffcall
623           (%kernel-import target::kernel-import-lisp-futex)
624           :address p :int FUTEX-WAIT :int val :address (%null-ptr) :address (%null-ptr) :int 0 :int)
625          (incf *total-futex-wait-times* (- (get-internal-real-time) start)))))))
626   
627
628
629
630#+futex
631(defun futex-wake (p n)
632  (int-errno-ffcall (%kernel-import target::kernel-import-lisp-futex)
633                    :address p :int FUTEX-WAKE :int n :address (%null-ptr) :address (%null-ptr) :int 0 :int))
634
635#+futex
636(defun %lock-futex (p wait-level lock fwhostate)
637  (let* ((val (%ptr-store-conditional p futex-avail futex-locked)))
638    (declare (fixnum val))
639    (or (eql val futex-avail)
640        (loop
641          (if (eql val futex-contended)
642            (let* ((*interrupt-level* wait-level))
643              (futex-wait p val (if fwhostate (funcall fwhostate lock) "futex wait")))
644            (setq val futex-contended))
645          (when (eql futex-avail (xchgl val p))
646            (return t))))))
647
648#+futex
649(defun %unlock-futex (p)
650  (unless (eql futex-avail (%atomic-decf-ptr p))
651    (setf (%get-natural p target::lockptr.avail) futex-avail)
652    (futex-wake p #$INT_MAX)))
653
654
655
656
657#+futex
658(defun %lock-recursive-lock-object (lock &optional flag)
659  (if (istruct-typep flag 'lock-acquisition)
660    (setf (lock-acquisition.status flag) nil)
661    (if flag (report-bad-arg flag 'lock-acquisition)))
662  (let* ((self (%current-tcr))
663         (level *interrupt-level*)
664         (ptr (recursive-lock-ptr lock)))
665    (declare (fixnum self))
666    (without-interrupts
667     (cond ((eql self (%get-object ptr target::lockptr.owner))
668            (incf (%get-natural ptr target::lockptr.count)))
669           (t (%lock-futex ptr level lock #'recursive-lock-whostate)
670              (%set-object ptr target::lockptr.owner self)
671              (setf (%get-natural ptr target::lockptr.count) 1)))
672     (when flag
673       (setf (lock-acquisition.status flag) t))
674     t)))
675
676         
677
678
679
680
681#-futex
682(defun %try-recursive-lock-object (lock &optional flag)
683  (let* ((ptr (recursive-lock-ptr lock)))
684    (with-macptrs ((p)
685                   (owner (%get-ptr ptr target::lockptr.owner))
686                   (spin (%inc-ptr ptr target::lockptr.spinlock)))
687      (%setf-macptr-to-object p (%current-tcr))
688      (if flag
689        (if (istruct-typep flag 'lock-acquisition)
690          (setf (lock-acquisition.status flag) nil)
691          (report-bad-arg flag 'lock-acquisition)))
692      (without-interrupts
693       (cond ((eql p owner)
694              (incf (%get-natural ptr target::lockptr.count))
695              (if flag (setf (lock-acquisition.status flag) t))
696              t)
697             (t
698              (let* ((win nil))
699                (%get-spin-lock spin)
700                (when (setq win (eql 1 (incf (%get-natural ptr target::lockptr.avail))))
701                  (setf (%get-ptr ptr target::lockptr.owner) p
702                        (%get-natural ptr target::lockptr.count) 1)
703                  (if flag (setf (lock-acquisition.status flag) t)))
704                (setf (%get-ptr spin) (%null-ptr))
705                win)))))))
706
707
708
709#+futex
710(defun %try-recursive-lock-object (lock &optional flag)
711  (let* ((self (%current-tcr))
712         (ptr (recursive-lock-ptr lock)))
713    (declare (fixnum self))
714    (if flag
715      (if (istruct-typep flag 'lock-acquisition)
716        (setf (lock-acquisition.status flag) nil)
717        (report-bad-arg flag 'lock-acquisition)))
718    (without-interrupts
719     (cond ((eql (%get-object ptr target::lockptr.owner) self)
720            (incf (%get-natural ptr target::lockptr.count))
721            (if flag (setf (lock-acquisition.status flag) t))
722            t)
723           (t
724            (when (eql 0 (%ptr-store-conditional ptr futex-avail futex-locked))
725              (%set-object ptr target::lockptr.owner self)
726              (setf (%get-natural ptr target::lockptr.count) 1)
727              (if flag (setf (lock-acquisition.status flag) t))
728              t))))))
729
730
731
732
733
734#-futex
735(defun %unlock-recursive-lock-object (lock)
736  (let* ((ptr (%svref lock target::lock._value-cell)))
737    (with-macptrs ((signal (%get-ptr ptr target::lockptr.signal))
738                   (spin (%inc-ptr ptr target::lockptr.spinlock)))
739      (unless (eql (%get-object ptr target::lockptr.owner) (%current-tcr))
740        (error 'not-lock-owner :lock lock))
741      (without-interrupts
742       (when (eql 0 (decf (the fixnum
743                            (%get-natural ptr target::lockptr.count))))
744         (%get-spin-lock spin)
745         (setf (%get-ptr ptr target::lockptr.owner) (%null-ptr))
746         (let* ((pending (+ (the fixnum
747                              (1- (the fixnum (%get-fixnum ptr target::lockptr.avail))))
748                            (the fixnum (%get-fixnum ptr target::lockptr.waiting)))))
749           (declare (fixnum pending))
750           (setf (%get-natural ptr target::lockptr.avail) 0
751                 (%get-natural ptr target::lockptr.waiting) 0)
752           (decf pending)
753           (if (> pending 0)
754             (setf (%get-natural ptr target::lockptr.waiting) pending))
755           (setf (%get-ptr spin) (%null-ptr))
756           (if (>= pending 0)
757             (%signal-semaphore-ptr signal)))))))
758  nil)
759
760
761
762#+futex
763(defun %unlock-recursive-lock-object (lock)
764  (let* ((ptr (%svref lock target::lock._value-cell)))
765    (unless (eql (%get-object ptr target::lockptr.owner) (%current-tcr))
766      (error 'not-lock-owner :lock lock))
767    (without-interrupts
768     (when (eql 0 (decf (the fixnum
769                          (%get-natural ptr target::lockptr.count))))
770    (setf (%get-natural ptr target::lockptr.owner) 0)
771    (%unlock-futex ptr))))
772  nil)
773
774
775
776
777(defun %%lock-owner (lock)
778  "Intended for debugging only; ownership may change while this code
779   is running."
780  (let* ((tcr (%get-object (recursive-lock-ptr lock) target::lockptr.owner)))
781    (unless (zerop tcr)
782      (tcr->process tcr))))
783
784 
785 
786
787
788
789
790(defun %rplaca-conditional (cons-cell old new)
791  (%store-node-conditional target::cons.car cons-cell old new))
792
793(defun %rplacd-conditional (cons-cell old new)
794  (%store-node-conditional target::cons.cdr cons-cell old new))
795
796;;; Atomically push NEW onto the list in the I'th cell of uvector V.
797
798(defun atomic-push-uvector-cell (v i new)
799  (let* ((cell (cons new nil))
800         (offset (+ target::misc-data-offset (ash i target::word-shift))))
801    (loop
802      (let* ((old (%svref v i)))
803        (rplacd cell old)
804        (when (%store-node-conditional offset v old cell)
805          (return cell))))))
806
807(defun atomic-pop-uvector-cell (v i)
808  (let* ((offset (+ target::misc-data-offset (ash i target::word-shift))))
809    (loop
810      (let* ((old (%svref v i)))
811        (if (null old)
812          (return (values nil nil))
813          (let* ((tail (cdr old)))
814            (when (%store-node-conditional offset v old tail)
815              (return (values (car old) t)))))))))
816
817
818(defun store-gvector-conditional (index gvector old new)
819  (%store-node-conditional (+ target::misc-data-offset
820                              (ash index target::word-shift))
821                           gvector
822                           old
823                           new))
824
825(defun %atomic-incf-car (cell &optional (by 1))
826  (%atomic-incf-node (require-type by 'fixnum)
827                     (require-type cell 'cons)
828                     target::cons.car))
829
830(defun %atomic-incf-cdr (cell &optional (by 1))
831  (%atomic-incf-node (require-type by 'fixnum)
832                     (require-type cell 'cons)
833                     target::cons.cdr))
834
835(defun %atomic-incf-gvector (v i &optional (by 1))
836  (setq v (require-type v 'gvector))
837  (setq i (require-type i 'fixnum))
838  (%atomic-incf-node by v (+ target::misc-data-offset (ash i target::word-shift))))
839
840(defun %atomic-incf-symbol-value (s &optional (by 1))
841  (setq s (require-type s 'symbol))
842  (multiple-value-bind (base offset) (%symbol-binding-address s)
843    (%atomic-incf-node by base offset)))
844
845;;; What happens if there are some pending readers and another writer,
846;;; and we abort out of the semaphore wait ?  If the writer semaphore is
847;;; signaled before we abandon interest in it
848#-futex
849(defun %write-lock-rwlock-ptr (ptr lock &optional flag)
850  (with-macptrs ((write-signal (%get-ptr ptr target::rwlock.writer-signal)) )
851    (if (istruct-typep flag 'lock-acquisition)
852      (setf (lock-acquisition.status flag) nil)
853      (if flag (report-bad-arg flag 'lock-acquisition)))
854    (let* ((level *interrupt-level*)
855           (tcr (%current-tcr)))
856      (declare (fixnum tcr))
857      (without-interrupts
858       (%get-spin-lock ptr)               ;(%get-spin-lock (%inc-ptr ptr target::rwlock.spin))
859       (if (eq (%get-object ptr target::rwlock.writer) tcr)
860         (progn
861           (incf (%get-signed-natural ptr target::rwlock.state))
862           (setf (%get-natural ptr target::rwlock.spin) 0)
863           (if flag
864             (setf (lock-acquisition.status flag) t))
865           t)
866         (do* ()
867              ((eql 0 (%get-signed-natural ptr target::rwlock.state))
868               ;; That wasn't so bad, was it ?  We have the spinlock now.
869               (setf (%get-signed-natural ptr target::rwlock.state) 1
870                     (%get-natural ptr target::rwlock.spin) 0)
871               (%set-object ptr target::rwlock.writer tcr)
872               (if flag
873                 (setf (lock-acquisition.status flag) t))
874               t)
875           (incf (%get-natural ptr target::rwlock.blocked-writers))
876           (setf (%get-natural ptr target::rwlock.spin) 0)
877           (let* ((*interrupt-level* level))
878                  (%process-wait-on-semaphore-ptr write-signal 1 0 (rwlock-write-whostate lock)))
879           (%get-spin-lock ptr)))))))
880#+futex
881(defun %write-lock-rwlock-ptr (ptr lock &optional flag)
882  (with-macptrs ((write-signal (%INC-ptr ptr target::rwlock.writer-signal)) )
883    (if (istruct-typep flag 'lock-acquisition)
884      (setf (lock-acquisition.status flag) nil)
885      (if flag (report-bad-arg flag 'lock-acquisition)))
886    (let* ((level *interrupt-level*)
887           (tcr (%current-tcr)))
888      (declare (fixnum tcr))
889      (without-interrupts
890       (%lock-futex ptr level lock nil)
891       (if (eq (%get-object ptr target::rwlock.writer) tcr)
892         (progn
893           (incf (%get-signed-natural ptr target::rwlock.state))
894           (%unlock-futex ptr)
895           (if flag
896             (setf (lock-acquisition.status flag) t))
897           t)
898         (do* ()
899              ((eql 0 (%get-signed-natural ptr target::rwlock.state))
900               ;; That wasn't so bad, was it ?  We have the spinlock now.
901               (setf (%get-signed-natural ptr target::rwlock.state) 1)
902               (setf (%get-signed-long write-signal) -1)
903               (%unlock-futex ptr)
904               (%set-object ptr target::rwlock.writer tcr)
905               (if flag
906                 (setf (lock-acquisition.status flag) t))
907               t)
908           (incf (%get-natural ptr target::rwlock.blocked-writers))
909           (let* ((waitval -1))
910             (%unlock-futex ptr)
911             (with-process-whostate ((rwlock-write-whostate lock))
912               (let* ((*interrupt-level* level))
913                 (futex-wait write-signal waitval (rwlock-write-whostate lock)))))
914           (%lock-futex ptr level lock nil)
915           (decf (%get-natural ptr target::rwlock.blocked-writers))))))))
916
917
918
919(defun write-lock-rwlock (lock &optional flag)
920  (%write-lock-rwlock-ptr (read-write-lock-ptr lock) lock flag))
921
922#-futex
923(defun %read-lock-rwlock-ptr (ptr lock &optional flag)
924  (with-macptrs ((read-signal (%get-ptr ptr target::rwlock.reader-signal)))
925    (if (istruct-typep flag 'lock-acquisition)
926      (setf (lock-acquisition.status flag) nil)
927      (if flag (report-bad-arg flag 'lock-acquisition)))
928    (let* ((level *interrupt-level*)
929           (tcr (%current-tcr)))
930      (declare (fixnum tcr))
931      (without-interrupts
932       (%get-spin-lock ptr)             ;(%get-spin-lock (%inc-ptr ptr target::rwlock.spin))
933       (if (eq (%get-object ptr target::rwlock.writer) tcr)
934         (progn
935           (setf (%get-natural ptr target::rwlock.spin) 0)
936           (error 'deadlock :lock lock))
937         (do* ((state
938                (%get-signed-natural ptr target::rwlock.state)
939                (%get-signed-natural ptr target::rwlock.state)))
940              ((<= state 0)
941               ;; That wasn't so bad, was it ?  We have the spinlock now.
942               (setf (%get-signed-natural ptr target::rwlock.state)
943                     (the fixnum (1- state))
944                     (%get-natural ptr target::rwlock.spin) 0)
945               (if flag
946                 (setf (lock-acquisition.status flag) t))
947               t)
948           (declare (fixnum state))
949           (incf (%get-natural ptr target::rwlock.blocked-readers))
950           (setf (%get-natural ptr target::rwlock.spin) 0)
951           (let* ((*interrupt-level* level))
952             (%process-wait-on-semaphore-ptr read-signal 1 0 (rwlock-read-whostate lock)))
953           (%get-spin-lock ptr)))))))
954
955#+futex
956(defun %read-lock-rwlock-ptr (ptr lock &optional flag) 
957  (with-macptrs ((reader-signal (%INC-ptr ptr target::rwlock.reader-signal)))
958    (if (istruct-typep flag 'lock-acquisition)
959      (setf (lock-acquisition.status flag) nil)
960      (if flag (report-bad-arg flag 'lock-acquisition)))
961    (let* ((level *interrupt-level*)
962           (tcr (%current-tcr)))
963      (declare (fixnum tcr))
964      (without-interrupts
965       (%lock-futex ptr level lock nil)
966       (if (eq (%get-object ptr target::rwlock.writer) tcr)
967         (progn
968           (%unlock-futex ptr)
969           (error 'deadlock :lock lock))
970         (do* ((state
971                (%get-signed-natural ptr target::rwlock.state)
972                (%get-signed-natural ptr target::rwlock.state)))
973              ((<= state 0)
974               ;; That wasn't so bad, was it ?  We have the spinlock now.
975               (setf (%get-signed-natural ptr target::rwlock.state)
976                     (the fixnum (1- state)))
977               (setf (%get-signed-long reader-signal) -1) ; can happen multiple times, but that's harmless
978               (%unlock-futex ptr)
979               (if flag
980                 (setf (lock-acquisition.status flag) t))
981               t)
982           (declare (fixnum state))
983           (incf (%get-natural ptr target::rwlock.blocked-readers))
984           (let* ((waitval -1))
985             (%unlock-futex ptr)
986             (let* ((*interrupt-level* level))
987               (futex-wait reader-signal waitval (rwlock-read-whostate lock))))
988           (%lock-futex ptr level lock nil)
989           (decf (%get-natural ptr target::rwlock.blocked-readers))))))))
990
991
992
993(defun read-lock-rwlock (lock &optional flag)
994  (%read-lock-rwlock-ptr (read-write-lock-ptr lock) lock flag))
995
996
997
998#-futex
999(defun %unlock-rwlock-ptr (ptr lock)
1000  (with-macptrs ((reader-signal (%get-ptr ptr target::rwlock.reader-signal))
1001                 (writer-signal (%get-ptr ptr target::rwlock.writer-signal)))
1002    (without-interrupts
1003     (%get-spin-lock ptr)
1004     (let* ((state (%get-signed-natural ptr target::rwlock.state))
1005            (tcr (%current-tcr)))
1006       (declare (fixnum state tcr))
1007       (cond ((> state 0)
1008              (unless (eql tcr (%get-object ptr target::rwlock.writer))
1009                (setf (%get-natural ptr target::rwlock.spin) 0)
1010                (error 'not-lock-owner :lock lock))
1011              (decf state))
1012             ((< state 0) (incf state))
1013             (t (setf (%get-natural ptr target::rwlock.spin) 0)
1014                (error 'not-locked :lock lock)))
1015       (setf (%get-signed-natural ptr target::rwlock.state) state)
1016       (when (zerop state)
1017         ;; We want any thread waiting for a lock semaphore to
1018         ;; be able to wait interruptibly.  When a thread waits,
1019         ;; it increments either the "blocked-readers" or "blocked-writers"
1020         ;; field, but since it may get interrupted before obtaining
1021         ;; the semaphore that's more of "an expression of interest"
1022         ;; in taking the lock than it is "a firm commitment to take it."
1023         ;; It's generally (much) better to signal the semaphore(s)
1024         ;; too often than it would be to not signal them often
1025         ;; enough; spurious wakeups are better than deadlock.
1026         ;; So: if there are blocked writers, the writer-signal
1027         ;; is raised once for each apparent blocked writer.  (At most
1028         ;; one writer will actually succeed in taking the lock.)
1029         ;; If there are blocked readers, the reader-signal is raised
1030         ;; once for each of them.  (It's possible for both the
1031         ;; reader and writer semaphores to be raised on the same
1032         ;; unlock; the writer semaphore is raised first, so in that
1033         ;; sense, writers still have priority but it's not guaranteed.)
1034         ;; Both the "blocked-writers" and "blocked-readers" fields
1035         ;; are cleared here (they can't be changed from another thread
1036         ;; until this thread releases the spinlock.)
1037         (setf (%get-signed-natural ptr target::rwlock.writer) 0)
1038         (let* ((nwriters (%get-natural ptr target::rwlock.blocked-writers))
1039                (nreaders (%get-natural ptr target::rwlock.blocked-readers)))
1040           (declare (fixnum nreaders nwriters))
1041           (when (> nwriters 0)
1042             (setf (%get-natural ptr target::rwlock.blocked-writers) 0)
1043             (dotimes (i nwriters)
1044               (%signal-semaphore-ptr writer-signal)))
1045           (when (> nreaders 0)
1046             (setf (%get-natural ptr target::rwlock.blocked-readers) 0)
1047             (dotimes (i nreaders)
1048               (%signal-semaphore-ptr reader-signal)))))
1049       (setf (%get-natural ptr target::rwlock.spin) 0)
1050       t))))
1051
1052#+futex
1053(defun %unlock-rwlock-ptr (ptr lock)
1054  (with-macptrs ((reader-signal (%INC-ptr ptr target::rwlock.reader-signal))
1055                 (writer-signal (%INC-ptr ptr target::rwlock.writer-signal)))
1056    (let* ((signal nil)
1057           (wakeup 0))
1058    (without-interrupts
1059     (%lock-futex ptr -1 lock nil)
1060     (let* ((state (%get-signed-natural ptr target::rwlock.state))
1061            (tcr (%current-tcr)))
1062       (declare (fixnum state tcr))
1063       (cond ((> state 0)
1064              (unless (eql tcr (%get-object ptr target::rwlock.writer))
1065                (%unlock-futex ptr)
1066                (error 'not-lock-owner :lock lock))
1067              (decf state))
1068             ((< state 0) (incf state))
1069             (t (%unlock-futex ptr)
1070                (error 'not-locked :lock lock)))
1071       (setf (%get-signed-natural ptr target::rwlock.state) state)
1072       (when (zerop state)
1073         (setf (%get-signed-natural ptr target::rwlock.writer) 0)
1074         (let* ((nwriters (%get-natural ptr target::rwlock.blocked-writers))
1075                (nreaders (%get-natural ptr target::rwlock.blocked-readers)))
1076           (declare (fixnum nreaders nwriters))
1077           (if (> nwriters 0)
1078             (setq signal writer-signal wakeup 1)
1079             (if (> nreaders 0)
1080               (setq signal reader-signal wakeup #$INT_MAX)))))
1081       (when signal (setf (%get-signed-long signal) 0))
1082       (%unlock-futex ptr)
1083       (when signal (futex-wake signal wakeup))
1084       t)))))
1085
1086
1087(defun unlock-rwlock (lock)
1088  (%unlock-rwlock-ptr (read-write-lock-ptr lock) lock))
1089
1090;;; There are all kinds of ways to lose here.
1091;;; The caller must have read access to the lock exactly once,
1092;;; or have write access.
1093;;; there's currently no way to detect whether the caller has
1094;;; read access at all.
1095;;; If we have to block and get interrupted, cleanup code may
1096;;; try to unlock a lock that we don't hold. (It might be possible
1097;;; to circumvent that if we use the same notifcation object here
1098;;; that controls that cleanup process.)
1099
1100(defun %promote-rwlock (lock &optional flag)
1101  (let* ((ptr (read-write-lock-ptr lock)))
1102    (if (istruct-typep flag 'lock-acquisition)
1103      (setf (lock-acquisition.status flag) nil)
1104      (if flag (report-bad-arg flag 'lock-acquisition)))
1105    (let* ((level *interrupt-level*)
1106           (tcr (%current-tcr)))
1107      (without-interrupts
1108       #+futex
1109       (%lock-futex ptr level lock nil)
1110       #-futex
1111       (%get-spin-lock ptr)
1112       (let* ((state (%get-signed-natural ptr target::rwlock.state)))
1113         (declare (fixnum state))
1114         (cond ((> state 0)
1115                (unless (eql (%get-object ptr target::rwlock.writer) tcr)
1116                  #+futex
1117                  (%unlock-futex ptr)
1118                  #-futex
1119                  (setf (%get-natural ptr target::rwlock.spin) 0)
1120                  (error :not-lock-owner :lock lock)))
1121               ((= state 0)
1122                #+futex (%unlock-futex ptr)
1123                #-futex (setf (%get-natural ptr target::rwlock.spin) 0)
1124                (error :not-locked :lock lock))
1125               (t
1126                (if (= state -1)
1127                  (progn
1128                    (setf (%get-signed-natural ptr target::rwlock.state) 1)
1129                    (%set-object ptr target::rwlock.writer tcr)
1130                    #+futex
1131                    (%unlock-futex ptr)
1132                    #-futex
1133                    (setf (%get-natural ptr target::rwlock.spin) 0)
1134                    (if flag
1135                      (setf (lock-acquisition.status flag) t))
1136                    t)
1137                  (progn                   
1138                    #+futex
1139                    (%unlock-futex ptr)
1140                    #-futex
1141                    (setf (%get-natural ptr target::rwlock.spin) 0)
1142                    (%unlock-rwlock-ptr ptr lock)
1143                    (let* ((*interrupt-level* level))
1144                      (%write-lock-rwlock-ptr ptr lock flag)))))))))))
1145                     
1146
1147
1148(defun safe-get-ptr (p &optional dest)
1149  (if (null dest)
1150    (setq dest (%null-ptr))
1151    (unless (typep dest 'macptr)
1152      (check-type dest macptr)))
1153  (without-interrupts                   ;reentrancy
1154   (%safe-get-ptr p dest)))
1155
1156
Note: See TracBrowser for help on using the repository browser.