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
)
89 (:include sset-element
(number (incf *compiler-sset-counter
*)))
91 ;; unique ID for debugging
92 #!+sb-show
(id (new-object-id) :read-only t
)
93 ;; True if this node needs to be optimized. This is set to true
94 ;; whenever something changes about the value of an lvar whose DEST
96 (reoptimize t
:type boolean
)
97 ;; the ctran indicating what we do controlwise after evaluating this
98 ;; node. This is null if the node is the last in its block.
99 (next nil
:type
(or ctran null
))
100 ;; the ctran that this node is the NEXT of. This is null during IR1
101 ;; conversion when we haven't linked the node in yet or in nodes
102 ;; that have been deleted from the IR1 by UNLINK-NODE.
103 (prev nil
:type
(or ctran null
))
104 ;; the lexical environment this node was converted in
105 (lexenv *lexenv
* :type lexenv
)
106 ;; a representation of the source code responsible for generating
109 ;; For a form introduced by compilation (does not appear in the
110 ;; original source), the path begins with a list of all the
111 ;; enclosing introduced forms. This list is from the inside out,
112 ;; with the form immediately responsible for this node at the head
115 ;; Following the introduced forms is a representation of the
116 ;; location of the enclosing original source form. This transition
117 ;; is indicated by the magic ORIGINAL-SOURCE-START marker. The first
118 ;; element of the original source is the "form number", which is the
119 ;; ordinal number of this form in a depth-first, left-to-right walk
120 ;; of the truly-top-level form in which this appears.
122 ;; Following is a list of integers describing the path taken through
123 ;; the source to get to this point:
124 ;; (K L M ...) => (NTH K (NTH L (NTH M ...)))
126 ;; The last element in the list is the top level form number, which
127 ;; is the ordinal number (in this call to the compiler) of the truly
128 ;; top level form containing the original source.
129 (source-path *current-path
* :type list
)
130 ;; If this node is in a tail-recursive position, then this is set to
131 ;; T. At the end of IR1 (in physical environment analysis) this is
132 ;; computed for all nodes (after cleanup code has been emitted).
133 ;; Before then, a non-null value indicates that IR1 optimization has
134 ;; converted a tail local call to a direct transfer.
136 ;; If the back-end breaks tail-recursion for some reason, then it
137 ;; can null out this slot.
138 (tail-p nil
:type boolean
))
140 (def!struct
(valued-node (:conc-name node-
)
144 ;; the bottom-up derived type for this node.
145 (derived-type *wild-type
* :type ctype
)
146 ;; Lvar, receiving the values, produced by this node. May be NIL if
147 ;; the value is unused.
148 (lvar nil
:type
(or lvar null
)))
150 ;;; Flags that are used to indicate various things about a block, such
151 ;;; as what optimizations need to be done on it:
152 ;;; -- REOPTIMIZE is set when something interesting happens the uses of a
153 ;;; lvar whose DEST is in this block. This indicates that the
154 ;;; value-driven (forward) IR1 optimizations should be done on this block.
155 ;;; -- FLUSH-P is set when code in this block becomes potentially flushable,
156 ;;; usually due to an lvar's DEST becoming null.
157 ;;; -- TYPE-CHECK is true when the type check phase should be run on this
158 ;;; block. IR1 optimize can introduce new blocks after type check has
159 ;;; already run. We need to check these blocks, but there is no point in
160 ;;; checking blocks we have already checked.
161 ;;; -- DELETE-P is true when this block is used to indicate that this block
162 ;;; has been determined to be unreachable and should be deleted. IR1
163 ;;; phases should not attempt to examine or modify blocks with DELETE-P
164 ;;; set, since they may:
165 ;;; - be in the process of being deleted, or
166 ;;; - have no successors.
167 ;;; -- TYPE-ASSERTED, TEST-MODIFIED
168 ;;; These flags are used to indicate that something in this block
169 ;;; might be of interest to constraint propagation. TYPE-ASSERTED
170 ;;; is set when an lvar type assertion is strengthened.
171 ;;; TEST-MODIFIED is set whenever the test for the ending IF has
172 ;;; changed (may be true when there is no IF.)
173 (!def-boolean-attribute block
174 reoptimize flush-p type-check delete-p type-asserted test-modified
)
176 ;;; FIXME: Tweak so that definitions of e.g. BLOCK-DELETE-P is
177 ;;; findable by grep for 'def.*block-delete-p'.
178 (macrolet ((frob (slot)
179 `(defmacro ,(symbolicate "BLOCK-" slot
) (block)
180 `(block-attributep (block-flags ,block
) ,',slot
))))
186 (frob test-modified
))
188 ;;; The CBLOCK structure represents a basic block. We include
189 ;;; SSET-ELEMENT so that we can have sets of blocks. Initially the
190 ;;; SSET-ELEMENT-NUMBER is null, DFO analysis numbers in reverse DFO.
191 ;;; During IR2 conversion, IR1 blocks are re-numbered in forward emit
192 ;;; order. This latter numbering also forms the basis of the block
193 ;;; numbering in the debug-info (though that is relative to the start
194 ;;; of the function.)
195 (def!struct
(cblock (:include sset-element
)
196 (:constructor make-block
(start))
197 (:constructor make-block-key
)
199 (:predicate block-p
))
200 ;; a list of all the blocks that are predecessors/successors of this
201 ;; block. In well-formed IR1, most blocks will have one successor.
202 ;; The only exceptions are:
203 ;; 1. component head blocks (any number)
204 ;; 2. blocks ending in an IF (1 or 2)
205 ;; 3. blocks with DELETE-P set (zero)
206 (pred nil
:type list
)
207 (succ nil
:type list
)
208 ;; the ctran which heads this block (a :BLOCK-START), or NIL when we
209 ;; haven't made the start ctran yet (and in the dummy component head
211 (start nil
:type
(or ctran null
))
212 ;; the last node in this block. This is NIL when we are in the
213 ;; process of building a block (and in the dummy component head and
215 (last nil
:type
(or node null
))
216 ;; the forward and backward links in the depth-first ordering of the
217 ;; blocks. These slots are NIL at beginning/end.
218 (next nil
:type
(or null cblock
))
219 (prev nil
:type
(or null cblock
))
220 ;; This block's attributes: see above.
221 (flags (block-attributes reoptimize flush-p type-check type-asserted
224 ;; in constraint propagation: list of LAMBDA-VARs killed in this block
225 ;; in copy propagation: list of killed TNs
227 ;; other sets used in constraint propagation and/or copy propagation
231 ;; Set of all blocks that dominate this block. NIL is interpreted
232 ;; as "all blocks in component".
233 (dominators nil
:type
(or null sset
))
234 ;; the LOOP that this block belongs to
235 (loop nil
:type
(or null cloop
))
236 ;; next block in the loop.
237 (loop-next nil
:type
(or null cblock
))
238 ;; the component this block is in, or NIL temporarily during IR1
239 ;; conversion and in deleted blocks
241 (aver-live-component *current-component
*)
243 :type
(or component null
))
244 ;; a flag used by various graph-walking code to determine whether
245 ;; this block has been processed already or what. We make this
246 ;; initially NIL so that FIND-INITIAL-DFO doesn't have to scan the
247 ;; entire initial component just to clear the flags.
249 ;; some kind of info used by the back end
251 ;; what macroexpansions happened "in" this block, used for xref
252 (macroexpands nil
:type list
)
253 ;; Cache the physenv of a block during lifetime analysis. :NONE if
254 ;; no cached value has been stored yet.
255 (physenv-cache :none
:type
(or null physenv
(member :none
))))
256 (def!method print-object
((cblock cblock
) stream
)
257 (print-unreadable-object (cblock stream
:type t
:identity t
)
258 (format stream
"~W :START c~W"
259 (block-number cblock
)
260 (cont-num (block-start cblock
)))))
262 ;;; The BLOCK-ANNOTATION class is inherited (via :INCLUDE) by
263 ;;; different BLOCK-INFO annotation structures so that code
264 ;;; (specifically control analysis) can be shared.
265 (def!struct
(block-annotation (:constructor nil
)
267 ;; The IR1 block that this block is in the INFO for.
268 (block (missing-arg) :type cblock
)
269 ;; the next and previous block in emission order (not DFO). This
270 ;; determines which block we drop though to, and is also used to
271 ;; chain together overflow blocks that result from splitting of IR2
272 ;; blocks in lifetime analysis.
273 (next nil
:type
(or block-annotation null
))
274 (prev nil
:type
(or block-annotation null
)))
276 ;;; A COMPONENT structure provides a handle on a connected piece of
277 ;;; the flow graph. Most of the passes in the compiler operate on
278 ;;; COMPONENTs rather than on the entire flow graph.
280 ;;; According to the CMU CL internals/front.tex, the reason for
281 ;;; separating compilation into COMPONENTs is
282 ;;; to increase the efficiency of large block compilations. In
283 ;;; addition to improving locality of reference and reducing the
284 ;;; size of flow analysis problems, this allows back-end data
285 ;;; structures to be reclaimed after the compilation of each
287 (def!struct
(component (:copier nil
)
293 (outer-loop (make-loop :kind
:outer
:head head
)))))
294 ;; unique ID for debugging
295 #!+sb-show
(id (new-object-id) :read-only t
)
296 ;; the kind of component
298 ;; (The terminology here is left over from before
299 ;; sbcl-0.pre7.34.flaky5.2, when there was no such thing as
300 ;; FUNCTIONAL-HAS-EXTERNAL-REFERENCES-P, so that Python was
301 ;; incapable of building standalone :EXTERNAL functions, but instead
302 ;; had to implement things like #'CL:COMPILE as FUNCALL of a little
303 ;; toplevel stub whose sole purpose was to return an :EXTERNAL
306 ;; The possibilities are:
308 ;; an ordinary component, containing non-top-level code
310 ;; a component containing only load-time code
312 ;; In the old system, before FUNCTIONAL-HAS-EXTERNAL-REFERENCES-P
313 ;; was defined, this was necessarily a component containing both
314 ;; top level and run-time code. Now this state is also used for
315 ;; a component with HAS-EXTERNAL-REFERENCES-P functionals in it.
317 ;; the result of initial IR1 conversion, on which component
318 ;; analysis has not been done
320 ;; debris left over from component analysis
322 ;; See also COMPONENT-TOPLEVELISH-P.
323 (kind nil
:type
(member nil
:toplevel
:complex-toplevel
:initial
:deleted
))
324 ;; the blocks that are the dummy head and tail of the DFO
326 ;; Entry/exit points have these blocks as their
327 ;; predecessors/successors. The start and return from each
328 ;; non-deleted function is linked to the component head and
329 ;; tail. Until physical environment analysis links NLX entry stubs
330 ;; to the component head, every successor of the head is a function
331 ;; start (i.e. begins with a BIND node.)
332 (head (missing-arg) :type cblock
)
333 (tail (missing-arg) :type cblock
)
334 ;; New blocks are inserted before this.
335 (last-block (missing-arg) :type cblock
)
336 ;; This becomes a list of the CLAMBDA structures for all functions
337 ;; in this component. OPTIONAL-DISPATCHes are represented only by
338 ;; their XEP and other associated lambdas. This doesn't contain any
339 ;; deleted or LET lambdas.
341 ;; Note that logical associations between CLAMBDAs and COMPONENTs
342 ;; seem to exist for a while before this is initialized. See e.g.
343 ;; the NEW-FUNCTIONALS slot. In particular, I got burned by writing
344 ;; some code to use this value to decide which components need
345 ;; LOCALL-ANALYZE-COMPONENT, when it turns out that
346 ;; LOCALL-ANALYZE-COMPONENT had a role in initializing this value
347 ;; (and DFO stuff does too, maybe). Also, even after it's
348 ;; initialized, it might change as CLAMBDAs are deleted or merged.
350 (lambdas () :type list
)
351 ;; a list of FUNCTIONALs for functions that are newly converted, and
352 ;; haven't been local-call analyzed yet. Initially functions are not
353 ;; in the LAMBDAS list. Local call analysis moves them there
354 ;; (possibly as LETs, or implicitly as XEPs if an OPTIONAL-DISPATCH.)
355 ;; Between runs of local call analysis there may be some debris of
356 ;; converted or even deleted functions in this list.
357 (new-functionals () :type list
)
358 ;; If this is :MAYBE, then there is stuff in this component that
359 ;; could benefit from further IR1 optimization. T means that
360 ;; reoptimization is necessary.
361 (reoptimize t
:type
(member nil
:maybe t
))
362 ;; If this is true, then the control flow in this component was
363 ;; messed up by IR1 optimizations, so the DFO should be recomputed.
364 (reanalyze nil
:type boolean
)
365 ;; some sort of name for the code in this component
366 (name "<unknown>" :type t
)
367 ;; When I am a child, this is :NO-IR2-YET.
368 ;; In my adulthood, IR2 stores notes to itself here.
369 ;; After I have left the great wheel and am staring into the GC, this
370 ;; is set to :DEAD to indicate that it's a gruesome error to operate
371 ;; on me (e.g. by using me as *CURRENT-COMPONENT*, or by pushing
372 ;; LAMBDAs onto my NEW-FUNCTIONALS, as in sbcl-0.pre7.115).
373 (info :no-ir2-yet
:type
(or ir2-component
(member :no-ir2-yet
:dead
)))
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 ;; The current sset index
397 (sset-number 0 :type fixnum
))
398 (defprinter (component :identity t
)
401 (reanalyze :test reanalyze
))
403 ;;; Check that COMPONENT is suitable for roles which involve adding
404 ;;; new code. (gotta love imperative programming with lotso in-place
406 (defun aver-live-component (component)
407 ;; FIXME: As of sbcl-0.pre7.115, we're asserting that
408 ;; COMPILE-COMPONENT hasn't happened yet. Might it be even better
409 ;; (certainly stricter, possibly also correct...) to assert that
410 ;; IR1-FINALIZE hasn't happened yet?
411 (aver (not (eql (component-info component
) :dead
))))
413 ;;; Before sbcl-0.7.0, there were :TOPLEVEL things which were magical
414 ;;; in multiple ways. That's since been refactored into the orthogonal
415 ;;; properties "optimized for locall with no arguments" and "externally
416 ;;; visible/referenced (so don't delete it)". The code <0.7.0 did a lot
417 ;;; of tests a la (EQ KIND :TOP_LEVEL) in the "don't delete it?" sense;
418 ;;; this function is a sort of literal translation of those tests into
421 ;;; FIXME: After things settle down, bare :TOPLEVEL might go away, at
422 ;;; which time it might be possible to replace the COMPONENT-KIND
423 ;;; :TOPLEVEL mess with a flag COMPONENT-HAS-EXTERNAL-REFERENCES-P
424 ;;; along the lines of FUNCTIONAL-HAS-EXTERNAL-REFERENCES-P.
425 (defun lambda-toplevelish-p (clambda)
426 (or (eql (lambda-kind clambda
) :toplevel
)
427 (lambda-has-external-references-p clambda
)))
428 (defun component-toplevelish-p (component)
429 (member (component-kind component
)
430 '(:toplevel
:complex-toplevel
)))
432 ;;; A CLEANUP structure represents some dynamic binding action. Blocks
433 ;;; are annotated with the current CLEANUP so that dynamic bindings
434 ;;; can be removed when control is transferred out of the binding
435 ;;; environment. We arrange for changes in dynamic bindings to happen
436 ;;; at block boundaries, so that cleanup code may easily be inserted.
437 ;;; The "mess-up" action is explicitly represented by a funny function
438 ;;; call or ENTRY node.
440 ;;; We guarantee that CLEANUPs only need to be done at block
441 ;;; boundaries by requiring that the exit ctrans initially head their
442 ;;; blocks, and then by not merging blocks when there is a cleanup
444 (def!struct
(cleanup (:copier nil
))
445 ;; the kind of thing that has to be cleaned up
447 :type
(member :special-bind
:catch
:unwind-protect
448 :block
:tagbody
:dynamic-extent
))
449 ;; the node that messes things up. This is the last node in the
450 ;; non-messed-up environment. Null only temporarily. This could be
451 ;; deleted due to unreachability.
452 (mess-up nil
:type
(or node null
))
453 ;; For all kinds, except :DYNAMIC-EXTENT: a list of all the NLX-INFO
454 ;; structures whose NLX-INFO-CLEANUP is this cleanup. This is filled
455 ;; in by physical environment analysis.
457 ;; For :DYNAMIC-EXTENT: a list of all DX LVARs, preserved by this
458 ;; cleanup. This is filled when the cleanup is created (now by
459 ;; locall call analysis) and is rechecked by physical environment
460 ;; analysis. (For closures this is a list of the allocating node -
461 ;; during IR1, and a list of the argument LVAR of the allocator -
462 ;; after physical environment analysis.)
463 (info nil
:type list
))
464 (defprinter (cleanup :identity t
)
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
)
589 (:include sset-element
(number (incf *compiler-sset-counter
*)))
591 ;; unique ID for debugging
592 #!+sb-show
(id (new-object-id) :read-only t
)
593 ;; (For public access to this slot, use LEAF-SOURCE-NAME.)
595 ;; the name of LEAF as it appears in the source, e.g. 'FOO or '(SETF
596 ;; FOO) or 'N or '*Z*, or the special .ANONYMOUS. value if there's
597 ;; no name for this thing in the source (as can happen for
598 ;; FUNCTIONALs, e.g. for anonymous LAMBDAs or for functions for
599 ;; top-level forms; and can also happen for anonymous constants) or
600 ;; perhaps also if the match between the name and the thing is
601 ;; skewed enough (e.g. for macro functions or method functions) that
602 ;; we don't want to have that name affect compilation
604 ;; (We use .ANONYMOUS. here more or less the way we'd ordinarily use
605 ;; NIL, but we're afraid to use NIL because it's a symbol which could
606 ;; be the name of a leaf, if only the constant named NIL.)
608 ;; The value of this slot in can affect ordinary runtime behavior,
609 ;; e.g. of special variables and known functions, not just debugging.
611 ;; See also the LEAF-DEBUG-NAME function and the
612 ;; FUNCTIONAL-%DEBUG-NAME slot.
613 (%source-name
(missing-arg)
614 :type
(or symbol
(and cons
(satisfies legal-fun-name-p
)))
616 ;; the type which values of this leaf must have
617 (type *universal-type
* :type ctype
)
618 ;; the type which values of this leaf have last been defined to have
619 ;; (but maybe won't have in future, in case of redefinition)
620 (defined-type *universal-type
* :type ctype
)
621 ;; where the TYPE information came from:
622 ;; :DECLARED, from a declaration.
623 ;; :ASSUMED, from uses of the object.
624 ;; :DEFINED, from examination of the definition.
625 ;; :DEFINED-METHOD, implicit, piecemeal declarations from CLOS.
626 ;; FIXME: This should be a named type. (LEAF-WHERE-FROM? Or
627 ;; perhaps just WHERE-FROM, since it's not just used in LEAF,
628 ;; but also in various DEFINE-INFO-TYPEs in globaldb.lisp,
629 ;; and very likely elsewhere too.)
630 (where-from :assumed
:type
(member :declared
:assumed
:defined
:defined-method
))
631 ;; list of the REF nodes for this leaf
633 ;; true if there was ever a REF or SET node for this leaf. This may
634 ;; be true when REFS and SETS are null, since code can be deleted.
635 (ever-used nil
:type boolean
)
636 ;; is it declared dynamic-extent, or truly-dynamic-extent?
637 (dynamic-extent nil
:type
(member nil t
:truly
))
638 ;; some kind of info used by the back end
641 ;;; LEAF name operations
643 ;;; KLUDGE: wants CLOS..
644 (defun leaf-has-source-name-p (leaf)
645 (not (eq (leaf-%source-name leaf
)
647 (defun leaf-source-name (leaf)
648 (aver (leaf-has-source-name-p leaf
))
649 (leaf-%source-name leaf
))
650 (defun leaf-debug-name (leaf)
651 (if (functional-p leaf
)
652 ;; FUNCTIONALs have additional %DEBUG-NAME behavior.
653 (functional-debug-name leaf
)
654 ;; Other objects just use their source name.
656 ;; (As of sbcl-0.pre7.85, there are a few non-FUNCTIONAL
657 ;; anonymous objects, (anonymous constants..) and those would
658 ;; fail here if we ever tried to get debug names from them, but
659 ;; it looks as though it's never interesting to get debug names
660 ;; from them, so it's moot. -- WHN)
661 (leaf-source-name leaf
)))
662 (defun leaf-%debug-name
(leaf)
663 (when (functional-p leaf
)
664 (functional-%debug-name leaf
)))
666 ;;; The CONSTANT structure is used to represent known constant values.
667 ;;; Since the same constant leaf may be shared between named and anonymous
668 ;;; constants, %SOURCE-NAME is never used.
669 (def!struct
(constant (:constructor make-constant
(value
671 (type (ctype-of value
))
672 (%source-name
'.anonymous.
)
673 (where-from :defined
)))
675 ;; the value of the constant
676 (value (missing-arg) :type t
))
677 (defprinter (constant :identity t
)
680 ;;; The BASIC-VAR structure represents information common to all
681 ;;; variables which don't correspond to known local functions.
682 (def!struct
(basic-var (:include leaf
)
684 ;; Lists of the set nodes for this variable.
685 (sets () :type list
))
687 ;;; The GLOBAL-VAR structure represents a value hung off of the symbol
689 (def!struct
(global-var (:include basic-var
))
690 ;; kind of variable described
692 :type
(member :special
:global-function
:global
:unknown
)))
693 (defprinter (global-var :identity t
)
696 (type :test
(not (eq type
*universal-type
*)))
697 (where-from :test
(not (eq where-from
:assumed
)))
700 ;;; A DEFINED-FUN represents a function that is defined in the same
701 ;;; compilation block, or that has an inline expansion, or that has a
702 ;;; non-NIL INLINEP value. Whenever we change the INLINEP state (i.e.
703 ;;; an inline proclamation) we copy the structure so that former
704 ;;; INLINEP values are preserved.
705 (def!struct
(defined-fun (:include global-var
706 (where-from :defined
)
707 (kind :global-function
)))
708 ;; The values of INLINEP and INLINE-EXPANSION initialized from the
709 ;; global environment.
710 (inlinep nil
:type inlinep
)
711 (inline-expansion nil
:type
(or cons null
))
712 ;; List of functionals corresponding to this DEFINED-FUN: either from the
713 ;; conversion of a NAMED-LAMBDA, or from inline-expansion (see
714 ;; RECOGNIZE-KNOWN-CALL) - we need separate functionals for each policy in
715 ;; which the function is used.
716 (functionals nil
:type list
))
717 (defprinter (defined-fun :identity t
)
721 (functionals :test functionals
))
725 ;;; We default the WHERE-FROM and TYPE slots to :DEFINED and FUNCTION.
726 ;;; We don't normally manipulate function types for defined functions,
727 ;;; but if someone wants to know, an approximation is there.
728 (def!struct
(functional (:include leaf
729 (%source-name
'.anonymous.
)
730 (where-from :defined
)
731 (type (specifier-type 'function
))))
732 ;; (For public access to this slot, use LEAF-DEBUG-NAME.)
734 ;; the name of FUNCTIONAL for debugging purposes, or NIL if we
735 ;; should just let the SOURCE-NAME fall through
737 ;; Unlike the SOURCE-NAME slot, this slot's value should never
738 ;; affect ordinary code behavior, only debugging/diagnostic behavior.
740 ;; Ha. Ah, the starry-eyed idealism of the writer of the above
741 ;; paragraph. FUNCTION-LAMBDA-EXPRESSION's behaviour, as of
742 ;; sbcl-0.7.11.x, differs if the name of the a function is a string
743 ;; or not, as if it is a valid function name then it can look for an
746 ;; E.g. for the function which implements (DEFUN FOO ...), we could
750 ;; for the function which implements the top level form
751 ;; (IN-PACKAGE :FOO) we could have
753 ;; %DEBUG-NAME=(TOP-LEVEL-FORM (IN-PACKAGE :FOO)
754 ;; for the function which implements FOO in
755 ;; (DEFUN BAR (...) (FLET ((FOO (...) ...)) ...))
758 ;; %DEBUG-NAME=(FLET FOO)
759 ;; and for the function which implements FOO in
760 ;; (DEFMACRO FOO (...) ...)
762 ;; %SOURCE-NAME=FOO (or maybe .ANONYMOUS.?)
763 ;; %DEBUG-NAME=(MACRO-FUNCTION FOO)
765 :type
(or null
(not (satisfies legal-fun-name-p
)))
767 ;; some information about how this function is used. These values
771 ;; an ordinary function, callable using local call
774 ;; a lambda that is used in only one local call, and has in
775 ;; effect been substituted directly inline. The return node is
776 ;; deleted, and the result is computed with the actual result
777 ;; lvar for the call.
780 ;; Similar to :LET (as per FUNCTIONAL-LETLIKE-P), but the call
784 ;; similar to a LET (as per FUNCTIONAL-SOMEWHAT-LETLIKE-P), but
785 ;; can have other than one call as long as there is at most
786 ;; one non-tail call.
789 ;; a lambda that is an entry point for an OPTIONAL-DISPATCH.
790 ;; Similar to NIL, but requires greater caution, since local call
791 ;; analysis may create new references to this function. Also, the
792 ;; function cannot be deleted even if it has *no* references. The
793 ;; OPTIONAL-DISPATCH is in the LAMDBA-OPTIONAL-DISPATCH.
796 ;; an external entry point lambda. The function it is an entry
797 ;; for is in the ENTRY-FUN slot.
800 ;; a top level lambda, holding a compiled top level form.
801 ;; Compiled very much like NIL, but provides an indication of
802 ;; top level context. A :TOPLEVEL lambda should have *no*
803 ;; references. Its ENTRY-FUN is a self-pointer.
806 ;; After a component is compiled, we clobber any top level code
807 ;; references to its non-closure XEPs with dummy FUNCTIONAL
808 ;; structures having this kind. This prevents the retained
809 ;; top level code from holding onto the IR for the code it
814 ;; special functions used internally by CATCH and UNWIND-PROTECT.
815 ;; These are pretty much like a normal function (NIL), but are
816 ;; treated specially by local call analysis and stuff. Neither
817 ;; kind should ever be given an XEP even though they appear as
818 ;; args to funny functions. An :ESCAPE function is never actually
819 ;; called, and thus doesn't need to have code generated for it.
822 ;; This function has been found to be uncallable, and has been
823 ;; marked for deletion.
826 ;; Effectless [MV-]LET; has no BIND node.
827 (kind nil
:type
(member nil
:optional
:deleted
:external
:toplevel
828 :escape
:cleanup
:let
:mv-let
:assignment
829 :zombie
:toplevel-xep
))
830 ;; Is this a function that some external entity (e.g. the fasl dumper)
831 ;; refers to, so that even when it appears to have no references, it
832 ;; shouldn't be deleted? In the old days (before
833 ;; sbcl-0.pre7.37.flaky5.2) this was sort of implicitly true when
834 ;; KIND was :TOPLEVEL. Now it must be set explicitly, both for
835 ;; :TOPLEVEL functions and for any other kind of functions that we
836 ;; want to dump or return from #'CL:COMPILE or whatever.
837 (has-external-references-p nil
)
838 ;; In a normal function, this is the external entry point (XEP)
839 ;; lambda for this function, if any. Each function that is used
840 ;; other than in a local call has an XEP, and all of the
841 ;; non-local-call references are replaced with references to the
844 ;; In an XEP lambda (indicated by the :EXTERNAL kind), this is the
845 ;; function that the XEP is an entry-point for. The body contains
846 ;; local calls to all the actual entry points in the function. In a
847 ;; :TOPLEVEL lambda (which is its own XEP) this is a self-pointer.
849 ;; With all other kinds, this is null.
850 (entry-fun nil
:type
(or functional null
))
851 ;; the value of any inline/notinline declaration for a local
852 ;; function (or NIL in any case if no inline expansion is available)
853 (inlinep nil
:type inlinep
)
854 ;; If we have a lambda that can be used as in inline expansion for
855 ;; this function, then this is it. If there is no source-level
856 ;; lambda corresponding to this function then this is null (but then
857 ;; INLINEP will always be NIL as well.)
858 (inline-expansion nil
:type list
)
859 ;; the lexical environment that the INLINE-EXPANSION should be converted in
860 (lexenv *lexenv
* :type lexenv
)
861 ;; the original function or macro lambda list, or :UNSPECIFIED if
862 ;; this is a compiler created function
863 (arg-documentation nil
:type
(or list
(member :unspecified
)))
864 ;; the documentation string for the lambda
865 (documentation nil
:type
(or null string
))
866 ;; Node, allocating closure for this lambda. May be NIL when we are
867 ;; sure that no closure is needed.
868 (allocator nil
:type
(or null combination
))
869 ;; various rare miscellaneous info that drives code generation & stuff
870 (plist () :type list
)
871 ;; xref information for this functional (only used for functions with an
874 ;; True if this functional was created from an inline expansion. This
875 ;; is either T, or the GLOBAL-VAR for which it is an expansion.
876 (inline-expanded nil
))
877 (defprinter (functional :identity t
)
882 ;;; Is FUNCTIONAL LET-converted? (where we're indifferent to whether
883 ;;; it returns one value or multiple values)
884 (defun functional-letlike-p (functional)
885 (member (functional-kind functional
)
888 ;;; Is FUNCTIONAL sorta LET-converted? (where even an :ASSIGNMENT counts)
890 ;;; FIXME: I (WHN) don't understand this one well enough to give a good
891 ;;; definition or even a good function name, it's just a literal copy
892 ;;; of a CMU CL idiom. Does anyone have a better name or explanation?
893 (defun functional-somewhat-letlike-p (functional)
894 (or (functional-letlike-p functional
)
895 (eql (functional-kind functional
) :assignment
)))
897 ;;; FUNCTIONAL name operations
898 (defun functional-debug-name (functional)
899 ;; FUNCTIONAL-%DEBUG-NAME takes precedence over FUNCTIONAL-SOURCE-NAME
900 ;; here because we want different debug names for the functions in
901 ;; DEFUN FOO and FLET FOO even though they have the same source name.
902 (or (functional-%debug-name functional
)
903 ;; Note that this will cause an error if the function is
904 ;; anonymous. In SBCL (as opposed to CMU CL) we make all
905 ;; FUNCTIONALs have debug names. The CMU CL code didn't bother
906 ;; in many FUNCTIONALs, especially those which were likely to be
907 ;; optimized away before the user saw them. However, getting
908 ;; that right requires a global understanding of the code,
909 ;; which seems bad, so we just require names for everything.
910 (leaf-source-name functional
)))
912 ;;; The CLAMBDA only deals with required lexical arguments. Special,
913 ;;; optional, keyword and rest arguments are handled by transforming
914 ;;; into simpler stuff.
915 (def!struct
(clambda (:include functional
)
917 (:predicate lambda-p
)
918 (:constructor make-lambda
)
919 (:copier copy-lambda
))
920 ;; list of LAMBDA-VAR descriptors for arguments
921 (vars nil
:type list
:read-only t
)
922 ;; If this function was ever a :OPTIONAL function (an entry-point
923 ;; for an OPTIONAL-DISPATCH), then this is that OPTIONAL-DISPATCH.
924 ;; The optional dispatch will be :DELETED if this function is no
926 (optional-dispatch nil
:type
(or optional-dispatch null
))
927 ;; the BIND node for this LAMBDA. This node marks the beginning of
928 ;; the lambda, and serves to explicitly represent the lambda binding
929 ;; semantics within the flow graph representation. This is null in
930 ;; deleted functions, and also in LETs where we deleted the call and
931 ;; bind (because there are no variables left), but have not yet
932 ;; actually deleted the LAMBDA yet.
933 (bind nil
:type
(or bind null
))
934 ;; the RETURN node for this LAMBDA, or NIL if it has been
935 ;; deleted. This marks the end of the lambda, receiving the result
936 ;; of the body. In a LET, the return node is deleted, and the body
937 ;; delivers the value to the actual lvar. The return may also be
938 ;; deleted if it is unreachable.
939 (return nil
:type
(or creturn null
))
940 ;; If this CLAMBDA is a LET, then this slot holds the LAMBDA whose
941 ;; LETS list we are in, otherwise it is a self-pointer.
942 (home nil
:type
(or clambda null
))
943 ;; all the lambdas that have been LET-substituted in this lambda.
944 ;; This is only non-null in lambdas that aren't LETs.
945 (lets nil
:type list
)
946 ;; all the ENTRY nodes in this function and its LETs, or null in a LET
947 (entries nil
:type list
)
948 ;; CLAMBDAs which are locally called by this lambda, and other
949 ;; objects (closed-over LAMBDA-VARs and XEPs) which this lambda
950 ;; depends on in such a way that DFO shouldn't put them in separate
952 (calls-or-closes (make-sset) :type
(or null sset
))
953 ;; the TAIL-SET that this LAMBDA is in. This is null during creation.
955 ;; In CMU CL, and old SBCL, this was also NILed out when LET
956 ;; conversion happened. That caused some problems, so as of
957 ;; sbcl-0.pre7.37.flaky5.2 when I was trying to get the compiler to
958 ;; emit :EXTERNAL functions directly, and so now the value
959 ;; is no longer NILed out in LET conversion, but instead copied
960 ;; (so that any further optimizations on the rest of the tail
961 ;; set won't modify the value) if necessary.
962 (tail-set nil
:type
(or tail-set null
))
963 ;; the structure which represents the phsical environment that this
964 ;; function's variables are allocated in. This is filled in by
965 ;; physical environment analysis. In a LET, this is EQ to our home's
966 ;; physical environment.
967 (physenv nil
:type
(or physenv null
))
968 ;; In a LET, this is the NODE-LEXENV of the combination node. We
969 ;; retain it so that if the LET is deleted (due to a lack of vars),
970 ;; we will still have caller's lexenv to figure out which cleanup is
972 (call-lexenv nil
:type
(or lexenv null
))
973 ;; list of embedded lambdas
974 (children nil
:type list
)
975 (parent nil
:type
(or clambda null
))
976 (allow-instrumenting *allow-instrumenting
* :type boolean
)
977 ;; True if this is a system introduced lambda: it may contain user code, but
978 ;; the lambda itself is not, and the bindings introduced by it are considered
979 ;; transparent by the nested DX analysis.
980 (system-lambda-p nil
:type boolean
))
981 (defprinter (clambda :conc-name lambda-
:identity t
)
986 (type :test
(not (eq type
*universal-type
*)))
987 (where-from :test
(not (eq where-from
:assumed
)))
988 (vars :prin1
(mapcar #'leaf-source-name vars
)))
990 ;;; The OPTIONAL-DISPATCH leaf is used to represent hairy lambdas. It
991 ;;; is a FUNCTIONAL, like LAMBDA. Each legal number of arguments has a
992 ;;; function which is called when that number of arguments is passed.
993 ;;; The function is called with all the arguments actually passed. If
994 ;;; additional arguments are legal, then the LEXPR style MORE-ENTRY
995 ;;; handles them. The value returned by the function is the value
996 ;;; which results from calling the OPTIONAL-DISPATCH.
998 ;;; The theory is that each entry-point function calls the next entry
999 ;;; point tail-recursively, passing all the arguments passed in and
1000 ;;; the default for the argument the entry point is for. The last
1001 ;;; entry point calls the real body of the function. In the presence
1002 ;;; of SUPPLIED-P args and other hair, things are more complicated. In
1003 ;;; general, there is a distinct internal function that takes the
1004 ;;; SUPPLIED-P args as parameters. The preceding entry point calls
1005 ;;; this function with NIL filled in for the SUPPLIED-P args, while
1006 ;;; the current entry point calls it with T in the SUPPLIED-P
1009 ;;; Note that it is easy to turn a call with a known number of
1010 ;;; arguments into a direct call to the appropriate entry-point
1011 ;;; function, so functions that are compiled together can avoid doing
1013 (def!struct
(optional-dispatch (:include functional
))
1014 ;; the original parsed argument list, for anyone who cares
1015 (arglist nil
:type list
)
1016 ;; true if &ALLOW-OTHER-KEYS was supplied
1017 (allowp nil
:type boolean
)
1018 ;; true if &KEY was specified (which doesn't necessarily mean that
1019 ;; there are any &KEY arguments..)
1020 (keyp nil
:type boolean
)
1021 ;; the number of required arguments. This is the smallest legal
1022 ;; number of arguments.
1023 (min-args 0 :type unsigned-byte
)
1024 ;; the total number of required and optional arguments. Args at
1025 ;; positions >= to this are &REST, &KEY or illegal args.
1026 (max-args 0 :type unsigned-byte
)
1027 ;; list of the (maybe delayed) LAMBDAs which are the entry points
1028 ;; for non-rest, non-key calls. The entry for MIN-ARGS is first,
1029 ;; MIN-ARGS+1 second, ... MAX-ARGS last. The last entry-point always
1030 ;; calls the main entry; in simple cases it may be the main entry.
1031 (entry-points nil
:type list
)
1032 ;; an entry point which takes MAX-ARGS fixed arguments followed by
1033 ;; an argument context pointer and an argument count. This entry
1034 ;; point deals with listifying rest args and parsing keywords. This
1035 ;; is null when extra arguments aren't legal.
1036 (more-entry nil
:type
(or clambda null
))
1037 ;; the main entry-point into the function, which takes all arguments
1038 ;; including keywords as fixed arguments. The format of the
1039 ;; arguments must be determined by examining the arglist. This may
1040 ;; be used by callers that supply at least MAX-ARGS arguments and
1041 ;; know what they are doing.
1042 (main-entry nil
:type
(or clambda null
)))
1043 (defprinter (optional-dispatch :identity t
)
1047 (type :test
(not (eq type
*universal-type
*)))
1048 (where-from :test
(not (eq where-from
:assumed
)))
1054 (entry-points :test entry-points
)
1055 (more-entry :test more-entry
)
1058 ;;; The ARG-INFO structure allows us to tack various information onto
1059 ;;; LAMBDA-VARs during IR1 conversion. If we use one of these things,
1060 ;;; then the var will have to be massaged a bit before it is simple
1062 (def!struct arg-info
1063 ;; true if this arg is to be specially bound
1064 (specialp nil
:type boolean
)
1065 ;; the kind of argument being described. Required args only have arg
1066 ;; info structures if they are special.
1068 :type
(member :required
:optional
:keyword
:rest
1069 :more-context
:more-count
))
1070 ;; If true, this is the VAR for SUPPLIED-P variable of a keyword or
1071 ;; optional arg. This is true for keywords with non-constant
1072 ;; defaults even when there is no user-specified supplied-p var.
1073 (supplied-p nil
:type
(or lambda-var null
))
1074 ;; the default for a keyword or optional, represented as the
1075 ;; original Lisp code. This is set to NIL in &KEY arguments that are
1076 ;; defaulted using the SUPPLIED-P arg.
1077 (default nil
:type t
)
1078 ;; the actual key for a &KEY argument. Note that in ANSI CL this is
1079 ;; not necessarily a keyword: (DEFUN FOO (&KEY ((BAR BAR))) ...).
1080 (key nil
:type symbol
))
1081 (defprinter (arg-info :identity t
)
1082 (specialp :test specialp
)
1084 (supplied-p :test supplied-p
)
1085 (default :test default
)
1088 ;;; The LAMBDA-VAR structure represents a lexical lambda variable.
1089 ;;; This structure is also used during IR1 conversion to describe
1090 ;;; lambda arguments which may ultimately turn out not to be simple
1093 ;;; LAMBDA-VARs with no REFs are considered to be deleted; physical
1094 ;;; environment analysis isn't done on these variables, so the back
1095 ;;; end must check for and ignore unreferenced variables. Note that a
1096 ;;; deleted LAMBDA-VAR may have sets; in this case the back end is
1097 ;;; still responsible for propagating the SET-VALUE to the set's CONT.
1098 (!def-boolean-attribute lambda-var
1099 ;; true if this variable has been declared IGNORE
1101 ;; This is set by physical environment analysis if it chooses an
1102 ;; indirect (value cell) representation for this variable because it
1103 ;; is both set and closed over.
1106 (def!struct
(lambda-var (:include basic-var
))
1107 (flags (lambda-var-attributes)
1109 ;; the CLAMBDA that this var belongs to. This may be null when we are
1110 ;; building a lambda during IR1 conversion.
1111 (home nil
:type
(or null clambda
))
1112 ;; The following two slots are only meaningful during IR1 conversion
1113 ;; of hairy lambda vars:
1115 ;; The ARG-INFO structure which holds information obtained from
1116 ;; &keyword parsing.
1117 (arg-info nil
:type
(or arg-info null
))
1118 ;; if true, the GLOBAL-VAR structure for the special variable which
1119 ;; is to be bound to the value of this argument
1120 (specvar nil
:type
(or global-var null
))
1121 ;; Set of the CONSTRAINTs on this variable. Used by constraint
1122 ;; propagation. This is left null by the lambda pre-pass if it
1123 ;; determine that this is a set closure variable, and is thus not a
1124 ;; good subject for flow analysis.
1125 (constraints nil
:type
(or null t
#| FIXME
: conset |
#))
1126 ;; Initial type of a LET variable as last seen by PROPAGATE-FROM-SETS.
1127 (last-initial-type *universal-type
* :type ctype
)
1128 ;; The FOP handle of the lexical variable represented by LAMBDA-VAR
1129 ;; in the fopcompiler.
1131 (defprinter (lambda-var :identity t
)
1134 (type :test
(not (eq type
*universal-type
*)))
1135 (where-from :test
(not (eq where-from
:assumed
)))
1136 (flags :test
(not (zerop flags
))
1137 :prin1
(decode-lambda-var-attributes flags
))
1138 (arg-info :test arg-info
)
1139 (specvar :test specvar
))
1141 (defmacro lambda-var-ignorep
(var)
1142 `(lambda-var-attributep (lambda-var-flags ,var
) ignore
))
1143 (defmacro lambda-var-indirect
(var)
1144 `(lambda-var-attributep (lambda-var-flags ,var
) indirect
))
1146 ;;;; basic node types
1148 ;;; A REF represents a reference to a LEAF. REF-REOPTIMIZE is
1149 ;;; initially (and forever) NIL, since REFs don't receive any values
1150 ;;; and don't have any IR1 optimizer.
1151 (def!struct
(ref (:include valued-node
(reoptimize nil
))
1152 (:constructor make-ref
1154 &optional
(%source-name
'.anonymous.
)
1155 &aux
(leaf-type (leaf-type leaf
))
1157 (make-single-value-type leaf-type
))))
1159 ;; The leaf referenced.
1160 (leaf nil
:type leaf
)
1161 ;; CONSTANT nodes are always anonymous, since we wish to coalesce named and
1162 ;; unnamed constants that are equivalent, we need to keep track of the
1163 ;; reference name for XREF.
1164 (%source-name
(missing-arg) :type symbol
:read-only t
))
1165 (defprinter (ref :identity t
)
1167 (%source-name
:test
(neq %source-name
'.anonymous.
))
1170 ;;; Naturally, the IF node always appears at the end of a block.
1171 (def!struct
(cif (:include node
)
1174 (:constructor make-if
)
1176 ;; LVAR for the predicate
1177 (test (missing-arg) :type lvar
)
1178 ;; the blocks that we execute next in true and false case,
1179 ;; respectively (may be the same)
1180 (consequent (missing-arg) :type cblock
)
1181 (consequent-constraints nil
:type
(or null t
#| FIXME
: conset |
#))
1182 (alternative (missing-arg) :type cblock
)
1183 (alternative-constraints nil
:type
(or null t
#| FIXME
: conset |
#)))
1184 (defprinter (cif :conc-name if-
:identity t
)
1185 (test :prin1
(lvar-uses test
))
1189 (def!struct
(cset (:include valued-node
1190 (derived-type (make-single-value-type
1194 (:constructor make-set
)
1196 ;; descriptor for the variable set
1197 (var (missing-arg) :type basic-var
)
1198 ;; LVAR for the value form
1199 (value (missing-arg) :type lvar
))
1200 (defprinter (cset :conc-name set-
:identity t
)
1202 (value :prin1
(lvar-uses value
)))
1204 ;;; The BASIC-COMBINATION structure is used to represent both normal
1205 ;;; and multiple value combinations. In a let-like function call, this
1206 ;;; node appears at the end of its block and the body of the called
1207 ;;; function appears as the successor; the NODE-LVAR is null.
1208 (def!struct
(basic-combination (:include valued-node
)
1211 ;; LVAR for the function
1212 (fun (missing-arg) :type lvar
)
1213 ;; list of LVARs for the args. In a local call, an argument lvar may
1214 ;; be replaced with NIL to indicate that the corresponding variable
1215 ;; is unreferenced, and thus no argument value need be passed.
1216 (args nil
:type list
)
1217 ;; the kind of function call being made. :LOCAL means that this is a
1218 ;; local call to a function in the same component, and that argument
1219 ;; syntax checking has been done, etc. Calls to known global
1220 ;; functions are represented by storing :KNOWN in this slot and the
1221 ;; FUN-INFO for that function in the FUN-INFO slot. :FULL is a call
1222 ;; to an (as yet) unknown function, or to a known function declared
1223 ;; NOTINLINE. :ERROR is like :FULL, but means that we have
1224 ;; discovered that the call contains an error, and should not be
1225 ;; reconsidered for optimization.
1226 (kind :full
:type
(member :local
:full
:error
:known
))
1227 ;; if a call to a known global function, contains the FUN-INFO.
1228 (fun-info nil
:type
(or fun-info null
))
1229 ;; some kind of information attached to this node by the back end
1233 ;;; The COMBINATION node represents all normal function calls,
1234 ;;; including FUNCALL. This is distinct from BASIC-COMBINATION so that
1235 ;;; an MV-COMBINATION isn't COMBINATION-P.
1236 (def!struct
(combination (:include basic-combination
)
1237 (:constructor make-combination
(fun))
1239 (defprinter (combination :identity t
)
1241 (fun :prin1
(lvar-uses fun
))
1242 (args :prin1
(mapcar (lambda (x)
1248 ;;; An MV-COMBINATION is to MULTIPLE-VALUE-CALL as a COMBINATION is to
1249 ;;; FUNCALL. This is used to implement all the multiple-value
1250 ;;; receiving forms.
1251 (def!struct
(mv-combination (:include basic-combination
)
1252 (:constructor make-mv-combination
(fun))
1254 (defprinter (mv-combination)
1255 (fun :prin1
(lvar-uses fun
))
1256 (args :prin1
(mapcar #'lvar-uses args
)))
1258 ;;; The BIND node marks the beginning of a lambda body and represents
1259 ;;; the creation and initialization of the variables.
1260 (def!struct
(bind (:include node
)
1262 ;; the lambda we are binding variables for. Null when we are
1263 ;; creating the LAMBDA during IR1 translation.
1264 (lambda nil
:type
(or clambda null
)))
1268 ;;; The RETURN node marks the end of a lambda body. It collects the
1269 ;;; return values and represents the control transfer on return. This
1270 ;;; is also where we stick information used for TAIL-SET type
1272 (def!struct
(creturn (:include node
)
1273 (:conc-name return-
)
1274 (:predicate return-p
)
1275 (:constructor make-return
)
1276 (:copier copy-return
))
1277 ;; the lambda we are returning from. Null temporarily during
1279 (lambda nil
:type
(or clambda null
))
1280 ;; the lvar which yields the value of the lambda
1281 (result (missing-arg) :type lvar
)
1282 ;; the union of the node-derived-type of all uses of the result
1283 ;; other than by a local call, intersected with the result's
1284 ;; asserted-type. If there are no non-call uses, this is
1286 (result-type *wild-type
* :type ctype
))
1287 (defprinter (creturn :conc-name return-
:identity t
)
1291 ;;; The CAST node represents type assertions. The check for
1292 ;;; TYPE-TO-CHECK is performed and then the VALUE is declared to be of
1293 ;;; type ASSERTED-TYPE.
1294 (def!struct
(cast (:include valued-node
)
1295 (:constructor %make-cast
))
1296 (asserted-type (missing-arg) :type ctype
)
1297 (type-to-check (missing-arg) :type ctype
)
1298 ;; an indication of what we have proven about how this type
1299 ;; assertion is satisfied:
1302 ;; No type check is necessary (VALUE type is a subtype of the TYPE-TO-CHECK.)
1305 ;; Type check will be performed by NODE-DEST.
1308 ;; A type check is needed.
1309 (%type-check t
:type
(member t
:external nil
))
1310 ;; the lvar which is checked
1311 (value (missing-arg) :type lvar
))
1312 (defprinter (cast :identity t
)
1318 ;;;; non-local exit support
1320 ;;;; In IR1, we insert special nodes to mark potentially non-local
1323 ;;; The ENTRY node serves to mark the start of the dynamic extent of a
1324 ;;; lexical exit. It is the mess-up node for the corresponding :ENTRY
1326 (def!struct
(entry (:include node
)
1328 ;; All of the EXIT nodes for potential non-local exits to this point.
1329 (exits nil
:type list
)
1330 ;; The cleanup for this entry. NULL only temporarily.
1331 (cleanup nil
:type
(or cleanup null
)))
1332 (defprinter (entry :identity t
)
1335 ;;; The EXIT node marks the place at which exit code would be emitted,
1336 ;;; if necessary. This is interposed between the uses of the exit
1337 ;;; continuation and the exit continuation's DEST. Instead of using
1338 ;;; the returned value being delivered directly to the exit
1339 ;;; continuation, it is delivered to our VALUE lvar. The original exit
1340 ;;; lvar is the exit node's LVAR; physenv analysis also makes it the
1341 ;;; lvar of %NLX-ENTRY call.
1342 (def!struct
(exit (:include valued-node
)
1344 ;; the ENTRY node that this is an exit for. If null, this is a
1345 ;; degenerate exit. A degenerate exit is used to "fill" an empty
1346 ;; block (which isn't allowed in IR1.) In a degenerate exit, Value
1347 ;; is always also null.
1348 (entry nil
:type
(or entry null
))
1349 ;; the lvar yielding the value we are to exit with. If NIL, then no
1350 ;; value is desired (as in GO).
1351 (value nil
:type
(or lvar null
))
1352 (nlx-info nil
:type
(or nlx-info null
)))
1353 (defprinter (exit :identity t
)
1356 (value :test value
))
1358 ;;;; miscellaneous IR1 structures
1360 (def!struct
(undefined-warning
1361 #-no-ansi-print-object
1362 (:print-object
(lambda (x s
)
1363 (print-unreadable-object (x s
:type t
)
1364 (prin1 (undefined-warning-name x
) s
))))
1366 ;; the name of the unknown thing
1367 (name nil
:type
(or symbol list
))
1368 ;; the kind of reference to NAME
1369 (kind (missing-arg) :type
(member :function
:type
:variable
))
1370 ;; the number of times this thing was used
1371 (count 0 :type unsigned-byte
)
1372 ;; a list of COMPILER-ERROR-CONTEXT structures describing places
1373 ;; where this thing was used. Note that we only record the first
1374 ;; *UNDEFINED-WARNING-LIMIT* calls.
1375 (warnings () :type list
))
1377 ;;; a helper for the POLICY macro, defined late here so that the
1378 ;;; various type tests can be inlined
1379 (declaim (ftype (function ((or list lexenv node functional
)) list
)
1381 (defun %coerce-to-policy
(thing)
1382 (let ((result (etypecase thing
1384 (lexenv (lexenv-policy thing
))
1385 (node (lexenv-policy (node-lexenv thing
)))
1386 (functional (lexenv-policy (functional-lexenv thing
))))))
1387 ;; Test the first element of the list as a rudimentary sanity
1388 ;; that it really does look like a valid policy.
1389 (aver (or (null result
) (policy-quality-name-p (caar result
))))
1393 ;;;; Freeze some structure types to speed type testing.
1396 (declaim (freeze-type node leaf lexenv ctran lvar cblock component cleanup
1397 physenv tail-set nlx-info
))