source: branches/1.2/devel/source/level-1/l1-lisp-threads.lisp @ 8167

Last change on this file since 8167 was 8167, checked in by gb, 12 years ago

gz's fix to thread state of exhausted threads.

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