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