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