e821679185d7f737f683b880dcb057f9f7816d56
[sbcl.git] / src / compiler / codegen.lisp
1 ;;;; the implementation-independent parts of the code generator. We use
2 ;;;; functions and information provided by the VM definition to convert
3 ;;;; IR2 into assembly code. After emitting code, we finish the
4 ;;;; assembly and then do the post-assembly phase.
5
6 ;;;; This software is part of the SBCL system. See the README file for
7 ;;;; more information.
8 ;;;;
9 ;;;; This software is derived from the CMU CL system, which was
10 ;;;; written at Carnegie Mellon University and released into the
11 ;;;; public domain. The software is in the public domain and is
12 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
13 ;;;; files for more information.
14
15 (in-package "SB!C")
16 \f
17 ;;;; utilities used during code generation
18
19 (defun component-header-length (&optional
20                                 (component *component-being-compiled*))
21   #!+sb-doc
22   "Returns the number of bytes used by the code object header."
23   (let* ((2comp (component-info component))
24          (constants (ir2-component-constants 2comp))
25          (num-consts (length constants)))
26     (ash (logandc2 (1+ num-consts) 1) sb!vm:word-shift)))
27
28 (defun sb-allocated-size (name)
29   #!+sb-doc
30   "The size of the Name'd SB in the currently compiled component. Useful
31   mainly for finding the size for allocating stack frames."
32   (finite-sb-current-size (sb-or-lose name)))
33
34 (defun current-nfp-tn (vop)
35   #!+sb-doc
36   "Return the TN that is used to hold the number stack frame-pointer in VOP's
37   function. Returns NIL if no number stack frame was allocated."
38   (unless (zerop (sb-allocated-size 'non-descriptor-stack))
39     (let ((block (ir2-block-block (vop-block vop))))
40     (when (ir2-environment-number-stack-p
41            (environment-info
42             (block-environment block)))
43       (ir2-component-nfp (component-info (block-component block)))))))
44
45 (defun callee-nfp-tn (2env)
46   #!+sb-doc
47   "Return the TN that is used to hold the number stack frame-pointer in the
48   function designated by 2env. Returns NIL if no number stack frame was
49   allocated."
50   (unless (zerop (sb-allocated-size 'non-descriptor-stack))
51     (when (ir2-environment-number-stack-p 2env)
52       (ir2-component-nfp (component-info *component-being-compiled*)))))
53
54 (defun callee-return-pc-tn (2env)
55   #!+sb-doc
56   "Return the TN used for passing the return PC in a local call to the function
57   designated by 2env."
58   (ir2-environment-return-pc-pass 2env))
59 \f
60 ;;;; specials used during code generation
61
62 (defvar *trace-table-info*)
63 (defvar *code-segment* nil)
64 (defvar *elsewhere* nil)
65 (defvar *elsewhere-label* nil)
66 \f
67 ;;;; noise to emit an instruction trace
68
69 (defvar *prev-segment*)
70 (defvar *prev-vop*)
71
72 #!+sb-show
73 (defun trace-instruction (segment vop inst args)
74   (let ((*standard-output* *compiler-trace-output*))
75     (unless (eq *prev-segment* segment)
76       (format t "in the ~A segment:~%" (sb!assem:segment-name segment))
77       (setf *prev-segment* segment))
78     (unless (eq *prev-vop* vop)
79       (when vop
80         (format t "~%VOP ")
81         (if (vop-p vop)
82             (print-vop vop)
83             (format *compiler-trace-output* "~S~%" vop)))
84       (terpri)
85       (setf *prev-vop* vop))
86     (case inst
87       (:label
88        (format t "~A:~%" args))
89       (:align
90        (format t "~0,8T.align~0,8T~A~%" args))
91       (t
92        (format t "~0,8T~A~@[~0,8T~{~A~^, ~}~]~%" inst args))))
93   (values))
94 \f
95 ;;;; GENERATE-CODE and support routines
96
97 ;;; standard defaults for slots of SEGMENT objects
98 (defun default-segment-run-scheduler ()
99   (and *assembly-optimize*
100         (policy (lambda-bind
101                  (block-home-lambda
102                   (block-next (component-head *component-being-compiled*))))
103                 (or (> speed compilation-speed) (> space compilation-speed)))))
104 (defun default-segment-inst-hook ()
105   #!+sb-show
106   (and *compiler-trace-output* #'trace-instruction))
107
108 (defun init-assembler ()
109   (setf *code-segment*
110         (sb!assem:make-segment :name "regular"
111                                :run-scheduler (default-segment-run-scheduler)
112                                :inst-hook (default-segment-inst-hook)))
113   #!+sb-dyncount
114   (setf (sb!assem:segment-collect-dynamic-statistics *code-segment*)
115         *collect-dynamic-statistics*)
116   (setf *elsewhere*
117         (sb!assem:make-segment :name "elsewhere"
118                                :run-scheduler (default-segment-run-scheduler)
119                                :inst-hook (default-segment-inst-hook)))
120   (values))
121
122 (defun generate-code (component)
123   #!+sb-show
124   (when *compiler-trace-output*
125     (format *compiler-trace-output*
126             "~|~%assembly code for ~S~2%"
127             component))
128   (let ((prev-env nil)
129         (*trace-table-info* nil)
130         (*prev-segment* nil)
131         (*prev-vop* nil)
132         (*fixups* nil))
133     (let ((label (sb!assem:gen-label)))
134       (setf *elsewhere-label* label)
135       (sb!assem:assemble (*elsewhere*)
136         (sb!assem:emit-label label)))
137     (do-ir2-blocks (block component)
138       (let ((1block (ir2-block-block block)))
139         (when (and (eq (block-info 1block) block)
140                    (block-start 1block))
141           (sb!assem:assemble (*code-segment*)
142             (sb!assem:emit-label (block-label 1block)))
143           (let ((env (block-environment 1block)))
144             (unless (eq env prev-env)
145               (let ((lab (gen-label)))
146                 (setf (ir2-environment-elsewhere-start (environment-info env))
147                       lab)
148                 (emit-label-elsewhere lab))
149               (setq prev-env env)))))
150       (do ((vop (ir2-block-start-vop block) (vop-next vop)))
151           ((null vop))
152         (let ((gen (vop-info-generator-function (vop-info vop))))
153           (if gen
154             (funcall gen vop)
155             (format t
156                     "missing generator for ~S~%"
157                     (template-name (vop-info vop)))))))
158     (sb!assem:append-segment *code-segment* *elsewhere*)
159     (setf *elsewhere* nil)
160     (values (sb!assem:finalize-segment *code-segment*)
161             (nreverse *trace-table-info*)
162             *fixups*)))
163
164 (defun emit-label-elsewhere (label)
165   (sb!assem:assemble (*elsewhere*)
166     (sb!assem:emit-label label)))
167
168 (defun label-elsewhere-p (label-or-posn)
169   (<= (label-position *elsewhere-label*)
170       (etypecase label-or-posn
171         (label
172          (label-position label-or-posn))
173         (index
174          label-or-posn))))