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