0.8.19.32:
[sbcl.git] / src / compiler / ir1opt.lisp
1 ;;;; This file implements the IR1 optimization phase of the compiler.
2 ;;;; IR1 optimization is a grab-bag of optimizations that don't make
3 ;;;; major changes to the block-level control flow and don't use flow
4 ;;;; analysis. These optimizations can mostly be classified as
5 ;;;; "meta-evaluation", but there is a sizable top-down component as
6 ;;;; well.
7
8 ;;;; This software is part of the SBCL system. See the README file for
9 ;;;; more information.
10 ;;;;
11 ;;;; This software is derived from the CMU CL system, which was
12 ;;;; written at Carnegie Mellon University and released into the
13 ;;;; public domain. The software is in the public domain and is
14 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
15 ;;;; files for more information.
16
17 (in-package "SB!C")
18 \f
19 ;;;; interface for obtaining results of constant folding
20
21 ;;; Return true for an LVAR whose sole use is a reference to a
22 ;;; constant leaf.
23 (defun constant-lvar-p (thing)
24   (declare (type (or lvar null) thing))
25   (and (lvar-p thing)
26        (let ((use (principal-lvar-use thing)))
27          (and (ref-p use) (constant-p (ref-leaf use))))))
28
29 ;;; Return the constant value for an LVAR whose only use is a constant
30 ;;; node.
31 (declaim (ftype (function (lvar) t) lvar-value))
32 (defun lvar-value (lvar)
33   (let ((use (principal-lvar-use lvar)))
34     (constant-value (ref-leaf use))))
35 \f
36 ;;;; interface for obtaining results of type inference
37
38 ;;; Our best guess for the type of this lvar's value. Note that this
39 ;;; may be VALUES or FUNCTION type, which cannot be passed as an
40 ;;; argument to the normal type operations. See LVAR-TYPE.
41 ;;;
42 ;;; The result value is cached in the LVAR-%DERIVED-TYPE slot. If the
43 ;;; slot is true, just return that value, otherwise recompute and
44 ;;; stash the value there.
45 #!-sb-fluid (declaim (inline lvar-derived-type))
46 (defun lvar-derived-type (lvar)
47   (declare (type lvar lvar))
48   (or (lvar-%derived-type lvar)
49       (setf (lvar-%derived-type lvar)
50             (%lvar-derived-type lvar))))
51 (defun %lvar-derived-type (lvar)
52   (declare (type lvar lvar))
53   (let ((uses (lvar-uses lvar)))
54     (cond ((null uses) *empty-type*)
55           ((listp uses)
56            (do ((res (node-derived-type (first uses))
57                      (values-type-union (node-derived-type (first current))
58                                         res))
59                 (current (rest uses) (rest current)))
60                ((null current) res)))
61           (t
62            (node-derived-type (lvar-uses lvar))))))
63
64 ;;; Return the derived type for LVAR's first value. This is guaranteed
65 ;;; not to be a VALUES or FUNCTION type.
66 (declaim (ftype (sfunction (lvar) ctype) lvar-type))
67 (defun lvar-type (lvar)
68   (single-value-type (lvar-derived-type lvar)))
69
70 ;;; If LVAR is an argument of a function, return a type which the
71 ;;; function checks LVAR for.
72 #!-sb-fluid (declaim (inline lvar-externally-checkable-type))
73 (defun lvar-externally-checkable-type (lvar)
74   (or (lvar-%externally-checkable-type lvar)
75       (%lvar-%externally-checkable-type lvar)))
76 (defun %lvar-%externally-checkable-type (lvar)
77   (declare (type lvar lvar))
78   (let ((dest (lvar-dest lvar)))
79     (if (not (and dest (combination-p dest)))
80         ;; TODO: MV-COMBINATION
81         (setf (lvar-%externally-checkable-type lvar) *wild-type*)
82         (let* ((fun (combination-fun dest))
83                (args (combination-args dest))
84                (fun-type (lvar-type fun)))
85           (setf (lvar-%externally-checkable-type fun) *wild-type*)
86           (if (or (not (call-full-like-p dest))
87                   (not (fun-type-p fun-type))
88                   ;; FUN-TYPE might be (AND FUNCTION (SATISFIES ...)).
89                   (fun-type-wild-args fun-type))
90               (dolist (arg args)
91                 (when arg
92                   (setf (lvar-%externally-checkable-type arg)
93                         *wild-type*)))
94               (map-combination-args-and-types
95                (lambda (arg type)
96                  (setf (lvar-%externally-checkable-type arg)
97                        (acond ((lvar-%externally-checkable-type arg)
98                                (values-type-intersection
99                                 it (coerce-to-values type)))
100                               (t (coerce-to-values type)))))
101                dest)))))
102   (lvar-%externally-checkable-type lvar))
103 #!-sb-fluid(declaim (inline flush-lvar-externally-checkable-type))
104 (defun flush-lvar-externally-checkable-type (lvar)
105   (declare (type lvar lvar))
106   (setf (lvar-%externally-checkable-type lvar) nil))
107 \f
108 ;;;; interface routines used by optimizers
109
110 (declaim (inline reoptimize-component))
111 (defun reoptimize-component (component kind)
112   (declare (type component component)
113            (type (member nil :maybe t) kind))
114   (aver kind)
115   (unless (eq (component-reoptimize component) t)
116     (setf (component-reoptimize component) kind)))
117
118 ;;; This function is called by optimizers to indicate that something
119 ;;; interesting has happened to the value of LVAR. Optimizers must
120 ;;; make sure that they don't call for reoptimization when nothing has
121 ;;; happened, since optimization will fail to terminate.
122 ;;;
123 ;;; We clear any cached type for the lvar and set the reoptimize flags
124 ;;; on everything in sight.
125 (defun reoptimize-lvar (lvar)
126   (declare (type (or lvar null) lvar))
127   (when lvar
128     (setf (lvar-%derived-type lvar) nil)
129     (let ((dest (lvar-dest lvar)))
130       (when dest
131         (setf (lvar-reoptimize lvar) t)
132         (setf (node-reoptimize dest) t)
133         (binding* (;; Since this may be called during IR1 conversion,
134                    ;; PREV may be missing.
135                    (prev (node-prev dest) :exit-if-null)
136                    (block (ctran-block prev))
137                    (component (block-component block)))
138           (when (typep dest 'cif)
139             (setf (block-test-modified block) t))
140           (setf (block-reoptimize block) t)
141           (reoptimize-component component :maybe))))
142     (do-uses (node lvar)
143       (setf (block-type-check (node-block node)) t)))
144   (values))
145
146 (defun reoptimize-lvar-uses (lvar)
147   (declare (type lvar lvar))
148   (do-uses (use lvar)
149     (setf (node-reoptimize use) t)
150     (setf (block-reoptimize (node-block use)) t)
151     (reoptimize-component (node-component use) :maybe)))
152
153 ;;; Annotate NODE to indicate that its result has been proven to be
154 ;;; TYPEP to RTYPE. After IR1 conversion has happened, this is the
155 ;;; only correct way to supply information discovered about a node's
156 ;;; type. If you screw with the NODE-DERIVED-TYPE directly, then
157 ;;; information may be lost and reoptimization may not happen.
158 ;;;
159 ;;; What we do is intersect RTYPE with NODE's DERIVED-TYPE. If the
160 ;;; intersection is different from the old type, then we do a
161 ;;; REOPTIMIZE-LVAR on the NODE-LVAR.
162 (defun derive-node-type (node rtype)
163   (declare (type valued-node node) (type ctype rtype))
164   (let ((node-type (node-derived-type node)))
165     (unless (eq node-type rtype)
166       (let ((int (values-type-intersection node-type rtype))
167             (lvar (node-lvar node)))
168         (when (type/= node-type int)
169           (when (and *check-consistency*
170                      (eq int *empty-type*)
171                      (not (eq rtype *empty-type*)))
172             (let ((*compiler-error-context* node))
173               (compiler-warn
174                "New inferred type ~S conflicts with old type:~
175                 ~%  ~S~%*** possible internal error? Please report this."
176                (type-specifier rtype) (type-specifier node-type))))
177           (setf (node-derived-type node) int)
178           ;; If the new type consists of only one object, replace the
179           ;; node with a constant reference.
180           (when (and (ref-p node)
181                      (lambda-var-p (ref-leaf node)))
182             (let ((type (single-value-type int)))
183               (when (and (member-type-p type)
184                          (null (rest (member-type-members type))))
185                 (change-ref-leaf node (find-constant
186                                        (first (member-type-members type)))))))
187           (reoptimize-lvar lvar)))))
188   (values))
189
190 ;;; This is similar to DERIVE-NODE-TYPE, but asserts that it is an
191 ;;; error for LVAR's value not to be TYPEP to TYPE. We implement it
192 ;;; splitting off DEST a new CAST node; old LVAR will deliver values
193 ;;; to CAST. If we improve the assertion, we set TYPE-CHECK and
194 ;;; TYPE-ASSERTED to guarantee that the new assertion will be checked.
195 (defun assert-lvar-type (lvar type policy)
196   (declare (type lvar lvar) (type ctype type))
197   (unless (values-subtypep (lvar-derived-type lvar) type)
198     (let ((internal-lvar (make-lvar))
199           (dest (lvar-dest lvar)))
200       (substitute-lvar internal-lvar lvar)
201       (let ((cast (insert-cast-before dest lvar type policy)))
202         (use-lvar cast internal-lvar))))
203   (values))
204
205 \f
206 ;;;; IR1-OPTIMIZE
207
208 ;;; Do one forward pass over COMPONENT, deleting unreachable blocks
209 ;;; and doing IR1 optimizations. We can ignore all blocks that don't
210 ;;; have the REOPTIMIZE flag set. If COMPONENT-REOPTIMIZE is true when
211 ;;; we are done, then another iteration would be beneficial.
212 (defun ir1-optimize (component fastp)
213   (declare (type component component))
214   (setf (component-reoptimize component) nil)
215   (loop with block = (block-next (component-head component))
216         with tail = (component-tail component)
217         for last-block = block
218         until (eq block tail)
219         do (cond
220              ;; We delete blocks when there is either no predecessor or the
221              ;; block is in a lambda that has been deleted. These blocks
222              ;; would eventually be deleted by DFO recomputation, but doing
223              ;; it here immediately makes the effect available to IR1
224              ;; optimization.
225              ((or (block-delete-p block)
226                   (null (block-pred block)))
227               (delete-block-lazily block)
228               (setq block (clean-component component block)))
229              ((eq (functional-kind (block-home-lambda block)) :deleted)
230               ;; Preserve the BLOCK-SUCC invariant that almost every block has
231               ;; one successor (and a block with DELETE-P set is an acceptable
232               ;; exception).
233               (mark-for-deletion block)
234               (setq block (clean-component component block)))
235              (t
236               (loop
237                  (let ((succ (block-succ block)))
238                    (unless (singleton-p succ)
239                      (return)))
240
241                  (let ((last (block-last block)))
242                    (typecase last
243                      (cif
244                       (flush-dest (if-test last))
245                       (when (unlink-node last)
246                         (return)))
247                      (exit
248                       (when (maybe-delete-exit last)
249                         (return)))))
250
251                  (unless (join-successor-if-possible block)
252                    (return)))
253
254               (when (and (not fastp) (block-reoptimize block) (block-component block))
255                 (aver (not (block-delete-p block)))
256                 (ir1-optimize-block block))
257
258               (cond ((and (block-delete-p block) (block-component block))
259                      (setq block (clean-component component block)))
260                     ((and (block-flush-p block) (block-component block))
261                      (flush-dead-code block)))))
262         do (when (eq block last-block)
263              (setq block (block-next block))))
264
265   (values))
266
267 ;;; Loop over the nodes in BLOCK, acting on (and clearing) REOPTIMIZE
268 ;;; flags.
269 ;;;
270 ;;; Note that although they are cleared here, REOPTIMIZE flags might
271 ;;; still be set upon return from this function, meaning that further
272 ;;; optimization is wanted (as a consequence of optimizations we did).
273 (defun ir1-optimize-block (block)
274   (declare (type cblock block))
275   ;; We clear the node and block REOPTIMIZE flags before doing the
276   ;; optimization, not after. This ensures that the node or block will
277   ;; be reoptimized if necessary.
278   (setf (block-reoptimize block) nil)
279   (do-nodes (node nil block :restart-p t)
280     (when (node-reoptimize node)
281       ;; As above, we clear the node REOPTIMIZE flag before optimizing.
282       (setf (node-reoptimize node) nil)
283       (typecase node
284         (ref)
285         (combination
286          ;; With a COMBINATION, we call PROPAGATE-FUN-CHANGE whenever
287          ;; the function changes, and call IR1-OPTIMIZE-COMBINATION if
288          ;; any argument changes.
289          (ir1-optimize-combination node))
290         (cif
291          (ir1-optimize-if node))
292         (creturn
293          ;; KLUDGE: We leave the NODE-OPTIMIZE flag set going into
294          ;; IR1-OPTIMIZE-RETURN, since IR1-OPTIMIZE-RETURN wants to
295          ;; clear the flag itself. -- WHN 2002-02-02, quoting original
296          ;; CMU CL comments
297          (setf (node-reoptimize node) t)
298          (ir1-optimize-return node))
299         (mv-combination
300          (ir1-optimize-mv-combination node))
301         (exit
302          ;; With an EXIT, we derive the node's type from the VALUE's
303          ;; type.
304          (let ((value (exit-value node)))
305            (when value
306              (derive-node-type node (lvar-derived-type value)))))
307         (cset
308          (ir1-optimize-set node))
309         (cast
310          (ir1-optimize-cast node)))))
311
312   (values))
313
314 ;;; Try to join with a successor block. If we succeed, we return true,
315 ;;; otherwise false.
316 (defun join-successor-if-possible (block)
317   (declare (type cblock block))
318   (let ((next (first (block-succ block))))
319     (when (block-start next)  ; NEXT is not an END-OF-COMPONENT marker
320       (cond ( ;; We cannot combine with a successor block if:
321              (or
322               ;; the successor has more than one predecessor;
323               (rest (block-pred next))
324               ;; the successor is the current block (infinite loop);
325               (eq next block)
326               ;; the next block has a different cleanup, and thus
327               ;; we may want to insert cleanup code between the
328               ;; two blocks at some point;
329               (not (eq (block-end-cleanup block)
330                        (block-start-cleanup next)))
331               ;; the next block has a different home lambda, and
332               ;; thus the control transfer is a non-local exit.
333               (not (eq (block-home-lambda block)
334                        (block-home-lambda next)))
335               ;; Stack analysis phase wants ENTRY to start a block...
336               (entry-p (block-start-node next))
337               (let ((last (block-last block)))
338                 (and (valued-node-p last)
339                      (awhen (node-lvar last)
340                        (or 
341                         ;; ... and a DX-allocator to end a block.
342                         (lvar-dynamic-extent it)
343                         ;; FIXME: This is a partial workaround for bug 303.
344                         (consp (lvar-uses it)))))))
345              nil)
346             (t
347              (join-blocks block next)
348              t)))))
349
350 ;;; Join together two blocks. The code in BLOCK2 is moved into BLOCK1
351 ;;; and BLOCK2 is deleted from the DFO. We combine the optimize flags
352 ;;; for the two blocks so that any indicated optimization gets done.
353 (defun join-blocks (block1 block2)
354   (declare (type cblock block1 block2))
355   (let* ((last1 (block-last block1))
356          (last2 (block-last block2))
357          (succ (block-succ block2))
358          (start2 (block-start block2)))
359     (do ((ctran start2 (node-next (ctran-next ctran))))
360         ((not ctran))
361       (setf (ctran-block ctran) block1))
362
363     (unlink-blocks block1 block2)
364     (dolist (block succ)
365       (unlink-blocks block2 block)
366       (link-blocks block1 block))
367
368     (setf (ctran-kind start2) :inside-block)
369     (setf (node-next last1) start2)
370     (setf (ctran-use start2) last1)
371     (setf (block-last block1) last2))
372
373   (setf (block-flags block1)
374         (attributes-union (block-flags block1)
375                           (block-flags block2)
376                           (block-attributes type-asserted test-modified)))
377
378   (let ((next (block-next block2))
379         (prev (block-prev block2)))
380     (setf (block-next prev) next)
381     (setf (block-prev next) prev))
382
383   (values))
384
385 ;;; Delete any nodes in BLOCK whose value is unused and which have no
386 ;;; side effects. We can delete sets of lexical variables when the set
387 ;;; variable has no references.
388 (defun flush-dead-code (block)
389   (declare (type cblock block))
390   (setf (block-flush-p block) nil)
391   (do-nodes-backwards (node lvar block :restart-p t)
392     (unless lvar
393       (typecase node
394         (ref
395          (delete-ref node)
396          (unlink-node node))
397         (combination
398          (let ((kind (combination-kind node))
399                (info (combination-fun-info node)))
400            (when (and (eq kind :known) (fun-info-p info))
401              (let ((attr (fun-info-attributes info)))
402                (when (and (not (ir1-attributep attr call))
403                           ;; ### For now, don't delete potentially
404                           ;; flushable calls when they have the CALL
405                           ;; attribute. Someday we should look at the
406                           ;; functional args to determine if they have
407                           ;; any side effects.
408                           (if (policy node (= safety 3))
409                               (ir1-attributep attr flushable)
410                               (ir1-attributep attr unsafely-flushable)))
411                  (flush-combination node))))))
412         (mv-combination
413          (when (eq (basic-combination-kind node) :local)
414            (let ((fun (combination-lambda node)))
415              (when (dolist (var (lambda-vars fun) t)
416                      (when (or (leaf-refs var)
417                                (lambda-var-sets var))
418                        (return nil)))
419                (flush-dest (first (basic-combination-args node)))
420                (delete-let fun)))))
421         (exit
422          (let ((value (exit-value node)))
423            (when value
424              (flush-dest value)
425              (setf (exit-value node) nil))))
426         (cset
427          (let ((var (set-var node)))
428            (when (and (lambda-var-p var)
429                       (null (leaf-refs var)))
430              (flush-dest (set-value node))
431              (setf (basic-var-sets var)
432                    (delq node (basic-var-sets var)))
433              (unlink-node node))))
434         (cast
435          (unless (cast-type-check node)
436            (flush-dest (cast-value node))
437            (unlink-node node))))))
438
439   (values))
440 \f
441 ;;;; local call return type propagation
442
443 ;;; This function is called on RETURN nodes that have their REOPTIMIZE
444 ;;; flag set. It iterates over the uses of the RESULT, looking for
445 ;;; interesting stuff to update the TAIL-SET. If a use isn't a local
446 ;;; call, then we union its type together with the types of other such
447 ;;; uses. We assign to the RETURN-RESULT-TYPE the intersection of this
448 ;;; type with the RESULT's asserted type. We can make this
449 ;;; intersection now (potentially before type checking) because this
450 ;;; assertion on the result will eventually be checked (if
451 ;;; appropriate.)
452 ;;;
453 ;;; We call MAYBE-CONVERT-TAIL-LOCAL-CALL on each local non-MV
454 ;;; combination, which may change the succesor of the call to be the
455 ;;; called function, and if so, checks if the call can become an
456 ;;; assignment. If we convert to an assignment, we abort, since the
457 ;;; RETURN has been deleted.
458 (defun find-result-type (node)
459   (declare (type creturn node))
460   (let ((result (return-result node)))
461     (collect ((use-union *empty-type* values-type-union))
462       (do-uses (use result)
463         (let ((use-home (node-home-lambda use)))
464           (cond ((or (eq (functional-kind use-home) :deleted)
465                      (block-delete-p (node-block use))))
466                 ((and (basic-combination-p use)
467                       (eq (basic-combination-kind use) :local))
468                  (aver (eq (lambda-tail-set use-home)
469                            (lambda-tail-set (combination-lambda use))))
470                  (when (combination-p use)
471                    (when (nth-value 1 (maybe-convert-tail-local-call use))
472                      (return-from find-result-type t))))
473                 (t
474                  (use-union (node-derived-type use))))))
475       (let ((int
476              ;; (values-type-intersection
477              ;; (continuation-asserted-type result) ; FIXME -- APD, 2002-01-26
478              (use-union)
479               ;; )
480               ))
481         (setf (return-result-type node) int))))
482   nil)
483
484 ;;; Do stuff to realize that something has changed about the value
485 ;;; delivered to a return node. Since we consider the return values of
486 ;;; all functions in the tail set to be equivalent, this amounts to
487 ;;; bringing the entire tail set up to date. We iterate over the
488 ;;; returns for all the functions in the tail set, reanalyzing them
489 ;;; all (not treating NODE specially.)
490 ;;;
491 ;;; When we are done, we check whether the new type is different from
492 ;;; the old TAIL-SET-TYPE. If so, we set the type and also reoptimize
493 ;;; all the lvars for references to functions in the tail set. This
494 ;;; will cause IR1-OPTIMIZE-COMBINATION to derive the new type as the
495 ;;; results of the calls.
496 (defun ir1-optimize-return (node)
497   (declare (type creturn node))
498   (tagbody
499    :restart
500      (let* ((tails (lambda-tail-set (return-lambda node)))
501             (funs (tail-set-funs tails)))
502        (collect ((res *empty-type* values-type-union))
503                 (dolist (fun funs)
504                   (let ((return (lambda-return fun)))
505                     (when return
506                       (when (node-reoptimize return)
507                         (setf (node-reoptimize return) nil)
508                         (when (find-result-type return)
509                           (go :restart)))
510                       (res (return-result-type return)))))
511
512                 (when (type/= (res) (tail-set-type tails))
513                   (setf (tail-set-type tails) (res))
514                   (dolist (fun (tail-set-funs tails))
515                     (dolist (ref (leaf-refs fun))
516                       (reoptimize-lvar (node-lvar ref))))))))
517
518   (values))
519 \f
520 ;;;; IF optimization
521
522 ;;; If the test has multiple uses, replicate the node when possible.
523 ;;; Also check whether the predicate is known to be true or false,
524 ;;; deleting the IF node in favor of the appropriate branch when this
525 ;;; is the case.
526 (defun ir1-optimize-if (node)
527   (declare (type cif node))
528   (let ((test (if-test node))
529         (block (node-block node)))
530
531     (when (and (eq (block-start-node block) node)
532                (listp (lvar-uses test)))
533       (do-uses (use test)
534         (when (immediately-used-p test use)
535           (convert-if-if use node)
536           (when (not (listp (lvar-uses test))) (return)))))
537
538     (let* ((type (lvar-type test))
539            (victim
540             (cond ((constant-lvar-p test)
541                    (if (lvar-value test)
542                        (if-alternative node)
543                        (if-consequent node)))
544                   ((not (types-equal-or-intersect type (specifier-type 'null)))
545                    (if-alternative node))
546                   ((type= type (specifier-type 'null))
547                    (if-consequent node)))))
548       (when victim
549         (flush-dest test)
550         (when (rest (block-succ block))
551           (unlink-blocks block victim))
552         (setf (component-reanalyze (node-component node)) t)
553         (unlink-node node))))
554   (values))
555
556 ;;; Create a new copy of an IF node that tests the value of the node
557 ;;; USE. The test must have >1 use, and must be immediately used by
558 ;;; USE. NODE must be the only node in its block (implying that
559 ;;; block-start = if-test).
560 ;;;
561 ;;; This optimization has an effect semantically similar to the
562 ;;; source-to-source transformation:
563 ;;;    (IF (IF A B C) D E) ==>
564 ;;;    (IF A (IF B D E) (IF C D E))
565 ;;;
566 ;;; We clobber the NODE-SOURCE-PATH of both the original and the new
567 ;;; node so that dead code deletion notes will definitely not consider
568 ;;; either node to be part of the original source. One node might
569 ;;; become unreachable, resulting in a spurious note.
570 (defun convert-if-if (use node)
571   (declare (type node use) (type cif node))
572   (with-ir1-environment-from-node node
573     (let* ((block (node-block node))
574            (test (if-test node))
575            (cblock (if-consequent node))
576            (ablock (if-alternative node))
577            (use-block (node-block use))
578            (new-ctran (make-ctran))
579            (new-lvar (make-lvar))
580            (new-node (make-if :test new-lvar
581                               :consequent cblock
582                               :alternative ablock))
583            (new-block (ctran-starts-block new-ctran)))
584       (link-node-to-previous-ctran new-node new-ctran)
585       (setf (lvar-dest new-lvar) new-node)
586       (setf (block-last new-block) new-node)
587
588       (unlink-blocks use-block block)
589       (%delete-lvar-use use)
590       (add-lvar-use use new-lvar)
591       (link-blocks use-block new-block)
592
593       (link-blocks new-block cblock)
594       (link-blocks new-block ablock)
595
596       (push "<IF Duplication>" (node-source-path node))
597       (push "<IF Duplication>" (node-source-path new-node))
598
599       (reoptimize-lvar test)
600       (reoptimize-lvar new-lvar)
601       (setf (component-reanalyze *current-component*) t)))
602   (values))
603 \f
604 ;;;; exit IR1 optimization
605
606 ;;; This function attempts to delete an exit node, returning true if
607 ;;; it deletes the block as a consequence:
608 ;;; -- If the exit is degenerate (has no ENTRY), then we don't do
609 ;;;    anything, since there is nothing to be done.
610 ;;; -- If the exit node and its ENTRY have the same home lambda then
611 ;;;    we know the exit is local, and can delete the exit. We change
612 ;;;    uses of the Exit-Value to be uses of the original lvar,
613 ;;;    then unlink the node. If the exit is to a TR context, then we
614 ;;;    must do MERGE-TAIL-SETS on any local calls which delivered
615 ;;;    their value to this exit.
616 ;;; -- If there is no value (as in a GO), then we skip the value
617 ;;;    semantics.
618 ;;;
619 ;;; This function is also called by environment analysis, since it
620 ;;; wants all exits to be optimized even if normal optimization was
621 ;;; omitted.
622 (defun maybe-delete-exit (node)
623   (declare (type exit node))
624   (let ((value (exit-value node))
625         (entry (exit-entry node)))
626     (when (and entry
627                (eq (node-home-lambda node) (node-home-lambda entry)))
628       (setf (entry-exits entry) (delq node (entry-exits entry)))
629       (if value
630           (delete-filter node (node-lvar node) value)
631           (unlink-node node)))))
632
633 \f
634 ;;;; combination IR1 optimization
635
636 ;;; Report as we try each transform?
637 #!+sb-show
638 (defvar *show-transforms-p* nil)
639
640 ;;; Do IR1 optimizations on a COMBINATION node.
641 (declaim (ftype (function (combination) (values)) ir1-optimize-combination))
642 (defun ir1-optimize-combination (node)
643   (when (lvar-reoptimize (basic-combination-fun node))
644     (propagate-fun-change node)
645     (maybe-terminate-block node nil))
646   (let ((args (basic-combination-args node))
647         (kind (basic-combination-kind node))
648         (info (basic-combination-fun-info node)))
649     (ecase kind
650       (:local
651        (let ((fun (combination-lambda node)))
652          (if (eq (functional-kind fun) :let)
653              (propagate-let-args node fun)
654              (propagate-local-call-args node fun))))
655       (:error
656        (dolist (arg args)
657          (when arg
658            (setf (lvar-reoptimize arg) nil))))
659       (:full
660        (dolist (arg args)
661          (when arg
662            (setf (lvar-reoptimize arg) nil)))
663        (when info
664          (let ((fun (fun-info-derive-type info)))
665            (when fun
666              (let ((res (funcall fun node)))
667                (when res
668                  (derive-node-type node (coerce-to-values res))
669                  (maybe-terminate-block node nil)))))))
670       (:known
671        (aver info)
672        (dolist (arg args)
673          (when arg
674            (setf (lvar-reoptimize arg) nil)))
675
676        (let ((attr (fun-info-attributes info)))
677          (when (and (ir1-attributep attr foldable)
678                     ;; KLUDGE: The next test could be made more sensitive,
679                     ;; only suppressing constant-folding of functions with
680                     ;; CALL attributes when they're actually passed
681                     ;; function arguments. -- WHN 19990918
682                     (not (ir1-attributep attr call))
683                     (every #'constant-lvar-p args)
684                     (node-lvar node)
685                     ;; Even if the function is foldable in principle,
686                     ;; it might be one of our low-level
687                     ;; implementation-specific functions. Such
688                     ;; functions don't necessarily exist at runtime on
689                     ;; a plain vanilla ANSI Common Lisp
690                     ;; cross-compilation host, in which case the
691                     ;; cross-compiler can't fold it because the
692                     ;; cross-compiler doesn't know how to evaluate it.
693                     #+sb-xc-host
694                     (or (fboundp (combination-fun-source-name node))
695                         (progn (format t ";;; !!! Unbound fun: (~S~{ ~S~})~%"
696                                        (combination-fun-source-name node)
697                                        (mapcar #'lvar-value args))
698                                nil)))
699            (constant-fold-call node)
700            (return-from ir1-optimize-combination)))
701
702        (let ((fun (fun-info-derive-type info)))
703          (when fun
704            (let ((res (funcall fun node)))
705              (when res
706                (derive-node-type node (coerce-to-values res))
707                (maybe-terminate-block node nil)))))
708
709        (let ((fun (fun-info-optimizer info)))
710          (unless (and fun (funcall fun node))
711            (dolist (x (fun-info-transforms info))
712              #!+sb-show
713              (when *show-transforms-p*
714                (let* ((lvar (basic-combination-fun node))
715                       (fname (lvar-fun-name lvar t)))
716                  (/show "trying transform" x (transform-function x) "for" fname)))
717              (unless (ir1-transform node x)
718                #!+sb-show
719                (when *show-transforms-p*
720                  (/show "quitting because IR1-TRANSFORM result was NIL"))
721                (return))))))))
722
723   (values))
724
725 ;;; If NODE doesn't return (i.e. return type is NIL), then terminate
726 ;;; the block there, and link it to the component tail.
727 ;;;
728 ;;; Except when called during IR1 convertion, we delete the
729 ;;; continuation if it has no other uses. (If it does have other uses,
730 ;;; we reoptimize.)
731 ;;;
732 ;;; Termination on the basis of a continuation type is
733 ;;; inhibited when:
734 ;;; -- The continuation is deleted (hence the assertion is spurious), or
735 ;;; -- We are in IR1 conversion (where THE assertions are subject to
736 ;;;    weakening.) FIXME: Now THE assertions are not weakened, but new
737 ;;;    uses can(?) be added later. -- APD, 2003-07-17
738 ;;;
739 ;;; Why do we need to consider LVAR type? -- APD, 2003-07-30
740 (defun maybe-terminate-block (node ir1-converting-not-optimizing-p)
741   (declare (type (or basic-combination cast ref) node))
742   (let* ((block (node-block node))
743          (lvar (node-lvar node))
744          (ctran (node-next node))
745          (tail (component-tail (block-component block)))
746          (succ (first (block-succ block))))
747     (declare (ignore lvar))
748     (unless (or (and (eq node (block-last block)) (eq succ tail))
749                 (block-delete-p block))
750       (when (eq (node-derived-type node) *empty-type*)
751         (cond (ir1-converting-not-optimizing-p
752                (cond
753                  ((block-last block)
754                   (aver (eq (block-last block) node)))
755                  (t
756                   (setf (block-last block) node)
757                   (setf (ctran-use ctran) nil)
758                   (setf (ctran-kind ctran) :unused)
759                   (setf (ctran-block ctran) nil)
760                   (setf (node-next node) nil)
761                   (link-blocks block (ctran-starts-block ctran)))))
762               (t
763                (node-ends-block node)))
764
765         (let ((succ (first (block-succ block))))
766           (unlink-blocks block succ)
767           (setf (component-reanalyze (block-component block)) t)
768           (aver (not (block-succ block)))
769           (link-blocks block tail)
770           (cond (ir1-converting-not-optimizing-p
771                  (%delete-lvar-use node))
772                 (t (delete-lvar-use node)
773                    (when (null (block-pred succ))
774                      (mark-for-deletion succ)))))
775         t))))
776
777 ;;; This is called both by IR1 conversion and IR1 optimization when
778 ;;; they have verified the type signature for the call, and are
779 ;;; wondering if something should be done to special-case the call. If
780 ;;; CALL is a call to a global function, then see whether it defined
781 ;;; or known:
782 ;;; -- If a DEFINED-FUN should be inline expanded, then convert
783 ;;;    the expansion and change the call to call it. Expansion is
784 ;;;    enabled if :INLINE or if SPACE=0. If the FUNCTIONAL slot is
785 ;;;    true, we never expand, since this function has already been
786 ;;;    converted. Local call analysis will duplicate the definition
787 ;;;    if necessary. We claim that the parent form is LABELS for
788 ;;;    context declarations, since we don't want it to be considered
789 ;;;    a real global function.
790 ;;; -- If it is a known function, mark it as such by setting the KIND.
791 ;;;
792 ;;; We return the leaf referenced (NIL if not a leaf) and the
793 ;;; FUN-INFO assigned.
794 (defun recognize-known-call (call ir1-converting-not-optimizing-p)
795   (declare (type combination call))
796   (let* ((ref (lvar-uses (basic-combination-fun call)))
797          (leaf (when (ref-p ref) (ref-leaf ref)))
798          (inlinep (if (defined-fun-p leaf)
799                       (defined-fun-inlinep leaf)
800                       :no-chance)))
801     (cond
802      ((eq inlinep :notinline)
803       (let ((info (info :function :info (leaf-source-name leaf))))
804         (when info
805           (setf (basic-combination-fun-info call) info))
806         (values nil nil)))
807      ((not (and (global-var-p leaf)
808                 (eq (global-var-kind leaf) :global-function)))
809       (values leaf nil))
810      ((and (ecase inlinep
811              (:inline t)
812              (:no-chance nil)
813              ((nil :maybe-inline) (policy call (zerop space))))
814            (defined-fun-p leaf)
815            (defined-fun-inline-expansion leaf)
816            (let ((fun (defined-fun-functional leaf)))
817              (or (not fun)
818                  (and (eq inlinep :inline) (functional-kind fun))))
819            (inline-expansion-ok call))
820       (flet (;; FIXME: Is this what the old CMU CL internal documentation
821              ;; called semi-inlining? A more descriptive name would
822              ;; be nice. -- WHN 2002-01-07
823              (frob ()
824                (let ((res (let ((*allow-instrumenting* t))
825                             (ir1-convert-lambda-for-defun
826                              (defined-fun-inline-expansion leaf)
827                              leaf t
828                              #'ir1-convert-inline-lambda))))
829                  (setf (defined-fun-functional leaf) res)
830                  (change-ref-leaf ref res))))
831         (if ir1-converting-not-optimizing-p
832             (frob)
833             (with-ir1-environment-from-node call
834               (frob)
835               (locall-analyze-component *current-component*))))
836
837       (values (ref-leaf (lvar-uses (basic-combination-fun call)))
838               nil))
839      (t
840       (let ((info (info :function :info (leaf-source-name leaf))))
841         (if info
842             (values leaf
843                     (progn
844                       (setf (basic-combination-kind call) :known)
845                       (setf (basic-combination-fun-info call) info)))
846             (values leaf nil)))))))
847
848 ;;; Check whether CALL satisfies TYPE. If so, apply the type to the
849 ;;; call, and do MAYBE-TERMINATE-BLOCK and return the values of
850 ;;; RECOGNIZE-KNOWN-CALL. If an error, set the combination kind and
851 ;;; return NIL, NIL. If the type is just FUNCTION, then skip the
852 ;;; syntax check, arg/result type processing, but still call
853 ;;; RECOGNIZE-KNOWN-CALL, since the call might be to a known lambda,
854 ;;; and that checking is done by local call analysis.
855 (defun validate-call-type (call type ir1-converting-not-optimizing-p)
856   (declare (type combination call) (type ctype type))
857   (cond ((not (fun-type-p type))
858          (aver (multiple-value-bind (val win)
859                    (csubtypep type (specifier-type 'function))
860                  (or val (not win))))
861          (recognize-known-call call ir1-converting-not-optimizing-p))
862         ((valid-fun-use call type
863                         :argument-test #'always-subtypep
864                         :result-test nil
865                         ;; KLUDGE: Common Lisp is such a dynamic
866                         ;; language that all we can do here in
867                         ;; general is issue a STYLE-WARNING. It
868                         ;; would be nice to issue a full WARNING
869                         ;; in the special case of of type
870                         ;; mismatches within a compilation unit
871                         ;; (as in section 3.2.2.3 of the spec)
872                         ;; but at least as of sbcl-0.6.11, we
873                         ;; don't keep track of whether the
874                         ;; mismatched data came from the same
875                         ;; compilation unit, so we can't do that.
876                         ;; -- WHN 2001-02-11
877                         ;;
878                         ;; FIXME: Actually, I think we could
879                         ;; issue a full WARNING if the call
880                         ;; violates a DECLAIM FTYPE.
881                         :lossage-fun #'compiler-style-warn
882                         :unwinnage-fun #'compiler-notify)
883          (assert-call-type call type)
884          (maybe-terminate-block call ir1-converting-not-optimizing-p)
885          (recognize-known-call call ir1-converting-not-optimizing-p))
886         (t
887          (setf (combination-kind call) :error)
888          (values nil nil))))
889
890 ;;; This is called by IR1-OPTIMIZE when the function for a call has
891 ;;; changed. If the call is local, we try to LET-convert it, and
892 ;;; derive the result type. If it is a :FULL call, we validate it
893 ;;; against the type, which recognizes known calls, does inline
894 ;;; expansion, etc. If a call to a predicate in a non-conditional
895 ;;; position or to a function with a source transform, then we
896 ;;; reconvert the form to give IR1 another chance.
897 (defun propagate-fun-change (call)
898   (declare (type combination call))
899   (let ((*compiler-error-context* call)
900         (fun-lvar (basic-combination-fun call)))
901     (setf (lvar-reoptimize fun-lvar) nil)
902     (case (combination-kind call)
903       (:local
904        (let ((fun (combination-lambda call)))
905          (maybe-let-convert fun)
906          (unless (member (functional-kind fun) '(:let :assignment :deleted))
907            (derive-node-type call (tail-set-type (lambda-tail-set fun))))))
908       (:full
909        (multiple-value-bind (leaf info)
910            (validate-call-type call (lvar-type fun-lvar) nil)
911          (cond ((functional-p leaf)
912                 (convert-call-if-possible
913                  (lvar-uses (basic-combination-fun call))
914                  call))
915                ((not leaf))
916                ((and (global-var-p leaf)
917                      (eq (global-var-kind leaf) :global-function)
918                      (leaf-has-source-name-p leaf)
919                      (or (info :function :source-transform (leaf-source-name leaf))
920                          (and info
921                               (ir1-attributep (fun-info-attributes info)
922                                               predicate)
923                               (let ((lvar (node-lvar call)))
924                                 (and lvar (not (if-p (lvar-dest lvar))))))))
925                 (let ((name (leaf-source-name leaf))
926                       (dummies (make-gensym-list
927                                 (length (combination-args call)))))
928                   (transform-call call
929                                   `(lambda ,dummies
930                                      (,@(if (symbolp name)
931                                             `(,name)
932                                             `(funcall #',name))
933                                         ,@dummies))
934                                   (leaf-source-name leaf)))))))))
935   (values))
936 \f
937 ;;;; known function optimization
938
939 ;;; Add a failed optimization note to FAILED-OPTIMZATIONS for NODE,
940 ;;; FUN and ARGS. If there is already a note for NODE and TRANSFORM,
941 ;;; replace it, otherwise add a new one.
942 (defun record-optimization-failure (node transform args)
943   (declare (type combination node) (type transform transform)
944            (type (or fun-type list) args))
945   (let* ((table (component-failed-optimizations *component-being-compiled*))
946          (found (assoc transform (gethash node table))))
947     (if found
948         (setf (cdr found) args)
949         (push (cons transform args) (gethash node table))))
950   (values))
951
952 ;;; Attempt to transform NODE using TRANSFORM-FUNCTION, subject to the
953 ;;; call type constraint TRANSFORM-TYPE. If we are inhibited from
954 ;;; doing the transform for some reason and FLAME is true, then we
955 ;;; make a note of the message in FAILED-OPTIMIZATIONS for IR1
956 ;;; finalize to pick up. We return true if the transform failed, and
957 ;;; thus further transformation should be attempted. We return false
958 ;;; if either the transform succeeded or was aborted.
959 (defun ir1-transform (node transform)
960   (declare (type combination node) (type transform transform))
961   (let* ((type (transform-type transform))
962          (fun (transform-function transform))
963          (constrained (fun-type-p type))
964          (table (component-failed-optimizations *component-being-compiled*))
965          (flame (if (transform-important transform)
966                     (policy node (>= speed inhibit-warnings))
967                     (policy node (> speed inhibit-warnings))))
968          (*compiler-error-context* node))
969     (cond ((or (not constrained)
970                (valid-fun-use node type))
971            (multiple-value-bind (severity args)
972                (catch 'give-up-ir1-transform
973                  (transform-call node
974                                  (funcall fun node)
975                                  (combination-fun-source-name node))
976                  (values :none nil))
977              (ecase severity
978                (:none
979                 (remhash node table)
980                 nil)
981                (:aborted
982                 (setf (combination-kind node) :error)
983                 (when args
984                   (apply #'warn args))
985                 (remhash node table)
986                 nil)
987                (:failure
988                 (if args
989                     (when flame
990                       (record-optimization-failure node transform args))
991                     (setf (gethash node table)
992                           (remove transform (gethash node table) :key #'car)))
993                 t)
994                (:delayed
995                  (remhash node table)
996                  nil))))
997           ((and flame
998                 (valid-fun-use node
999                                type
1000                                :argument-test #'types-equal-or-intersect
1001                                :result-test #'values-types-equal-or-intersect))
1002            (record-optimization-failure node transform type)
1003            t)
1004           (t
1005            t))))
1006
1007 ;;; When we don't like an IR1 transform, we throw the severity/reason
1008 ;;; and args.
1009 ;;;
1010 ;;; GIVE-UP-IR1-TRANSFORM is used to throw out of an IR1 transform,
1011 ;;; aborting this attempt to transform the call, but admitting the
1012 ;;; possibility that this or some other transform will later succeed.
1013 ;;; If arguments are supplied, they are format arguments for an
1014 ;;; efficiency note.
1015 ;;;
1016 ;;; ABORT-IR1-TRANSFORM is used to throw out of an IR1 transform and
1017 ;;; force a normal call to the function at run time. No further
1018 ;;; optimizations will be attempted.
1019 ;;;
1020 ;;; DELAY-IR1-TRANSFORM is used to throw out of an IR1 transform, and
1021 ;;; delay the transform on the node until later. REASONS specifies
1022 ;;; when the transform will be later retried. The :OPTIMIZE reason
1023 ;;; causes the transform to be delayed until after the current IR1
1024 ;;; optimization pass. The :CONSTRAINT reason causes the transform to
1025 ;;; be delayed until after constraint propagation.
1026 ;;;
1027 ;;; FIXME: Now (0.6.11.44) that there are 4 variants of this (GIVE-UP,
1028 ;;; ABORT, DELAY/:OPTIMIZE, DELAY/:CONSTRAINT) and we're starting to
1029 ;;; do CASE operations on the various REASON values, it might be a
1030 ;;; good idea to go OO, representing the reasons by objects, using
1031 ;;; CLOS methods on the objects instead of CASE, and (possibly) using
1032 ;;; SIGNAL instead of THROW.
1033 (declaim (ftype (function (&rest t) nil) give-up-ir1-transform))
1034 (defun give-up-ir1-transform (&rest args)
1035   (throw 'give-up-ir1-transform (values :failure args)))
1036 (defun abort-ir1-transform (&rest args)
1037   (throw 'give-up-ir1-transform (values :aborted args)))
1038 (defun delay-ir1-transform (node &rest reasons)
1039   (let ((assoc (assoc node *delayed-ir1-transforms*)))
1040     (cond ((not assoc)
1041             (setf *delayed-ir1-transforms*
1042                     (acons node reasons *delayed-ir1-transforms*))
1043             (throw 'give-up-ir1-transform :delayed))
1044           ((cdr assoc)
1045             (dolist (reason reasons)
1046               (pushnew reason (cdr assoc)))
1047             (throw 'give-up-ir1-transform :delayed)))))
1048
1049 ;;; Clear any delayed transform with no reasons - these should have
1050 ;;; been tried in the last pass. Then remove the reason from the
1051 ;;; delayed transform reasons, and if any become empty then set
1052 ;;; reoptimize flags for the node. Return true if any transforms are
1053 ;;; to be retried.
1054 (defun retry-delayed-ir1-transforms (reason)
1055   (setf *delayed-ir1-transforms*
1056         (remove-if-not #'cdr *delayed-ir1-transforms*))
1057   (let ((reoptimize nil))
1058     (dolist (assoc *delayed-ir1-transforms*)
1059       (let ((reasons (remove reason (cdr assoc))))
1060         (setf (cdr assoc) reasons)
1061         (unless reasons
1062           (let ((node (car assoc)))
1063             (unless (node-deleted node)
1064               (setf reoptimize t)
1065               (setf (node-reoptimize node) t)
1066               (let ((block (node-block node)))
1067                 (setf (block-reoptimize block) t)
1068                 (reoptimize-component (block-component block) :maybe)))))))
1069     reoptimize))
1070
1071 ;;; Take the lambda-expression RES, IR1 convert it in the proper
1072 ;;; environment, and then install it as the function for the call
1073 ;;; NODE. We do local call analysis so that the new function is
1074 ;;; integrated into the control flow.
1075 ;;;
1076 ;;; We require the original function source name in order to generate
1077 ;;; a meaningful debug name for the lambda we set up. (It'd be
1078 ;;; possible to do this starting from debug names as well as source
1079 ;;; names, but as of sbcl-0.7.1.5, there was no need for this
1080 ;;; generality, since source names are always known to our callers.)
1081 (defun transform-call (call res source-name)
1082   (declare (type combination call) (list res))
1083   (aver (and (legal-fun-name-p source-name)
1084              (not (eql source-name '.anonymous.))))
1085   (node-ends-block call)
1086   (with-ir1-environment-from-node call
1087     (with-component-last-block (*current-component*
1088                                 (block-next (node-block call)))
1089       (let ((new-fun (ir1-convert-inline-lambda
1090                       res
1091                       :debug-name (debug-namify "LAMBDA-inlined "
1092                                                 source-name
1093                                                 "<unknown function>")))
1094             (ref (lvar-use (combination-fun call))))
1095         (change-ref-leaf ref new-fun)
1096         (setf (combination-kind call) :full)
1097         (locall-analyze-component *current-component*))))
1098   (values))
1099
1100 ;;; Replace a call to a foldable function of constant arguments with
1101 ;;; the result of evaluating the form. If there is an error during the
1102 ;;; evaluation, we give a warning and leave the call alone, making the
1103 ;;; call a :ERROR call.
1104 ;;;
1105 ;;; If there is more than one value, then we transform the call into a
1106 ;;; VALUES form.
1107 (defun constant-fold-call (call)
1108   (let ((args (mapcar #'lvar-value (combination-args call)))
1109         (fun-name (combination-fun-source-name call)))
1110     (multiple-value-bind (values win)
1111         (careful-call fun-name
1112                       args
1113                       call
1114                       ;; Note: CMU CL had COMPILER-WARN here, and that
1115                       ;; seems more natural, but it's probably not.
1116                       ;;
1117                       ;; It's especially not while bug 173 exists:
1118                       ;; Expressions like
1119                       ;;   (COND (END
1120                       ;;          (UNLESS (OR UNSAFE? (<= END SIZE)))
1121                       ;;            ...))
1122                       ;; can cause constant-folding TYPE-ERRORs (in
1123                       ;; #'<=) when END can be proved to be NIL, even
1124                       ;; though the code is perfectly legal and safe
1125                       ;; because a NIL value of END means that the
1126                       ;; #'<= will never be executed.
1127                       ;;
1128                       ;; Moreover, even without bug 173,
1129                       ;; quite-possibly-valid code like
1130                       ;;   (COND ((NONINLINED-PREDICATE END)
1131                       ;;          (UNLESS (<= END SIZE))
1132                       ;;            ...))
1133                       ;; (where NONINLINED-PREDICATE is something the
1134                       ;; compiler can't do at compile time, but which
1135                       ;; turns out to make the #'<= expression
1136                       ;; unreachable when END=NIL) could cause errors
1137                       ;; when the compiler tries to constant-fold (<=
1138                       ;; END SIZE).
1139                       ;;
1140                       ;; So, with or without bug 173, it'd be
1141                       ;; unnecessarily evil to do a full
1142                       ;; COMPILER-WARNING (and thus return FAILURE-P=T
1143                       ;; from COMPILE-FILE) for legal code, so we we
1144                       ;; use a wimpier COMPILE-STYLE-WARNING instead.
1145                       #'compiler-style-warn
1146                       "constant folding")
1147       (cond ((not win)
1148              (setf (combination-kind call) :error))
1149             ((and (proper-list-of-length-p values 1))
1150              (with-ir1-environment-from-node call
1151                (let* ((lvar (node-lvar call))
1152                       (prev (node-prev call))
1153                       (intermediate-ctran (make-ctran)))
1154                  (%delete-lvar-use call)
1155                  (setf (ctran-next prev) nil)
1156                  (setf (node-prev call) nil)
1157                  (reference-constant prev intermediate-ctran lvar
1158                                      (first values))
1159                  (link-node-to-previous-ctran call intermediate-ctran)
1160                  (reoptimize-lvar lvar)
1161                  (flush-combination call))))
1162             (t (let ((dummies (make-gensym-list (length args))))
1163                  (transform-call
1164                   call
1165                   `(lambda ,dummies
1166                      (declare (ignore ,@dummies))
1167                      (values ,@(mapcar (lambda (x) `',x) values)))
1168                   fun-name))))))
1169   (values))
1170 \f
1171 ;;;; local call optimization
1172
1173 ;;; Propagate TYPE to LEAF and its REFS, marking things changed. If
1174 ;;; the leaf type is a function type, then just leave it alone, since
1175 ;;; TYPE is never going to be more specific than that (and
1176 ;;; TYPE-INTERSECTION would choke.)
1177 (defun propagate-to-refs (leaf type)
1178   (declare (type leaf leaf) (type ctype type))
1179   (let ((var-type (leaf-type leaf)))
1180     (unless (fun-type-p var-type)
1181       (let ((int (type-approx-intersection2 var-type type)))
1182         (when (type/= int var-type)
1183           (setf (leaf-type leaf) int)
1184           (dolist (ref (leaf-refs leaf))
1185             (derive-node-type ref (make-single-value-type int))
1186             ;; KLUDGE: LET var substitution
1187             (let* ((lvar (node-lvar ref)))
1188               (when (and lvar (combination-p (lvar-dest lvar)))
1189                 (reoptimize-lvar lvar))))))
1190       (values))))
1191
1192 ;;; Iteration variable: exactly one SETQ of the form:
1193 ;;;
1194 ;;; (let ((var initial))
1195 ;;;   ...
1196 ;;;   (setq var (+ var step))
1197 ;;;   ...)
1198 (defun maybe-infer-iteration-var-type (var initial-type)
1199   (binding* ((sets (lambda-var-sets var) :exit-if-null)
1200              (set (first sets))
1201              (() (null (rest sets)) :exit-if-null)
1202              (set-use (principal-lvar-use (set-value set)))
1203              (() (and (combination-p set-use)
1204                       (eq (combination-kind set-use) :known)
1205                       (fun-info-p (combination-fun-info set-use))
1206                       (not (node-to-be-deleted-p set-use))
1207                       (eq (combination-fun-source-name set-use) '+))
1208                :exit-if-null)
1209              (+-args (basic-combination-args set-use))
1210              (() (and (proper-list-of-length-p +-args 2 2)
1211                       (let ((first (principal-lvar-use
1212                                     (first +-args))))
1213                         (and (ref-p first)
1214                              (eq (ref-leaf first) var))))
1215                :exit-if-null)
1216              (step-type (lvar-type (second +-args)))
1217              (set-type (lvar-type (set-value set))))
1218     (when (and (numeric-type-p initial-type)
1219                (numeric-type-p step-type)
1220                (numeric-type-equal initial-type step-type))
1221       (multiple-value-bind (low high)
1222           (cond ((csubtypep step-type (specifier-type '(real 0 *)))
1223                  (values (numeric-type-low initial-type)
1224                          (when (and (numeric-type-p set-type)
1225                                     (numeric-type-equal set-type initial-type))
1226                            (numeric-type-high set-type))))
1227                 ((csubtypep step-type (specifier-type '(real * 0)))
1228                  (values (when (and (numeric-type-p set-type)
1229                                     (numeric-type-equal set-type initial-type))
1230                            (numeric-type-low set-type))
1231                          (numeric-type-high initial-type)))
1232                 (t
1233                  (values nil nil)))
1234         (modified-numeric-type initial-type
1235                                :low low
1236                                :high high
1237                                :enumerable nil)))))
1238 (deftransform + ((x y) * * :result result)
1239   "check for iteration variable reoptimization"
1240   (let ((dest (principal-lvar-end result))
1241         (use (principal-lvar-use x)))
1242     (when (and (ref-p use)
1243                (set-p dest)
1244                (eq (ref-leaf use)
1245                    (set-var dest)))
1246       (reoptimize-lvar (set-value dest))))
1247   (give-up-ir1-transform))
1248
1249 ;;; Figure out the type of a LET variable that has sets. We compute
1250 ;;; the union of the INITIAL-TYPE and the types of all the set
1251 ;;; values and to a PROPAGATE-TO-REFS with this type.
1252 (defun propagate-from-sets (var initial-type)
1253   (collect ((res initial-type type-union))
1254     (dolist (set (basic-var-sets var))
1255       (let ((type (lvar-type (set-value set))))
1256         (res type)
1257         (when (node-reoptimize set)
1258           (derive-node-type set (make-single-value-type type))
1259           (setf (node-reoptimize set) nil))))
1260     (let ((res (res)))
1261       (awhen (maybe-infer-iteration-var-type var initial-type)
1262         (setq res it))
1263       (propagate-to-refs var res)))
1264   (values))
1265
1266 ;;; If a LET variable, find the initial value's type and do
1267 ;;; PROPAGATE-FROM-SETS. We also derive the VALUE's type as the node's
1268 ;;; type.
1269 (defun ir1-optimize-set (node)
1270   (declare (type cset node))
1271   (let ((var (set-var node)))
1272     (when (and (lambda-var-p var) (leaf-refs var))
1273       (let ((home (lambda-var-home var)))
1274         (when (eq (functional-kind home) :let)
1275           (let* ((initial-value (let-var-initial-value var))
1276                  (initial-type (lvar-type initial-value)))
1277             (setf (lvar-reoptimize initial-value) nil)
1278             (propagate-from-sets var initial-type))))))
1279
1280   (derive-node-type node (make-single-value-type
1281                           (lvar-type (set-value node))))
1282   (values))
1283
1284 ;;; Return true if the value of REF will always be the same (and is
1285 ;;; thus legal to substitute.)
1286 (defun constant-reference-p (ref)
1287   (declare (type ref ref))
1288   (let ((leaf (ref-leaf ref)))
1289     (typecase leaf
1290       ((or constant functional) t)
1291       (lambda-var
1292        (null (lambda-var-sets leaf)))
1293       (defined-fun
1294        (not (eq (defined-fun-inlinep leaf) :notinline)))
1295       (global-var
1296        (case (global-var-kind leaf)
1297          (:global-function
1298           (let ((name (leaf-source-name leaf)))
1299             (or #-sb-xc-host
1300                 (eq (symbol-package (fun-name-block-name name))
1301                     *cl-package*)
1302                 (info :function :info name)))))))))
1303
1304 ;;; If we have a non-set LET var with a single use, then (if possible)
1305 ;;; replace the variable reference's LVAR with the arg lvar.
1306 ;;;
1307 ;;; We change the REF to be a reference to NIL with unused value, and
1308 ;;; let it be flushed as dead code. A side effect of this substitution
1309 ;;; is to delete the variable.
1310 (defun substitute-single-use-lvar (arg var)
1311   (declare (type lvar arg) (type lambda-var var))
1312   (binding* ((ref (first (leaf-refs var)))
1313              (lvar (node-lvar ref) :exit-if-null)
1314              (dest (lvar-dest lvar)))
1315     (when (and
1316            ;; Think about (LET ((A ...)) (IF ... A ...)): two
1317            ;; LVAR-USEs should not be met on one path. Another problem
1318            ;; is with dynamic-extent.
1319            (eq (lvar-uses lvar) ref)
1320            (not (block-delete-p (node-block ref)))
1321            (typecase dest
1322              ;; we should not change lifetime of unknown values lvars
1323              (cast
1324               (and (type-single-value-p (lvar-derived-type arg))
1325                    (multiple-value-bind (pdest pprev)
1326                        (principal-lvar-end lvar)
1327                      (declare (ignore pdest))
1328                      (lvar-single-value-p pprev))))
1329              (mv-combination
1330               (or (eq (basic-combination-fun dest) lvar)
1331                   (and (eq (basic-combination-kind dest) :local)
1332                        (type-single-value-p (lvar-derived-type arg)))))
1333              ((or creturn exit)
1334               ;; While CRETURN and EXIT nodes may be known-values,
1335               ;; they have their own complications, such as
1336               ;; substitution into CRETURN may create new tail calls.
1337               nil)
1338              (t
1339               (aver (lvar-single-value-p lvar))
1340               t))
1341            (eq (node-home-lambda ref)
1342                (lambda-home (lambda-var-home var))))
1343       (let ((ref-type (single-value-type (node-derived-type ref))))
1344         (cond ((csubtypep (single-value-type (lvar-type arg)) ref-type)
1345                (substitute-lvar-uses lvar arg
1346                                      ;; Really it is (EQ (LVAR-USES LVAR) REF):
1347                                      t)
1348                (delete-lvar-use ref))
1349               (t
1350                (let* ((value (make-lvar))
1351                       (cast (insert-cast-before ref value ref-type
1352                                                 ;; KLUDGE: it should be (TYPE-CHECK 0)
1353                                                 *policy*)))
1354                  (setf (cast-type-to-check cast) *wild-type*)
1355                  (substitute-lvar-uses value arg
1356                                      ;; FIXME
1357                                      t)
1358                  (%delete-lvar-use ref)
1359                  (add-lvar-use cast lvar)))))
1360       (setf (node-derived-type ref) *wild-type*)
1361       (change-ref-leaf ref (find-constant nil))
1362       (delete-ref ref)
1363       (unlink-node ref)
1364       (reoptimize-lvar lvar)
1365       t)))
1366
1367 ;;; Delete a LET, removing the call and bind nodes, and warning about
1368 ;;; any unreferenced variables. Note that FLUSH-DEAD-CODE will come
1369 ;;; along right away and delete the REF and then the lambda, since we
1370 ;;; flush the FUN lvar.
1371 (defun delete-let (clambda)
1372   (declare (type clambda clambda))
1373   (aver (functional-letlike-p clambda))
1374   (note-unreferenced-vars clambda)
1375   (let ((call (let-combination clambda)))
1376     (flush-dest (basic-combination-fun call))
1377     (unlink-node call)
1378     (unlink-node (lambda-bind clambda))
1379     (setf (lambda-bind clambda) nil))
1380   (setf (functional-kind clambda) :zombie)
1381   (let ((home (lambda-home clambda)))
1382     (setf (lambda-lets home) (delete clambda (lambda-lets home))))
1383   (values))
1384
1385 ;;; This function is called when one of the arguments to a LET
1386 ;;; changes. We look at each changed argument. If the corresponding
1387 ;;; variable is set, then we call PROPAGATE-FROM-SETS. Otherwise, we
1388 ;;; consider substituting for the variable, and also propagate
1389 ;;; derived-type information for the arg to all the VAR's refs.
1390 ;;;
1391 ;;; Substitution is inhibited when the arg leaf's derived type isn't a
1392 ;;; subtype of the argument's leaf type. This prevents type checking
1393 ;;; from being defeated, and also ensures that the best representation
1394 ;;; for the variable can be used.
1395 ;;;
1396 ;;; Substitution of individual references is inhibited if the
1397 ;;; reference is in a different component from the home. This can only
1398 ;;; happen with closures over top level lambda vars. In such cases,
1399 ;;; the references may have already been compiled, and thus can't be
1400 ;;; retroactively modified.
1401 ;;;
1402 ;;; If all of the variables are deleted (have no references) when we
1403 ;;; are done, then we delete the LET.
1404 ;;;
1405 ;;; Note that we are responsible for clearing the LVAR-REOPTIMIZE
1406 ;;; flags.
1407 (defun propagate-let-args (call fun)
1408   (declare (type combination call) (type clambda fun))
1409   (loop for arg in (combination-args call)
1410         and var in (lambda-vars fun) do
1411     (when (and arg (lvar-reoptimize arg))
1412       (setf (lvar-reoptimize arg) nil)
1413       (cond
1414         ((lambda-var-sets var)
1415          (propagate-from-sets var (lvar-type arg)))
1416         ((let ((use (lvar-uses arg)))
1417            (when (ref-p use)
1418              (let ((leaf (ref-leaf use)))
1419                (when (and (constant-reference-p use)
1420                           (csubtypep (leaf-type leaf)
1421                                      ;; (NODE-DERIVED-TYPE USE) would
1422                                      ;; be better -- APD, 2003-05-15
1423                                      (leaf-type var)))
1424                  (propagate-to-refs var (lvar-type arg))
1425                  (let ((use-component (node-component use)))
1426                    (prog1 (substitute-leaf-if
1427                            (lambda (ref)
1428                              (cond ((eq (node-component ref) use-component)
1429                                     t)
1430                                    (t
1431                                     (aver (lambda-toplevelish-p (lambda-home fun)))
1432                                     nil)))
1433                            leaf var)))
1434                  t)))))
1435         ((and (null (rest (leaf-refs var)))
1436               (substitute-single-use-lvar arg var)))
1437         (t
1438          (propagate-to-refs var (lvar-type arg))))))
1439
1440   (when (every #'not (combination-args call))
1441     (delete-let fun))
1442
1443   (values))
1444
1445 ;;; This function is called when one of the args to a non-LET local
1446 ;;; call changes. For each changed argument corresponding to an unset
1447 ;;; variable, we compute the union of the types across all calls and
1448 ;;; propagate this type information to the var's refs.
1449 ;;;
1450 ;;; If the function has an XEP, then we don't do anything, since we
1451 ;;; won't discover anything.
1452 ;;;
1453 ;;; We can clear the LVAR-REOPTIMIZE flags for arguments in all calls
1454 ;;; corresponding to changed arguments in CALL, since the only use in
1455 ;;; IR1 optimization of the REOPTIMIZE flag for local call args is
1456 ;;; right here.
1457 (defun propagate-local-call-args (call fun)
1458   (declare (type combination call) (type clambda fun))
1459
1460   (unless (or (functional-entry-fun fun)
1461               (lambda-optional-dispatch fun))
1462     (let* ((vars (lambda-vars fun))
1463            (union (mapcar (lambda (arg var)
1464                             (when (and arg
1465                                        (lvar-reoptimize arg)
1466                                        (null (basic-var-sets var)))
1467                               (lvar-type arg)))
1468                           (basic-combination-args call)
1469                           vars))
1470            (this-ref (lvar-use (basic-combination-fun call))))
1471
1472       (dolist (arg (basic-combination-args call))
1473         (when arg
1474           (setf (lvar-reoptimize arg) nil)))
1475
1476       (dolist (ref (leaf-refs fun))
1477         (let ((dest (node-dest ref)))
1478           (unless (or (eq ref this-ref) (not dest))
1479             (setq union
1480                   (mapcar (lambda (this-arg old)
1481                             (when old
1482                               (setf (lvar-reoptimize this-arg) nil)
1483                               (type-union (lvar-type this-arg) old)))
1484                           (basic-combination-args dest)
1485                           union)))))
1486
1487       (loop for var in vars
1488             and type in union
1489             when type do (propagate-to-refs var type))))
1490
1491   (values))
1492 \f
1493 ;;;; multiple values optimization
1494
1495 ;;; Do stuff to notice a change to a MV combination node. There are
1496 ;;; two main branches here:
1497 ;;;  -- If the call is local, then it is already a MV let, or should
1498 ;;;     become one. Note that although all :LOCAL MV calls must eventually
1499 ;;;     be converted to :MV-LETs, there can be a window when the call
1500 ;;;     is local, but has not been LET converted yet. This is because
1501 ;;;     the entry-point lambdas may have stray references (in other
1502 ;;;     entry points) that have not been deleted yet.
1503 ;;;  -- The call is full. This case is somewhat similar to the non-MV
1504 ;;;     combination optimization: we propagate return type information and
1505 ;;;     notice non-returning calls. We also have an optimization
1506 ;;;     which tries to convert MV-CALLs into MV-binds.
1507 (defun ir1-optimize-mv-combination (node)
1508   (ecase (basic-combination-kind node)
1509     (:local
1510      (let ((fun-lvar (basic-combination-fun node)))
1511        (when (lvar-reoptimize fun-lvar)
1512          (setf (lvar-reoptimize fun-lvar) nil)
1513          (maybe-let-convert (combination-lambda node))))
1514      (setf (lvar-reoptimize (first (basic-combination-args node))) nil)
1515      (when (eq (functional-kind (combination-lambda node)) :mv-let)
1516        (unless (convert-mv-bind-to-let node)
1517          (ir1-optimize-mv-bind node))))
1518     (:full
1519      (let* ((fun (basic-combination-fun node))
1520             (fun-changed (lvar-reoptimize fun))
1521             (args (basic-combination-args node)))
1522        (when fun-changed
1523          (setf (lvar-reoptimize fun) nil)
1524          (let ((type (lvar-type fun)))
1525            (when (fun-type-p type)
1526              (derive-node-type node (fun-type-returns type))))
1527          (maybe-terminate-block node nil)
1528          (let ((use (lvar-uses fun)))
1529            (when (and (ref-p use) (functional-p (ref-leaf use)))
1530              (convert-call-if-possible use node)
1531              (when (eq (basic-combination-kind node) :local)
1532                (maybe-let-convert (ref-leaf use))))))
1533        (unless (or (eq (basic-combination-kind node) :local)
1534                    (eq (lvar-fun-name fun) '%throw))
1535          (ir1-optimize-mv-call node))
1536        (dolist (arg args)
1537          (setf (lvar-reoptimize arg) nil))))
1538     (:error))
1539   (values))
1540
1541 ;;; Propagate derived type info from the values lvar to the vars.
1542 (defun ir1-optimize-mv-bind (node)
1543   (declare (type mv-combination node))
1544   (let* ((arg (first (basic-combination-args node)))
1545          (vars (lambda-vars (combination-lambda node)))
1546          (n-vars (length vars))
1547          (types (values-type-in (lvar-derived-type arg)
1548                                 n-vars)))
1549     (loop for var in vars
1550           and type in types
1551           do (if (basic-var-sets var)
1552                  (propagate-from-sets var type)
1553                  (propagate-to-refs var type)))
1554     (setf (lvar-reoptimize arg) nil))
1555   (values))
1556
1557 ;;; If possible, convert a general MV call to an MV-BIND. We can do
1558 ;;; this if:
1559 ;;; -- The call has only one argument, and
1560 ;;; -- The function has a known fixed number of arguments, or
1561 ;;; -- The argument yields a known fixed number of values.
1562 ;;;
1563 ;;; What we do is change the function in the MV-CALL to be a lambda
1564 ;;; that "looks like an MV bind", which allows
1565 ;;; IR1-OPTIMIZE-MV-COMBINATION to notice that this call can be
1566 ;;; converted (the next time around.) This new lambda just calls the
1567 ;;; actual function with the MV-BIND variables as arguments. Note that
1568 ;;; this new MV bind is not let-converted immediately, as there are
1569 ;;; going to be stray references from the entry-point functions until
1570 ;;; they get deleted.
1571 ;;;
1572 ;;; In order to avoid loss of argument count checking, we only do the
1573 ;;; transformation according to a known number of expected argument if
1574 ;;; safety is unimportant. We can always convert if we know the number
1575 ;;; of actual values, since the normal call that we build will still
1576 ;;; do any appropriate argument count checking.
1577 ;;;
1578 ;;; We only attempt the transformation if the called function is a
1579 ;;; constant reference. This allows us to just splice the leaf into
1580 ;;; the new function, instead of trying to somehow bind the function
1581 ;;; expression. The leaf must be constant because we are evaluating it
1582 ;;; again in a different place. This also has the effect of squelching
1583 ;;; multiple warnings when there is an argument count error.
1584 (defun ir1-optimize-mv-call (node)
1585   (let ((fun (basic-combination-fun node))
1586         (*compiler-error-context* node)
1587         (ref (lvar-uses (basic-combination-fun node)))
1588         (args (basic-combination-args node)))
1589
1590     (unless (and (ref-p ref) (constant-reference-p ref)
1591                  (singleton-p args))
1592       (return-from ir1-optimize-mv-call))
1593
1594     (multiple-value-bind (min max)
1595         (fun-type-nargs (lvar-type fun))
1596       (let ((total-nvals
1597              (multiple-value-bind (types nvals)
1598                  (values-types (lvar-derived-type (first args)))
1599                (declare (ignore types))
1600                (if (eq nvals :unknown) nil nvals))))
1601
1602         (when total-nvals
1603           (when (and min (< total-nvals min))
1604             (compiler-warn
1605              "MULTIPLE-VALUE-CALL with ~R values when the function expects ~
1606               at least ~R."
1607              total-nvals min)
1608             (setf (basic-combination-kind node) :error)
1609             (return-from ir1-optimize-mv-call))
1610           (when (and max (> total-nvals max))
1611             (compiler-warn
1612              "MULTIPLE-VALUE-CALL with ~R values when the function expects ~
1613               at most ~R."
1614              total-nvals max)
1615             (setf (basic-combination-kind node) :error)
1616             (return-from ir1-optimize-mv-call)))
1617
1618         (let ((count (cond (total-nvals)
1619                            ((and (policy node (zerop verify-arg-count))
1620                                  (eql min max))
1621                             min)
1622                            (t nil))))
1623           (when count
1624             (with-ir1-environment-from-node node
1625               (let* ((dums (make-gensym-list count))
1626                      (ignore (gensym))
1627                      (fun (ir1-convert-lambda
1628                            `(lambda (&optional ,@dums &rest ,ignore)
1629                               (declare (ignore ,ignore))
1630                               (funcall ,(ref-leaf ref) ,@dums)))))
1631                 (change-ref-leaf ref fun)
1632                 (aver (eq (basic-combination-kind node) :full))
1633                 (locall-analyze-component *current-component*)
1634                 (aver (eq (basic-combination-kind node) :local)))))))))
1635   (values))
1636
1637 ;;; If we see:
1638 ;;;    (multiple-value-bind
1639 ;;;     (x y)
1640 ;;;     (values xx yy)
1641 ;;;      ...)
1642 ;;; Convert to:
1643 ;;;    (let ((x xx)
1644 ;;;       (y yy))
1645 ;;;      ...)
1646 ;;;
1647 ;;; What we actually do is convert the VALUES combination into a
1648 ;;; normal LET combination calling the original :MV-LET lambda. If
1649 ;;; there are extra args to VALUES, discard the corresponding
1650 ;;; lvars. If there are insufficient args, insert references to NIL.
1651 (defun convert-mv-bind-to-let (call)
1652   (declare (type mv-combination call))
1653   (let* ((arg (first (basic-combination-args call)))
1654          (use (lvar-uses arg)))
1655     (when (and (combination-p use)
1656                (eq (lvar-fun-name (combination-fun use))
1657                    'values))
1658       (let* ((fun (combination-lambda call))
1659              (vars (lambda-vars fun))
1660              (vals (combination-args use))
1661              (nvars (length vars))
1662              (nvals (length vals)))
1663         (cond ((> nvals nvars)
1664                (mapc #'flush-dest (subseq vals nvars))
1665                (setq vals (subseq vals 0 nvars)))
1666               ((< nvals nvars)
1667                (with-ir1-environment-from-node use
1668                  (let ((node-prev (node-prev use)))
1669                    (setf (node-prev use) nil)
1670                    (setf (ctran-next node-prev) nil)
1671                    (collect ((res vals))
1672                      (loop for count below (- nvars nvals)
1673                            for prev = node-prev then ctran
1674                            for ctran = (make-ctran)
1675                            and lvar = (make-lvar use)
1676                            do (reference-constant prev ctran lvar nil)
1677                               (res lvar)
1678                            finally (link-node-to-previous-ctran
1679                                     use ctran))
1680                      (setq vals (res)))))))
1681         (setf (combination-args use) vals)
1682         (flush-dest (combination-fun use))
1683         (let ((fun-lvar (basic-combination-fun call)))
1684           (setf (lvar-dest fun-lvar) use)
1685           (setf (combination-fun use) fun-lvar)
1686           (flush-lvar-externally-checkable-type fun-lvar))
1687         (setf (combination-kind use) :local)
1688         (setf (functional-kind fun) :let)
1689         (flush-dest (first (basic-combination-args call)))
1690         (unlink-node call)
1691         (when vals
1692           (reoptimize-lvar (first vals)))
1693         (propagate-to-args use fun)
1694         (reoptimize-call use))
1695       t)))
1696
1697 ;;; If we see:
1698 ;;;    (values-list (list x y z))
1699 ;;;
1700 ;;; Convert to:
1701 ;;;    (values x y z)
1702 ;;;
1703 ;;; In implementation, this is somewhat similar to
1704 ;;; CONVERT-MV-BIND-TO-LET. We grab the args of LIST and make them
1705 ;;; args of the VALUES-LIST call, flushing the old argument lvar
1706 ;;; (allowing the LIST to be flushed.)
1707 ;;;
1708 ;;; FIXME: Thus we lose possible type assertions on (LIST ...).
1709 (defoptimizer (values-list optimizer) ((list) node)
1710   (let ((use (lvar-uses list)))
1711     (when (and (combination-p use)
1712                (eq (lvar-fun-name (combination-fun use))
1713                    'list))
1714
1715       ;; FIXME: VALUES might not satisfy an assertion on NODE-LVAR.
1716       (change-ref-leaf (lvar-uses (combination-fun node))
1717                        (find-free-fun 'values "in a strange place"))
1718       (setf (combination-kind node) :full)
1719       (let ((args (combination-args use)))
1720         (dolist (arg args)
1721           (setf (lvar-dest arg) node)
1722           (flush-lvar-externally-checkable-type arg))
1723         (setf (combination-args use) nil)
1724         (flush-dest list)
1725         (setf (combination-args node) args))
1726       t)))
1727
1728 ;;; If VALUES appears in a non-MV context, then effectively convert it
1729 ;;; to a PROG1. This allows the computation of the additional values
1730 ;;; to become dead code.
1731 (deftransform values ((&rest vals) * * :node node)
1732   (unless (lvar-single-value-p (node-lvar node))
1733     (give-up-ir1-transform))
1734   (setf (node-derived-type node)
1735         (make-short-values-type (list (single-value-type
1736                                        (node-derived-type node)))))
1737   (principal-lvar-single-valuify (node-lvar node))
1738   (if vals
1739       (let ((dummies (make-gensym-list (length (cdr vals)))))
1740         `(lambda (val ,@dummies)
1741            (declare (ignore ,@dummies))
1742            val))
1743       nil))
1744
1745 ;;; TODO:
1746 ;;; - CAST chains;
1747 (defun ir1-optimize-cast (cast &optional do-not-optimize)
1748   (declare (type cast cast))
1749   (let ((value (cast-value cast))
1750         (atype (cast-asserted-type cast)))
1751     (when (not do-not-optimize)
1752       (let ((lvar (node-lvar cast)))
1753         (when (values-subtypep (lvar-derived-type value)
1754                                (cast-asserted-type cast))
1755           (delete-filter cast lvar value)
1756           (when lvar
1757             (reoptimize-lvar lvar)
1758             (when (lvar-single-value-p lvar)
1759               (note-single-valuified-lvar lvar)))
1760           (return-from ir1-optimize-cast t))
1761
1762         (when (and (listp (lvar-uses value))
1763                    lvar)
1764           ;; Pathwise removing of CAST
1765           (let ((ctran (node-next cast))
1766                 (dest (lvar-dest lvar))
1767                 next-block)
1768             (collect ((merges))
1769               (do-uses (use value)
1770                 (when (and (values-subtypep (node-derived-type use) atype)
1771                            (immediately-used-p value use))
1772                   (unless next-block
1773                     (when ctran (ensure-block-start ctran))
1774                     (setq next-block (first (block-succ (node-block cast))))
1775                     (ensure-block-start (node-prev cast))
1776                     (reoptimize-lvar lvar)
1777                     (setf (lvar-%derived-type value) nil))
1778                   (%delete-lvar-use use)
1779                   (add-lvar-use use lvar)
1780                   (unlink-blocks (node-block use) (node-block cast))
1781                   (link-blocks (node-block use) next-block)
1782                   (when (and (return-p dest)
1783                              (basic-combination-p use)
1784                              (eq (basic-combination-kind use) :local))
1785                     (merges use))))
1786               (dolist (use (merges))
1787                 (merge-tail-sets use)))))))
1788
1789     (let* ((value-type (lvar-derived-type value))
1790            (int (values-type-intersection value-type atype)))
1791       (derive-node-type cast int)
1792       (when (eq int *empty-type*)
1793         (unless (eq value-type *empty-type*)
1794
1795           ;; FIXME: Do it in one step.
1796           (filter-lvar
1797            value
1798            (if (cast-single-value-p cast)
1799                `(list 'dummy)
1800                `(multiple-value-call #'list 'dummy)))
1801           (filter-lvar
1802            (cast-value cast)
1803            ;; FIXME: Derived type.
1804            `(%compile-time-type-error 'dummy
1805                                       ',(type-specifier atype)
1806                                       ',(type-specifier value-type)))
1807           ;; KLUDGE: FILTER-LVAR does not work for non-returning
1808           ;; functions, so we declare the return type of
1809           ;; %COMPILE-TIME-TYPE-ERROR to be * and derive the real type
1810           ;; here.
1811           (setq value (cast-value cast))
1812           (derive-node-type (lvar-uses value) *empty-type*)
1813           (maybe-terminate-block (lvar-uses value) nil)
1814           ;; FIXME: Is it necessary?
1815           (aver (null (block-pred (node-block cast))))
1816           (delete-block-lazily (node-block cast))
1817           (return-from ir1-optimize-cast)))
1818       (when (eq (node-derived-type cast) *empty-type*)
1819         (maybe-terminate-block cast nil))
1820
1821       (when (and (cast-%type-check cast)
1822                  (values-subtypep value-type
1823                                   (cast-type-to-check cast)))
1824         (setf (cast-%type-check cast) nil))))
1825
1826   (unless do-not-optimize
1827     (setf (node-reoptimize cast) nil)))