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