0.7.12.42:
[sbcl.git] / src / compiler / ir1-translators.lisp
1 ;;;; the usual place for DEF-IR1-TRANSLATOR forms (and their
2 ;;;; close personal friends)
3
4 ;;;; This software is part of the SBCL system. See the README file for
5 ;;;; more information.
6 ;;;;
7 ;;;; This software is derived from the CMU CL system, which was
8 ;;;; written at Carnegie Mellon University and released into the
9 ;;;; public domain. The software is in the public domain and is
10 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
11 ;;;; files for more information.
12
13 (in-package "SB!C")
14 \f
15 ;;;; special forms for control
16
17 (def-ir1-translator progn ((&rest forms) start cont)
18   #!+sb-doc
19   "Progn Form*
20   Evaluates each Form in order, returning the values of the last form. With no
21   forms, returns NIL."
22   (ir1-convert-progn-body start cont forms))
23
24 (def-ir1-translator if ((test then &optional else) start cont)
25   #!+sb-doc
26   "If Predicate Then [Else]
27   If Predicate evaluates to non-null, evaluate Then and returns its values,
28   otherwise evaluate Else and return its values. Else defaults to NIL."
29   (let* ((pred (make-continuation))
30          (then-cont (make-continuation))
31          (then-block (continuation-starts-block then-cont))
32          (else-cont (make-continuation))
33          (else-block (continuation-starts-block else-cont))
34          (dummy-cont (make-continuation))
35          (node (make-if :test pred
36                         :consequent then-block
37                         :alternative else-block)))
38     ;; IR1-CONVERT-MAYBE-PREDICATE requires DEST to be CIF, so the
39     ;; order of the following two forms is important
40     (setf (continuation-dest pred) node)
41     (ir1-convert start pred test)
42     (link-node-to-previous-continuation node pred)
43     (use-continuation node dummy-cont)
44
45     (let ((start-block (continuation-block pred)))
46       (setf (block-last start-block) node)
47       (continuation-starts-block cont)
48
49       (link-blocks start-block then-block)
50       (link-blocks start-block else-block))
51
52     (ir1-convert then-cont cont then)
53     (ir1-convert else-cont cont else)))
54 \f
55 ;;;; BLOCK and TAGBODY
56
57 ;;;; We make an ENTRY node to mark the start and a :ENTRY cleanup to
58 ;;;; mark its extent. When doing GO or RETURN-FROM, we emit an EXIT
59 ;;;; node.
60
61 ;;; Make a :ENTRY cleanup and emit an ENTRY node, then convert the
62 ;;; body in the modified environment. We make CONT start a block now,
63 ;;; since if it was done later, the block would be in the wrong
64 ;;; environment.
65 (def-ir1-translator block ((name &rest forms) start cont)
66   #!+sb-doc
67   "Block Name Form*
68   Evaluate the Forms as a PROGN. Within the lexical scope of the body,
69   (RETURN-FROM Name Value-Form) can be used to exit the form, returning the
70   result of Value-Form."
71   (unless (symbolp name)
72     (compiler-error "The block name ~S is not a symbol." name))
73   (continuation-starts-block cont)
74   (let* ((dummy (make-continuation))
75          (entry (make-entry))
76          (cleanup (make-cleanup :kind :block
77                                 :mess-up entry)))
78     (push entry (lambda-entries (lexenv-lambda *lexenv*)))
79     (setf (entry-cleanup entry) cleanup)
80     (link-node-to-previous-continuation entry start)
81     (use-continuation entry dummy)
82
83     (let* ((env-entry (list entry cont))
84            (*lexenv* (make-lexenv :blocks (list (cons name env-entry))
85                                   :cleanup cleanup)))
86       (push env-entry (continuation-lexenv-uses cont))
87       (ir1-convert-progn-body dummy cont forms))))
88
89 (def-ir1-translator return-from ((name &optional value) start cont)
90   #!+sb-doc
91   "Return-From Block-Name Value-Form
92   Evaluate the Value-Form, returning its values from the lexically enclosing
93   BLOCK Block-Name. This is constrained to be used only within the dynamic
94   extent of the BLOCK."
95   ;; CMU CL comment:
96   ;;   We make CONT start a block just so that it will have a block
97   ;;   assigned. People assume that when they pass a continuation into
98   ;;   IR1-CONVERT as CONT, it will have a block when it is done.
99   ;; KLUDGE: Note that this block is basically fictitious. In the code
100   ;;   (BLOCK B (RETURN-FROM B) (SETQ X 3))
101   ;; it's the block which answers the question "which block is
102   ;; the (SETQ X 3) in?" when the right answer is that (SETQ X 3) is
103   ;; dead code and so doesn't really have a block at all. The existence
104   ;; of this block, and that way that it doesn't explicitly say
105   ;; "I'm actually nowhere at all" makes some logic (e.g.
106   ;; BLOCK-HOME-LAMBDA-OR-NULL) more obscure, and it might be better
107   ;; to get rid of it, perhaps using a special placeholder value
108   ;; to indicate the orphanedness of the code.
109   (continuation-starts-block cont)
110   (let* ((found (or (lexenv-find name blocks)
111                     (compiler-error "return for unknown block: ~S" name)))
112          (value-cont (make-continuation))
113          (entry (first found))
114          (exit (make-exit :entry entry
115                           :value value-cont)))
116     (push exit (entry-exits entry))
117     (setf (continuation-dest value-cont) exit)
118     (ir1-convert start value-cont value)
119     (link-node-to-previous-continuation exit value-cont)
120     (let ((home-lambda (continuation-home-lambda-or-null start)))
121       (when home-lambda
122         (push entry (lambda-calls-or-closes home-lambda))))
123     (use-continuation exit (second found))))
124
125 ;;; Return a list of the segments of a TAGBODY. Each segment looks
126 ;;; like (<tag> <form>* (go <next tag>)). That is, we break up the
127 ;;; tagbody into segments of non-tag statements, and explicitly
128 ;;; represent the drop-through with a GO. The first segment has a
129 ;;; dummy NIL tag, since it represents code before the first tag. The
130 ;;; last segment (which may also be the first segment) ends in NIL
131 ;;; rather than a GO.
132 (defun parse-tagbody (body)
133   (declare (list body))
134   (collect ((segments))
135     (let ((current (cons nil body)))
136       (loop
137         (let ((tag-pos (position-if (complement #'listp) current :start 1)))
138           (unless tag-pos
139             (segments `(,@current nil))
140             (return))
141           (let ((tag (elt current tag-pos)))
142             (when (assoc tag (segments))
143               (compiler-error
144                "The tag ~S appears more than once in the tagbody."
145                tag))
146             (unless (or (symbolp tag) (integerp tag))
147               (compiler-error "~S is not a legal tagbody statement." tag))
148             (segments `(,@(subseq current 0 tag-pos) (go ,tag))))
149           (setq current (nthcdr tag-pos current)))))
150     (segments)))
151
152 ;;; Set up the cleanup, emitting the entry node. Then make a block for
153 ;;; each tag, building up the tag list for LEXENV-TAGS as we go.
154 ;;; Finally, convert each segment with the precomputed Start and Cont
155 ;;; values.
156 (def-ir1-translator tagbody ((&rest statements) start cont)
157   #!+sb-doc
158   "Tagbody {Tag | Statement}*
159   Define tags for used with GO. The Statements are evaluated in order
160   (skipping Tags) and NIL is returned. If a statement contains a GO to a
161   defined Tag within the lexical scope of the form, then control is transferred
162   to the next statement following that tag. A Tag must an integer or a
163   symbol. A statement must be a list. Other objects are illegal within the
164   body."
165   (continuation-starts-block cont)
166   (let* ((dummy (make-continuation))
167          (entry (make-entry))
168          (segments (parse-tagbody statements))
169          (cleanup (make-cleanup :kind :tagbody
170                                 :mess-up entry)))
171     (push entry (lambda-entries (lexenv-lambda *lexenv*)))
172     (setf (entry-cleanup entry) cleanup)
173     (link-node-to-previous-continuation entry start)
174     (use-continuation entry dummy)
175
176     (collect ((tags)
177               (starts)
178               (conts))
179       (starts dummy)
180       (dolist (segment (rest segments))
181         (let* ((tag-cont (make-continuation))
182                (tag (list (car segment) entry tag-cont)))
183           (conts tag-cont)
184           (starts tag-cont)
185           (continuation-starts-block tag-cont)
186           (tags tag)
187           (push (cdr tag) (continuation-lexenv-uses tag-cont))))
188       (conts cont)
189
190       (let ((*lexenv* (make-lexenv :cleanup cleanup :tags (tags))))
191         (mapc (lambda (segment start cont)
192                 (ir1-convert-progn-body start cont (rest segment)))
193               segments (starts) (conts))))))
194
195 ;;; Emit an EXIT node without any value.
196 (def-ir1-translator go ((tag) start cont)
197   #!+sb-doc
198   "Go Tag
199   Transfer control to the named Tag in the lexically enclosing TAGBODY. This
200   is constrained to be used only within the dynamic extent of the TAGBODY."
201   (continuation-starts-block cont)
202   (let* ((found (or (lexenv-find tag tags :test #'eql)
203                     (compiler-error "attempt to GO to nonexistent tag: ~S"
204                                     tag)))
205          (entry (first found))
206          (exit (make-exit :entry entry)))
207     (push exit (entry-exits entry))
208     (link-node-to-previous-continuation exit start)
209     (let ((home-lambda (continuation-home-lambda-or-null start)))
210       (when home-lambda
211         (push entry (lambda-calls-or-closes home-lambda))))
212     (use-continuation exit (second found))))
213 \f
214 ;;;; translators for compiler-magic special forms
215
216 ;;; This handles EVAL-WHEN in non-top-level forms. (EVAL-WHENs in top
217 ;;; level forms are picked off and handled by PROCESS-TOPLEVEL-FORM,
218 ;;; so that they're never seen at this level.)
219 ;;;
220 ;;; ANSI "3.2.3.1 Processing of Top Level Forms" says that processing
221 ;;; of non-top-level EVAL-WHENs is very simple:
222 ;;;   EVAL-WHEN forms cause compile-time evaluation only at top level.
223 ;;;   Both :COMPILE-TOPLEVEL and :LOAD-TOPLEVEL situation specifications
224 ;;;   are ignored for non-top-level forms. For non-top-level forms, an
225 ;;;   eval-when specifying the :EXECUTE situation is treated as an
226 ;;;   implicit PROGN including the forms in the body of the EVAL-WHEN
227 ;;;   form; otherwise, the forms in the body are ignored.
228 (def-ir1-translator eval-when ((situations &rest forms) start cont)
229   #!+sb-doc
230   "EVAL-WHEN (Situation*) Form*
231   Evaluate the Forms in the specified Situations (any of :COMPILE-TOPLEVEL,
232   :LOAD-TOPLEVEL, or :EXECUTE, or (deprecated) COMPILE, LOAD, or EVAL)."
233   (multiple-value-bind (ct lt e) (parse-eval-when-situations situations)
234     (declare (ignore ct lt))
235     (ir1-convert-progn-body start cont (and e forms)))
236   (values))
237
238 ;;; common logic for MACROLET and SYMBOL-MACROLET
239 ;;;
240 ;;; Call DEFINITIONIZE-FUN on each element of DEFINITIONS to find its
241 ;;; in-lexenv representation, stuff the results into *LEXENV*, and
242 ;;; call FUN (with no arguments).
243 (defun %funcall-in-foomacrolet-lexenv (definitionize-fun
244                                        definitionize-keyword
245                                        definitions
246                                        fun)
247   (declare (type function definitionize-fun fun))
248   (declare (type (member :vars :funs) definitionize-keyword))
249   (declare (type list definitions))
250   (unless (= (length definitions)
251              (length (remove-duplicates definitions :key #'first)))
252     (compiler-style-warn "duplicate definitions in ~S" definitions))
253   (let* ((processed-definitions (mapcar definitionize-fun definitions))
254          (*lexenv* (make-lexenv definitionize-keyword processed-definitions)))
255     (funcall fun definitionize-keyword processed-definitions)))
256
257 ;;; Tweak LEXENV to include the DEFINITIONS from a MACROLET, then
258 ;;; call FUN (with no arguments).
259 ;;;
260 ;;; This is split off from the IR1 convert method so that it can be
261 ;;; shared by the special-case top level MACROLET processing code, and
262 ;;; further split so that the special-case MACROLET processing code in
263 ;;; EVAL can likewise make use of it.
264 (defmacro macrolet-definitionize-fun (context lexenv)
265   (flet ((make-error-form (control &rest args)
266            (ecase context
267              (:compile `(compiler-error ,control ,@args))
268              (:eval `(error 'simple-program-error
269                       :format-control ,control
270                       :format-arguments (list ,@args))))))
271     `(lambda (definition)
272       (unless (list-of-length-at-least-p definition 2)
273         ,(make-error-form "The list ~S is too short to be a legal local macro definition." 'definition))
274       (destructuring-bind (name arglist &body body) definition
275         (unless (symbolp name)
276           ,(make-error-form "The local macro name ~S is not a symbol." 'name))
277         (unless (listp arglist)
278           ,(make-error-form "The local macro argument list ~S is not a list." 'arglist))
279         (let ((whole (gensym "WHOLE"))
280               (environment (gensym "ENVIRONMENT")))
281           (multiple-value-bind (body local-decls)
282               (parse-defmacro arglist whole body name 'macrolet
283                               :environment environment)
284             `(,name macro .
285               ,(compile-in-lexenv
286                 nil
287                 `(lambda (,whole ,environment)
288                   ,@local-decls
289                   (block ,name ,body))
290                 ,lexenv))))))))
291
292 (defun funcall-in-macrolet-lexenv (definitions fun)
293   (%funcall-in-foomacrolet-lexenv
294    (macrolet-definitionize-fun :compile (make-restricted-lexenv *lexenv*))
295    :funs
296    definitions
297    fun))
298
299 (def-ir1-translator macrolet ((definitions &rest body) start cont)
300   #!+sb-doc
301   "MACROLET ({(Name Lambda-List Form*)}*) Body-Form*
302   Evaluate the Body-Forms in an environment with the specified local macros
303   defined. Name is the local macro name, Lambda-List is the DEFMACRO style
304   destructuring lambda list, and the Forms evaluate to the expansion.."
305   (funcall-in-macrolet-lexenv
306    definitions
307    (lambda (&key funs)
308      (declare (ignore funs))
309      (ir1-translate-locally body start cont))))
310
311 (defmacro symbol-macrolet-definitionize-fun (context)
312   (flet ((make-error-form (control &rest args)
313            (ecase context
314              (:compile `(compiler-error ,control ,@args))
315              (:eval `(error 'simple-program-error
316                       :format-control ,control
317                       :format-arguments (list ,@args))))))
318     `(lambda (definition)
319       (unless (proper-list-of-length-p definition 2)
320        ,(make-error-form "malformed symbol/expansion pair: ~S" 'definition))
321      (destructuring-bind (name expansion) definition
322        (unless (symbolp name)
323          ,(make-error-form
324            "The local symbol macro name ~S is not a symbol."
325            'name))
326        (let ((kind (info :variable :kind name)))
327          (when (member kind '(:special :constant))
328            ,(make-error-form
329              "Attempt to bind a ~(~A~) variable with SYMBOL-MACROLET: ~S"
330              'kind 'name)))
331        `(,name . (MACRO . ,expansion))))))1
332
333 (defun funcall-in-symbol-macrolet-lexenv (definitions fun)
334   (%funcall-in-foomacrolet-lexenv
335    (symbol-macrolet-definitionize-fun :compile)
336    :vars
337    definitions
338    fun))
339
340 (def-ir1-translator symbol-macrolet ((macrobindings &body body) start cont)
341   #!+sb-doc
342   "SYMBOL-MACROLET ({(Name Expansion)}*) Decl* Form*
343   Define the Names as symbol macros with the given Expansions. Within the
344   body, references to a Name will effectively be replaced with the Expansion."
345   (funcall-in-symbol-macrolet-lexenv
346    macrobindings
347    (lambda (&key vars)
348      (ir1-translate-locally body start cont :vars vars))))
349
350 ;;; not really a special form, but..
351 (def-ir1-translator declare ((&rest stuff) start cont)
352   (declare (ignore stuff))
353   ;; We ignore START and CONT too, but we can't use DECLARE IGNORE to
354   ;; tell the compiler about it here, because the DEF-IR1-TRANSLATOR
355   ;; macro would put the DECLARE in the wrong place, so..
356   start cont
357   (compiler-error "misplaced declaration"))
358 \f
359 ;;;; %PRIMITIVE
360 ;;;;
361 ;;;; Uses of %PRIMITIVE are either expanded into Lisp code or turned
362 ;;;; into a funny function.
363
364 ;;; Carefully evaluate a list of forms, returning a list of the results.
365 (defun eval-info-args (args)
366   (declare (list args))
367   (handler-case (mapcar #'eval args)
368     (error (condition)
369       (compiler-error "Lisp error during evaluation of info args:~%~A"
370                       condition))))
371
372 ;;; Convert to the %%PRIMITIVE funny function. The first argument is
373 ;;; the template, the second is a list of the results of any
374 ;;; codegen-info args, and the remaining arguments are the runtime
375 ;;; arguments.
376 ;;;
377 ;;; We do various error checking now so that we don't bomb out with
378 ;;; a fatal error during IR2 conversion.
379 ;;;
380 ;;; KLUDGE: It's confusing having multiple names floating around for
381 ;;; nearly the same concept: PRIMITIVE, TEMPLATE, VOP. Now that CMU
382 ;;; CL's *PRIMITIVE-TRANSLATORS* stuff is gone, we could call
383 ;;; primitives VOPs, rename TEMPLATE to VOP-TEMPLATE, rename
384 ;;; BACKEND-TEMPLATE-NAMES to BACKEND-VOPS, and rename %PRIMITIVE to
385 ;;; VOP or %VOP.. -- WHN 2001-06-11
386 ;;; FIXME: Look at doing this ^, it doesn't look too hard actually.
387 (def-ir1-translator %primitive ((name &rest args) start cont)
388   (declare (type symbol name))
389   (let* ((template (or (gethash name *backend-template-names*)
390                        (bug "undefined primitive ~A" name)))
391          (required (length (template-arg-types template)))
392          (info (template-info-arg-count template))
393          (min (+ required info))
394          (nargs (length args)))
395     (if (template-more-args-type template)
396         (when (< nargs min)
397           (bug "Primitive ~A was called with ~R argument~:P, ~
398                 but wants at least ~R."
399                name
400                nargs
401                min))
402         (unless (= nargs min)
403           (bug "Primitive ~A was called with ~R argument~:P, ~
404                 but wants exactly ~R."
405                name
406                nargs
407                min)))
408
409     (when (eq (template-result-types template) :conditional)
410       (bug "%PRIMITIVE was used with a conditional template."))
411
412     (when (template-more-results-type template)
413       (bug "%PRIMITIVE was used with an unknown values template."))
414
415     (ir1-convert start
416                  cont
417                  `(%%primitive ',template
418                                ',(eval-info-args
419                                   (subseq args required min))
420                                ,@(subseq args 0 required)
421                                ,@(subseq args min)))))
422 \f
423 ;;;; QUOTE
424
425 (def-ir1-translator quote ((thing) start cont)
426   #!+sb-doc
427   "QUOTE Value
428   Return Value without evaluating it."
429   (reference-constant start cont thing))
430 \f
431 ;;;; FUNCTION and NAMED-LAMBDA
432
433 (def-ir1-translator function ((thing) start cont)
434   #!+sb-doc
435   "FUNCTION Name
436   Return the lexically apparent definition of the function Name. Name may also
437   be a lambda expression."
438   (if (consp thing)
439       (case (car thing)
440         ((lambda named-lambda instance-lambda lambda-with-lexenv)
441          (reference-leaf start
442                          cont
443                          (ir1-convert-lambdalike
444                           thing
445                           :debug-name (debug-namify "#'~S" thing)
446                           :allow-debug-catch-tag t)))
447         ((setf sb!pcl::class-predicate sb!pcl::slot-accessor)
448          (let ((var (find-lexically-apparent-fun
449                      thing "as the argument to FUNCTION")))
450            (reference-leaf start cont var)))
451         (t
452          (compiler-error "~S is not a legal function name." thing)))
453       (let ((var (find-lexically-apparent-fun
454                   thing "as the argument to FUNCTION")))
455         (reference-leaf start cont var))))
456 \f
457 ;;;; FUNCALL
458
459 ;;; FUNCALL is implemented on %FUNCALL, which can only call functions
460 ;;; (not symbols). %FUNCALL is used directly in some places where the
461 ;;; call should always be open-coded even if FUNCALL is :NOTINLINE.
462 (deftransform funcall ((function &rest args) * *)
463   (let ((arg-names (make-gensym-list (length args))))
464     `(lambda (function ,@arg-names)
465        (%funcall ,(if (csubtypep (continuation-type function)
466                                  (specifier-type 'function))
467                       'function
468                       '(%coerce-callable-to-fun function))
469                  ,@arg-names))))
470
471 (def-ir1-translator %funcall ((function &rest args) start cont)
472   (let ((fun-cont (make-continuation)))
473     (ir1-convert start fun-cont function)
474     (assert-continuation-type fun-cont (specifier-type 'function)
475                               (lexenv-policy *lexenv*))
476     (ir1-convert-combination-args fun-cont cont args)))
477
478 ;;; This source transform exists to reduce the amount of work for the
479 ;;; compiler. If the called function is a FUNCTION form, then convert
480 ;;; directly to %FUNCALL, instead of waiting around for type
481 ;;; inference.
482 (define-source-transform funcall (function &rest args)
483   (if (and (consp function) (eq (car function) 'function))
484       `(%funcall ,function ,@args)
485       (values nil t)))
486
487 (deftransform %coerce-callable-to-fun ((thing) (function) *
488                                        :important t)
489   "optimize away possible call to FDEFINITION at runtime"
490   'thing)
491 \f
492 ;;;; LET and LET*
493 ;;;;
494 ;;;; (LET and LET* can't be implemented as macros due to the fact that
495 ;;;; any pervasive declarations also affect the evaluation of the
496 ;;;; arguments.)
497
498 ;;; Given a list of binding specifiers in the style of LET, return:
499 ;;;  1. The list of var structures for the variables bound.
500 ;;;  2. The initial value form for each variable.
501 ;;;
502 ;;; The variable names are checked for legality and globally special
503 ;;; variables are marked as such. Context is the name of the form, for
504 ;;; error reporting purposes.
505 (declaim (ftype (function (list symbol) (values list list))
506                 extract-let-vars))
507 (defun extract-let-vars (bindings context)
508   (collect ((vars)
509             (vals)
510             (names))
511     (flet ((get-var (name)
512              (varify-lambda-arg name
513                                 (if (eq context 'let*)
514                                     nil
515                                     (names)))))
516       (dolist (spec bindings)
517         (cond ((atom spec)
518                (let ((var (get-var spec)))
519                  (vars var)
520                  (names spec)
521                  (vals nil)))
522               (t
523                (unless (proper-list-of-length-p spec 1 2)
524                  (compiler-error "The ~S binding spec ~S is malformed."
525                                  context
526                                  spec))
527                (let* ((name (first spec))
528                       (var (get-var name)))
529                  (vars var)
530                  (names name)
531                  (vals (second spec)))))))
532
533     (values (vars) (vals))))
534
535 (def-ir1-translator let ((bindings &body body)
536                          start cont)
537   #!+sb-doc
538   "LET ({(Var [Value]) | Var}*) Declaration* Form*
539   During evaluation of the Forms, bind the Vars to the result of evaluating the
540   Value forms. The variables are bound in parallel after all of the Values are
541   evaluated."
542   (multiple-value-bind (forms decls) (parse-body body nil)
543     (multiple-value-bind (vars values) (extract-let-vars bindings 'let)
544       (let ((fun-cont (make-continuation)))
545         (let* ((*lexenv* (process-decls decls vars nil cont))
546                (fun (ir1-convert-lambda-body
547                      forms vars
548                      :debug-name (debug-namify "LET ~S" bindings))))
549           (reference-leaf start fun-cont fun))
550         (ir1-convert-combination-args fun-cont cont values)))))
551
552 (def-ir1-translator let* ((bindings &body body)
553                           start cont)
554   #!+sb-doc
555   "LET* ({(Var [Value]) | Var}*) Declaration* Form*
556   Similar to LET, but the variables are bound sequentially, allowing each Value
557   form to reference any of the previous Vars."
558   (multiple-value-bind (forms decls) (parse-body body nil)
559     (multiple-value-bind (vars values) (extract-let-vars bindings 'let*)
560       (let ((*lexenv* (process-decls decls vars nil cont)))
561         (ir1-convert-aux-bindings start cont forms vars values)))))
562
563 ;;; logic shared between IR1 translators for LOCALLY, MACROLET,
564 ;;; and SYMBOL-MACROLET
565 ;;;
566 ;;; Note that all these things need to preserve toplevel-formness,
567 ;;; but we don't need to worry about that within an IR1 translator,
568 ;;; since toplevel-formness is picked off by PROCESS-TOPLEVEL-FOO
569 ;;; forms before we hit the IR1 transform level.
570 (defun ir1-translate-locally (body start cont &key vars funs)
571   (declare (type list body) (type continuation start cont))
572   (multiple-value-bind (forms decls) (parse-body body nil)
573     (let ((*lexenv* (process-decls decls vars funs cont)))
574       (ir1-convert-aux-bindings start cont forms nil nil))))
575
576 (def-ir1-translator locally ((&body body) start cont)
577   #!+sb-doc
578   "LOCALLY Declaration* Form*
579   Sequentially evaluate the Forms in a lexical environment where the
580   the Declarations have effect. If LOCALLY is a top level form, then
581   the Forms are also processed as top level forms."
582   (ir1-translate-locally body start cont))
583 \f
584 ;;;; FLET and LABELS
585
586 ;;; Given a list of local function specifications in the style of
587 ;;; FLET, return lists of the function names and of the lambdas which
588 ;;; are their definitions.
589 ;;;
590 ;;; The function names are checked for legality. CONTEXT is the name
591 ;;; of the form, for error reporting.
592 (declaim (ftype (function (list symbol) (values list list)) extract-flet-vars))
593 (defun extract-flet-vars (definitions context)
594   (collect ((names)
595             (defs))
596     (dolist (def definitions)
597       (when (or (atom def) (< (length def) 2))
598         (compiler-error "The ~S definition spec ~S is malformed." context def))
599
600       (let ((name (first def)))
601         (check-fun-name name)
602         (names name)
603         (multiple-value-bind (forms decls) (parse-body (cddr def))
604           (defs `(lambda ,(second def)
605                    ,@decls
606                    (block ,(fun-name-block-name name)
607                      . ,forms))))))
608     (values (names) (defs))))
609
610 (def-ir1-translator flet ((definitions &body body)
611                           start cont)
612   #!+sb-doc
613   "FLET ({(Name Lambda-List Declaration* Form*)}*) Declaration* Body-Form*
614   Evaluate the Body-Forms with some local function definitions. The bindings
615   do not enclose the definitions; any use of Name in the Forms will refer to
616   the lexically apparent function definition in the enclosing environment."
617   (multiple-value-bind (forms decls) (parse-body body nil)
618     (multiple-value-bind (names defs)
619         (extract-flet-vars definitions 'flet)
620       (let* ((fvars (mapcar (lambda (n d)
621                               (ir1-convert-lambda d
622                                                   :source-name n
623                                                   :debug-name (debug-namify
624                                                                "FLET ~S" n)
625                                                   :allow-debug-catch-tag t))
626                             names defs))
627              (*lexenv* (make-lexenv
628                         :default (process-decls decls nil fvars cont)
629                         :funs (pairlis names fvars))))
630         (ir1-convert-progn-body start cont forms)))))
631
632 (def-ir1-translator labels ((definitions &body body) start cont)
633   #!+sb-doc
634   "LABELS ({(Name Lambda-List Declaration* Form*)}*) Declaration* Body-Form*
635   Evaluate the Body-Forms with some local function definitions. The bindings
636   enclose the new definitions, so the defined functions can call themselves or
637   each other."
638   (multiple-value-bind (forms decls) (parse-body body nil)
639     (multiple-value-bind (names defs)
640         (extract-flet-vars definitions 'labels)
641       (let* (;; dummy LABELS functions, to be used as placeholders
642              ;; during construction of real LABELS functions
643              (placeholder-funs (mapcar (lambda (name)
644                                          (make-functional
645                                           :%source-name name
646                                           :%debug-name (debug-namify
647                                                         "LABELS placeholder ~S"
648                                                         name)))
649                                        names))
650              ;; (like PAIRLIS but guaranteed to preserve ordering:)
651              (placeholder-fenv (mapcar #'cons names placeholder-funs))
652              ;; the real LABELS functions, compiled in a LEXENV which
653              ;; includes the dummy LABELS functions
654              (real-funs
655               (let ((*lexenv* (make-lexenv :funs placeholder-fenv)))
656                 (mapcar (lambda (name def)
657                           (ir1-convert-lambda def
658                                               :source-name name
659                                               :debug-name (debug-namify
660                                                            "LABELS ~S" name)
661                                               :allow-debug-catch-tag t))
662                         names defs))))
663
664         ;; Modify all the references to the dummy function leaves so
665         ;; that they point to the real function leaves.
666         (loop for real-fun in real-funs and
667               placeholder-cons in placeholder-fenv do
668               (substitute-leaf real-fun (cdr placeholder-cons))
669               (setf (cdr placeholder-cons) real-fun))
670
671         ;; Voila.
672         (let ((*lexenv* (make-lexenv
673                          :default (process-decls decls nil real-funs cont)
674                          ;; Use a proper FENV here (not the
675                          ;; placeholder used earlier) so that if the
676                          ;; lexical environment is used for inline
677                          ;; expansion we'll get the right functions.
678                          :funs (pairlis names real-funs))))
679           (ir1-convert-progn-body start cont forms))))))
680 \f
681 ;;;; the THE special operator, and friends
682
683 ;;; Do stuff to recognize a THE or VALUES declaration. CONT is the
684 ;;; continuation that the assertion applies to, TYPE is the type
685 ;;; specifier and LEXENV is the current lexical environment. NAME is
686 ;;; the name of the declaration we are doing, for use in error
687 ;;; messages.
688 ;;;
689 ;;; This is somewhat involved, since a type assertion may only be made
690 ;;; on a continuation, not on a node. We can't just set the
691 ;;; continuation asserted type and let it go at that, since there may
692 ;;; be parallel THE's for the same continuation, i.e.
693 ;;;     (if ...
694 ;;;      (the foo ...)
695 ;;;      (the bar ...))
696 ;;;
697 ;;; In this case, our representation can do no better than the union
698 ;;; of these assertions. And if there is a branch with no assertion,
699 ;;; we have nothing at all. We really need to recognize scoping, since
700 ;;; we need to be able to discern between parallel assertions (which
701 ;;; we union) and nested ones (which we intersect).
702 ;;;
703 ;;; We represent the scoping by throwing our innermost (intersected)
704 ;;; assertion on CONT into the TYPE-RESTRICTIONS. As we go down, we
705 ;;; intersect our assertions together. If CONT has no uses yet, we
706 ;;; have not yet bottomed out on the first COND branch; in this case
707 ;;; we optimistically assume that this type will be the one we end up
708 ;;; with, and set the ASSERTED-TYPE to it. We can never get better
709 ;;; than the type that we have the first time we bottom out. Later
710 ;;; THE's (or the absence thereof) can only weaken this result.
711 ;;;
712 ;;; We make this work by getting USE-CONTINUATION to do the unioning
713 ;;; across COND branches. We can't do it here, since we don't know how
714 ;;; many branches there are going to be.
715 (defun ir1ize-the-or-values (type cont lexenv place)
716   (declare (type continuation cont) (type lexenv lexenv))
717   (let* ((atype (if (typep type 'ctype) type (compiler-values-specifier-type type)))
718          (old-atype (or (lexenv-find cont type-restrictions)
719                         *wild-type*))
720          (old-ctype (or (lexenv-find cont weakend-type-restrictions)
721                         *wild-type*))
722          (intersects (values-types-equal-or-intersect old-atype atype))
723          (new-atype (values-type-intersection old-atype atype))
724          (new-ctype (values-type-intersection
725                      old-ctype (maybe-weaken-check atype (lexenv-policy lexenv)))))
726     (when (null (find-uses cont))
727       (setf (continuation-asserted-type cont) new-atype)
728       (setf (continuation-type-to-check cont) new-ctype))
729     (when (and (not intersects)
730                ;; FIXME: Is it really right to look at *LEXENV* here,
731                ;; instead of looking at the LEXENV argument? Why?
732                (not (policy *lexenv*
733                             (= inhibit-warnings 3)))) ;FIXME: really OK to suppress?
734       (compiler-warn
735        "The type ~S ~A conflicts with an enclosing assertion:~%   ~S"
736        (type-specifier atype)
737        place
738        (type-specifier old-atype)))
739     (make-lexenv :type-restrictions `((,cont . ,new-atype))
740                  :weakend-type-restrictions `((,cont . ,new-ctype))
741                  :default lexenv)))
742
743 ;;; Assert that FORM evaluates to the specified type (which may be a
744 ;;; VALUES type).
745 ;;;
746 ;;; FIXME: In a version of CMU CL that I used at Cadabra ca. 20000101,
747 ;;; this didn't seem to expand into an assertion, at least for ALIEN
748 ;;; values. Check that SBCL doesn't have this problem.
749 (def-ir1-translator the ((type value) start cont)
750   (with-continuation-type-assertion (cont (compiler-values-specifier-type type)
751                                           "in THE declaration")
752     (ir1-convert start cont value)))
753
754 ;;; This is like the THE special form, except that it believes
755 ;;; whatever you tell it. It will never generate a type check, but
756 ;;; will cause a warning if the compiler can prove the assertion is
757 ;;; wrong.
758 ;;;
759 ;;; Since the CONTINUATION-DERIVED-TYPE is computed as the union of
760 ;;; its uses's types, setting it won't work. Instead we must intersect
761 ;;; the type with the uses's DERIVED-TYPE.
762 (def-ir1-translator truly-the ((type value) start cont)
763   #!+sb-doc
764   (declare (inline member))
765   (let ((type (compiler-values-specifier-type type))
766         (old (find-uses cont)))
767     (ir1-convert start cont value)
768     (do-uses (use cont)
769       (unless (member use old :test #'eq)
770         (derive-node-type use type)))))
771 \f
772 ;;;; SETQ
773
774 ;;; If there is a definition in LEXENV-VARS, just set that, otherwise
775 ;;; look at the global information. If the name is for a constant,
776 ;;; then error out.
777 (def-ir1-translator setq ((&whole source &rest things) start cont)
778   (let ((len (length things)))
779     (when (oddp len)
780       (compiler-error "odd number of args to SETQ: ~S" source))
781     (if (= len 2)
782         (let* ((name (first things))
783                (leaf (or (lexenv-find name vars)
784                          (find-free-var name))))
785           (etypecase leaf
786             (leaf
787              (when (constant-p leaf)
788                (compiler-error "~S is a constant and thus can't be set." name))
789              (when (lambda-var-p leaf)
790                (let ((home-lambda (continuation-home-lambda-or-null start)))
791                  (when home-lambda
792                    (pushnew leaf (lambda-calls-or-closes home-lambda))))
793                (when (lambda-var-ignorep leaf)
794                  ;; ANSI's definition of "Declaration IGNORE, IGNORABLE"
795                  ;; requires that this be a STYLE-WARNING, not a full warning.
796                  (compiler-style-warn
797                   "~S is being set even though it was declared to be ignored."
798                   name)))
799              (setq-var start cont leaf (second things)))
800             (cons
801              (aver (eq (car leaf) 'MACRO))
802              (ir1-convert start cont `(setf ,(cdr leaf) ,(second things))))
803             (heap-alien-info
804              (ir1-convert start cont
805                           `(%set-heap-alien ',leaf ,(second things))))))
806         (collect ((sets))
807           (do ((thing things (cddr thing)))
808               ((endp thing)
809                (ir1-convert-progn-body start cont (sets)))
810             (sets `(setq ,(first thing) ,(second thing))))))))
811
812 ;;; This is kind of like REFERENCE-LEAF, but we generate a SET node.
813 ;;; This should only need to be called in SETQ.
814 (defun setq-var (start cont var value)
815   (declare (type continuation start cont) (type basic-var var))
816   (let ((dest (make-continuation)))
817     (ir1-convert start dest value)
818     (assert-continuation-type dest
819                               (or (lexenv-find var type-restrictions)
820                                   (leaf-type var))
821                               (lexenv-policy *lexenv*))
822     (let ((res (make-set :var var :value dest)))
823       (setf (continuation-dest dest) res)
824       (setf (leaf-ever-used var) t)
825       (push res (basic-var-sets var))
826       (link-node-to-previous-continuation res dest)
827       (use-continuation res cont))))
828 \f
829 ;;;; CATCH, THROW and UNWIND-PROTECT
830
831 ;;; We turn THROW into a MULTIPLE-VALUE-CALL of a magical function,
832 ;;; since as as far as IR1 is concerned, it has no interesting
833 ;;; properties other than receiving multiple-values.
834 (def-ir1-translator throw ((tag result) start cont)
835   #!+sb-doc
836   "Throw Tag Form
837   Do a non-local exit, return the values of Form from the CATCH whose tag
838   evaluates to the same thing as Tag."
839   (ir1-convert start cont
840                `(multiple-value-call #'%throw ,tag ,result)))
841
842 ;;; This is a special special form used to instantiate a cleanup as
843 ;;; the current cleanup within the body. KIND is the kind of cleanup
844 ;;; to make, and MESS-UP is a form that does the mess-up action. We
845 ;;; make the MESS-UP be the USE of the MESS-UP form's continuation,
846 ;;; and introduce the cleanup into the lexical environment. We
847 ;;; back-patch the ENTRY-CLEANUP for the current cleanup to be the new
848 ;;; cleanup, since this inner cleanup is the interesting one.
849 (def-ir1-translator %within-cleanup ((kind mess-up &body body) start cont)
850   (let ((dummy (make-continuation))
851         (dummy2 (make-continuation)))
852     (ir1-convert start dummy mess-up)
853     (let* ((mess-node (continuation-use dummy))
854            (cleanup (make-cleanup :kind kind
855                                   :mess-up mess-node))
856            (old-cup (lexenv-cleanup *lexenv*))
857            (*lexenv* (make-lexenv :cleanup cleanup)))
858       (setf (entry-cleanup (cleanup-mess-up old-cup)) cleanup)
859       (ir1-convert dummy dummy2 '(%cleanup-point))
860       (ir1-convert-progn-body dummy2 cont body))))
861
862 ;;; This is a special special form that makes an "escape function"
863 ;;; which returns unknown values from named block. We convert the
864 ;;; function, set its kind to :ESCAPE, and then reference it. The
865 ;;; :ESCAPE kind indicates that this function's purpose is to
866 ;;; represent a non-local control transfer, and that it might not
867 ;;; actually have to be compiled.
868 ;;;
869 ;;; Note that environment analysis replaces references to escape
870 ;;; functions with references to the corresponding NLX-INFO structure.
871 (def-ir1-translator %escape-fun ((tag) start cont)
872   (let ((fun (ir1-convert-lambda
873               `(lambda ()
874                  (return-from ,tag (%unknown-values)))
875               :debug-name (debug-namify "escape function for ~S" tag))))
876     (setf (functional-kind fun) :escape)
877     (reference-leaf start cont fun)))
878
879 ;;; Yet another special special form. This one looks up a local
880 ;;; function and smashes it to a :CLEANUP function, as well as
881 ;;; referencing it.
882 (def-ir1-translator %cleanup-fun ((name) start cont)
883   (let ((fun (lexenv-find name funs)))
884     (aver (lambda-p fun))
885     (setf (functional-kind fun) :cleanup)
886     (reference-leaf start cont fun)))
887
888 ;;; We represent the possibility of the control transfer by making an
889 ;;; "escape function" that does a lexical exit, and instantiate the
890 ;;; cleanup using %WITHIN-CLEANUP.
891 (def-ir1-translator catch ((tag &body body) start cont)
892   #!+sb-doc
893   "Catch Tag Form*
894   Evaluates Tag and instantiates it as a catcher while the body forms are
895   evaluated in an implicit PROGN. If a THROW is done to Tag within the dynamic
896   scope of the body, then control will be transferred to the end of the body
897   and the thrown values will be returned."
898   (ir1-convert
899    start cont
900    (let ((exit-block (gensym "EXIT-BLOCK-")))
901      `(block ,exit-block
902         (%within-cleanup
903             :catch
904             (%catch (%escape-fun ,exit-block) ,tag)
905           ,@body)))))
906
907 ;;; UNWIND-PROTECT is similar to CATCH, but hairier. We make the
908 ;;; cleanup forms into a local function so that they can be referenced
909 ;;; both in the case where we are unwound and in any local exits. We
910 ;;; use %CLEANUP-FUN on this to indicate that reference by
911 ;;; %UNWIND-PROTECT isn't "real", and thus doesn't cause creation of
912 ;;; an XEP.
913 (def-ir1-translator unwind-protect ((protected &body cleanup) start cont)
914   #!+sb-doc
915   "Unwind-Protect Protected Cleanup*
916   Evaluate the form Protected, returning its values. The cleanup forms are
917   evaluated whenever the dynamic scope of the Protected form is exited (either
918   due to normal completion or a non-local exit such as THROW)."
919   (ir1-convert
920    start cont
921    (let ((cleanup-fun (gensym "CLEANUP-FUN-"))
922          (drop-thru-tag (gensym "DROP-THRU-TAG-"))
923          (exit-tag (gensym "EXIT-TAG-"))
924          (next (gensym "NEXT"))
925          (start (gensym "START"))
926          (count (gensym "COUNT")))
927      `(flet ((,cleanup-fun () ,@cleanup nil))
928         ;; FIXME: If we ever get DYNAMIC-EXTENT working, then
929         ;; ,CLEANUP-FUN should probably be declared DYNAMIC-EXTENT,
930         ;; and something can be done to make %ESCAPE-FUN have
931         ;; dynamic extent too.
932         (block ,drop-thru-tag
933           (multiple-value-bind (,next ,start ,count)
934               (block ,exit-tag
935                 (%within-cleanup
936                     :unwind-protect
937                     (%unwind-protect (%escape-fun ,exit-tag)
938                                      (%cleanup-fun ,cleanup-fun))
939                   (return-from ,drop-thru-tag ,protected)))
940             (,cleanup-fun)
941             (%continue-unwind ,next ,start ,count)))))))
942 \f
943 ;;;; multiple-value stuff
944
945 ;;; If there are arguments, MULTIPLE-VALUE-CALL turns into an
946 ;;; MV-COMBINATION.
947 ;;;
948 ;;; If there are no arguments, then we convert to a normal
949 ;;; combination, ensuring that a MV-COMBINATION always has at least
950 ;;; one argument. This can be regarded as an optimization, but it is
951 ;;; more important for simplifying compilation of MV-COMBINATIONS.
952 (def-ir1-translator multiple-value-call ((fun &rest args) start cont)
953   #!+sb-doc
954   "MULTIPLE-VALUE-CALL Function Values-Form*
955   Call Function, passing all the values of each Values-Form as arguments,
956   values from the first Values-Form making up the first argument, etc."
957   (let* ((fun-cont (make-continuation))
958          (node (if args
959                    (make-mv-combination fun-cont)
960                    (make-combination fun-cont))))
961     (ir1-convert start fun-cont
962                  (if (and (consp fun) (eq (car fun) 'function))
963                      fun
964                      `(%coerce-callable-to-fun ,fun)))
965     (setf (continuation-dest fun-cont) node)
966     (collect ((arg-conts))
967       (let ((this-start fun-cont))
968         (dolist (arg args)
969           (let ((this-cont (make-continuation node)))
970             (ir1-convert this-start this-cont arg)
971             (setq this-start this-cont)
972             (arg-conts this-cont)))
973         (link-node-to-previous-continuation node this-start)
974         (use-continuation node cont)
975         (setf (basic-combination-args node) (arg-conts))))))
976
977 ;;; MULTIPLE-VALUE-PROG1 is represented implicitly in IR1 by having a
978 ;;; the result code use result continuation (CONT), but transfer
979 ;;; control to the evaluation of the body. In other words, the result
980 ;;; continuation isn't IMMEDIATELY-USED-P by the nodes that compute
981 ;;; the result.
982 ;;;
983 ;;; In order to get the control flow right, we convert the result with
984 ;;; a dummy result continuation, then convert all the uses of the
985 ;;; dummy to be uses of CONT. If a use is an EXIT, then we also
986 ;;; substitute CONT for the dummy in the corresponding ENTRY node so
987 ;;; that they are consistent. Note that this doesn't amount to
988 ;;; changing the exit target, since the control destination of an exit
989 ;;; is determined by the block successor; we are just indicating the
990 ;;; continuation that the result is delivered to.
991 ;;;
992 ;;; We then convert the body, using another dummy continuation in its
993 ;;; own block as the result. After we are done converting the body, we
994 ;;; move all predecessors of the dummy end block to CONT's block.
995 ;;;
996 ;;; Note that we both exploit and maintain the invariant that the CONT
997 ;;; to an IR1 convert method either has no block or starts the block
998 ;;; that control should transfer to after completion for the form.
999 ;;; Nested MV-PROG1's work because during conversion of the result
1000 ;;; form, we use dummy continuation whose block is the true control
1001 ;;; destination.
1002 (def-ir1-translator multiple-value-prog1 ((result &rest forms) start cont)
1003   #!+sb-doc
1004   "MULTIPLE-VALUE-PROG1 Values-Form Form*
1005   Evaluate Values-Form and then the Forms, but return all the values of
1006   Values-Form."
1007   (continuation-starts-block cont)
1008   (let* ((dummy-result (make-continuation))
1009          (dummy-start (make-continuation))
1010          (cont-block (continuation-block cont)))
1011     (continuation-starts-block dummy-start)
1012     (ir1-convert start dummy-start result)
1013
1014     (with-continuation-type-assertion
1015         ;; FIXME: policy
1016         (cont (continuation-asserted-type dummy-start)
1017               "of the first form")
1018       (substitute-continuation-uses cont dummy-start))
1019
1020     (continuation-starts-block dummy-result)
1021     (ir1-convert-progn-body dummy-start dummy-result forms)
1022     (let ((end-block (continuation-block dummy-result)))
1023       (dolist (pred (block-pred end-block))
1024         (unlink-blocks pred end-block)
1025         (link-blocks pred cont-block))
1026       (aver (not (continuation-dest dummy-result)))
1027       (delete-continuation dummy-result)
1028       (remove-from-dfo end-block))))
1029 \f
1030 ;;;; interface to defining macros
1031
1032 ;;; Old CMUCL comment:
1033 ;;;
1034 ;;;   Return a new source path with any stuff intervening between the
1035 ;;;   current path and the first form beginning with NAME stripped
1036 ;;;   off.  This is used to hide the guts of DEFmumble macros to
1037 ;;;   prevent annoying error messages.
1038 ;;;
1039 ;;; Now that we have implementations of DEFmumble macros in terms of
1040 ;;; EVAL-WHEN, this function is no longer used.  However, it might be
1041 ;;; worth figuring out why it was used, and maybe doing analogous
1042 ;;; munging to the functions created in the expanders for the macros.
1043 (defun revert-source-path (name)
1044   (do ((path *current-path* (cdr path)))
1045       ((null path) *current-path*)
1046     (let ((first (first path)))
1047       (when (or (eq first name)
1048                 (eq first 'original-source-start))
1049         (return path)))))