1.0.30.11: autogenerate tagname information for LDB in genesis
[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-ctran))
43              (block (ctran-starts-block start))
44              (next (make-ctran))
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 next nil form)
51         (setf (block-last block) (ctran-use next))
52         (setf (node-next (block-last block)) nil)
53         block))))
54 \f
55 ;;;; lvar use hacking
56
57 ;;; Return a list of all the nodes which use LVAR.
58 (declaim (ftype (sfunction (lvar) list) find-uses))
59 (defun find-uses (lvar)
60   (let ((uses (lvar-uses lvar)))
61     (if (listp uses)
62         uses
63         (list uses))))
64
65 (declaim (ftype (sfunction (lvar) lvar) principal-lvar))
66 (defun principal-lvar (lvar)
67   (labels ((pl (lvar)
68              (let ((use (lvar-uses lvar)))
69                (if (cast-p use)
70                    (pl (cast-value use))
71                    lvar))))
72     (pl lvar)))
73
74 (defun principal-lvar-use (lvar)
75   (labels ((plu (lvar)
76              (declare (type lvar lvar))
77              (let ((use (lvar-uses lvar)))
78                (if (cast-p use)
79                    (plu (cast-value use))
80                    use))))
81     (plu lvar)))
82
83 ;;; Update lvar use information so that NODE is no longer a use of its
84 ;;; LVAR.
85 ;;;
86 ;;; Note: if you call this function, you may have to do a
87 ;;; REOPTIMIZE-LVAR to inform IR1 optimization that something has
88 ;;; changed.
89 (declaim (ftype (sfunction (node) (values))
90                 delete-lvar-use
91                 %delete-lvar-use))
92 ;;; Just delete NODE from its LVAR uses; LVAR is preserved so it may
93 ;;; be given a new use.
94 (defun %delete-lvar-use (node)
95   (let ((lvar (node-lvar node)))
96     (when lvar
97       (if (listp (lvar-uses lvar))
98           (let ((new-uses (delq node (lvar-uses lvar))))
99             (setf (lvar-uses lvar)
100                   (if (singleton-p new-uses)
101                       (first new-uses)
102                       new-uses)))
103           (setf (lvar-uses lvar) nil))
104       (setf (node-lvar node) nil)))
105   (values))
106 ;;; Delete NODE from its LVAR uses; if LVAR has no other uses, delete
107 ;;; its DEST's block, which must be unreachable.
108 (defun delete-lvar-use (node)
109   (let ((lvar (node-lvar node)))
110     (when lvar
111       (%delete-lvar-use node)
112       (if (null (lvar-uses lvar))
113           (binding* ((dest (lvar-dest lvar) :exit-if-null)
114                      (() (not (node-deleted dest)) :exit-if-null)
115                      (block (node-block dest)))
116             (mark-for-deletion block))
117           (reoptimize-lvar lvar))))
118   (values))
119
120 ;;; Update lvar use information so that NODE uses LVAR.
121 ;;;
122 ;;; Note: if you call this function, you may have to do a
123 ;;; REOPTIMIZE-LVAR to inform IR1 optimization that something has
124 ;;; changed.
125 (declaim (ftype (sfunction (node (or lvar null)) (values)) add-lvar-use))
126 (defun add-lvar-use (node lvar)
127   (aver (not (node-lvar node)))
128   (when lvar
129     (let ((uses (lvar-uses lvar)))
130       (setf (lvar-uses lvar)
131             (cond ((null uses)
132                    node)
133                   ((listp uses)
134                    (cons node uses))
135                   (t
136                    (list node uses))))
137       (setf (node-lvar node) lvar)))
138
139   (values))
140
141 ;;; Return true if LVAR destination is executed immediately after
142 ;;; NODE. Cleanups are ignored.
143 (defun immediately-used-p (lvar node)
144   (declare (type lvar lvar) (type node node))
145   (aver (eq (node-lvar node) lvar))
146   (let ((dest (lvar-dest lvar)))
147     (acond ((node-next node)
148             (eq (ctran-next it) dest))
149            (t (eq (block-start (first (block-succ (node-block node))))
150                   (node-prev dest))))))
151
152 ;;; Return true if LVAR destination is executed after node with only
153 ;;; uninteresting nodes intervening.
154 ;;;
155 ;;; Uninteresting nodes are nodes in the same block which are either
156 ;;; REFs, external CASTs to the same destination, or known combinations
157 ;;; that never unwind.
158 (defun almost-immediately-used-p (lvar node)
159   (declare (type lvar lvar)
160            (type node node))
161   (aver (eq (node-lvar node) lvar))
162   (let ((dest (lvar-dest lvar)))
163     (tagbody
164      :next
165        (let ((ctran (node-next node)))
166          (cond (ctran
167                 (setf node (ctran-next ctran))
168                 (if (eq node dest)
169                     (return-from almost-immediately-used-p t)
170                     (typecase node
171                       (ref
172                        (go :next))
173                       (cast
174                        (when (and (eq :external (cast-type-check node))
175                                   (eq dest (node-dest node)))
176                          (go :next)))
177                       (combination
178                        ;; KLUDGE: Unfortunately we don't have an attribute for
179                        ;; "never unwinds", so we just special case
180                        ;; %ALLOCATE-CLOSURES: it is easy to run into with eg.
181                        ;; FORMAT and a non-constant first argument.
182                        (when (eq '%allocate-closures (combination-fun-source-name node nil))
183                          (go :next))))))
184                (t
185                 (when (eq (block-start (first (block-succ (node-block node))))
186                           (node-prev dest))
187                   (return-from almost-immediately-used-p t))))))))
188 \f
189 ;;;; lvar substitution
190
191 ;;; In OLD's DEST, replace OLD with NEW. NEW's DEST must initially be
192 ;;; NIL. We do not flush OLD's DEST.
193 (defun substitute-lvar (new old)
194   (declare (type lvar old new))
195   (aver (not (lvar-dest new)))
196   (let ((dest (lvar-dest old)))
197     (etypecase dest
198       ((or ref bind))
199       (cif (setf (if-test dest) new))
200       (cset (setf (set-value dest) new))
201       (creturn (setf (return-result dest) new))
202       (exit (setf (exit-value dest) new))
203       (basic-combination
204        (if (eq old (basic-combination-fun dest))
205            (setf (basic-combination-fun dest) new)
206            (setf (basic-combination-args dest)
207                  (nsubst new old (basic-combination-args dest)))))
208       (cast (setf (cast-value dest) new)))
209
210     (setf (lvar-dest old) nil)
211     (setf (lvar-dest new) dest)
212     (flush-lvar-externally-checkable-type new))
213   (values))
214
215 ;;; Replace all uses of OLD with uses of NEW, where NEW has an
216 ;;; arbitary number of uses. NEW is supposed to be "later" than OLD.
217 (defun substitute-lvar-uses (new old propagate-dx)
218   (declare (type lvar old)
219            (type (or lvar null) new)
220            (type boolean propagate-dx))
221
222   (cond (new
223          (do-uses (node old)
224            (%delete-lvar-use node)
225            (add-lvar-use node new))
226          (reoptimize-lvar new)
227          (awhen (and propagate-dx (lvar-dynamic-extent old))
228            (setf (lvar-dynamic-extent old) nil)
229            (unless (lvar-dynamic-extent new)
230              (setf (lvar-dynamic-extent new) it)
231              (setf (cleanup-info it) (subst new old (cleanup-info it)))))
232          (when (lvar-dynamic-extent new)
233            (do-uses (node new)
234              (node-ends-block node))))
235         (t (flush-dest old)))
236
237   (values))
238 \f
239 ;;;; block starting/creation
240
241 ;;; Return the block that CTRAN is the start of, making a block if
242 ;;; necessary. This function is called by IR1 translators which may
243 ;;; cause a CTRAN to be used more than once. Every CTRAN which may be
244 ;;; used more than once must start a block by the time that anyone
245 ;;; does a USE-CTRAN on it.
246 ;;;
247 ;;; We also throw the block into the next/prev list for the
248 ;;; *CURRENT-COMPONENT* so that we keep track of which blocks we have
249 ;;; made.
250 (defun ctran-starts-block (ctran)
251   (declare (type ctran ctran))
252   (ecase (ctran-kind ctran)
253     (:unused
254      (aver (not (ctran-block ctran)))
255      (let* ((next (component-last-block *current-component*))
256             (prev (block-prev next))
257             (new-block (make-block ctran)))
258        (setf (block-next new-block) next
259              (block-prev new-block) prev
260              (block-prev next) new-block
261              (block-next prev) new-block
262              (ctran-block ctran) new-block
263              (ctran-kind ctran) :block-start)
264        (aver (not (ctran-use ctran)))
265        new-block))
266     (:block-start
267      (ctran-block ctran))))
268
269 ;;; Ensure that CTRAN is the start of a block so that the use set can
270 ;;; be freely manipulated.
271 (defun ensure-block-start (ctran)
272   (declare (type ctran ctran))
273   (let ((kind (ctran-kind ctran)))
274     (ecase kind
275       ((:block-start))
276       ((:unused)
277        (setf (ctran-block ctran)
278              (make-block-key :start ctran))
279        (setf (ctran-kind ctran) :block-start))
280       ((:inside-block)
281        (node-ends-block (ctran-use ctran)))))
282   (values))
283
284 ;;; CTRAN must be the last ctran in an incomplete block; finish the
285 ;;; block and start a new one if necessary.
286 (defun start-block (ctran)
287   (declare (type ctran ctran))
288   (aver (not (ctran-next ctran)))
289   (ecase (ctran-kind ctran)
290     (:inside-block
291      (let ((block (ctran-block ctran))
292            (node (ctran-use ctran)))
293        (aver (not (block-last block)))
294        (aver node)
295        (setf (block-last block) node)
296        (setf (node-next node) nil)
297        (setf (ctran-use ctran) nil)
298        (setf (ctran-kind ctran) :unused)
299        (setf (ctran-block ctran) nil)
300        (link-blocks block (ctran-starts-block ctran))))
301     (:block-start)))
302 \f
303 ;;;;
304
305 ;;; Filter values of LVAR through FORM, which must be an ordinary/mv
306 ;;; call. First argument must be 'DUMMY, which will be replaced with
307 ;;; LVAR. In case of an ordinary call the function should not have
308 ;;; return type NIL. We create a new "filtered" lvar.
309 ;;;
310 ;;; TODO: remove preconditions.
311 (defun filter-lvar (lvar form)
312   (declare (type lvar lvar) (type list form))
313   (let* ((dest (lvar-dest lvar))
314          (ctran (node-prev dest)))
315     (with-ir1-environment-from-node dest
316
317       (ensure-block-start ctran)
318       (let* ((old-block (ctran-block ctran))
319              (new-start (make-ctran))
320              (filtered-lvar (make-lvar))
321              (new-block (ctran-starts-block new-start)))
322
323         ;; Splice in the new block before DEST, giving the new block
324         ;; all of DEST's predecessors.
325         (dolist (block (block-pred old-block))
326           (change-block-successor block old-block new-block))
327
328         (ir1-convert new-start ctran filtered-lvar form)
329
330         ;; KLUDGE: Comments at the head of this function in CMU CL
331         ;; said that somewhere in here we
332         ;;   Set the new block's start and end cleanups to the *start*
333         ;;   cleanup of PREV's block. This overrides the incorrect
334         ;;   default from WITH-IR1-ENVIRONMENT-FROM-NODE.
335         ;; Unfortunately I can't find any code which corresponds to this.
336         ;; Perhaps it was a stale comment? Or perhaps I just don't
337         ;; understand.. -- WHN 19990521
338
339         ;; Replace 'DUMMY with the LVAR. (We can find 'DUMMY because
340         ;; no LET conversion has been done yet.) The [mv-]combination
341         ;; code from the call in the form will be the use of the new
342         ;; check lvar. We substitute for the first argument of
343         ;; this node.
344         (let* ((node (lvar-use filtered-lvar))
345                (args (basic-combination-args node))
346                (victim (first args)))
347           (aver (eq (constant-value (ref-leaf (lvar-use victim)))
348                     'dummy))
349
350           (substitute-lvar filtered-lvar lvar)
351           (substitute-lvar lvar victim)
352           (flush-dest victim))
353
354         ;; Invoking local call analysis converts this call to a LET.
355         (locall-analyze-component *current-component*))))
356   (values))
357
358 ;;; Delete NODE and VALUE. It may result in some calls becoming tail.
359 (defun delete-filter (node lvar value)
360   (aver (eq (lvar-dest value) node))
361   (aver (eq (node-lvar node) lvar))
362   (cond (lvar (collect ((merges))
363                 (when (return-p (lvar-dest lvar))
364                   (do-uses (use value)
365                     (when (and (basic-combination-p use)
366                                (eq (basic-combination-kind use) :local))
367                       (merges use))))
368                 (substitute-lvar-uses lvar value
369                                       (and lvar (eq (lvar-uses lvar) node)))
370                 (%delete-lvar-use node)
371                 (prog1
372                     (unlink-node node)
373                   (dolist (merge (merges))
374                     (merge-tail-sets merge)))))
375         (t (flush-dest value)
376            (unlink-node node))))
377
378 ;;; Make a CAST and insert it into IR1 before node NEXT.
379 (defun insert-cast-before (next lvar type policy)
380   (declare (type node next) (type lvar lvar) (type ctype type))
381   (with-ir1-environment-from-node next
382     (let* ((ctran (node-prev next))
383            (cast (make-cast lvar type policy))
384            (internal-ctran (make-ctran)))
385       (setf (ctran-next ctran) cast
386             (node-prev cast) ctran)
387       (use-ctran cast internal-ctran)
388       (link-node-to-previous-ctran next internal-ctran)
389       (setf (lvar-dest lvar) cast)
390       (reoptimize-lvar lvar)
391       (when (return-p next)
392         (node-ends-block cast))
393       (setf (block-attributep (block-flags (node-block cast))
394                               type-check type-asserted)
395             t)
396       cast)))
397 \f
398 ;;;; miscellaneous shorthand functions
399
400 ;;; Return the home (i.e. enclosing non-LET) CLAMBDA for NODE. Since
401 ;;; the LEXENV-LAMBDA may be deleted, we must chain up the
402 ;;; LAMBDA-CALL-LEXENV thread until we find a CLAMBDA that isn't
403 ;;; deleted, and then return its home.
404 (defun node-home-lambda (node)
405   (declare (type node node))
406   (do ((fun (lexenv-lambda (node-lexenv node))
407             (lexenv-lambda (lambda-call-lexenv fun))))
408       ((not (memq (functional-kind fun) '(:deleted :zombie)))
409        (lambda-home fun))
410     (when (eq (lambda-home fun) fun)
411       (return fun))))
412
413 #!-sb-fluid (declaim (inline node-block))
414 (defun node-block (node)
415   (ctran-block (node-prev node)))
416 (declaim (ftype (sfunction (node) component) node-component))
417 (defun node-component (node)
418   (block-component (node-block node)))
419 (declaim (ftype (sfunction (node) physenv) node-physenv))
420 (defun node-physenv (node)
421   (lambda-physenv (node-home-lambda node)))
422 #!-sb-fluid (declaim (inline node-dest))
423 (defun node-dest (node)
424   (awhen (node-lvar node) (lvar-dest it)))
425
426 #!-sb-fluid (declaim (inline node-stack-allocate-p))
427 (defun node-stack-allocate-p (node)
428   (awhen (node-lvar node)
429     (lvar-dynamic-extent it)))
430
431 (defun flushable-combination-p (call)
432   (declare (combination call))
433   (let ((kind (combination-kind call))
434         (info (combination-fun-info call)))
435     (when (and (eq kind :known) (fun-info-p info))
436       (let ((attr (fun-info-attributes info)))
437         (when (and (not (ir1-attributep attr call))
438                    ;; FIXME: For now, don't consider potentially flushable
439                    ;; calls flushable when they have the CALL attribute.
440                    ;; Someday we should look at the functional args to
441                    ;; determine if they have any side effects.
442                    (if (policy call (= safety 3))
443                        (ir1-attributep attr flushable)
444                        (ir1-attributep attr unsafely-flushable)))
445           t)))))
446
447 ;;;; DYNAMIC-EXTENT related
448
449 (defun note-no-stack-allocation (lvar &key flush)
450   (do-uses (use (principal-lvar lvar))
451     (unless (or
452              ;; Don't complain about not being able to stack allocate constants.
453              (and (ref-p use) (constant-p (ref-leaf use)))
454              ;; If we're flushing, don't complain if we can flush the combination.
455              (and flush (combination-p use) (flushable-combination-p use)))
456       (let ((*compiler-error-context* use))
457         (compiler-notify "could not stack allocate the result of ~S"
458                          (find-original-source (node-source-path use)))))))
459
460 (declaim (ftype (sfunction (node (member nil t :truly) &optional (or null component))
461                            boolean) use-good-for-dx-p))
462 (declaim (ftype (sfunction (lvar (member nil t :truly) &optional (or null component))
463                            boolean) lvar-good-for-dx-p))
464 (defun use-good-for-dx-p (use dx &optional component)
465   ;; FIXME: Can casts point to LVARs in other components?
466   ;; RECHECK-DYNAMIC-EXTENT-LVARS assumes that they can't -- that is, that the
467   ;; PRINCIPAL-LVAR is always in the same component as the original one. It
468   ;; would be either good to have an explanation of why casts don't point
469   ;; across components, or an explanation of when they do it. ...in the
470   ;; meanwhile AVER that our assumption holds true.
471   (aver (or (not component) (eq component (node-component use))))
472   (or (dx-combination-p use dx)
473       (and (cast-p use)
474            (not (cast-type-check use))
475            (lvar-good-for-dx-p (cast-value use) dx component))
476       (and (trivial-lambda-var-ref-p use)
477            (let ((uses (lvar-uses (trivial-lambda-var-ref-lvar use))))
478              (or (eq use uses)
479                  (lvar-good-for-dx-p (trivial-lambda-var-ref-lvar use) dx component))))))
480
481 (defun lvar-good-for-dx-p (lvar dx &optional component)
482   (let ((uses (lvar-uses lvar)))
483     (if (listp uses)
484         (when uses
485           (every (lambda (use)
486                    (use-good-for-dx-p use dx component))
487                  uses))
488         (use-good-for-dx-p uses dx component))))
489
490 (defun known-dx-combination-p (use dx)
491   (and (eq (combination-kind use) :known)
492        (let ((info (combination-fun-info use)))
493          (or (awhen (fun-info-stack-allocate-result info)
494                (funcall it use dx))
495              (awhen (fun-info-result-arg info)
496                (let ((args (combination-args use)))
497                  (lvar-good-for-dx-p (if (zerop it)
498                                          (car args)
499                                          (nth it args))
500                                      dx)))))))
501
502 (defun dx-combination-p (use dx)
503   (and (combination-p use)
504        (or
505         ;; Known, and can do DX.
506         (known-dx-combination-p use dx)
507         ;; Possibly a not-yet-eliminated lambda which ends up returning the
508         ;; results of an actual known DX combination.
509         (let* ((fun (combination-fun use))
510                (ref (principal-lvar-use fun))
511                (clambda (when (ref-p ref)
512                           (ref-leaf ref)))
513                (creturn (when (lambda-p clambda)
514                           (lambda-return clambda)))
515                (result-use (when (return-p creturn)
516                              (principal-lvar-use (return-result creturn)))))
517           ;; FIXME: We should be able to deal with multiple uses here as well.
518           (and (dx-combination-p result-use dx)
519                (combination-args-flow-cleanly-p use result-use dx))))))
520
521 (defun combination-args-flow-cleanly-p (combination1 combination2 dx)
522   (labels ((recurse (combination)
523              (or (eq combination combination2)
524                  (if (known-dx-combination-p combination dx)
525                      (let ((dest (lvar-dest (combination-lvar combination))))
526                        (and (combination-p dest)
527                             (recurse dest)))
528                      (let* ((fun1 (combination-fun combination))
529                             (ref1 (principal-lvar-use fun1))
530                             (clambda1 (when (ref-p ref1) (ref-leaf ref1))))
531                        (when (lambda-p clambda1)
532                          (dolist (var (lambda-vars clambda1) t)
533                            (dolist (var-ref (lambda-var-refs var))
534                              (let ((dest (lvar-dest (ref-lvar var-ref))))
535                                (unless (and (combination-p dest) (recurse dest))
536                                  (return-from combination-args-flow-cleanly-p nil)))))))))))
537     (recurse combination1)))
538
539 (defun trivial-lambda-var-ref-p (use)
540   (and (ref-p use)
541        (let ((var (ref-leaf use)))
542          ;; lambda-var, no SETS
543          (when (and (lambda-var-p var) (not (lambda-var-sets var)))
544            (let ((home (lambda-var-home var))
545                  (refs (lambda-var-refs var)))
546              ;; bound by a system lambda, no other REFS
547              (when (and (lambda-system-lambda-p home)
548                         (eq use (car refs)) (not (cdr refs)))
549                ;; the LAMBDA this var is bound by has only a single REF, going
550                ;; to a combination
551                (let* ((lambda-refs (lambda-refs home))
552                       (primary (car lambda-refs)))
553                  (and (ref-p primary)
554                       (not (cdr lambda-refs))
555                       (combination-p (lvar-dest (ref-lvar primary)))))))))))
556
557 (defun trivial-lambda-var-ref-lvar (use)
558   (let* ((this (ref-leaf use))
559          (home (lambda-var-home this)))
560     (multiple-value-bind (fun vars)
561         (values home (lambda-vars home))
562       (let* ((combination (lvar-dest (ref-lvar (car (lambda-refs fun)))))
563              (args (combination-args combination)))
564         (assert (= (length vars) (length args)))
565         (loop for var in vars
566               for arg in args
567               when (eq var this)
568               return arg)))))
569
570 ;;; This needs to play nice with LVAR-GOOD-FOR-DX-P and friends.
571 (defun handle-nested-dynamic-extent-lvars (dx lvar &optional recheck-component)
572   (let ((uses (lvar-uses lvar)))
573     ;; DX value generators must end their blocks: see UPDATE-UVL-LIVE-SETS.
574     ;; Uses of mupltiple-use LVARs already end their blocks, so we just need
575     ;; to process uses of single-use LVARs.
576     (when (node-p uses)
577       (node-ends-block uses))
578     ;; If this LVAR's USE is good for DX, it is either a CAST, or it
579     ;; must be a regular combination whose arguments are potentially DX as well.
580     (flet ((recurse (use)
581              (etypecase use
582                (cast
583                 (handle-nested-dynamic-extent-lvars
584                  dx (cast-value use) recheck-component))
585                (combination
586                 (loop for arg in (combination-args use)
587                       ;; deleted args show up as NIL here
588                       when (and arg
589                                 (lvar-good-for-dx-p arg dx recheck-component))
590                       append (handle-nested-dynamic-extent-lvars
591                               dx arg recheck-component)))
592                (ref
593                 (let* ((other (trivial-lambda-var-ref-lvar use)))
594                   (unless (eq other lvar)
595                     (handle-nested-dynamic-extent-lvars
596                      dx other recheck-component)))))))
597       (cons (cons dx lvar)
598             (if (listp uses)
599                 (loop for use in uses
600                       when (use-good-for-dx-p use dx recheck-component)
601                       nconc (recurse use))
602                 (when (use-good-for-dx-p uses dx recheck-component)
603                   (recurse uses)))))))
604
605 ;;;;; BLOCK UTILS
606
607 (declaim (inline block-to-be-deleted-p))
608 (defun block-to-be-deleted-p (block)
609   (or (block-delete-p block)
610       (eq (functional-kind (block-home-lambda block)) :deleted)))
611
612 ;;; Checks whether NODE is in a block to be deleted
613 (declaim (inline node-to-be-deleted-p))
614 (defun node-to-be-deleted-p (node)
615   (block-to-be-deleted-p (node-block node)))
616
617 (declaim (ftype (sfunction (clambda) cblock) lambda-block))
618 (defun lambda-block (clambda)
619   (node-block (lambda-bind clambda)))
620 (declaim (ftype (sfunction (clambda) component) lambda-component))
621 (defun lambda-component (clambda)
622   (block-component (lambda-block clambda)))
623
624 (declaim (ftype (sfunction (cblock) node) block-start-node))
625 (defun block-start-node (block)
626   (ctran-next (block-start block)))
627
628 ;;; Return the enclosing cleanup for environment of the first or last
629 ;;; node in BLOCK.
630 (defun block-start-cleanup (block)
631   (node-enclosing-cleanup (block-start-node block)))
632 (defun block-end-cleanup (block)
633   (node-enclosing-cleanup (block-last block)))
634
635 ;;; Return the non-LET LAMBDA that holds BLOCK's code, or NIL
636 ;;; if there is none.
637 ;;;
638 ;;; There can legitimately be no home lambda in dead code early in the
639 ;;; IR1 conversion process, e.g. when IR1-converting the SETQ form in
640 ;;;   (BLOCK B (RETURN-FROM B) (SETQ X 3))
641 ;;; where the block is just a placeholder during parsing and doesn't
642 ;;; actually correspond to code which will be written anywhere.
643 (declaim (ftype (sfunction (cblock) (or clambda null)) block-home-lambda-or-null))
644 (defun block-home-lambda-or-null (block)
645   (if (node-p (block-last block))
646       ;; This is the old CMU CL way of doing it.
647       (node-home-lambda (block-last block))
648       ;; Now that SBCL uses this operation more aggressively than CMU
649       ;; CL did, the old CMU CL way of doing it can fail in two ways.
650       ;;   1. It can fail in a few cases even when a meaningful home
651       ;;      lambda exists, e.g. in IR1-CONVERT of one of the legs of
652       ;;      an IF.
653       ;;   2. It can fail when converting a form which is born orphaned
654       ;;      so that it never had a meaningful home lambda, e.g. a form
655       ;;      which follows a RETURN-FROM or GO form.
656       (let ((pred-list (block-pred block)))
657         ;; To deal with case 1, we reason that
658         ;; previous-in-target-execution-order blocks should be in the
659         ;; same lambda, and that they seem in practice to be
660         ;; previous-in-compilation-order blocks too, so we look back
661         ;; to find one which is sufficiently initialized to tell us
662         ;; what the home lambda is.
663         (if pred-list
664             ;; We could get fancy about this, flooding through the
665             ;; graph of all the previous blocks, but in practice it
666             ;; seems to work just to grab the first previous block and
667             ;; use it.
668             (node-home-lambda (block-last (first pred-list)))
669             ;; In case 2, we end up with an empty PRED-LIST and
670             ;; have to punt: There's no home lambda.
671             nil))))
672
673 ;;; Return the non-LET LAMBDA that holds BLOCK's code.
674 (declaim (ftype (sfunction (cblock) clambda) block-home-lambda))
675 (defun block-home-lambda (block)
676   (block-home-lambda-or-null block))
677
678 ;;; Return the IR1 physical environment for BLOCK.
679 (declaim (ftype (sfunction (cblock) physenv) block-physenv))
680 (defun block-physenv (block)
681   (lambda-physenv (block-home-lambda block)))
682
683 ;;; Return the Top Level Form number of PATH, i.e. the ordinal number
684 ;;; of its original source's top level form in its compilation unit.
685 (defun source-path-tlf-number (path)
686   (declare (list path))
687   (car (last path)))
688
689 ;;; Return the (reversed) list for the PATH in the original source
690 ;;; (with the Top Level Form number last).
691 (defun source-path-original-source (path)
692   (declare (list path) (inline member))
693   (cddr (member 'original-source-start path :test #'eq)))
694
695 ;;; Return the Form Number of PATH's original source inside the Top
696 ;;; Level Form that contains it. This is determined by the order that
697 ;;; we walk the subforms of the top level source form.
698 (defun source-path-form-number (path)
699   (declare (list path) (inline member))
700   (cadr (member 'original-source-start path :test #'eq)))
701
702 ;;; Return a list of all the enclosing forms not in the original
703 ;;; source that converted to get to this form, with the immediate
704 ;;; source for node at the start of the list.
705 (defun source-path-forms (path)
706   (subseq path 0 (position 'original-source-start path)))
707
708 ;;; Return the innermost source form for NODE.
709 (defun node-source-form (node)
710   (declare (type node node))
711   (let* ((path (node-source-path node))
712          (forms (source-path-forms path)))
713     (if forms
714         (first forms)
715         (values (find-original-source path)))))
716
717 ;;; Return NODE-SOURCE-FORM, T if lvar has a single use, otherwise
718 ;;; NIL, NIL.
719 (defun lvar-source (lvar)
720   (let ((use (lvar-uses lvar)))
721     (if (listp use)
722         (values nil nil)
723         (values (node-source-form use) t))))
724
725 ;;; Return the unique node, delivering a value to LVAR.
726 #!-sb-fluid (declaim (inline lvar-use))
727 (defun lvar-use (lvar)
728   (the (not list) (lvar-uses lvar)))
729
730 #!-sb-fluid (declaim (inline lvar-has-single-use-p))
731 (defun lvar-has-single-use-p (lvar)
732   (typep (lvar-uses lvar) '(not list)))
733
734 ;;; Return the LAMBDA that is CTRAN's home, or NIL if there is none.
735 (declaim (ftype (sfunction (ctran) (or clambda null))
736                 ctran-home-lambda-or-null))
737 (defun ctran-home-lambda-or-null (ctran)
738   ;; KLUDGE: This function is a post-CMU-CL hack by WHN, and this
739   ;; implementation might not be quite right, or might be uglier than
740   ;; necessary. It appears that the original Python never found a need
741   ;; to do this operation. The obvious things based on
742   ;; NODE-HOME-LAMBDA of CTRAN-USE usually work; then if that fails,
743   ;; BLOCK-HOME-LAMBDA of CTRAN-BLOCK works, given that we
744   ;; generalize it enough to grovel harder when the simple CMU CL
745   ;; approach fails, and furthermore realize that in some exceptional
746   ;; cases it might return NIL. -- WHN 2001-12-04
747   (cond ((ctran-use ctran)
748          (node-home-lambda (ctran-use ctran)))
749         ((ctran-block ctran)
750          (block-home-lambda-or-null (ctran-block ctran)))
751         (t
752          (bug "confused about home lambda for ~S" ctran))))
753
754 ;;; Return the LAMBDA that is CTRAN's home.
755 (declaim (ftype (sfunction (ctran) clambda) ctran-home-lambda))
756 (defun ctran-home-lambda (ctran)
757   (ctran-home-lambda-or-null ctran))
758
759 (declaim (inline cast-single-value-p))
760 (defun cast-single-value-p (cast)
761   (not (values-type-p (cast-asserted-type cast))))
762
763 #!-sb-fluid (declaim (inline lvar-single-value-p))
764 (defun lvar-single-value-p (lvar)
765   (or (not lvar)
766       (let ((dest (lvar-dest lvar)))
767         (typecase dest
768           ((or creturn exit)
769            nil)
770           (mv-combination
771            (eq (basic-combination-fun dest) lvar))
772           (cast
773            (locally
774                (declare (notinline lvar-single-value-p))
775              (and (cast-single-value-p dest)
776                   (lvar-single-value-p (node-lvar dest)))))
777           (t
778            t)))))
779
780 (defun principal-lvar-end (lvar)
781   (loop for prev = lvar then (node-lvar dest)
782         for dest = (and prev (lvar-dest prev))
783         while (cast-p dest)
784         finally (return (values dest prev))))
785
786 (defun principal-lvar-single-valuify (lvar)
787   (loop for prev = lvar then (node-lvar dest)
788         for dest = (and prev (lvar-dest prev))
789         while (cast-p dest)
790         do (setf (node-derived-type dest)
791                  (make-short-values-type (list (single-value-type
792                                                 (node-derived-type dest)))))
793         (reoptimize-lvar prev)))
794 \f
795 ;;; Return a new LEXENV just like DEFAULT except for the specified
796 ;;; slot values. Values for the alist slots are NCONCed to the
797 ;;; beginning of the current value, rather than replacing it entirely.
798 (defun make-lexenv (&key (default *lexenv*)
799                          funs vars blocks tags
800                          type-restrictions
801                          (lambda (lexenv-lambda default))
802                          (cleanup (lexenv-cleanup default))
803                          (handled-conditions (lexenv-handled-conditions default))
804                          (disabled-package-locks
805                           (lexenv-disabled-package-locks default))
806                          (policy (lexenv-policy default)))
807   (macrolet ((frob (var slot)
808                `(let ((old (,slot default)))
809                   (if ,var
810                       (nconc ,var old)
811                       old))))
812     (internal-make-lexenv
813      (frob funs lexenv-funs)
814      (frob vars lexenv-vars)
815      (frob blocks lexenv-blocks)
816      (frob tags lexenv-tags)
817      (frob type-restrictions lexenv-type-restrictions)
818      lambda cleanup handled-conditions
819      disabled-package-locks policy)))
820
821 ;;; Makes a LEXENV, suitable for using in a MACROLET introduced
822 ;;; macroexpander
823 (defun make-restricted-lexenv (lexenv)
824   (flet ((fun-good-p (fun)
825            (destructuring-bind (name . thing) fun
826              (declare (ignore name))
827              (etypecase thing
828                (functional nil)
829                (global-var t)
830                (cons (aver (eq (car thing) 'macro))
831                      t))))
832          (var-good-p (var)
833            (destructuring-bind (name . thing) var
834              (declare (ignore name))
835              (etypecase thing
836                ;; The evaluator will mark lexicals with :BOGUS when it
837                ;; translates an interpreter lexenv to a compiler
838                ;; lexenv.
839                ((or leaf #!+sb-eval (member :bogus)) nil)
840                (cons (aver (eq (car thing) 'macro))
841                      t)
842                (heap-alien-info nil)))))
843     (internal-make-lexenv
844      (remove-if-not #'fun-good-p (lexenv-funs lexenv))
845      (remove-if-not #'var-good-p (lexenv-vars lexenv))
846      nil
847      nil
848      (lexenv-type-restrictions lexenv) ; XXX
849      nil
850      nil
851      (lexenv-handled-conditions lexenv)
852      (lexenv-disabled-package-locks lexenv)
853      (lexenv-policy lexenv))))
854 \f
855 ;;;; flow/DFO/component hackery
856
857 ;;; Join BLOCK1 and BLOCK2.
858 (defun link-blocks (block1 block2)
859   (declare (type cblock block1 block2))
860   (setf (block-succ block1)
861         (if (block-succ block1)
862             (%link-blocks block1 block2)
863             (list block2)))
864   (push block1 (block-pred block2))
865   (values))
866 (defun %link-blocks (block1 block2)
867   (declare (type cblock block1 block2))
868   (let ((succ1 (block-succ block1)))
869     (aver (not (memq block2 succ1)))
870     (cons block2 succ1)))
871
872 ;;; This is like LINK-BLOCKS, but we separate BLOCK1 and BLOCK2. If
873 ;;; this leaves a successor with a single predecessor that ends in an
874 ;;; IF, then set BLOCK-TEST-MODIFIED so that any test constraint will
875 ;;; now be able to be propagated to the successor.
876 (defun unlink-blocks (block1 block2)
877   (declare (type cblock block1 block2))
878   (let ((succ1 (block-succ block1)))
879     (if (eq block2 (car succ1))
880         (setf (block-succ block1) (cdr succ1))
881         (do ((succ (cdr succ1) (cdr succ))
882              (prev succ1 succ))
883             ((eq (car succ) block2)
884              (setf (cdr prev) (cdr succ)))
885           (aver succ))))
886
887   (let ((new-pred (delq block1 (block-pred block2))))
888     (setf (block-pred block2) new-pred)
889     (when (singleton-p new-pred)
890       (let ((pred-block (first new-pred)))
891         (when (if-p (block-last pred-block))
892           (setf (block-test-modified pred-block) t)))))
893   (values))
894
895 ;;; Swing the succ/pred link between BLOCK and OLD to be between BLOCK
896 ;;; and NEW. If BLOCK ends in an IF, then we have to fix up the
897 ;;; consequent/alternative blocks to point to NEW. We also set
898 ;;; BLOCK-TEST-MODIFIED so that any test constraint will be applied to
899 ;;; the new successor.
900 (defun change-block-successor (block old new)
901   (declare (type cblock new old block))
902   (unlink-blocks block old)
903   (let ((last (block-last block))
904         (comp (block-component block)))
905     (setf (component-reanalyze comp) t)
906     (typecase last
907       (cif
908        (setf (block-test-modified block) t)
909        (let* ((succ-left (block-succ block))
910               (new (if (and (eq new (component-tail comp))
911                             succ-left)
912                        (first succ-left)
913                        new)))
914          (unless (memq new succ-left)
915            (link-blocks block new))
916          (macrolet ((frob (slot)
917                       `(when (eq (,slot last) old)
918                          (setf (,slot last) new))))
919            (frob if-consequent)
920            (frob if-alternative)
921            (when (eq (if-consequent last)
922                      (if-alternative last))
923              (reoptimize-component (block-component block) :maybe)))))
924       (t
925        (unless (memq new (block-succ block))
926          (link-blocks block new)))))
927
928   (values))
929
930 ;;; Unlink a block from the next/prev chain. We also null out the
931 ;;; COMPONENT.
932 (declaim (ftype (sfunction (cblock) (values)) remove-from-dfo))
933 (defun remove-from-dfo (block)
934   (let ((next (block-next block))
935         (prev (block-prev block)))
936     (setf (block-component block) nil)
937     (setf (block-next prev) next)
938     (setf (block-prev next) prev))
939   (values))
940
941 ;;; Add BLOCK to the next/prev chain following AFTER. We also set the
942 ;;; COMPONENT to be the same as for AFTER.
943 (defun add-to-dfo (block after)
944   (declare (type cblock block after))
945   (let ((next (block-next after))
946         (comp (block-component after)))
947     (aver (not (eq (component-kind comp) :deleted)))
948     (setf (block-component block) comp)
949     (setf (block-next after) block)
950     (setf (block-prev block) after)
951     (setf (block-next block) next)
952     (setf (block-prev next) block))
953   (values))
954
955 ;;; List all NLX-INFOs which BLOCK can exit to.
956 ;;;
957 ;;; We hope that no cleanup actions are performed in the middle of
958 ;;; BLOCK, so it is enough to look only at cleanups in the block
959 ;;; end. The tricky thing is a special cleanup block; all its nodes
960 ;;; have the same cleanup info, corresponding to the start, so the
961 ;;; same approach returns safe result.
962 (defun map-block-nlxes (fun block &optional dx-cleanup-fun)
963   (loop for cleanup = (block-end-cleanup block)
964         then (node-enclosing-cleanup (cleanup-mess-up cleanup))
965         while cleanup
966         do (let ((mess-up (cleanup-mess-up cleanup)))
967              (case (cleanup-kind cleanup)
968                ((:block :tagbody)
969                 (aver (entry-p mess-up))
970                 (loop for exit in (entry-exits mess-up)
971                       for nlx-info = (exit-nlx-info exit)
972                       do (funcall fun nlx-info)))
973                ((:catch :unwind-protect)
974                 (aver (combination-p mess-up))
975                 (let* ((arg-lvar (first (basic-combination-args mess-up)))
976                        (nlx-info (constant-value (ref-leaf (lvar-use arg-lvar)))))
977                 (funcall fun nlx-info)))
978                ((:dynamic-extent)
979                 (when dx-cleanup-fun
980                   (funcall dx-cleanup-fun cleanup)))))))
981
982 ;;; Set the FLAG for all the blocks in COMPONENT to NIL, except for
983 ;;; the head and tail which are set to T.
984 (declaim (ftype (sfunction (component) (values)) clear-flags))
985 (defun clear-flags (component)
986   (let ((head (component-head component))
987         (tail (component-tail component)))
988     (setf (block-flag head) t)
989     (setf (block-flag tail) t)
990     (do-blocks (block component)
991       (setf (block-flag block) nil)))
992   (values))
993
994 ;;; Make a component with no blocks in it. The BLOCK-FLAG is initially
995 ;;; true in the head and tail blocks.
996 (declaim (ftype (sfunction () component) make-empty-component))
997 (defun make-empty-component ()
998   (let* ((head (make-block-key :start nil :component nil))
999          (tail (make-block-key :start nil :component nil))
1000          (res (make-component head tail)))
1001     (setf (block-flag head) t)
1002     (setf (block-flag tail) t)
1003     (setf (block-component head) res)
1004     (setf (block-component tail) res)
1005     (setf (block-next head) tail)
1006     (setf (block-prev tail) head)
1007     res))
1008
1009 ;;; Make NODE the LAST node in its block, splitting the block if necessary.
1010 ;;; The new block is added to the DFO immediately following NODE's block.
1011 (defun node-ends-block (node)
1012   (declare (type node node))
1013   (let* ((block (node-block node))
1014          (start (node-next node))
1015          (last (block-last block)))
1016     (check-type last node)
1017     (unless (eq last node)
1018       (aver (and (eq (ctran-kind start) :inside-block)
1019                  (not (block-delete-p block))))
1020       (let* ((succ (block-succ block))
1021              (new-block
1022               (make-block-key :start start
1023                               :component (block-component block)
1024                               :succ succ :last last)))
1025         (setf (ctran-kind start) :block-start)
1026         (setf (ctran-use start) nil)
1027         (setf (block-last block) node)
1028         (setf (node-next node) nil)
1029         (dolist (b succ)
1030           (setf (block-pred b)
1031                 (cons new-block (remove block (block-pred b)))))
1032         (setf (block-succ block) ())
1033         (link-blocks block new-block)
1034         (add-to-dfo new-block block)
1035         (setf (component-reanalyze (block-component block)) t)
1036
1037         (do ((ctran start (node-next (ctran-next ctran))))
1038             ((not ctran))
1039           (setf (ctran-block ctran) new-block))
1040
1041         (setf (block-type-asserted block) t)
1042         (setf (block-test-modified block) t))))
1043   (values))
1044 \f
1045 ;;;; deleting stuff
1046
1047 ;;; Deal with deleting the last (read) reference to a LAMBDA-VAR.
1048 (defun delete-lambda-var (leaf)
1049   (declare (type lambda-var leaf))
1050
1051   ;; Iterate over all local calls flushing the corresponding argument,
1052   ;; allowing the computation of the argument to be deleted. We also
1053   ;; mark the LET for reoptimization, since it may be that we have
1054   ;; deleted its last variable.
1055   (let* ((fun (lambda-var-home leaf))
1056          (n (position leaf (lambda-vars fun))))
1057     (dolist (ref (leaf-refs fun))
1058       (let* ((lvar (node-lvar ref))
1059              (dest (and lvar (lvar-dest lvar))))
1060         (when (and (combination-p dest)
1061                    (eq (basic-combination-fun dest) lvar)
1062                    (eq (basic-combination-kind dest) :local))
1063           (let* ((args (basic-combination-args dest))
1064                  (arg (elt args n)))
1065             (reoptimize-lvar arg)
1066             (flush-dest arg)
1067             (setf (elt args n) nil))))))
1068
1069   ;; The LAMBDA-VAR may still have some SETs, but this doesn't cause
1070   ;; too much difficulty, since we can efficiently implement
1071   ;; write-only variables. We iterate over the SETs, marking their
1072   ;; blocks for dead code flushing, since we can delete SETs whose
1073   ;; value is unused.
1074   (dolist (set (lambda-var-sets leaf))
1075     (setf (block-flush-p (node-block set)) t))
1076
1077   (values))
1078
1079 ;;; Note that something interesting has happened to VAR.
1080 (defun reoptimize-lambda-var (var)
1081   (declare (type lambda-var var))
1082   (let ((fun (lambda-var-home var)))
1083     ;; We only deal with LET variables, marking the corresponding
1084     ;; initial value arg as needing to be reoptimized.
1085     (when (and (eq (functional-kind fun) :let)
1086                (leaf-refs var))
1087       (do ((args (basic-combination-args
1088                   (lvar-dest (node-lvar (first (leaf-refs fun)))))
1089                  (cdr args))
1090            (vars (lambda-vars fun) (cdr vars)))
1091           ((eq (car vars) var)
1092            (reoptimize-lvar (car args))))))
1093   (values))
1094
1095 ;;; Delete a function that has no references. This need only be called
1096 ;;; on functions that never had any references, since otherwise
1097 ;;; DELETE-REF will handle the deletion.
1098 (defun delete-functional (fun)
1099   (aver (and (null (leaf-refs fun))
1100              (not (functional-entry-fun fun))))
1101   (etypecase fun
1102     (optional-dispatch (delete-optional-dispatch fun))
1103     (clambda (delete-lambda fun)))
1104   (values))
1105
1106 ;;; Deal with deleting the last reference to a CLAMBDA, which means
1107 ;;; that the lambda is unreachable, so that its body may be
1108 ;;; deleted. We set FUNCTIONAL-KIND to :DELETED and rely on
1109 ;;; IR1-OPTIMIZE to delete its blocks.
1110 (defun delete-lambda (clambda)
1111   (declare (type clambda clambda))
1112   (let ((original-kind (functional-kind clambda))
1113         (bind (lambda-bind clambda)))
1114     (aver (not (member original-kind '(:deleted :toplevel))))
1115     (aver (not (functional-has-external-references-p clambda)))
1116     (aver (or (eq original-kind :zombie) bind))
1117     (setf (functional-kind clambda) :deleted)
1118     (setf (lambda-bind clambda) nil)
1119
1120     (labels ((delete-children (lambda)
1121                (dolist (child (lambda-children lambda))
1122                  (cond ((eq (functional-kind child) :deleted)
1123                         (delete-children child))
1124                        (t
1125                         (delete-lambda child))))
1126                (setf (lambda-children lambda) nil)
1127                (setf (lambda-parent lambda) nil)))
1128       (delete-children clambda))
1129
1130     ;; (The IF test is (FUNCTIONAL-SOMEWHAT-LETLIKE-P CLAMBDA), except
1131     ;; that we're using the old value of the KIND slot, not the
1132     ;; current slot value, which has now been set to :DELETED.)
1133     (case original-kind
1134       (:zombie)
1135       ((:let :mv-let :assignment)
1136        (let ((bind-block (node-block bind)))
1137          (mark-for-deletion bind-block))
1138        (let ((home (lambda-home clambda)))
1139          (setf (lambda-lets home) (delete clambda (lambda-lets home))))
1140        ;; KLUDGE: In presence of NLEs we cannot always understand that
1141        ;; LET's BIND dominates its body [for a LET "its" body is not
1142        ;; quite its]; let's delete too dangerous for IR2 stuff. --
1143        ;; APD, 2004-01-01
1144        (dolist (var (lambda-vars clambda))
1145          (flet ((delete-node (node)
1146                   (mark-for-deletion (node-block node))))
1147          (mapc #'delete-node (leaf-refs var))
1148          (mapc #'delete-node (lambda-var-sets var)))))
1149       (t
1150        ;; Function has no reachable references.
1151        (dolist (ref (lambda-refs clambda))
1152          (mark-for-deletion (node-block ref)))
1153        ;; If the function isn't a LET, we unlink the function head
1154        ;; and tail from the component head and tail to indicate that
1155        ;; the code is unreachable. We also delete the function from
1156        ;; COMPONENT-LAMBDAS (it won't be there before local call
1157        ;; analysis, but no matter.) If the lambda was never
1158        ;; referenced, we give a note.
1159        (let* ((bind-block (node-block bind))
1160               (component (block-component bind-block))
1161               (return (lambda-return clambda))
1162               (return-block (and return (node-block return))))
1163          (unless (leaf-ever-used clambda)
1164            (let ((*compiler-error-context* bind))
1165              (compiler-notify 'code-deletion-note
1166                               :format-control "deleting unused function~:[.~;~:*~%  ~S~]"
1167                               :format-arguments (list (leaf-debug-name clambda)))))
1168          (unless (block-delete-p bind-block)
1169            (unlink-blocks (component-head component) bind-block))
1170          (when (and return-block (not (block-delete-p return-block)))
1171            (mark-for-deletion return-block)
1172            (unlink-blocks return-block (component-tail component)))
1173          (setf (component-reanalyze component) t)
1174          (let ((tails (lambda-tail-set clambda)))
1175            (setf (tail-set-funs tails)
1176                  (delete clambda (tail-set-funs tails)))
1177            (setf (lambda-tail-set clambda) nil))
1178          (setf (component-lambdas component)
1179                (delq clambda (component-lambdas component))))))
1180
1181     ;; If the lambda is an XEP, then we null out the ENTRY-FUN in its
1182     ;; ENTRY-FUN so that people will know that it is not an entry
1183     ;; point anymore.
1184     (when (eq original-kind :external)
1185       (let ((fun (functional-entry-fun clambda)))
1186         (setf (functional-entry-fun fun) nil)
1187         (when (optional-dispatch-p fun)
1188           (delete-optional-dispatch fun)))))
1189
1190   (values))
1191
1192 ;;; Deal with deleting the last reference to an OPTIONAL-DISPATCH. We
1193 ;;; have to be a bit more careful than with lambdas, since DELETE-REF
1194 ;;; is used both before and after local call analysis. Afterward, all
1195 ;;; references to still-existing OPTIONAL-DISPATCHes have been moved
1196 ;;; to the XEP, leaving it with no references at all. So we look at
1197 ;;; the XEP to see whether an optional-dispatch is still really being
1198 ;;; used. But before local call analysis, there are no XEPs, and all
1199 ;;; references are direct.
1200 ;;;
1201 ;;; When we do delete the OPTIONAL-DISPATCH, we grovel all of its
1202 ;;; entry-points, making them be normal lambdas, and then deleting the
1203 ;;; ones with no references. This deletes any e-p lambdas that were
1204 ;;; either never referenced, or couldn't be deleted when the last
1205 ;;; reference was deleted (due to their :OPTIONAL kind.)
1206 ;;;
1207 ;;; Note that the last optional entry point may alias the main entry,
1208 ;;; so when we process the main entry, its KIND may have been changed
1209 ;;; to NIL or even converted to a LETlike value.
1210 (defun delete-optional-dispatch (leaf)
1211   (declare (type optional-dispatch leaf))
1212   (let ((entry (functional-entry-fun leaf)))
1213     (unless (and entry (leaf-refs entry))
1214       (aver (or (not entry) (eq (functional-kind entry) :deleted)))
1215       (setf (functional-kind leaf) :deleted)
1216
1217       (flet ((frob (fun)
1218                (unless (eq (functional-kind fun) :deleted)
1219                  (aver (eq (functional-kind fun) :optional))
1220                  (setf (functional-kind fun) nil)
1221                  (let ((refs (leaf-refs fun)))
1222                    (cond ((null refs)
1223                           (delete-lambda fun))
1224                          ((null (rest refs))
1225                           (or (maybe-let-convert fun)
1226                               (maybe-convert-to-assignment fun)))
1227                          (t
1228                           (maybe-convert-to-assignment fun)))))))
1229
1230         (dolist (ep (optional-dispatch-entry-points leaf))
1231           (when (promise-ready-p ep)
1232             (frob (force ep))))
1233         (when (optional-dispatch-more-entry leaf)
1234           (frob (optional-dispatch-more-entry leaf)))
1235         (let ((main (optional-dispatch-main-entry leaf)))
1236           (when entry
1237             (setf (functional-entry-fun entry) main)
1238             (setf (functional-entry-fun main) entry))
1239           (when (eq (functional-kind main) :optional)
1240             (frob main))))))
1241
1242   (values))
1243
1244 (defun note-local-functional (fun)
1245   (declare (type functional fun))
1246   (when (and (leaf-has-source-name-p fun)
1247              (eq (leaf-source-name fun) (functional-debug-name fun)))
1248     (let ((name (leaf-source-name fun)))
1249       (let ((defined-fun (gethash name *free-funs*)))
1250         (when (and defined-fun
1251                    (defined-fun-p defined-fun)
1252                    (eq (defined-fun-functional defined-fun) fun))
1253           (remhash name *free-funs*))))))
1254
1255 ;;; Return functional for DEFINED-FUN which has been converted in policy
1256 ;;; corresponding to the current one, or NIL if no such functional exists.
1257 (defun defined-fun-functional (defined-fun)
1258   (let ((policy (lexenv-%policy *lexenv*)))
1259     (dolist (functional (defined-fun-functionals defined-fun))
1260       (when (equal policy (lexenv-%policy (functional-lexenv functional)))
1261         (return functional)))))
1262
1263 ;;; Do stuff to delete the semantic attachments of a REF node. When
1264 ;;; this leaves zero or one reference, we do a type dispatch off of
1265 ;;; the leaf to determine if a special action is appropriate.
1266 (defun delete-ref (ref)
1267   (declare (type ref ref))
1268   (let* ((leaf (ref-leaf ref))
1269          (refs (delq ref (leaf-refs leaf))))
1270     (setf (leaf-refs leaf) refs)
1271
1272     (cond ((null refs)
1273            (typecase leaf
1274              (lambda-var
1275               (delete-lambda-var leaf))
1276              (clambda
1277               (ecase (functional-kind leaf)
1278                 ((nil :let :mv-let :assignment :escape :cleanup)
1279                  (aver (null (functional-entry-fun leaf)))
1280                  (delete-lambda leaf))
1281                 (:external
1282                  (delete-lambda leaf))
1283                 ((:deleted :zombie :optional))))
1284              (optional-dispatch
1285               (unless (eq (functional-kind leaf) :deleted)
1286                 (delete-optional-dispatch leaf)))))
1287           ((null (rest refs))
1288            (typecase leaf
1289              (clambda (or (maybe-let-convert leaf)
1290                           (maybe-convert-to-assignment leaf)))
1291              (lambda-var (reoptimize-lambda-var leaf))))
1292           (t
1293            (typecase leaf
1294              (clambda (maybe-convert-to-assignment leaf))))))
1295
1296   (values))
1297
1298 ;;; This function is called by people who delete nodes; it provides a
1299 ;;; way to indicate that the value of a lvar is no longer used. We
1300 ;;; null out the LVAR-DEST, set FLUSH-P in the blocks containing uses
1301 ;;; of LVAR and set COMPONENT-REOPTIMIZE.
1302 (defun flush-dest (lvar)
1303   (declare (type (or lvar null) lvar))
1304   (unless (null lvar)
1305     (when (lvar-dynamic-extent lvar)
1306       (note-no-stack-allocation lvar :flush t))
1307     (setf (lvar-dest lvar) nil)
1308     (flush-lvar-externally-checkable-type lvar)
1309     (do-uses (use lvar)
1310       (let ((prev (node-prev use)))
1311         (let ((block (ctran-block prev)))
1312           (reoptimize-component (block-component block) t)
1313           (setf (block-attributep (block-flags block)
1314                                   flush-p type-asserted type-check)
1315                 t)))
1316       (setf (node-lvar use) nil))
1317     (setf (lvar-uses lvar) nil))
1318   (values))
1319
1320 (defun delete-dest (lvar)
1321   (when lvar
1322     (let* ((dest (lvar-dest lvar))
1323            (prev (node-prev dest)))
1324       (let ((block (ctran-block prev)))
1325         (unless (block-delete-p block)
1326           (mark-for-deletion block))))))
1327
1328 ;;; Queue the block for deletion
1329 (defun delete-block-lazily (block)
1330   (declare (type cblock block))
1331   (unless (block-delete-p block)
1332     (setf (block-delete-p block) t)
1333     (push block (component-delete-blocks (block-component block)))))
1334
1335 ;;; Do a graph walk backward from BLOCK, marking all predecessor
1336 ;;; blocks with the DELETE-P flag.
1337 (defun mark-for-deletion (block)
1338   (declare (type cblock block))
1339   (let* ((component (block-component block))
1340          (head (component-head component)))
1341     (labels ((helper (block)
1342                (delete-block-lazily block)
1343                (dolist (pred (block-pred block))
1344                  (unless (or (block-delete-p pred)
1345                              (eq pred head))
1346                    (helper pred)))))
1347       (unless (block-delete-p block)
1348         (helper block)
1349         (setf (component-reanalyze component) t))))
1350   (values))
1351
1352 ;;; This function does what is necessary to eliminate the code in it
1353 ;;; from the IR1 representation. This involves unlinking it from its
1354 ;;; predecessors and successors and deleting various node-specific
1355 ;;; semantic information. BLOCK must be already removed from
1356 ;;; COMPONENT-DELETE-BLOCKS.
1357 (defun delete-block (block &optional silent)
1358   (declare (type cblock block))
1359   (aver (block-component block))      ; else block is already deleted!
1360   #!+high-security (aver (not (memq block (component-delete-blocks (block-component block)))))
1361   (unless silent
1362     (note-block-deletion block))
1363   (setf (block-delete-p block) t)
1364
1365   (dolist (b (block-pred block))
1366     (unlink-blocks b block)
1367     ;; In bug 147 the almost-all-blocks-have-a-successor invariant was
1368     ;; broken when successors were deleted without setting the
1369     ;; BLOCK-DELETE-P flags of their predececessors. Make sure that
1370     ;; doesn't happen again.
1371     (aver (not (and (null (block-succ b))
1372                     (not (block-delete-p b))
1373                     (not (eq b (component-head (block-component b))))))))
1374   (dolist (b (block-succ block))
1375     (unlink-blocks block b))
1376
1377   (do-nodes-carefully (node block)
1378     (when (valued-node-p node)
1379       (delete-lvar-use node))
1380     (etypecase node
1381       (ref (delete-ref node))
1382       (cif (flush-dest (if-test node)))
1383       ;; The next two cases serve to maintain the invariant that a LET
1384       ;; always has a well-formed COMBINATION, REF and BIND. We delete
1385       ;; the lambda whenever we delete any of these, but we must be
1386       ;; careful that this LET has not already been partially deleted.
1387       (basic-combination
1388        (when (and (eq (basic-combination-kind node) :local)
1389                   ;; Guards COMBINATION-LAMBDA agains the REF being deleted.
1390                   (lvar-uses (basic-combination-fun node)))
1391          (let ((fun (combination-lambda node)))
1392            ;; If our REF was the second-to-last ref, and has been
1393            ;; deleted, then FUN may be a LET for some other
1394            ;; combination.
1395            (when (and (functional-letlike-p fun)
1396                       (eq (let-combination fun) node))
1397              (delete-lambda fun))))
1398        (flush-dest (basic-combination-fun node))
1399        (dolist (arg (basic-combination-args node))
1400          (when arg (flush-dest arg))))
1401       (bind
1402        (let ((lambda (bind-lambda node)))
1403          (unless (eq (functional-kind lambda) :deleted)
1404            (delete-lambda lambda))))
1405       (exit
1406        (let ((value (exit-value node))
1407              (entry (exit-entry node)))
1408          (when value
1409            (flush-dest value))
1410          (when entry
1411            (setf (entry-exits entry)
1412                  (delq node (entry-exits entry))))))
1413       (entry
1414        (dolist (exit (entry-exits node))
1415          (mark-for-deletion (node-block exit)))
1416        (let ((home (node-home-lambda node)))
1417          (setf (lambda-entries home) (delq node (lambda-entries home)))))
1418       (creturn
1419        (flush-dest (return-result node))
1420        (delete-return node))
1421       (cset
1422        (flush-dest (set-value node))
1423        (let ((var (set-var node)))
1424          (setf (basic-var-sets var)
1425                (delete node (basic-var-sets var)))))
1426       (cast
1427        (flush-dest (cast-value node)))))
1428
1429   (remove-from-dfo block)
1430   (values))
1431
1432 ;;; Do stuff to indicate that the return node NODE is being deleted.
1433 (defun delete-return (node)
1434   (declare (type creturn node))
1435   (let* ((fun (return-lambda node))
1436          (tail-set (lambda-tail-set fun)))
1437     (aver (lambda-return fun))
1438     (setf (lambda-return fun) nil)
1439     (when (and tail-set (not (find-if #'lambda-return
1440                                       (tail-set-funs tail-set))))
1441       (setf (tail-set-type tail-set) *empty-type*)))
1442   (values))
1443
1444 ;;; If any of the VARS in FUN was never referenced and was not
1445 ;;; declared IGNORE, then complain.
1446 (defun note-unreferenced-vars (fun)
1447   (declare (type clambda fun))
1448   (dolist (var (lambda-vars fun))
1449     (unless (or (leaf-ever-used var)
1450                 (lambda-var-ignorep var))
1451       (let ((*compiler-error-context* (lambda-bind fun)))
1452         (unless (policy *compiler-error-context* (= inhibit-warnings 3))
1453           ;; ANSI section "3.2.5 Exceptional Situations in the Compiler"
1454           ;; requires this to be no more than a STYLE-WARNING.
1455           #-sb-xc-host
1456           (compiler-style-warn "The variable ~S is defined but never used."
1457                                (leaf-debug-name var))
1458           ;; There's no reason to accept this kind of equivocation
1459           ;; when compiling our own code, though.
1460           #+sb-xc-host
1461           (warn "The variable ~S is defined but never used."
1462                 (leaf-debug-name var)))
1463         (setf (leaf-ever-used var) t)))) ; to avoid repeated warnings? -- WHN
1464   (values))
1465
1466 (defvar *deletion-ignored-objects* '(t nil))
1467
1468 ;;; Return true if we can find OBJ in FORM, NIL otherwise. We bound
1469 ;;; our recursion so that we don't get lost in circular structures. We
1470 ;;; ignore the car of forms if they are a symbol (to prevent confusing
1471 ;;; function referencess with variables), and we also ignore anything
1472 ;;; inside ' or #'.
1473 (defun present-in-form (obj form depth)
1474   (declare (type (integer 0 20) depth))
1475   (cond ((= depth 20) nil)
1476         ((eq obj form) t)
1477         ((atom form) nil)
1478         (t
1479          (let ((first (car form))
1480                (depth (1+ depth)))
1481            (if (member first '(quote function))
1482                nil
1483                (or (and (not (symbolp first))
1484                         (present-in-form obj first depth))
1485                    (do ((l (cdr form) (cdr l))
1486                         (n 0 (1+ n)))
1487                        ((or (atom l) (> n 100))
1488                         nil)
1489                      (declare (fixnum n))
1490                      (when (present-in-form obj (car l) depth)
1491                        (return t)))))))))
1492
1493 ;;; This function is called on a block immediately before we delete
1494 ;;; it. We check to see whether any of the code about to die appeared
1495 ;;; in the original source, and emit a note if so.
1496 ;;;
1497 ;;; If the block was in a lambda is now deleted, then we ignore the
1498 ;;; whole block, since this case is picked off in DELETE-LAMBDA. We
1499 ;;; also ignore the deletion of CRETURN nodes, since it is somewhat
1500 ;;; reasonable for a function to not return, and there is a different
1501 ;;; note for that case anyway.
1502 ;;;
1503 ;;; If the actual source is an atom, then we use a bunch of heuristics
1504 ;;; to guess whether this reference really appeared in the original
1505 ;;; source:
1506 ;;; -- If a symbol, it must be interned and not a keyword.
1507 ;;; -- It must not be an easily introduced constant (T or NIL, a fixnum
1508 ;;;    or a character.)
1509 ;;; -- The atom must be "present" in the original source form, and
1510 ;;;    present in all intervening actual source forms.
1511 (defun note-block-deletion (block)
1512   (let ((home (block-home-lambda block)))
1513     (unless (eq (functional-kind home) :deleted)
1514       (do-nodes (node nil block)
1515         (let* ((path (node-source-path node))
1516                (first (first path)))
1517           (when (or (eq first 'original-source-start)
1518                     (and (atom first)
1519                          (or (not (symbolp first))
1520                              (let ((pkg (symbol-package first)))
1521                                (and pkg
1522                                     (not (eq pkg (symbol-package :end))))))
1523                          (not (member first *deletion-ignored-objects*))
1524                          (not (typep first '(or fixnum character)))
1525                          (every (lambda (x)
1526                                   (present-in-form first x 0))
1527                                 (source-path-forms path))
1528                          (present-in-form first (find-original-source path)
1529                                           0)))
1530             (unless (return-p node)
1531               (let ((*compiler-error-context* node))
1532                 (compiler-notify 'code-deletion-note
1533                                  :format-control "deleting unreachable code"
1534                                  :format-arguments nil)))
1535             (return))))))
1536   (values))
1537
1538 ;;; Delete a node from a block, deleting the block if there are no
1539 ;;; nodes left. We remove the node from the uses of its LVAR.
1540 ;;;
1541 ;;; If the node is the last node, there must be exactly one successor.
1542 ;;; We link all of our precedessors to the successor and unlink the
1543 ;;; block. In this case, we return T, otherwise NIL. If no nodes are
1544 ;;; left, and the block is a successor of itself, then we replace the
1545 ;;; only node with a degenerate exit node. This provides a way to
1546 ;;; represent the bodyless infinite loop, given the prohibition on
1547 ;;; empty blocks in IR1.
1548 (defun unlink-node (node)
1549   (declare (type node node))
1550   (when (valued-node-p node)
1551     (delete-lvar-use node))
1552
1553   (let* ((ctran (node-next node))
1554          (next (and ctran (ctran-next ctran)))
1555          (prev (node-prev node))
1556          (block (ctran-block prev))
1557          (prev-kind (ctran-kind prev))
1558          (last (block-last block)))
1559
1560     (setf (block-type-asserted block) t)
1561     (setf (block-test-modified block) t)
1562
1563     (cond ((or (eq prev-kind :inside-block)
1564                (and (eq prev-kind :block-start)
1565                     (not (eq node last))))
1566            (cond ((eq node last)
1567                   (setf (block-last block) (ctran-use prev))
1568                   (setf (node-next (ctran-use prev)) nil))
1569                  (t
1570                   (setf (ctran-next prev) next)
1571                   (setf (node-prev next) prev)
1572                   (when (if-p next) ; AOP wanted
1573                     (reoptimize-lvar (if-test next)))))
1574            (setf (node-prev node) nil)
1575            nil)
1576           (t
1577            (aver (eq prev-kind :block-start))
1578            (aver (eq node last))
1579            (let* ((succ (block-succ block))
1580                   (next (first succ)))
1581              (aver (singleton-p succ))
1582              (cond
1583               ((eq block (first succ))
1584                (with-ir1-environment-from-node node
1585                  (let ((exit (make-exit)))
1586                    (setf (ctran-next prev) nil)
1587                    (link-node-to-previous-ctran exit prev)
1588                    (setf (block-last block) exit)))
1589                (setf (node-prev node) nil)
1590                nil)
1591               (t
1592                (aver (eq (block-start-cleanup block)
1593                          (block-end-cleanup block)))
1594                (unlink-blocks block next)
1595                (dolist (pred (block-pred block))
1596                  (change-block-successor pred block next))
1597                (when (block-delete-p block)
1598                  (let ((component (block-component block)))
1599                    (setf (component-delete-blocks component)
1600                          (delq block (component-delete-blocks component)))))
1601                (remove-from-dfo block)
1602                (setf (block-delete-p block) t)
1603                (setf (node-prev node) nil)
1604                t)))))))
1605
1606 ;;; Return true if CTRAN has been deleted, false if it is still a valid
1607 ;;; part of IR1.
1608 (defun ctran-deleted-p (ctran)
1609   (declare (type ctran ctran))
1610   (let ((block (ctran-block ctran)))
1611     (or (not (block-component block))
1612         (block-delete-p block))))
1613
1614 ;;; Return true if NODE has been deleted, false if it is still a valid
1615 ;;; part of IR1.
1616 (defun node-deleted (node)
1617   (declare (type node node))
1618   (let ((prev (node-prev node)))
1619     (or (not prev)
1620         (ctran-deleted-p prev))))
1621
1622 ;;; Delete all the blocks and functions in COMPONENT. We scan first
1623 ;;; marking the blocks as DELETE-P to prevent weird stuff from being
1624 ;;; triggered by deletion.
1625 (defun delete-component (component)
1626   (declare (type component component))
1627   (aver (null (component-new-functionals component)))
1628   (setf (component-kind component) :deleted)
1629   (do-blocks (block component)
1630     (delete-block-lazily block))
1631   (dolist (fun (component-lambdas component))
1632     (unless (eq (functional-kind fun) :deleted)
1633       (setf (functional-kind fun) nil)
1634       (setf (functional-entry-fun fun) nil)
1635       (setf (leaf-refs fun) nil)
1636       (delete-functional fun)))
1637   (clean-component component)
1638   (values))
1639
1640 ;;; Remove all pending blocks to be deleted. Return the nearest live
1641 ;;; block after or equal to BLOCK.
1642 (defun clean-component (component &optional block)
1643   (loop while (component-delete-blocks component)
1644         ;; actual deletion of a block may queue new blocks
1645         do (let ((current (pop (component-delete-blocks component))))
1646              (when (eq block current)
1647                (setq block (block-next block)))
1648              (delete-block current)))
1649   block)
1650
1651 ;;; Convert code of the form
1652 ;;;   (FOO ... (FUN ...) ...)
1653 ;;; to
1654 ;;;   (FOO ...    ...    ...).
1655 ;;; In other words, replace the function combination FUN by its
1656 ;;; arguments. If there are any problems with doing this, use GIVE-UP
1657 ;;; to blow out of whatever transform called this. Note, as the number
1658 ;;; of arguments changes, the transform must be prepared to return a
1659 ;;; lambda with a new lambda-list with the correct number of
1660 ;;; arguments.
1661 (defun splice-fun-args (lvar fun num-args)
1662   #!+sb-doc
1663   "If LVAR is a call to FUN with NUM-ARGS args, change those arguments to feed
1664 directly to the LVAR-DEST of LVAR, which must be a combination. If FUN
1665 is :ANY, the function name is not checked."
1666   (declare (type lvar lvar)
1667            (type symbol fun)
1668            (type index num-args))
1669   (let ((outside (lvar-dest lvar))
1670         (inside (lvar-uses lvar)))
1671     (aver (combination-p outside))
1672     (unless (combination-p inside)
1673       (give-up-ir1-transform))
1674     (let ((inside-fun (combination-fun inside)))
1675       (unless (or (eq fun :any)
1676                   (eq (lvar-fun-name inside-fun) fun))
1677         (give-up-ir1-transform))
1678       (let ((inside-args (combination-args inside)))
1679         (unless (= (length inside-args) num-args)
1680           (give-up-ir1-transform))
1681         (let* ((outside-args (combination-args outside))
1682                (arg-position (position lvar outside-args))
1683                (before-args (subseq outside-args 0 arg-position))
1684                (after-args (subseq outside-args (1+ arg-position))))
1685           (dolist (arg inside-args)
1686             (setf (lvar-dest arg) outside)
1687             (flush-lvar-externally-checkable-type arg))
1688           (setf (combination-args inside) nil)
1689           (setf (combination-args outside)
1690                 (append before-args inside-args after-args))
1691           (change-ref-leaf (lvar-uses inside-fun)
1692                            (find-free-fun 'list "???"))
1693           (setf (combination-fun-info inside) (info :function :info 'list)
1694                 (combination-kind inside) :known)
1695           (setf (node-derived-type inside) *wild-type*)
1696           (flush-dest lvar)
1697           inside-args)))))
1698
1699 ;;; Eliminate keyword arguments from the call (leaving the
1700 ;;; parameters in place.
1701 ;;;
1702 ;;;    (FOO ... :BAR X :QUUX Y)
1703 ;;; becomes
1704 ;;;    (FOO ... X Y)
1705 ;;;
1706 ;;; SPECS is a list of (:KEYWORD PARAMETER) specifications.
1707 ;;; Returns the list of specified parameters names in the
1708 ;;; order they appeared in the call. N-POSITIONAL is the
1709 ;;; number of positional arguments in th call.
1710 (defun eliminate-keyword-args (call n-positional specs)
1711   (let* ((specs (copy-tree specs))
1712          (all (combination-args call))
1713          (new-args (reverse (subseq all 0 n-positional)))
1714          (key-args (subseq all n-positional))
1715          (parameters nil)
1716          (flushed-keys nil))
1717     (loop while key-args
1718           do (let* ((key (pop key-args))
1719                     (val (pop key-args))
1720                     (keyword (if (constant-lvar-p key)
1721                                  (lvar-value key)
1722                                  (give-up-ir1-transform)))
1723                     (spec (or (assoc keyword specs :test #'eq)
1724                               (give-up-ir1-transform))))
1725                (push val new-args)
1726                (push key flushed-keys)
1727                (push (second spec) parameters)
1728                ;; In case of duplicate keys.
1729                (setf (second spec) (gensym))))
1730     (dolist (key flushed-keys)
1731       (flush-dest key))
1732     (setf (combination-args call) (reverse new-args))
1733     (reverse parameters)))
1734
1735 (defun extract-fun-args (lvar fun num-args)
1736   (declare (type lvar lvar)
1737            (type (or symbol list) fun)
1738            (type index num-args))
1739   (let ((fun (if (listp fun) fun (list fun))))
1740     (let ((inside (lvar-uses lvar)))
1741       (unless (combination-p inside)
1742         (give-up-ir1-transform))
1743       (let ((inside-fun (combination-fun inside)))
1744         (unless (member (lvar-fun-name inside-fun) fun)
1745           (give-up-ir1-transform))
1746         (let ((inside-args (combination-args inside)))
1747           (unless (= (length inside-args) num-args)
1748             (give-up-ir1-transform))
1749           (values (lvar-fun-name inside-fun) inside-args))))))
1750
1751 (defun flush-combination (combination)
1752   (declare (type combination combination))
1753   (flush-dest (combination-fun combination))
1754   (dolist (arg (combination-args combination))
1755     (flush-dest arg))
1756   (unlink-node combination)
1757   (values))
1758
1759 \f
1760 ;;;; leaf hackery
1761
1762 ;;; Change the LEAF that a REF refers to.
1763 (defun change-ref-leaf (ref leaf)
1764   (declare (type ref ref) (type leaf leaf))
1765   (unless (eq (ref-leaf ref) leaf)
1766     (push ref (leaf-refs leaf))
1767     (delete-ref ref)
1768     (setf (ref-leaf ref) leaf)
1769     (setf (leaf-ever-used leaf) t)
1770     (let* ((ltype (leaf-type leaf))
1771            (vltype (make-single-value-type ltype)))
1772       (if (let* ((lvar (node-lvar ref))
1773                  (dest (and lvar (lvar-dest lvar))))
1774             (and (basic-combination-p dest)
1775                  (eq lvar (basic-combination-fun dest))
1776                  (csubtypep ltype (specifier-type 'function))))
1777           (setf (node-derived-type ref) vltype)
1778           (derive-node-type ref vltype)))
1779     (reoptimize-lvar (node-lvar ref)))
1780   (values))
1781
1782 ;;; Change all REFS for OLD-LEAF to NEW-LEAF.
1783 (defun substitute-leaf (new-leaf old-leaf)
1784   (declare (type leaf new-leaf old-leaf))
1785   (dolist (ref (leaf-refs old-leaf))
1786     (change-ref-leaf ref new-leaf))
1787   (values))
1788
1789 ;;; like SUBSITUTE-LEAF, only there is a predicate on the REF to tell
1790 ;;; whether to substitute
1791 (defun substitute-leaf-if (test new-leaf old-leaf)
1792   (declare (type leaf new-leaf old-leaf) (type function test))
1793   (dolist (ref (leaf-refs old-leaf))
1794     (when (funcall test ref)
1795       (change-ref-leaf ref new-leaf)))
1796   (values))
1797
1798 ;;; Return a LEAF which represents the specified constant object. If
1799 ;;; the object is not in *CONSTANTS*, then we create a new constant
1800 ;;; LEAF and enter it. If we are producing a fasl file, make sure that
1801 ;;; MAKE-LOAD-FORM gets used on any parts of the constant that it
1802 ;;; needs to be.
1803 ;;;
1804 ;;; We are allowed to coalesce things like EQUAL strings and bit-vectors
1805 ;;; when file-compiling, but not when using COMPILE.
1806 (defun find-constant (object &optional (name nil namep))
1807   (let ((faslp (producing-fasl-file)))
1808     (labels ((make-it ()
1809                (when faslp
1810                  (if namep
1811                      (maybe-emit-make-load-forms object name)
1812                      (maybe-emit-make-load-forms object)))
1813                (make-constant object))
1814              (core-coalesce-p (x)
1815                ;; True for things which retain their identity under EQUAL,
1816                ;; so we can safely share the same CONSTANT leaf between
1817                ;; multiple references.
1818                (or (typep x '(or symbol number character))
1819                    ;; Amusingly enough, we see CLAMBDAs --among other things--
1820                    ;; here, from compiling things like %ALLOCATE-CLOSUREs forms.
1821                    ;; No point in stuffing them in the hash-table.
1822                    (and (typep x 'instance)
1823                         (not (or (leaf-p x) (node-p x))))))
1824              (file-coalesce-p (x)
1825                ;; CLHS 3.2.4.2.2: We are also allowed to coalesce various
1826                ;; other things when file-compiling.
1827                (or (core-coalesce-p x)
1828                    (if (consp x)
1829                        (if (eq +code-coverage-unmarked+ (cdr x))
1830                            ;; These are already coalesced, and the CAR should
1831                            ;; always be OK, so no need to check.
1832                            t
1833                            (unless (maybe-cyclic-p x) ; safe for EQUAL?
1834                              (do ((y x (cdr y)))
1835                                  ((atom y) (file-coalesce-p y))
1836                                (unless (file-coalesce-p (car y))
1837                                  (return nil)))))
1838                        ;; We *could* coalesce base-strings as well,
1839                        ;; but we'd need a separate hash-table for
1840                        ;; that, since we are not allowed to coalesce
1841                        ;; base-strings with non-base-strings.
1842                        (typep x
1843                               '(or bit-vector
1844                                 ;; in the cross-compiler, we coalesce
1845                                 ;; all strings with the same contents,
1846                                 ;; because we will end up dumping them
1847                                 ;; as base-strings anyway.  In the
1848                                 ;; real compiler, we're not allowed to
1849                                 ;; coalesce regardless of string
1850                                 ;; specialized element type, so we
1851                                 ;; KLUDGE by coalescing only character
1852                                 ;; strings (the common case) and
1853                                 ;; punting on the other types.
1854                                 #+sb-xc-host
1855                                 string
1856                                 #-sb-xc-host
1857                                 (vector character))))))
1858              (coalescep (x)
1859                (if faslp (file-coalesce-p x) (core-coalesce-p x))))
1860       (if (and (boundp '*constants*) (coalescep object))
1861           (or (gethash object *constants*)
1862               (setf (gethash object *constants*)
1863                     (make-it)))
1864           (make-it)))))
1865 \f
1866 ;;; Return true if VAR would have to be closed over if environment
1867 ;;; analysis ran now (i.e. if there are any uses that have a different
1868 ;;; home lambda than VAR's home.)
1869 (defun closure-var-p (var)
1870   (declare (type lambda-var var))
1871   (let ((home (lambda-var-home var)))
1872     (cond ((eq (functional-kind home) :deleted)
1873            nil)
1874           (t (let ((home (lambda-home home)))
1875                (flet ((frob (l)
1876                         (find home l
1877                               :key #'node-home-lambda
1878                               :test #'neq)))
1879                  (or (frob (leaf-refs var))
1880                      (frob (basic-var-sets var)))))))))
1881
1882 ;;; If there is a non-local exit noted in ENTRY's environment that
1883 ;;; exits to CONT in that entry, then return it, otherwise return NIL.
1884 (defun find-nlx-info (exit)
1885   (declare (type exit exit))
1886   (let* ((entry (exit-entry exit))
1887          (cleanup (entry-cleanup entry))
1888         (block (first (block-succ (node-block exit)))))
1889     (dolist (nlx (physenv-nlx-info (node-physenv entry)) nil)
1890       (when (and (eq (nlx-info-block nlx) block)
1891                  (eq (nlx-info-cleanup nlx) cleanup))
1892         (return nlx)))))
1893
1894 (defun nlx-info-lvar (nlx)
1895   (declare (type nlx-info nlx))
1896   (node-lvar (block-last (nlx-info-target nlx))))
1897 \f
1898 ;;;; functional hackery
1899
1900 (declaim (ftype (sfunction (functional) clambda) main-entry))
1901 (defun main-entry (functional)
1902   (etypecase functional
1903     (clambda functional)
1904     (optional-dispatch
1905      (optional-dispatch-main-entry functional))))
1906
1907 ;;; RETURN true if FUNCTIONAL is a thing that can be treated like
1908 ;;; MV-BIND when it appears in an MV-CALL. All fixed arguments must be
1909 ;;; optional with null default and no SUPPLIED-P. There must be a
1910 ;;; &REST arg with no references.
1911 (declaim (ftype (sfunction (functional) boolean) looks-like-an-mv-bind))
1912 (defun looks-like-an-mv-bind (functional)
1913   (and (optional-dispatch-p functional)
1914        (do ((arg (optional-dispatch-arglist functional) (cdr arg)))
1915            ((null arg) nil)
1916          (let ((info (lambda-var-arg-info (car arg))))
1917            (unless info (return nil))
1918            (case (arg-info-kind info)
1919              (:optional
1920               (when (or (arg-info-supplied-p info) (arg-info-default info))
1921                 (return nil)))
1922              (:rest
1923               (return (and (null (cdr arg)) (null (leaf-refs (car arg))))))
1924              (t
1925               (return nil)))))))
1926
1927 ;;; Return true if function is an external entry point. This is true
1928 ;;; of normal XEPs (:EXTERNAL kind) and also of top level lambdas
1929 ;;; (:TOPLEVEL kind.)
1930 (defun xep-p (fun)
1931   (declare (type functional fun))
1932   (not (null (member (functional-kind fun) '(:external :toplevel)))))
1933
1934 ;;; If LVAR's only use is a non-notinline global function reference,
1935 ;;; then return the referenced symbol, otherwise NIL. If NOTINLINE-OK
1936 ;;; is true, then we don't care if the leaf is NOTINLINE.
1937 (defun lvar-fun-name (lvar &optional notinline-ok)
1938   (declare (type lvar lvar))
1939   (let ((use (lvar-uses lvar)))
1940     (if (ref-p use)
1941         (let ((leaf (ref-leaf use)))
1942           (if (and (global-var-p leaf)
1943                    (eq (global-var-kind leaf) :global-function)
1944                    (or (not (defined-fun-p leaf))
1945                        (not (eq (defined-fun-inlinep leaf) :notinline))
1946                        notinline-ok))
1947               (leaf-source-name leaf)
1948               nil))
1949         nil)))
1950
1951 (defun lvar-fun-debug-name (lvar)
1952   (declare (type lvar lvar))
1953   (let ((uses (lvar-uses lvar)))
1954     (flet ((name1 (use)
1955              (leaf-debug-name (ref-leaf use))))
1956       (if (ref-p uses)
1957         (name1 uses)
1958         (mapcar #'name1 uses)))))
1959
1960 ;;; Return the source name of a combination. (This is an idiom
1961 ;;; which was used in CMU CL. I gather it always works. -- WHN)
1962 (defun combination-fun-source-name (combination &optional (errorp t))
1963   (let ((leaf (ref-leaf (lvar-uses (combination-fun combination)))))
1964     (when (or errorp (leaf-has-source-name-p leaf))
1965       (leaf-source-name leaf))))
1966
1967 ;;; Return the COMBINATION node that is the call to the LET FUN.
1968 (defun let-combination (fun)
1969   (declare (type clambda fun))
1970   (aver (functional-letlike-p fun))
1971   (lvar-dest (node-lvar (first (leaf-refs fun)))))
1972
1973 ;;; Return the initial value lvar for a LET variable, or NIL if there
1974 ;;; is none.
1975 (defun let-var-initial-value (var)
1976   (declare (type lambda-var var))
1977   (let ((fun (lambda-var-home var)))
1978     (elt (combination-args (let-combination fun))
1979          (position-or-lose var (lambda-vars fun)))))
1980
1981 ;;; Return the LAMBDA that is called by the local CALL.
1982 (defun combination-lambda (call)
1983   (declare (type basic-combination call))
1984   (aver (eq (basic-combination-kind call) :local))
1985   (ref-leaf (lvar-uses (basic-combination-fun call))))
1986
1987 (defvar *inline-expansion-limit* 200
1988   #!+sb-doc
1989   "an upper limit on the number of inline function calls that will be expanded
1990    in any given code object (single function or block compilation)")
1991
1992 ;;; Check whether NODE's component has exceeded its inline expansion
1993 ;;; limit, and warn if so, returning NIL.
1994 (defun inline-expansion-ok (node)
1995   (let ((expanded (incf (component-inline-expansions
1996                          (block-component
1997                           (node-block node))))))
1998     (cond ((> expanded *inline-expansion-limit*) nil)
1999           ((= expanded *inline-expansion-limit*)
2000            ;; FIXME: If the objective is to stop the recursive
2001            ;; expansion of inline functions, wouldn't it be more
2002            ;; correct to look back through surrounding expansions
2003            ;; (which are, I think, stored in the *CURRENT-PATH*, and
2004            ;; possibly stored elsewhere too) and suppress expansion
2005            ;; and print this warning when the function being proposed
2006            ;; for inline expansion is found there? (I don't like the
2007            ;; arbitrary numerical limit in principle, and I think
2008            ;; it'll be a nuisance in practice if we ever want the
2009            ;; compiler to be able to use WITH-COMPILATION-UNIT on
2010            ;; arbitrarily huge blocks of code. -- WHN)
2011            (let ((*compiler-error-context* node))
2012              (compiler-notify "*INLINE-EXPANSION-LIMIT* (~W) was exceeded, ~
2013                                probably trying to~%  ~
2014                                inline a recursive function."
2015                               *inline-expansion-limit*))
2016            nil)
2017           (t t))))
2018
2019 ;;; Make sure that FUNCTIONAL is not let-converted or deleted.
2020 (defun assure-functional-live-p (functional)
2021   (declare (type functional functional))
2022   (when (and (or
2023               ;; looks LET-converted
2024               (functional-somewhat-letlike-p functional)
2025               ;; It's possible for a LET-converted function to end up
2026               ;; deleted later. In that case, for the purposes of this
2027               ;; analysis, it is LET-converted: LET-converted functionals
2028               ;; are too badly trashed to expand them inline, and deleted
2029               ;; LET-converted functionals are even worse.
2030               (memq (functional-kind functional) '(:deleted :zombie))))
2031     (throw 'locall-already-let-converted functional)))
2032
2033 (defun call-full-like-p (call)
2034   (declare (type combination call))
2035   (let ((kind (basic-combination-kind call)))
2036     (or (eq kind :full)
2037         (and (eq kind :known)
2038              (let ((info (basic-combination-fun-info call)))
2039                (and
2040                 (not (fun-info-ir2-convert info))
2041                 (dolist (template (fun-info-templates info) t)
2042                   (when (eq (template-ltn-policy template) :fast-safe)
2043                     (multiple-value-bind (val win)
2044                        (valid-fun-use call (template-type template))
2045                       (when (or val (not win)) (return nil)))))))))))
2046 \f
2047 ;;;; careful call
2048
2049 ;;; Apply a function to some arguments, returning a list of the values
2050 ;;; resulting of the evaluation. If an error is signalled during the
2051 ;;; application, then we produce a warning message using WARN-FUN and
2052 ;;; return NIL as our second value to indicate this. NODE is used as
2053 ;;; the error context for any error message, and CONTEXT is a string
2054 ;;; that is spliced into the warning.
2055 (declaim (ftype (sfunction ((or symbol function) list node function string)
2056                           (values list boolean))
2057                 careful-call))
2058 (defun careful-call (function args node warn-fun context)
2059   (values
2060    (multiple-value-list
2061     (handler-case (apply function args)
2062       (error (condition)
2063         (let ((*compiler-error-context* node))
2064           (funcall warn-fun "Lisp error during ~A:~%~A" context condition)
2065           (return-from careful-call (values nil nil))))))
2066    t))
2067
2068 ;;; Variations of SPECIFIER-TYPE for parsing possibly wrong
2069 ;;; specifiers.
2070 (macrolet
2071     ((deffrob (basic careful compiler transform)
2072        `(progn
2073           (defun ,careful (specifier)
2074             (handler-case (,basic specifier)
2075               (sb!kernel::arg-count-error (condition)
2076                 (values nil (list (format nil "~A" condition))))
2077               (simple-error (condition)
2078                 (values nil (list* (simple-condition-format-control condition)
2079                                    (simple-condition-format-arguments condition))))))
2080           (defun ,compiler (specifier)
2081             (multiple-value-bind (type error-args) (,careful specifier)
2082               (or type
2083                   (apply #'compiler-error error-args))))
2084           (defun ,transform (specifier)
2085             (multiple-value-bind (type error-args) (,careful specifier)
2086               (or type
2087                   (apply #'give-up-ir1-transform
2088                          error-args)))))))
2089   (deffrob specifier-type careful-specifier-type compiler-specifier-type ir1-transform-specifier-type)
2090   (deffrob values-specifier-type careful-values-specifier-type compiler-values-specifier-type ir1-transform-values-specifier-type))
2091
2092 \f
2093 ;;;; utilities used at run-time for parsing &KEY args in IR1
2094
2095 ;;; This function is used by the result of PARSE-DEFTRANSFORM to find
2096 ;;; the lvar for the value of the &KEY argument KEY in the list of
2097 ;;; lvars ARGS. It returns the lvar if the keyword is present, or NIL
2098 ;;; otherwise. The legality and constantness of the keywords should
2099 ;;; already have been checked.
2100 (declaim (ftype (sfunction (list keyword) (or lvar null))
2101                 find-keyword-lvar))
2102 (defun find-keyword-lvar (args key)
2103   (do ((arg args (cddr arg)))
2104       ((null arg) nil)
2105     (when (eq (lvar-value (first arg)) key)
2106       (return (second arg)))))
2107
2108 ;;; This function is used by the result of PARSE-DEFTRANSFORM to
2109 ;;; verify that alternating lvars in ARGS are constant and that there
2110 ;;; is an even number of args.
2111 (declaim (ftype (sfunction (list) boolean) check-key-args-constant))
2112 (defun check-key-args-constant (args)
2113   (do ((arg args (cddr arg)))
2114       ((null arg) t)
2115     (unless (and (rest arg)
2116                  (constant-lvar-p (first arg)))
2117       (return nil))))
2118
2119 ;;; This function is used by the result of PARSE-DEFTRANSFORM to
2120 ;;; verify that the list of lvars ARGS is a well-formed &KEY arglist
2121 ;;; and that only keywords present in the list KEYS are supplied.
2122 (declaim (ftype (sfunction (list list) boolean) check-transform-keys))
2123 (defun check-transform-keys (args keys)
2124   (and (check-key-args-constant args)
2125        (do ((arg args (cddr arg)))
2126            ((null arg) t)
2127          (unless (member (lvar-value (first arg)) keys)
2128            (return nil)))))
2129 \f
2130 ;;;; miscellaneous
2131
2132 ;;; Called by the expansion of the EVENT macro.
2133 (declaim (ftype (sfunction (event-info (or node null)) *) %event))
2134 (defun %event (info node)
2135   (incf (event-info-count info))
2136   (when (and (>= (event-info-level info) *event-note-threshold*)
2137              (policy (or node *lexenv*)
2138                      (= inhibit-warnings 0)))
2139     (let ((*compiler-error-context* node))
2140       (compiler-notify (event-info-description info))))
2141
2142   (let ((action (event-info-action info)))
2143     (when action (funcall action node))))
2144
2145 ;;;
2146 (defun make-cast (value type policy)
2147   (declare (type lvar value)
2148            (type ctype type)
2149            (type policy policy))
2150   (%make-cast :asserted-type type
2151               :type-to-check (maybe-weaken-check type policy)
2152               :value value
2153               :derived-type (coerce-to-values type)))
2154
2155 (defun cast-type-check (cast)
2156   (declare (type cast cast))
2157   (when (cast-reoptimize cast)
2158     (ir1-optimize-cast cast t))
2159   (cast-%type-check cast))
2160
2161 (defun note-single-valuified-lvar (lvar)
2162   (declare (type (or lvar null) lvar))
2163   (when lvar
2164     (let ((use (lvar-uses lvar)))
2165       (cond ((ref-p use)
2166              (let ((leaf (ref-leaf use)))
2167                (when (and (lambda-var-p leaf)
2168                           (null (rest (leaf-refs leaf))))
2169                  (reoptimize-lambda-var leaf))))
2170             ((or (listp use) (combination-p use))
2171              (do-uses (node lvar)
2172                (setf (node-reoptimize node) t)
2173                (setf (block-reoptimize (node-block node)) t)
2174                (reoptimize-component (node-component node) :maybe)))))))
2175
2176 ;;; Return true if LVAR's only use is a non-NOTINLINE reference to a
2177 ;;; global function with one of the specified NAMES.
2178 (defun lvar-fun-is (lvar names)
2179   (declare (type lvar lvar) (list names))
2180   (let ((use (lvar-uses lvar)))
2181     (and (ref-p use)
2182          (let ((leaf (ref-leaf use)))
2183            (and (global-var-p leaf)
2184                 (eq (global-var-kind leaf) :global-function)
2185                 (not (null (member (leaf-source-name leaf) names
2186                                    :test #'equal))))))))
2187
2188 (defun lvar-matches (lvar &key fun-names arg-count)
2189   (let ((use (lvar-use lvar)))
2190     (and (combination-p use)
2191          (or (not fun-names)
2192              (member (combination-fun-source-name use)
2193                      fun-names :test #'eq))
2194          (or (not arg-count)
2195              (= arg-count (length (combination-args use)))))))