source: trunk/source/lib/x86-backtrace.lisp @ 9879

Last change on this file since 9879 was 9879, checked in by gz, 11 years ago

Propagate r9620 to trunk from working-0711

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