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
8 ;;;; This software is part of the SBCL system. See the README file for
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.
19 ;;;; interface for obtaining results of constant folding
21 ;;; Return true for an LVAR whose sole use is a reference to a
23 (defun constant-lvar-p (thing)
24 (declare (type (or lvar null
) thing
))
26 (let ((use (principal-lvar-use thing
)))
27 (and (ref-p use
) (constant-p (ref-leaf use
))))))
29 ;;; Return the constant value for an LVAR whose only use is a constant
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
))))
36 ;;;; interface for obtaining results of type inference
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.
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
*)
56 (do ((res (node-derived-type (first uses
))
57 (values-type-union (node-derived-type (first current
))
59 (current (rest uses
) (rest current
)))
60 ((null current
) res
)))
62 (node-derived-type (lvar-uses lvar
))))))
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
)))
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
))
92 (setf (lvar-%externally-checkable-type arg
)
94 (map-combination-args-and-types
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
)))))
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
))
108 ;;;; interface routines used by optimizers
110 (declaim (inline reoptimize-component
))
111 (defun reoptimize-component (component kind
)
112 (declare (type component component
)
113 (type (member nil
:maybe t
) kind
))
115 (unless (eq (component-reoptimize component
) t
)
116 (setf (component-reoptimize component
) kind
)))
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.
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
))
128 (setf (lvar-%derived-type lvar
) nil
)
129 (let ((dest (lvar-dest lvar
)))
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
))))
143 (setf (block-type-check (node-block node
)) t
)))
146 (defun reoptimize-lvar-uses (lvar)
147 (declare (type lvar lvar
))
149 (setf (node-reoptimize use
) t
)
150 (setf (block-reoptimize (node-block use
)) t
)
151 (reoptimize-component (node-component use
) :maybe
)))
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.
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
))
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
)))))
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
))))
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
)
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
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
233 (mark-for-deletion block
)
234 (setq block
(clean-component component block
)))
237 (let ((succ (block-succ block
)))
238 (unless (singleton-p succ
)
241 (let ((last (block-last block
)))
244 (flush-dest (if-test last
))
245 (when (unlink-node last
)
248 (when (maybe-delete-exit last
)
251 (unless (join-successor-if-possible block
)
254 (when (and (not fastp
) (block-reoptimize block
) (block-component block
))
255 (aver (not (block-delete-p block
)))
256 (ir1-optimize-block block
))
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
))))
267 ;;; Loop over the nodes in BLOCK, acting on (and clearing) REOPTIMIZE
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
)
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
))
291 (ir1-optimize-if node
))
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
297 (setf (node-reoptimize node
) t
)
298 (ir1-optimize-return node
))
300 (ir1-optimize-mv-combination node
))
302 ;; With an EXIT, we derive the node's type from the VALUE's
304 (let ((value (exit-value node
)))
306 (derive-node-type node
(lvar-derived-type value
)))))
308 (ir1-optimize-set node
))
310 (ir1-optimize-cast node
)))))
314 ;;; Try to join with a successor block. If we succeed, we return true,
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:
322 ;; the successor has more than one predecessor;
323 (rest (block-pred next
))
324 ;; the successor is the current block (infinite loop);
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
)
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
)))))))
347 (join-blocks block next
)
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
))))
361 (setf (ctran-block ctran
) block1
))
363 (unlink-blocks block1 block2
)
365 (unlink-blocks block2 block
)
366 (link-blocks block1 block
))
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
))
373 (setf (block-flags block1
)
374 (attributes-union (block-flags block1
)
376 (block-attributes type-asserted test-modified
)))
378 (let ((next (block-next block2
))
379 (prev (block-prev block2
)))
380 (setf (block-next prev
) next
)
381 (setf (block-prev next
) prev
))
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
)
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
408 (if (policy node
(= safety
3))
409 (ir1-attributep attr flushable
)
410 (ir1-attributep attr unsafely-flushable
)))
411 (flush-combination node
))))))
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
))
419 (flush-dest (first (basic-combination-args node
)))
422 (let ((value (exit-value node
)))
425 (setf (exit-value node
) nil
))))
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
))))
435 (unless (cast-type-check node
)
436 (flush-dest (cast-value node
))
437 (unlink-node node
))))))
441 ;;;; local call return type propagation
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
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
))))
474 (use-union (node-derived-type use
))))))
476 ;; (values-type-intersection
477 ;; (continuation-asserted-type result) ; FIXME -- APD, 2002-01-26
481 (setf (return-result-type node
) int
))))
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.)
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
))
500 (let* ((tails (lambda-tail-set (return-lambda node
)))
501 (funs (tail-set-funs tails
)))
502 (collect ((res *empty-type
* values-type-union
))
504 (let ((return (lambda-return fun
)))
506 (when (node-reoptimize return
)
507 (setf (node-reoptimize return
) nil
)
508 (when (find-result-type return
)
510 (res (return-result-type return
)))))
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
))))))))
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
526 (defun ir1-optimize-if (node)
527 (declare (type cif node
))
528 (let ((test (if-test node
))
529 (block (node-block node
)))
531 (when (and (eq (block-start-node block
) node
)
532 (listp (lvar-uses test
)))
534 (when (immediately-used-p test use
)
535 (convert-if-if use node
)
536 (when (not (listp (lvar-uses test
))) (return)))))
538 (let* ((type (lvar-type test
))
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
)))))
550 (when (rest (block-succ block
))
551 (unlink-blocks block victim
))
552 (setf (component-reanalyze (node-component node
)) t
)
553 (unlink-node node
))))
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).
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))
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
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
)
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
)
593 (link-blocks new-block cblock
)
594 (link-blocks new-block ablock
)
596 (push "<IF Duplication>" (node-source-path node
))
597 (push "<IF Duplication>" (node-source-path new-node
))
599 (reoptimize-lvar test
)
600 (reoptimize-lvar new-lvar
)
601 (setf (component-reanalyze *current-component
*) t
)))
604 ;;;; exit IR1 optimization
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
619 ;;; This function is also called by environment analysis, since it
620 ;;; wants all exits to be optimized even if normal optimization was
622 (defun maybe-delete-exit (node)
623 (declare (type exit node
))
624 (let ((value (exit-value node
))
625 (entry (exit-entry node
)))
627 (eq (node-home-lambda node
) (node-home-lambda entry
)))
628 (setf (entry-exits entry
) (delq node
(entry-exits entry
)))
630 (delete-filter node
(node-lvar node
) value
)
631 (unlink-node node
)))))
634 ;;;; combination IR1 optimization
636 ;;; Report as we try each transform?
638 (defvar *show-transforms-p
* nil
)
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
)))
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
))))
658 (setf (lvar-reoptimize arg
) nil
))))
662 (setf (lvar-reoptimize arg
) nil
)))
664 (let ((fun (fun-info-derive-type info
)))
666 (let ((res (funcall fun node
)))
668 (derive-node-type node
(coerce-to-values res
))
669 (maybe-terminate-block node nil
)))))))
674 (setf (lvar-reoptimize arg
) nil
)))
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
)
685 (constant-fold-call node
)
686 (return-from ir1-optimize-combination
)))
688 (let ((fun (fun-info-derive-type info
)))
690 (let ((res (funcall fun node
)))
692 (derive-node-type node
(coerce-to-values res
))
693 (maybe-terminate-block node nil
)))))
695 (let ((fun (fun-info-optimizer info
)))
696 (unless (and fun
(funcall fun node
))
697 (dolist (x (fun-info-transforms info
))
699 (when *show-transforms-p
*
700 (let* ((lvar (basic-combination-fun node
))
701 (fname (lvar-fun-name lvar t
)))
702 (/show
"trying transform" x
(transform-function x
) "for" fname
)))
703 (unless (ir1-transform node x
)
705 (when *show-transforms-p
*
706 (/show
"quitting because IR1-TRANSFORM result was NIL"))
711 ;;; If NODE doesn't return (i.e. return type is NIL), then terminate
712 ;;; the block there, and link it to the component tail.
714 ;;; Except when called during IR1 convertion, we delete the
715 ;;; continuation if it has no other uses. (If it does have other uses,
718 ;;; Termination on the basis of a continuation type is
720 ;;; -- The continuation is deleted (hence the assertion is spurious), or
721 ;;; -- We are in IR1 conversion (where THE assertions are subject to
722 ;;; weakening.) FIXME: Now THE assertions are not weakened, but new
723 ;;; uses can(?) be added later. -- APD, 2003-07-17
725 ;;; Why do we need to consider LVAR type? -- APD, 2003-07-30
726 (defun maybe-terminate-block (node ir1-converting-not-optimizing-p
)
727 (declare (type (or basic-combination cast ref
) node
))
728 (let* ((block (node-block node
))
729 (lvar (node-lvar node
))
730 (ctran (node-next node
))
731 (tail (component-tail (block-component block
)))
732 (succ (first (block-succ block
))))
733 (declare (ignore lvar
))
734 (unless (or (and (eq node
(block-last block
)) (eq succ tail
))
735 (block-delete-p block
))
736 (when (eq (node-derived-type node
) *empty-type
*)
737 (cond (ir1-converting-not-optimizing-p
740 (aver (eq (block-last block
) node
)))
742 (setf (block-last block
) node
)
743 (setf (ctran-use ctran
) nil
)
744 (setf (ctran-kind ctran
) :unused
)
745 (setf (ctran-block ctran
) nil
)
746 (setf (node-next node
) nil
)
747 (link-blocks block
(ctran-starts-block ctran
)))))
749 (node-ends-block node
)))
751 (let ((succ (first (block-succ block
))))
752 (unlink-blocks block succ
)
753 (setf (component-reanalyze (block-component block
)) t
)
754 (aver (not (block-succ block
)))
755 (link-blocks block tail
)
756 (cond (ir1-converting-not-optimizing-p
757 (%delete-lvar-use node
))
758 (t (delete-lvar-use node
)
759 (when (null (block-pred succ
))
760 (mark-for-deletion succ
)))))
763 ;;; This is called both by IR1 conversion and IR1 optimization when
764 ;;; they have verified the type signature for the call, and are
765 ;;; wondering if something should be done to special-case the call. If
766 ;;; CALL is a call to a global function, then see whether it defined
768 ;;; -- If a DEFINED-FUN should be inline expanded, then convert
769 ;;; the expansion and change the call to call it. Expansion is
770 ;;; enabled if :INLINE or if SPACE=0. If the FUNCTIONAL slot is
771 ;;; true, we never expand, since this function has already been
772 ;;; converted. Local call analysis will duplicate the definition
773 ;;; if necessary. We claim that the parent form is LABELS for
774 ;;; context declarations, since we don't want it to be considered
775 ;;; a real global function.
776 ;;; -- If it is a known function, mark it as such by setting the KIND.
778 ;;; We return the leaf referenced (NIL if not a leaf) and the
779 ;;; FUN-INFO assigned.
780 (defun recognize-known-call (call ir1-converting-not-optimizing-p
)
781 (declare (type combination call
))
782 (let* ((ref (lvar-uses (basic-combination-fun call
)))
783 (leaf (when (ref-p ref
) (ref-leaf ref
)))
784 (inlinep (if (defined-fun-p leaf
)
785 (defined-fun-inlinep leaf
)
788 ((eq inlinep
:notinline
)
789 (let ((info (info :function
:info
(leaf-source-name leaf
))))
791 (setf (basic-combination-fun-info call
) info
))
793 ((not (and (global-var-p leaf
)
794 (eq (global-var-kind leaf
) :global-function
)))
799 ((nil :maybe-inline
) (policy call
(zerop space
))))
801 (defined-fun-inline-expansion leaf
)
802 (let ((fun (defined-fun-functional leaf
)))
804 (and (eq inlinep
:inline
) (functional-kind fun
))))
805 (inline-expansion-ok call
))
806 (flet (;; FIXME: Is this what the old CMU CL internal documentation
807 ;; called semi-inlining? A more descriptive name would
808 ;; be nice. -- WHN 2002-01-07
810 (let ((res (let ((*allow-instrumenting
* t
))
811 (ir1-convert-lambda-for-defun
812 (defined-fun-inline-expansion leaf
)
814 #'ir1-convert-inline-lambda
))))
815 (setf (defined-fun-functional leaf
) res
)
816 (change-ref-leaf ref res
))))
817 (if ir1-converting-not-optimizing-p
819 (with-ir1-environment-from-node call
821 (locall-analyze-component *current-component
*))))
823 (values (ref-leaf (lvar-uses (basic-combination-fun call
)))
826 (let ((info (info :function
:info
(leaf-source-name leaf
))))
830 (setf (basic-combination-kind call
) :known
)
831 (setf (basic-combination-fun-info call
) info
)))
832 (values leaf nil
)))))))
834 ;;; Check whether CALL satisfies TYPE. If so, apply the type to the
835 ;;; call, and do MAYBE-TERMINATE-BLOCK and return the values of
836 ;;; RECOGNIZE-KNOWN-CALL. If an error, set the combination kind and
837 ;;; return NIL, NIL. If the type is just FUNCTION, then skip the
838 ;;; syntax check, arg/result type processing, but still call
839 ;;; RECOGNIZE-KNOWN-CALL, since the call might be to a known lambda,
840 ;;; and that checking is done by local call analysis.
841 (defun validate-call-type (call type ir1-converting-not-optimizing-p
)
842 (declare (type combination call
) (type ctype type
))
843 (cond ((not (fun-type-p type
))
844 (aver (multiple-value-bind (val win
)
845 (csubtypep type
(specifier-type 'function
))
847 (recognize-known-call call ir1-converting-not-optimizing-p
))
848 ((valid-fun-use call type
849 :argument-test
#'always-subtypep
851 ;; KLUDGE: Common Lisp is such a dynamic
852 ;; language that all we can do here in
853 ;; general is issue a STYLE-WARNING. It
854 ;; would be nice to issue a full WARNING
855 ;; in the special case of of type
856 ;; mismatches within a compilation unit
857 ;; (as in section 3.2.2.3 of the spec)
858 ;; but at least as of sbcl-0.6.11, we
859 ;; don't keep track of whether the
860 ;; mismatched data came from the same
861 ;; compilation unit, so we can't do that.
864 ;; FIXME: Actually, I think we could
865 ;; issue a full WARNING if the call
866 ;; violates a DECLAIM FTYPE.
867 :lossage-fun
#'compiler-style-warn
868 :unwinnage-fun
#'compiler-notify
)
869 (assert-call-type call type
)
870 (maybe-terminate-block call ir1-converting-not-optimizing-p
)
871 (recognize-known-call call ir1-converting-not-optimizing-p
))
873 (setf (combination-kind call
) :error
)
876 ;;; This is called by IR1-OPTIMIZE when the function for a call has
877 ;;; changed. If the call is local, we try to LET-convert it, and
878 ;;; derive the result type. If it is a :FULL call, we validate it
879 ;;; against the type, which recognizes known calls, does inline
880 ;;; expansion, etc. If a call to a predicate in a non-conditional
881 ;;; position or to a function with a source transform, then we
882 ;;; reconvert the form to give IR1 another chance.
883 (defun propagate-fun-change (call)
884 (declare (type combination call
))
885 (let ((*compiler-error-context
* call
)
886 (fun-lvar (basic-combination-fun call
)))
887 (setf (lvar-reoptimize fun-lvar
) nil
)
888 (case (combination-kind call
)
890 (let ((fun (combination-lambda call
)))
891 (maybe-let-convert fun
)
892 (unless (member (functional-kind fun
) '(:let
:assignment
:deleted
))
893 (derive-node-type call
(tail-set-type (lambda-tail-set fun
))))))
895 (multiple-value-bind (leaf info
)
896 (validate-call-type call
(lvar-type fun-lvar
) nil
)
897 (cond ((functional-p leaf
)
898 (convert-call-if-possible
899 (lvar-uses (basic-combination-fun call
))
902 ((and (global-var-p leaf
)
903 (eq (global-var-kind leaf
) :global-function
)
904 (leaf-has-source-name-p leaf
)
905 (or (info :function
:source-transform
(leaf-source-name leaf
))
907 (ir1-attributep (fun-info-attributes info
)
909 (let ((lvar (node-lvar call
)))
910 (and lvar
(not (if-p (lvar-dest lvar
))))))))
911 (let ((name (leaf-source-name leaf
))
912 (dummies (make-gensym-list
913 (length (combination-args call
)))))
916 (,@(if (symbolp name
)
920 (leaf-source-name leaf
)))))))))
923 ;;;; known function optimization
925 ;;; Add a failed optimization note to FAILED-OPTIMZATIONS for NODE,
926 ;;; FUN and ARGS. If there is already a note for NODE and TRANSFORM,
927 ;;; replace it, otherwise add a new one.
928 (defun record-optimization-failure (node transform args
)
929 (declare (type combination node
) (type transform transform
)
930 (type (or fun-type list
) args
))
931 (let* ((table (component-failed-optimizations *component-being-compiled
*))
932 (found (assoc transform
(gethash node table
))))
934 (setf (cdr found
) args
)
935 (push (cons transform args
) (gethash node table
))))
938 ;;; Attempt to transform NODE using TRANSFORM-FUNCTION, subject to the
939 ;;; call type constraint TRANSFORM-TYPE. If we are inhibited from
940 ;;; doing the transform for some reason and FLAME is true, then we
941 ;;; make a note of the message in FAILED-OPTIMIZATIONS for IR1
942 ;;; finalize to pick up. We return true if the transform failed, and
943 ;;; thus further transformation should be attempted. We return false
944 ;;; if either the transform succeeded or was aborted.
945 (defun ir1-transform (node transform
)
946 (declare (type combination node
) (type transform transform
))
947 (let* ((type (transform-type transform
))
948 (fun (transform-function transform
))
949 (constrained (fun-type-p type
))
950 (table (component-failed-optimizations *component-being-compiled
*))
951 (flame (if (transform-important transform
)
952 (policy node
(>= speed inhibit-warnings
))
953 (policy node
(> speed inhibit-warnings
))))
954 (*compiler-error-context
* node
))
955 (cond ((or (not constrained
)
956 (valid-fun-use node type
))
957 (multiple-value-bind (severity args
)
958 (catch 'give-up-ir1-transform
961 (combination-fun-source-name node
))
968 (setf (combination-kind node
) :error
)
976 (record-optimization-failure node transform args
))
977 (setf (gethash node table
)
978 (remove transform
(gethash node table
) :key
#'car
)))
986 :argument-test
#'types-equal-or-intersect
987 :result-test
#'values-types-equal-or-intersect
))
988 (record-optimization-failure node transform type
)
993 ;;; When we don't like an IR1 transform, we throw the severity/reason
996 ;;; GIVE-UP-IR1-TRANSFORM is used to throw out of an IR1 transform,
997 ;;; aborting this attempt to transform the call, but admitting the
998 ;;; possibility that this or some other transform will later succeed.
999 ;;; If arguments are supplied, they are format arguments for an
1000 ;;; efficiency note.
1002 ;;; ABORT-IR1-TRANSFORM is used to throw out of an IR1 transform and
1003 ;;; force a normal call to the function at run time. No further
1004 ;;; optimizations will be attempted.
1006 ;;; DELAY-IR1-TRANSFORM is used to throw out of an IR1 transform, and
1007 ;;; delay the transform on the node until later. REASONS specifies
1008 ;;; when the transform will be later retried. The :OPTIMIZE reason
1009 ;;; causes the transform to be delayed until after the current IR1
1010 ;;; optimization pass. The :CONSTRAINT reason causes the transform to
1011 ;;; be delayed until after constraint propagation.
1013 ;;; FIXME: Now (0.6.11.44) that there are 4 variants of this (GIVE-UP,
1014 ;;; ABORT, DELAY/:OPTIMIZE, DELAY/:CONSTRAINT) and we're starting to
1015 ;;; do CASE operations on the various REASON values, it might be a
1016 ;;; good idea to go OO, representing the reasons by objects, using
1017 ;;; CLOS methods on the objects instead of CASE, and (possibly) using
1018 ;;; SIGNAL instead of THROW.
1019 (declaim (ftype (function (&rest t
) nil
) give-up-ir1-transform
))
1020 (defun give-up-ir1-transform (&rest args
)
1021 (throw 'give-up-ir1-transform
(values :failure args
)))
1022 (defun abort-ir1-transform (&rest args
)
1023 (throw 'give-up-ir1-transform
(values :aborted args
)))
1024 (defun delay-ir1-transform (node &rest reasons
)
1025 (let ((assoc (assoc node
*delayed-ir1-transforms
*)))
1027 (setf *delayed-ir1-transforms
*
1028 (acons node reasons
*delayed-ir1-transforms
*))
1029 (throw 'give-up-ir1-transform
:delayed
))
1031 (dolist (reason reasons
)
1032 (pushnew reason
(cdr assoc
)))
1033 (throw 'give-up-ir1-transform
:delayed
)))))
1035 ;;; Clear any delayed transform with no reasons - these should have
1036 ;;; been tried in the last pass. Then remove the reason from the
1037 ;;; delayed transform reasons, and if any become empty then set
1038 ;;; reoptimize flags for the node. Return true if any transforms are
1040 (defun retry-delayed-ir1-transforms (reason)
1041 (setf *delayed-ir1-transforms
*
1042 (remove-if-not #'cdr
*delayed-ir1-transforms
*))
1043 (let ((reoptimize nil
))
1044 (dolist (assoc *delayed-ir1-transforms
*)
1045 (let ((reasons (remove reason
(cdr assoc
))))
1046 (setf (cdr assoc
) reasons
)
1048 (let ((node (car assoc
)))
1049 (unless (node-deleted node
)
1051 (setf (node-reoptimize node
) t
)
1052 (let ((block (node-block node
)))
1053 (setf (block-reoptimize block
) t
)
1054 (reoptimize-component (block-component block
) :maybe
)))))))
1057 ;;; Take the lambda-expression RES, IR1 convert it in the proper
1058 ;;; environment, and then install it as the function for the call
1059 ;;; NODE. We do local call analysis so that the new function is
1060 ;;; integrated into the control flow.
1062 ;;; We require the original function source name in order to generate
1063 ;;; a meaningful debug name for the lambda we set up. (It'd be
1064 ;;; possible to do this starting from debug names as well as source
1065 ;;; names, but as of sbcl-0.7.1.5, there was no need for this
1066 ;;; generality, since source names are always known to our callers.)
1067 (defun transform-call (call res source-name
)
1068 (declare (type combination call
) (list res
))
1069 (aver (and (legal-fun-name-p source-name
)
1070 (not (eql source-name
'.anonymous.
))))
1071 (node-ends-block call
)
1072 (with-ir1-environment-from-node call
1073 (with-component-last-block (*current-component
*
1074 (block-next (node-block call
)))
1075 (let ((new-fun (ir1-convert-inline-lambda
1077 :debug-name
(debug-name 'lambda-inlined source-name
)))
1078 (ref (lvar-use (combination-fun call
))))
1079 (change-ref-leaf ref new-fun
)
1080 (setf (combination-kind call
) :full
)
1081 (locall-analyze-component *current-component
*))))
1084 ;;; Replace a call to a foldable function of constant arguments with
1085 ;;; the result of evaluating the form. If there is an error during the
1086 ;;; evaluation, we give a warning and leave the call alone, making the
1087 ;;; call a :ERROR call.
1089 ;;; If there is more than one value, then we transform the call into a
1091 (defun constant-fold-call (call)
1092 (let ((args (mapcar #'lvar-value
(combination-args call
)))
1093 (fun-name (combination-fun-source-name call
)))
1094 (multiple-value-bind (values win
)
1095 (careful-call fun-name
1098 ;; Note: CMU CL had COMPILER-WARN here, and that
1099 ;; seems more natural, but it's probably not.
1101 ;; It's especially not while bug 173 exists:
1104 ;; (UNLESS (OR UNSAFE? (<= END SIZE)))
1106 ;; can cause constant-folding TYPE-ERRORs (in
1107 ;; #'<=) when END can be proved to be NIL, even
1108 ;; though the code is perfectly legal and safe
1109 ;; because a NIL value of END means that the
1110 ;; #'<= will never be executed.
1112 ;; Moreover, even without bug 173,
1113 ;; quite-possibly-valid code like
1114 ;; (COND ((NONINLINED-PREDICATE END)
1115 ;; (UNLESS (<= END SIZE))
1117 ;; (where NONINLINED-PREDICATE is something the
1118 ;; compiler can't do at compile time, but which
1119 ;; turns out to make the #'<= expression
1120 ;; unreachable when END=NIL) could cause errors
1121 ;; when the compiler tries to constant-fold (<=
1124 ;; So, with or without bug 173, it'd be
1125 ;; unnecessarily evil to do a full
1126 ;; COMPILER-WARNING (and thus return FAILURE-P=T
1127 ;; from COMPILE-FILE) for legal code, so we we
1128 ;; use a wimpier COMPILE-STYLE-WARNING instead.
1129 #-sb-xc-host
#'compiler-style-warn
1130 ;; On the other hand, for code we control, we
1131 ;; should be able to work around any bug
1132 ;; 173-related problems, and in particular we
1133 ;; want to be alerted to calls to our own
1134 ;; functions which aren't being folded away; a
1135 ;; COMPILER-WARNING is butch enough to stop the
1136 ;; SBCL build itself in its tracks.
1137 #+sb-xc-host
#'compiler-warn
1140 (setf (combination-kind call
) :error
))
1141 ((and (proper-list-of-length-p values
1))
1142 (with-ir1-environment-from-node call
1143 (let* ((lvar (node-lvar call
))
1144 (prev (node-prev call
))
1145 (intermediate-ctran (make-ctran)))
1146 (%delete-lvar-use call
)
1147 (setf (ctran-next prev
) nil
)
1148 (setf (node-prev call
) nil
)
1149 (reference-constant prev intermediate-ctran lvar
1151 (link-node-to-previous-ctran call intermediate-ctran
)
1152 (reoptimize-lvar lvar
)
1153 (flush-combination call
))))
1154 (t (let ((dummies (make-gensym-list (length args
))))
1158 (declare (ignore ,@dummies
))
1159 (values ,@(mapcar (lambda (x) `',x
) values
)))
1163 ;;;; local call optimization
1165 ;;; Propagate TYPE to LEAF and its REFS, marking things changed. If
1166 ;;; the leaf type is a function type, then just leave it alone, since
1167 ;;; TYPE is never going to be more specific than that (and
1168 ;;; TYPE-INTERSECTION would choke.)
1169 (defun propagate-to-refs (leaf type
)
1170 (declare (type leaf leaf
) (type ctype type
))
1171 (let ((var-type (leaf-type leaf
)))
1172 (unless (fun-type-p var-type
)
1173 (let ((int (type-approx-intersection2 var-type type
)))
1174 (when (type/= int var-type
)
1175 (setf (leaf-type leaf
) int
)
1176 (dolist (ref (leaf-refs leaf
))
1177 (derive-node-type ref
(make-single-value-type int
))
1178 ;; KLUDGE: LET var substitution
1179 (let* ((lvar (node-lvar ref
)))
1180 (when (and lvar
(combination-p (lvar-dest lvar
)))
1181 (reoptimize-lvar lvar
))))))
1184 ;;; Iteration variable: exactly one SETQ of the form:
1186 ;;; (let ((var initial))
1188 ;;; (setq var (+ var step))
1190 (defun maybe-infer-iteration-var-type (var initial-type
)
1191 (binding* ((sets (lambda-var-sets var
) :exit-if-null
)
1193 (() (null (rest sets
)) :exit-if-null
)
1194 (set-use (principal-lvar-use (set-value set
)))
1195 (() (and (combination-p set-use
)
1196 (eq (combination-kind set-use
) :known
)
1197 (fun-info-p (combination-fun-info set-use
))
1198 (not (node-to-be-deleted-p set-use
))
1199 (eq (combination-fun-source-name set-use
) '+))
1201 (+-args
(basic-combination-args set-use
))
1202 (() (and (proper-list-of-length-p +-args
2 2)
1203 (let ((first (principal-lvar-use
1206 (eq (ref-leaf first
) var
))))
1208 (step-type (lvar-type (second +-args
)))
1209 (set-type (lvar-type (set-value set
))))
1210 (when (and (numeric-type-p initial-type
)
1211 (numeric-type-p step-type
)
1212 (numeric-type-equal initial-type step-type
))
1213 (labels ((leftmost (x y cmp cmp
=)
1214 (cond ((eq x nil
) nil
)
1217 (let ((x1 (first x
)))
1219 (let ((y1 (first y
)))
1220 (if (funcall cmp x1 y1
) x y
)))
1222 (if (funcall cmp x1 y
) x y
)))))
1224 (let ((y1 (first y
)))
1225 (if (funcall cmp
= x y1
) x y
)))
1226 (t (if (funcall cmp x y
) x y
))))
1227 (max* (x y
) (leftmost x y
#'> #'>=))
1228 (min* (x y
) (leftmost x y
#'< #'<=)))
1229 (declare (inline compare
))
1230 (multiple-value-bind (low high
)
1231 (cond ((csubtypep step-type
(specifier-type '(real 0 *)))
1232 (values (numeric-type-low initial-type
)
1233 (when (and (numeric-type-p set-type
)
1234 (numeric-type-equal set-type initial-type
))
1235 (max* (numeric-type-high initial-type
)
1236 (numeric-type-high set-type
)))))
1237 ((csubtypep step-type
(specifier-type '(real * 0)))
1238 (values (when (and (numeric-type-p set-type
)
1239 (numeric-type-equal set-type initial-type
))
1240 (min* (numeric-type-low initial-type
)
1241 (numeric-type-low set-type
)))
1242 (numeric-type-high initial-type
)))
1245 (modified-numeric-type initial-type
1248 :enumerable nil
))))))
1249 (deftransform + ((x y
) * * :result result
)
1250 "check for iteration variable reoptimization"
1251 (let ((dest (principal-lvar-end result
))
1252 (use (principal-lvar-use x
)))
1253 (when (and (ref-p use
)
1257 (reoptimize-lvar (set-value dest
))))
1258 (give-up-ir1-transform))
1260 ;;; Figure out the type of a LET variable that has sets. We compute
1261 ;;; the union of the INITIAL-TYPE and the types of all the set
1262 ;;; values and to a PROPAGATE-TO-REFS with this type.
1263 (defun propagate-from-sets (var initial-type
)
1264 (collect ((res initial-type type-union
))
1265 (dolist (set (basic-var-sets var
))
1266 (let ((type (lvar-type (set-value set
))))
1268 (when (node-reoptimize set
)
1269 (derive-node-type set
(make-single-value-type type
))
1270 (setf (node-reoptimize set
) nil
))))
1272 (awhen (maybe-infer-iteration-var-type var initial-type
)
1274 (propagate-to-refs var res
)))
1277 ;;; If a LET variable, find the initial value's type and do
1278 ;;; PROPAGATE-FROM-SETS. We also derive the VALUE's type as the node's
1280 (defun ir1-optimize-set (node)
1281 (declare (type cset node
))
1282 (let ((var (set-var node
)))
1283 (when (and (lambda-var-p var
) (leaf-refs var
))
1284 (let ((home (lambda-var-home var
)))
1285 (when (eq (functional-kind home
) :let
)
1286 (let* ((initial-value (let-var-initial-value var
))
1287 (initial-type (lvar-type initial-value
)))
1288 (setf (lvar-reoptimize initial-value
) nil
)
1289 (propagate-from-sets var initial-type
))))))
1291 (derive-node-type node
(make-single-value-type
1292 (lvar-type (set-value node
))))
1295 ;;; Return true if the value of REF will always be the same (and is
1296 ;;; thus legal to substitute.)
1297 (defun constant-reference-p (ref)
1298 (declare (type ref ref
))
1299 (let ((leaf (ref-leaf ref
)))
1301 ((or constant functional
) t
)
1303 (null (lambda-var-sets leaf
)))
1305 (not (eq (defined-fun-inlinep leaf
) :notinline
)))
1307 (case (global-var-kind leaf
)
1309 (let ((name (leaf-source-name leaf
)))
1311 (eq (symbol-package (fun-name-block-name name
))
1313 (info :function
:info name
)))))))))
1315 ;;; If we have a non-set LET var with a single use, then (if possible)
1316 ;;; replace the variable reference's LVAR with the arg lvar.
1318 ;;; We change the REF to be a reference to NIL with unused value, and
1319 ;;; let it be flushed as dead code. A side effect of this substitution
1320 ;;; is to delete the variable.
1321 (defun substitute-single-use-lvar (arg var
)
1322 (declare (type lvar arg
) (type lambda-var var
))
1323 (binding* ((ref (first (leaf-refs var
)))
1324 (lvar (node-lvar ref
) :exit-if-null
)
1325 (dest (lvar-dest lvar
)))
1327 ;; Think about (LET ((A ...)) (IF ... A ...)): two
1328 ;; LVAR-USEs should not be met on one path. Another problem
1329 ;; is with dynamic-extent.
1330 (eq (lvar-uses lvar
) ref
)
1331 (not (block-delete-p (node-block ref
)))
1333 ;; we should not change lifetime of unknown values lvars
1335 (and (type-single-value-p (lvar-derived-type arg
))
1336 (multiple-value-bind (pdest pprev
)
1337 (principal-lvar-end lvar
)
1338 (declare (ignore pdest
))
1339 (lvar-single-value-p pprev
))))
1341 (or (eq (basic-combination-fun dest
) lvar
)
1342 (and (eq (basic-combination-kind dest
) :local
)
1343 (type-single-value-p (lvar-derived-type arg
)))))
1345 ;; While CRETURN and EXIT nodes may be known-values,
1346 ;; they have their own complications, such as
1347 ;; substitution into CRETURN may create new tail calls.
1350 (aver (lvar-single-value-p lvar
))
1352 (eq (node-home-lambda ref
)
1353 (lambda-home (lambda-var-home var
))))
1354 (let ((ref-type (single-value-type (node-derived-type ref
))))
1355 (cond ((csubtypep (single-value-type (lvar-type arg
)) ref-type
)
1356 (substitute-lvar-uses lvar arg
1357 ;; Really it is (EQ (LVAR-USES LVAR) REF):
1359 (delete-lvar-use ref
))
1361 (let* ((value (make-lvar))
1362 (cast (insert-cast-before ref value ref-type
1363 ;; KLUDGE: it should be (TYPE-CHECK 0)
1365 (setf (cast-type-to-check cast
) *wild-type
*)
1366 (substitute-lvar-uses value arg
1369 (%delete-lvar-use ref
)
1370 (add-lvar-use cast lvar
)))))
1371 (setf (node-derived-type ref
) *wild-type
*)
1372 (change-ref-leaf ref
(find-constant nil
))
1375 (reoptimize-lvar lvar
)
1378 ;;; Delete a LET, removing the call and bind nodes, and warning about
1379 ;;; any unreferenced variables. Note that FLUSH-DEAD-CODE will come
1380 ;;; along right away and delete the REF and then the lambda, since we
1381 ;;; flush the FUN lvar.
1382 (defun delete-let (clambda)
1383 (declare (type clambda clambda
))
1384 (aver (functional-letlike-p clambda
))
1385 (note-unreferenced-vars clambda
)
1386 (let ((call (let-combination clambda
)))
1387 (flush-dest (basic-combination-fun call
))
1389 (unlink-node (lambda-bind clambda
))
1390 (setf (lambda-bind clambda
) nil
))
1391 (setf (functional-kind clambda
) :zombie
)
1392 (let ((home (lambda-home clambda
)))
1393 (setf (lambda-lets home
) (delete clambda
(lambda-lets home
))))
1396 ;;; This function is called when one of the arguments to a LET
1397 ;;; changes. We look at each changed argument. If the corresponding
1398 ;;; variable is set, then we call PROPAGATE-FROM-SETS. Otherwise, we
1399 ;;; consider substituting for the variable, and also propagate
1400 ;;; derived-type information for the arg to all the VAR's refs.
1402 ;;; Substitution is inhibited when the arg leaf's derived type isn't a
1403 ;;; subtype of the argument's leaf type. This prevents type checking
1404 ;;; from being defeated, and also ensures that the best representation
1405 ;;; for the variable can be used.
1407 ;;; Substitution of individual references is inhibited if the
1408 ;;; reference is in a different component from the home. This can only
1409 ;;; happen with closures over top level lambda vars. In such cases,
1410 ;;; the references may have already been compiled, and thus can't be
1411 ;;; retroactively modified.
1413 ;;; If all of the variables are deleted (have no references) when we
1414 ;;; are done, then we delete the LET.
1416 ;;; Note that we are responsible for clearing the LVAR-REOPTIMIZE
1418 (defun propagate-let-args (call fun
)
1419 (declare (type combination call
) (type clambda fun
))
1420 (loop for arg in
(combination-args call
)
1421 and var in
(lambda-vars fun
) do
1422 (when (and arg
(lvar-reoptimize arg
))
1423 (setf (lvar-reoptimize arg
) nil
)
1425 ((lambda-var-sets var
)
1426 (propagate-from-sets var
(lvar-type arg
)))
1427 ((let ((use (lvar-uses arg
)))
1429 (let ((leaf (ref-leaf use
)))
1430 (when (and (constant-reference-p use
)
1431 (csubtypep (leaf-type leaf
)
1432 ;; (NODE-DERIVED-TYPE USE) would
1433 ;; be better -- APD, 2003-05-15
1435 (propagate-to-refs var
(lvar-type arg
))
1436 (let ((use-component (node-component use
)))
1437 (prog1 (substitute-leaf-if
1439 (cond ((eq (node-component ref
) use-component
)
1442 (aver (lambda-toplevelish-p (lambda-home fun
)))
1446 ((and (null (rest (leaf-refs var
)))
1447 (substitute-single-use-lvar arg var
)))
1449 (propagate-to-refs var
(lvar-type arg
))))))
1451 (when (every #'not
(combination-args call
))
1456 ;;; This function is called when one of the args to a non-LET local
1457 ;;; call changes. For each changed argument corresponding to an unset
1458 ;;; variable, we compute the union of the types across all calls and
1459 ;;; propagate this type information to the var's refs.
1461 ;;; If the function has an XEP, then we don't do anything, since we
1462 ;;; won't discover anything.
1464 ;;; We can clear the LVAR-REOPTIMIZE flags for arguments in all calls
1465 ;;; corresponding to changed arguments in CALL, since the only use in
1466 ;;; IR1 optimization of the REOPTIMIZE flag for local call args is
1468 (defun propagate-local-call-args (call fun
)
1469 (declare (type combination call
) (type clambda fun
))
1471 (unless (or (functional-entry-fun fun
)
1472 (lambda-optional-dispatch fun
))
1473 (let* ((vars (lambda-vars fun
))
1474 (union (mapcar (lambda (arg var
)
1476 (lvar-reoptimize arg
)
1477 (null (basic-var-sets var
)))
1479 (basic-combination-args call
)
1481 (this-ref (lvar-use (basic-combination-fun call
))))
1483 (dolist (arg (basic-combination-args call
))
1485 (setf (lvar-reoptimize arg
) nil
)))
1487 (dolist (ref (leaf-refs fun
))
1488 (let ((dest (node-dest ref
)))
1489 (unless (or (eq ref this-ref
) (not dest
))
1491 (mapcar (lambda (this-arg old
)
1493 (setf (lvar-reoptimize this-arg
) nil
)
1494 (type-union (lvar-type this-arg
) old
)))
1495 (basic-combination-args dest
)
1498 (loop for var in vars
1500 when type do
(propagate-to-refs var type
))))
1504 ;;;; multiple values optimization
1506 ;;; Do stuff to notice a change to a MV combination node. There are
1507 ;;; two main branches here:
1508 ;;; -- If the call is local, then it is already a MV let, or should
1509 ;;; become one. Note that although all :LOCAL MV calls must eventually
1510 ;;; be converted to :MV-LETs, there can be a window when the call
1511 ;;; is local, but has not been LET converted yet. This is because
1512 ;;; the entry-point lambdas may have stray references (in other
1513 ;;; entry points) that have not been deleted yet.
1514 ;;; -- The call is full. This case is somewhat similar to the non-MV
1515 ;;; combination optimization: we propagate return type information and
1516 ;;; notice non-returning calls. We also have an optimization
1517 ;;; which tries to convert MV-CALLs into MV-binds.
1518 (defun ir1-optimize-mv-combination (node)
1519 (ecase (basic-combination-kind node
)
1521 (let ((fun-lvar (basic-combination-fun node
)))
1522 (when (lvar-reoptimize fun-lvar
)
1523 (setf (lvar-reoptimize fun-lvar
) nil
)
1524 (maybe-let-convert (combination-lambda node
))))
1525 (setf (lvar-reoptimize (first (basic-combination-args node
))) nil
)
1526 (when (eq (functional-kind (combination-lambda node
)) :mv-let
)
1527 (unless (convert-mv-bind-to-let node
)
1528 (ir1-optimize-mv-bind node
))))
1530 (let* ((fun (basic-combination-fun node
))
1531 (fun-changed (lvar-reoptimize fun
))
1532 (args (basic-combination-args node
)))
1534 (setf (lvar-reoptimize fun
) nil
)
1535 (let ((type (lvar-type fun
)))
1536 (when (fun-type-p type
)
1537 (derive-node-type node
(fun-type-returns type
))))
1538 (maybe-terminate-block node nil
)
1539 (let ((use (lvar-uses fun
)))
1540 (when (and (ref-p use
) (functional-p (ref-leaf use
)))
1541 (convert-call-if-possible use node
)
1542 (when (eq (basic-combination-kind node
) :local
)
1543 (maybe-let-convert (ref-leaf use
))))))
1544 (unless (or (eq (basic-combination-kind node
) :local
)
1545 (eq (lvar-fun-name fun
) '%throw
))
1546 (ir1-optimize-mv-call node
))
1548 (setf (lvar-reoptimize arg
) nil
))))
1552 ;;; Propagate derived type info from the values lvar to the vars.
1553 (defun ir1-optimize-mv-bind (node)
1554 (declare (type mv-combination node
))
1555 (let* ((arg (first (basic-combination-args node
)))
1556 (vars (lambda-vars (combination-lambda node
)))
1557 (n-vars (length vars
))
1558 (types (values-type-in (lvar-derived-type arg
)
1560 (loop for var in vars
1562 do
(if (basic-var-sets var
)
1563 (propagate-from-sets var type
)
1564 (propagate-to-refs var type
)))
1565 (setf (lvar-reoptimize arg
) nil
))
1568 ;;; If possible, convert a general MV call to an MV-BIND. We can do
1570 ;;; -- The call has only one argument, and
1571 ;;; -- The function has a known fixed number of arguments, or
1572 ;;; -- The argument yields a known fixed number of values.
1574 ;;; What we do is change the function in the MV-CALL to be a lambda
1575 ;;; that "looks like an MV bind", which allows
1576 ;;; IR1-OPTIMIZE-MV-COMBINATION to notice that this call can be
1577 ;;; converted (the next time around.) This new lambda just calls the
1578 ;;; actual function with the MV-BIND variables as arguments. Note that
1579 ;;; this new MV bind is not let-converted immediately, as there are
1580 ;;; going to be stray references from the entry-point functions until
1581 ;;; they get deleted.
1583 ;;; In order to avoid loss of argument count checking, we only do the
1584 ;;; transformation according to a known number of expected argument if
1585 ;;; safety is unimportant. We can always convert if we know the number
1586 ;;; of actual values, since the normal call that we build will still
1587 ;;; do any appropriate argument count checking.
1589 ;;; We only attempt the transformation if the called function is a
1590 ;;; constant reference. This allows us to just splice the leaf into
1591 ;;; the new function, instead of trying to somehow bind the function
1592 ;;; expression. The leaf must be constant because we are evaluating it
1593 ;;; again in a different place. This also has the effect of squelching
1594 ;;; multiple warnings when there is an argument count error.
1595 (defun ir1-optimize-mv-call (node)
1596 (let ((fun (basic-combination-fun node
))
1597 (*compiler-error-context
* node
)
1598 (ref (lvar-uses (basic-combination-fun node
)))
1599 (args (basic-combination-args node
)))
1601 (unless (and (ref-p ref
) (constant-reference-p ref
)
1603 (return-from ir1-optimize-mv-call
))
1605 (multiple-value-bind (min max
)
1606 (fun-type-nargs (lvar-type fun
))
1608 (multiple-value-bind (types nvals
)
1609 (values-types (lvar-derived-type (first args
)))
1610 (declare (ignore types
))
1611 (if (eq nvals
:unknown
) nil nvals
))))
1614 (when (and min
(< total-nvals min
))
1616 "MULTIPLE-VALUE-CALL with ~R values when the function expects ~
1619 (setf (basic-combination-kind node
) :error
)
1620 (return-from ir1-optimize-mv-call
))
1621 (when (and max
(> total-nvals max
))
1623 "MULTIPLE-VALUE-CALL with ~R values when the function expects ~
1626 (setf (basic-combination-kind node
) :error
)
1627 (return-from ir1-optimize-mv-call
)))
1629 (let ((count (cond (total-nvals)
1630 ((and (policy node
(zerop verify-arg-count
))
1635 (with-ir1-environment-from-node node
1636 (let* ((dums (make-gensym-list count
))
1638 (fun (ir1-convert-lambda
1639 `(lambda (&optional
,@dums
&rest
,ignore
)
1640 (declare (ignore ,ignore
))
1641 (funcall ,(ref-leaf ref
) ,@dums
)))))
1642 (change-ref-leaf ref fun
)
1643 (aver (eq (basic-combination-kind node
) :full
))
1644 (locall-analyze-component *current-component
*)
1645 (aver (eq (basic-combination-kind node
) :local
)))))))))
1649 ;;; (multiple-value-bind
1658 ;;; What we actually do is convert the VALUES combination into a
1659 ;;; normal LET combination calling the original :MV-LET lambda. If
1660 ;;; there are extra args to VALUES, discard the corresponding
1661 ;;; lvars. If there are insufficient args, insert references to NIL.
1662 (defun convert-mv-bind-to-let (call)
1663 (declare (type mv-combination call
))
1664 (let* ((arg (first (basic-combination-args call
)))
1665 (use (lvar-uses arg
)))
1666 (when (and (combination-p use
)
1667 (eq (lvar-fun-name (combination-fun use
))
1669 (let* ((fun (combination-lambda call
))
1670 (vars (lambda-vars fun
))
1671 (vals (combination-args use
))
1672 (nvars (length vars
))
1673 (nvals (length vals
)))
1674 (cond ((> nvals nvars
)
1675 (mapc #'flush-dest
(subseq vals nvars
))
1676 (setq vals
(subseq vals
0 nvars
)))
1678 (with-ir1-environment-from-node use
1679 (let ((node-prev (node-prev use
)))
1680 (setf (node-prev use
) nil
)
1681 (setf (ctran-next node-prev
) nil
)
1682 (collect ((res vals
))
1683 (loop for count below
(- nvars nvals
)
1684 for prev
= node-prev then ctran
1685 for ctran
= (make-ctran)
1686 and lvar
= (make-lvar use
)
1687 do
(reference-constant prev ctran lvar nil
)
1689 finally
(link-node-to-previous-ctran
1691 (setq vals
(res)))))))
1692 (setf (combination-args use
) vals
)
1693 (flush-dest (combination-fun use
))
1694 (let ((fun-lvar (basic-combination-fun call
)))
1695 (setf (lvar-dest fun-lvar
) use
)
1696 (setf (combination-fun use
) fun-lvar
)
1697 (flush-lvar-externally-checkable-type fun-lvar
))
1698 (setf (combination-kind use
) :local
)
1699 (setf (functional-kind fun
) :let
)
1700 (flush-dest (first (basic-combination-args call
)))
1703 (reoptimize-lvar (first vals
)))
1704 (propagate-to-args use fun
)
1705 (reoptimize-call use
))
1709 ;;; (values-list (list x y z))
1714 ;;; In implementation, this is somewhat similar to
1715 ;;; CONVERT-MV-BIND-TO-LET. We grab the args of LIST and make them
1716 ;;; args of the VALUES-LIST call, flushing the old argument lvar
1717 ;;; (allowing the LIST to be flushed.)
1719 ;;; FIXME: Thus we lose possible type assertions on (LIST ...).
1720 (defoptimizer (values-list optimizer
) ((list) node
)
1721 (let ((use (lvar-uses list
)))
1722 (when (and (combination-p use
)
1723 (eq (lvar-fun-name (combination-fun use
))
1726 ;; FIXME: VALUES might not satisfy an assertion on NODE-LVAR.
1727 (change-ref-leaf (lvar-uses (combination-fun node
))
1728 (find-free-fun 'values
"in a strange place"))
1729 (setf (combination-kind node
) :full
)
1730 (let ((args (combination-args use
)))
1732 (setf (lvar-dest arg
) node
)
1733 (flush-lvar-externally-checkable-type arg
))
1734 (setf (combination-args use
) nil
)
1736 (setf (combination-args node
) args
))
1739 ;;; If VALUES appears in a non-MV context, then effectively convert it
1740 ;;; to a PROG1. This allows the computation of the additional values
1741 ;;; to become dead code.
1742 (deftransform values
((&rest vals
) * * :node node
)
1743 (unless (lvar-single-value-p (node-lvar node
))
1744 (give-up-ir1-transform))
1745 (setf (node-derived-type node
)
1746 (make-short-values-type (list (single-value-type
1747 (node-derived-type node
)))))
1748 (principal-lvar-single-valuify (node-lvar node
))
1750 (let ((dummies (make-gensym-list (length (cdr vals
)))))
1751 `(lambda (val ,@dummies
)
1752 (declare (ignore ,@dummies
))
1758 (defun ir1-optimize-cast (cast &optional do-not-optimize
)
1759 (declare (type cast cast
))
1760 (let ((value (cast-value cast
))
1761 (atype (cast-asserted-type cast
)))
1762 (when (not do-not-optimize
)
1763 (let ((lvar (node-lvar cast
)))
1764 (when (values-subtypep (lvar-derived-type value
)
1765 (cast-asserted-type cast
))
1766 (delete-filter cast lvar value
)
1768 (reoptimize-lvar lvar
)
1769 (when (lvar-single-value-p lvar
)
1770 (note-single-valuified-lvar lvar
)))
1771 (return-from ir1-optimize-cast t
))
1773 (when (and (listp (lvar-uses value
))
1775 ;; Pathwise removing of CAST
1776 (let ((ctran (node-next cast
))
1777 (dest (lvar-dest lvar
))
1780 (do-uses (use value
)
1781 (when (and (values-subtypep (node-derived-type use
) atype
)
1782 (immediately-used-p value use
))
1784 (when ctran
(ensure-block-start ctran
))
1785 (setq next-block
(first (block-succ (node-block cast
))))
1786 (ensure-block-start (node-prev cast
))
1787 (reoptimize-lvar lvar
)
1788 (setf (lvar-%derived-type value
) nil
))
1789 (%delete-lvar-use use
)
1790 (add-lvar-use use lvar
)
1791 (unlink-blocks (node-block use
) (node-block cast
))
1792 (link-blocks (node-block use
) next-block
)
1793 (when (and (return-p dest
)
1794 (basic-combination-p use
)
1795 (eq (basic-combination-kind use
) :local
))
1797 (dolist (use (merges))
1798 (merge-tail-sets use
)))))))
1800 (let* ((value-type (lvar-derived-type value
))
1801 (int (values-type-intersection value-type atype
)))
1802 (derive-node-type cast int
)
1803 (when (eq int
*empty-type
*)
1804 (unless (eq value-type
*empty-type
*)
1806 ;; FIXME: Do it in one step.
1809 (if (cast-single-value-p cast
)
1811 `(multiple-value-call #'list
'dummy
)))
1814 ;; FIXME: Derived type.
1815 `(%compile-time-type-error
'dummy
1816 ',(type-specifier atype
)
1817 ',(type-specifier value-type
)))
1818 ;; KLUDGE: FILTER-LVAR does not work for non-returning
1819 ;; functions, so we declare the return type of
1820 ;; %COMPILE-TIME-TYPE-ERROR to be * and derive the real type
1822 (setq value
(cast-value cast
))
1823 (derive-node-type (lvar-uses value
) *empty-type
*)
1824 (maybe-terminate-block (lvar-uses value
) nil
)
1825 ;; FIXME: Is it necessary?
1826 (aver (null (block-pred (node-block cast
))))
1827 (delete-block-lazily (node-block cast
))
1828 (return-from ir1-optimize-cast
)))
1829 (when (eq (node-derived-type cast
) *empty-type
*)
1830 (maybe-terminate-block cast nil
))
1832 (when (and (cast-%type-check cast
)
1833 (values-subtypep value-type
1834 (cast-type-to-check cast
)))
1835 (setf (cast-%type-check cast
) nil
))))
1837 (unless do-not-optimize
1838 (setf (node-reoptimize cast
) nil
)))