1 ;;;; structures for the first intermediate representation in the
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.
15 ;;; The front-end data structure (IR1) is composed of nodes,
16 ;;; representing actual evaluations. Linear sequences of nodes in
17 ;;; control-flow order are combined into blocks (but see
18 ;;; JOIN-SUCCESSOR-IF-POSSIBLE for precise conditions); control
19 ;;; transfers inside a block are represented with CTRANs and between
20 ;;; blocks -- with BLOCK-SUCC/BLOCK-PRED lists; data transfers are
21 ;;; represented with LVARs.
23 ;;; "Lead-in" Control TRANsfer [to some node]
25 (:make-load-form-fun ignore-it
)
26 (:constructor make-ctran
))
27 ;; an indication of the way that this continuation is currently used
30 ;; A continuation for which all control-related slots have the
31 ;; default values. A continuation is unused during IR1 conversion
32 ;; until it is assigned a block, and may be also be temporarily
33 ;; unused during later manipulations of IR1. In a consistent
34 ;; state there should never be any mention of :UNUSED
35 ;; continuations. NEXT can have a non-null value if the next node
36 ;; has already been determined.
39 ;; The continuation that is the START of BLOCK.
42 ;; A continuation that is the NEXT of some node in BLOCK.
43 (kind :unused
:type
(member :unused
:inside-block
:block-start
))
44 ;; A NODE which is to be evaluated next. Null only temporary.
45 (next nil
:type
(or node null
))
46 ;; the node where this CTRAN is used, if unique. This is always null
47 ;; in :UNUSED and :BLOCK-START CTRANs, and is never null in
48 ;; :INSIDE-BLOCK continuations.
49 (use nil
:type
(or node null
))
50 ;; the basic block this continuation is in. This is null only in
51 ;; :UNUSED continuations.
52 (block nil
:type
(or cblock null
)))
54 (def!method print-object
((x ctran
) stream
)
55 (print-unreadable-object (x stream
:type t
:identity t
)
56 (format stream
"~D" (cont-num x
))))
58 ;;; Linear VARiable. Multiple-value (possibly of unknown number)
61 (:make-load-form-fun ignore-it
)
62 (:constructor make-lvar
(&optional dest
)))
63 ;; The node which receives this value. NIL only temporarily.
64 (dest nil
:type
(or node null
))
65 ;; cached type of this lvar's value. If NIL, then this must be
66 ;; recomputed: see LVAR-DERIVED-TYPE.
67 (%derived-type nil
:type
(or ctype null
))
68 ;; the node (if unique) or a list of nodes where this lvar is used.
69 (uses nil
:type
(or node list
))
70 ;; set to true when something about this lvar's value has
71 ;; changed. See REOPTIMIZE-LVAR. This provides a way for IR1
72 ;; optimize to determine which operands to a node have changed. If
73 ;; the optimizer for this node type doesn't care, it can elect not
74 ;; to clear this flag.
75 (reoptimize t
:type boolean
)
76 ;; Cached type which is checked by DEST. If NIL, then this must be
77 ;; recomputed: see LVAR-EXTERNALLY-CHECKABLE-TYPE.
78 (%externally-checkable-type nil
:type
(or null ctype
))
79 ;; if the LVAR value is DYNAMIC-EXTENT, CLEANUP protecting it.
80 (dynamic-extent nil
:type
(or null cleanup
))
81 ;; something or other that the back end annotates this lvar with
84 (def!method print-object
((x lvar
) stream
)
85 (print-unreadable-object (x stream
:type t
:identity t
)
86 (format stream
"~D" (cont-num x
))))
88 (def!struct
(node (:constructor nil
)
90 ;; unique ID for debugging
91 #!+sb-show
(id (new-object-id) :read-only t
)
92 ;; True if this node needs to be optimized. This is set to true
93 ;; whenever something changes about the value of an lvar whose DEST
95 (reoptimize t
:type boolean
)
96 ;; the ctran indicating what we do controlwise after evaluating this
97 ;; node. This is null if the node is the last in its block.
98 (next nil
:type
(or ctran null
))
99 ;; the ctran that this node is the NEXT of. This is null during IR1
100 ;; conversion when we haven't linked the node in yet or in nodes
101 ;; that have been deleted from the IR1 by UNLINK-NODE.
102 (prev nil
:type
(or ctran null
))
103 ;; the lexical environment this node was converted in
104 (lexenv *lexenv
* :type lexenv
)
105 ;; a representation of the source code responsible for generating
108 ;; For a form introduced by compilation (does not appear in the
109 ;; original source), the path begins with a list of all the
110 ;; enclosing introduced forms. This list is from the inside out,
111 ;; with the form immediately responsible for this node at the head
114 ;; Following the introduced forms is a representation of the
115 ;; location of the enclosing original source form. This transition
116 ;; is indicated by the magic ORIGINAL-SOURCE-START marker. The first
117 ;; element of the original source is the "form number", which is the
118 ;; ordinal number of this form in a depth-first, left-to-right walk
119 ;; of the truly-top-level form in which this appears.
121 ;; Following is a list of integers describing the path taken through
122 ;; the source to get to this point:
123 ;; (K L M ...) => (NTH K (NTH L (NTH M ...)))
125 ;; The last element in the list is the top level form number, which
126 ;; is the ordinal number (in this call to the compiler) of the truly
127 ;; top level form containing the original source.
128 (source-path *current-path
* :type list
)
129 ;; If this node is in a tail-recursive position, then this is set to
130 ;; T. At the end of IR1 (in physical environment analysis) this is
131 ;; computed for all nodes (after cleanup code has been emitted).
132 ;; Before then, a non-null value indicates that IR1 optimization has
133 ;; converted a tail local call to a direct transfer.
135 ;; If the back-end breaks tail-recursion for some reason, then it
136 ;; can null out this slot.
137 (tail-p nil
:type boolean
))
139 (def!struct
(valued-node (:conc-name node-
)
143 ;; the bottom-up derived type for this node.
144 (derived-type *wild-type
* :type ctype
)
145 ;; Lvar, receiving the values, produced by this node. May be NIL if
146 ;; the value is unused.
147 (lvar nil
:type
(or lvar null
)))
149 ;;; Flags that are used to indicate various things about a block, such
150 ;;; as what optimizations need to be done on it:
151 ;;; -- REOPTIMIZE is set when something interesting happens the uses of a
152 ;;; lvar whose DEST is in this block. This indicates that the
153 ;;; value-driven (forward) IR1 optimizations should be done on this block.
154 ;;; -- FLUSH-P is set when code in this block becomes potentially flushable,
155 ;;; usually due to an lvar's DEST becoming null.
156 ;;; -- TYPE-CHECK is true when the type check phase should be run on this
157 ;;; block. IR1 optimize can introduce new blocks after type check has
158 ;;; already run. We need to check these blocks, but there is no point in
159 ;;; checking blocks we have already checked.
160 ;;; -- DELETE-P is true when this block is used to indicate that this block
161 ;;; has been determined to be unreachable and should be deleted. IR1
162 ;;; phases should not attempt to examine or modify blocks with DELETE-P
163 ;;; set, since they may:
164 ;;; - be in the process of being deleted, or
165 ;;; - have no successors.
166 ;;; -- TYPE-ASSERTED, TEST-MODIFIED
167 ;;; These flags are used to indicate that something in this block
168 ;;; might be of interest to constraint propagation. TYPE-ASSERTED
169 ;;; is set when an lvar type assertion is strengthened.
170 ;;; TEST-MODIFIED is set whenever the test for the ending IF has
171 ;;; changed (may be true when there is no IF.)
172 (!def-boolean-attribute block
173 reoptimize flush-p type-check delete-p type-asserted test-modified
)
175 ;;; FIXME: Tweak so that definitions of e.g. BLOCK-DELETE-P is
176 ;;; findable by grep for 'def.*block-delete-p'.
177 (macrolet ((frob (slot)
178 `(defmacro ,(symbolicate "BLOCK-" slot
) (block)
179 `(block-attributep (block-flags ,block
) ,',slot
))))
185 (frob test-modified
))
187 ;;; The CBLOCK structure represents a basic block. We include
188 ;;; SSET-ELEMENT so that we can have sets of blocks. Initially the
189 ;;; SSET-ELEMENT-NUMBER is null, DFO analysis numbers in reverse DFO.
190 ;;; During IR2 conversion, IR1 blocks are re-numbered in forward emit
191 ;;; order. This latter numbering also forms the basis of the block
192 ;;; numbering in the debug-info (though that is relative to the start
193 ;;; of the function.)
194 (def!struct
(cblock (:include sset-element
)
195 (:constructor make-block
(start))
196 (:constructor make-block-key
)
198 (:predicate block-p
))
199 ;; a list of all the blocks that are predecessors/successors of this
200 ;; block. In well-formed IR1, most blocks will have one successor.
201 ;; The only exceptions are:
202 ;; 1. component head blocks (any number)
203 ;; 2. blocks ending in an IF (1 or 2)
204 ;; 3. blocks with DELETE-P set (zero)
205 (pred nil
:type list
)
206 (succ nil
:type list
)
207 ;; the ctran which heads this block (a :BLOCK-START), or NIL when we
208 ;; haven't made the start ctran yet (and in the dummy component head
210 (start nil
:type
(or ctran null
))
211 ;; the last node in this block. This is NIL when we are in the
212 ;; process of building a block (and in the dummy component head and
214 (last nil
:type
(or node null
))
215 ;; the forward and backward links in the depth-first ordering of the
216 ;; blocks. These slots are NIL at beginning/end.
217 (next nil
:type
(or null cblock
))
218 (prev nil
:type
(or null cblock
))
219 ;; This block's attributes: see above.
220 (flags (block-attributes reoptimize flush-p type-check type-asserted
223 ;; in constraint propagation: list of LAMBDA-VARs killed in this block
224 ;; in copy propagation: list of killed TNs
226 ;; other sets used in constraint propagation and/or copy propagation
230 ;; Set of all blocks that dominate this block. NIL is interpreted
231 ;; as "all blocks in component".
232 (dominators nil
:type
(or null sset
))
233 ;; the LOOP that this block belongs to
234 (loop nil
:type
(or null cloop
))
235 ;; next block in the loop.
236 (loop-next nil
:type
(or null cblock
))
237 ;; the component this block is in, or NIL temporarily during IR1
238 ;; conversion and in deleted blocks
240 (aver-live-component *current-component
*)
242 :type
(or component null
))
243 ;; a flag used by various graph-walking code to determine whether
244 ;; this block has been processed already or what. We make this
245 ;; initially NIL so that FIND-INITIAL-DFO doesn't have to scan the
246 ;; entire initial component just to clear the flags.
248 ;; some kind of info used by the back end
250 ;; constraints that hold in this block and its successors by merit
251 ;; of being tested by its IF predecessors.
252 (test-constraint nil
:type
(or sset null
)))
253 (def!method print-object
((cblock cblock
) stream
)
254 (print-unreadable-object (cblock stream
:type t
:identity t
)
255 (format stream
"~W :START c~W"
256 (block-number cblock
)
257 (cont-num (block-start cblock
)))))
259 ;;; The BLOCK-ANNOTATION class is inherited (via :INCLUDE) by
260 ;;; different BLOCK-INFO annotation structures so that code
261 ;;; (specifically control analysis) can be shared.
262 (def!struct
(block-annotation (:constructor nil
)
264 ;; The IR1 block that this block is in the INFO for.
265 (block (missing-arg) :type cblock
)
266 ;; the next and previous block in emission order (not DFO). This
267 ;; determines which block we drop though to, and is also used to
268 ;; chain together overflow blocks that result from splitting of IR2
269 ;; blocks in lifetime analysis.
270 (next nil
:type
(or block-annotation null
))
271 (prev nil
:type
(or block-annotation null
)))
273 ;;; A COMPONENT structure provides a handle on a connected piece of
274 ;;; the flow graph. Most of the passes in the compiler operate on
275 ;;; COMPONENTs rather than on the entire flow graph.
277 ;;; According to the CMU CL internals/front.tex, the reason for
278 ;;; separating compilation into COMPONENTs is
279 ;;; to increase the efficiency of large block compilations. In
280 ;;; addition to improving locality of reference and reducing the
281 ;;; size of flow analysis problems, this allows back-end data
282 ;;; structures to be reclaimed after the compilation of each
284 (def!struct
(component (:copier nil
)
290 (outer-loop (make-loop :kind
:outer
:head head
)))))
291 ;; unique ID for debugging
292 #!+sb-show
(id (new-object-id) :read-only t
)
293 ;; the kind of component
295 ;; (The terminology here is left over from before
296 ;; sbcl-0.pre7.34.flaky5.2, when there was no such thing as
297 ;; FUNCTIONAL-HAS-EXTERNAL-REFERENCES-P, so that Python was
298 ;; incapable of building standalone :EXTERNAL functions, but instead
299 ;; had to implement things like #'CL:COMPILE as FUNCALL of a little
300 ;; toplevel stub whose sole purpose was to return an :EXTERNAL
303 ;; The possibilities are:
305 ;; an ordinary component, containing non-top-level code
307 ;; a component containing only load-time code
309 ;; In the old system, before FUNCTIONAL-HAS-EXTERNAL-REFERENCES-P
310 ;; was defined, this was necessarily a component containing both
311 ;; top level and run-time code. Now this state is also used for
312 ;; a component with HAS-EXTERNAL-REFERENCES-P functionals in it.
314 ;; the result of initial IR1 conversion, on which component
315 ;; analysis has not been done
317 ;; debris left over from component analysis
319 ;; See also COMPONENT-TOPLEVELISH-P.
320 (kind nil
:type
(member nil
:toplevel
:complex-toplevel
:initial
:deleted
))
321 ;; the blocks that are the dummy head and tail of the DFO
323 ;; Entry/exit points have these blocks as their
324 ;; predecessors/successors. The start and return from each
325 ;; non-deleted function is linked to the component head and
326 ;; tail. Until physical environment analysis links NLX entry stubs
327 ;; to the component head, every successor of the head is a function
328 ;; start (i.e. begins with a BIND node.)
329 (head (missing-arg) :type cblock
)
330 (tail (missing-arg) :type cblock
)
331 ;; New blocks are inserted before this.
332 (last-block (missing-arg) :type cblock
)
333 ;; This becomes a list of the CLAMBDA structures for all functions
334 ;; in this component. OPTIONAL-DISPATCHes are represented only by
335 ;; their XEP and other associated lambdas. This doesn't contain any
336 ;; deleted or LET lambdas.
338 ;; Note that logical associations between CLAMBDAs and COMPONENTs
339 ;; seem to exist for a while before this is initialized. See e.g.
340 ;; the NEW-FUNCTIONALS slot. In particular, I got burned by writing
341 ;; some code to use this value to decide which components need
342 ;; LOCALL-ANALYZE-COMPONENT, when it turns out that
343 ;; LOCALL-ANALYZE-COMPONENT had a role in initializing this value
344 ;; (and DFO stuff does too, maybe). Also, even after it's
345 ;; initialized, it might change as CLAMBDAs are deleted or merged.
347 (lambdas () :type list
)
348 ;; a list of FUNCTIONALs for functions that are newly converted, and
349 ;; haven't been local-call analyzed yet. Initially functions are not
350 ;; in the LAMBDAS list. Local call analysis moves them there
351 ;; (possibly as LETs, or implicitly as XEPs if an OPTIONAL-DISPATCH.)
352 ;; Between runs of local call analysis there may be some debris of
353 ;; converted or even deleted functions in this list.
354 (new-functionals () :type list
)
355 ;; If this is :MAYBE, then there is stuff in this component that
356 ;; could benefit from further IR1 optimization. T means that
357 ;; reoptimization is necessary.
358 (reoptimize t
:type
(member nil
:maybe t
))
359 ;; If this is true, then the control flow in this component was
360 ;; messed up by IR1 optimizations, so the DFO should be recomputed.
361 (reanalyze nil
:type boolean
)
362 ;; some sort of name for the code in this component
363 (name "<unknown>" :type t
)
364 ;; When I am a child, this is :NO-IR2-YET.
365 ;; In my adulthood, IR2 stores notes to itself here.
366 ;; After I have left the great wheel and am staring into the GC, this
367 ;; is set to :DEAD to indicate that it's a gruesome error to operate
368 ;; on me (e.g. by using me as *CURRENT-COMPONENT*, or by pushing
369 ;; LAMBDAs onto my NEW-FUNCTIONALS, as in sbcl-0.pre7.115).
370 (info :no-ir2-yet
:type
(or ir2-component
(member :no-ir2-yet
:dead
)))
371 ;; the SOURCE-INFO structure describing where this component was
373 (source-info *source-info
* :type source-info
)
374 ;; count of the number of inline expansions we have done while
375 ;; compiling this component, to detect infinite or exponential
377 (inline-expansions 0 :type index
)
378 ;; a map from combination nodes to things describing how an
379 ;; optimization of the node failed. The description is an alist
380 ;; (TRANSFORM . ARGS), where TRANSFORM is the structure describing
381 ;; the transform that failed, and ARGS is either a list of format
382 ;; arguments for the note, or the FUN-TYPE that would have
383 ;; enabled the transformation but failed to match.
384 (failed-optimizations (make-hash-table :test
'eq
) :type hash-table
)
385 ;; This is similar to NEW-FUNCTIONALS, but is used when a function
386 ;; has already been analyzed, but new references have been added by
387 ;; inline expansion. Unlike NEW-FUNCTIONALS, this is not disjoint
388 ;; from COMPONENT-LAMBDAS.
389 (reanalyze-functionals nil
:type list
)
390 (delete-blocks nil
:type list
)
391 (nlx-info-generated-p nil
:type boolean
)
392 ;; this is filled by physical environment analysis
393 (dx-lvars nil
:type list
)
394 ;; The default LOOP in the component.
395 (outer-loop (missing-arg) :type cloop
))
396 (defprinter (component :identity t
)
399 (reanalyze :test reanalyze
))
401 ;;; Check that COMPONENT is suitable for roles which involve adding
402 ;;; new code. (gotta love imperative programming with lotso in-place
404 (defun aver-live-component (component)
405 ;; FIXME: As of sbcl-0.pre7.115, we're asserting that
406 ;; COMPILE-COMPONENT hasn't happened yet. Might it be even better
407 ;; (certainly stricter, possibly also correct...) to assert that
408 ;; IR1-FINALIZE hasn't happened yet?
409 (aver (not (eql (component-info component
) :dead
))))
411 ;;; Before sbcl-0.7.0, there were :TOPLEVEL things which were magical
412 ;;; in multiple ways. That's since been refactored into the orthogonal
413 ;;; properties "optimized for locall with no arguments" and "externally
414 ;;; visible/referenced (so don't delete it)". The code <0.7.0 did a lot
415 ;;; of tests a la (EQ KIND :TOP_LEVEL) in the "don't delete it?" sense;
416 ;;; this function is a sort of literal translation of those tests into
419 ;;; FIXME: After things settle down, bare :TOPLEVEL might go away, at
420 ;;; which time it might be possible to replace the COMPONENT-KIND
421 ;;; :TOPLEVEL mess with a flag COMPONENT-HAS-EXTERNAL-REFERENCES-P
422 ;;; along the lines of FUNCTIONAL-HAS-EXTERNAL-REFERENCES-P.
423 (defun lambda-toplevelish-p (clambda)
424 (or (eql (lambda-kind clambda
) :toplevel
)
425 (lambda-has-external-references-p clambda
)))
426 (defun component-toplevelish-p (component)
427 (member (component-kind component
)
428 '(:toplevel
:complex-toplevel
)))
430 ;;; A CLEANUP structure represents some dynamic binding action. Blocks
431 ;;; are annotated with the current CLEANUP so that dynamic bindings
432 ;;; can be removed when control is transferred out of the binding
433 ;;; environment. We arrange for changes in dynamic bindings to happen
434 ;;; at block boundaries, so that cleanup code may easily be inserted.
435 ;;; The "mess-up" action is explicitly represented by a funny function
436 ;;; call or ENTRY node.
438 ;;; We guarantee that CLEANUPs only need to be done at block
439 ;;; boundaries by requiring that the exit ctrans initially head their
440 ;;; blocks, and then by not merging blocks when there is a cleanup
442 (def!struct
(cleanup (:copier nil
))
443 ;; the kind of thing that has to be cleaned up
445 :type
(member :special-bind
:catch
:unwind-protect
446 :block
:tagbody
:dynamic-extent
))
447 ;; the node that messes things up. This is the last node in the
448 ;; non-messed-up environment. Null only temporarily. This could be
449 ;; deleted due to unreachability.
450 (mess-up nil
:type
(or node null
))
451 ;; For all kinds, except :DYNAMIC-EXTENT: a list of all the NLX-INFO
452 ;; structures whose NLX-INFO-CLEANUP is this cleanup. This is filled
453 ;; in by physical environment analysis.
455 ;; For :DYNAMIC-EXTENT: a list of all DX LVARs, preserved by this
456 ;; cleanup. This is filled when the cleanup is created (now by
457 ;; locall call analysis) and is rechecked by physical environment
458 ;; analysis. (For closures this is a list of the allocating node -
459 ;; during IR1, and a list of the argument LVAR of the allocator -
460 ;; after physical environment analysis.)
461 (info nil
:type list
))
462 (defprinter (cleanup :identity t
)
466 (defmacro cleanup-nlx-info
(cleanup)
467 `(cleanup-info ,cleanup
))
469 ;;; A PHYSENV represents the result of physical environment analysis.
471 ;;; As far as I can tell from reverse engineering, this IR1 structure
472 ;;; represents the physical environment (which is probably not the
473 ;;; standard Lispy term for this concept, but I dunno what is the
474 ;;; standard term): those things in the lexical environment which a
475 ;;; LAMBDA actually interacts with. Thus in
476 ;;; (DEFUN FROB-THINGS (THINGS)
477 ;;; (DOLIST (THING THINGS)
478 ;;; (BLOCK FROBBING-ONE-THING
479 ;;; (MAPCAR (LAMBDA (PATTERN)
480 ;;; (WHEN (FITS-P THING PATTERN)
481 ;;; (RETURN-FROM FROB-THINGS (LIST :FIT THING PATTERN))))
483 ;;; the variables THINGS, THING, and PATTERN and the block names
484 ;;; FROB-THINGS and FROBBING-ONE-THING are all in the inner LAMBDA's
485 ;;; lexical environment, but of those only THING, PATTERN, and
486 ;;; FROB-THINGS are in its physical environment. In IR1, we largely
487 ;;; just collect the names of these things; in IR2 an IR2-PHYSENV
488 ;;; structure is attached to INFO and used to keep track of
489 ;;; associations between these names and less-abstract things (like
490 ;;; TNs, or eventually stack slots and registers). -- WHN 2001-09-29
491 (def!struct
(physenv (:copier nil
))
492 ;; the function that allocates this physical environment
493 (lambda (missing-arg) :type clambda
:read-only t
)
494 ;; This ultimately converges to a list of all the LAMBDA-VARs and
495 ;; NLX-INFOs needed from enclosing environments by code in this
496 ;; physical environment. In the meantime, it may be
497 ;; * NIL at object creation time
498 ;; * a superset of the correct result, generated somewhat later
499 ;; * smaller and smaller sets converging to the correct result as
500 ;; we notice and delete unused elements in the superset
501 (closure nil
:type list
)
502 ;; a list of NLX-INFO structures describing all the non-local exits
503 ;; into this physical environment
504 (nlx-info nil
:type list
)
505 ;; some kind of info used by the back end
507 (defprinter (physenv :identity t
)
509 (closure :test closure
)
510 (nlx-info :test nlx-info
))
512 ;;; An TAIL-SET structure is used to accumulate information about
513 ;;; tail-recursive local calls. The "tail set" is effectively the
514 ;;; transitive closure of the "is called tail-recursively by"
517 ;;; All functions in the same tail set share the same TAIL-SET
518 ;;; structure. Initially each function has its own TAIL-SET, but when
519 ;;; IR1-OPTIMIZE-RETURN notices a tail local call, it joins the tail
520 ;;; sets of the called function and the calling function.
522 ;;; The tail set is somewhat approximate, because it is too early to
523 ;;; be sure which calls will be tail-recursive. Any call that *might*
524 ;;; end up tail-recursive causes TAIL-SET merging.
525 (def!struct
(tail-set)
526 ;; a list of all the LAMBDAs in this tail set
527 (funs nil
:type list
)
528 ;; our current best guess of the type returned by these functions.
529 ;; This is the union across all the functions of the return node's
530 ;; RESULT-TYPE, excluding local calls.
531 (type *wild-type
* :type ctype
)
532 ;; some info used by the back end
534 (defprinter (tail-set :identity t
)
539 ;;; An NLX-INFO structure is used to collect various information about
540 ;;; non-local exits. This is effectively an annotation on the
541 ;;; continuation, although it is accessed by searching in the
542 ;;; PHYSENV-NLX-INFO.
543 (def!struct
(nlx-info
544 (:constructor make-nlx-info
(cleanup
547 (block (first (block-succ
548 (node-block exit
))))))
549 (:make-load-form-fun ignore-it
))
550 ;; the cleanup associated with this exit. In a catch or
551 ;; unwind-protect, this is the :CATCH or :UNWIND-PROTECT cleanup,
552 ;; and not the cleanup for the escape block. The CLEANUP-KIND of
553 ;; this thus provides a good indication of what kind of exit is
555 (cleanup (missing-arg) :type cleanup
)
556 ;; the ``continuation'' exited to (the block, succeeding the EXIT
557 ;; nodes). If this exit is from an escape function (CATCH or
558 ;; UNWIND-PROTECT), then physical environment analysis deletes the
559 ;; escape function and instead has the %NLX-ENTRY use this
562 ;; This slot is used as a sort of name to allow us to find the
563 ;; NLX-INFO that corresponds to a given exit. For this purpose, the
564 ;; ENTRY must also be used to disambiguate, since exits to different
565 ;; places may deliver their result to the same continuation.
566 (block (missing-arg) :type cblock
)
567 ;; the entry stub inserted by physical environment analysis. This is
568 ;; a block containing a call to the %NLX-ENTRY funny function that
569 ;; has the original exit destination as its successor. Null only
571 (target nil
:type
(or cblock null
))
572 ;; for a lexical exit it determines whether tag existence check is
574 (safe-p nil
:type boolean
)
575 ;; some kind of info used by the back end
577 (defprinter (nlx-info :identity t
)
584 ;;; Variables, constants and functions are all represented by LEAF
585 ;;; structures. A reference to a LEAF is indicated by a REF node. This
586 ;;; allows us to easily substitute one for the other without actually
587 ;;; hacking the flow graph.
588 (def!struct
(leaf (:make-load-form-fun ignore-it
)
590 ;; unique ID for debugging
591 #!+sb-show
(id (new-object-id) :read-only t
)
592 ;; (For public access to this slot, use LEAF-SOURCE-NAME.)
594 ;; the name of LEAF as it appears in the source, e.g. 'FOO or '(SETF
595 ;; FOO) or 'N or '*Z*, or the special .ANONYMOUS. value if there's
596 ;; no name for this thing in the source (as can happen for
597 ;; FUNCTIONALs, e.g. for anonymous LAMBDAs or for functions for
598 ;; top-level forms; and can also happen for anonymous constants) or
599 ;; perhaps also if the match between the name and the thing is
600 ;; skewed enough (e.g. for macro functions or method functions) that
601 ;; we don't want to have that name affect compilation
603 ;; (We use .ANONYMOUS. here more or less the way we'd ordinarily use
604 ;; NIL, but we're afraid to use NIL because it's a symbol which could
605 ;; be the name of a leaf, if only the constant named NIL.)
607 ;; The value of this slot in can affect ordinary runtime behavior,
608 ;; e.g. of special variables and known functions, not just debugging.
610 ;; See also the LEAF-DEBUG-NAME function and the
611 ;; FUNCTIONAL-%DEBUG-NAME slot.
612 (%source-name
(missing-arg)
613 :type
(or symbol
(and cons
(satisfies legal-fun-name-p
)))
615 ;; the type which values of this leaf must have
616 (type *universal-type
* :type ctype
)
617 ;; where the TYPE information came from:
618 ;; :DECLARED, from a declaration.
619 ;; :ASSUMED, from uses of the object.
620 ;; :DEFINED, from examination of the definition.
621 ;; FIXME: This should be a named type. (LEAF-WHERE-FROM? Or
622 ;; perhaps just WHERE-FROM, since it's not just used in LEAF,
623 ;; but also in various DEFINE-INFO-TYPEs in globaldb.lisp,
624 ;; and very likely elsewhere too.)
625 (where-from :assumed
:type
(member :declared
:assumed
:defined
))
626 ;; list of the REF nodes for this leaf
628 ;; true if there was ever a REF or SET node for this leaf. This may
629 ;; be true when REFS and SETS are null, since code can be deleted.
630 (ever-used nil
:type boolean
)
631 ;; is it declared dynamic-extent?
632 (dynamic-extent nil
:type boolean
)
633 ;; some kind of info used by the back end
636 ;;; LEAF name operations
638 ;;; KLUDGE: wants CLOS..
639 (defun leaf-has-source-name-p (leaf)
640 (not (eq (leaf-%source-name leaf
)
642 (defun leaf-source-name (leaf)
643 (aver (leaf-has-source-name-p leaf
))
644 (leaf-%source-name leaf
))
645 (defun leaf-debug-name (leaf)
646 (if (functional-p leaf
)
647 ;; FUNCTIONALs have additional %DEBUG-NAME behavior.
648 (functional-debug-name leaf
)
649 ;; Other objects just use their source name.
651 ;; (As of sbcl-0.pre7.85, there are a few non-FUNCTIONAL
652 ;; anonymous objects, (anonymous constants..) and those would
653 ;; fail here if we ever tried to get debug names from them, but
654 ;; it looks as though it's never interesting to get debug names
655 ;; from them, so it's moot. -- WHN)
656 (leaf-source-name leaf
)))
658 ;;; The CONSTANT structure is used to represent known constant values.
659 ;;; If NAME is not null, then it is the name of the named constant
660 ;;; which this leaf corresponds to, otherwise this is an anonymous
662 (def!struct
(constant (:include leaf
))
663 ;; the value of the constant
665 (defprinter (constant :identity t
)
666 (%source-name
:test %source-name
)
669 ;;; The BASIC-VAR structure represents information common to all
670 ;;; variables which don't correspond to known local functions.
671 (def!struct
(basic-var (:include leaf
)
673 ;; Lists of the set nodes for this variable.
674 (sets () :type list
))
676 ;;; The GLOBAL-VAR structure represents a value hung off of the symbol
678 (def!struct
(global-var (:include basic-var
))
679 ;; kind of variable described
681 :type
(member :special
:global-function
:global
)))
682 (defprinter (global-var :identity t
)
685 (type :test
(not (eq type
*universal-type
*)))
686 (where-from :test
(not (eq where-from
:assumed
)))
689 ;;; A DEFINED-FUN represents a function that is defined in the same
690 ;;; compilation block, or that has an inline expansion, or that has a
691 ;;; non-NIL INLINEP value. Whenever we change the INLINEP state (i.e.
692 ;;; an inline proclamation) we copy the structure so that former
693 ;;; INLINEP values are preserved.
694 (def!struct
(defined-fun (:include global-var
695 (where-from :defined
)
696 (kind :global-function
)))
697 ;; The values of INLINEP and INLINE-EXPANSION initialized from the
698 ;; global environment.
699 (inlinep nil
:type inlinep
)
700 (inline-expansion nil
:type
(or cons null
))
701 ;; the block-local definition of this function (either because it
702 ;; was semi-inline, or because it was defined in this block). If
703 ;; this function is not an entry point, then this may be deleted or
704 ;; LET-converted. Null if we haven't converted the expansion yet.
705 (functional nil
:type
(or functional null
)))
706 (defprinter (defined-fun :identity t
)
710 (functional :test functional
))
714 ;;; We default the WHERE-FROM and TYPE slots to :DEFINED and FUNCTION.
715 ;;; We don't normally manipulate function types for defined functions,
716 ;;; but if someone wants to know, an approximation is there.
717 (def!struct
(functional (:include leaf
718 (%source-name
'.anonymous.
)
719 (where-from :defined
)
720 (type (specifier-type 'function
))))
721 ;; (For public access to this slot, use LEAF-DEBUG-NAME.)
723 ;; the name of FUNCTIONAL for debugging purposes, or NIL if we
724 ;; should just let the SOURCE-NAME fall through
726 ;; Unlike the SOURCE-NAME slot, this slot's value should never
727 ;; affect ordinary code behavior, only debugging/diagnostic behavior.
729 ;; Ha. Ah, the starry-eyed idealism of the writer of the above
730 ;; paragraph. FUNCTION-LAMBDA-EXPRESSION's behaviour, as of
731 ;; sbcl-0.7.11.x, differs if the name of the a function is a string
732 ;; or not, as if it is a valid function name then it can look for an
735 ;; E.g. for the function which implements (DEFUN FOO ...), we could
739 ;; for the function which implements the top level form
740 ;; (IN-PACKAGE :FOO) we could have
742 ;; %DEBUG-NAME=(TOP-LEVEL-FORM (IN-PACKAGE :FOO)
743 ;; for the function which implements FOO in
744 ;; (DEFUN BAR (...) (FLET ((FOO (...) ...)) ...))
747 ;; %DEBUG-NAME=(FLET FOO)
748 ;; and for the function which implements FOO in
749 ;; (DEFMACRO FOO (...) ...)
751 ;; %SOURCE-NAME=FOO (or maybe .ANONYMOUS.?)
752 ;; %DEBUG-NAME=(MACRO-FUNCTION FOO)
754 :type
(or null
(not (satisfies legal-fun-name-p
)))
756 ;; some information about how this function is used. These values
760 ;; an ordinary function, callable using local call
763 ;; a lambda that is used in only one local call, and has in
764 ;; effect been substituted directly inline. The return node is
765 ;; deleted, and the result is computed with the actual result
766 ;; lvar for the call.
769 ;; Similar to :LET (as per FUNCTIONAL-LETLIKE-P), but the call
773 ;; similar to a LET (as per FUNCTIONAL-SOMEWHAT-LETLIKE-P), but
774 ;; can have other than one call as long as there is at most
775 ;; one non-tail call.
778 ;; a lambda that is an entry point for an OPTIONAL-DISPATCH.
779 ;; Similar to NIL, but requires greater caution, since local call
780 ;; analysis may create new references to this function. Also, the
781 ;; function cannot be deleted even if it has *no* references. The
782 ;; OPTIONAL-DISPATCH is in the LAMDBA-OPTIONAL-DISPATCH.
785 ;; an external entry point lambda. The function it is an entry
786 ;; for is in the ENTRY-FUN slot.
789 ;; a top level lambda, holding a compiled top level form.
790 ;; Compiled very much like NIL, but provides an indication of
791 ;; top level context. A :TOPLEVEL lambda should have *no*
792 ;; references. Its ENTRY-FUN is a self-pointer.
795 ;; After a component is compiled, we clobber any top level code
796 ;; references to its non-closure XEPs with dummy FUNCTIONAL
797 ;; structures having this kind. This prevents the retained
798 ;; top level code from holding onto the IR for the code it
803 ;; special functions used internally by CATCH and UNWIND-PROTECT.
804 ;; These are pretty much like a normal function (NIL), but are
805 ;; treated specially by local call analysis and stuff. Neither
806 ;; kind should ever be given an XEP even though they appear as
807 ;; args to funny functions. An :ESCAPE function is never actually
808 ;; called, and thus doesn't need to have code generated for it.
811 ;; This function has been found to be uncallable, and has been
812 ;; marked for deletion.
815 ;; Effectless [MV-]LET; has no BIND node.
816 (kind nil
:type
(member nil
:optional
:deleted
:external
:toplevel
817 :escape
:cleanup
:let
:mv-let
:assignment
818 :zombie
:toplevel-xep
))
819 ;; Is this a function that some external entity (e.g. the fasl dumper)
820 ;; refers to, so that even when it appears to have no references, it
821 ;; shouldn't be deleted? In the old days (before
822 ;; sbcl-0.pre7.37.flaky5.2) this was sort of implicitly true when
823 ;; KIND was :TOPLEVEL. Now it must be set explicitly, both for
824 ;; :TOPLEVEL functions and for any other kind of functions that we
825 ;; want to dump or return from #'CL:COMPILE or whatever.
826 (has-external-references-p nil
)
827 ;; In a normal function, this is the external entry point (XEP)
828 ;; lambda for this function, if any. Each function that is used
829 ;; other than in a local call has an XEP, and all of the
830 ;; non-local-call references are replaced with references to the
833 ;; In an XEP lambda (indicated by the :EXTERNAL kind), this is the
834 ;; function that the XEP is an entry-point for. The body contains
835 ;; local calls to all the actual entry points in the function. In a
836 ;; :TOPLEVEL lambda (which is its own XEP) this is a self-pointer.
838 ;; With all other kinds, this is null.
839 (entry-fun nil
:type
(or functional null
))
840 ;; the value of any inline/notinline declaration for a local
841 ;; function (or NIL in any case if no inline expansion is available)
842 (inlinep nil
:type inlinep
)
843 ;; If we have a lambda that can be used as in inline expansion for
844 ;; this function, then this is it. If there is no source-level
845 ;; lambda corresponding to this function then this is null (but then
846 ;; INLINEP will always be NIL as well.)
847 (inline-expansion nil
:type list
)
848 ;; the lexical environment that the INLINE-EXPANSION should be converted in
849 (lexenv *lexenv
* :type lexenv
)
850 ;; the original function or macro lambda list, or :UNSPECIFIED if
851 ;; this is a compiler created function
852 (arg-documentation nil
:type
(or list
(member :unspecified
)))
853 ;; Node, allocating closure for this lambda. May be NIL when we are
854 ;; sure that no closure is needed.
855 (allocator nil
:type
(or null combination
))
856 ;; various rare miscellaneous info that drives code generation & stuff
857 (plist () :type list
))
858 (defprinter (functional :identity t
)
863 ;;; Is FUNCTIONAL LET-converted? (where we're indifferent to whether
864 ;;; it returns one value or multiple values)
865 (defun functional-letlike-p (functional)
866 (member (functional-kind functional
)
869 ;;; Is FUNCTIONAL sorta LET-converted? (where even an :ASSIGNMENT counts)
871 ;;; FIXME: I (WHN) don't understand this one well enough to give a good
872 ;;; definition or even a good function name, it's just a literal copy
873 ;;; of a CMU CL idiom. Does anyone have a better name or explanation?
874 (defun functional-somewhat-letlike-p (functional)
875 (or (functional-letlike-p functional
)
876 (eql (functional-kind functional
) :assignment
)))
878 ;;; FUNCTIONAL name operations
879 (defun functional-debug-name (functional)
880 ;; FUNCTIONAL-%DEBUG-NAME takes precedence over FUNCTIONAL-SOURCE-NAME
881 ;; here because we want different debug names for the functions in
882 ;; DEFUN FOO and FLET FOO even though they have the same source name.
883 (or (functional-%debug-name functional
)
884 ;; Note that this will cause an error if the function is
885 ;; anonymous. In SBCL (as opposed to CMU CL) we make all
886 ;; FUNCTIONALs have debug names. The CMU CL code didn't bother
887 ;; in many FUNCTIONALs, especially those which were likely to be
888 ;; optimized away before the user saw them. However, getting
889 ;; that right requires a global understanding of the code,
890 ;; which seems bad, so we just require names for everything.
891 (leaf-source-name functional
)))
893 ;;; The CLAMBDA only deals with required lexical arguments. Special,
894 ;;; optional, keyword and rest arguments are handled by transforming
895 ;;; into simpler stuff.
896 (def!struct
(clambda (:include functional
)
898 (:predicate lambda-p
)
899 (:constructor make-lambda
)
900 (:copier copy-lambda
))
901 ;; list of LAMBDA-VAR descriptors for arguments
902 (vars nil
:type list
:read-only t
)
903 ;; If this function was ever a :OPTIONAL function (an entry-point
904 ;; for an OPTIONAL-DISPATCH), then this is that OPTIONAL-DISPATCH.
905 ;; The optional dispatch will be :DELETED if this function is no
907 (optional-dispatch nil
:type
(or optional-dispatch null
))
908 ;; the BIND node for this LAMBDA. This node marks the beginning of
909 ;; the lambda, and serves to explicitly represent the lambda binding
910 ;; semantics within the flow graph representation. This is null in
911 ;; deleted functions, and also in LETs where we deleted the call and
912 ;; bind (because there are no variables left), but have not yet
913 ;; actually deleted the LAMBDA yet.
914 (bind nil
:type
(or bind null
))
915 ;; the RETURN node for this LAMBDA, or NIL if it has been
916 ;; deleted. This marks the end of the lambda, receiving the result
917 ;; of the body. In a LET, the return node is deleted, and the body
918 ;; delivers the value to the actual lvar. The return may also be
919 ;; deleted if it is unreachable.
920 (return nil
:type
(or creturn null
))
921 ;; If this CLAMBDA is a LET, then this slot holds the LAMBDA whose
922 ;; LETS list we are in, otherwise it is a self-pointer.
923 (home nil
:type
(or clambda null
))
924 ;; all the lambdas that have been LET-substituted in this lambda.
925 ;; This is only non-null in lambdas that aren't LETs.
926 (lets nil
:type list
)
927 ;; all the ENTRY nodes in this function and its LETs, or null in a LET
928 (entries nil
:type list
)
929 ;; CLAMBDAs which are locally called by this lambda, and other
930 ;; objects (closed-over LAMBDA-VARs and XEPs) which this lambda
931 ;; depends on in such a way that DFO shouldn't put them in separate
933 (calls-or-closes nil
:type list
)
934 ;; the TAIL-SET that this LAMBDA is in. This is null during creation.
936 ;; In CMU CL, and old SBCL, this was also NILed out when LET
937 ;; conversion happened. That caused some problems, so as of
938 ;; sbcl-0.pre7.37.flaky5.2 when I was trying to get the compiler to
939 ;; emit :EXTERNAL functions directly, and so now the value
940 ;; is no longer NILed out in LET conversion, but instead copied
941 ;; (so that any further optimizations on the rest of the tail
942 ;; set won't modify the value) if necessary.
943 (tail-set nil
:type
(or tail-set null
))
944 ;; the structure which represents the phsical environment that this
945 ;; function's variables are allocated in. This is filled in by
946 ;; physical environment analysis. In a LET, this is EQ to our home's
947 ;; physical environment.
948 (physenv nil
:type
(or physenv null
))
949 ;; In a LET, this is the NODE-LEXENV of the combination node. We
950 ;; retain it so that if the LET is deleted (due to a lack of vars),
951 ;; we will still have caller's lexenv to figure out which cleanup is
953 (call-lexenv nil
:type
(or lexenv null
))
954 ;; list of embedded lambdas
955 (children nil
:type list
)
956 (parent nil
:type
(or clambda null
)))
957 (defprinter (clambda :conc-name lambda-
:identity t
)
962 (type :test
(not (eq type
*universal-type
*)))
963 (where-from :test
(not (eq where-from
:assumed
)))
964 (vars :prin1
(mapcar #'leaf-source-name vars
)))
966 ;;; The OPTIONAL-DISPATCH leaf is used to represent hairy lambdas. It
967 ;;; is a FUNCTIONAL, like LAMBDA. Each legal number of arguments has a
968 ;;; function which is called when that number of arguments is passed.
969 ;;; The function is called with all the arguments actually passed. If
970 ;;; additional arguments are legal, then the LEXPR style MORE-ENTRY
971 ;;; handles them. The value returned by the function is the value
972 ;;; which results from calling the OPTIONAL-DISPATCH.
974 ;;; The theory is that each entry-point function calls the next entry
975 ;;; point tail-recursively, passing all the arguments passed in and
976 ;;; the default for the argument the entry point is for. The last
977 ;;; entry point calls the real body of the function. In the presence
978 ;;; of SUPPLIED-P args and other hair, things are more complicated. In
979 ;;; general, there is a distinct internal function that takes the
980 ;;; SUPPLIED-P args as parameters. The preceding entry point calls
981 ;;; this function with NIL filled in for the SUPPLIED-P args, while
982 ;;; the current entry point calls it with T in the SUPPLIED-P
985 ;;; Note that it is easy to turn a call with a known number of
986 ;;; arguments into a direct call to the appropriate entry-point
987 ;;; function, so functions that are compiled together can avoid doing
989 (def!struct
(optional-dispatch (:include functional
))
990 ;; the original parsed argument list, for anyone who cares
991 (arglist nil
:type list
)
992 ;; true if &ALLOW-OTHER-KEYS was supplied
993 (allowp nil
:type boolean
)
994 ;; true if &KEY was specified (which doesn't necessarily mean that
995 ;; there are any &KEY arguments..)
996 (keyp nil
:type boolean
)
997 ;; the number of required arguments. This is the smallest legal
998 ;; number of arguments.
999 (min-args 0 :type unsigned-byte
)
1000 ;; the total number of required and optional arguments. Args at
1001 ;; positions >= to this are &REST, &KEY or illegal args.
1002 (max-args 0 :type unsigned-byte
)
1003 ;; list of the (maybe delayed) LAMBDAs which are the entry points
1004 ;; for non-rest, non-key calls. The entry for MIN-ARGS is first,
1005 ;; MIN-ARGS+1 second, ... MAX-ARGS last. The last entry-point always
1006 ;; calls the main entry; in simple cases it may be the main entry.
1007 (entry-points nil
:type list
)
1008 ;; an entry point which takes MAX-ARGS fixed arguments followed by
1009 ;; an argument context pointer and an argument count. This entry
1010 ;; point deals with listifying rest args and parsing keywords. This
1011 ;; is null when extra arguments aren't legal.
1012 (more-entry nil
:type
(or clambda null
))
1013 ;; the main entry-point into the function, which takes all arguments
1014 ;; including keywords as fixed arguments. The format of the
1015 ;; arguments must be determined by examining the arglist. This may
1016 ;; be used by callers that supply at least MAX-ARGS arguments and
1017 ;; know what they are doing.
1018 (main-entry nil
:type
(or clambda null
)))
1019 (defprinter (optional-dispatch :identity t
)
1023 (type :test
(not (eq type
*universal-type
*)))
1024 (where-from :test
(not (eq where-from
:assumed
)))
1030 (entry-points :test entry-points
)
1031 (more-entry :test more-entry
)
1034 ;;; The ARG-INFO structure allows us to tack various information onto
1035 ;;; LAMBDA-VARs during IR1 conversion. If we use one of these things,
1036 ;;; then the var will have to be massaged a bit before it is simple
1038 (def!struct arg-info
1039 ;; true if this arg is to be specially bound
1040 (specialp nil
:type boolean
)
1041 ;; the kind of argument being described. Required args only have arg
1042 ;; info structures if they are special.
1044 :type
(member :required
:optional
:keyword
:rest
1045 :more-context
:more-count
))
1046 ;; If true, this is the VAR for SUPPLIED-P variable of a keyword or
1047 ;; optional arg. This is true for keywords with non-constant
1048 ;; defaults even when there is no user-specified supplied-p var.
1049 (supplied-p nil
:type
(or lambda-var null
))
1050 ;; the default for a keyword or optional, represented as the
1051 ;; original Lisp code. This is set to NIL in &KEY arguments that are
1052 ;; defaulted using the SUPPLIED-P arg.
1053 (default nil
:type t
)
1054 ;; the actual key for a &KEY argument. Note that in ANSI CL this is
1055 ;; not necessarily a keyword: (DEFUN FOO (&KEY ((BAR BAR))) ...).
1056 (key nil
:type symbol
))
1057 (defprinter (arg-info :identity t
)
1058 (specialp :test specialp
)
1060 (supplied-p :test supplied-p
)
1061 (default :test default
)
1064 ;;; The LAMBDA-VAR structure represents a lexical lambda variable.
1065 ;;; This structure is also used during IR1 conversion to describe
1066 ;;; lambda arguments which may ultimately turn out not to be simple
1069 ;;; LAMBDA-VARs with no REFs are considered to be deleted; physical
1070 ;;; environment analysis isn't done on these variables, so the back
1071 ;;; end must check for and ignore unreferenced variables. Note that a
1072 ;;; deleted LAMBDA-VAR may have sets; in this case the back end is
1073 ;;; still responsible for propagating the SET-VALUE to the set's CONT.
1074 (!def-boolean-attribute lambda-var
1075 ;; true if this variable has been declared IGNORE
1077 ;; This is set by physical environment analysis if it chooses an
1078 ;; indirect (value cell) representation for this variable because it
1079 ;; is both set and closed over.
1082 (def!struct
(lambda-var (:include basic-var
))
1083 (flags (lambda-var-attributes)
1085 ;; the CLAMBDA that this var belongs to. This may be null when we are
1086 ;; building a lambda during IR1 conversion.
1087 (home nil
:type
(or null clambda
))
1088 ;; The following two slots are only meaningful during IR1 conversion
1089 ;; of hairy lambda vars:
1091 ;; The ARG-INFO structure which holds information obtained from
1092 ;; &keyword parsing.
1093 (arg-info nil
:type
(or arg-info null
))
1094 ;; if true, the GLOBAL-VAR structure for the special variable which
1095 ;; is to be bound to the value of this argument
1096 (specvar nil
:type
(or global-var null
))
1097 ;; Set of the CONSTRAINTs on this variable. Used by constraint
1098 ;; propagation. This is left null by the lambda pre-pass if it
1099 ;; determine that this is a set closure variable, and is thus not a
1100 ;; good subject for flow analysis.
1101 (constraints nil
:type
(or sset null
)))
1102 (defprinter (lambda-var :identity t
)
1105 (type :test
(not (eq type
*universal-type
*)))
1106 (where-from :test
(not (eq where-from
:assumed
)))
1107 (flags :test
(not (zerop flags
))
1108 :prin1
(decode-lambda-var-attributes flags
))
1109 (arg-info :test arg-info
)
1110 (specvar :test specvar
))
1112 (defmacro lambda-var-ignorep
(var)
1113 `(lambda-var-attributep (lambda-var-flags ,var
) ignore
))
1114 (defmacro lambda-var-indirect
(var)
1115 `(lambda-var-attributep (lambda-var-flags ,var
) indirect
))
1117 ;;;; basic node types
1119 ;;; A REF represents a reference to a LEAF. REF-REOPTIMIZE is
1120 ;;; initially (and forever) NIL, since REFs don't receive any values
1121 ;;; and don't have any IR1 optimizer.
1122 (def!struct
(ref (:include valued-node
(reoptimize nil
))
1123 (:constructor make-ref
1125 &aux
(leaf-type (leaf-type leaf
))
1127 (make-single-value-type leaf-type
))))
1129 ;; The leaf referenced.
1130 (leaf nil
:type leaf
))
1131 (defprinter (ref :identity t
)
1135 ;;; Naturally, the IF node always appears at the end of a block.
1136 (def!struct
(cif (:include node
)
1139 (:constructor make-if
)
1141 ;; LVAR for the predicate
1142 (test (missing-arg) :type lvar
)
1143 ;; the blocks that we execute next in true and false case,
1144 ;; respectively (may be the same)
1145 (consequent (missing-arg) :type cblock
)
1146 (alternative (missing-arg) :type cblock
))
1147 (defprinter (cif :conc-name if-
:identity t
)
1148 (test :prin1
(lvar-uses test
))
1152 (def!struct
(cset (:include valued-node
1153 (derived-type (make-single-value-type
1157 (:constructor make-set
)
1159 ;; descriptor for the variable set
1160 (var (missing-arg) :type basic-var
)
1161 ;; LVAR for the value form
1162 (value (missing-arg) :type lvar
))
1163 (defprinter (cset :conc-name set-
:identity t
)
1165 (value :prin1
(lvar-uses value
)))
1167 ;;; The BASIC-COMBINATION structure is used to represent both normal
1168 ;;; and multiple value combinations. In a let-like function call, this
1169 ;;; node appears at the end of its block and the body of the called
1170 ;;; function appears as the successor; the NODE-LVAR is null.
1171 (def!struct
(basic-combination (:include valued-node
)
1174 ;; LVAR for the function
1175 (fun (missing-arg) :type lvar
)
1176 ;; list of LVARs for the args. In a local call, an argument lvar may
1177 ;; be replaced with NIL to indicate that the corresponding variable
1178 ;; is unreferenced, and thus no argument value need be passed.
1179 (args nil
:type list
)
1180 ;; the kind of function call being made. :LOCAL means that this is a
1181 ;; local call to a function in the same component, and that argument
1182 ;; syntax checking has been done, etc. Calls to known global
1183 ;; functions are represented by storing :KNOWN in this slot and the
1184 ;; FUN-INFO for that function in the FUN-INFO slot. :FULL is a call
1185 ;; to an (as yet) unknown function, or to a known function declared
1186 ;; NOTINLINE. :ERROR is like :FULL, but means that we have
1187 ;; discovered that the call contains an error, and should not be
1188 ;; reconsidered for optimization.
1189 (kind :full
:type
(member :local
:full
:error
:known
))
1190 ;; if a call to a known global function, contains the FUN-INFO.
1191 (fun-info nil
:type
(or fun-info null
))
1192 ;; some kind of information attached to this node by the back end
1195 ;;; The COMBINATION node represents all normal function calls,
1196 ;;; including FUNCALL. This is distinct from BASIC-COMBINATION so that
1197 ;;; an MV-COMBINATION isn't COMBINATION-P.
1198 (def!struct
(combination (:include basic-combination
)
1199 (:constructor make-combination
(fun))
1201 (defprinter (combination :identity t
)
1203 (fun :prin1
(lvar-uses fun
))
1204 (args :prin1
(mapcar (lambda (x)
1210 ;;; An MV-COMBINATION is to MULTIPLE-VALUE-CALL as a COMBINATION is to
1211 ;;; FUNCALL. This is used to implement all the multiple-value
1212 ;;; receiving forms.
1213 (def!struct
(mv-combination (:include basic-combination
)
1214 (:constructor make-mv-combination
(fun))
1216 (defprinter (mv-combination)
1217 (fun :prin1
(lvar-uses fun
))
1218 (args :prin1
(mapcar #'lvar-uses args
)))
1220 ;;; The BIND node marks the beginning of a lambda body and represents
1221 ;;; the creation and initialization of the variables.
1222 (def!struct
(bind (:include node
)
1224 ;; the lambda we are binding variables for. Null when we are
1225 ;; creating the LAMBDA during IR1 translation.
1226 (lambda nil
:type
(or clambda null
)))
1230 ;;; The RETURN node marks the end of a lambda body. It collects the
1231 ;;; return values and represents the control transfer on return. This
1232 ;;; is also where we stick information used for TAIL-SET type
1234 (def!struct
(creturn (:include node
)
1235 (:conc-name return-
)
1236 (:predicate return-p
)
1237 (:constructor make-return
)
1238 (:copier copy-return
))
1239 ;; the lambda we are returning from. Null temporarily during
1241 (lambda nil
:type
(or clambda null
))
1242 ;; the lvar which yields the value of the lambda
1243 (result (missing-arg) :type lvar
)
1244 ;; the union of the node-derived-type of all uses of the result
1245 ;; other than by a local call, intersected with the result's
1246 ;; asserted-type. If there are no non-call uses, this is
1248 (result-type *wild-type
* :type ctype
))
1249 (defprinter (creturn :conc-name return-
:identity t
)
1253 ;;; The CAST node represents type assertions. The check for
1254 ;;; TYPE-TO-CHECK is performed and then the VALUE is declared to be of
1255 ;;; type ASSERTED-TYPE.
1256 (def!struct
(cast (:include valued-node
)
1257 (:constructor %make-cast
))
1258 (asserted-type (missing-arg) :type ctype
)
1259 (type-to-check (missing-arg) :type ctype
)
1260 ;; an indication of what we have proven about how this type
1261 ;; assertion is satisfied:
1264 ;; No type check is necessary (VALUE type is a subtype of the TYPE-TO-CHECK.)
1267 ;; Type check will be performed by NODE-DEST.
1270 ;; A type check is needed.
1271 (%type-check t
:type
(member t
:external nil
))
1272 ;; the lvar which is checked
1273 (value (missing-arg) :type lvar
))
1274 (defprinter (cast :identity t
)
1280 ;;;; non-local exit support
1282 ;;;; In IR1, we insert special nodes to mark potentially non-local
1285 ;;; The ENTRY node serves to mark the start of the dynamic extent of a
1286 ;;; lexical exit. It is the mess-up node for the corresponding :ENTRY
1288 (def!struct
(entry (:include node
)
1290 ;; All of the EXIT nodes for potential non-local exits to this point.
1291 (exits nil
:type list
)
1292 ;; The cleanup for this entry. NULL only temporarily.
1293 (cleanup nil
:type
(or cleanup null
)))
1294 (defprinter (entry :identity t
)
1297 ;;; The EXIT node marks the place at which exit code would be emitted,
1298 ;;; if necessary. This is interposed between the uses of the exit
1299 ;;; continuation and the exit continuation's DEST. Instead of using
1300 ;;; the returned value being delivered directly to the exit
1301 ;;; continuation, it is delivered to our VALUE lvar. The original exit
1302 ;;; lvar is the exit node's LVAR; physenv analysis also makes it the
1303 ;;; lvar of %NLX-ENTRY call.
1304 (def!struct
(exit (:include valued-node
)
1306 ;; the ENTRY node that this is an exit for. If null, this is a
1307 ;; degenerate exit. A degenerate exit is used to "fill" an empty
1308 ;; block (which isn't allowed in IR1.) In a degenerate exit, Value
1309 ;; is always also null.
1310 (entry nil
:type
(or entry null
))
1311 ;; the lvar yielding the value we are to exit with. If NIL, then no
1312 ;; value is desired (as in GO).
1313 (value nil
:type
(or lvar null
))
1314 (nlx-info nil
:type
(or nlx-info null
)))
1315 (defprinter (exit :identity t
)
1318 (value :test value
))
1320 ;;;; miscellaneous IR1 structures
1322 (def!struct
(undefined-warning
1323 #-no-ansi-print-object
1324 (:print-object
(lambda (x s
)
1325 (print-unreadable-object (x s
:type t
)
1326 (prin1 (undefined-warning-name x
) s
))))
1328 ;; the name of the unknown thing
1329 (name nil
:type
(or symbol list
))
1330 ;; the kind of reference to NAME
1331 (kind (missing-arg) :type
(member :function
:type
:variable
))
1332 ;; the number of times this thing was used
1333 (count 0 :type unsigned-byte
)
1334 ;; a list of COMPILER-ERROR-CONTEXT structures describing places
1335 ;; where this thing was used. Note that we only record the first
1336 ;; *UNDEFINED-WARNING-LIMIT* calls.
1337 (warnings () :type list
))
1339 ;;; a helper for the POLICY macro, defined late here so that the
1340 ;;; various type tests can be inlined
1341 (declaim (ftype (function ((or list lexenv node functional
)) list
)
1343 (defun %coerce-to-policy
(thing)
1344 (let ((result (etypecase thing
1346 (lexenv (lexenv-policy thing
))
1347 (node (lexenv-policy (node-lexenv thing
)))
1348 (functional (lexenv-policy (functional-lexenv thing
))))))
1349 ;; Test the first element of the list as a rudimentary sanity
1350 ;; that it really does look like a valid policy.
1351 (aver (or (null result
) (policy-quality-name-p (caar result
))))
1355 ;;;; Freeze some structure types to speed type testing.
1358 (declaim (freeze-type node leaf lexenv ctran lvar cblock component cleanup
1359 physenv tail-set nlx-info
))