Commit | Line | Data |
---|---|---|
1f1d88f5 MW |
1 | ;;; -*-lisp-*- |
2 | ;;; | |
dea4d055 | 3 | ;;; Code generation protocol |
1f1d88f5 MW |
4 | ;;; |
5 | ;;; (c) 2009 Straylight/Edgeware | |
6 | ;;; | |
7 | ||
8 | ;;;----- Licensing notice --------------------------------------------------- | |
9 | ;;; | |
e0808c47 | 10 | ;;; This file is part of the Sensible Object Design, an object system for C. |
1f1d88f5 MW |
11 | ;;; |
12 | ;;; SOD is free software; you can redistribute it and/or modify | |
13 | ;;; it under the terms of the GNU General Public License as published by | |
14 | ;;; the Free Software Foundation; either version 2 of the License, or | |
15 | ;;; (at your option) any later version. | |
16 | ;;; | |
17 | ;;; SOD is distributed in the hope that it will be useful, | |
18 | ;;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
19 | ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
20 | ;;; GNU General Public License for more details. | |
21 | ;;; | |
22 | ;;; You should have received a copy of the GNU General Public License | |
23 | ;;; along with SOD; if not, write to the Free Software Foundation, | |
24 | ;;; Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. | |
25 | ||
26 | (cl:in-package #:sod) | |
27 | ||
28 | ;;;-------------------------------------------------------------------------- | |
29 | ;;; Temporary names. | |
30 | ||
dea4d055 MW |
31 | ;; Protocol. |
32 | ||
33 | (export 'format-temporary-name) | |
34 | (defgeneric format-temporary-name (var stream) | |
1f1d88f5 | 35 | (:documentation |
dea4d055 | 36 | "Write the name of a temporary variable VAR to STREAM.")) |
1f1d88f5 | 37 | |
dea4d055 MW |
38 | (export 'var-in-use-p) |
39 | (defgeneric var-in-use-p (var) | |
40 | (:documentation | |
3109662a | 41 | "Answer whether VAR is currently being used. See `with-temporary-var'.") |
dea4d055 MW |
42 | (:method (var) |
43 | "Non-temporary variables are always in use." | |
1d8cc67a | 44 | (declare (ignore var)) |
dea4d055 MW |
45 | t)) |
46 | (defgeneric (setf var-in-use-p) (value var) | |
47 | (:documentation | |
3109662a | 48 | "Record whether VAR is currently being used. See `with-temporary-var'.")) |
1f1d88f5 | 49 | |
dea4d055 | 50 | ;; Root class. |
1f1d88f5 | 51 | |
1344e1f9 | 52 | (export '(temporary-name temp-tag)) |
dea4d055 MW |
53 | (defclass temporary-name () |
54 | ((tag :initarg :tag :reader temp-tag)) | |
55 | (:documentation | |
56 | "Base class for temporary variable and argument names.")) | |
1f1d88f5 | 57 | |
dea4d055 | 58 | ;; Important temporary names. |
1f1d88f5 | 59 | |
dea4d055 | 60 | (export '(*sod-ap* *sod-master-ap*)) |
1f1d88f5 MW |
61 | (defparameter *sod-ap* |
62 | (make-instance 'temporary-name :tag "sod__ap")) | |
63 | (defparameter *sod-master-ap* | |
64 | (make-instance 'temporary-name :tag "sod__master_ap")) | |
2bbe0f1d MW |
65 | (defparameter *sod-tmp-ap* |
66 | (make-instance 'temporary-name :tag "sod__tmp_ap")) | |
1d8206e9 MW |
67 | (defparameter *sod-tmp-val* |
68 | (make-instance 'temporary-name :tag "sod__t")) | |
1f1d88f5 | 69 | |
944caf84 MW |
70 | (export '*null-pointer*) |
71 | (defparameter *null-pointer* "NULL") | |
72 | ||
1f1d88f5 MW |
73 | ;;;-------------------------------------------------------------------------- |
74 | ;;; Instructions. | |
75 | ||
dea4d055 MW |
76 | ;; Classes. |
77 | ||
78 | (export 'inst) | |
1f1d88f5 MW |
79 | (defclass inst () () |
80 | (:documentation | |
81 | "A base class for instructions. | |
82 | ||
83 | An `instruction' is anything which might be useful to string into a code | |
9ec578d9 MW |
84 | generator. Both statements and expressions can be represented by trees of |
85 | instructions. The `definst' macro is a convenient way of defining new | |
86 | instructions. | |
1f1d88f5 MW |
87 | |
88 | The only important protocol for instructions is output, which is achieved | |
3109662a | 89 | by calling `print-object' with `*print-escape*' nil. |
1f1d88f5 MW |
90 | |
91 | This doesn't really do very much, but it acts as a handy marker for | |
92 | instruction subclasses.")) | |
93 | ||
dea4d055 | 94 | (export 'inst-metric) |
1f1d88f5 MW |
95 | (defgeneric inst-metric (inst) |
96 | (:documentation | |
97 | "Returns a `metric' describing how complicated INST is. | |
98 | ||
3109662a MW |
99 | The default metric of an inst node is simply 1; `inst' subclasses |
100 | generated by `definst' (q.v.) have an automatically generated method which | |
101 | returns one plus the sum of the metrics of the node's children. | |
1f1d88f5 MW |
102 | |
103 | This isn't intended to be a particularly rigorous definition. Its purpose | |
104 | is to allow code generators to make decisions about inlining or calling | |
105 | code fairly simply.") | |
9ec578d9 MW |
106 | (:method ((inst t)) |
107 | (declare (ignore inst)) | |
108 | 1) | |
109 | (:method ((inst null)) | |
1d8cc67a | 110 | (declare (ignore inst)) |
9ec578d9 MW |
111 | 1) |
112 | (:method ((inst list)) | |
113 | (reduce #'+ inst :key #'inst-metric))) | |
1f1d88f5 | 114 | |
dea4d055 MW |
115 | ;; Instruction definition. |
116 | ||
117 | (export 'definst) | |
418752c5 | 118 | (defmacro definst (code (streamvar &key export) args &body body) |
1f1d88f5 MW |
119 | "Define an instruction type and describe how to output it. |
120 | ||
3109662a MW |
121 | An `inst' can represent any structured piece of output syntax: a |
122 | statement, expression or declaration, for example. This macro defines the | |
123 | following things: | |
1f1d88f5 | 124 | |
3109662a | 125 | * A class `CODE-inst' to represent the instruction. |
1f1d88f5 MW |
126 | |
127 | * Instance slots named after the ARGS, with matching keyword initargs, | |
3109662a | 128 | and `inst-ARG' readers. |
1f1d88f5 | 129 | |
167524b5 MW |
130 | * A constructor `make-CODE-inst' which accepts the ARGS (as an ordinary |
131 | BVL) as arguments and returns a fresh instance. | |
1f1d88f5 | 132 | |
3109662a | 133 | * A print method, which prints a diagnostic dump if `*print-escape*' is |
1f1d88f5 MW |
134 | set, or invokes the BODY (with STREAMVAR bound to the output stream) |
135 | otherwise. The BODY is expected to produce target code at this | |
418752c5 MW |
136 | point. |
137 | ||
138 | If EXPORT is non-nil, then export the `CODE-inst' and `make-CODE-inst' | |
139 | symbols." | |
1f1d88f5 | 140 | |
167524b5 MW |
141 | (let* ((inst-var (gensym "INST")) |
142 | (class-name (symbolicate code '-inst)) | |
143 | (constructor-name (symbolicate 'make- code '-inst)) | |
144 | (slots (mapcan (lambda (arg) | |
145 | (if (listp arg) (list (car arg)) | |
146 | (let ((name (symbol-name arg))) | |
147 | (if (and (plusp (length name)) | |
148 | (char/= (char name 0) #\&)) | |
149 | (list arg) | |
150 | nil)))) | |
151 | args)) | |
152 | (keys (mapcar (lambda (arg) (intern (symbol-name arg) :keyword)) | |
153 | slots))) | |
1f1d88f5 MW |
154 | `(progn |
155 | (defclass ,class-name (inst) | |
167524b5 MW |
156 | ,(mapcar (lambda (slot key) |
157 | `(,slot :initarg ,key | |
158 | :reader ,(symbolicate 'inst- slot))) | |
159 | slots keys)) | |
418752c5 | 160 | (defun ,constructor-name (,@args) |
167524b5 | 161 | (make-instance ',class-name ,@(mappend #'list keys slots))) |
1f1d88f5 | 162 | (defmethod inst-metric ((,inst-var ,class-name)) |
167524b5 MW |
163 | (with-slots (,@slots) ,inst-var |
164 | (+ 1 ,@(mapcar (lambda (slot) `(inst-metric ,slot)) slots)))) | |
1f1d88f5 | 165 | (defmethod print-object ((,inst-var ,class-name) ,streamvar) |
167524b5 | 166 | (with-slots (,@slots) ,inst-var |
1f1d88f5 MW |
167 | (if *print-escape* |
168 | (print-unreadable-object (,inst-var ,streamvar :type t) | |
169 | (format stream "~@<~@{~S ~@_~S~^ ~_~}~:>" | |
167524b5 | 170 | ,@(mappend #'list keys slots))) |
fc09e191 | 171 | (block ,code ,@body)))) |
34c51b1c | 172 | ,@(and export `((export '(,class-name ,constructor-name |
167524b5 MW |
173 | ,@(mapcar (lambda (slot) |
174 | (symbolicate 'inst- slot)) | |
175 | slots))))) | |
418752c5 | 176 | ',code))) |
1f1d88f5 | 177 | |
dea4d055 MW |
178 | ;; Formatting utilities. |
179 | ||
1f1d88f5 | 180 | (defun format-compound-statement* (stream child morep thunk) |
3109662a | 181 | "Underlying function for `format-compound-statement'." |
1f1d88f5 MW |
182 | (cond ((typep child 'block-inst) |
183 | (funcall thunk stream) | |
184 | (write-char #\space stream) | |
185 | (princ child stream) | |
186 | (when morep (write-char #\space stream))) | |
187 | (t | |
188 | (pprint-logical-block (stream nil) | |
189 | (funcall thunk stream) | |
190 | (write-char #\space stream) | |
191 | (pprint-indent :block 2 stream) | |
192 | (pprint-newline :linear stream) | |
193 | (princ child stream) | |
194 | (pprint-indent :block 0 stream) | |
195 | (case morep | |
196 | (:space | |
197 | (write-char #\space stream) | |
198 | (pprint-newline :linear stream)) | |
dea4d055 | 199 | ((t) |
1f1d88f5 MW |
200 | (pprint-newline :mandatory stream))))))) |
201 | ||
dea4d055 | 202 | (export 'format-compound-statement) |
1f1d88f5 MW |
203 | (defmacro format-compound-statement |
204 | ((stream child &optional morep) &body body) | |
205 | "Format a compound statement to STREAM. | |
206 | ||
207 | The introductory material is printed by BODY. The CHILD is formatted | |
3109662a | 208 | properly according to whether it's a `block-inst'. If MOREP is true, then |
1f1d88f5 MW |
209 | allow for more stuff following the child." |
210 | `(format-compound-statement* ,stream ,child ,morep | |
211 | (lambda (,stream) ,@body))) | |
212 | ||
77d83e01 MW |
213 | ;; Important instruction classes. |
214 | ||
215 | ;; HACK: Some of the slot names we'd like to use are external symbols in our | |
216 | ;; package or the `common-lisp' package. Use gensyms for these slot names to | |
217 | ;; prevent them from leaking. | |
218 | ||
167524b5 | 219 | (definst var (stream :export t) (name #1=#:type &optional init) |
77d83e01 MW |
220 | (pprint-c-type #1# stream name) |
221 | (when init | |
222 | (format stream " = ~A" init)) | |
223 | (write-char #\; stream)) | |
224 | ||
225 | (definst function (stream :export t) (name #1=#:type body) | |
226 | (pprint-logical-block (stream nil) | |
227 | (princ "static " stream) | |
228 | (pprint-c-type #1# stream name) | |
229 | (format stream "~:@_~A~:@_~:@_" body))) | |
230 | ||
231 | ;; Expression statements. | |
232 | (definst expr (stream :export t) (#1=#:expr) | |
233 | (format stream "~A;" #1#)) | |
234 | (definst set (stream :export t) (var #1=#:expr) | |
235 | (format stream "~@<~A = ~@_~2I~A;~:>" var #1#)) | |
236 | (definst update (stream :export t) (var op #1=#:expr) | |
237 | (format stream "~@<~A ~A= ~@_~2I~A;~:>" var op #1#)) | |
238 | ||
239 | ;; Special kinds of expressions. | |
167524b5 | 240 | (definst call (stream :export t) (#1=#:func &rest args) |
77d83e01 MW |
241 | (format stream "~A(~@<~{~A~^, ~_~}~:>)" #1# args)) |
242 | ||
243 | ;; Simple statements. | |
244 | (definst return (stream :export t) (#1=#:expr) | |
245 | (format stream "return~@[ (~A)~];" #1#)) | |
246 | (definst break (stream :export t) () | |
247 | (format stream "break;")) | |
248 | (definst continue (stream :export t) () | |
249 | (format stream "continue;")) | |
250 | ||
251 | ;; Compound statements. | |
252 | ||
253 | (definst block (stream :export t) (decls body) | |
254 | (format stream "{~:@_~@< ~2I~@[~{~A~:@_~}~:@_~]~{~A~^~:@_~}~:>~:@_}" | |
255 | decls body)) | |
256 | ||
167524b5 | 257 | (definst if (stream :export t) (#1=#:cond conseq &optional alt) |
d6bb2ccd MW |
258 | (let ((stmt "if")) |
259 | (loop (format-compound-statement (stream conseq (if alt t nil)) | |
260 | (format stream "~A (~A)" stmt #1#)) | |
261 | (typecase alt | |
262 | (null (return)) | |
263 | (if-inst (setf stmt "else if" | |
264 | #1# (inst-cond alt) | |
265 | conseq (inst-conseq alt) | |
266 | alt (inst-alt alt))) | |
267 | (t (format-compound-statement (stream alt) | |
268 | (format stream "else")) | |
269 | (return)))))) | |
77d83e01 MW |
270 | |
271 | (definst while (stream :export t) (#1=#:cond body) | |
272 | (format-compound-statement (stream body) | |
273 | (format stream "while (~A)" #1#))) | |
274 | ||
275 | (definst do-while (stream :export t) (body #1=#:cond) | |
276 | (format-compound-statement (stream body :space) | |
277 | (write-string "do" stream)) | |
278 | (format stream "while (~A);" #1#)) | |
279 | ||
1f1d88f5 | 280 | ;;;-------------------------------------------------------------------------- |
dea4d055 | 281 | ;;; Code generation. |
1f1d88f5 | 282 | |
dea4d055 | 283 | ;; Accessors. |
1f1d88f5 | 284 | |
dea4d055 MW |
285 | (export 'codegen-functions) |
286 | (defgeneric codegen-functions (codegen) | |
1f1d88f5 | 287 | (:documentation |
3109662a | 288 | "Return the list of `function-inst's of completed functions.")) |
1f1d88f5 | 289 | |
dea4d055 | 290 | (export 'ensure-var) |
1f1d88f5 MW |
291 | (defgeneric ensure-var (codegen name type &optional init) |
292 | (:documentation | |
293 | "Add a variable to CODEGEN's list. | |
294 | ||
3109662a | 295 | The variable is called NAME (which should be comparable using `equal' and |
1f1d88f5 | 296 | print to an identifier) and has the given TYPE. If INIT is present and |
3109662a | 297 | non-nil it is an expression `inst' used to provide the variable with an |
dea4d055 | 298 | initial value.")) |
1f1d88f5 | 299 | |
dea4d055 MW |
300 | (export '(emit-inst emit-insts)) |
301 | (defgeneric emit-inst (codegen inst) | |
302 | (:documentation | |
303 | "Add INST to the end of CODEGEN's list of instructions.")) | |
304 | (defgeneric emit-insts (codegen insts) | |
305 | (:documentation | |
306 | "Add a list of INSTS to the end of CODEGEN's list of instructions.") | |
307 | (:method (codegen insts) | |
308 | (dolist (inst insts) (emit-inst codegen inst)))) | |
1f1d88f5 | 309 | |
3f4ac959 MW |
310 | (export '(emit-decl emit-decls)) |
311 | (defgeneric emit-decl (codegen inst) | |
312 | (:documentation | |
313 | "Add INST to the end of CODEGEN's list of declarations.")) | |
314 | (defgeneric emit-decls (codegen insts) | |
315 | (:documentation | |
316 | "Add a list of INSTS to the end of CODEGEN's list of declarations.")) | |
317 | ||
dea4d055 | 318 | (export 'codegen-push) |
1f1d88f5 MW |
319 | (defgeneric codegen-push (codegen) |
320 | (:documentation | |
321 | "Pushes the current code generation state onto a stack. | |
322 | ||
dea4d055 | 323 | The state consists of the accumulated variables and instructions.")) |
1f1d88f5 | 324 | |
dea4d055 | 325 | (export 'codegen-pop) |
1f1d88f5 MW |
326 | (defgeneric codegen-pop (codegen) |
327 | (:documentation | |
328 | "Pops a saved state off of the CODEGEN's stack. | |
329 | ||
330 | Returns the newly accumulated variables and instructions as lists, as | |
dea4d055 | 331 | separate values.")) |
1f1d88f5 | 332 | |
dea4d055 | 333 | (export 'codegen-add-function) |
1f1d88f5 MW |
334 | (defgeneric codegen-add-function (codegen function) |
335 | (:documentation | |
336 | "Adds a function to CODEGEN's list. | |
337 | ||
338 | Actually, we're not picky: FUNCTION can be any kind of object that you're | |
3109662a | 339 | willing to find in the list returned by `codegen-functions'.")) |
dea4d055 MW |
340 | |
341 | (export 'temporary-var) | |
342 | (defgeneric temporary-var (codegen type) | |
343 | (:documentation | |
344 | "Return the name of a temporary variable. | |
345 | ||
346 | The temporary variable will have the given TYPE, and will be marked | |
347 | in-use. You should clear the in-use flag explicitly when you've finished | |
3109662a MW |
348 | with the variable -- or, better, use `with-temporary-var' to do the |
349 | cleanup automatically.")) | |
1f1d88f5 | 350 | |
dea4d055 | 351 | (export 'codegen-build-function) |
1f1d88f5 MW |
352 | (defun codegen-build-function (codegen name type vars insts) |
353 | "Build a function and add it to CODEGEN's list. | |
354 | ||
355 | Returns the function's name." | |
356 | (codegen-add-function codegen | |
357 | (make-function-inst name type | |
358 | (make-block-inst vars insts))) | |
359 | name) | |
360 | ||
dea4d055 MW |
361 | (export 'codegen-pop-block) |
362 | (defgeneric codegen-pop-block (codegen) | |
363 | (:documentation | |
3109662a | 364 | "Makes a block (`block-inst') out of the completed code in CODEGEN.") |
dea4d055 MW |
365 | (:method (codegen) |
366 | (multiple-value-bind (vars insts) (codegen-pop codegen) | |
367 | (make-block-inst vars insts)))) | |
368 | ||
369 | (export 'codegen-pop-function) | |
1f1d88f5 MW |
370 | (defgeneric codegen-pop-function (codegen name type) |
371 | (:documentation | |
372 | "Makes a function out of the completed code in CODEGEN. | |
373 | ||
374 | The NAME can be any object you like. The TYPE should be a function type | |
375 | object which includes argument names. The return value is the NAME.") | |
dea4d055 | 376 | (:method (codegen name type) |
1f1d88f5 MW |
377 | (multiple-value-bind (vars insts) (codegen-pop codegen) |
378 | (codegen-build-function codegen name type vars insts)))) | |
379 | ||
dea4d055 | 380 | (export 'with-temporary-var) |
1f1d88f5 MW |
381 | (defmacro with-temporary-var ((codegen var type) &body body) |
382 | "Evaluate BODY with VAR bound to a temporary variable name. | |
383 | ||
384 | During BODY, VAR will be marked in-use; when BODY ends, VAR will be marked | |
9ec578d9 | 385 | available for re-use." |
b8c698ee MW |
386 | (multiple-value-bind (doc decls body) (parse-body body :docp nil) |
387 | (declare (ignore doc)) | |
388 | `(let ((,var (temporary-var ,codegen ,type))) | |
389 | ,@decls | |
390 | (unwind-protect | |
391 | (progn ,@body) | |
392 | (setf (var-in-use-p ,var) nil))))) | |
1f1d88f5 MW |
393 | |
394 | ;;;-------------------------------------------------------------------------- | |
395 | ;;; Code generation idioms. | |
396 | ||
dea4d055 | 397 | (export 'deliver-expr) |
1f1d88f5 MW |
398 | (defun deliver-expr (codegen target expr) |
399 | "Emit code to deliver the value of EXPR to the TARGET. | |
400 | ||
401 | The TARGET may be one of the following. | |
402 | ||
3109662a | 403 | * `:void', indicating that the value is to be discarded. The expression |
1f1d88f5 MW |
404 | will still be evaluated. |
405 | ||
3109662a MW |
406 | * `:void-return', indicating that the value is to be discarded (as for |
407 | `:void') and furthermore a `return' from the current function should | |
408 | be forced after computing the value. | |
1f1d88f5 | 409 | |
3109662a MW |
410 | * `:return', indicating that the value is to be returned from the |
411 | current function. | |
1f1d88f5 MW |
412 | |
413 | * A variable name, indicating that the value is to be stored in the | |
414 | variable. | |
415 | ||
3109662a MW |
416 | In the cases of `:return', `:void' and `:void-return' targets, it is valid |
417 | for EXPR to be nil; this signifies that no computation needs to be | |
418 | performed. Variable-name targets require an expression." | |
1f1d88f5 MW |
419 | |
420 | (case target | |
421 | (:return (emit-inst codegen (make-return-inst expr))) | |
422 | (:void (when expr (emit-inst codegen (make-expr-inst expr)))) | |
423 | (:void-return (when expr (emit-inst codegen (make-expr-inst expr))) | |
424 | (emit-inst codegen (make-return-inst nil))) | |
425 | (t (emit-inst codegen (make-set-inst target expr))))) | |
426 | ||
dea4d055 | 427 | (export 'convert-stmts) |
1f1d88f5 | 428 | (defun convert-stmts (codegen target type func) |
3109662a | 429 | "Invoke FUNC to deliver a value to a non-`:return' target. |
1f1d88f5 | 430 | |
3109662a MW |
431 | FUNC is a function which accepts a single argument, a non-`:return' |
432 | target, and generates statements which deliver a value (see | |
433 | `deliver-expr') of the specified TYPE to this target. In general, the | |
434 | generated code will have the form | |
1f1d88f5 MW |
435 | |
436 | setup instructions... | |
3109662a | 437 | (deliver-expr CODEGEN TARGET (compute value...)) |
1f1d88f5 MW |
438 | cleanup instructions... |
439 | ||
440 | where the cleanup instructions are essential to the proper working of the | |
441 | generated program. | |
442 | ||
3109662a MW |
443 | The `convert-stmts' function will call FUNC to generate code, and arrange |
444 | that its value is correctly delivered to TARGET, regardless of what the | |
445 | TARGET is -- i.e., it lifts the restriction to non-`:return' targets. It | |
446 | does this by inventing a new temporary variable." | |
1f1d88f5 MW |
447 | |
448 | (case target | |
449 | (:return (with-temporary-var (codegen var type) | |
450 | (funcall func var) | |
451 | (deliver-expr codegen target var))) | |
452 | (:void-return (funcall func :void) | |
453 | (emit-inst codegen (make-return-inst nil))) | |
454 | (t (funcall func target)))) | |
455 | ||
357885be MW |
456 | (export 'deliver-call) |
457 | (defun deliver-call (codegen target func &rest args) | |
458 | "Emit a statement to call FUNC with ARGS and deliver the result to TARGET." | |
167524b5 | 459 | (deliver-expr codegen target (apply #'make-call-inst func args))) |
357885be | 460 | |
1f1d88f5 | 461 | ;;;----- That's all, folks -------------------------------------------------- |