source: branches/qres/ccl/lib/x86-backtrace.lisp @ 14259

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

r13066, r13067 from trunk: copyrights etc

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 17.0 KB
Line 
1;;;-*-Mode: LISP; Package: CCL -*-
2;;;
3;;;   Copyright (C) 2006-2009 Clozure Associates and contributors
4;;;   This file is part of Clozure CL. 
5;;;
6;;;   Clozure CL is licensed under the terms of the Lisp Lesser GNU Public
7;;;   License , known as the LLGPL and distributed with Clozure CL as the
8;;;   file "LICENSE".  The LLGPL consists of a preamble and the LGPL,
9;;;   which is distributed with Clozure CL as the file "LGPL".  Where these
10;;;   conflict, the preamble takes precedence. 
11;;;
12;;;   Clozure CL 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
18(in-package "CCL")
19
20
21;;; Returns two values:
22;;;  [nil, nil] if it can be reliably determined that function uses no registers at PC
23;;;  [mask, saved-location]  if it can be reliably determined that the registers specified by "mask"
24;;;      were saved at "saved-location" in the function's stack frame
25;;;  [mask, nil] if registers in "mask" MAY have been saved, but we don't know how to restore them
26;;;      (perhaps because the "at-pc" argument wasn't specified.
27
28
29(defun registers-used-by (function &optional at-pc)
30  (multiple-value-bind (mask stack-location rpc)
31      (%function-register-usage function)
32    (if (or (null mask)
33            (and at-pc rpc (<= at-pc rpc)))
34      (values nil nil)
35      (values (canonicalize-register-mask mask) (if (and at-pc rpc) stack-location)))))
36
37(defun canonicalize-register-mask (mask)
38  (dpb (ldb (byte 2 14) mask) (byte 2 2) (ldb (byte 2 11) mask)))
39
40(defun xcf-p (p)
41  (eql 0 (%fixnum-ref p target::lisp-frame.return-address)))
42
43(defun %current-xcf ()
44  (do* ((q (%get-frame-ptr) (%%frame-backlink q)))
45       ((zerop q))
46    (declare (fixnum q))
47    (when (xcf-p q) (return q))))
48
49;;; Try to determine the program counter value, relative to an xcf's nominal function.
50(defun pc-from-xcf (xcf)
51  (let* ((nominal-function (%fixnum-ref xcf target::xcf.nominal-function))
52         (containing-object (%fixnum-ref xcf target::xcf.containing-object)))
53    (when (typep nominal-function 'function)
54      (if (eq containing-object (function-to-function-vector nominal-function))
55        (- (%fixnum-ref xcf target::xcf.relative-pc)
56           #+x8632-target x8632::fulltag-misc
57           #+x8664-target x8664::tag-function)
58        (let* ((tra (%fixnum-ref xcf target::xcf.ra0)))
59          (if (and #+x8664-target (= (lisptag tra) x8664::tag-tra)
60                   #+x8632-target (= (fulltag tra) x8632::fulltag-tra)
61                   (eq nominal-function (%return-address-function tra)))
62            (%return-address-offset tra)))))))
63           
64(defun cfp-lfun (p)
65  (if (xcf-p p)
66    (values
67     (%fixnum-ref p target::xcf.nominal-function)
68     (pc-from-xcf p))
69    (%cfp-lfun p)))
70
71;;; On PPC, some frames on the control stack are associated with catch
72;;; frames rather than with function calls.  The whole concept doesn't
73;;; really apply here (e.g., nothing we encounter while walking frame
74;;; pointer links belongs to a catch frame.)
75(defun catch-csp-p (p context)
76  (declare (ignore p context)))
77
78(defun %raw-frame-ref (frame context idx bad)
79  (declare (fixnum frame idx))
80  (let* ((base (parent-frame frame context))
81         (raw-size (- base frame)))
82    (declare (fixnum base raw-size))
83    (if (and (>= idx 0)
84             (< idx raw-size))
85      (let* ((addr (- (the fixnum (1- base))
86                      idx)))
87        (multiple-value-bind (db-count first-db last-db)
88            (count-db-links-in-frame frame base context)
89          (let* ((is-db-link
90                  (unless (zerop db-count)
91                    (do* ((last last-db (previous-db-link last first-db)))
92                         ((null last))
93                      (when (= addr last)
94                        (return t))))))
95            (if is-db-link
96              (oldest-binding-frame-value context addr)
97              (%fixnum-ref addr)))))
98      bad)))
99
100(defun %raw-frame-set (frame context idx new)
101  (declare (fixnum frame idx))
102  (let* ((base (parent-frame frame context))
103         (raw-size (- base frame)))
104    (declare (fixnum base raw-size))
105    (if (and (>= idx 0)
106             (< idx raw-size))
107      (let* ((addr (- (the fixnum (1- base))
108                      idx)))
109        (multiple-value-bind (db-count first-db last-db)
110            (count-db-links-in-frame frame base context)
111          (let* ((is-db-link
112                  (unless (zerop db-count)
113                    (do* ((last last-db (previous-db-link last first-db)))
114                         ((null last))
115                      (when (= addr last)
116                        (return t))))))
117            (if is-db-link
118              (setf (oldest-binding-frame-value context addr) new)
119              (setf (%fixnum-ref addr) new))))))))
120
121(defun %stack< (index1 index2 &optional context)
122  (let* ((tcr (if context (bt.tcr context) (%current-tcr)))
123         (vs-area (%fixnum-ref tcr target::tcr.vs-area)))
124    (and (%ptr-in-area-p index1 vs-area)
125         (%ptr-in-area-p index2 vs-area)
126         (< (the fixnum index1) (the fixnum index2)))))
127
128
129
130
131(defun register-number->saved-register-index (regnum)
132  (ecase regnum
133    (#.x8664::save3 0)
134    (#.x8664::save2 1)
135    (#.x8664::save1 2)
136    (#.x8664::save0 3)))
137
138
139(defun get-register-value (address last-catch index)
140  (if address
141    (%fixnum-ref address)
142    (uvref last-catch (+ index 
143                         #+x8632-target
144                         x8632::catch-frame.db-link-cell
145                         #+x8664-target
146                         x8664::catch-frame.save-save3-cell))))
147
148;;; Inverse of get-register-value
149
150(defun set-register-value (value address last-catch index)
151  (if address
152    (%fixnum-set address value)
153    (setf (uvref last-catch (+ index
154                               #+x8632-target
155                               x8632::catch-frame.db-link-cell
156                               #+x8664-target
157                               x8664::catch-frame.save-save3-cell))
158          value)))
159
160(defun %find-register-argument-value (context cfp regval bad)
161  (let* ((last-catch (last-catch-since cfp context))
162         (index (register-number->saved-register-index regval)))
163    (do* ((frame cfp (child-frame frame context))
164          (first t))
165         ((null frame))
166      (if (xcf-p frame)
167        (with-macptrs (xp)
168          (%setf-macptr-to-object xp (%fixnum-ref frame x8664::xcf.xp))
169          (return-from %find-register-argument-value
170            (encoded-gpr-lisp xp regval)))
171        (progn
172          (unless first
173            (multiple-value-bind (lfun pc)
174                (cfp-lfun frame)
175              (when lfun
176                (multiple-value-bind (mask where)
177                    (registers-used-by lfun pc)
178                  (when (if mask (logbitp index mask))
179                    (return-from %find-register-argument-value
180                      (if where
181                        (let ((offset (logcount (logandc2 mask (1- (ash 1 (1+ index)))))))
182                          (raw-frame-ref frame context (+ where offset) bad))
183                        bad)))))))
184          (setq first nil))))
185    (get-register-value nil last-catch index)))
186
187(defun %set-register-argument-value (context cfp regval new)
188  (let* ((last-catch (last-catch-since cfp context))
189         (index (register-number->saved-register-index regval)))
190    (do* ((frame cfp (child-frame frame context))
191          (first t))
192         ((null frame))
193      (if (xcf-p frame)
194        (with-macptrs (xp)
195          (%setf-macptr-to-object xp (%fixnum-ref frame x8664::xcf.xp))
196          (return-from %set-register-argument-value
197            (setf (encoded-gpr-lisp xp regval) new)))
198        (progn
199          (unless first
200            (multiple-value-bind (lfun pc)
201                (cfp-lfun frame)
202              (when lfun
203                (multiple-value-bind (mask where)
204                    (registers-used-by lfun pc)
205                  (when (if mask (logbitp index mask))
206                    (incf where (logcount (logandc2 mask (1- (ash 1 (1+ index))))))
207
208                    (return-from %set-register-argument-value
209                      (raw-frame-set frame context where new)))))))
210          (setq first nil))))
211    (set-register-value new nil last-catch index)))
212
213;;; Used for printing only.
214(defun index->address (p)
215  (ldb (byte #+32-bit-target 32 #+64-bit-target 64 0)  (ash p target::fixnumshift)))
216
217(defun exception-frame-p (x)
218  (and x (xcf-p x)))
219
220;;; Function has failed a number-of-arguments check; return a list
221;;; of the actual arguments.
222;;; On x86-64, the kernel has finished the frame and pushed everything
223;;; for us, so all that we need to do is to hide any inherited arguments.
224(defun arg-check-call-arguments (fp function)
225  (when (xcf-p fp)
226    (with-macptrs (xp)
227      (%setf-macptr-to-object xp (%fixnum-ref fp target::xcf.xp))
228      (let* ((numinh (ldb $lfbits-numinh (lfun-bits function)))
229             (nargs (- (xp-argument-count xp) numinh))
230             (p (- (%fixnum-ref fp target::xcf.backptr)
231                   (* target::node-size numinh))))
232        (declare (fixnum numinh nargs p))
233        (collect ((args))
234          (dotimes (i nargs (args))
235            (args (%fixnum-ref p (- target::node-size)))
236            (decf p)))))))
237
238(defun vsp-limits (frame context)
239  (let* ((parent (parent-frame frame context)))
240    (if (xcf-p frame)
241      (values (+ frame (ash target::xcf.size (- target::word-shift)))
242              parent)
243      (let* ((tra (%fixnum-ref frame target::lisp-frame.return-address)))
244        (values (+ frame 2 (if (eq tra (%get-kernel-global ret1valaddr)) 1 0))
245                parent)))))
246
247(defun last-catch-since (fp context)
248  (let* ((tcr (if context (bt.tcr context) (%current-tcr)))
249         (catch (%catch-top tcr))
250         (last-catch nil))
251    (loop
252      (unless catch (return last-catch))
253      (let ((catch-fp (uvref catch
254                             #+x8632-target
255                             x8632::catch-frame.ebp-cell
256                             #+x8664-target
257                             x8664::catch-frame.rbp-cell)))
258        (when (%stack< fp catch-fp context) (return last-catch))
259        (setq last-catch catch
260              catch (next-catch catch))))))
261
262(defun last-xcf-since (target-fp start-fp context)
263  (do* ((last-xcf nil)
264        (fp start-fp (parent-frame fp context)))
265       ((or (eql fp target-fp)
266            (null fp)
267            (%stack< target-fp fp)) last-xcf)
268    (if (xcf-p fp) (setq last-xcf fp))))
269
270(defun match-local-name (cellno info pc)
271  (when info
272    (let* ((syms (%car info))
273           (ptrs (%cdr info)))
274      (dotimes (i (length syms))
275        (let ((j (%i+ i (%i+ i i ))))
276          (and (eq (uvref ptrs j) (%ilogior (%ilsl (+ 6 target::word-shift) cellno) #o77))
277               (%i>= pc (uvref ptrs (%i+ j 1)))
278               (%i< pc (uvref ptrs (%i+ j 2)))
279               (return (aref syms i))))))))
280
281(defun apply-in-frame (frame function arglist &optional context)
282  (setq function (coerce-to-function function))
283  (let* ((parent (parent-frame frame context)))
284    (when parent
285      (if (xcf-p parent)
286        (error "Can't unwind to exception frame ~s" frame)
287        (setq frame parent))
288      (if (or (null context)
289              (eq (bt.tcr context) (%current-tcr)))
290        (%apply-in-frame frame function arglist)
291        (let* ((process (tcr->process (bt.tcr context))))
292          (if process
293            (process-interrupt process #'%apply-in-frame frame function arglist)
294            (error "Can't find process for backtrace context ~s" context)))))))
295
296(defun return-from-frame (frame &rest values)
297  (apply-in-frame frame #'values values nil))
298   
299
300(defun last-tsp-before (target)
301  (declare (fixnum target))
302  (do* ((tsp (%fixnum-ref (%current-tcr) target::tcr.save-tsp)
303             (%fixnum-ref tsp target::tsp-frame.backptr)))
304       ((zerop tsp) nil)
305    (declare (fixnum tsp))
306    (when (> (the fixnum (%fixnum-ref tsp #+x8632-target x8632::tsp-frame.ebp
307                                          #+x8664-target x8664::tsp-frame.rbp))
308             target)
309      (return tsp))))
310
311   
312
313
314;;; We can't determine this reliably (yet).
315(defun last-foreign-sp-before (target)
316  (declare (fixnum target))
317  (do* ((cfp (%fixnum-ref (%current-tcr) target::tcr.foreign-sp)
318             (%fixnum-ref cfp target::csp-frame.backptr)))
319       ((zerop cfp))
320    (declare (fixnum cfp))
321    (let* ((rbp (%fixnum-ref cfp #+x8632-target x8632::csp-frame.ebp
322                                 #+x8664-target x8664::csp-frame.rbp)))
323      (declare (fixnum rbp))
324      (if (> rbp target)
325        (return cfp)
326        (if (zerop rbp)
327          (return nil))))))
328
329
330(defun %tsp-frame-containing-progv-binding (db)
331  (declare (fixnum db))
332  (do* ((tsp (%fixnum-ref (%current-tcr) target::tcr.save-tsp) next)
333        (next (%fixnum-ref tsp target::tsp-frame.backptr)
334              (%fixnum-ref tsp target::tsp-frame.backptr)))
335       ()
336    (declare (fixnum tsp next))
337    (let* ((rbp (%fixnum-ref tsp #+x8632-target x8632::tsp-frame.ebp
338                                 #+x8664-target x8664::tsp-frame.rbp)))
339      (declare (fixnum rbp))
340      (if (zerop rbp)
341        (return (values nil nil))
342        (if (and (> db tsp)
343                 (< db next))
344          (return (values tsp rbp)))))))
345
346       
347
348
349
350
351(defun last-binding-before (frame)
352  (declare (fixnum frame))
353  (do* ((db (%current-db-link) (%fixnum-ref db 0))
354        (tcr (%current-tcr))
355        (vs-area (%fixnum-ref tcr target::tcr.vs-area))
356        (vs-low (%fixnum-ref vs-area target::area.low))
357        (vs-high (%fixnum-ref vs-area target::area.high)))
358       ((eql db 0) nil)
359    (declare (fixnum db vs-low vs-high))
360    (if (and (> db vs-low)
361             (< db vs-high))
362      (if (> db frame)
363        (return db))
364      ;; db link points elsewhere; PROGV uses the temp stack
365      ;; to store an indefinite number of bindings.
366      (multiple-value-bind (tsp rbp)
367          (%tsp-frame-containing-progv-binding db)
368        (if tsp
369          (if (> rbp frame)
370            (return db)
371            ;; If the tsp frame is too young, we can skip
372            ;; all of the bindings it contains.  The tsp
373            ;; frame contains two words of overhead, followed
374            ;; by a count of binding records in the frame,
375            ;; followed by the youngest of "count" binding
376            ;; records (which happens to be the value of
377            ;; "db".)  Skip "count" binding records.
378            (dotimes (i (the fixnum (%fixnum-ref tsp target::dnode-size)))
379              (setq db (%fixnum-ref db 0))))
380          ;; If the binding record wasn't on the temp stack and wasn't
381          ;; on the value stack, that probably means that things are
382          ;; seriously screwed up.  This error will be almost
383          ;; meaningless to the user.
384          (error "binding record (#x~16,'0x/#x~16,'0x) not on temp or value stack" (index->address db) db))))))
385         
386
387
388(defun find-x8664-saved-nvrs (frame start-fp context)
389  (let* ((locations (make-array 16 :initial-element nil))
390         (need (logior (ash 1 x8664::save0)
391                       (ash 1 x8664::save1)
392                       (ash 1 x8664::save2)
393                       (ash 1 x8664::save3))))
394    (declare (fixnum need)
395             (dynamic-extent locations))
396    (do* ((parent frame child)
397          (child (child-frame parent context) (child-frame child context)))
398         ((or (= need 0) (eq child start-fp))
399          (values (%svref locations x8664::save0)
400                  (%svref locations x8664::save1)
401                  (%svref locations x8664::save2)
402                  (%svref locations x8664::save3)))
403      (multiple-value-bind (lfun pc) (cfp-lfun child)
404        (when (and lfun pc)
405          (multiple-value-bind (used where) (registers-used-by lfun pc)
406            (when (and used where (logtest used need))
407              (locally (declare (fixnum used))
408                (do* ((i x8664::save3 (1+ i)))
409                     ((or (= i 16) (= used 0)))
410                  (declare (type (mod 16) i))
411                  (when (logbitp i used)
412                    (when (logbitp i need)
413                      (setq need (logandc2 need (ash 1 i)))
414                      (setf (%svref locations i)
415                            (- (the fixnum (1- parent))
416                               (+ where (logcount (logandc2 used (1+ (ash 1 (1+ i)))))))))
417                    (setq used (logandc2 used (ash 1 i)))))))))))))
418                                         
419             
420         
421(defun %apply-in-frame (frame function arglist)
422  (target-arch-case
423   (:x8632 (error "%apply-in-frame doesn't work for x8632 yet"))
424   (:x8664
425    (let* ((target-catch (last-catch-since frame nil))
426           (start-fp (if target-catch
427                       (uvref target-catch x8664::catch-frame.rbp-cell)
428                       (%get-frame-ptr)))
429           (target-xcf (last-xcf-since frame start-fp nil))
430           (target-db-link (last-binding-before frame))
431           (target-tsp (last-tsp-before frame))
432           (target-foreign-sp (last-foreign-sp-before frame)))
433      (multiple-value-bind (save0-loc save1-loc save2-loc save3-loc)
434          (find-x8664-saved-nvrs frame start-fp nil)
435        (let* ((thunk (%clone-x86-function #'%%apply-in-frame-proto
436                                           frame
437                                           target-catch
438                                           target-db-link
439                                           target-xcf
440                                           target-tsp
441                                           target-foreign-sp
442                                           (if save0-loc
443                                             (- save0-loc frame)
444                                             0)
445                                           (if save1-loc
446                                             (- save1-loc frame)
447                                             0)
448                                           (if save2-loc
449                                             (- save2-loc frame)
450                                             0)
451                                           (if save3-loc
452                                             (- save3-loc frame)
453                                             0)
454                                           (coerce-to-function function)
455                                           arglist
456                                           0)))
457          (funcall thunk)))))))
458
459           
460   
Note: See TracBrowser for help on using the repository browser.