source: branches/ia32/lib/backtrace.lisp @ 13886

Last change on this file since 13886 was 9403, checked in by rme, 12 years ago

Use target::target-most-positive-fixnum.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 18.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 target::target-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 target::target-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      (multiple-value-bind (req opt restp keys)
99          (function-args lfun)
100        (when (or (not (eql 0 req)) (not (eql 0 opt)) restp keys)
101          (let* ((arglist (arglist-from-map lfun)))
102            (if (null arglist)
103              (call "???")
104              (progn
105                (dotimes (i req)
106                  (let* ((val (argument-value context cfp lfun pc (pop arglist))))
107                    (if (eq val (%unbound-marker))
108                      (call "?")
109                      (call (let* ((*print-length* *backtrace-print-length*)
110                                   (*print-level* *backtrace-print-level*))
111                              (format nil "~s" val))))))
112                (if (or restp keys (not (eql opt 0)))
113                  (call "[...]"))
114                ))))))
115    (call)))
116
117
118;;; Return a list of "interesting" frame addresses in context, most
119;;; recent first.
120(defun %stack-frames-in-context (context &optional (include-internal *backtrace-show-internal-frames*))
121  (collect ((frames))
122    (do* ((p (bt.youngest context) (parent-frame p context))
123          (q (bt.oldest context)))
124         ((eql p q) (frames))
125      (when (or (not (catch-csp-p p context)) include-internal)
126        (when (or (cfp-lfun p) include-internal)
127          (frames p))))))
128   
129(defun %print-call-history-internal (context origin detailed-p
130                                             &optional (count target::target-most-positive-fixnum) (skip-initial 0))
131  (let ((*standard-output* *debug-io*)
132        (*print-circle* nil)
133        (p origin)
134        (q (last-frame-ptr context)))
135    (dotimes (i skip-initial)
136      (setq p (parent-frame p context))
137      (when (or (null p) (eq p q) (%stack< q p context))
138        (return (setq p nil))))
139    (do* ((frame-number (or skip-initial 0) (1+ frame-number))
140          (i 0 (1+ i))
141          (p p (parent-frame p context)))
142         ((or (null p) (eq p q) (%stack< q p context)
143              (>= i count))
144          (values))
145      (declare (fixnum frame-number i))
146      (when (or (not (catch-csp-p p context))
147                *backtrace-show-internal-frames*)
148        (multiple-value-bind (lfun pc) (cfp-lfun p)
149          (when (or lfun *backtrace-show-internal-frames*)
150            (unless (and (typep detailed-p 'fixnum)
151                         (not (= (the fixnum detailed-p) frame-number)))
152              (format t "~&(~x) : ~D ~a ~d"
153                      (index->address p) frame-number
154                      (if lfun (backtrace-call-arguments context p lfun pc))
155                      pc)
156              (when detailed-p
157                (if (eq detailed-p :raw)
158                  (%show-stack-frame p context lfun pc)
159                  (%show-args-and-locals p context lfun pc))))))))))
160
161
162(defun %access-lisp-data (vstack-index)
163  (%fixnum-ref vstack-index))
164
165(defun %store-lisp-data (vstack-index value)
166  (setf (%fixnum-ref vstack-index) value))
167
168(defun closed-over-value (data)
169  (if (closed-over-value-p data)
170    (uvref data 0)
171    data))
172
173(defun set-closed-over-value (value-cell value)
174  (setf (uvref value-cell 0) value))
175
176
177
178;;; Act as if VSTACK-INDEX points at some lisp data & return that data.
179(defun access-lisp-data (vstack-index)
180  (closed-over-value (%access-lisp-data vstack-index)))
181
182(defun find-local-name (cellno lfun pc)
183  (let* ((n cellno))
184    (when lfun
185      (multiple-value-bind (mask where) (registers-used-by lfun pc)
186        (if (and where (< (1- where) n (+ where (logcount mask))))
187          (let ((j *saved-register-count*))
188            (decf n where)
189            (loop (loop (if (logbitp (decf j) mask) (return)))
190                  (if (< (decf n) 0) (return)))
191            (values (format nil "saved ~a" (aref *saved-register-names* j))
192                    nil))
193          (multiple-value-bind (nreq nopt restp nkeys junk optinitp junk ncells nclosed)
194                               (if lfun (function-args lfun))
195            (declare (ignore junk optinitp))
196            (if nkeys (setq nkeys (+ nkeys nkeys)))
197            (values
198             (if (and ncells (< n ncells))
199               (if (< n nclosed)
200                 :inherited
201                 (if (< (setq n (- n nclosed)) nreq)
202                   "required"
203                   (if (< (setq n (- n nreq)) nopt)
204                     "optional"
205                     (progn
206                       (setq n (- n nopt))
207                       (progn
208                         (if (and nkeys (< n nkeys))
209                           (if (not (logbitp 0 n)) ; a keyword
210                             "keyword"
211                             "key-supplied-p")
212                           (progn
213                             (if nkeys (setq n (- n nkeys)))
214                             (if (and restp (zerop n))
215                               "rest"
216                               "opt-supplied-p")))))))))
217             (match-local-name cellno (function-symbol-map lfun) pc))))))))
218
219(defun map-entry-value (context cfp lfun pc idx unavailable)
220  (declare (fixnum pc idx))
221  (let* ((info (function-symbol-map lfun)))
222    (if (null info)
223      unavailable
224      (let* ((addrs (cdr info))
225             (i (* 3 idx))
226             (addr (svref addrs i))
227             (startpc (svref addrs (the fixnum (+ i 1))))
228             (endpc (svref addrs (the fixnum (+ i 2)))))
229        (declare (fixnum i addr startpc endpc))
230        (if (or (< pc startpc)
231                (>= pc endpc))
232          unavailable
233          (let* ((value (if (= #o77 (ldb (byte 6 0) addr))
234                          (raw-frame-ref cfp context (ash addr (- (+ target::word-shift 6)))
235                                         unavailable)
236                          (find-register-argument-value context cfp addr unavailable))))
237            (if (typep value 'value-cell)
238              (uvref value 0)
239              value)))))))
240
241(defun argument-value (context cfp lfun pc name &optional (quote t))
242  (declare (fixnum pc))
243  (let* ((info (function-symbol-map lfun))
244         (unavailable (%unbound-marker)))
245    (if (null info)
246      unavailable
247      (let* ((names (car info))
248             (addrs (cdr info)))
249        (do* ((nname (1- (length names)) (1- nname))
250              (naddr (- (length addrs) 3) (- naddr 3)))
251             ((or (< nname 0) (< naddr 0)) unavailable)
252          (declare (fixnum nname naddr))
253          (when (eq (svref names nname) name)
254            (let* ((value
255                    (let* ((addr (svref addrs naddr))
256                           (startpc (svref addrs (the fixnum (1+ naddr))))
257                           (endpc (svref addrs (the fixnum (+ naddr 2)))))
258                      (declare (fixnum addr startpc endpc))
259                      (if (or (< pc startpc)
260                              (>= pc endpc))
261                        unavailable
262                        (if (= #o77 (ldb (byte 6 0) addr))
263                          (raw-frame-ref cfp context (ash addr (- (+ target::word-shift 6)))
264                                         unavailable)
265                          (find-register-argument-value context cfp addr unavailable))))))
266              (if (typep value 'value-cell)
267                (setq value (uvref value 0)))
268              (if (or (not quote) (self-evaluating-p value))
269                (return value)
270                (return (list 'quote value))))))))))
271
272
273
274(defun raw-frame-ref (cfp context index bad)
275  (%raw-frame-ref cfp context index bad))
276 
277(defun find-register-argument-value (context cfp regval bad)
278  (%find-register-argument-value context cfp regval bad))
279   
280
281(defun dbg-form (frame-number)
282  (when *break-frame*
283    (let* ((cfp (nth-raw-frame frame-number *break-frame* nil)))
284      (if (and cfp (not (catch-csp-p cfp nil)))
285        (multiple-value-bind (function pc)
286            (cfp-lfun cfp)
287          (if (and function
288                   (function-is-current-definition? function))
289            (block %cfp-form
290              (collect ((form))
291                (multiple-value-bind (nreq nopt restp keys allow-other-keys
292                                           optinit lexprp ncells nclosed)
293                    (function-args function)
294                  (declare (ignore ncells))
295                  (unless (or lexprp restp (> 0 nclosed) (> 0 nopt) keys allow-other-keys
296                              optinit)
297                    (let* ((name (function-name function)))
298                      (multiple-value-bind (arglist win)
299                          (arglist-from-map function)
300                      (when (and win name (symbolp name))
301                        (form name)
302                        (dotimes (i nreq)
303                          (let* ((val (argument-value nil cfp function pc (pop arglist))))
304                            (if (closed-over-value-p val)
305                              (setq val (%svref val target::value-cell.value-cell)))
306                            (if (eq val (%unbound-marker))
307                              (return-from %cfp-form nil))
308                            (form val))))))))
309                (form)))))))))
310
311(defun function-args (lfun)
312  "Returns 9 values, as follows:
313     req = number of required arguments
314     opt = number of optional arguments
315     restp = t if rest arg
316     keys = number of keyword arguments or NIL if &key not mentioned
317     allow-other-keys = t if &allow-other-keys present
318     optinit = t if any optional arg has non-nil default value or supplied-p
319               variable
320     lexprp = t if function is a lexpr, in which case all other values are
321              undefined.
322     ncells = number of stack frame cells used by all arguments.
323     nclosed = number of inherited values (now counted distinctly from required)
324     All numeric values (but ncells) are mod 64."
325  (let* ((bits (lfun-bits lfun))
326         (req (ldb $lfbits-numreq bits))
327         (opt (ldb $lfbits-numopt bits))
328         (restp (logbitp $lfbits-rest-bit bits))
329         (keyvect (lfun-keyvect lfun))
330         (keys (and keyvect (length keyvect)))
331         (allow-other-keys (logbitp $lfbits-aok-bit bits))
332         (optinit (logbitp $lfbits-optinit-bit bits))
333         (lexprp (logbitp $lfbits-restv-bit bits))
334         (nclosed (ldb $lfbits-numinh bits)))
335    (values req opt restp keys allow-other-keys optinit lexprp
336            (unless (or lexprp)
337              (+ req opt (if restp 1 0) (if keys (+ keys keys) 0)
338                 (if optinit opt 0) nclosed))
339            nclosed)))
340
341;;; If we can tell reliably, return the function's minimum number of
342;;; non-inherited arguments, the maximum number of such arguments (or NIL),
343;;; and the actual number of such arguments.  We "can't tell" if either
344;;; of the arguments to this function are null, and we can't tell reliably
345;;; if any of the lfbits fields are full.
346(defun min-max-actual-args (fn nargs)
347  (let* ((lfbits (if (and fn nargs)
348                   (lfun-bits fn)
349                   -1))
350         (raw-req (ldb $lfbits-numreq lfbits))
351         (raw-opt (ldb $lfbits-numopt lfbits))
352         (raw-inh (ldb $lfbits-numinh lfbits)))
353    (declare (fixnum raw-req raw-opt raw-inh))
354    (if (or (eql raw-req (1- (ash 1 (byte-size $lfbits-numreq))))
355            (eql raw-opt (1- (ash 1 (byte-size $lfbits-numopt))))
356            (eql raw-inh (1- (ash 1 (byte-size $lfbits-numinh)))))
357      (values nil nil nil)
358      (values raw-req
359              (unless (or (lfun-keyvect fn)
360                          (logbitp $lfbits-rest-bit lfbits)
361                          (logbitp $lfbits-restv-bit lfbits))
362                (+ raw-req raw-opt))
363              (- nargs raw-inh)))))
364
365
366
367(defun closed-over-value-p (value)
368  (eql target::subtag-value-cell (typecode value)))
369
370
371(defun variables-in-scope (lfun pc)
372  ;; Return a list of all symbol names "in scope" in the function lfun
373  ;; at relative program counter PC, using the function's symbol map.
374  ;; The list will be ordered so that least-recent bindings appear first.
375  ;; Return a list of the matching symbol map entries as a second value
376  (when pc
377    (locally (declare (fixnum pc))
378      (let* ((map (function-symbol-map lfun))
379             (names (car map))
380             (info (cdr map)))
381        (when map
382          (let* ((vars ())
383                 (indices ()))
384            (dotimes (i (length names) (values vars indices))
385              (let* ((start-pc (aref info (1+ (* 3 i))))
386                     (end-pc (aref info (+ 2 (* 3 i)))))
387                (declare (fixnum start-pc end-pc))
388                (when (and (>= pc start-pc)
389                           (< pc end-pc))
390                  (push i indices)
391                  (push (svref names i) vars))))))))))
392
393(defun arguments-and-locals (context cfp lfun pc &optional unavailable)
394  (multiple-value-bind (vars map-indices) (variables-in-scope lfun pc)
395    (collect ((args)
396              (locals))
397      (multiple-value-bind (valid req opt rest keys)
398          (arg-names-from-map lfun pc)
399        (when valid
400          (let* ((nargs (+ (length req) (length opt) (if rest 1 0) (length keys)))
401                 (nlocals (- (length vars) nargs))
402                 (local-vars (nthcdr nargs vars))
403                 (local-indices (nthcdr nargs map-indices))
404                 (arg-vars (nbutlast vars nlocals))
405                 (arg-indices (nbutlast map-indices nlocals)))
406            (flet ((get-arg-value (name)
407                     (let* ((pos (position name arg-vars :test #'eq)))
408                       (when pos
409                         (args (cons name (map-entry-value context cfp lfun pc (nth pos arg-indices) unavailable))))))
410                   (get-local-value (name)
411                     (when name
412                       (locals (cons name (map-entry-value context cfp lfun pc (pop local-indices) unavailable))))))
413              (dolist (name req)
414                (get-arg-value name))
415              (dolist (name opt)
416                (get-arg-value name))
417              (when rest
418                (get-arg-value rest))
419              (dolist (name keys)
420                (get-arg-value name))
421              #+no
422              (setq local-vars (nreverse local-vars)
423                    local-indices (nreverse local-indices))
424              (dolist (name local-vars)
425                (get-local-value name)))))
426        (values (args) (locals))))))
427                   
428           
429
430(defun safe-cell-value (val)
431  val)
432
433(defun closure-closed-over-values (closure)
434  (when (typep closure 'compiled-lexical-closure)
435    (let* ((inner (closure-function closure))
436           (nclosed (nth-value 8 (function-args inner)))
437           (names (car (function-symbol-map inner))))
438      (when nclosed
439        (collect ((cells))
440          (do* ((i (1- (length names)) (1- i))
441                (k 0 (1+ k))
442                (idx 2 (1+ idx)))
443               ((= k nclosed) (reverse (cells)))
444            (let* ((name (svref names i))
445                   (imm (nth-immediate closure idx)))
446              (cells (list name (if (closed-over-value-p imm)
447                                  (closed-over-value imm)
448                                  imm))))))))))
449
450     
451;;; Find the oldest binding frame that binds the same symbol as
452;;; FRAME in context.  If found, return the saved value of that
453;;; binding, else the value of the symbol in the context's thread.
454(defun oldest-binding-frame-value (context frame)
455  (let* ((oldest nil)
456         (binding-index (%fixnum-ref frame (ash 1 target::fixnum-shift))))
457    (do* ((db (db-link context) (%fixnum-ref db 0)))
458         ((eq frame db)
459          (if oldest
460            (%fixnum-ref oldest (ash 2 target::fixnum-shift))
461            (let* ((symbol (binding-index-symbol binding-index)))
462              (if context
463                (symbol-value-in-tcr symbol (bt.tcr context))
464                (%sym-value symbol)))))
465      (if (eq (%fixnum-ref db (ash 1 target::fixnum-shift)) binding-index)
466        (setq oldest db)))))
467   
468
469
470;;; End of backtrace.lisp
Note: See TracBrowser for help on using the repository browser.