source: branches/working-0711/ccl/lib/backtrace.lisp @ 8036

Last change on this file since 8036 was 8036, checked in by gb, 13 years ago

%PRINT-CALL-HISTORY-INTERNAL: mark exeption frames, not their children.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 22.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;;; backtrace.lisp
18;;; low-level support for stack-backtrace printing
19
20(in-package "CCL")
21
22#+ppc-target (require "PPC-BACKTRACE")
23#+x86-target (require "X86-BACKTRACE")
24
25
26(defparameter *backtrace-show-internal-frames* nil)
27(defparameter *backtrace-print-level* 2)
28(defparameter *backtrace-print-length* 5)
29
30;;; This PRINTS the call history on *DEBUG-IO*.  It's more dangerous
31;;; (because of stack consing) to actually return it.
32                               
33(defun print-call-history (&key context
34                                (origin (%get-frame-ptr))
35                                (detailed-p t)
36                                (count most-positive-fixnum)
37                                (start-frame-number 0))
38  (let* ((tcr (if context (bt.tcr context) (%current-tcr))))         
39    (if (eq tcr (%current-tcr))
40      (%print-call-history-internal context origin detailed-p (or count most-positive-fixnum) start-frame-number)
41      (unwind-protect
42           (progn
43             (%suspend-tcr tcr )
44             (%print-call-history-internal context origin  detailed-p
45                                           count start-frame-number))
46        (%resume-tcr tcr)))
47    (values)))
48
49(defun %show-stack-frame (p context lfun pc)
50  (handler-case
51      (multiple-value-bind (count vsp parent-vsp) (count-values-in-frame p context)
52        (declare (fixnum count))
53        (dotimes (i count)
54          (multiple-value-bind (var type name) 
55                               (nth-value-in-frame p i context lfun pc vsp parent-vsp)
56            (format t "~&  ~D " i)
57            (when name (format t "~s" name))
58            (let* ((*print-length* *backtrace-print-length*)
59                   (*print-level* *backtrace-print-level*))
60              (format t ": ~s" var))
61            (when type (format t " (~S)" type)))))
62    (error () (format t "#<error printing frame>")))
63  (terpri)
64  (terpri))
65
66(defun %show-args-and-locals (p context lfun pc)
67  (handler-case
68      (let* ((unavailable (cons nil nil)))
69        (multiple-value-bind (args locals) (arguments-and-locals context p lfun pc unavailable)
70          (format t "~&  ~s" (arglist-from-map lfun))
71          (let* ((*print-length* *backtrace-print-length*)
72                 (*print-level* *backtrace-print-level*))
73            (flet ((show-pair (pair prefix)
74                     (destructuring-bind (name . val) pair
75                       (format t "~&~a~s: " prefix name)
76                       (if (eq val unavailable)
77                         (format t "#<Unavailable>")
78                         (format t "~s" val)))))
79              (dolist (arg args)
80                (show-pair arg "   "))
81              (terpri)
82              (terpri)
83              (dolist (loc locals)
84                (show-pair loc "  "))))))
85    (error () (format t "#<error printing args and locals>")))
86  (terpri)
87  (terpri))
88
89
90(defun backtrace-call-arguments (context cfp lfun pc)
91  (collect ((call))
92    (let* ((name (function-name lfun)))
93      (if (function-is-current-definition? lfun)
94        (call name)
95        (progn
96          (call 'funcall)
97          (call `(function ,(concatenate 'string "#<" (%lfun-name-string lfun) ">")))))
98      (if (<= pc target::arg-check-trap-pc-limit)
99        (append (call) (arg-check-call-arguments cfp lfun))
100        (multiple-value-bind (req opt restp keys)
101            (function-args lfun)
102          (when (or (not (eql 0 req)) (not (eql 0 opt)) restp keys)
103            (let* ((arglist (arglist-from-map lfun)))
104              (if (null arglist)
105                (call "???")
106                (progn
107                  (dotimes (i req)
108                    (let* ((val (argument-value context cfp lfun pc (pop arglist))))
109                      (if (eq val (%unbound-marker))
110                        (call "?")
111                        (call (let* ((*print-length* *backtrace-print-length*)
112                                     (*print-level* *backtrace-print-level*))
113                                (format nil "~s" val))))))
114                  (if (or restp keys (not (eql opt 0)))
115                    (call "[...]"))))))
116          (call))))))
117
118
119;;; Return a list of "interesting" frame addresses in context, most
120;;; recent first.
121(defun %stack-frames-in-context (context &optional (include-internal *backtrace-show-internal-frames*))
122  (collect ((frames))
123    (do* ((p (bt.youngest context) (parent-frame p context))
124          (q (bt.oldest context)))
125         ((eql p q) (frames))
126      (when (or (not (catch-csp-p p context)) include-internal)
127        (when (or (cfp-lfun p) include-internal)
128          (frames p))))))
129   
130(defun %print-call-history-internal (context origin detailed-p
131                                             &optional (count most-positive-fixnum) (skip-initial 0))
132  (let ((*standard-output* *debug-io*)
133        (*print-circle* nil)
134        (p origin)
135        (q (last-frame-ptr context)))
136    (dotimes (i skip-initial)
137      (setq p (parent-frame p context))
138      (when (or (null p) (eq p q) (%stack< q p context))
139        (return (setq p nil))))
140    (do* ((frame-number (or skip-initial 0) (1+ frame-number))
141          (i 0 (1+ i))
142          (p p (parent-frame p context)))
143         ((or (null p) (eq p q) (%stack< q p context)
144              (>= i count))
145          (values))
146      (declare (fixnum frame-number i))
147      (when (or (not (catch-csp-p p context))
148                *backtrace-show-internal-frames*)
149        (multiple-value-bind (lfun pc) (cfp-lfun p)
150          (when (or lfun *backtrace-show-internal-frames*)
151            (unless (and (typep detailed-p 'fixnum)
152                         (not (= (the fixnum detailed-p) frame-number)))
153              (format t "~&~c(~x) : ~D ~a ~d"
154                      (if (exception-frame-p p)  #\* #\space)
155                      (index->address p) frame-number
156                      (if lfun (backtrace-call-arguments context p lfun pc))
157                      pc)
158              (when detailed-p
159                (if (eq detailed-p :raw)
160                  (%show-stack-frame p context lfun pc)
161                  (%show-args-and-locals p context lfun pc))))))))))
162
163
164(defun %access-lisp-data (vstack-index)
165  (%fixnum-ref vstack-index))
166
167(defun %store-lisp-data (vstack-index value)
168  (setf (%fixnum-ref vstack-index) value))
169
170(defun closed-over-value (data)
171  (if (closed-over-value-p data)
172    (uvref data 0)
173    data))
174
175(defun set-closed-over-value (value-cell value)
176  (setf (uvref value-cell 0) value))
177
178
179
180;;; Act as if VSTACK-INDEX points at some lisp data & return that data.
181(defun access-lisp-data (vstack-index)
182  (closed-over-value (%access-lisp-data vstack-index)))
183
184(defun find-local-name (cellno lfun pc)
185  (let* ((n cellno))
186    (when lfun
187      (multiple-value-bind (mask where) (registers-used-by lfun pc)
188        (if (and where (< (1- where) n (+ where (logcount mask))))
189          (let ((j *saved-register-count*))
190            (decf n where)
191            (loop (loop (if (logbitp (decf j) mask) (return)))
192                  (if (< (decf n) 0) (return)))
193            (values (format nil "saved ~a" (aref *saved-register-names* j))
194                    nil))
195          (multiple-value-bind (nreq nopt restp nkeys junk optinitp junk ncells nclosed)
196                               (if lfun (function-args lfun))
197            (declare (ignore junk optinitp))
198            (if nkeys (setq nkeys (+ nkeys nkeys)))
199            (values
200             (if (and ncells (< n ncells))
201               (if (< n nclosed)
202                 :inherited
203                 (if (< (setq n (- n nclosed)) nreq)
204                   "required"
205                   (if (< (setq n (- n nreq)) nopt)
206                     "optional"
207                     (progn
208                       (setq n (- n nopt))
209                       (progn
210                         (if (and nkeys (< n nkeys))
211                           (if (not (logbitp 0 n)) ; a keyword
212                             "keyword"
213                             "key-supplied-p")
214                           (progn
215                             (if nkeys (setq n (- n nkeys)))
216                             (if (and restp (zerop n))
217                               "rest"
218                               "opt-supplied-p")))))))))
219             (match-local-name cellno (function-symbol-map lfun) pc))))))))
220
221(defun map-entry-value (context cfp lfun pc idx unavailable)
222  (declare (fixnum pc idx))
223  (let* ((info (function-symbol-map lfun)))
224    (if (null info)
225      unavailable
226      (let* ((addrs (cdr info))
227             (i (* 3 idx))
228             (addr (svref addrs i))
229             (startpc (svref addrs (the fixnum (+ i 1))))
230             (endpc (svref addrs (the fixnum (+ i 2)))))
231        (declare (fixnum i addr startpc endpc))
232        (if (or (< pc startpc)
233                (>= pc endpc))
234          unavailable
235          (let* ((value (if (= #o77 (ldb (byte 6 0) addr))
236                          (raw-frame-ref cfp context (ash addr (- (+ target::word-shift 6)))
237                                         unavailable)
238                          (find-register-argument-value context cfp addr unavailable))))
239            (if (typep value 'value-cell)
240              (uvref value 0)
241              value)))))))
242
243;;; Returns non-nil on success (not newval)
244(defun set-map-entry-value (context cfp lfun pc idx newval)
245  (declare (fixnum pc idx))
246  (let* ((unavailable (cons nil nil))
247         (value (map-entry-value context cfp lfun pc idx unavailable)))
248    (if (eq value unavailable)
249      nil
250      (if (typep value 'value-cell)
251        (progn (setf (uvref value 0) newval) t)
252
253        (let* ((addrs (cdr (function-symbol-map lfun)))
254               (addr (svref addrs (the fixnum (* 3 idx)))))
255          (declare (fixnum  addr))
256          (if (= #o77 (ldb (byte 6 0) addr))
257            (raw-frame-set cfp context (ash addr (- (+ target::word-shift 6))) newval)
258            (set-register-argument-value context cfp addr newval))
259          t)))))
260
261         
262(defun argument-value (context cfp lfun pc name &optional (quote t))
263  (declare (fixnum pc))
264  (let* ((info (function-symbol-map lfun))
265         (unavailable (%unbound-marker)))
266    (if (null info)
267      unavailable
268      (let* ((names (car info))
269             (addrs (cdr info)))
270        (do* ((nname (1- (length names)) (1- nname))
271              (naddr (- (length addrs) 3) (- naddr 3)))
272             ((or (< nname 0) (< naddr 0)) unavailable)
273          (declare (fixnum nname naddr))
274          (when (eq (svref names nname) name)
275            (let* ((value
276                    (let* ((addr (svref addrs naddr))
277                           (startpc (svref addrs (the fixnum (1+ naddr))))
278                           (endpc (svref addrs (the fixnum (+ naddr 2)))))
279                      (declare (fixnum addr startpc endpc))
280                      (if (or (< pc startpc)
281                              (>= pc endpc))
282                        unavailable
283                        (if (= #o77 (ldb (byte 6 0) addr))
284                          (raw-frame-ref cfp context (ash addr (- (+ target::word-shift 6)))
285                                         unavailable)
286                          (find-register-argument-value context cfp addr unavailable))))))
287              (if (typep value 'value-cell)
288                (setq value (uvref value 0)))
289              (if (or (not quote) (self-evaluating-p value))
290                (return value)
291                (return (list 'quote value))))))))))
292
293
294
295(defun raw-frame-ref (cfp context index bad)
296  (%raw-frame-ref cfp context index bad))
297
298(defun raw-frame-set (cfp context index new)
299  (%raw-frame-set cfp context index new))
300 
301(defun find-register-argument-value (context cfp regval bad)
302  (%find-register-argument-value context cfp regval bad))
303
304(defun set-register-argument-value (context cfp regval newval)
305  (%set-register-argument-value context cfp regval newval))
306
307   
308
309(defun dbg-form (frame-number)
310  (when *break-frame*
311    (let* ((cfp (nth-raw-frame frame-number *break-frame* nil)))
312      (if (and cfp (not (catch-csp-p cfp nil)))
313        (multiple-value-bind (function pc)
314            (cfp-lfun cfp)
315          (if (and function
316                   (function-is-current-definition? function))
317            (block %cfp-form
318              (collect ((form))
319                (multiple-value-bind (nreq nopt restp keys allow-other-keys
320                                           optinit lexprp ncells nclosed)
321                    (function-args function)
322                  (declare (ignore ncells))
323                  (unless (or lexprp restp (> 0 nclosed) (> 0 nopt) keys allow-other-keys
324                              optinit)
325                    (let* ((name (function-name function)))
326                      (multiple-value-bind (arglist win)
327                          (arglist-from-map function)
328                      (when (and win name (symbolp name))
329                        (form name)
330                        (dotimes (i nreq)
331                          (let* ((val (argument-value nil cfp function pc (pop arglist))))
332                            (if (closed-over-value-p val)
333                              (setq val (%svref val target::value-cell.value-cell)))
334                            (if (eq val (%unbound-marker))
335                              (return-from %cfp-form nil))
336                            (form val))))))))
337                (form)))))))))
338
339(defun function-args (lfun)
340  "Returns 9 values, as follows:
341     req = number of required arguments
342     opt = number of optional arguments
343     restp = t if rest arg
344     keys = number of keyword arguments or NIL if &key not mentioned
345     allow-other-keys = t if &allow-other-keys present
346     optinit = t if any optional arg has non-nil default value or supplied-p
347               variable
348     lexprp = t if function is a lexpr, in which case all other values are
349              undefined.
350     ncells = number of stack frame cells used by all arguments.
351     nclosed = number of inherited values (now counted distinctly from required)
352     All numeric values (but ncells) are mod 64."
353  (let* ((bits (lfun-bits lfun))
354         (req (ldb $lfbits-numreq bits))
355         (opt (ldb $lfbits-numopt bits))
356         (restp (logbitp $lfbits-rest-bit bits))
357         (keyvect (lfun-keyvect lfun))
358         (keys (and keyvect (length keyvect)))
359         (allow-other-keys (logbitp $lfbits-aok-bit bits))
360         (optinit (logbitp $lfbits-optinit-bit bits))
361         (lexprp (logbitp $lfbits-restv-bit bits))
362         (nclosed (ldb $lfbits-numinh bits)))
363    (values req opt restp keys allow-other-keys optinit lexprp
364            (unless (or lexprp)
365              (+ req opt (if restp 1 0) (if keys (+ keys keys) 0)
366                 (if optinit opt 0) nclosed))
367            nclosed)))
368
369;;; If we can tell reliably, return the function's minimum number of
370;;; non-inherited arguments, the maximum number of such arguments (or NIL),
371;;; and the actual number of such arguments.  We "can't tell" if either
372;;; of the arguments to this function are null, and we can't tell reliably
373;;; if any of the lfbits fields are full.
374(defun min-max-actual-args (fn nargs)
375  (let* ((lfbits (if (and fn nargs)
376                   (lfun-bits fn)
377                   -1))
378         (raw-req (ldb $lfbits-numreq lfbits))
379         (raw-opt (ldb $lfbits-numopt lfbits))
380         (raw-inh (ldb $lfbits-numinh lfbits)))
381    (declare (fixnum raw-req raw-opt raw-inh))
382    (if (or (eql raw-req (1- (ash 1 (byte-size $lfbits-numreq))))
383            (eql raw-opt (1- (ash 1 (byte-size $lfbits-numopt))))
384            (eql raw-inh (1- (ash 1 (byte-size $lfbits-numinh)))))
385      (values nil nil nil)
386      (values raw-req
387              (unless (or (lfun-keyvect fn)
388                          (logbitp $lfbits-rest-bit lfbits)
389                          (logbitp $lfbits-restv-bit lfbits))
390                (+ raw-req raw-opt))
391              (- nargs raw-inh)))))
392
393
394
395(defun closed-over-value-p (value)
396  (eql target::subtag-value-cell (typecode value)))
397
398
399(defun variables-in-scope (lfun pc)
400  ;; Return a list of all symbol names "in scope" in the function lfun
401  ;; at relative program counter PC, using the function's symbol map.
402  ;; The list will be ordered so that least-recent bindings appear first.
403  ;; Return a list of the matching symbol map entries as a second value
404  (when pc
405    (locally (declare (fixnum pc))
406      (let* ((map (function-symbol-map lfun))
407             (names (car map))
408             (info (cdr map)))
409        (when map
410          (let* ((vars ())
411                 (indices ()))
412            (dotimes (i (length names) (values vars indices))
413              (let* ((start-pc (aref info (1+ (* 3 i))))
414                     (end-pc (aref info (+ 2 (* 3 i)))))
415                (declare (fixnum start-pc end-pc))
416                (when (and (>= pc start-pc)
417                           (< pc end-pc))
418                  (push i indices)
419                  (push (svref names i) vars))))))))))
420
421
422(defun arg-value (context cfp lfun pc unavailable name)
423  (multiple-value-bind (vars map-indices) (variables-in-scope lfun pc)
424    (multiple-value-bind (valid req opt rest keys)
425        (arg-names-from-map lfun pc)
426      (if valid
427        (let* ((nargs (+ (length req) (length opt) (if rest 1 0) (length keys)))
428               (pos (position name vars)))
429          (if (and pos (< pos nargs))
430            (map-entry-value context cfp lfun pc (nth pos map-indices) unavailable)
431            unavailable))
432        unavailable))))
433
434(defun local-value (context cfp lfun pc unavailable name)
435  (multiple-value-bind (vars map-indices) (variables-in-scope lfun pc)
436    (multiple-value-bind (valid req opt rest keys)
437        (arg-names-from-map lfun pc)
438      (if valid
439        (let* ((nargs (+ (length req) (length opt) (if rest 1 0) (length keys)))
440               (names (nthcdr nargs vars))
441               (indices (nthcdr nargs map-indices))
442               (pos (if (typep name 'unsigned-byte)
443                      name
444                      (position name names :from-end t))))
445          (if (and pos (< pos nargs))
446            (map-entry-value context cfp lfun pc (nth pos indices) unavailable)
447            unavailable))
448        unavailable))))
449
450(defun set-arg-value (context cfp lfun pc name new)
451  (multiple-value-bind (vars map-indices) (variables-in-scope lfun pc)
452    (multiple-value-bind (valid req opt rest keys)
453        (arg-names-from-map lfun pc)
454      (if valid
455        (let* ((nargs (+ (length req) (length opt) (if rest 1 0) (length keys)))
456               (pos (position name vars)))
457          (when (and pos (< pos nargs))
458            (set-map-entry-value context cfp lfun pc (nth pos map-indices) new)))))))
459
460(defun set-local-value (context cfp lfun pc name new)
461  (multiple-value-bind (vars map-indices) (variables-in-scope lfun pc)
462    (multiple-value-bind (valid req opt rest keys)
463        (arg-names-from-map lfun pc)
464      (if valid
465        (let* ((nargs (+ (length req) (length opt) (if rest 1 0) (length keys)))
466               (names (nthcdr nargs vars))
467               (indices (nthcdr nargs map-indices))
468               (pos (if (typep name 'unsigned-byte)
469                      name
470                      (position name names :from-end t))))
471          (if (and pos (< pos nargs))
472            (set-map-entry-value context cfp lfun pc (nth pos indices) new)))))))
473
474
475(defun arguments-and-locals (context cfp lfun pc &optional unavailable)
476  (multiple-value-bind (vars map-indices) (variables-in-scope lfun pc)
477    (collect ((args)
478              (locals))
479      (multiple-value-bind (valid req opt rest keys)
480          (arg-names-from-map lfun pc)
481        (when valid
482          (let* ((nargs (+ (length req) (length opt) (if rest 1 0) (length keys)))
483                 (nlocals (- (length vars) nargs))
484                 (local-vars (nthcdr nargs vars))
485                 (local-indices (nthcdr nargs map-indices))
486                 (arg-vars (nbutlast vars nlocals))
487                 (arg-indices (nbutlast map-indices nlocals)))
488            (flet ((get-arg-value (name)
489                     (let* ((pos (position name arg-vars :test #'eq)))
490                       (when pos
491                         (args (cons name (map-entry-value context cfp lfun pc (nth pos arg-indices) unavailable))))))
492                   (get-local-value (name)
493                     (when name
494                       (locals (cons name (map-entry-value context cfp lfun pc (pop local-indices) unavailable))))))
495              (dolist (name req)
496                (get-arg-value name))
497              (dolist (name opt)
498                (get-arg-value name))
499              (when rest
500                (get-arg-value rest))
501              (dolist (name keys)
502                (get-arg-value name))
503              #+no
504              (setq local-vars (nreverse local-vars)
505                    local-indices (nreverse local-indices))
506              (dolist (name local-vars)
507                (get-local-value name)))))
508        (values (args) (locals))))))
509                   
510           
511
512(defun safe-cell-value (val)
513  val)
514
515(defun closure-closed-over-values (closure)
516  (when (typep closure 'compiled-lexical-closure)
517    (let* ((inner (closure-function closure))
518           (nclosed (nth-value 8 (function-args inner)))
519           (names (car (function-symbol-map inner))))
520      (when nclosed
521        (collect ((cells))
522          (do* ((i (1- (length names)) (1- i))
523                (k 0 (1+ k))
524                (idx 2 (1+ idx)))
525               ((= k nclosed) (reverse (cells)))
526            (let* ((name (svref names i))
527                   (imm (nth-immediate closure idx)))
528              (cells (list name (if (closed-over-value-p imm)
529                                  (closed-over-value imm)
530                                  imm))))))))))
531
532     
533;;; Find the oldest binding frame that binds the same symbol as
534;;; FRAME in context.  If found, return the saved value of that
535;;; binding, else the value of the symbol in the context's thread.
536(defun oldest-binding-frame-value (context frame)
537  (let* ((oldest nil)
538         (binding-index (%fixnum-ref frame (ash 1 target::fixnum-shift))))
539    (do* ((db (db-link context) (%fixnum-ref db 0)))
540         ((eq frame db)
541          (if oldest
542            (%fixnum-ref oldest (ash 2 target::fixnum-shift))
543            (let* ((symbol (binding-index-symbol binding-index)))
544              (if context
545                (symbol-value-in-tcr symbol (bt.tcr context))
546                (%sym-value symbol)))))
547      (if (eq (%fixnum-ref db (ash 1 target::fixnum-shift)) binding-index)
548        (setq oldest db)))))
549
550(defun (setf oldest-binding-frame-value) (new context frame)
551  (let* ((oldest nil)
552         (binding-index (%fixnum-ref frame (ash 1 target::fixnum-shift))))
553    (do* ((db (db-link context) (%fixnum-ref db 0)))
554         ((eq frame db)
555          (if oldest
556            (setf (%fixnum-ref oldest (ash 2 target::fixnum-shift)) new)
557            (let* ((symbol (binding-index-symbol binding-index)))
558              (if context
559                (setf (symbol-value-in-tcr symbol (bt.tcr context)) new)
560                (%set-sym-value symbol new)))))
561      (if (eq (%fixnum-ref db (ash 1 target::fixnum-shift)) binding-index)
562        (setq oldest db)))))
563   
564
565
566;;; End of backtrace.lisp
Note: See TracBrowser for help on using the repository browser.