1 ;;;; This file contains the noise to byte-compile stuff. It uses the
2 ;;;; same front end as the real compiler, but generates byte code
3 ;;;; instead of native code.
5 ;;;; This software is part of the SBCL system. See the README file for
8 ;;;; This software is derived from the CMU CL system, which was
9 ;;;; written at Carnegie Mellon University and released into the
10 ;;;; public domain. The software is in the public domain and is
11 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
12 ;;;; files for more information.
19 ;;; Generate trace-file output for the byte compiler back-end.
21 ;;; (Note: As of sbcl-0.6.7, this is target-only code not because it's
22 ;;; logically target-only, but just because it's still implemented in
25 (defun describe-byte-component (component xeps segment *standard-output*)
26 (format t "~|~%;;;; byte component ~S~2%" (component-name component))
27 (format t ";;; functions:~%")
28 (dolist (fun (component-lambdas component))
30 (let ((info (leaf-info fun)))
33 (sb!assem:label-position (byte-lambda-info-label info))
36 (format t "~%;;;disassembly:~2%")
43 (eps (simple-byte-function-entry-point xep)))
45 (dolist (ep (hairy-byte-function-entry-points xep))
47 (when (hairy-byte-function-more-args-entry-point xep)
48 (eps (hairy-byte-function-more-args-entry-point xep)))))))
49 ;; In CMU CL, this was
50 ;; (SB!ASSEM:SEGMENT-MAP-OUTPUT
52 ;; #'(LAMBDA (SAP BYTES) (CHUNKS (CONS SAP BYTES))))
54 (sb!assem:on-segment-contents-vectorly segment
55 (lambda (chunk) (chunks chunk)))
56 (let* ((total-bytes (reduce #'+ (mapcar #'cdr (chunks))))
57 ;; KLUDGE: It's not clear that BUF has to be a SAP instead
58 ;; of a nice high-level, safe, friendly vector. Perhaps
59 ;; this code could be rewritten to use ordinary indices and
60 ;; vectors instead of SAP references to chunks of raw
61 ;; system memory? -- WHN 19990811
62 (buf (allocate-system-memory total-bytes)))
64 (dolist (chunk (chunks))
65 (declare (type (simple-array (unsigned-byte 8)) chunk))
66 (copy-byte-vector-to-system-area chunk buf offset)
67 (incf offset chunk-n-bits)))
69 (disassem-byte-sap buf
76 (byte-component-info-constants
77 (component-info component)))
80 (deallocate-system-memory buf total-bytes)
83 ;;; Given a byte-compiled function, disassemble it to standard output.
84 (defun disassem-byte-fun (xep)
85 (declare (optimize (inhibit-warnings 3)))
86 (disassem-byte-component
87 (byte-function-component xep)
90 (list (simple-byte-function-entry-point xep)))
93 (if (hairy-byte-function-more-args-entry-point xep)
94 (cons (hairy-byte-function-more-args-entry-point xep)
95 (hairy-byte-function-entry-points xep))
96 (hairy-byte-function-entry-points xep)))
99 ;;; Given a byte-compiled component, disassemble it to standard output.
100 ;;; EPS is a list of the entry points.
101 (defun disassem-byte-component (component &optional (eps '(0)))
102 (let* ((bytes (* (code-header-ref component sb!vm:code-code-size-slot)
104 (num-consts (- (get-header-data component)
105 sb!vm:code-constants-offset))
106 (consts (make-array num-consts)))
107 (dotimes (i num-consts)
108 (setf (aref consts i)
109 (code-header-ref component (+ i sb!vm:code-constants-offset))))
111 (disassem-byte-sap (code-instructions component) bytes
115 ;;; Disassemble byte code from a SAP and constants vector.
116 (defun disassem-byte-sap (sap bytes constants eps)
117 (declare (optimize (inhibit-warnings 3)))
120 (format t "~&~4D:" index))
122 (let ((byte (sap-ref-8 sap index)))
123 (format t " ~2,'0X" byte)
127 (logior (ash (next-byte) 16)
130 (extract-extended-op ()
131 (let ((byte (next-byte)))
135 (extract-4-bit-op (byte)
136 (let ((4-bits (ldb (byte 4 0) byte)))
138 (extract-extended-op)
140 (extract-3-bit-op (byte)
141 (let ((3-bits (ldb (byte 3 0) byte)))
145 (extract-branch-target (byte)
147 (let ((disp (next-byte)))
152 (note (string &rest noise)
153 (format t "~12T~?" string noise))
154 (get-constant (index)
155 (if (< -1 index (length constants))
156 (aref constants index)
159 (unless (< index bytes)
162 (when (eql index (first eps))
166 (let ((byte (next-byte)))
169 (logior (ash (next-byte) 16)
172 (note "Entry point, frame-size=~D~%" frame-size)))
175 (let ((byte (next-byte)))
176 (macrolet ((dispatch (&rest clauses)
177 `(cond ,@(mapcar #'(lambda (clause)
178 `((= (logand byte ,(caar clause))
183 ((#b11110000 #b00000000)
184 (let ((op (extract-4-bit-op byte)))
185 (note "push-local ~D" op)))
186 ((#b11110000 #b00010000)
187 (let ((op (extract-4-bit-op byte)))
188 (note "push-arg ~D" op)))
189 ((#b11110000 #b00100000)
190 (let ((*print-level* 3)
192 (note "push-const ~S" (get-constant (extract-4-bit-op byte)))))
193 ((#b11110000 #b00110000)
194 (let ((op (extract-4-bit-op byte))
197 (note "push-sys-const ~S"
198 (svref *system-constants* op))))
199 ((#b11110000 #b01000000)
200 (let ((op (extract-4-bit-op byte)))
201 (note "push-int ~D" op)))
202 ((#b11110000 #b01010000)
203 (let ((op (extract-4-bit-op byte)))
204 (note "push-neg-int ~D" (- (1+ op)))))
205 ((#b11110000 #b01100000)
206 (let ((op (extract-4-bit-op byte)))
207 (note "pop-local ~D" op)))
208 ((#b11110000 #b01110000)
209 (let ((op (extract-4-bit-op byte)))
210 (note "pop-n ~D" op)))
211 ((#b11110000 #b10000000)
212 (let ((op (extract-3-bit-op byte)))
213 (note "~:[~;named-~]call, ~D args"
214 (logbitp 3 byte) op)))
215 ((#b11110000 #b10010000)
216 (let ((op (extract-3-bit-op byte)))
217 (note "~:[~;named-~]tail-call, ~D args"
218 (logbitp 3 byte) op)))
219 ((#b11110000 #b10100000)
220 (let ((op (extract-3-bit-op byte)))
221 (note "~:[~;named-~]multiple-call, ~D args"
222 (logbitp 3 byte) op)))
223 ((#b11111000 #b10110000)
225 (let ((op (extract-3-bit-op byte))
226 (target (extract-24-bits)))
227 (note "local call ~D, ~D args" target op)))
228 ((#b11111000 #b10111000)
230 (let ((op (extract-3-bit-op byte))
231 (target (extract-24-bits)))
232 (note "local tail-call ~D, ~D args" target op)))
233 ((#b11111000 #b11000000)
234 ;; local-multiple-call
235 (let ((op (extract-3-bit-op byte))
236 (target (extract-24-bits)))
237 (note "local multiple-call ~D, ~D args" target op)))
238 ((#b11111000 #b11001000)
240 (let ((op (extract-3-bit-op byte)))
241 (note "return, ~D vals" op)))
242 ((#b11111110 #b11010000)
244 (note "branch ~D" (extract-branch-target byte)))
245 ((#b11111110 #b11010010)
247 (note "if-true ~D" (extract-branch-target byte)))
248 ((#b11111110 #b11010100)
250 (note "if-false ~D" (extract-branch-target byte)))
251 ((#b11111110 #b11010110)
253 (note "if-eq ~D" (extract-branch-target byte)))
254 ((#b11111000 #b11011000)
256 (let* ((low-3-bits (extract-3-bit-op byte))
257 (xop (nth (if (eq low-3-bits :var) (next-byte) low-3-bits)
259 (note "xop ~A~@[ ~D~]"
262 ((catch go unwind-protect)
264 ((type-check push-n-under)
265 (get-constant (extract-extended-op)))))))
267 ((#b11100000 #b11100000)
270 (inline-function-info-function
271 (svref *inline-functions* (ldb (byte 5 0) byte))))))))))))