src/compiler/ir1util.lisp

   1 ;;;; This file contains miscellaneous utilities used for manipulating
   2 ;;;; the IR1 representation.
   3
   4 ;;;; This software is part of the SBCL system. See the README file for
   5 ;;;; more information.
   6 ;;;;
   7 ;;;; This software is derived from the CMU CL system, which was
   8 ;;;; written at Carnegie Mellon University and released into the
   9 ;;;; public domain. The software is in the public domain and is
  10 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
  11 ;;;; files for more information.
  12
  13 (in-package "SB!C")
  14 \f
  15 ;;;; cleanup hackery
  16
  17 ;;; Return the innermost cleanup enclosing NODE, or NIL if there is
  18 ;;; none in its function. If NODE has no cleanup, but is in a LET,
  19 ;;; then we must still check the environment that the call is in.
  20 (defun node-enclosing-cleanup (node)
  21   (declare (type node node))
  22   (do ((lexenv (node-lexenv node)
  23                (lambda-call-lexenv (lexenv-lambda lexenv))))
  24       ((null lexenv) nil)
  25     (let ((cup (lexenv-cleanup lexenv)))
  26       (when cup (return cup)))))
  27
  28 ;;; Convert the FORM in a block inserted between BLOCK1 and BLOCK2 as
  29 ;;; an implicit MV-PROG1. The inserted block is returned. NODE is used
  30 ;;; for IR1 context when converting the form. Note that the block is
  31 ;;; not assigned a number, and is linked into the DFO at the
  32 ;;; beginning. We indicate that we have trashed the DFO by setting
  33 ;;; COMPONENT-REANALYZE. If CLEANUP is supplied, then convert with
  34 ;;; that cleanup.
  35 (defun insert-cleanup-code (block1 block2 node form &optional cleanup)
  36   (declare (type cblock block1 block2) (type node node)
  37            (type (or cleanup null) cleanup))
  38   (setf (component-reanalyze (block-component block1)) t)
  39   (with-ir1-environment-from-node node
  40     (let* ((start (make-continuation))
  41            (block (continuation-starts-block start))
  42            (cont (make-continuation))
  43            (*lexenv* (if cleanup
  44                          (make-lexenv :cleanup cleanup)
  45                          *lexenv*)))
  46       (change-block-successor block1 block2 block)
  47       (link-blocks block block2)
  48       (ir1-convert start cont form)
  49       (setf (block-last block) (continuation-use cont))
  50       block)))
  51 \f
  52 ;;;; continuation use hacking
  53
  54 ;;; Return a list of all the nodes which use Cont.
  55 (declaim (ftype (function (continuation) list) find-uses))
  56 (defun find-uses (cont)
  57   (ecase (continuation-kind cont)
  58     ((:block-start :deleted-block-start)
  59      (block-start-uses (continuation-block cont)))
  60     (:inside-block (list (continuation-use cont)))
  61     (:unused nil)
  62     (:deleted nil)))
  63
  64 ;;; Update continuation use information so that NODE is no longer a
  65 ;;; use of its CONT. If the old continuation doesn't start its block,
  66 ;;; then we don't update the BLOCK-START-USES, since it will be
  67 ;;; deleted when we are done.
  68 ;;;
  69 ;;; Note: if you call this function, you may have to do a
  70 ;;; REOPTIMIZE-CONTINUATION to inform IR1 optimization that something
  71 ;;; has changed.
  72 (declaim (ftype (function (node) (values)) delete-continuation-use))
  73 (defun delete-continuation-use (node)
  74   (let* ((cont (node-cont node))
  75          (block (continuation-block cont)))
  76     (ecase (continuation-kind cont)
  77       (:deleted)
  78       ((:block-start :deleted-block-start)
  79        (let ((uses (delete node (block-start-uses block))))
  80          (setf (block-start-uses block) uses)
  81          (setf (continuation-use cont)
  82                (if (cdr uses) nil (car uses)))))
  83       (:inside-block
  84        (setf (continuation-kind cont) :unused)
  85        (setf (continuation-block cont) nil)
  86        (setf (continuation-use cont) nil)
  87        (setf (continuation-next cont) nil)))
  88     (setf (node-cont node) nil))
  89   (values))
  90
  91 ;;; Update continuation use information so that NODE uses CONT. If
  92 ;;; CONT is :UNUSED, then we set its block to NODE's NODE-BLOCK (which
  93 ;;; must be set.)
  94 ;;;
  95 ;;; Note: if you call this function, you may have to do a
  96 ;;; REOPTIMIZE-CONTINUATION to inform IR1 optimization that something
  97 ;;; has changed.
  98 (declaim (ftype (function (node continuation) (values)) add-continuation-use))
  99 (defun add-continuation-use (node cont)
 100   (aver (not (node-cont node)))
 101   (let ((block (continuation-block cont)))
 102     (ecase (continuation-kind cont)
 103       (:deleted)
 104       (:unused
 105        (aver (not block))
 106        (let ((block (node-block node)))
 107          (aver block)
 108          (setf (continuation-block cont) block))
 109        (setf (continuation-kind cont) :inside-block)
 110        (setf (continuation-use cont) node))
 111       ((:block-start :deleted-block-start)
 112        (let ((uses (cons node (block-start-uses block))))
 113          (setf (block-start-uses block) uses)
 114          (setf (continuation-use cont)
 115                (if (cdr uses) nil (car uses)))))))
 116   (setf (node-cont node) cont)
 117   (values))
 118
 119 ;;; Return true if CONT is the NODE-CONT for NODE and CONT is
 120 ;;; transferred to immediately after the evaluation of NODE.
 121 (defun immediately-used-p (cont node)
 122   (declare (type continuation cont) (type node node))
 123   (and (eq (node-cont node) cont)
 124        (not (eq (continuation-kind cont) :deleted))
 125        (let ((cblock (continuation-block cont))
 126              (nblock (node-block node)))
 127          (or (eq cblock nblock)
 128              (let ((succ (block-succ nblock)))
 129                (and (= (length succ) 1)
 130                     (eq (first succ) cblock)))))))
 131 \f
 132 ;;;; continuation substitution
 133
 134 ;;; In OLD's DEST, replace OLD with NEW. NEW's DEST must initially be
 135 ;;; NIL. When we are done, we call FLUSH-DEST on OLD to clear its DEST
 136 ;;; and to note potential optimization opportunities.
 137 (defun substitute-continuation (new old)
 138   (declare (type continuation old new))
 139   (aver (not (continuation-dest new)))
 140   (let ((dest (continuation-dest old)))
 141     (etypecase dest
 142       ((or ref bind))
 143       (cif (setf (if-test dest) new))
 144       (cset (setf (set-value dest) new))
 145       (creturn (setf (return-result dest) new))
 146       (exit (setf (exit-value dest) new))
 147       (basic-combination
 148        (if (eq old (basic-combination-fun dest))
 149            (setf (basic-combination-fun dest) new)
 150            (setf (basic-combination-args dest)
 151                  (nsubst new old (basic-combination-args dest))))))
 152
 153     (flush-dest old)
 154     (setf (continuation-dest new) dest))
 155   (values))
 156
 157 ;;; Replace all uses of OLD with uses of NEW, where NEW has an
 158 ;;; arbitary number of uses. If NEW will end up with more than one
 159 ;;; use, then we must arrange for it to start a block if it doesn't
 160 ;;; already.
 161 (defun substitute-continuation-uses (new old)
 162   (declare (type continuation old new))
 163   (unless (and (eq (continuation-kind new) :unused)
 164                (eq (continuation-kind old) :inside-block))
 165     (ensure-block-start new))
 166
 167   (do-uses (node old)
 168     (delete-continuation-use node)
 169     (add-continuation-use node new))
 170   (dolist (lexenv-use (continuation-lexenv-uses old))
 171     (setf (cadr lexenv-use) new))
 172
 173   (reoptimize-continuation new)
 174   (values))
 175 \f
 176 ;;;; block starting/creation
 177
 178 ;;; Return the block that CONT is the start of, making a block if
 179 ;;; necessary. This function is called by IR1 translators which may
 180 ;;; cause a continuation to be used more than once. Every continuation
 181 ;;; which may be used more than once must start a block by the time
 182 ;;; that anyone does a USE-CONTINUATION on it.
 183 ;;;
 184 ;;; We also throw the block into the next/prev list for the
 185 ;;; *CURRENT-COMPONENT* so that we keep track of which blocks we have
 186 ;;; made.
 187 (defun continuation-starts-block (cont)
 188   (declare (type continuation cont))
 189   (ecase (continuation-kind cont)
 190     (:unused
 191      (aver (not (continuation-block cont)))
 192      (let* ((head (component-head *current-component*))
 193             (next (block-next head))
 194             (new-block (make-block cont)))
 195        (setf (block-next new-block) next
 196              (block-prev new-block) head
 197              (block-prev next) new-block
 198              (block-next head) new-block
 199              (continuation-block cont) new-block
 200              (continuation-use cont) nil
 201              (continuation-kind cont) :block-start)
 202        new-block))
 203     (:block-start
 204      (continuation-block cont))))
 205
 206 ;;; Ensure that CONT is the start of a block (or deleted) so that
 207 ;;; the use set can be freely manipulated.
 208 ;;; -- If the continuation is :UNUSED or is :INSIDE-BLOCK and the
 209 ;;;    CONT of LAST in its block, then we make it the start of a new
 210 ;;;    deleted block.
 211 ;;; -- If the continuation is :INSIDE-BLOCK inside a block, then we
 212 ;;;    split the block using Node-Ends-Block, which makes the
 213 ;;;    continuation be a :BLOCK-START.
 214 (defun ensure-block-start (cont)
 215   (declare (type continuation cont))
 216   (let ((kind (continuation-kind cont)))
 217     (ecase kind
 218       ((:deleted :block-start :deleted-block-start))
 219       ((:unused :inside-block)
 220        (let ((block (continuation-block cont)))
 221          (cond ((or (eq kind :unused)
 222                     (eq (node-cont (block-last block)) cont))
 223                 (setf (continuation-block cont)
 224                       (make-block-key :start cont
 225                                       :component nil
 226                                       :start-uses (find-uses cont)))
 227                 (setf (continuation-kind cont) :deleted-block-start))
 228                (t
 229                 (node-ends-block (continuation-use cont))))))))
 230   (values))
 231 \f
 232 ;;;; miscellaneous shorthand functions
 233
 234 ;;; Return the home (i.e. enclosing non-LET) CLAMBDA for NODE. Since
 235 ;;; the LEXENV-LAMBDA may be deleted, we must chain up the
 236 ;;; LAMBDA-CALL-LEXENV thread until we find a CLAMBDA that isn't
 237 ;;; deleted, and then return its home.
 238 (defun node-home-lambda (node)
 239   (declare (type node node))
 240   (do ((fun (lexenv-lambda (node-lexenv node))
 241             (lexenv-lambda (lambda-call-lexenv fun))))
 242       ((not (eq (functional-kind fun) :deleted))
 243        (lambda-home fun))
 244     (when (eq (lambda-home fun) fun)
 245       (return fun))))
 246
 247 (defun node-block (node)
 248   (declare (type node node))
 249   (the cblock (continuation-block (node-prev node))))
 250 (defun node-component (node)
 251   (declare (type node node))
 252   (block-component (node-block node)))
 253 (defun node-physenv (node)
 254   (declare (type node node))
 255   (the physenv (lambda-physenv (node-home-lambda node))))
 256
 257 (defun lambda-block (clambda)
 258   (declare (type clambda clambda))
 259   (node-block (lambda-bind clambda)))
 260 (defun lambda-component (clambda)
 261   (block-component (lambda-block clambda)))
 262
 263 ;;; Return the enclosing cleanup for environment of the first or last
 264 ;;; node in BLOCK.
 265 (defun block-start-cleanup (block)
 266   (declare (type cblock block))
 267   (node-enclosing-cleanup (continuation-next (block-start block))))
 268 (defun block-end-cleanup (block)
 269   (declare (type cblock block))
 270   (node-enclosing-cleanup (block-last block)))
 271
 272 ;;; Return the non-LET LAMBDA that holds BLOCK's code, or NIL
 273 ;;; if there is none.
 274 ;;;
 275 ;;; There can legitimately be no home lambda in dead code early in the
 276 ;;; IR1 conversion process, e.g. when IR1-converting the SETQ form in
 277 ;;;   (BLOCK B (RETURN-FROM B) (SETQ X 3))
 278 ;;; where the block is just a placeholder during parsing and doesn't
 279 ;;; actually correspond to code which will be written anywhere.
 280 (defun block-home-lambda-or-null (block)
 281   (declare (type cblock block))
 282   (if (node-p (block-last block))
 283       ;; This is the old CMU CL way of doing it.
 284       (node-home-lambda (block-last block))
 285       ;; Now that SBCL uses this operation more aggressively than CMU
 286       ;; CL did, the old CMU CL way of doing it can fail in two ways.
 287       ;;   1. It can fail in a few cases even when a meaningful home
 288       ;;      lambda exists, e.g. in IR1-CONVERT of one of the legs of
 289       ;;      an IF.
 290       ;;   2. It can fail when converting a form which is born orphaned
 291       ;;      so that it never had a meaningful home lambda, e.g. a form
 292       ;;      which follows a RETURN-FROM or GO form.
 293       (let ((pred-list (block-pred block)))
 294         ;; To deal with case 1, we reason that
 295         ;; previous-in-target-execution-order blocks should be in the
 296         ;; same lambda, and that they seem in practice to be
 297         ;; previous-in-compilation-order blocks too, so we look back
 298         ;; to find one which is sufficiently initialized to tell us
 299         ;; what the home lambda is.
 300         (if pred-list
 301             ;; We could get fancy about this, flooding through the
 302             ;; graph of all the previous blocks, but in practice it
 303             ;; seems to work just to grab the first previous block and
 304             ;; use it.
 305             (node-home-lambda (block-last (first pred-list)))
 306             ;; In case 2, we end up with an empty PRED-LIST and
 307             ;; have to punt: There's no home lambda.
 308             nil))))
 309
 310 ;;; Return the non-LET LAMBDA that holds BLOCK's code.
 311 (defun block-home-lambda (block)
 312   (the clambda
 313     (block-home-lambda-or-null block)))
 314
 315 ;;; Return the IR1 physical environment for BLOCK.
 316 (defun block-physenv (block)
 317   (declare (type cblock block))
 318   (lambda-physenv (block-home-lambda block)))
 319
 320 ;;; Return the Top Level Form number of PATH, i.e. the ordinal number
 321 ;;; of its original source's top level form in its compilation unit.
 322 (defun source-path-tlf-number (path)
 323   (declare (list path))
 324   (car (last path)))
 325
 326 ;;; Return the (reversed) list for the PATH in the original source
 327 ;;; (with the Top Level Form number last).
 328 (defun source-path-original-source (path)
 329   (declare (list path) (inline member))
 330   (cddr (member 'original-source-start path :test #'eq)))
 331
 332 ;;; Return the Form Number of PATH's original source inside the Top
 333 ;;; Level Form that contains it. This is determined by the order that
 334 ;;; we walk the subforms of the top level source form.
 335 (defun source-path-form-number (path)
 336   (declare (list path) (inline member))
 337   (cadr (member 'original-source-start path :test #'eq)))
 338
 339 ;;; Return a list of all the enclosing forms not in the original
 340 ;;; source that converted to get to this form, with the immediate
 341 ;;; source for node at the start of the list.
 342 (defun source-path-forms (path)
 343   (subseq path 0 (position 'original-source-start path)))
 344
 345 ;;; Return the innermost source form for NODE.
 346 (defun node-source-form (node)
 347   (declare (type node node))
 348   (let* ((path (node-source-path node))
 349          (forms (source-path-forms path)))
 350     (if forms
 351         (first forms)
 352         (values (find-original-source path)))))
 353
 354 ;;; Return NODE-SOURCE-FORM, T if continuation has a single use,
 355 ;;; otherwise NIL, NIL.
 356 (defun continuation-source (cont)
 357   (let ((use (continuation-use cont)))
 358     (if use
 359         (values (node-source-form use) t)
 360         (values nil nil))))
 361
 362 ;;; Return the LAMBDA that is CONT's home, or NIL if there is none.
 363 (defun continuation-home-lambda-or-null (cont)
 364   ;; KLUDGE: This function is a post-CMU-CL hack by WHN, and this
 365   ;; implementation might not be quite right, or might be uglier than
 366   ;; necessary. It appears that the original Python never found a need
 367   ;; to do this operation. The obvious things based on
 368   ;; NODE-HOME-LAMBDA of CONTINUATION-USE usually work; then if that
 369   ;; fails, BLOCK-HOME-LAMBDA of CONTINUATION-BLOCK works, given that
 370   ;; we generalize it enough to grovel harder when the simple CMU CL
 371   ;; approach fails, and furthermore realize that in some exceptional
 372   ;; cases it might return NIL. -- WHN 2001-12-04
 373   (cond ((continuation-use cont)
 374          (node-home-lambda (continuation-use cont)))
 375         ((continuation-block cont)
 376          (block-home-lambda-or-null (continuation-block cont)))
 377         (t
 378          (bug "confused about home lambda for ~S"))))
 379
 380 ;;; Return the LAMBDA that is CONT's home.
 381 (defun continuation-home-lambda (cont)
 382   (the clambda
 383     (continuation-home-lambda-or-null cont)))
 384 \f
 385 ;;; Return a new LEXENV just like DEFAULT except for the specified
 386 ;;; slot values. Values for the alist slots are NCONCed to the
 387 ;;; beginning of the current value, rather than replacing it entirely.
 388 (defun make-lexenv (&key (default *lexenv*)
 389                          funs vars blocks tags type-restrictions options
 390                          (lambda (lexenv-lambda default))
 391                          (cleanup (lexenv-cleanup default))
 392                          (policy (lexenv-policy default)))
 393   (macrolet ((frob (var slot)
 394                `(let ((old (,slot default)))
 395                   (if ,var
 396                       (nconc ,var old)
 397                       old))))
 398     (internal-make-lexenv
 399      (frob funs lexenv-funs)
 400      (frob vars lexenv-vars)
 401      (frob blocks lexenv-blocks)
 402      (frob tags lexenv-tags)
 403      (frob type-restrictions lexenv-type-restrictions)
 404      lambda cleanup policy
 405      (frob options lexenv-options))))
 406 \f
 407 ;;;; flow/DFO/component hackery
 408
 409 ;;; Join BLOCK1 and BLOCK2.
 410 (defun link-blocks (block1 block2)
 411   (declare (type cblock block1 block2))
 412   (setf (block-succ block1)
 413         (if (block-succ block1)
 414             (%link-blocks block1 block2)
 415             (list block2)))
 416   (push block1 (block-pred block2))
 417   (values))
 418 (defun %link-blocks (block1 block2)
 419   (declare (type cblock block1 block2) (inline member))
 420   (let ((succ1 (block-succ block1)))
 421     (aver (not (member block2 succ1 :test #'eq)))
 422     (cons block2 succ1)))
 423
 424 ;;; This is like LINK-BLOCKS, but we separate BLOCK1 and BLOCK2. If
 425 ;;; this leaves a successor with a single predecessor that ends in an
 426 ;;; IF, then set BLOCK-TEST-MODIFIED so that any test constraint will
 427 ;;; now be able to be propagated to the successor.
 428 (defun unlink-blocks (block1 block2)
 429   (declare (type cblock block1 block2))
 430   (let ((succ1 (block-succ block1)))
 431     (if (eq block2 (car succ1))
 432         (setf (block-succ block1) (cdr succ1))
 433         (do ((succ (cdr succ1) (cdr succ))
 434              (prev succ1 succ))
 435             ((eq (car succ) block2)
 436              (setf (cdr prev) (cdr succ)))
 437           (aver succ))))
 438
 439   (let ((new-pred (delq block1 (block-pred block2))))
 440     (setf (block-pred block2) new-pred)
 441     (when (and new-pred (null (rest new-pred)))
 442       (let ((pred-block (first new-pred)))
 443         (when (if-p (block-last pred-block))
 444           (setf (block-test-modified pred-block) t)))))
 445   (values))
 446
 447 ;;; Swing the succ/pred link between BLOCK and OLD to be between BLOCK
 448 ;;; and NEW. If BLOCK ends in an IF, then we have to fix up the
 449 ;;; consequent/alternative blocks to point to NEW. We also set
 450 ;;; BLOCK-TEST-MODIFIED so that any test constraint will be applied to
 451 ;;; the new successor.
 452 (defun change-block-successor (block old new)
 453   (declare (type cblock new old block) (inline member))
 454   (unlink-blocks block old)
 455   (let ((last (block-last block))
 456         (comp (block-component block)))
 457     (setf (component-reanalyze comp) t)
 458     (typecase last
 459       (cif
 460        (setf (block-test-modified block) t)
 461        (let* ((succ-left (block-succ block))
 462               (new (if (and (eq new (component-tail comp))
 463                             succ-left)
 464                        (first succ-left)
 465                        new)))
 466          (unless (member new succ-left :test #'eq)
 467            (link-blocks block new))
 468          (macrolet ((frob (slot)
 469                       `(when (eq (,slot last) old)
 470                          (setf (,slot last) new))))
 471            (frob if-consequent)
 472            (frob if-alternative)
 473            (when (eq (if-consequent last)
 474                      (if-alternative last))
 475              (setf (component-reoptimize (block-component block)) t)))))
 476       (t
 477        (unless (member new (block-succ block) :test #'eq)
 478          (link-blocks block new)))))
 479
 480   (values))
 481
 482 ;;; Unlink a block from the next/prev chain. We also null out the
 483 ;;; COMPONENT.
 484 (declaim (ftype (function (cblock) (values)) remove-from-dfo))
 485 (defun remove-from-dfo (block)
 486   (let ((next (block-next block))
 487         (prev (block-prev block)))
 488     (setf (block-component block) nil)
 489     (setf (block-next prev) next)
 490     (setf (block-prev next) prev))
 491   (values))
 492
 493 ;;; Add BLOCK to the next/prev chain following AFTER. We also set the
 494 ;;; COMPONENT to be the same as for AFTER.
 495 (defun add-to-dfo (block after)
 496   (declare (type cblock block after))
 497   (let ((next (block-next after))
 498         (comp (block-component after)))
 499     (aver (not (eq (component-kind comp) :deleted)))
 500     (setf (block-component block) comp)
 501     (setf (block-next after) block)
 502     (setf (block-prev block) after)
 503     (setf (block-next block) next)
 504     (setf (block-prev next) block))
 505   (values))
 506
 507 ;;; Set the FLAG for all the blocks in COMPONENT to NIL, except for
 508 ;;; the head and tail which are set to T.
 509 (declaim (ftype (function (component) (values)) clear-flags))
 510 (defun clear-flags (component)
 511   (let ((head (component-head component))
 512         (tail (component-tail component)))
 513     (setf (block-flag head) t)
 514     (setf (block-flag tail) t)
 515     (do-blocks (block component)
 516       (setf (block-flag block) nil)))
 517   (values))
 518
 519 ;;; Make a component with no blocks in it. The BLOCK-FLAG is initially
 520 ;;; true in the head and tail blocks.
 521 (declaim (ftype (function nil component) make-empty-component))
 522 (defun make-empty-component ()
 523   (let* ((head (make-block-key :start nil :component nil))
 524          (tail (make-block-key :start nil :component nil))
 525          (res (make-component :head head :tail tail)))
 526     (setf (block-flag head) t)
 527     (setf (block-flag tail) t)
 528     (setf (block-component head) res)
 529     (setf (block-component tail) res)
 530     (setf (block-next head) tail)
 531     (setf (block-prev tail) head)
 532     res))
 533
 534 ;;; Make NODE the LAST node in its block, splitting the block if necessary.
 535 ;;; The new block is added to the DFO immediately following NODE's block.
 536 (defun node-ends-block (node)
 537   (declare (type node node))
 538   (let* ((block (node-block node))
 539          (start (node-cont node))
 540          (last (block-last block))
 541          (last-cont (node-cont last)))
 542     (unless (eq last node)
 543       (aver (and (eq (continuation-kind start) :inside-block)
 544                    (not (block-delete-p block))))
 545       (let* ((succ (block-succ block))
 546              (new-block
 547               (make-block-key :start start
 548                               :component (block-component block)
 549                               :start-uses (list (continuation-use start))
 550                               :succ succ :last last)))
 551         (setf (continuation-kind start) :block-start)
 552         (dolist (b succ)
 553           (setf (block-pred b)
 554                 (cons new-block (remove block (block-pred b)))))
 555         (setf (block-succ block) ())
 556         (setf (block-last block) node)
 557         (link-blocks block new-block)
 558         (add-to-dfo new-block block)
 559         (setf (component-reanalyze (block-component block)) t)
 560
 561         (do ((cont start (node-cont (continuation-next cont))))
 562             ((eq cont last-cont)
 563              (when (eq (continuation-kind last-cont) :inside-block)
 564                (setf (continuation-block last-cont) new-block)))
 565           (setf (continuation-block cont) new-block))
 566
 567         (setf (block-type-asserted block) t)
 568         (setf (block-test-modified block) t))))
 569
 570   (values))
 571 \f
 572 ;;;; deleting stuff
 573
 574 ;;; Deal with deleting the last (read) reference to a LAMBDA-VAR.
 575 (defun delete-lambda-var (leaf)
 576   (declare (type lambda-var leaf))
 577
 578   ;; Iterate over all local calls flushing the corresponding argument,
 579   ;; allowing the computation of the argument to be deleted. We also
 580   ;; mark the LET for reoptimization, since it may be that we have
 581   ;; deleted its last variable.
 582   (let* ((fun (lambda-var-home leaf))
 583          (n (position leaf (lambda-vars fun))))
 584     (dolist (ref (leaf-refs fun))
 585       (let* ((cont (node-cont ref))
 586              (dest (continuation-dest cont)))
 587         (when (and (combination-p dest)
 588                    (eq (basic-combination-fun dest) cont)
 589                    (eq (basic-combination-kind dest) :local))
 590           (let* ((args (basic-combination-args dest))
 591                  (arg (elt args n)))
 592             (reoptimize-continuation arg)
 593             (flush-dest arg)
 594             (setf (elt args n) nil))))))
 595
 596   ;; The LAMBDA-VAR may still have some SETs, but this doesn't cause
 597   ;; too much difficulty, since we can efficiently implement
 598   ;; write-only variables. We iterate over the SETs, marking their
 599   ;; blocks for dead code flushing, since we can delete SETs whose
 600   ;; value is unused.
 601   (dolist (set (lambda-var-sets leaf))
 602     (setf (block-flush-p (node-block set)) t))
 603
 604   (values))
 605
 606 ;;; Note that something interesting has happened to VAR.
 607 (defun reoptimize-lambda-var (var)
 608   (declare (type lambda-var var))
 609   (let ((fun (lambda-var-home var)))
 610     ;; We only deal with LET variables, marking the corresponding
 611     ;; initial value arg as needing to be reoptimized.
 612     (when (and (eq (functional-kind fun) :let)
 613                (leaf-refs var))
 614       (do ((args (basic-combination-args
 615                   (continuation-dest
 616                    (node-cont
 617                     (first (leaf-refs fun)))))
 618                  (cdr args))
 619            (vars (lambda-vars fun) (cdr vars)))
 620           ((eq (car vars) var)
 621            (reoptimize-continuation (car args))))))
 622   (values))
 623
 624 ;;; Delete a function that has no references. This need only be called
 625 ;;; on functions that never had any references, since otherwise
 626 ;;; DELETE-REF will handle the deletion.
 627 (defun delete-functional (fun)
 628   (aver (and (null (leaf-refs fun))
 629              (not (functional-entry-fun fun))))
 630   (etypecase fun
 631     (optional-dispatch (delete-optional-dispatch fun))
 632     (clambda (delete-lambda fun)))
 633   (values))
 634
 635 ;;; Deal with deleting the last reference to a CLAMBDA. Since there is
 636 ;;; only one way into a CLAMBDA, deleting the last reference to a
 637 ;;; CLAMBDA ensures that there is no way to reach any of the code in
 638 ;;; it. So we just set the FUNCTIONAL-KIND for FUN and its LETs to
 639 ;;; :DELETED, causing IR1 optimization to delete blocks in that
 640 ;;; CLAMBDA.
 641 (defun delete-lambda (clambda)
 642   (declare (type clambda clambda))
 643   (let ((original-kind (functional-kind clambda))
 644         (bind (lambda-bind clambda)))
 645     (aver (not (member original-kind '(:deleted :optional :toplevel))))
 646     (aver (not (functional-has-external-references-p clambda)))
 647     (setf (functional-kind clambda) :deleted)
 648     (setf (lambda-bind clambda) nil)
 649     (dolist (let (lambda-lets clambda))
 650       (setf (lambda-bind let) nil)
 651       (setf (functional-kind let) :deleted))
 652
 653     ;; (The IF test is (FUNCTIONAL-SOMEWHAT-LETLIKE-P CLAMBDA), except
 654     ;; that we're using the old value of the KIND slot, not the
 655     ;; current slot value, which has now been set to :DELETED.)
 656     (if (member original-kind '(:let :mv-let :assignment))
 657         (let ((home (lambda-home clambda)))
 658           (setf (lambda-lets home) (delete clambda (lambda-lets home))))
 659         ;; If the function isn't a LET, we unlink the function head
 660         ;; and tail from the component head and tail to indicate that
 661         ;; the code is unreachable. We also delete the function from
 662         ;; COMPONENT-LAMBDAS (it won't be there before local call
 663         ;; analysis, but no matter.) If the lambda was never
 664         ;; referenced, we give a note.
 665         (let* ((bind-block (node-block bind))
 666                (component (block-component bind-block))
 667                (return (lambda-return clambda)))
 668           (dolist (ref (lambda-refs clambda))
 669             (let ((home (node-home-lambda ref)))
 670               (aver (eq home clambda))))
 671           (unless (leaf-ever-used clambda)
 672             (let ((*compiler-error-context* bind))
 673               (compiler-note "deleting unused function~:[.~;~:*~%  ~S~]"
 674                              (leaf-debug-name clambda))))
 675           (unlink-blocks (component-head component) bind-block)
 676           (when return
 677             (unlink-blocks (node-block return) (component-tail component)))
 678           (setf (component-reanalyze component) t)
 679           (let ((tails (lambda-tail-set clambda)))
 680             (setf (tail-set-funs tails)
 681                   (delete clambda (tail-set-funs tails)))
 682             (setf (lambda-tail-set clambda) nil))
 683           (setf (component-lambdas component)
 684                 (delete clambda (component-lambdas component)))))
 685
 686     ;; If the lambda is an XEP, then we null out the ENTRY-FUN in its
 687     ;; ENTRY-FUN so that people will know that it is not an entry
 688     ;; point anymore.
 689     (when (eq original-kind :external)
 690       (let ((fun (functional-entry-fun clambda)))
 691         (setf (functional-entry-fun fun) nil)
 692         (when (optional-dispatch-p fun)
 693           (delete-optional-dispatch fun)))))
 694
 695   (values))
 696
 697 ;;; Deal with deleting the last reference to an OPTIONAL-DISPATCH. We
 698 ;;; have to be a bit more careful than with lambdas, since DELETE-REF
 699 ;;; is used both before and after local call analysis. Afterward, all
 700 ;;; references to still-existing OPTIONAL-DISPATCHes have been moved
 701 ;;; to the XEP, leaving it with no references at all. So we look at
 702 ;;; the XEP to see whether an optional-dispatch is still really being
 703 ;;; used. But before local call analysis, there are no XEPs, and all
 704 ;;; references are direct.
 705 ;;;
 706 ;;; When we do delete the OPTIONAL-DISPATCH, we grovel all of its
 707 ;;; entry-points, making them be normal lambdas, and then deleting the
 708 ;;; ones with no references. This deletes any e-p lambdas that were
 709 ;;; either never referenced, or couldn't be deleted when the last
 710 ;;; reference was deleted (due to their :OPTIONAL kind.)
 711 ;;;
 712 ;;; Note that the last optional entry point may alias the main entry,
 713 ;;; so when we process the main entry, its KIND may have been changed
 714 ;;; to NIL or even converted to a LETlike value.
 715 (defun delete-optional-dispatch (leaf)
 716   (declare (type optional-dispatch leaf))
 717   (let ((entry (functional-entry-fun leaf)))
 718     (unless (and entry (leaf-refs entry))
 719       (aver (or (not entry) (eq (functional-kind entry) :deleted)))
 720       (setf (functional-kind leaf) :deleted)
 721
 722       (flet ((frob (fun)
 723                (unless (eq (functional-kind fun) :deleted)
 724                  (aver (eq (functional-kind fun) :optional))
 725                  (setf (functional-kind fun) nil)
 726                  (let ((refs (leaf-refs fun)))
 727                    (cond ((null refs)
 728                           (delete-lambda fun))
 729                          ((null (rest refs))
 730                           (or (maybe-let-convert fun)
 731                               (maybe-convert-to-assignment fun)))
 732                          (t
 733                           (maybe-convert-to-assignment fun)))))))
 734
 735         (dolist (ep (optional-dispatch-entry-points leaf))
 736           (frob ep))
 737         (when (optional-dispatch-more-entry leaf)
 738           (frob (optional-dispatch-more-entry leaf)))
 739         (let ((main (optional-dispatch-main-entry leaf)))
 740           (when (eq (functional-kind main) :optional)
 741             (frob main))))))
 742
 743   (values))
 744
 745 ;;; Do stuff to delete the semantic attachments of a REF node. When
 746 ;;; this leaves zero or one reference, we do a type dispatch off of
 747 ;;; the leaf to determine if a special action is appropriate.
 748 (defun delete-ref (ref)
 749   (declare (type ref ref))
 750   (let* ((leaf (ref-leaf ref))
 751          (refs (delete ref (leaf-refs leaf))))
 752     (setf (leaf-refs leaf) refs)
 753
 754     (cond ((null refs)
 755            (typecase leaf
 756              (lambda-var
 757               (delete-lambda-var leaf))
 758              (clambda
 759               (ecase (functional-kind leaf)
 760                 ((nil :let :mv-let :assignment :escape :cleanup)
 761                  (aver (null (functional-entry-fun leaf)))
 762                  (delete-lambda leaf))
 763                 (:external
 764                  (delete-lambda leaf))
 765                 ((:deleted :optional))))
 766              (optional-dispatch
 767               (unless (eq (functional-kind leaf) :deleted)
 768                 (delete-optional-dispatch leaf)))))
 769           ((null (rest refs))
 770            (typecase leaf
 771              (clambda (or (maybe-let-convert leaf)
 772                           (maybe-convert-to-assignment leaf)))
 773              (lambda-var (reoptimize-lambda-var leaf))))
 774           (t
 775            (typecase leaf
 776              (clambda (maybe-convert-to-assignment leaf))))))
 777
 778   (values))
 779
 780 ;;; This function is called by people who delete nodes; it provides a
 781 ;;; way to indicate that the value of a continuation is no longer
 782 ;;; used. We null out the CONTINUATION-DEST, set FLUSH-P in the blocks
 783 ;;; containing uses of CONT and set COMPONENT-REOPTIMIZE. If the PREV
 784 ;;; of the use is deleted, then we blow off reoptimization.
 785 ;;;
 786 ;;; If the continuation is :DELETED, then we don't do anything, since
 787 ;;; all semantics have already been flushed. :DELETED-BLOCK-START
 788 ;;; start continuations are treated just like :BLOCK-START; it is
 789 ;;; possible that the continuation may be given a new dest (e.g. by
 790 ;;; SUBSTITUTE-CONTINUATION), so we don't want to delete it.
 791 (defun flush-dest (cont)
 792   (declare (type continuation cont))
 793
 794   (unless (eq (continuation-kind cont) :deleted)
 795     (aver (continuation-dest cont))
 796     (setf (continuation-dest cont) nil)
 797     (do-uses (use cont)
 798       (let ((prev (node-prev use)))
 799         (unless (eq (continuation-kind prev) :deleted)
 800           (let ((block (continuation-block prev)))
 801             (setf (component-reoptimize (block-component block)) t)
 802             (setf (block-attributep (block-flags block) flush-p type-asserted)
 803                   t))))))
 804
 805   (setf (continuation-%type-check cont) nil)
 806
 807   (values))
 808
 809 ;;; Do a graph walk backward from BLOCK, marking all predecessor
 810 ;;; blocks with the DELETE-P flag.
 811 (defun mark-for-deletion (block)
 812   (declare (type cblock block))
 813   (unless (block-delete-p block)
 814     (setf (block-delete-p block) t)
 815     (setf (component-reanalyze (block-component block)) t)
 816     (dolist (pred (block-pred block))
 817       (mark-for-deletion pred)))
 818   (values))
 819
 820 ;;; Delete CONT, eliminating both control and value semantics. We set
 821 ;;; FLUSH-P and COMPONENT-REOPTIMIZE similarly to in FLUSH-DEST. Here
 822 ;;; we must get the component from the use block, since the
 823 ;;; continuation may be a :DELETED-BLOCK-START.
 824 ;;;
 825 ;;; If CONT has DEST, then it must be the case that the DEST is
 826 ;;; unreachable, since we can't compute the value desired. In this
 827 ;;; case, we call MARK-FOR-DELETION to cause the DEST block and its
 828 ;;; predecessors to tell people to ignore them, and to cause them to
 829 ;;; be deleted eventually.
 830 (defun delete-continuation (cont)
 831   (declare (type continuation cont))
 832   (aver (not (eq (continuation-kind cont) :deleted)))
 833
 834   (do-uses (use cont)
 835     (let ((prev (node-prev use)))
 836       (unless (eq (continuation-kind prev) :deleted)
 837         (let ((block (continuation-block prev)))
 838           (setf (block-attributep (block-flags block) flush-p type-asserted) t)
 839           (setf (component-reoptimize (block-component block)) t)))))
 840
 841   (let ((dest (continuation-dest cont)))
 842     (when dest
 843       (let ((prev (node-prev dest)))
 844         (when (and prev
 845                    (not (eq (continuation-kind prev) :deleted)))
 846           (let ((block (continuation-block prev)))
 847             (unless (block-delete-p block)
 848               (mark-for-deletion block)))))))
 849
 850   (setf (continuation-kind cont) :deleted)
 851   (setf (continuation-dest cont) nil)
 852   (setf (continuation-next cont) nil)
 853   (setf (continuation-asserted-type cont) *empty-type*)
 854   (setf (continuation-%derived-type cont) *empty-type*)
 855   (setf (continuation-use cont) nil)
 856   (setf (continuation-block cont) nil)
 857   (setf (continuation-reoptimize cont) nil)
 858   (setf (continuation-%type-check cont) nil)
 859   (setf (continuation-info cont) nil)
 860
 861   (values))
 862
 863 ;;; This function does what is necessary to eliminate the code in it
 864 ;;; from the IR1 representation. This involves unlinking it from its
 865 ;;; predecessors and successors and deleting various node-specific
 866 ;;; semantic information.
 867 ;;;
 868 ;;; We mark the START as has having no next and remove the last node
 869 ;;; from its CONT's uses. We also flush the DEST for all continuations
 870 ;;; whose values are received by nodes in the block.
 871 (defun delete-block (block)
 872   (declare (type cblock block))
 873   (aver (block-component block)) ; else block is already deleted!
 874   (note-block-deletion block)
 875   (setf (block-delete-p block) t)
 876
 877   (let* ((last (block-last block))
 878          (cont (node-cont last)))
 879     (delete-continuation-use last)
 880     (if (eq (continuation-kind cont) :unused)
 881         (delete-continuation cont)
 882         (reoptimize-continuation cont)))
 883
 884   (dolist (b (block-pred block))
 885     (unlink-blocks b block)
 886     ;; In bug 147 the almost-all-blocks-have-a-successor invariant was
 887     ;; broken when successors were deleted without setting the
 888     ;; BLOCK-DELETE-P flags of their predececessors. Make sure that
 889     ;; doesn't happen again.
 890     (aver (not (and (null (block-succ b))
 891                     (not (block-delete-p b))
 892                     (not (eq b (component-head (block-component b))))))))
 893   (dolist (b (block-succ block))
 894     (unlink-blocks block b))
 895
 896   (do-nodes (node cont block)
 897     (typecase node
 898       (ref (delete-ref node))
 899       (cif
 900        (flush-dest (if-test node)))
 901       ;; The next two cases serve to maintain the invariant that a LET
 902       ;; always has a well-formed COMBINATION, REF and BIND. We delete
 903       ;; the lambda whenever we delete any of these, but we must be
 904       ;; careful that this LET has not already been partially deleted.
 905       (basic-combination
 906        (when (and (eq (basic-combination-kind node) :local)
 907                   ;; Guards COMBINATION-LAMBDA agains the REF being deleted.
 908                   (continuation-use (basic-combination-fun node)))
 909          (let ((fun (combination-lambda node)))
 910            ;; If our REF was the second-to-last ref, and has been
 911            ;; deleted, then FUN may be a LET for some other
 912            ;; combination.
 913            (when (and (functional-letlike-p fun)
 914                       (eq (let-combination fun) node))
 915              (delete-lambda fun))))
 916        (flush-dest (basic-combination-fun node))
 917        (dolist (arg (basic-combination-args node))
 918          (when arg (flush-dest arg))))
 919       (bind
 920        (let ((lambda (bind-lambda node)))
 921          (unless (eq (functional-kind lambda) :deleted)
 922            (aver (functional-somewhat-letlike-p lambda))
 923            (delete-lambda lambda))))
 924       (exit
 925        (let ((value (exit-value node))
 926              (entry (exit-entry node)))
 927          (when value
 928            (flush-dest value))
 929          (when entry
 930            (setf (entry-exits entry)
 931                  (delete node (entry-exits entry))))))
 932       (creturn
 933        (flush-dest (return-result node))
 934        (delete-return node))
 935       (cset
 936        (flush-dest (set-value node))
 937        (let ((var (set-var node)))
 938          (setf (basic-var-sets var)
 939                (delete node (basic-var-sets var))))))
 940
 941     (delete-continuation (node-prev node)))
 942
 943   (remove-from-dfo block)
 944   (values))
 945
 946 ;;; Do stuff to indicate that the return node Node is being deleted.
 947 ;;; We set the RETURN to NIL.
 948 (defun delete-return (node)
 949   (declare (type creturn node))
 950   (let ((fun (return-lambda node)))
 951     (aver (lambda-return fun))
 952     (setf (lambda-return fun) nil))
 953   (values))
 954
 955 ;;; If any of the VARS in FUN was never referenced and was not
 956 ;;; declared IGNORE, then complain.
 957 (defun note-unreferenced-vars (fun)
 958   (declare (type clambda fun))
 959   (dolist (var (lambda-vars fun))
 960     (unless (or (leaf-ever-used var)
 961                 (lambda-var-ignorep var))
 962       (let ((*compiler-error-context* (lambda-bind fun)))
 963         (unless (policy *compiler-error-context* (= inhibit-warnings 3))
 964           ;; ANSI section "3.2.5 Exceptional Situations in the Compiler"
 965           ;; requires this to be no more than a STYLE-WARNING.
 966           (compiler-style-warn "The variable ~S is defined but never used."
 967                                (leaf-debug-name var)))
 968         (setf (leaf-ever-used var) t)))) ; to avoid repeated warnings? -- WHN
 969   (values))
 970
 971 (defvar *deletion-ignored-objects* '(t nil))
 972
 973 ;;; Return true if we can find OBJ in FORM, NIL otherwise. We bound
 974 ;;; our recursion so that we don't get lost in circular structures. We
 975 ;;; ignore the car of forms if they are a symbol (to prevent confusing
 976 ;;; function referencess with variables), and we also ignore anything
 977 ;;; inside ' or #'.
 978 (defun present-in-form (obj form depth)
 979   (declare (type (integer 0 20) depth))
 980   (cond ((= depth 20) nil)
 981         ((eq obj form) t)
 982         ((atom form) nil)
 983         (t
 984          (let ((first (car form))
 985                (depth (1+ depth)))
 986            (if (member first '(quote function))
 987                nil
 988                (or (and (not (symbolp first))
 989                         (present-in-form obj first depth))
 990                    (do ((l (cdr form) (cdr l))
 991                         (n 0 (1+ n)))
 992                        ((or (atom l) (> n 100))
 993                         nil)
 994                      (declare (fixnum n))
 995                      (when (present-in-form obj (car l) depth)
 996                        (return t)))))))))
 997
 998 ;;; This function is called on a block immediately before we delete
 999 ;;; it. We check to see whether any of the code about to die appeared
1000 ;;; in the original source, and emit a note if so.
1001 ;;;
1002 ;;; If the block was in a lambda is now deleted, then we ignore the
1003 ;;; whole block, since this case is picked off in DELETE-LAMBDA. We
1004 ;;; also ignore the deletion of CRETURN nodes, since it is somewhat
1005 ;;; reasonable for a function to not return, and there is a different
1006 ;;; note for that case anyway.
1007 ;;;
1008 ;;; If the actual source is an atom, then we use a bunch of heuristics
1009 ;;; to guess whether this reference really appeared in the original
1010 ;;; source:
1011 ;;; -- If a symbol, it must be interned and not a keyword.
1012 ;;; -- It must not be an easily introduced constant (T or NIL, a fixnum
1013 ;;;    or a character.)
1014 ;;; -- The atom must be "present" in the original source form, and
1015 ;;;    present in all intervening actual source forms.
1016 (defun note-block-deletion (block)
1017   (let ((home (block-home-lambda block)))
1018     (unless (eq (functional-kind home) :deleted)
1019       (do-nodes (node cont block)
1020         (let* ((path (node-source-path node))
1021                (first (first path)))
1022           (when (or (eq first 'original-source-start)
1023                     (and (atom first)
1024                          (or (not (symbolp first))
1025                              (let ((pkg (symbol-package first)))
1026                                (and pkg
1027                                     (not (eq pkg (symbol-package :end))))))
1028                          (not (member first *deletion-ignored-objects*))
1029                          (not (typep first '(or fixnum character)))
1030                          (every (lambda (x)
1031                                   (present-in-form first x 0))
1032                                 (source-path-forms path))
1033                          (present-in-form first (find-original-source path)
1034                                           0)))
1035             (unless (return-p node)
1036               (let ((*compiler-error-context* node))
1037                 (compiler-note "deleting unreachable code")))
1038             (return))))))
1039   (values))
1040
1041 ;;; Delete a node from a block, deleting the block if there are no
1042 ;;; nodes left. We remove the node from the uses of its CONT, but we
1043 ;;; don't deal with cleaning up any type-specific semantic
1044 ;;; attachments. If the CONT is :UNUSED after deleting this use, then
1045 ;;; we delete CONT. (Note :UNUSED is not the same as no uses. A
1046 ;;; continuation will only become :UNUSED if it was :INSIDE-BLOCK
1047 ;;; before.)
1048 ;;;
1049 ;;; If the node is the last node, there must be exactly one successor.
1050 ;;; We link all of our precedessors to the successor and unlink the
1051 ;;; block. In this case, we return T, otherwise NIL. If no nodes are
1052 ;;; left, and the block is a successor of itself, then we replace the
1053 ;;; only node with a degenerate exit node. This provides a way to
1054 ;;; represent the bodyless infinite loop, given the prohibition on
1055 ;;; empty blocks in IR1.
1056 (defun unlink-node (node)
1057   (declare (type node node))
1058   (let* ((cont (node-cont node))
1059          (next (continuation-next cont))
1060          (prev (node-prev node))
1061          (block (continuation-block prev))
1062          (prev-kind (continuation-kind prev))
1063          (last (block-last block)))
1064
1065     (unless (eq (continuation-kind cont) :deleted)
1066       (delete-continuation-use node)
1067       (when (eq (continuation-kind cont) :unused)
1068         (aver (not (continuation-dest cont)))
1069         (delete-continuation cont)))
1070
1071     (setf (block-type-asserted block) t)
1072     (setf (block-test-modified block) t)
1073
1074     (cond ((or (eq prev-kind :inside-block)
1075                (and (eq prev-kind :block-start)
1076                     (not (eq node last))))
1077            (cond ((eq node last)
1078                   (setf (block-last block) (continuation-use prev))
1079                   (setf (continuation-next prev) nil))
1080                  (t
1081                   (setf (continuation-next prev) next)
1082                   (setf (node-prev next) prev)))
1083            (setf (node-prev node) nil)
1084            nil)
1085           (t
1086            (aver (eq prev-kind :block-start))
1087            (aver (eq node last))
1088            (let* ((succ (block-succ block))
1089                   (next (first succ)))
1090              (aver (and succ (null (cdr succ))))
1091              (cond
1092               ((member block succ)
1093                (with-ir1-environment-from-node node
1094                  (let ((exit (make-exit))
1095                        (dummy (make-continuation)))
1096                    (setf (continuation-next prev) nil)
1097                    (link-node-to-previous-continuation exit prev)
1098                    (add-continuation-use exit dummy)
1099                    (setf (block-last block) exit)))
1100                (setf (node-prev node) nil)
1101                nil)
1102               (t
1103                (aver (eq (block-start-cleanup block)
1104                          (block-end-cleanup block)))
1105                (unlink-blocks block next)
1106                (dolist (pred (block-pred block))
1107                  (change-block-successor pred block next))
1108                (remove-from-dfo block)
1109                (cond ((continuation-dest prev)
1110                       (setf (continuation-next prev) nil)
1111                       (setf (continuation-kind prev) :deleted-block-start))
1112                      (t
1113                       (delete-continuation prev)))
1114                (setf (node-prev node) nil)
1115                t)))))))
1116
1117 ;;; Return true if NODE has been deleted, false if it is still a valid
1118 ;;; part of IR1.
1119 (defun node-deleted (node)
1120   (declare (type node node))
1121   (let ((prev (node-prev node)))
1122     (not (and prev
1123               (not (eq (continuation-kind prev) :deleted))
1124               (let ((block (continuation-block prev)))
1125                 (and (block-component block)
1126                      (not (block-delete-p block))))))))
1127
1128 ;;; Delete all the blocks and functions in COMPONENT. We scan first
1129 ;;; marking the blocks as DELETE-P to prevent weird stuff from being
1130 ;;; triggered by deletion.
1131 (defun delete-component (component)
1132   (declare (type component component))
1133   (aver (null (component-new-functionals component)))
1134   (setf (component-kind component) :deleted)
1135   (do-blocks (block component)
1136     (setf (block-delete-p block) t))
1137   (dolist (fun (component-lambdas component))
1138     (setf (functional-kind fun) nil)
1139     (setf (functional-entry-fun fun) nil)
1140     (setf (leaf-refs fun) nil)
1141     (delete-functional fun))
1142   (do-blocks (block component)
1143     (delete-block block))
1144   (values))
1145
1146 ;;; Convert code of the form
1147 ;;;   (FOO ... (FUN ...) ...)
1148 ;;; to
1149 ;;;   (FOO ...    ...    ...).
1150 ;;; In other words, replace the function combination FUN by its
1151 ;;; arguments. If there are any problems with doing this, use GIVE-UP
1152 ;;; to blow out of whatever transform called this. Note, as the number
1153 ;;; of arguments changes, the transform must be prepared to return a
1154 ;;; lambda with a new lambda-list with the correct number of
1155 ;;; arguments.
1156 (defun extract-fun-args (cont fun num-args)
1157   #!+sb-doc
1158   "If CONT is a call to FUN with NUM-ARGS args, change those arguments
1159    to feed directly to the continuation-dest of CONT, which must be
1160    a combination."
1161   (declare (type continuation cont)
1162            (type symbol fun)
1163            (type index num-args))
1164   (let ((outside (continuation-dest cont))
1165         (inside (continuation-use cont)))
1166     (aver (combination-p outside))
1167     (unless (combination-p inside)
1168       (give-up-ir1-transform))
1169     (let ((inside-fun (combination-fun inside)))
1170       (unless (eq (continuation-fun-name inside-fun) fun)
1171         (give-up-ir1-transform))
1172       (let ((inside-args (combination-args inside)))
1173         (unless (= (length inside-args) num-args)
1174           (give-up-ir1-transform))
1175         (let* ((outside-args (combination-args outside))
1176                (arg-position (position cont outside-args))
1177                (before-args (subseq outside-args 0 arg-position))
1178                (after-args (subseq outside-args (1+ arg-position))))
1179           (dolist (arg inside-args)
1180             (setf (continuation-dest arg) outside))
1181           (setf (combination-args inside) nil)
1182           (setf (combination-args outside)
1183                 (append before-args inside-args after-args))
1184           (change-ref-leaf (continuation-use inside-fun)
1185                            (find-free-fun 'list "???"))
1186           (setf (combination-kind inside) :full)
1187           (setf (node-derived-type inside) *wild-type*)
1188           (flush-dest cont)
1189           (setf (continuation-asserted-type cont) *wild-type*)
1190           (values))))))
1191 \f
1192 ;;;; leaf hackery
1193
1194 ;;; Change the LEAF that a REF refers to.
1195 (defun change-ref-leaf (ref leaf)
1196   (declare (type ref ref) (type leaf leaf))
1197   (unless (eq (ref-leaf ref) leaf)
1198     (push ref (leaf-refs leaf))
1199     (delete-ref ref)
1200     (setf (ref-leaf ref) leaf)
1201     (let ((ltype (leaf-type leaf)))
1202       (if (fun-type-p ltype)
1203           (setf (node-derived-type ref) ltype)
1204           (derive-node-type ref ltype)))
1205     (reoptimize-continuation (node-cont ref)))
1206   (values))
1207
1208 ;;; Change all REFS for OLD-LEAF to NEW-LEAF.
1209 (defun substitute-leaf (new-leaf old-leaf)
1210   (declare (type leaf new-leaf old-leaf))
1211   (dolist (ref (leaf-refs old-leaf))
1212     (change-ref-leaf ref new-leaf))
1213   (values))
1214
1215 ;;; like SUBSITUTE-LEAF, only there is a predicate on the REF to tell
1216 ;;; whether to substitute
1217 (defun substitute-leaf-if (test new-leaf old-leaf)
1218   (declare (type leaf new-leaf old-leaf) (type function test))
1219   (dolist (ref (leaf-refs old-leaf))
1220     (when (funcall test ref)
1221       (change-ref-leaf ref new-leaf)))
1222   (values))
1223
1224 ;;; Return a LEAF which represents the specified constant object. If
1225 ;;; the object is not in *CONSTANTS*, then we create a new constant
1226 ;;; LEAF and enter it.
1227 (defun find-constant (object)
1228   (if (typep object
1229              ;; FIXME: What is the significance of this test? ("things
1230              ;; that are worth uniquifying"?)
1231              '(or symbol number character instance))
1232       (or (gethash object *constants*)
1233           (setf (gethash object *constants*)
1234                 (make-constant :value object
1235                                :%source-name '.anonymous.
1236                                :type (ctype-of object)
1237                                :where-from :defined)))
1238       (make-constant :value object
1239                      :%source-name '.anonymous.
1240                      :type (ctype-of object)
1241                      :where-from :defined)))
1242 \f
1243 ;;; If there is a non-local exit noted in ENTRY's environment that
1244 ;;; exits to CONT in that entry, then return it, otherwise return NIL.
1245 (defun find-nlx-info (entry cont)
1246   (declare (type entry entry) (type continuation cont))
1247   (let ((entry-cleanup (entry-cleanup entry)))
1248     (dolist (nlx (physenv-nlx-info (node-physenv entry)) nil)
1249       (when (and (eq (nlx-info-continuation nlx) cont)
1250                  (eq (nlx-info-cleanup nlx) entry-cleanup))
1251         (return nlx)))))
1252 \f
1253 ;;;; functional hackery
1254
1255 (declaim (ftype (function (functional) clambda) main-entry))
1256 (defun main-entry (functional)
1257   (etypecase functional
1258     (clambda functional)
1259     (optional-dispatch
1260      (optional-dispatch-main-entry functional))))
1261
1262 ;;; RETURN true if FUNCTIONAL is a thing that can be treated like
1263 ;;; MV-BIND when it appears in an MV-CALL. All fixed arguments must be
1264 ;;; optional with null default and no SUPPLIED-P. There must be a
1265 ;;; &REST arg with no references.
1266 (declaim (ftype (function (functional) boolean) looks-like-an-mv-bind))
1267 (defun looks-like-an-mv-bind (functional)
1268   (and (optional-dispatch-p functional)
1269        (do ((arg (optional-dispatch-arglist functional) (cdr arg)))
1270            ((null arg) nil)
1271          (let ((info (lambda-var-arg-info (car arg))))
1272            (unless info (return nil))
1273            (case (arg-info-kind info)
1274              (:optional
1275               (when (or (arg-info-supplied-p info) (arg-info-default info))
1276                 (return nil)))
1277              (:rest
1278               (return (and (null (cdr arg)) (null (leaf-refs (car arg))))))
1279              (t
1280               (return nil)))))))
1281
1282 ;;; Return true if function is an external entry point. This is true
1283 ;;; of normal XEPs (:EXTERNAL kind) and also of top level lambdas
1284 ;;; (:TOPLEVEL kind.)
1285 (defun xep-p (fun)
1286   (declare (type functional fun))
1287   (not (null (member (functional-kind fun) '(:external :toplevel)))))
1288
1289 ;;; If CONT's only use is a non-notinline global function reference,
1290 ;;; then return the referenced symbol, otherwise NIL. If NOTINLINE-OK
1291 ;;; is true, then we don't care if the leaf is NOTINLINE.
1292 (defun continuation-fun-name (cont &optional notinline-ok)
1293   (declare (type continuation cont))
1294   (let ((use (continuation-use cont)))
1295     (if (ref-p use)
1296         (let ((leaf (ref-leaf use)))
1297           (if (and (global-var-p leaf)
1298                    (eq (global-var-kind leaf) :global-function)
1299                    (or (not (defined-fun-p leaf))
1300                        (not (eq (defined-fun-inlinep leaf) :notinline))
1301                        notinline-ok))
1302               (leaf-source-name leaf)
1303               nil))
1304         nil)))
1305
1306 ;;; Return the source name of a combination. (This is an idiom
1307 ;;; which was used in CMU CL. I gather it always works. -- WHN)
1308 (defun combination-fun-source-name (combination)
1309   (let ((ref (continuation-use (combination-fun combination))))
1310     (leaf-source-name (ref-leaf ref))))
1311
1312 ;;; Return the COMBINATION node that is the call to the LET FUN.
1313 (defun let-combination (fun)
1314   (declare (type clambda fun))
1315   (aver (functional-letlike-p fun))
1316   (continuation-dest (node-cont (first (leaf-refs fun)))))
1317
1318 ;;; Return the initial value continuation for a LET variable, or NIL
1319 ;;; if there is none.
1320 (defun let-var-initial-value (var)
1321   (declare (type lambda-var var))
1322   (let ((fun (lambda-var-home var)))
1323     (elt (combination-args (let-combination fun))
1324          (position-or-lose var (lambda-vars fun)))))
1325
1326 ;;; Return the LAMBDA that is called by the local CALL.
1327 (defun combination-lambda (call)
1328   (declare (type basic-combination call))
1329   (aver (eq (basic-combination-kind call) :local))
1330   (ref-leaf (continuation-use (basic-combination-fun call))))
1331
1332 (defvar *inline-expansion-limit* 200
1333   #!+sb-doc
1334   "an upper limit on the number of inline function calls that will be expanded
1335    in any given code object (single function or block compilation)")
1336
1337 ;;; Check whether NODE's component has exceeded its inline expansion
1338 ;;; limit, and warn if so, returning NIL.
1339 (defun inline-expansion-ok (node)
1340   (let ((expanded (incf (component-inline-expansions
1341                          (block-component
1342                           (node-block node))))))
1343     (cond ((> expanded *inline-expansion-limit*) nil)
1344           ((= expanded *inline-expansion-limit*)
1345            ;; FIXME: If the objective is to stop the recursive
1346            ;; expansion of inline functions, wouldn't it be more
1347            ;; correct to look back through surrounding expansions
1348            ;; (which are, I think, stored in the *CURRENT-PATH*, and
1349            ;; possibly stored elsewhere too) and suppress expansion
1350            ;; and print this warning when the function being proposed
1351            ;; for inline expansion is found there? (I don't like the
1352            ;; arbitrary numerical limit in principle, and I think
1353            ;; it'll be a nuisance in practice if we ever want the
1354            ;; compiler to be able to use WITH-COMPILATION-UNIT on
1355            ;; arbitrarily huge blocks of code. -- WHN)
1356            (let ((*compiler-error-context* node))
1357              (compiler-note "*INLINE-EXPANSION-LIMIT* (~W) was exceeded, ~
1358                              probably trying to~%  ~
1359                              inline a recursive function."
1360                             *inline-expansion-limit*))
1361            nil)
1362           (t t))))
1363 \f
1364 ;;;; careful call
1365
1366 ;;; Apply a function to some arguments, returning a list of the values
1367 ;;; resulting of the evaluation. If an error is signalled during the
1368 ;;; application, then we produce a warning message using WARN-FUN and
1369 ;;; return NIL as our second value to indicate this. NODE is used as
1370 ;;; the error context for any error message, and CONTEXT is a string
1371 ;;; that is spliced into the warning.
1372 (declaim (ftype (function ((or symbol function) list node function string)
1373                           (values list boolean))
1374                 careful-call))
1375 (defun careful-call (function args node warn-fun context)
1376   (values
1377    (multiple-value-list
1378     (handler-case (apply function args)
1379       (error (condition)
1380         (let ((*compiler-error-context* node))
1381           (funcall warn-fun "Lisp error during ~A:~%~A" context condition)
1382           (return-from careful-call (values nil nil))))))
1383    t))
1384
1385 ;;; Variations of SPECIFIER-TYPE for parsing possibly wrong
1386 ;;; specifiers.
1387 (macrolet
1388     ((deffrob (basic careful compiler transform)
1389        `(progn
1390           (defun ,careful (specifier)
1391             (handler-case (,basic specifier)
1392               (simple-error (condition)
1393                 (values nil (list* (simple-condition-format-control condition)
1394                                    (simple-condition-format-arguments condition))))))
1395           (defun ,compiler (specifier)
1396             (multiple-value-bind (type error-args) (,careful specifier)
1397               (or type
1398                   (apply #'compiler-error error-args))))
1399           (defun ,transform (specifier)
1400             (multiple-value-bind (type error-args) (,careful specifier)
1401               (or type
1402                   (apply #'give-up-ir1-transform
1403                          error-args)))))))
1404   (deffrob specifier-type careful-specifier-type compiler-specifier-type ir1-transform-specifier-type)
1405   (deffrob values-specifier-type careful-values-specifier-type compiler-values-specifier-type ir1-transform-values-specifier-type))
1406
1407 \f
1408 ;;;; utilities used at run-time for parsing &KEY args in IR1
1409
1410 ;;; This function is used by the result of PARSE-DEFTRANSFORM to find
1411 ;;; the continuation for the value of the &KEY argument KEY in the
1412 ;;; list of continuations ARGS. It returns the continuation if the
1413 ;;; keyword is present, or NIL otherwise. The legality and
1414 ;;; constantness of the keywords should already have been checked.
1415 (declaim (ftype (function (list keyword) (or continuation null))
1416                 find-keyword-continuation))
1417 (defun find-keyword-continuation (args key)
1418   (do ((arg args (cddr arg)))
1419       ((null arg) nil)
1420     (when (eq (continuation-value (first arg)) key)
1421       (return (second arg)))))
1422
1423 ;;; This function is used by the result of PARSE-DEFTRANSFORM to
1424 ;;; verify that alternating continuations in ARGS are constant and
1425 ;;; that there is an even number of args.
1426 (declaim (ftype (function (list) boolean) check-key-args-constant))
1427 (defun check-key-args-constant (args)
1428   (do ((arg args (cddr arg)))
1429       ((null arg) t)
1430     (unless (and (rest arg)
1431                  (constant-continuation-p (first arg)))
1432       (return nil))))
1433
1434 ;;; This function is used by the result of PARSE-DEFTRANSFORM to
1435 ;;; verify that the list of continuations ARGS is a well-formed &KEY
1436 ;;; arglist and that only keywords present in the list KEYS are
1437 ;;; supplied.
1438 (declaim (ftype (function (list list) boolean) check-transform-keys))
1439 (defun check-transform-keys (args keys)
1440   (and (check-key-args-constant args)
1441        (do ((arg args (cddr arg)))
1442            ((null arg) t)
1443          (unless (member (continuation-value (first arg)) keys)
1444            (return nil)))))
1445 \f
1446 ;;;; miscellaneous
1447
1448 ;;; Called by the expansion of the EVENT macro.
1449 (declaim (ftype (function (event-info (or node null)) *) %event))
1450 (defun %event (info node)
1451   (incf (event-info-count info))
1452   (when (and (>= (event-info-level info) *event-note-threshold*)
1453              (policy (or node *lexenv*)
1454                      (= inhibit-warnings 0)))
1455     (let ((*compiler-error-context* node))
1456       (compiler-note (event-info-description info))))
1457
1458   (let ((action (event-info-action info)))
1459     (when action (funcall action node))))