source: branches/qres/ccl/level-0/l0-misc.lisp @ 14055

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

r13066, r13067 from trunk: copyrights etc

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