0.9.10.26
[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 (defun check-important-result (node info)
641   (when (and (null (node-lvar node))
642              (ir1-attributep (fun-info-attributes info) important-result))
643     (let ((*compiler-error-context* node))
644       (compiler-style-warn
645        "The return value of ~A should not be discarded."
646        (lvar-fun-name (basic-combination-fun node))))))
647
648 ;;; Do IR1 optimizations on a COMBINATION node.
649 (declaim (ftype (function (combination) (values)) ir1-optimize-combination))
650 (defun ir1-optimize-combination (node)
651   (when (lvar-reoptimize (basic-combination-fun node))
652     (propagate-fun-change node)
653     (maybe-terminate-block node nil))
654   (let ((args (basic-combination-args node))
655         (kind (basic-combination-kind node))
656         (info (basic-combination-fun-info node)))
657     (ecase kind
658       (:local
659        (let ((fun (combination-lambda node)))
660          (if (eq (functional-kind fun) :let)
661              (propagate-let-args node fun)
662              (propagate-local-call-args node fun))))
663       (:error
664        (dolist (arg args)
665          (when arg
666            (setf (lvar-reoptimize arg) nil))))
667       (:full
668        (dolist (arg args)
669          (when arg
670            (setf (lvar-reoptimize arg) nil)))
671        (when info
672          (check-important-result node info)
673          (let ((fun (fun-info-destroyed-constant-args info)))
674            (when fun
675              (let ((destroyed-constant-args (funcall fun args)))
676                (when destroyed-constant-args
677                  (let ((*compiler-error-context* node))
678                    (warn 'constant-modified
679                          :fun-name (lvar-fun-name
680                                     (basic-combination-fun node)))
681                    (setf (basic-combination-kind node) :error)
682                    (return-from ir1-optimize-combination))))))
683          (let ((fun (fun-info-derive-type info)))
684            (when fun
685              (let ((res (funcall fun node)))
686                (when res
687                  (derive-node-type node (coerce-to-values res))
688                  (maybe-terminate-block node nil)))))))
689       (:known
690        (aver info)
691        (dolist (arg args)
692          (when arg
693            (setf (lvar-reoptimize arg) nil)))
694        (check-important-result node info)
695        (let ((fun (fun-info-destroyed-constant-args info)))
696          (when fun
697            (let ((destroyed-constant-args (funcall fun args)))
698              (when destroyed-constant-args
699                (let ((*compiler-error-context* node))
700                  (warn 'constant-modified
701                        :fun-name (lvar-fun-name
702                                   (basic-combination-fun node)))
703                  (setf (basic-combination-kind node) :error)
704                  (return-from ir1-optimize-combination))))))
705
706        (let ((attr (fun-info-attributes info)))
707          (when (and (ir1-attributep attr foldable)
708                     ;; KLUDGE: The next test could be made more sensitive,
709                     ;; only suppressing constant-folding of functions with
710                     ;; CALL attributes when they're actually passed
711                     ;; function arguments. -- WHN 19990918
712                     (not (ir1-attributep attr call))
713                     (every #'constant-lvar-p args)
714                     (node-lvar node))
715            (constant-fold-call node)
716            (return-from ir1-optimize-combination)))
717
718        (let ((fun (fun-info-derive-type info)))
719          (when fun
720            (let ((res (funcall fun node)))
721              (when res
722                (derive-node-type node (coerce-to-values res))
723                (maybe-terminate-block node nil)))))
724
725        (let ((fun (fun-info-optimizer info)))
726          (unless (and fun (funcall fun node))
727            ;; First give the VM a peek at the call
728            (multiple-value-bind (style transform)
729                (combination-implementation-style node)
730              (ecase style
731                (:direct
732                 ;; The VM knows how to handle this.
733                 )
734                (:transform
735                 ;; The VM mostly knows how to handle this.  We need
736                 ;; to massage the call slightly, though.
737                 (transform-call node transform (combination-fun-source-name node)))
738                (:default
739                 ;; Let transforms have a crack at it.
740                 (dolist (x (fun-info-transforms info))
741                   #!+sb-show
742                   (when *show-transforms-p*
743                     (let* ((lvar (basic-combination-fun node))
744                            (fname (lvar-fun-name lvar t)))
745                       (/show "trying transform" x (transform-function x) "for" fname)))
746                   (unless (ir1-transform node x)
747                     #!+sb-show
748                     (when *show-transforms-p*
749                       (/show "quitting because IR1-TRANSFORM result was NIL"))
750                     (return)))))))))))
751
752   (values))
753
754 ;;; If NODE doesn't return (i.e. return type is NIL), then terminate
755 ;;; the block there, and link it to the component tail.
756 ;;;
757 ;;; Except when called during IR1 convertion, we delete the
758 ;;; continuation if it has no other uses. (If it does have other uses,
759 ;;; we reoptimize.)
760 ;;;
761 ;;; Termination on the basis of a continuation type is
762 ;;; inhibited when:
763 ;;; -- The continuation is deleted (hence the assertion is spurious), or
764 ;;; -- We are in IR1 conversion (where THE assertions are subject to
765 ;;;    weakening.) FIXME: Now THE assertions are not weakened, but new
766 ;;;    uses can(?) be added later. -- APD, 2003-07-17
767 ;;;
768 ;;; Why do we need to consider LVAR type? -- APD, 2003-07-30
769 (defun maybe-terminate-block (node ir1-converting-not-optimizing-p)
770   (declare (type (or basic-combination cast ref) node))
771   (let* ((block (node-block node))
772          (lvar (node-lvar node))
773          (ctran (node-next node))
774          (tail (component-tail (block-component block)))
775          (succ (first (block-succ block))))
776     (declare (ignore lvar))
777     (unless (or (and (eq node (block-last block)) (eq succ tail))
778                 (block-delete-p block))
779       (when (eq (node-derived-type node) *empty-type*)
780         (cond (ir1-converting-not-optimizing-p
781                (cond
782                  ((block-last block)
783                   (aver (eq (block-last block) node)))
784                  (t
785                   (setf (block-last block) node)
786                   (setf (ctran-use ctran) nil)
787                   (setf (ctran-kind ctran) :unused)
788                   (setf (ctran-block ctran) nil)
789                   (setf (node-next node) nil)
790                   (link-blocks block (ctran-starts-block ctran)))))
791               (t
792                (node-ends-block node)))
793
794         (let ((succ (first (block-succ block))))
795           (unlink-blocks block succ)
796           (setf (component-reanalyze (block-component block)) t)
797           (aver (not (block-succ block)))
798           (link-blocks block tail)
799           (cond (ir1-converting-not-optimizing-p
800                  (%delete-lvar-use node))
801                 (t (delete-lvar-use node)
802                    (when (null (block-pred succ))
803                      (mark-for-deletion succ)))))
804         t))))
805
806 ;;; This is called both by IR1 conversion and IR1 optimization when
807 ;;; they have verified the type signature for the call, and are
808 ;;; wondering if something should be done to special-case the call. If
809 ;;; CALL is a call to a global function, then see whether it defined
810 ;;; or known:
811 ;;; -- If a DEFINED-FUN should be inline expanded, then convert
812 ;;;    the expansion and change the call to call it. Expansion is
813 ;;;    enabled if :INLINE or if SPACE=0. If the FUNCTIONAL slot is
814 ;;;    true, we never expand, since this function has already been
815 ;;;    converted. Local call analysis will duplicate the definition
816 ;;;    if necessary. We claim that the parent form is LABELS for
817 ;;;    context declarations, since we don't want it to be considered
818 ;;;    a real global function.
819 ;;; -- If it is a known function, mark it as such by setting the KIND.
820 ;;;
821 ;;; We return the leaf referenced (NIL if not a leaf) and the
822 ;;; FUN-INFO assigned.
823 (defun recognize-known-call (call ir1-converting-not-optimizing-p)
824   (declare (type combination call))
825   (let* ((ref (lvar-uses (basic-combination-fun call)))
826          (leaf (when (ref-p ref) (ref-leaf ref)))
827          (inlinep (if (defined-fun-p leaf)
828                       (defined-fun-inlinep leaf)
829                       :no-chance)))
830     (cond
831      ((eq inlinep :notinline)
832       (let ((info (info :function :info (leaf-source-name leaf))))
833         (when info
834           (setf (basic-combination-fun-info call) info))
835         (values nil nil)))
836      ((not (and (global-var-p leaf)
837                 (eq (global-var-kind leaf) :global-function)))
838       (values leaf nil))
839      ((and (ecase inlinep
840              (:inline t)
841              (:no-chance nil)
842              ((nil :maybe-inline) (policy call (zerop space))))
843            (defined-fun-p leaf)
844            (defined-fun-inline-expansion leaf)
845            (let ((fun (defined-fun-functional leaf)))
846              (or (not fun)
847                  (and (eq inlinep :inline) (functional-kind fun))))
848            (inline-expansion-ok call))
849       (flet (;; FIXME: Is this what the old CMU CL internal documentation
850              ;; called semi-inlining? A more descriptive name would
851              ;; be nice. -- WHN 2002-01-07
852              (frob ()
853                (let ((res (let ((*allow-instrumenting* t))
854                             (ir1-convert-lambda-for-defun
855                              (defined-fun-inline-expansion leaf)
856                              leaf t
857                              #'ir1-convert-inline-lambda))))
858                  (setf (defined-fun-functional leaf) res)
859                  (change-ref-leaf ref res))))
860         (if ir1-converting-not-optimizing-p
861             (frob)
862             (with-ir1-environment-from-node call
863               (frob)
864               (locall-analyze-component *current-component*))))
865
866       (values (ref-leaf (lvar-uses (basic-combination-fun call)))
867               nil))
868      (t
869       (let ((info (info :function :info (leaf-source-name leaf))))
870         (if info
871             (values leaf
872                     (progn
873                       (setf (basic-combination-kind call) :known)
874                       (setf (basic-combination-fun-info call) info)))
875             (values leaf nil)))))))
876
877 ;;; Check whether CALL satisfies TYPE. If so, apply the type to the
878 ;;; call, and do MAYBE-TERMINATE-BLOCK and return the values of
879 ;;; RECOGNIZE-KNOWN-CALL. If an error, set the combination kind and
880 ;;; return NIL, NIL. If the type is just FUNCTION, then skip the
881 ;;; syntax check, arg/result type processing, but still call
882 ;;; RECOGNIZE-KNOWN-CALL, since the call might be to a known lambda,
883 ;;; and that checking is done by local call analysis.
884 (defun validate-call-type (call type ir1-converting-not-optimizing-p)
885   (declare (type combination call) (type ctype type))
886   (cond ((not (fun-type-p type))
887          (aver (multiple-value-bind (val win)
888                    (csubtypep type (specifier-type 'function))
889                  (or val (not win))))
890          (recognize-known-call call ir1-converting-not-optimizing-p))
891         ((valid-fun-use call type
892                         :argument-test #'always-subtypep
893                         :result-test nil
894                         ;; KLUDGE: Common Lisp is such a dynamic
895                         ;; language that all we can do here in
896                         ;; general is issue a STYLE-WARNING. It
897                         ;; would be nice to issue a full WARNING
898                         ;; in the special case of of type
899                         ;; mismatches within a compilation unit
900                         ;; (as in section 3.2.2.3 of the spec)
901                         ;; but at least as of sbcl-0.6.11, we
902                         ;; don't keep track of whether the
903                         ;; mismatched data came from the same
904                         ;; compilation unit, so we can't do that.
905                         ;; -- WHN 2001-02-11
906                         ;;
907                         ;; FIXME: Actually, I think we could
908                         ;; issue a full WARNING if the call
909                         ;; violates a DECLAIM FTYPE.
910                         :lossage-fun #'compiler-style-warn
911                         :unwinnage-fun #'compiler-notify)
912          (assert-call-type call type)
913          (maybe-terminate-block call ir1-converting-not-optimizing-p)
914          (recognize-known-call call ir1-converting-not-optimizing-p))
915         (t
916          (setf (combination-kind call) :error)
917          (values nil nil))))
918
919 ;;; This is called by IR1-OPTIMIZE when the function for a call has
920 ;;; changed. If the call is local, we try to LET-convert it, and
921 ;;; derive the result type. If it is a :FULL call, we validate it
922 ;;; against the type, which recognizes known calls, does inline
923 ;;; expansion, etc. If a call to a predicate in a non-conditional
924 ;;; position or to a function with a source transform, then we
925 ;;; reconvert the form to give IR1 another chance.
926 (defun propagate-fun-change (call)
927   (declare (type combination call))
928   (let ((*compiler-error-context* call)
929         (fun-lvar (basic-combination-fun call)))
930     (setf (lvar-reoptimize fun-lvar) nil)
931     (case (combination-kind call)
932       (:local
933        (let ((fun (combination-lambda call)))
934          (maybe-let-convert fun)
935          (unless (member (functional-kind fun) '(:let :assignment :deleted))
936            (derive-node-type call (tail-set-type (lambda-tail-set fun))))))
937       (:full
938        (multiple-value-bind (leaf info)
939            (validate-call-type call (lvar-type fun-lvar) nil)
940          (cond ((functional-p leaf)
941                 (convert-call-if-possible
942                  (lvar-uses (basic-combination-fun call))
943                  call))
944                ((not leaf))
945                ((and (global-var-p leaf)
946                      (eq (global-var-kind leaf) :global-function)
947                      (leaf-has-source-name-p leaf)
948                      (or (info :function :source-transform (leaf-source-name leaf))
949                          (and info
950                               (ir1-attributep (fun-info-attributes info)
951                                               predicate)
952                               (let ((lvar (node-lvar call)))
953                                 (and lvar (not (if-p (lvar-dest lvar))))))))
954                 (let ((name (leaf-source-name leaf))
955                       (dummies (make-gensym-list
956                                 (length (combination-args call)))))
957                   (transform-call call
958                                   `(lambda ,dummies
959                                      (,@(if (symbolp name)
960                                             `(,name)
961                                             `(funcall #',name))
962                                         ,@dummies))
963                                   (leaf-source-name leaf)))))))))
964   (values))
965 \f
966 ;;;; known function optimization
967
968 ;;; Add a failed optimization note to FAILED-OPTIMZATIONS for NODE,
969 ;;; FUN and ARGS. If there is already a note for NODE and TRANSFORM,
970 ;;; replace it, otherwise add a new one.
971 (defun record-optimization-failure (node transform args)
972   (declare (type combination node) (type transform transform)
973            (type (or fun-type list) args))
974   (let* ((table (component-failed-optimizations *component-being-compiled*))
975          (found (assoc transform (gethash node table))))
976     (if found
977         (setf (cdr found) args)
978         (push (cons transform args) (gethash node table))))
979   (values))
980
981 ;;; Attempt to transform NODE using TRANSFORM-FUNCTION, subject to the
982 ;;; call type constraint TRANSFORM-TYPE. If we are inhibited from
983 ;;; doing the transform for some reason and FLAME is true, then we
984 ;;; make a note of the message in FAILED-OPTIMIZATIONS for IR1
985 ;;; finalize to pick up. We return true if the transform failed, and
986 ;;; thus further transformation should be attempted. We return false
987 ;;; if either the transform succeeded or was aborted.
988 (defun ir1-transform (node transform)
989   (declare (type combination node) (type transform transform))
990   (let* ((type (transform-type transform))
991          (fun (transform-function transform))
992          (constrained (fun-type-p type))
993          (table (component-failed-optimizations *component-being-compiled*))
994          (flame (if (transform-important transform)
995                     (policy node (>= speed inhibit-warnings))
996                     (policy node (> speed inhibit-warnings))))
997          (*compiler-error-context* node))
998     (cond ((or (not constrained)
999                (valid-fun-use node type))
1000            (multiple-value-bind (severity args)
1001                (catch 'give-up-ir1-transform
1002                  (transform-call node
1003                                  (funcall fun node)
1004                                  (combination-fun-source-name node))
1005                  (values :none nil))
1006              (ecase severity
1007                (:none
1008                 (remhash node table)
1009                 nil)
1010                (:aborted
1011                 (setf (combination-kind node) :error)
1012                 (when args
1013                   (apply #'warn args))
1014                 (remhash node table)
1015                 nil)
1016                (:failure
1017                 (if args
1018                     (when flame
1019                       (record-optimization-failure node transform args))
1020                     (setf (gethash node table)
1021                           (remove transform (gethash node table) :key #'car)))
1022                 t)
1023                (:delayed
1024                  (remhash node table)
1025                  nil))))
1026           ((and flame
1027                 (valid-fun-use node
1028                                type
1029                                :argument-test #'types-equal-or-intersect
1030                                :result-test #'values-types-equal-or-intersect))
1031            (record-optimization-failure node transform type)
1032            t)
1033           (t
1034            t))))
1035
1036 ;;; When we don't like an IR1 transform, we throw the severity/reason
1037 ;;; and args.
1038 ;;;
1039 ;;; GIVE-UP-IR1-TRANSFORM is used to throw out of an IR1 transform,
1040 ;;; aborting this attempt to transform the call, but admitting the
1041 ;;; possibility that this or some other transform will later succeed.
1042 ;;; If arguments are supplied, they are format arguments for an
1043 ;;; efficiency note.
1044 ;;;
1045 ;;; ABORT-IR1-TRANSFORM is used to throw out of an IR1 transform and
1046 ;;; force a normal call to the function at run time. No further
1047 ;;; optimizations will be attempted.
1048 ;;;
1049 ;;; DELAY-IR1-TRANSFORM is used to throw out of an IR1 transform, and
1050 ;;; delay the transform on the node until later. REASONS specifies
1051 ;;; when the transform will be later retried. The :OPTIMIZE reason
1052 ;;; causes the transform to be delayed until after the current IR1
1053 ;;; optimization pass. The :CONSTRAINT reason causes the transform to
1054 ;;; be delayed until after constraint propagation.
1055 ;;;
1056 ;;; FIXME: Now (0.6.11.44) that there are 4 variants of this (GIVE-UP,
1057 ;;; ABORT, DELAY/:OPTIMIZE, DELAY/:CONSTRAINT) and we're starting to
1058 ;;; do CASE operations on the various REASON values, it might be a
1059 ;;; good idea to go OO, representing the reasons by objects, using
1060 ;;; CLOS methods on the objects instead of CASE, and (possibly) using
1061 ;;; SIGNAL instead of THROW.
1062 (declaim (ftype (function (&rest t) nil) give-up-ir1-transform))
1063 (defun give-up-ir1-transform (&rest args)
1064   (throw 'give-up-ir1-transform (values :failure args)))
1065 (defun abort-ir1-transform (&rest args)
1066   (throw 'give-up-ir1-transform (values :aborted args)))
1067 (defun delay-ir1-transform (node &rest reasons)
1068   (let ((assoc (assoc node *delayed-ir1-transforms*)))
1069     (cond ((not assoc)
1070             (setf *delayed-ir1-transforms*
1071                     (acons node reasons *delayed-ir1-transforms*))
1072             (throw 'give-up-ir1-transform :delayed))
1073           ((cdr assoc)
1074             (dolist (reason reasons)
1075               (pushnew reason (cdr assoc)))
1076             (throw 'give-up-ir1-transform :delayed)))))
1077
1078 ;;; Clear any delayed transform with no reasons - these should have
1079 ;;; been tried in the last pass. Then remove the reason from the
1080 ;;; delayed transform reasons, and if any become empty then set
1081 ;;; reoptimize flags for the node. Return true if any transforms are
1082 ;;; to be retried.
1083 (defun retry-delayed-ir1-transforms (reason)
1084   (setf *delayed-ir1-transforms*
1085         (remove-if-not #'cdr *delayed-ir1-transforms*))
1086   (let ((reoptimize nil))
1087     (dolist (assoc *delayed-ir1-transforms*)
1088       (let ((reasons (remove reason (cdr assoc))))
1089         (setf (cdr assoc) reasons)
1090         (unless reasons
1091           (let ((node (car assoc)))
1092             (unless (node-deleted node)
1093               (setf reoptimize t)
1094               (setf (node-reoptimize node) t)
1095               (let ((block (node-block node)))
1096                 (setf (block-reoptimize block) t)
1097                 (reoptimize-component (block-component block) :maybe)))))))
1098     reoptimize))
1099
1100 ;;; Take the lambda-expression RES, IR1 convert it in the proper
1101 ;;; environment, and then install it as the function for the call
1102 ;;; NODE. We do local call analysis so that the new function is
1103 ;;; integrated into the control flow.
1104 ;;;
1105 ;;; We require the original function source name in order to generate
1106 ;;; a meaningful debug name for the lambda we set up. (It'd be
1107 ;;; possible to do this starting from debug names as well as source
1108 ;;; names, but as of sbcl-0.7.1.5, there was no need for this
1109 ;;; generality, since source names are always known to our callers.)
1110 (defun transform-call (call res source-name)
1111   (declare (type combination call) (list res))
1112   (aver (and (legal-fun-name-p source-name)
1113              (not (eql source-name '.anonymous.))))
1114   (node-ends-block call)
1115   (with-ir1-environment-from-node call
1116     (with-component-last-block (*current-component*
1117                                 (block-next (node-block call)))
1118       (let ((new-fun (ir1-convert-inline-lambda
1119                       res
1120                       :debug-name (debug-name 'lambda-inlined source-name)))
1121             (ref (lvar-use (combination-fun call))))
1122         (change-ref-leaf ref new-fun)
1123         (setf (combination-kind call) :full)
1124         (locall-analyze-component *current-component*))))
1125   (values))
1126
1127 ;;; Replace a call to a foldable function of constant arguments with
1128 ;;; the result of evaluating the form. If there is an error during the
1129 ;;; evaluation, we give a warning and leave the call alone, making the
1130 ;;; call a :ERROR call.
1131 ;;;
1132 ;;; If there is more than one value, then we transform the call into a
1133 ;;; VALUES form.
1134 (defun constant-fold-call (call)
1135   (let ((args (mapcar #'lvar-value (combination-args call)))
1136         (fun-name (combination-fun-source-name call)))
1137     (multiple-value-bind (values win)
1138         (careful-call fun-name
1139                       args
1140                       call
1141                       ;; Note: CMU CL had COMPILER-WARN here, and that
1142                       ;; seems more natural, but it's probably not.
1143                       ;;
1144                       ;; It's especially not while bug 173 exists:
1145                       ;; Expressions like
1146                       ;;   (COND (END
1147                       ;;          (UNLESS (OR UNSAFE? (<= END SIZE)))
1148                       ;;            ...))
1149                       ;; can cause constant-folding TYPE-ERRORs (in
1150                       ;; #'<=) when END can be proved to be NIL, even
1151                       ;; though the code is perfectly legal and safe
1152                       ;; because a NIL value of END means that the
1153                       ;; #'<= will never be executed.
1154                       ;;
1155                       ;; Moreover, even without bug 173,
1156                       ;; quite-possibly-valid code like
1157                       ;;   (COND ((NONINLINED-PREDICATE END)
1158                       ;;          (UNLESS (<= END SIZE))
1159                       ;;            ...))
1160                       ;; (where NONINLINED-PREDICATE is something the
1161                       ;; compiler can't do at compile time, but which
1162                       ;; turns out to make the #'<= expression
1163                       ;; unreachable when END=NIL) could cause errors
1164                       ;; when the compiler tries to constant-fold (<=
1165                       ;; END SIZE).
1166                       ;;
1167                       ;; So, with or without bug 173, it'd be
1168                       ;; unnecessarily evil to do a full
1169                       ;; COMPILER-WARNING (and thus return FAILURE-P=T
1170                       ;; from COMPILE-FILE) for legal code, so we we
1171                       ;; use a wimpier COMPILE-STYLE-WARNING instead.
1172                       #-sb-xc-host #'compiler-style-warn
1173                       ;; On the other hand, for code we control, we
1174                       ;; should be able to work around any bug
1175                       ;; 173-related problems, and in particular we
1176                       ;; want to be alerted to calls to our own
1177                       ;; functions which aren't being folded away; a
1178                       ;; COMPILER-WARNING is butch enough to stop the
1179                       ;; SBCL build itself in its tracks.
1180                       #+sb-xc-host #'compiler-warn
1181                       "constant folding")
1182       (cond ((not win)
1183              (setf (combination-kind call) :error))
1184             ((and (proper-list-of-length-p values 1))
1185              (with-ir1-environment-from-node call
1186                (let* ((lvar (node-lvar call))
1187                       (prev (node-prev call))
1188                       (intermediate-ctran (make-ctran)))
1189                  (%delete-lvar-use call)
1190                  (setf (ctran-next prev) nil)
1191                  (setf (node-prev call) nil)
1192                  (reference-constant prev intermediate-ctran lvar
1193                                      (first values))
1194                  (link-node-to-previous-ctran call intermediate-ctran)
1195                  (reoptimize-lvar lvar)
1196                  (flush-combination call))))
1197             (t (let ((dummies (make-gensym-list (length args))))
1198                  (transform-call
1199                   call
1200                   `(lambda ,dummies
1201                      (declare (ignore ,@dummies))
1202                      (values ,@(mapcar (lambda (x) `',x) values)))
1203                   fun-name))))))
1204   (values))
1205 \f
1206 ;;;; local call optimization
1207
1208 ;;; Propagate TYPE to LEAF and its REFS, marking things changed. If
1209 ;;; the leaf type is a function type, then just leave it alone, since
1210 ;;; TYPE is never going to be more specific than that (and
1211 ;;; TYPE-INTERSECTION would choke.)
1212 (defun propagate-to-refs (leaf type)
1213   (declare (type leaf leaf) (type ctype type))
1214   (let ((var-type (leaf-type leaf)))
1215     (unless (fun-type-p var-type)
1216       (let ((int (type-approx-intersection2 var-type type)))
1217         (when (type/= int var-type)
1218           (setf (leaf-type leaf) int)
1219           (dolist (ref (leaf-refs leaf))
1220             (derive-node-type ref (make-single-value-type int))
1221             ;; KLUDGE: LET var substitution
1222             (let* ((lvar (node-lvar ref)))
1223               (when (and lvar (combination-p (lvar-dest lvar)))
1224                 (reoptimize-lvar lvar))))))
1225       (values))))
1226
1227 ;;; Iteration variable: exactly one SETQ of the form:
1228 ;;;
1229 ;;; (let ((var initial))
1230 ;;;   ...
1231 ;;;   (setq var (+ var step))
1232 ;;;   ...)
1233 (defun maybe-infer-iteration-var-type (var initial-type)
1234   (binding* ((sets (lambda-var-sets var) :exit-if-null)
1235              (set (first sets))
1236              (() (null (rest sets)) :exit-if-null)
1237              (set-use (principal-lvar-use (set-value set)))
1238              (() (and (combination-p set-use)
1239                       (eq (combination-kind set-use) :known)
1240                       (fun-info-p (combination-fun-info set-use))
1241                       (not (node-to-be-deleted-p set-use))
1242                       (or (eq (combination-fun-source-name set-use) '+)
1243                           (eq (combination-fun-source-name set-use) '-)))
1244               :exit-if-null)
1245              (minusp (eq (combination-fun-source-name set-use) '-))
1246              (+-args (basic-combination-args set-use))
1247              (() (and (proper-list-of-length-p +-args 2 2)
1248                       (let ((first (principal-lvar-use
1249                                     (first +-args))))
1250                         (and (ref-p first)
1251                              (eq (ref-leaf first) var))))
1252               :exit-if-null)
1253              (step-type (lvar-type (second +-args)))
1254              (set-type (lvar-type (set-value set))))
1255     (when (and (numeric-type-p initial-type)
1256                (numeric-type-p step-type)
1257                (or (numeric-type-equal initial-type step-type)
1258                    ;; Detect cases like (LOOP FOR 1.0 to 5.0 ...), where
1259                    ;; the initial and the step are of different types,
1260                    ;; and the step is less contagious.
1261                    (numeric-type-equal initial-type
1262                                        (numeric-contagion initial-type
1263                                                           step-type))))
1264       (labels ((leftmost (x y cmp cmp=)
1265                  (cond ((eq x nil) nil)
1266                        ((eq y nil) nil)
1267                        ((listp x)
1268                         (let ((x1 (first x)))
1269                           (cond ((listp y)
1270                                  (let ((y1 (first y)))
1271                                    (if (funcall cmp x1 y1) x y)))
1272                                 (t
1273                                  (if (funcall cmp x1 y) x y)))))
1274                        ((listp y)
1275                         (let ((y1 (first y)))
1276                           (if (funcall cmp= x y1) x y)))
1277                        (t (if (funcall cmp x y) x y))))
1278                (max* (x y) (leftmost x y #'> #'>=))
1279                (min* (x y) (leftmost x y #'< #'<=)))
1280         (multiple-value-bind (low high)
1281             (let ((step-type-non-negative (csubtypep step-type (specifier-type
1282                                                                 '(real 0 *))))
1283                   (step-type-non-positive (csubtypep step-type (specifier-type
1284                                                                 '(real * 0)))))
1285               (cond ((or (and step-type-non-negative (not minusp))
1286                          (and step-type-non-positive minusp))
1287                      (values (numeric-type-low initial-type)
1288                              (when (and (numeric-type-p set-type)
1289                                         (numeric-type-equal set-type initial-type))
1290                                (max* (numeric-type-high initial-type)
1291                                      (numeric-type-high set-type)))))
1292                     ((or (and step-type-non-positive (not minusp))
1293                          (and step-type-non-negative minusp))
1294                      (values (when (and (numeric-type-p set-type)
1295                                         (numeric-type-equal set-type initial-type))
1296                                (min* (numeric-type-low initial-type)
1297                                      (numeric-type-low set-type)))
1298                              (numeric-type-high initial-type)))
1299                     (t
1300                      (values nil nil))))
1301           (modified-numeric-type initial-type
1302                                  :low low
1303                                  :high high
1304                                  :enumerable nil))))))
1305 (deftransform + ((x y) * * :result result)
1306   "check for iteration variable reoptimization"
1307   (let ((dest (principal-lvar-end result))
1308         (use (principal-lvar-use x)))
1309     (when (and (ref-p use)
1310                (set-p dest)
1311                (eq (ref-leaf use)
1312                    (set-var dest)))
1313       (reoptimize-lvar (set-value dest))))
1314   (give-up-ir1-transform))
1315
1316 ;;; Figure out the type of a LET variable that has sets. We compute
1317 ;;; the union of the INITIAL-TYPE and the types of all the set
1318 ;;; values and to a PROPAGATE-TO-REFS with this type.
1319 (defun propagate-from-sets (var initial-type)
1320   (collect ((res initial-type type-union))
1321     (dolist (set (basic-var-sets var))
1322       (let ((type (lvar-type (set-value set))))
1323         (res type)
1324         (when (node-reoptimize set)
1325           (derive-node-type set (make-single-value-type type))
1326           (setf (node-reoptimize set) nil))))
1327     (let ((res (res)))
1328       (awhen (maybe-infer-iteration-var-type var initial-type)
1329         (setq res it))
1330       (propagate-to-refs var res)))
1331   (values))
1332
1333 ;;; If a LET variable, find the initial value's type and do
1334 ;;; PROPAGATE-FROM-SETS. We also derive the VALUE's type as the node's
1335 ;;; type.
1336 (defun ir1-optimize-set (node)
1337   (declare (type cset node))
1338   (let ((var (set-var node)))
1339     (when (and (lambda-var-p var) (leaf-refs var))
1340       (let ((home (lambda-var-home var)))
1341         (when (eq (functional-kind home) :let)
1342           (let* ((initial-value (let-var-initial-value var))
1343                  (initial-type (lvar-type initial-value)))
1344             (setf (lvar-reoptimize initial-value) nil)
1345             (propagate-from-sets var initial-type))))))
1346
1347   (derive-node-type node (make-single-value-type
1348                           (lvar-type (set-value node))))
1349   (values))
1350
1351 ;;; Return true if the value of REF will always be the same (and is
1352 ;;; thus legal to substitute.)
1353 (defun constant-reference-p (ref)
1354   (declare (type ref ref))
1355   (let ((leaf (ref-leaf ref)))
1356     (typecase leaf
1357       ((or constant functional) t)
1358       (lambda-var
1359        (null (lambda-var-sets leaf)))
1360       (defined-fun
1361        (not (eq (defined-fun-inlinep leaf) :notinline)))
1362       (global-var
1363        (case (global-var-kind leaf)
1364          (:global-function
1365           (let ((name (leaf-source-name leaf)))
1366             (or #-sb-xc-host
1367                 (eq (symbol-package (fun-name-block-name name))
1368                     *cl-package*)
1369                 (info :function :info name)))))))))
1370
1371 ;;; If we have a non-set LET var with a single use, then (if possible)
1372 ;;; replace the variable reference's LVAR with the arg lvar.
1373 ;;;
1374 ;;; We change the REF to be a reference to NIL with unused value, and
1375 ;;; let it be flushed as dead code. A side effect of this substitution
1376 ;;; is to delete the variable.
1377 (defun substitute-single-use-lvar (arg var)
1378   (declare (type lvar arg) (type lambda-var var))
1379   (binding* ((ref (first (leaf-refs var)))
1380              (lvar (node-lvar ref) :exit-if-null)
1381              (dest (lvar-dest lvar)))
1382     (when (and
1383            ;; Think about (LET ((A ...)) (IF ... A ...)): two
1384            ;; LVAR-USEs should not be met on one path. Another problem
1385            ;; is with dynamic-extent.
1386            (eq (lvar-uses lvar) ref)
1387            (not (block-delete-p (node-block ref)))
1388            (typecase dest
1389              ;; we should not change lifetime of unknown values lvars
1390              (cast
1391               (and (type-single-value-p (lvar-derived-type arg))
1392                    (multiple-value-bind (pdest pprev)
1393                        (principal-lvar-end lvar)
1394                      (declare (ignore pdest))
1395                      (lvar-single-value-p pprev))))
1396              (mv-combination
1397               (or (eq (basic-combination-fun dest) lvar)
1398                   (and (eq (basic-combination-kind dest) :local)
1399                        (type-single-value-p (lvar-derived-type arg)))))
1400              ((or creturn exit)
1401               ;; While CRETURN and EXIT nodes may be known-values,
1402               ;; they have their own complications, such as
1403               ;; substitution into CRETURN may create new tail calls.
1404               nil)
1405              (t
1406               (aver (lvar-single-value-p lvar))
1407               t))
1408            (eq (node-home-lambda ref)
1409                (lambda-home (lambda-var-home var))))
1410       (let ((ref-type (single-value-type (node-derived-type ref))))
1411         (cond ((csubtypep (single-value-type (lvar-type arg)) ref-type)
1412                (substitute-lvar-uses lvar arg
1413                                      ;; Really it is (EQ (LVAR-USES LVAR) REF):
1414                                      t)
1415                (delete-lvar-use ref))
1416               (t
1417                (let* ((value (make-lvar))
1418                       (cast (insert-cast-before ref value ref-type
1419                                                 ;; KLUDGE: it should be (TYPE-CHECK 0)
1420                                                 *policy*)))
1421                  (setf (cast-type-to-check cast) *wild-type*)
1422                  (substitute-lvar-uses value arg
1423                                      ;; FIXME
1424                                      t)
1425                  (%delete-lvar-use ref)
1426                  (add-lvar-use cast lvar)))))
1427       (setf (node-derived-type ref) *wild-type*)
1428       (change-ref-leaf ref (find-constant nil))
1429       (delete-ref ref)
1430       (unlink-node ref)
1431       (reoptimize-lvar lvar)
1432       t)))
1433
1434 ;;; Delete a LET, removing the call and bind nodes, and warning about
1435 ;;; any unreferenced variables. Note that FLUSH-DEAD-CODE will come
1436 ;;; along right away and delete the REF and then the lambda, since we
1437 ;;; flush the FUN lvar.
1438 (defun delete-let (clambda)
1439   (declare (type clambda clambda))
1440   (aver (functional-letlike-p clambda))
1441   (note-unreferenced-vars clambda)
1442   (let ((call (let-combination clambda)))
1443     (flush-dest (basic-combination-fun call))
1444     (unlink-node call)
1445     (unlink-node (lambda-bind clambda))
1446     (setf (lambda-bind clambda) nil))
1447   (setf (functional-kind clambda) :zombie)
1448   (let ((home (lambda-home clambda)))
1449     (setf (lambda-lets home) (delete clambda (lambda-lets home))))
1450   (values))
1451
1452 ;;; This function is called when one of the arguments to a LET
1453 ;;; changes. We look at each changed argument. If the corresponding
1454 ;;; variable is set, then we call PROPAGATE-FROM-SETS. Otherwise, we
1455 ;;; consider substituting for the variable, and also propagate
1456 ;;; derived-type information for the arg to all the VAR's refs.
1457 ;;;
1458 ;;; Substitution is inhibited when the arg leaf's derived type isn't a
1459 ;;; subtype of the argument's leaf type. This prevents type checking
1460 ;;; from being defeated, and also ensures that the best representation
1461 ;;; for the variable can be used.
1462 ;;;
1463 ;;; Substitution of individual references is inhibited if the
1464 ;;; reference is in a different component from the home. This can only
1465 ;;; happen with closures over top level lambda vars. In such cases,
1466 ;;; the references may have already been compiled, and thus can't be
1467 ;;; retroactively modified.
1468 ;;;
1469 ;;; If all of the variables are deleted (have no references) when we
1470 ;;; are done, then we delete the LET.
1471 ;;;
1472 ;;; Note that we are responsible for clearing the LVAR-REOPTIMIZE
1473 ;;; flags.
1474 (defun propagate-let-args (call fun)
1475   (declare (type combination call) (type clambda fun))
1476   (loop for arg in (combination-args call)
1477         and var in (lambda-vars fun) do
1478     (when (and arg (lvar-reoptimize arg))
1479       (setf (lvar-reoptimize arg) nil)
1480       (cond
1481         ((lambda-var-sets var)
1482          (propagate-from-sets var (lvar-type arg)))
1483         ((let ((use (lvar-uses arg)))
1484            (when (ref-p use)
1485              (let ((leaf (ref-leaf use)))
1486                (when (and (constant-reference-p use)
1487                           (csubtypep (leaf-type leaf)
1488                                      ;; (NODE-DERIVED-TYPE USE) would
1489                                      ;; be better -- APD, 2003-05-15
1490                                      (leaf-type var)))
1491                  (propagate-to-refs var (lvar-type arg))
1492                  (let ((use-component (node-component use)))
1493                    (prog1 (substitute-leaf-if
1494                            (lambda (ref)
1495                              (cond ((eq (node-component ref) use-component)
1496                                     t)
1497                                    (t
1498                                     (aver (lambda-toplevelish-p (lambda-home fun)))
1499                                     nil)))
1500                            leaf var)))
1501                  t)))))
1502         ((and (null (rest (leaf-refs var)))
1503               (substitute-single-use-lvar arg var)))
1504         (t
1505          (propagate-to-refs var (lvar-type arg))))))
1506
1507   (when (every #'not (combination-args call))
1508     (delete-let fun))
1509
1510   (values))
1511
1512 ;;; This function is called when one of the args to a non-LET local
1513 ;;; call changes. For each changed argument corresponding to an unset
1514 ;;; variable, we compute the union of the types across all calls and
1515 ;;; propagate this type information to the var's refs.
1516 ;;;
1517 ;;; If the function has an XEP, then we don't do anything, since we
1518 ;;; won't discover anything.
1519 ;;;
1520 ;;; We can clear the LVAR-REOPTIMIZE flags for arguments in all calls
1521 ;;; corresponding to changed arguments in CALL, since the only use in
1522 ;;; IR1 optimization of the REOPTIMIZE flag for local call args is
1523 ;;; right here.
1524 (defun propagate-local-call-args (call fun)
1525   (declare (type combination call) (type clambda fun))
1526
1527   (unless (or (functional-entry-fun fun)
1528               (lambda-optional-dispatch fun))
1529     (let* ((vars (lambda-vars fun))
1530            (union (mapcar (lambda (arg var)
1531                             (when (and arg
1532                                        (lvar-reoptimize arg)
1533                                        (null (basic-var-sets var)))
1534                               (lvar-type arg)))
1535                           (basic-combination-args call)
1536                           vars))
1537            (this-ref (lvar-use (basic-combination-fun call))))
1538
1539       (dolist (arg (basic-combination-args call))
1540         (when arg
1541           (setf (lvar-reoptimize arg) nil)))
1542
1543       (dolist (ref (leaf-refs fun))
1544         (let ((dest (node-dest ref)))
1545           (unless (or (eq ref this-ref) (not dest))
1546             (setq union
1547                   (mapcar (lambda (this-arg old)
1548                             (when old
1549                               (setf (lvar-reoptimize this-arg) nil)
1550                               (type-union (lvar-type this-arg) old)))
1551                           (basic-combination-args dest)
1552                           union)))))
1553
1554       (loop for var in vars
1555             and type in union
1556             when type do (propagate-to-refs var type))))
1557
1558   (values))
1559 \f
1560 ;;;; multiple values optimization
1561
1562 ;;; Do stuff to notice a change to a MV combination node. There are
1563 ;;; two main branches here:
1564 ;;;  -- If the call is local, then it is already a MV let, or should
1565 ;;;     become one. Note that although all :LOCAL MV calls must eventually
1566 ;;;     be converted to :MV-LETs, there can be a window when the call
1567 ;;;     is local, but has not been LET converted yet. This is because
1568 ;;;     the entry-point lambdas may have stray references (in other
1569 ;;;     entry points) that have not been deleted yet.
1570 ;;;  -- The call is full. This case is somewhat similar to the non-MV
1571 ;;;     combination optimization: we propagate return type information and
1572 ;;;     notice non-returning calls. We also have an optimization
1573 ;;;     which tries to convert MV-CALLs into MV-binds.
1574 (defun ir1-optimize-mv-combination (node)
1575   (ecase (basic-combination-kind node)
1576     (:local
1577      (let ((fun-lvar (basic-combination-fun node)))
1578        (when (lvar-reoptimize fun-lvar)
1579          (setf (lvar-reoptimize fun-lvar) nil)
1580          (maybe-let-convert (combination-lambda node))))
1581      (setf (lvar-reoptimize (first (basic-combination-args node))) nil)
1582      (when (eq (functional-kind (combination-lambda node)) :mv-let)
1583        (unless (convert-mv-bind-to-let node)
1584          (ir1-optimize-mv-bind node))))
1585     (:full
1586      (let* ((fun (basic-combination-fun node))
1587             (fun-changed (lvar-reoptimize fun))
1588             (args (basic-combination-args node)))
1589        (when fun-changed
1590          (setf (lvar-reoptimize fun) nil)
1591          (let ((type (lvar-type fun)))
1592            (when (fun-type-p type)
1593              (derive-node-type node (fun-type-returns type))))
1594          (maybe-terminate-block node nil)
1595          (let ((use (lvar-uses fun)))
1596            (when (and (ref-p use) (functional-p (ref-leaf use)))
1597              (convert-call-if-possible use node)
1598              (when (eq (basic-combination-kind node) :local)
1599                (maybe-let-convert (ref-leaf use))))))
1600        (unless (or (eq (basic-combination-kind node) :local)
1601                    (eq (lvar-fun-name fun) '%throw))
1602          (ir1-optimize-mv-call node))
1603        (dolist (arg args)
1604          (setf (lvar-reoptimize arg) nil))))
1605     (:error))
1606   (values))
1607
1608 ;;; Propagate derived type info from the values lvar to the vars.
1609 (defun ir1-optimize-mv-bind (node)
1610   (declare (type mv-combination node))
1611   (let* ((arg (first (basic-combination-args node)))
1612          (vars (lambda-vars (combination-lambda node)))
1613          (n-vars (length vars))
1614          (types (values-type-in (lvar-derived-type arg)
1615                                 n-vars)))
1616     (loop for var in vars
1617           and type in types
1618           do (if (basic-var-sets var)
1619                  (propagate-from-sets var type)
1620                  (propagate-to-refs var type)))
1621     (setf (lvar-reoptimize arg) nil))
1622   (values))
1623
1624 ;;; If possible, convert a general MV call to an MV-BIND. We can do
1625 ;;; this if:
1626 ;;; -- The call has only one argument, and
1627 ;;; -- The function has a known fixed number of arguments, or
1628 ;;; -- The argument yields a known fixed number of values.
1629 ;;;
1630 ;;; What we do is change the function in the MV-CALL to be a lambda
1631 ;;; that "looks like an MV bind", which allows
1632 ;;; IR1-OPTIMIZE-MV-COMBINATION to notice that this call can be
1633 ;;; converted (the next time around.) This new lambda just calls the
1634 ;;; actual function with the MV-BIND variables as arguments. Note that
1635 ;;; this new MV bind is not let-converted immediately, as there are
1636 ;;; going to be stray references from the entry-point functions until
1637 ;;; they get deleted.
1638 ;;;
1639 ;;; In order to avoid loss of argument count checking, we only do the
1640 ;;; transformation according to a known number of expected argument if
1641 ;;; safety is unimportant. We can always convert if we know the number
1642 ;;; of actual values, since the normal call that we build will still
1643 ;;; do any appropriate argument count checking.
1644 ;;;
1645 ;;; We only attempt the transformation if the called function is a
1646 ;;; constant reference. This allows us to just splice the leaf into
1647 ;;; the new function, instead of trying to somehow bind the function
1648 ;;; expression. The leaf must be constant because we are evaluating it
1649 ;;; again in a different place. This also has the effect of squelching
1650 ;;; multiple warnings when there is an argument count error.
1651 (defun ir1-optimize-mv-call (node)
1652   (let ((fun (basic-combination-fun node))
1653         (*compiler-error-context* node)
1654         (ref (lvar-uses (basic-combination-fun node)))
1655         (args (basic-combination-args node)))
1656
1657     (unless (and (ref-p ref) (constant-reference-p ref)
1658                  (singleton-p args))
1659       (return-from ir1-optimize-mv-call))
1660
1661     (multiple-value-bind (min max)
1662         (fun-type-nargs (lvar-type fun))
1663       (let ((total-nvals
1664              (multiple-value-bind (types nvals)
1665                  (values-types (lvar-derived-type (first args)))
1666                (declare (ignore types))
1667                (if (eq nvals :unknown) nil nvals))))
1668
1669         (when total-nvals
1670           (when (and min (< total-nvals min))
1671             (compiler-warn
1672              "MULTIPLE-VALUE-CALL with ~R values when the function expects ~
1673               at least ~R."
1674              total-nvals min)
1675             (setf (basic-combination-kind node) :error)
1676             (return-from ir1-optimize-mv-call))
1677           (when (and max (> total-nvals max))
1678             (compiler-warn
1679              "MULTIPLE-VALUE-CALL with ~R values when the function expects ~
1680               at most ~R."
1681              total-nvals max)
1682             (setf (basic-combination-kind node) :error)
1683             (return-from ir1-optimize-mv-call)))
1684
1685         (let ((count (cond (total-nvals)
1686                            ((and (policy node (zerop verify-arg-count))
1687                                  (eql min max))
1688                             min)
1689                            (t nil))))
1690           (when count
1691             (with-ir1-environment-from-node node
1692               (let* ((dums (make-gensym-list count))
1693                      (ignore (gensym))
1694                      (fun (ir1-convert-lambda
1695                            `(lambda (&optional ,@dums &rest ,ignore)
1696                               (declare (ignore ,ignore))
1697                               (funcall ,(ref-leaf ref) ,@dums)))))
1698                 (change-ref-leaf ref fun)
1699                 (aver (eq (basic-combination-kind node) :full))
1700                 (locall-analyze-component *current-component*)
1701                 (aver (eq (basic-combination-kind node) :local)))))))))
1702   (values))
1703
1704 ;;; If we see:
1705 ;;;    (multiple-value-bind
1706 ;;;     (x y)
1707 ;;;     (values xx yy)
1708 ;;;      ...)
1709 ;;; Convert to:
1710 ;;;    (let ((x xx)
1711 ;;;       (y yy))
1712 ;;;      ...)
1713 ;;;
1714 ;;; What we actually do is convert the VALUES combination into a
1715 ;;; normal LET combination calling the original :MV-LET lambda. If
1716 ;;; there are extra args to VALUES, discard the corresponding
1717 ;;; lvars. If there are insufficient args, insert references to NIL.
1718 (defun convert-mv-bind-to-let (call)
1719   (declare (type mv-combination call))
1720   (let* ((arg (first (basic-combination-args call)))
1721          (use (lvar-uses arg)))
1722     (when (and (combination-p use)
1723                (eq (lvar-fun-name (combination-fun use))
1724                    'values))
1725       (let* ((fun (combination-lambda call))
1726              (vars (lambda-vars fun))
1727              (vals (combination-args use))
1728              (nvars (length vars))
1729              (nvals (length vals)))
1730         (cond ((> nvals nvars)
1731                (mapc #'flush-dest (subseq vals nvars))
1732                (setq vals (subseq vals 0 nvars)))
1733               ((< nvals nvars)
1734                (with-ir1-environment-from-node use
1735                  (let ((node-prev (node-prev use)))
1736                    (setf (node-prev use) nil)
1737                    (setf (ctran-next node-prev) nil)
1738                    (collect ((res vals))
1739                      (loop for count below (- nvars nvals)
1740                            for prev = node-prev then ctran
1741                            for ctran = (make-ctran)
1742                            and lvar = (make-lvar use)
1743                            do (reference-constant prev ctran lvar nil)
1744                               (res lvar)
1745                            finally (link-node-to-previous-ctran
1746                                     use ctran))
1747                      (setq vals (res)))))))
1748         (setf (combination-args use) vals)
1749         (flush-dest (combination-fun use))
1750         (let ((fun-lvar (basic-combination-fun call)))
1751           (setf (lvar-dest fun-lvar) use)
1752           (setf (combination-fun use) fun-lvar)
1753           (flush-lvar-externally-checkable-type fun-lvar))
1754         (setf (combination-kind use) :local)
1755         (setf (functional-kind fun) :let)
1756         (flush-dest (first (basic-combination-args call)))
1757         (unlink-node call)
1758         (when vals
1759           (reoptimize-lvar (first vals)))
1760         (propagate-to-args use fun)
1761         (reoptimize-call use))
1762       t)))
1763
1764 ;;; If we see:
1765 ;;;    (values-list (list x y z))
1766 ;;;
1767 ;;; Convert to:
1768 ;;;    (values x y z)
1769 ;;;
1770 ;;; In implementation, this is somewhat similar to
1771 ;;; CONVERT-MV-BIND-TO-LET. We grab the args of LIST and make them
1772 ;;; args of the VALUES-LIST call, flushing the old argument lvar
1773 ;;; (allowing the LIST to be flushed.)
1774 ;;;
1775 ;;; FIXME: Thus we lose possible type assertions on (LIST ...).
1776 (defoptimizer (values-list optimizer) ((list) node)
1777   (let ((use (lvar-uses list)))
1778     (when (and (combination-p use)
1779                (eq (lvar-fun-name (combination-fun use))
1780                    'list))
1781
1782       ;; FIXME: VALUES might not satisfy an assertion on NODE-LVAR.
1783       (change-ref-leaf (lvar-uses (combination-fun node))
1784                        (find-free-fun 'values "in a strange place"))
1785       (setf (combination-kind node) :full)
1786       (let ((args (combination-args use)))
1787         (dolist (arg args)
1788           (setf (lvar-dest arg) node)
1789           (flush-lvar-externally-checkable-type arg))
1790         (setf (combination-args use) nil)
1791         (flush-dest list)
1792         (setf (combination-args node) args))
1793       t)))
1794
1795 ;;; If VALUES appears in a non-MV context, then effectively convert it
1796 ;;; to a PROG1. This allows the computation of the additional values
1797 ;;; to become dead code.
1798 (deftransform values ((&rest vals) * * :node node)
1799   (unless (lvar-single-value-p (node-lvar node))
1800     (give-up-ir1-transform))
1801   (setf (node-derived-type node)
1802         (make-short-values-type (list (single-value-type
1803                                        (node-derived-type node)))))
1804   (principal-lvar-single-valuify (node-lvar node))
1805   (if vals
1806       (let ((dummies (make-gensym-list (length (cdr vals)))))
1807         `(lambda (val ,@dummies)
1808            (declare (ignore ,@dummies))
1809            val))
1810       nil))
1811
1812 ;;; TODO:
1813 ;;; - CAST chains;
1814 (defun ir1-optimize-cast (cast &optional do-not-optimize)
1815   (declare (type cast cast))
1816   (let ((value (cast-value cast))
1817         (atype (cast-asserted-type cast)))
1818     (when (not do-not-optimize)
1819       (let ((lvar (node-lvar cast)))
1820         (when (values-subtypep (lvar-derived-type value)
1821                                (cast-asserted-type cast))
1822           (delete-filter cast lvar value)
1823           (when lvar
1824             (reoptimize-lvar lvar)
1825             (when (lvar-single-value-p lvar)
1826               (note-single-valuified-lvar lvar)))
1827           (return-from ir1-optimize-cast t))
1828
1829         (when (and (listp (lvar-uses value))
1830                    lvar)
1831           ;; Pathwise removing of CAST
1832           (let ((ctran (node-next cast))
1833                 (dest (lvar-dest lvar))
1834                 next-block)
1835             (collect ((merges))
1836               (do-uses (use value)
1837                 (when (and (values-subtypep (node-derived-type use) atype)
1838                            (immediately-used-p value use))
1839                   (unless next-block
1840                     (when ctran (ensure-block-start ctran))
1841                     (setq next-block (first (block-succ (node-block cast))))
1842                     (ensure-block-start (node-prev cast))
1843                     (reoptimize-lvar lvar)
1844                     (setf (lvar-%derived-type value) nil))
1845                   (%delete-lvar-use use)
1846                   (add-lvar-use use lvar)
1847                   (unlink-blocks (node-block use) (node-block cast))
1848                   (link-blocks (node-block use) next-block)
1849                   (when (and (return-p dest)
1850                              (basic-combination-p use)
1851                              (eq (basic-combination-kind use) :local))
1852                     (merges use))))
1853               (dolist (use (merges))
1854                 (merge-tail-sets use)))))))
1855
1856     (let* ((value-type (lvar-derived-type value))
1857            (int (values-type-intersection value-type atype)))
1858       (derive-node-type cast int)
1859       (when (eq int *empty-type*)
1860         (unless (eq value-type *empty-type*)
1861
1862           ;; FIXME: Do it in one step.
1863           (filter-lvar
1864            value
1865            (if (cast-single-value-p cast)
1866                `(list 'dummy)
1867                `(multiple-value-call #'list 'dummy)))
1868           (filter-lvar
1869            (cast-value cast)
1870            ;; FIXME: Derived type.
1871            `(%compile-time-type-error 'dummy
1872                                       ',(type-specifier atype)
1873                                       ',(type-specifier value-type)))
1874           ;; KLUDGE: FILTER-LVAR does not work for non-returning
1875           ;; functions, so we declare the return type of
1876           ;; %COMPILE-TIME-TYPE-ERROR to be * and derive the real type
1877           ;; here.
1878           (setq value (cast-value cast))
1879           (derive-node-type (lvar-uses value) *empty-type*)
1880           (maybe-terminate-block (lvar-uses value) nil)
1881           ;; FIXME: Is it necessary?
1882           (aver (null (block-pred (node-block cast))))
1883           (delete-block-lazily (node-block cast))
1884           (return-from ir1-optimize-cast)))
1885       (when (eq (node-derived-type cast) *empty-type*)
1886         (maybe-terminate-block cast nil))
1887
1888       (when (and (cast-%type-check cast)
1889                  (values-subtypep value-type
1890                                   (cast-type-to-check cast)))
1891         (setf (cast-%type-check cast) nil))))
1892
1893   (unless do-not-optimize
1894     (setf (node-reoptimize cast) nil)))
1895
1896 (deftransform make-symbol ((string) (simple-string))
1897   `(%make-symbol string))