source: trunk/source/level-1/l1-lisp-threads.lisp @ 14641

Last change on this file since 14641 was 14641, checked in by rme, 10 years ago

More places that need to subtract tcr-bias.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 39.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;; l1-lisp-threads.lisp
19
20(in-package "CCL")
21
22(defvar *bind-io-control-vars-per-process* nil
23  "If true, bind I/O control variables per process")
24
25
26             
27(defun lisp-thread-p (thing)
28  (istruct-typep thing 'lisp-thread))
29
30(setf (type-predicate 'lisp-thread) 'lisp-thread-p)
31
32(defloadvar *ticks-per-second*
33    #+windows-target 1000
34    #-windows-target
35    (#_sysconf #$_SC_CLK_TCK))
36
37(defloadvar *ns-per-tick*
38    (floor 1000000000 *ticks-per-second*))
39
40#-windows-target
41(defun %nanosleep (seconds nanoseconds)
42  (with-process-whostate ("Sleep")
43    (rlet ((a :timespec)
44           (b :timespec))
45      (setf (pref a :timespec.tv_sec) seconds
46            (pref a :timespec.tv_nsec) nanoseconds)
47      (let* ((aptr a)
48             (bptr b))
49        (loop
50          (let* ((result 
51                  (external-call #+darwin-target "_nanosleep"
52                                 #-darwin-target "nanosleep"
53                                 :address aptr
54                                 :address bptr
55                                 :signed-fullword)))
56            (declare (type (signed-byte 32) result))
57            (if (and (< result 0)
58                     (eql (%get-errno) (- #$EINTR)))
59              ;; x86-64 Leopard bug.
60              (let* ((asec (pref aptr :timespec.tv_sec))
61                     (bsec (pref bptr :timespec.tv_sec)))
62                (if (and (>= bsec 0)
63                         (or (< bsec asec)
64                             (and (= bsec asec)
65                                  (< (pref bptr :timespec.tv_nsec)
66                                     (pref aptr :timespec.tv_nsec)))))
67                  (psetq aptr bptr bptr aptr)
68                  (return)))
69              (return))))))))
70
71
72(defun timeval->ticks (tv)
73  (+ (* *ticks-per-second* (pref tv :timeval.tv_sec))
74     (round (pref tv :timeval.tv_usec) (floor 1000000 *ticks-per-second*))))
75
76
77(defun gettimeofday (ptimeval &optional ptz)
78  (int-errno-ffcall (%kernel-import target::kernel-import-lisp-gettimeofday)
79                    :address ptimeval
80                    :address (or ptz (%null-ptr))
81                    :int))
82
83(defloadvar *lisp-start-timeval*
84    (progn
85      (let* ((r (make-record :timeval)))
86        (gettimeofday r)
87        r)))
88
89
90(defloadvar *internal-real-time-session-seconds* nil)
91
92
93(defun get-internal-real-time ()
94  "Return the real time in the internal time format. (See
95  INTERNAL-TIME-UNITS-PER-SECOND.) This is useful for finding elapsed time."
96  (rlet ((tv :timeval))
97    (gettimeofday tv)
98    (let* ((units (truncate (the fixnum (pref tv :timeval.tv_usec)) (/ 1000000 internal-time-units-per-second)))
99           (initial *internal-real-time-session-seconds*))
100      (if initial
101        (locally
102            (declare (type (unsigned-byte 32) initial))
103          (+ (* internal-time-units-per-second
104                (the (unsigned-byte 32)
105                  (- (the (unsigned-byte 32) (pref tv :timeval.tv_sec))
106                     initial)))
107             units))
108        (progn
109          (setq *internal-real-time-session-seconds*
110                (pref tv :timeval.tv_sec))
111          units)))))
112
113(defun get-tick-count ()
114  (values (floor (get-internal-real-time)
115                 (floor internal-time-units-per-second
116                        *ticks-per-second*))))
117
118
119
120
121(defun %kernel-global-offset (name-or-offset)
122  (if (fixnump name-or-offset)
123    name-or-offset
124    (target::%kernel-global name-or-offset)))
125
126
127(defun %kernel-global-offset-form (name-or-offset-form)
128  (cond ((quoted-form-p name-or-offset-form)
129         `(%target-kernel-global ,name-or-offset-form))
130        ((fixnump name-or-offset-form)
131         name-or-offset-form)
132        (t `(%target-kernel-global ',name-or-offset-form))))
133
134
135
136(defmacro %set-kernel-global (name-or-offset new-value)
137  `(%set-kernel-global-from-offset
138    ,(%kernel-global-offset-form name-or-offset)
139    ,new-value))
140
141
142
143; The number of bytes in a consing (or stack) area
144(defun %area-size (area)
145  (ash (- (%fixnum-ref area target::area.high)
146          (%fixnum-ref area target::area.low))
147       target::fixnumshift))
148
149(defun %stack-area-usable-size (area)
150  (ash (- (%fixnum-ref area target::area.high)
151          (%fixnum-ref area target::area.softlimit))
152       target::fixnum-shift))
153
154(defun %cons-lisp-thread (name &optional tcr)
155  (%istruct 'lisp-thread
156            tcr
157            name
158            0
159            0
160            0
161            nil
162            nil
163            (make-lock)
164            nil
165            :reset
166            (make-lock)))
167
168(defvar *current-lisp-thread*
169  (%cons-lisp-thread "Initial" (%current-tcr)))
170
171(defstatic *initial-lisp-thread* *current-lisp-thread*)
172
173(defun thread-change-state (thread oldstate newstate)
174  (with-lock-grabbed ((lisp-thread.state-change-lock thread))
175    (when (eq (lisp-thread.state thread) oldstate)
176      (setf (lisp-thread.state thread) newstate))))
177
178(thread-change-state *initial-lisp-thread* :reset :run)
179
180(defun thread-state (thread)
181  (with-lock-grabbed ((lisp-thread.state-change-lock thread))
182    (lisp-thread.state thread)))
183 
184(defun thread-make-startup-function (thread tcr)
185  #'(lambda ()
186      (thread-change-state thread :reset :run)
187      (let* ((*current-lisp-thread* thread)
188             (initial-function (lisp-thread.initial-function.args thread)))
189        (tcr-clear-preset-state tcr)
190        (%set-tcr-toplevel-function tcr nil)
191        (setf (interrupt-level) 0)
192        (apply (car initial-function) (cdr initial-function))
193        (cleanup-thread-tcr thread tcr))))
194
195(defun init-thread-from-tcr (tcr thread)
196  (let* ((cs-area nil)
197         (vs-area (%fixnum-ref tcr (- target::tcr.vs-area target::tcr-bias)))
198         #-arm-target
199         (ts-area (%fixnum-ref tcr (- target::tcr.ts-area target::tcr-bias))))
200    #+(and windows-target x8632-target)
201    (let ((aux (%fixnum-ref tcr (- target::tcr.aux target::tcr-bias))))
202      (setq cs-area (%fixnum-ref aux target::tcr-aux.cs-area)))
203    #-(and windows-target x8632-target)
204    (setq cs-area (%fixnum-ref tcr target::tcr.cs-area))
205    (when (or (zerop cs-area)
206              (zerop vs-area)
207              #-arm-target
208              (zerop ts-area))
209      (error "Can't allocate new thread"))
210    (setf (lisp-thread.tcr thread) tcr
211          (lisp-thread.cs-size thread)
212          (%stack-area-usable-size cs-area)
213          (lisp-thread.vs-size thread)
214          (%stack-area-usable-size vs-area)
215          (lisp-thread.ts-size thread)
216          #+arm-target 0
217          #-arm-target
218          (%stack-area-usable-size ts-area)
219          (lisp-thread.startup-function thread)
220          (thread-make-startup-function thread tcr)))
221  (thread-change-state thread :exit :reset)
222  thread)
223
224(defun default-allocation-quantum ()
225  (ash 1 (%get-kernel-global 'default-allocation-quantum)))
226
227(defun new-lisp-thread-from-tcr (tcr name)
228  (let* ((thread (%cons-lisp-thread name tcr)))   
229    (init-thread-from-tcr tcr thread)
230    (push thread (population-data *lisp-thread-population*))
231    thread))
232
233(def-ccl-pointers initial-thread ()
234  (init-thread-from-tcr (%current-tcr) *initial-lisp-thread*))
235
236(defmethod print-object ((thread lisp-thread) stream)
237  (print-unreadable-object (thread stream :type t :identity t)
238    (format stream "~a" (lisp-thread.name thread))
239    (let* ((tcr (lisp-thread.tcr thread)))
240      (if (and tcr (not (eql 0 tcr)))
241        (format stream " [tcr @ #x~x]" (ash tcr target::fixnumshift))))))
242
243
244(defvar *lisp-thread-population*
245  (%cons-population (list *initial-lisp-thread*) $population_weak-list nil))
246
247
248
249
250
251(defparameter *default-control-stack-size*
252  #+32-bit-target (ash 1 20)
253  #+64-bit-target (ash 2 20))
254(defparameter *default-value-stack-size*
255  #+32-bit-target (ash 1 20)
256  #+64-bit-target (ash 2 20))
257(defparameter *default-temp-stack-size*
258  #+32-bit-target (ash 1 19)
259  #+64-bit-target (ash 2 19))
260
261
262(defstatic *initial-listener-default-control-stack-size* *default-control-stack-size*)
263(defstatic *initial-listener-default-value-stack-size* *default-value-stack-size*)
264(defstatic *initial-listener-default-temp-stack-size* *default-temp-stack-size*)
265
266
267(def-ccl-pointers listener-stack-sizes ()
268  (let* ((size (%get-kernel-global 'stack-size))) ; set by --thread-stack-size
269    (declare (fixnum size))
270    (when (> size 0)
271      (setq *initial-listener-default-control-stack-size* size
272            *initial-listener-default-value-stack-size* size
273            *initial-listener-default-temp-stack-size* (floor size 2)))))
274
275
276(defmacro with-area-macptr ((var area) &body body)
277  `(with-macptrs (,var)
278     (%setf-macptr-to-object ,var ,area)
279     ,@body))
280
281
282(defun gc-area.return-sp (area)
283  (%fixnum-ref area target::area.gc-count))
284
285
286(defun (setf gc-area.return-sp) (return-sp area)
287  (setf (%fixnum-ref area target::area.gc-count) return-sp))
288
289
290
291(defun shutdown-lisp-threads ()
292  )
293
294(defun %current-xp ()
295  (let ((xframe (%fixnum-ref (%current-tcr) (- target::tcr.xframe
296                                               target::tcr-bias))))
297    (when (eql xframe 0)
298      (error "No current exception frame"))
299    (%fixnum-ref xframe
300                 (get-field-offset :xframe-list.this))))
301
302(defun new-tcr (cs-size vs-size ts-size)
303  (let* ((tcr (macptr->fixnum
304               (ff-call
305                (%kernel-import target::kernel-import-newthread)
306                #+64-bit-target :unsigned-doubleword
307                #+32-bit-target :unsigned-fullword cs-size
308                #+64-bit-target :unsigned-doubleword
309                #+32-bit-target :unsigned-fullword vs-size
310                #+64-bit-target :unsigned-doubleword
311                #+32-bit-target :unsigned-fullword ts-size
312                :address))))
313    (declare (fixnum tcr))
314    (if (zerop tcr)
315      (error "Can't create thread")
316      tcr)))
317
318(defun new-thread (name cstack-size vstack-size tstack-size)
319  (new-lisp-thread-from-tcr (new-tcr cstack-size vstack-size tstack-size) name))
320
321(defun new-tcr-for-thread (thread)
322  (let* ((tcr (new-tcr
323               (lisp-thread.cs-size thread)
324               (lisp-thread.vs-size thread)
325               (lisp-thread.ts-size thread))))
326    (setf (lisp-thread.tcr thread) tcr
327          (lisp-thread.startup-function thread)
328          (thread-make-startup-function thread tcr))
329    (thread-change-state thread :exit :reset)
330    tcr))
331 
332         
333
334
335
336(defconstant cstack-hardprot (ash 100 10))
337(defconstant cstack-softprot (ash 100 10))
338
339
340
341(defun tcr-flags (tcr)
342  (%fixnum-ref tcr (- target::tcr.flags target::tcr-bias)))
343
344
345
346(defun %tcr-frame-ptr (tcr)
347  (with-macptrs (p)
348    (%setf-macptr-to-object p tcr)
349    (%fixnum-from-macptr
350     (ff-call (%kernel-import target::kernel-import-tcr-frame-ptr)
351              :address p
352              :address))))
353 
354(defun thread-exhausted-p (thread)
355  (or (null thread)
356      (null (lisp-thread.tcr thread))))
357
358(defun thread-total-run-time (thread)
359  (unless (thread-exhausted-p thread)
360    nil))
361
362(defun %tcr-interrupt (tcr)
363  ;; The other thread's interrupt-pending flag might get cleared
364  ;; right after we look and see it set, but since this is called
365  ;; with the lock on the thread's interrupt queue held, the
366  ;; pending interrupt won't have been taken yet.
367  ;; When a thread dies, it should try to clear its interrupt-pending
368  ;; flag.
369  (if (eql 0 (%fixnum-ref tcr (- target::tcr.interrupt-pending
370                                 target::tcr-bias)))
371    (%%tcr-interrupt tcr)
372    0))
373
374
375
376     
377     
378
379(defun thread-interrupt (thread process function &rest args)
380  (with-lock-grabbed ((lisp-thread.state-change-lock thread))
381    (case (lisp-thread.state thread)
382      (:run 
383       (with-lock-grabbed ((lisp-thread.interrupt-lock thread))
384         (let ((tcr (lisp-thread.tcr thread)))
385           (when tcr
386             (push (cons function args)
387                   (lisp-thread.interrupt-functions thread))
388             (eql 0 (%tcr-interrupt tcr))))))
389      (:reset
390       ;; Preset the thread with a function that'll return to the :reset
391       ;; state
392       (let* ((pif (process-initial-form process))
393              (pif-f (car pif))
394              (pif-args (cdr pif)))
395         (process-preset process #'(lambda ()
396                                     (%rplaca pif pif-f)
397                                     (%rplacd pif pif-args)
398                                     (apply function args)
399                                     ;; If function returns normally,
400                                     ;; return to the reset state
401                                     (%process-reset nil)))
402         (thread-enable thread (process-termination-semaphore process) (1- (integer-length (process-allocation-quantum process))) 0)
403         t)))))
404
405(defun thread-handle-interrupts ()
406  (let* ((thread *current-lisp-thread*))
407    (with-process-whostate ("Active")
408      (loop
409        (let* ((f (with-lock-grabbed ((lisp-thread.interrupt-lock thread))
410                    (pop (lisp-thread.interrupt-functions thread)))))
411          (if f
412            (apply (car f) (cdr f))
413            (return)))))))
414
415
416       
417(defun  thread-preset (thread function &rest args)
418  (setf (lisp-thread.initial-function.args thread)
419        (cons function args)))
420
421(defun thread-enable (thread termination-semaphore allocation-quantum &optional (timeout (* 60 60 24)))
422  (let* ((tcr (or (lisp-thread.tcr thread) (new-tcr-for-thread thread))))
423    (with-macptrs (s)
424      #+(and windows-target x8632-target)
425      (let ((aux (%fixnum-ref tcr (- target::tcr.aux target::tcr-bias))))
426        (%setf-macptr-to-object s (%fixnum-ref aux target::tcr-aux.reset-completion)))
427      #-(and windows-target x8632-target)
428      (%setf-macptr-to-object s (%fixnum-ref tcr target::tcr.reset-completion))
429      (when (%timed-wait-on-semaphore-ptr s timeout nil)
430        (%set-tcr-toplevel-function
431         tcr
432         (lisp-thread.startup-function thread))
433        (%activate-tcr tcr termination-semaphore allocation-quantum)
434        thread))))
435                             
436
437(defun cleanup-thread-tcr (thread tcr)
438  (let* ((flags (%fixnum-ref tcr (- target::tcr.flags
439                                    target::tcr-bias))))
440    (declare (fixnum flags))
441    (if (logbitp arch::tcr-flag-bit-awaiting-preset flags)
442      (thread-change-state thread :run :reset)
443      (progn
444        (thread-change-state thread :run :exit)
445        (setf (lisp-thread.tcr thread) nil)))))
446
447(defun kill-lisp-thread (thread)
448  (unless (eq thread *initial-lisp-thread*)
449    (let* ((tcr (lisp-thread.tcr thread)))
450      (when tcr
451        (setf (lisp-thread.tcr thread) nil
452              (lisp-thread.state thread) :exit)
453        (%kill-tcr tcr)))))
454
455;;; This returns the underlying pthread, whatever that is, as an
456;;; unsigned integer.
457(defun lisp-thread-os-thread (thread)
458  (with-macptrs (tcrp)
459    (%setf-macptr-to-object tcrp (lisp-thread.tcr thread))
460    (unless (%null-ptr-p tcrp)
461     
462      (let* ((natural #+(and windows-target x8632-target)
463                      (%get-natural (%get-ptr tcrp (- target::tcr.aux
464                                                      target::tcr-bias))
465                                    target::tcr-aux.osid)
466                      #-(and windows-target x8632-target)
467                      (%get-natural tcrp target::tcr.osid)))
468        (unless (zerop natural) natural)))))
469
470
471                         
472;;; This returns something lower-level than the pthread, if that
473;;; concept makes sense.  On current versions of Linux, it returns
474;;; the pid of the clone()d process; on Darwin, it returns a Mach
475;;; thread.  On some (near)future version of Linux, the concept
476;;; may not apply.
477;;; The future is here: on Linux systems using NPTL, this returns
478;;; exactly the same thing that (getpid) does.
479;;; This should probably be retired; even if it does something
480;;; interesting, is the value it returns useful ?
481
482(defun lisp-thread-native-thread (thread)
483  (with-macptrs (tcrp)
484    (%setf-macptr-to-object tcrp (lisp-thread.tcr thread))
485    (unless (%null-ptr-p tcrp)
486      #+(and windows-target x8632-target)
487      (let ((aux (%get-ptr tcrp (- target::tcr.aux target::tcr-bias))))
488        (%get-unsigned-long aux target::tcr-aux.native-thread-id))
489      #-(and windows-target x8632-target)
490      (#+32-bit-target %get-unsigned-long
491       #+64-bit-target %%get-unsigned-longlong tcrp target::tcr.native-thread-id))))
492
493(defun lisp-thread-suspend-count (thread)
494  (with-macptrs (tcrp)
495    (%setf-macptr-to-object tcrp (lisp-thread.tcr thread))
496    (unless (%null-ptr-p tcrp)
497      #+(and windows-target x8632-target)
498      (let ((aux (%get-ptr tcrp (- target::tcr.aux target::tcr-bias))))
499        (%get-unsigned-long aux target::tcr-aux.suspend-count))
500      #-(and windows-target x8632-target)
501      (#+32-bit-target %get-unsigned-long
502       #+64-bit-target %%get-unsigned-longlong tcrp target::tcr.suspend-count))))
503
504(defun tcr-clear-preset-state (tcr)
505  (let* ((flags (%fixnum-ref tcr (- target::tcr.flags target::tcr-bias))))
506    (declare (fixnum flags))
507    (setf (%fixnum-ref tcr (- target::tcr.flags target::tcr-bias))
508          (bitclr arch::tcr-flag-bit-awaiting-preset flags))))
509
510(defun tcr-set-preset-state (tcr)
511  (let* ((flags (%fixnum-ref tcr (- target::tcr.flags target::tcr-bias))))
512    (declare (fixnum flags))
513    (setf (%fixnum-ref tcr (- target::tcr.flags target::tcr-bias))
514          (bitset arch::tcr-flag-bit-awaiting-preset flags)))) 
515
516;;; This doesn't quite activate the thread; see PROCESS-TCR-ENABLE.
517(defun %activate-tcr (tcr termination-semaphore allocation-quantum)
518  (declare (ignore termination-semaphore))
519  (if (and tcr (not (eql 0 tcr)))
520    (with-macptrs (tcrp)
521      (%setf-macptr-to-object tcrp tcr)
522      #+(and windows-target x8632-target)
523      (let ((aux (%get-ptr tcrp (- target::tcr.aux target::tcr-bias))))
524        (setf (%get-unsigned-long aux target::tcr-aux.log2-allocation-quantum)
525              (or allocation-quantum (default-allocation-quantum))))
526      #-(and windows-target x8632-target)
527      (setf (%get-natural tcrp target::tcr.log2-allocation-quantum)
528            (or allocation-quantum (default-allocation-quantum)))
529      t)))
530                         
531(defvar *canonical-error-value*
532  '(*canonical-error-value*))
533
534
535(defun symbol-value-in-tcr (sym tcr)
536  (if (eq tcr (%current-tcr))
537    (%sym-value sym)
538    (unwind-protect
539         (progn
540           (%suspend-tcr tcr)
541           (let* ((loc (%tcr-binding-location tcr sym)))
542             (if loc
543               (%fixnum-ref loc)
544               (%sym-global-value sym))))
545      (%resume-tcr tcr))))
546
547(defun (setf symbol-value-in-tcr) (value sym tcr)
548  (if (eq tcr (%current-tcr))
549    (%set-sym-value sym value)
550    (unwind-protect
551         (progn
552           (%suspend-tcr tcr)
553           (let* ((loc (%tcr-binding-location tcr sym)))
554             (if loc
555               (setf (%fixnum-ref loc) value)
556               (%set-sym-global-value sym value))))
557      (%resume-tcr tcr))))
558
559;;; Backtrace support
560;;;
561
562
563
564(defmacro do-db-links ((db-link &optional var value) &body body)
565  (let ((thunk (gensym))
566        (var-var (or var (gensym)))
567        (value-var (or value (gensym))))
568    `(block nil
569       (let ((,thunk #'(lambda (,db-link ,var-var ,value-var)
570                         (declare (ignorable ,db-link))
571                         ,@(unless var (list `(declare (ignore ,var-var))))
572                         ,@(unless value (list `(declare (ignore ,value-var))))
573                         ,@body)))
574         (declare (dynamic-extent ,thunk))
575         (map-db-links ,thunk)))))
576
577
578
579
580(defun map-db-links (f)
581  (without-interrupts
582   (let ((db-link (%current-db-link)))
583     (loop
584       (when (eql 0 db-link) (return))
585       (funcall f db-link (%fixnum-ref db-link (* 1 target::node-size)) (%fixnum-ref db-link (* 2 target::node-size)))
586       (setq db-link (%fixnum-ref db-link))))))
587
588(defun %get-frame-ptr ()
589  (%current-frame-ptr))
590
591(defun %current-exception-frame ()
592  #+ppc-target *fake-stack-frames*
593  #+x86-target (or (let* ((xcf (%current-xcf)))
594                     (if xcf
595                       (%%frame-backlink xcf)))
596                   (%current-frame-ptr))
597  #+arm-target (or (current-fake-stack-frame)
598                   (%current-frame-ptr)))
599
600
601
602
603
604(defun next-catch (catch)
605  (let ((next-catch (uvref catch target::catch-frame.link-cell)))
606    (unless (eql next-catch 0) next-catch)))
607
608
609
610
611; @@@ this needs to load early so errors can work
612(defun next-lisp-frame (p context)
613  (let ((frame p))
614    (loop
615      (let ((parent (%frame-backlink frame context)))
616        (multiple-value-bind (lisp-frame-p bos-p) (lisp-frame-p parent context)
617          (if lisp-frame-p
618            (return parent)
619            (if bos-p
620              (return nil))))
621        (setq frame parent)))))
622
623(defun parent-frame (p context)
624  (loop
625    (let ((parent (next-lisp-frame p context)))
626      (when (or (null parent)
627                (not (catch-csp-p parent context)))
628        (return parent))
629      (setq p parent))))
630
631
632
633
634
635(defun last-frame-ptr (&optional context origin)
636  (let* ((current (or origin
637                      (if context (bt.current context) (%current-frame-ptr))))
638         (last current))
639    (loop
640      (setq current (parent-frame current context))
641      (if current
642        (setq last current)
643        (return last)))))
644
645
646
647(defun child-frame (p context )
648  (let* ((current (if context (bt.current context) (%current-frame-ptr)))
649         (last nil))
650    (loop
651      (when (null current)
652        (return nil))
653      (when (eq current p) (return last))
654      (setq last current
655            current (parent-frame current context)))))
656
657
658
659
660
661; This returns the current head of the db-link chain.
662(defun db-link (&optional context)
663  (if context
664    (bt.db-link context)
665    (%fixnum-ref (%current-tcr) (- target::tcr.db-link target::tcr-bias))))
666
667(defun previous-db-link (db-link start )
668  (declare (fixnum db-link start))
669  (let ((prev nil))
670    (loop
671      (when (or (eql db-link start) (eql 0 start))
672        (return prev))
673      (setq prev start
674            start (%fixnum-ref start 0)))))
675
676(defun count-db-links-in-frame (vsp parent-vsp &optional context)
677  (declare (fixnum vsp parent-vsp))
678  (let ((db (db-link context))
679        (count 0)
680        (first nil)
681        (last nil))
682    (declare (fixnum db count))
683    (loop
684      (cond ((eql db 0)
685             (return (values count (or first 0) (or last 0))))
686            ((and (>= db vsp) (< db parent-vsp))
687             (unless first (setq first db))
688             (setq last db)
689             (incf count)))
690      (setq db (%fixnum-ref db)))))
691
692;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
693;;;
694;;; bogus-thing-p support
695;;;
696
697(defun %ptr-in-area-p (ptr area)
698  (declare (optimize (speed 3) (safety 0)) (fixnum ptr area))           ; lie, maybe
699  (and (<= (the fixnum (%fixnum-ref area target::area.low)) ptr)
700       (> (the fixnum (%fixnum-ref area target::area.high)) ptr)))
701
702(defun %active-area (area active)
703  (or (do ((a area (%fixnum-ref a target::area.older)))
704          ((eql a 0))
705        (when (%ptr-in-area-p active a)
706          (return a)))
707      (do ((a (%fixnum-ref area target::area.younger) (%fixnum-ref a target::area.younger)))
708          ((eql a 0))
709        (when (%ptr-in-area-p active a)
710          (return a)))))
711
712(defun %ptr-to-vstack-p (tcr idx)
713  (%ptr-in-area-p idx (%fixnum-ref tcr (- target::tcr.vs-area
714                                          target::tcr-bias))))
715
716#-arm-target
717(defun %on-tsp-stack (tcr object)
718  (%ptr-in-area-p object (%fixnum-ref tcr (- target::tcr.ts-area
719                                             target::tcr-bias))))
720
721(defun %on-csp-stack (tcr object)
722  (let ((cs-area #+(and windows-target x8632-target)
723                 (%fixnum-ref (%fixnum-ref tcr (- target::tcr.aux
724                                                  target::tcr-bias))
725                              target::tcr-aux.cs-area)
726                 #-(and windows-target x8632-target)
727                 (%fixnum-ref tcr target::tcr.cs-area)))
728    (%ptr-in-area-p object cs-area)))
729
730(defparameter *aux-tsp-ranges* ())
731(defparameter *aux-vsp-ranges* ())
732(defparameter *aux-csp-ranges* ())
733
734(defun object-in-range-p (object range)
735  (declare (fixnum object))
736  (when range
737    (destructuring-bind (active . high) range
738      (declare (fixnum active high))
739      (and (< active object)
740           (< object high)))))
741
742(defun object-in-some-range (object ranges)
743  (dolist (r ranges)
744    (when (object-in-range-p object r)
745      (return t))))
746
747#-arm-target
748(defun on-any-tsp-stack (object)
749  (or (%on-tsp-stack (%current-tcr) object)
750      (object-in-some-range object *aux-tsp-ranges*)))
751
752(defun on-any-vstack (idx)
753  (or (%ptr-to-vstack-p (%current-tcr) idx)
754      (object-in-some-range idx *aux-vsp-ranges*)))
755
756(defun on-any-csp-stack (object)
757  (or (%on-csp-stack (%current-tcr) object)
758      (object-in-some-range object *aux-csp-ranges*)))
759
760;;; This MUST return either T or NIL.
761(defun temporary-cons-p (x)
762  (and (consp x)
763       (not (null (or (on-any-vstack x)
764                      #-arm-target
765                      (on-any-tsp-stack x)
766                      #+arm-target
767                      (on-any-csp-stack x))))))
768
769
770
771
772
773
774
775(defun %value-cell-header-at-p (cur-vsp)
776  (eql target::value-cell-header (%fixnum-address-of (%fixnum-ref cur-vsp))))
777
778(defun count-stack-consed-value-cells-in-frame (vsp parent-vsp)
779  (let ((cur-vsp vsp)
780        (count 0))
781    (declare (fixnum cur-vsp count))
782    (loop
783      (when (>= cur-vsp parent-vsp) (return))
784      (when (and (evenp cur-vsp) (%value-cell-header-at-p cur-vsp))
785        (incf count)
786        (incf cur-vsp))                 ; don't need to check value after header
787      (incf cur-vsp))
788    count))
789
790;;; stack consed value cells are one of two forms:
791;;; Well, they were of two forms.  When they existed, that is.
792;;;
793;;; nil             ; n-4
794;;; header          ; n = even address (multiple of 8)
795;;; value           ; n+4
796;;;
797;;; header          ; n = even address (multiple of 8)
798;;; value           ; n+4
799;;; nil             ; n+8
800
801(defun in-stack-consed-value-cell-p (arg-vsp vsp parent-vsp)
802  (declare (fixnum arg-vsp vsp parent-vsp))
803  (if (evenp arg-vsp)
804    (%value-cell-header-at-p arg-vsp)
805    (or (and (> arg-vsp vsp)
806             (%value-cell-header-at-p (the fixnum (1- arg-vsp))))
807        (let ((next-vsp (1+ arg-vsp)))
808          (declare (fixnum next-vsp))
809          (and (< next-vsp parent-vsp)
810               (%value-cell-header-at-p next-vsp))))))
811
812
813
814(defun count-values-in-frame (p context &optional child)
815  (declare (ignore child))
816  (multiple-value-bind (vsp parent-vsp) (vsp-limits p context)
817    (values
818     (- parent-vsp 
819        vsp
820        (* 2 (count-db-links-in-frame vsp parent-vsp context))))))
821
822(defun nth-value-in-frame-loc (sp n context lfun pc vsp parent-vsp)
823  (declare (fixnum sp))
824  (setq n (require-type n 'fixnum))
825  (unless (or (null vsp) (fixnump vsp))
826    (setq vsp (require-type vsp '(or null fixnum))))
827  (unless (or (null parent-vsp) (fixnump parent-vsp))
828    (setq parent-vsp (require-type parent-vsp '(or null fixnum))))
829  (unless (and vsp parent-vsp)
830    (multiple-value-setq (vsp parent-vsp) (vsp-limits sp context)))
831  (locally (declare (fixnum n vsp parent-vsp))
832    (multiple-value-bind (db-count first-db last-db)
833                         (count-db-links-in-frame vsp parent-vsp context)
834      (declare (ignore db-count))
835      (declare (fixnum first-db last-db))
836      (let ((arg-vsp (1- parent-vsp))
837            (cnt n)
838            (phys-cell 0)
839            db-link-p)
840        (declare (fixnum arg-vsp cnt phys-cell))
841        (loop
842          (if (eql (the fixnum (- arg-vsp 2)) last-db)
843            (setq db-link-p t
844                  arg-vsp last-db
845                  last-db (previous-db-link last-db first-db)
846                  phys-cell (+ phys-cell 2))
847            (setq db-link-p nil))
848            (when (< (decf cnt) 0)
849              (return
850               (if db-link-p
851                 (values (+ 2 arg-vsp)
852                         :saved-special
853                         (binding-index-symbol (%fixnum-ref (1+ arg-vsp))))
854                 (multiple-value-bind (type name) (find-local-name phys-cell lfun pc)
855                   (values arg-vsp type name)))))
856          (incf phys-cell)
857          (when (< (decf arg-vsp) vsp)
858            (error "~d out of range" n)))))))
859
860
861
862(defun nth-value-in-frame (sp n context &optional lfun pc vsp parent-vsp)
863  (multiple-value-bind (loc type name)
864                       (nth-value-in-frame-loc sp n context lfun pc vsp parent-vsp)
865    (let* ((val (%fixnum-ref loc)))
866      (when (and (eq type :saved-special)
867                 (eq val (%no-thread-local-binding-marker))
868                 name)
869        (setq val (%sym-global-value name)))
870      (values val  type name))))
871
872(defun set-nth-value-in-frame (sp n context new-value &optional vsp parent-vsp)
873  (multiple-value-bind (loc type name)
874      (nth-value-in-frame-loc sp n context nil nil vsp parent-vsp)
875    (let* ((old-value (%fixnum-ref loc)))
876      (if (and (eq type :saved-special)
877               (eq old-value (%no-thread-local-binding-marker))
878               name)
879        ;; Setting the (shallow-bound) value of the outermost
880        ;; thread-local binding of NAME.  Hmm.
881        (%set-sym-global-value name new-value)
882        (setf (%fixnum-ref loc) new-value)))))
883
884(defun nth-raw-frame (n start-frame context)
885  (declare (fixnum n))
886  (do* ((p start-frame (parent-frame p context))
887        (i 0 (1+ i))
888        (q (last-frame-ptr context)))
889       ((or (null p) (eq p q) (%stack< q p context)))
890    (declare (fixnum i))
891    (if (= i n)
892      (return p))))
893
894(defun nth-function-frame (n start-frame context)
895  (declare (fixnum n))
896  (do* ((p start-frame (parent-frame p context))
897        (i -1)
898        (q (last-frame-ptr context)))
899       ((or (null p) (eq p q) (%stack< q p context)))
900    (declare (fixnum i))
901    (when (function-frame-p p context)
902      (incf i)
903      (if (= i n)
904        (return p)))))
905
906;;; True if the object is in one of the heap areas
907(defun %in-consing-area-p (x area)
908  (declare (optimize (speed 3) (safety 0)) (fixnum x))       ; lie
909  (let* ((low (%fixnum-ref area target::area.low))
910         (high (%fixnum-ref area target::area.high))
911)
912    (declare (fixnum low high))
913    (and (<= low x) (< x high))))
914
915
916
917(defun in-any-consing-area-p (x)
918  (do-consing-areas (area)
919    (when (%in-consing-area-p x area)
920      (return t))))
921
922
923
924
925
926
927
928
929
930;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
931;;;
932;;; terminate-when-unreachable
933;;;
934
935#|
936Message-Id: <v02130502ad3e6a2f1542@[205.231.144.48]>
937Mime-Version: 1.0
938Content-Type: text/plain; charset="us-ascii"
939Date: Wed, 7 Feb 1996 10:32:55 -0500
940To: pmcldev@digitool.com
941From: bitCraft@taconic.net (Bill St. Clair)
942Subject: terminate-when-unreachable
943
944I propose that we add a general termination mechanism to PPC MCL.
945We need it to properly terminate stack groups, it would be
946a nicer way to do the termination for macptrs than the current
947ad-hoc mechanism (which BTW is not yet part of PPC MCL), and
948it is a nice addition to MCL. I don't think it's hard to make
949the garbage collector support this, and I volunteer to do the
950work unless Gary really wants to.
951
952I see two ways to support termination:
953
9541) Do termination for hash tables. This was our plan for
955   2.0, but Gary got confused about how to mark the objects at
956   the right time (or so I remember).
957
9582) Resurrect weak alists (they're not part of the PPC garbage
959   collector) and add a termination bit to the population type.
960   This allows for termination of weak lists and weak alists,
961   though the termination mechanism really only needs termination
962   for a single weak alist.
963
964I prefer option 2, weak alists, since it avoids the overhead
965necessary to grow and rehash a hash table. It also uses less space,
966since a finalizeable hash table needs to allocate two cons cells
967for each entry so that the finalization code has some place to
968put the deleted entry.
969
970I propose the following interface (slightly modified from what
971Apple Dylan provides):
972
973terminate-when-unreachable object &optional (function 'terminate)
974  When OBJECT becomes unreachable, funcall FUNCTION with OBJECT
975  as a single argument. Each call of terminate-when-unreachable
976  on a single (EQ) object registers a new termination function.
977  All will be called when the object becomes unreachable.
978
979terminate object                                         [generic function]
980  The default termination function
981
982terminate (object t)                                     [method]
983  The default method. Ignores object. Returns nil.
984
985drain-termination-queue                                  [function]
986  Drain the termination queue. I.e. call the termination function
987  for every object that has become unreachable.
988
989*enable-automatic-termination*                           [variable]
990  If true, the default, drain-termination-queue will be automatically
991  called on the first event check after the garbage collector runs.
992  If you set this to false, you are responsible for calling
993  drain-termination-queue.
994
995cancel-terminate-when-unreachable object &optional function
996  Removes the effect of the last call to terminate-when-unreachable
997  for OBJECT & FUNCTION (both tested with EQ). Returns true if
998  it found a match (which it won't if the object has been moved
999  to the termination queue since terminate-when-unreachable was called).
1000  If FUNCTION is NIL or unspecified, then it will not be used; the
1001  last call to terminate-when-unreachable with the given OBJECT will
1002  be undone.
1003
1004termination-function object
1005  Return the function passed to the last call of terminate-when-unreachable
1006  for OBJECT. Will be NIL if the object has been put in the
1007  termination queue since terminate-when-unreachable was called.
1008
1009|#
1010
1011
1012(defstatic *termination-population*
1013  (%cons-terminatable-alist))
1014
1015(defstatic *termination-population-lock* (make-lock))
1016
1017
1018(defvar *enable-automatic-termination* t)
1019
1020(defun terminate-when-unreachable (object &optional (function 'terminate))
1021  "The termination mechanism is a way to have the garbage collector run a
1022function right before an object is about to become garbage. It is very
1023similar to the finalization mechanism which Java has. It is not standard
1024Common Lisp, although other Lisp implementations have similar features.
1025It is useful when there is some sort of special cleanup, deallocation,
1026or releasing of resources which needs to happen when a certain object is
1027no longer being used."
1028  (let ((new-cell (cons object function))
1029        (population *termination-population*))
1030    (without-interrupts
1031     (with-lock-grabbed (*termination-population-lock*)
1032       (atomic-push-uvector-cell population population.data new-cell)))
1033    function))
1034
1035(defmethod terminate ((object t))
1036  nil)
1037
1038(defun drain-termination-queue ()
1039  (with-lock-grabbed (*termination-population-lock*)
1040    (let* ((population *termination-population*))
1041      (loop
1042        (multiple-value-bind (cell existed)
1043            (atomic-pop-uvector-cell population population.termination-list)
1044          (if (not existed)
1045            (return)
1046          (funcall (cdr cell) (car cell))))))))
1047
1048(defun cancel-terminate-when-unreachable (object &optional (function nil function-p))
1049  (let* ((found nil))
1050    (with-lock-grabbed (*termination-population-lock*)
1051      ;; We don't really need to be very paranoid here.  Nothing can
1052      ;; be added to the termination queue while we hold the lock,
1053      ;; and the GC can't splice anything out of the list while
1054      ;; we hold a strong reference to that list.
1055      (let* ((population *termination-population*)
1056             (queue (population.data population)))
1057        (do* ((prev nil spine)
1058              (spine queue (cdr spine)))
1059             ((null spine))
1060          (let* ((entry (car spine)))
1061            (destructuring-bind (o . f) entry
1062              (when (and (eq o object)
1063                         (or (null function-p)
1064                             (eq function f)))
1065                (if prev
1066                  (setf (cdr prev) (cdr spine))
1067                  (setf (population.data population) (cdr spine)))
1068                (setq found t)
1069                (return)))))
1070      found))))
1071
1072
1073(defun termination-function (object)
1074  (without-interrupts
1075   (with-lock-grabbed (*termination-population-lock*)
1076     (cdr (assq object (population-data *termination-population*))))))
1077
1078(defun do-automatic-termination ()
1079  (when *enable-automatic-termination*
1080    (drain-termination-queue)))
1081
1082(queue-fixup
1083 (add-gc-hook 'do-automatic-termination :post-gc))
1084
1085;;; A callback to handle foreign thread preparation, initialization,
1086;;; and termination.
1087;;; "preparation" involves telling the kernel to reserve space for
1088;;; some initial thread-specific special bindings.  The kernel
1089;;; needs to reserve this space on the foreign thread's vstack;
1090;;; it needs us to tell it how much space to reserve (enough
1091;;; for bindings of *current-thread*, *current-process*, and
1092;;; the default initial bindings of *PACKAGE*, etc.)
1093;;;
1094;;; "initialization" involves making those special bindings in
1095;;; the vstack space reserved by the kernel, and setting the
1096;;; values of *current-thread* and *current-process* to newly
1097;;; created values.
1098;;;
1099;;; "termination" involves removing the current thread and
1100;;; current process from the global thread/process lists.
1101;;; "preparation" and "initialization" happen when the foreign
1102;;; thread first tries to call lisp code.  "termination" happens
1103;;; via the pthread thread-local-storage cleanup mechanism.
1104(defcallback %foreign-thread-control (:without-interrupts t :int param :int)
1105  (declare (fixnum param))
1106  (cond ((< param 0) (%foreign-thread-prepare))
1107        ((= param 0) (%foreign-thread-initialize) 0)
1108        (t (%foreign-thread-terminate) 0)))
1109
1110
1111
1112(defun %foreign-thread-prepare ()
1113  (let* ((initial-bindings (standard-initial-bindings)))
1114    (%save-standard-binding-list initial-bindings)
1115    (* 3 (+ 2 (length initial-bindings)))))
1116
1117
1118(defun %foreign-thread-initialize ()
1119  ;; Recover the initial-bindings alist.
1120  (let* ((bsp (%saved-bindings-address))
1121         (initial-bindings (%fixnum-ref bsp )))
1122    (declare (fixnum bsp))
1123    ;; Um, this is a little more complicated now that we use
1124    ;; thread-local shallow binding
1125    (flet ((save-binding (new-value sym prev)
1126             (let* ((idx (symbol-binding-index sym))
1127                    (byte-idx (ash idx target::fixnum-shift))
1128                    (binding-vector (%ensure-tlb-index idx))
1129                    (old-value (%fixnum-ref  binding-vector byte-idx)))
1130             (setf (%fixnum-ref binding-vector byte-idx) new-value
1131                   (%fixnum-ref bsp (ash -1 target::word-shift)) old-value
1132                   (%fixnum-ref bsp (ash -2 target::word-shift)) idx
1133                   (%fixnum-ref bsp (ash -3 target::word-shift)) prev
1134                   bsp (- bsp 3)))))
1135      (save-binding nil '*current-lisp-thread* 0)
1136      (save-binding nil '*current-process* bsp)
1137      (dolist (pair initial-bindings)
1138        (save-binding (funcall (cdr pair)) (car pair) bsp))
1139      ;; These may (or may not) be the most recent special bindings.
1140      ;; If they are, just set the current tcr's db-link to point
1141      ;; to BSP; if not, "append" them to the end of the current
1142      ;; linked list.
1143      (let* ((current-db-link (%fixnum-ref (%current-tcr)
1144                                           (- target::tcr.db-link
1145                                              target::tcr-bias))))
1146        (declare (fixnum current-db-link))
1147        (if (zerop current-db-link)
1148          (setf (%fixnum-ref (%current-tcr) (- target::tcr.db-link
1149                                               target::tcr-bias)) bsp)
1150          (do* ((binding current-db-link)
1151                (next (%fixnum-ref binding 0)
1152                      (%fixnum-ref binding 0)))
1153               ()
1154            (if (zerop next)
1155              (return (setf (%fixnum-ref binding 0) bsp))
1156              (setq binding next)))))
1157      ;; Ensure that pending unwind-protects (for WITHOUT-INTERRUPTS
1158      ;; on the callback) don't try to unwind the binding stack beyond
1159      ;; where it was just set.
1160      (do* ((catch (%fixnum-ref (%current-tcr) (- target::tcr.catch-top
1161                                                  target::tcr-bias))
1162                   (%fixnum-ref catch target::catch-frame.link)))
1163           ((zerop catch))
1164        (declare (fixnum catch))
1165        (when (eql 0 (%fixnum-ref catch target::catch-frame.db-link))
1166          (setf (%fixnum-ref catch target::catch-frame.db-link) bsp)))))
1167  (let* ((thread (new-lisp-thread-from-tcr (%current-tcr) "foreign")))
1168    (setq *current-lisp-thread* thread
1169          *current-process*
1170          (make-process "foreign" :thread thread)
1171          *whostate* "Foreign thread callback")))
1172   
1173;;; Remove the foreign thread's lisp-thread and lisp process from
1174;;; the global lists.
1175(defun %foreign-thread-terminate ()
1176  (let* ((proc *current-process*))
1177    (when proc
1178      (remove-from-all-processes proc)
1179      (let* ((ts (process-termination-semaphore proc)))
1180        (when ts (signal-semaphore ts))))))
1181
Note: See TracBrowser for help on using the repository browser.