1.0.0.18:
[sbcl.git] / src / compiler / node.lisp
1 ;;;; structures for the first intermediate representation in the
2 ;;;; compiler, IR1
3
4 ;;;; This software is part of the SBCL system. See the README file for
5 ;;;; more information.
6 ;;;;
7 ;;;; This software is derived from the CMU CL system, which was
8 ;;;; written at Carnegie Mellon University and released into the
9 ;;;; public domain. The software is in the public domain and is
10 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
11 ;;;; files for more information.
12
13 (in-package "SB!C")
14
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.
22
23 ;;; "Lead-in" Control TRANsfer [to some node]
24 (def!struct (ctran
25              (:make-load-form-fun ignore-it)
26              (:constructor make-ctran))
27   ;; an indication of the way that this continuation is currently used
28   ;;
29   ;; :UNUSED
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.
37   ;;
38   ;; :BLOCK-START
39   ;;    The continuation that is the START of BLOCK.
40   ;;
41   ;; :INSIDE-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)))
53
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))))
57
58 ;;; Linear VARiable. Multiple-value (possibly of unknown number)
59 ;;; temporal storage.
60 (def!struct (lvar
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
82   (info nil))
83
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))))
87
88 (def!struct (node (:constructor nil)
89                   (:copier 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
94   ;; is this node.
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
106   ;; this node
107   ;;
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
112   ;; of the list.
113   ;;
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.
120   ;;
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 ...)))
124   ;;
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.
134   ;;
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))
138
139 (def!struct (valued-node (:conc-name node-)
140                          (:include node)
141                          (:constructor nil)
142                          (:copier nil))
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)))
148
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)
174
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))))
180   (frob reoptimize)
181   (frob flush-p)
182   (frob type-check)
183   (frob delete-p)
184   (frob type-asserted)
185   (frob test-modified))
186
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)
197                     (:conc-name block-)
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
209   ;; and tail blocks)
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
213   ;; tail blocks.)
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
221                            test-modified)
222          :type attributes)
223   ;; in constraint propagation: list of LAMBDA-VARs killed in this block
224   ;; in copy propagation: list of killed TNs
225   (kill nil)
226   ;; other sets used in constraint propagation and/or copy propagation
227   (gen nil)
228   (in nil)
229   (out nil)
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
239   (component (progn
240                (aver-live-component *current-component*)
241                *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.
247   (flag nil)
248   ;; some kind of info used by the back end
249   (info nil)
250   ;; what macroexpansions happened "in" this block, used for xref
251   (macroexpands nil :type list))
252 (def!method print-object ((cblock cblock) stream)
253   (print-unreadable-object (cblock stream :type t :identity t)
254     (format stream "~W :START c~W"
255             (block-number cblock)
256             (cont-num (block-start cblock)))))
257
258 ;;; The BLOCK-ANNOTATION class is inherited (via :INCLUDE) by
259 ;;; different BLOCK-INFO annotation structures so that code
260 ;;; (specifically control analysis) can be shared.
261 (def!struct (block-annotation (:constructor nil)
262                               (:copier nil))
263   ;; The IR1 block that this block is in the INFO for.
264   (block (missing-arg) :type cblock)
265   ;; the next and previous block in emission order (not DFO). This
266   ;; determines which block we drop though to, and is also used to
267   ;; chain together overflow blocks that result from splitting of IR2
268   ;; blocks in lifetime analysis.
269   (next nil :type (or block-annotation null))
270   (prev nil :type (or block-annotation null)))
271
272 ;;; A COMPONENT structure provides a handle on a connected piece of
273 ;;; the flow graph. Most of the passes in the compiler operate on
274 ;;; COMPONENTs rather than on the entire flow graph.
275 ;;;
276 ;;; According to the CMU CL internals/front.tex, the reason for
277 ;;; separating compilation into COMPONENTs is
278 ;;;   to increase the efficiency of large block compilations. In
279 ;;;   addition to improving locality of reference and reducing the
280 ;;;   size of flow analysis problems, this allows back-end data
281 ;;;   structures to be reclaimed after the compilation of each
282 ;;;   component.
283 (def!struct (component (:copier nil)
284                        (:constructor
285                         make-component
286                         (head
287                          tail &aux
288                          (last-block tail)
289                          (outer-loop (make-loop :kind :outer :head head)))))
290   ;; unique ID for debugging
291   #!+sb-show (id (new-object-id) :read-only t)
292   ;; the kind of component
293   ;;
294   ;; (The terminology here is left over from before
295   ;; sbcl-0.pre7.34.flaky5.2, when there was no such thing as
296   ;; FUNCTIONAL-HAS-EXTERNAL-REFERENCES-P, so that Python was
297   ;; incapable of building standalone :EXTERNAL functions, but instead
298   ;; had to implement things like #'CL:COMPILE as FUNCALL of a little
299   ;; toplevel stub whose sole purpose was to return an :EXTERNAL
300   ;; function.)
301   ;;
302   ;; The possibilities are:
303   ;;   NIL
304   ;;     an ordinary component, containing non-top-level code
305   ;;   :TOPLEVEL
306   ;;     a component containing only load-time code
307   ;;   :COMPLEX-TOPLEVEL
308   ;;     In the old system, before FUNCTIONAL-HAS-EXTERNAL-REFERENCES-P
309   ;;     was defined, this was necessarily a component containing both
310   ;;     top level and run-time code. Now this state is also used for
311   ;;     a component with HAS-EXTERNAL-REFERENCES-P functionals in it.
312   ;;   :INITIAL
313   ;;     the result of initial IR1 conversion, on which component
314   ;;     analysis has not been done
315   ;;   :DELETED
316   ;;     debris left over from component analysis
317   ;;
318   ;; See also COMPONENT-TOPLEVELISH-P.
319   (kind nil :type (member nil :toplevel :complex-toplevel :initial :deleted))
320   ;; the blocks that are the dummy head and tail of the DFO
321   ;;
322   ;; Entry/exit points have these blocks as their
323   ;; predecessors/successors. The start and return from each
324   ;; non-deleted function is linked to the component head and
325   ;; tail. Until physical environment analysis links NLX entry stubs
326   ;; to the component head, every successor of the head is a function
327   ;; start (i.e. begins with a BIND node.)
328   (head (missing-arg) :type cblock)
329   (tail (missing-arg) :type cblock)
330   ;; New blocks are inserted before this.
331   (last-block (missing-arg) :type cblock)
332   ;; This becomes a list of the CLAMBDA structures for all functions
333   ;; in this component. OPTIONAL-DISPATCHes are represented only by
334   ;; their XEP and other associated lambdas. This doesn't contain any
335   ;; deleted or LET lambdas.
336   ;;
337   ;; Note that logical associations between CLAMBDAs and COMPONENTs
338   ;; seem to exist for a while before this is initialized. See e.g.
339   ;; the NEW-FUNCTIONALS slot. In particular, I got burned by writing
340   ;; some code to use this value to decide which components need
341   ;; LOCALL-ANALYZE-COMPONENT, when it turns out that
342   ;; LOCALL-ANALYZE-COMPONENT had a role in initializing this value
343   ;; (and DFO stuff does too, maybe). Also, even after it's
344   ;; initialized, it might change as CLAMBDAs are deleted or merged.
345   ;; -- WHN 2001-09-30
346   (lambdas () :type list)
347   ;; a list of FUNCTIONALs for functions that are newly converted, and
348   ;; haven't been local-call analyzed yet. Initially functions are not
349   ;; in the LAMBDAS list. Local call analysis moves them there
350   ;; (possibly as LETs, or implicitly as XEPs if an OPTIONAL-DISPATCH.)
351   ;; Between runs of local call analysis there may be some debris of
352   ;; converted or even deleted functions in this list.
353   (new-functionals () :type list)
354   ;; If this is :MAYBE, then there is stuff in this component that
355   ;; could benefit from further IR1 optimization. T means that
356   ;; reoptimization is necessary.
357   (reoptimize t :type (member nil :maybe t))
358   ;; If this is true, then the control flow in this component was
359   ;; messed up by IR1 optimizations, so the DFO should be recomputed.
360   (reanalyze nil :type boolean)
361   ;; some sort of name for the code in this component
362   (name "<unknown>" :type t)
363   ;; When I am a child, this is :NO-IR2-YET.
364   ;; In my adulthood, IR2 stores notes to itself here.
365   ;; After I have left the great wheel and am staring into the GC, this
366   ;;   is set to :DEAD to indicate that it's a gruesome error to operate
367   ;;   on me (e.g. by using me as *CURRENT-COMPONENT*, or by pushing
368   ;;   LAMBDAs onto my NEW-FUNCTIONALS, as in sbcl-0.pre7.115).
369   (info :no-ir2-yet :type (or ir2-component (member :no-ir2-yet :dead)))
370   ;; the SOURCE-INFO structure describing where this component was
371   ;; compiled from
372   (source-info *source-info* :type source-info)
373   ;; count of the number of inline expansions we have done while
374   ;; compiling this component, to detect infinite or exponential
375   ;; blowups
376   (inline-expansions 0 :type index)
377   ;; a map from combination nodes to things describing how an
378   ;; optimization of the node failed. The description is an alist
379   ;; (TRANSFORM . ARGS), where TRANSFORM is the structure describing
380   ;; the transform that failed, and ARGS is either a list of format
381   ;; arguments for the note, or the FUN-TYPE that would have
382   ;; enabled the transformation but failed to match.
383   (failed-optimizations (make-hash-table :test 'eq) :type hash-table)
384   ;; This is similar to NEW-FUNCTIONALS, but is used when a function
385   ;; has already been analyzed, but new references have been added by
386   ;; inline expansion. Unlike NEW-FUNCTIONALS, this is not disjoint
387   ;; from COMPONENT-LAMBDAS.
388   (reanalyze-functionals nil :type list)
389   (delete-blocks nil :type list)
390   (nlx-info-generated-p nil :type boolean)
391   ;; this is filled by physical environment analysis
392   (dx-lvars nil :type list)
393   ;; The default LOOP in the component.
394   (outer-loop (missing-arg) :type cloop))
395 (defprinter (component :identity t)
396   name
397   #!+sb-show id
398   (reanalyze :test reanalyze))
399
400 ;;; Check that COMPONENT is suitable for roles which involve adding
401 ;;; new code. (gotta love imperative programming with lotso in-place
402 ;;; side effects...)
403 (defun aver-live-component (component)
404   ;; FIXME: As of sbcl-0.pre7.115, we're asserting that
405   ;; COMPILE-COMPONENT hasn't happened yet. Might it be even better
406   ;; (certainly stricter, possibly also correct...) to assert that
407   ;; IR1-FINALIZE hasn't happened yet?
408   (aver (not (eql (component-info component) :dead))))
409
410 ;;; Before sbcl-0.7.0, there were :TOPLEVEL things which were magical
411 ;;; in multiple ways. That's since been refactored into the orthogonal
412 ;;; properties "optimized for locall with no arguments" and "externally
413 ;;; visible/referenced (so don't delete it)". The code <0.7.0 did a lot
414 ;;; of tests a la (EQ KIND :TOP_LEVEL) in the "don't delete it?" sense;
415 ;;; this function is a sort of literal translation of those tests into
416 ;;; the new world.
417 ;;;
418 ;;; FIXME: After things settle down, bare :TOPLEVEL might go away, at
419 ;;; which time it might be possible to replace the COMPONENT-KIND
420 ;;; :TOPLEVEL mess with a flag COMPONENT-HAS-EXTERNAL-REFERENCES-P
421 ;;; along the lines of FUNCTIONAL-HAS-EXTERNAL-REFERENCES-P.
422 (defun lambda-toplevelish-p (clambda)
423   (or (eql (lambda-kind clambda) :toplevel)
424       (lambda-has-external-references-p clambda)))
425 (defun component-toplevelish-p (component)
426   (member (component-kind component)
427           '(:toplevel :complex-toplevel)))
428
429 ;;; A CLEANUP structure represents some dynamic binding action. Blocks
430 ;;; are annotated with the current CLEANUP so that dynamic bindings
431 ;;; can be removed when control is transferred out of the binding
432 ;;; environment. We arrange for changes in dynamic bindings to happen
433 ;;; at block boundaries, so that cleanup code may easily be inserted.
434 ;;; The "mess-up" action is explicitly represented by a funny function
435 ;;; call or ENTRY node.
436 ;;;
437 ;;; We guarantee that CLEANUPs only need to be done at block
438 ;;; boundaries by requiring that the exit ctrans initially head their
439 ;;; blocks, and then by not merging blocks when there is a cleanup
440 ;;; change.
441 (def!struct (cleanup (:copier nil))
442   ;; the kind of thing that has to be cleaned up
443   (kind (missing-arg)
444         :type (member :special-bind :catch :unwind-protect
445                       :block :tagbody :dynamic-extent))
446   ;; the node that messes things up. This is the last node in the
447   ;; non-messed-up environment. Null only temporarily. This could be
448   ;; deleted due to unreachability.
449   (mess-up nil :type (or node null))
450   ;; For all kinds, except :DYNAMIC-EXTENT: a list of all the NLX-INFO
451   ;; structures whose NLX-INFO-CLEANUP is this cleanup. This is filled
452   ;; in by physical environment analysis.
453   ;;
454   ;; For :DYNAMIC-EXTENT: a list of all DX LVARs, preserved by this
455   ;; cleanup. This is filled when the cleanup is created (now by
456   ;; locall call analysis) and is rechecked by physical environment
457   ;; analysis. (For closures this is a list of the allocating node -
458   ;; during IR1, and a list of the argument LVAR of the allocator -
459   ;; after physical environment analysis.)
460   (info nil :type list))
461 (defprinter (cleanup :identity t)
462   kind
463   mess-up
464   (info :test info))
465 (defmacro cleanup-nlx-info (cleanup)
466   `(cleanup-info ,cleanup))
467
468 ;;; A PHYSENV represents the result of physical environment analysis.
469 ;;;
470 ;;; As far as I can tell from reverse engineering, this IR1 structure
471 ;;; represents the physical environment (which is probably not the
472 ;;; standard Lispy term for this concept, but I dunno what is the
473 ;;; standard term): those things in the lexical environment which a
474 ;;; LAMBDA actually interacts with. Thus in
475 ;;;   (DEFUN FROB-THINGS (THINGS)
476 ;;;     (DOLIST (THING THINGS)
477 ;;;       (BLOCK FROBBING-ONE-THING
478 ;;;         (MAPCAR (LAMBDA (PATTERN)
479 ;;;                   (WHEN (FITS-P THING PATTERN)
480 ;;;                     (RETURN-FROM FROB-THINGS (LIST :FIT THING PATTERN))))
481 ;;;                 *PATTERNS*))))
482 ;;; the variables THINGS, THING, and PATTERN and the block names
483 ;;; FROB-THINGS and FROBBING-ONE-THING are all in the inner LAMBDA's
484 ;;; lexical environment, but of those only THING, PATTERN, and
485 ;;; FROB-THINGS are in its physical environment. In IR1, we largely
486 ;;; just collect the names of these things; in IR2 an IR2-PHYSENV
487 ;;; structure is attached to INFO and used to keep track of
488 ;;; associations between these names and less-abstract things (like
489 ;;; TNs, or eventually stack slots and registers). -- WHN 2001-09-29
490 (def!struct (physenv (:copier nil))
491   ;; the function that allocates this physical environment
492   (lambda (missing-arg) :type clambda :read-only t)
493   ;; This ultimately converges to a list of all the LAMBDA-VARs and
494   ;; NLX-INFOs needed from enclosing environments by code in this
495   ;; physical environment. In the meantime, it may be
496   ;;   * NIL at object creation time
497   ;;   * a superset of the correct result, generated somewhat later
498   ;;   * smaller and smaller sets converging to the correct result as
499   ;;     we notice and delete unused elements in the superset
500   (closure nil :type list)
501   ;; a list of NLX-INFO structures describing all the non-local exits
502   ;; into this physical environment
503   (nlx-info nil :type list)
504   ;; some kind of info used by the back end
505   (info nil))
506 (defprinter (physenv :identity t)
507   lambda
508   (closure :test closure)
509   (nlx-info :test nlx-info))
510
511 ;;; An TAIL-SET structure is used to accumulate information about
512 ;;; tail-recursive local calls. The "tail set" is effectively the
513 ;;; transitive closure of the "is called tail-recursively by"
514 ;;; relation.
515 ;;;
516 ;;; All functions in the same tail set share the same TAIL-SET
517 ;;; structure. Initially each function has its own TAIL-SET, but when
518 ;;; IR1-OPTIMIZE-RETURN notices a tail local call, it joins the tail
519 ;;; sets of the called function and the calling function.
520 ;;;
521 ;;; The tail set is somewhat approximate, because it is too early to
522 ;;; be sure which calls will be tail-recursive. Any call that *might*
523 ;;; end up tail-recursive causes TAIL-SET merging.
524 (def!struct (tail-set)
525   ;; a list of all the LAMBDAs in this tail set
526   (funs nil :type list)
527   ;; our current best guess of the type returned by these functions.
528   ;; This is the union across all the functions of the return node's
529   ;; RESULT-TYPE, excluding local calls.
530   (type *wild-type* :type ctype)
531   ;; some info used by the back end
532   (info nil))
533 (defprinter (tail-set :identity t)
534   funs
535   type
536   (info :test info))
537
538 ;;; An NLX-INFO structure is used to collect various information about
539 ;;; non-local exits. This is effectively an annotation on the
540 ;;; continuation, although it is accessed by searching in the
541 ;;; PHYSENV-NLX-INFO.
542 (def!struct (nlx-info
543              (:constructor make-nlx-info (cleanup
544                                           exit
545                                           &aux
546                                           (block (first (block-succ
547                                                          (node-block exit))))))
548              (:make-load-form-fun ignore-it))
549   ;; the cleanup associated with this exit. In a catch or
550   ;; unwind-protect, this is the :CATCH or :UNWIND-PROTECT cleanup,
551   ;; and not the cleanup for the escape block. The CLEANUP-KIND of
552   ;; this thus provides a good indication of what kind of exit is
553   ;; being done.
554   (cleanup (missing-arg) :type cleanup)
555   ;; the ``continuation'' exited to (the block, succeeding the EXIT
556   ;; nodes). If this exit is from an escape function (CATCH or
557   ;; UNWIND-PROTECT), then physical environment analysis deletes the
558   ;; escape function and instead has the %NLX-ENTRY use this
559   ;; continuation.
560   ;;
561   ;; This slot is used as a sort of name to allow us to find the
562   ;; NLX-INFO that corresponds to a given exit. For this purpose, the
563   ;; ENTRY must also be used to disambiguate, since exits to different
564   ;; places may deliver their result to the same continuation.
565   (block (missing-arg) :type cblock)
566   ;; the entry stub inserted by physical environment analysis. This is
567   ;; a block containing a call to the %NLX-ENTRY funny function that
568   ;; has the original exit destination as its successor. Null only
569   ;; temporarily.
570   (target nil :type (or cblock null))
571   ;; for a lexical exit it determines whether tag existence check is
572   ;; needed
573   (safe-p nil :type boolean)
574   ;; some kind of info used by the back end
575   info)
576 (defprinter (nlx-info :identity t)
577   block
578   target
579   info)
580 \f
581 ;;;; LEAF structures
582
583 ;;; Variables, constants and functions are all represented by LEAF
584 ;;; structures. A reference to a LEAF is indicated by a REF node. This
585 ;;; allows us to easily substitute one for the other without actually
586 ;;; hacking the flow graph.
587 (def!struct (leaf (:make-load-form-fun ignore-it)
588                   (:constructor nil))
589   ;; unique ID for debugging
590   #!+sb-show (id (new-object-id) :read-only t)
591   ;; (For public access to this slot, use LEAF-SOURCE-NAME.)
592   ;;
593   ;; the name of LEAF as it appears in the source, e.g. 'FOO or '(SETF
594   ;; FOO) or 'N or '*Z*, or the special .ANONYMOUS. value if there's
595   ;; no name for this thing in the source (as can happen for
596   ;; FUNCTIONALs, e.g. for anonymous LAMBDAs or for functions for
597   ;; top-level forms; and can also happen for anonymous constants) or
598   ;; perhaps also if the match between the name and the thing is
599   ;; skewed enough (e.g. for macro functions or method functions) that
600   ;; we don't want to have that name affect compilation
601   ;;
602   ;; (We use .ANONYMOUS. here more or less the way we'd ordinarily use
603   ;; NIL, but we're afraid to use NIL because it's a symbol which could
604   ;; be the name of a leaf, if only the constant named NIL.)
605   ;;
606   ;; The value of this slot in can affect ordinary runtime behavior,
607   ;; e.g. of special variables and known functions, not just debugging.
608   ;;
609   ;; See also the LEAF-DEBUG-NAME function and the
610   ;; FUNCTIONAL-%DEBUG-NAME slot.
611   (%source-name (missing-arg)
612                 :type (or symbol (and cons (satisfies legal-fun-name-p)))
613                 :read-only t)
614   ;; the type which values of this leaf must have
615   (type *universal-type* :type ctype)
616   ;; where the TYPE information came from:
617   ;;  :DECLARED, from a declaration.
618   ;;  :ASSUMED, from uses of the object.
619   ;;  :DEFINED, from examination of the definition.
620   ;; FIXME: This should be a named type. (LEAF-WHERE-FROM? Or
621   ;; perhaps just WHERE-FROM, since it's not just used in LEAF,
622   ;; but also in various DEFINE-INFO-TYPEs in globaldb.lisp,
623   ;; and very likely elsewhere too.)
624   (where-from :assumed :type (member :declared :assumed :defined))
625   ;; list of the REF nodes for this leaf
626   (refs () :type list)
627   ;; true if there was ever a REF or SET node for this leaf. This may
628   ;; be true when REFS and SETS are null, since code can be deleted.
629   (ever-used nil :type boolean)
630   ;; is it declared dynamic-extent?
631   (dynamic-extent nil :type boolean)
632   ;; some kind of info used by the back end
633   (info nil))
634
635 ;;; LEAF name operations
636 ;;;
637 ;;; KLUDGE: wants CLOS..
638 (defun leaf-has-source-name-p (leaf)
639   (not (eq (leaf-%source-name leaf)
640            '.anonymous.)))
641 (defun leaf-source-name (leaf)
642   (aver (leaf-has-source-name-p leaf))
643   (leaf-%source-name leaf))
644 (defun leaf-debug-name (leaf)
645   (if (functional-p leaf)
646       ;; FUNCTIONALs have additional %DEBUG-NAME behavior.
647       (functional-debug-name leaf)
648       ;; Other objects just use their source name.
649       ;;
650       ;; (As of sbcl-0.pre7.85, there are a few non-FUNCTIONAL
651       ;; anonymous objects, (anonymous constants..) and those would
652       ;; fail here if we ever tried to get debug names from them, but
653       ;; it looks as though it's never interesting to get debug names
654       ;; from them, so it's moot. -- WHN)
655       (leaf-source-name leaf)))
656
657 ;;; The CONSTANT structure is used to represent known constant values.
658 ;;; If NAME is not null, then it is the name of the named constant
659 ;;; which this leaf corresponds to, otherwise this is an anonymous
660 ;;; constant.
661 (def!struct (constant (:include leaf))
662   ;; the value of the constant
663   (value nil :type t))
664 (defprinter (constant :identity t)
665   (%source-name :test %source-name)
666   value)
667
668 ;;; The BASIC-VAR structure represents information common to all
669 ;;; variables which don't correspond to known local functions.
670 (def!struct (basic-var (:include leaf)
671                        (:constructor nil))
672   ;; Lists of the set nodes for this variable.
673   (sets () :type list))
674
675 ;;; The GLOBAL-VAR structure represents a value hung off of the symbol
676 ;;; NAME.
677 (def!struct (global-var (:include basic-var))
678   ;; kind of variable described
679   (kind (missing-arg)
680         :type (member :special :global-function :global)))
681 (defprinter (global-var :identity t)
682   %source-name
683   #!+sb-show id
684   (type :test (not (eq type *universal-type*)))
685   (where-from :test (not (eq where-from :assumed)))
686   kind)
687
688 ;;; A DEFINED-FUN represents a function that is defined in the same
689 ;;; compilation block, or that has an inline expansion, or that has a
690 ;;; non-NIL INLINEP value. Whenever we change the INLINEP state (i.e.
691 ;;; an inline proclamation) we copy the structure so that former
692 ;;; INLINEP values are preserved.
693 (def!struct (defined-fun (:include global-var
694                                    (where-from :defined)
695                                    (kind :global-function)))
696   ;; The values of INLINEP and INLINE-EXPANSION initialized from the
697   ;; global environment.
698   (inlinep nil :type inlinep)
699   (inline-expansion nil :type (or cons null))
700   ;; the block-local definition of this function (either because it
701   ;; was semi-inline, or because it was defined in this block). If
702   ;; this function is not an entry point, then this may be deleted or
703   ;; LET-converted. Null if we haven't converted the expansion yet.
704   (functional nil :type (or functional null)))
705 (defprinter (defined-fun :identity t)
706   %source-name
707   #!+sb-show id
708   inlinep
709   (functional :test functional))
710 \f
711 ;;;; function stuff
712
713 ;;; We default the WHERE-FROM and TYPE slots to :DEFINED and FUNCTION.
714 ;;; We don't normally manipulate function types for defined functions,
715 ;;; but if someone wants to know, an approximation is there.
716 (def!struct (functional (:include leaf
717                                   (%source-name '.anonymous.)
718                                   (where-from :defined)
719                                   (type (specifier-type 'function))))
720   ;; (For public access to this slot, use LEAF-DEBUG-NAME.)
721   ;;
722   ;; the name of FUNCTIONAL for debugging purposes, or NIL if we
723   ;; should just let the SOURCE-NAME fall through
724   ;;
725   ;; Unlike the SOURCE-NAME slot, this slot's value should never
726   ;; affect ordinary code behavior, only debugging/diagnostic behavior.
727   ;;
728   ;; Ha.  Ah, the starry-eyed idealism of the writer of the above
729   ;; paragraph.  FUNCTION-LAMBDA-EXPRESSION's behaviour, as of
730   ;; sbcl-0.7.11.x, differs if the name of the a function is a string
731   ;; or not, as if it is a valid function name then it can look for an
732   ;; inline expansion.
733   ;;
734   ;; E.g. for the function which implements (DEFUN FOO ...), we could
735   ;; have
736   ;;   %SOURCE-NAME=FOO
737   ;;   %DEBUG-NAME=NIL
738   ;; for the function which implements the top level form
739   ;; (IN-PACKAGE :FOO) we could have
740   ;;   %SOURCE-NAME=NIL
741   ;;   %DEBUG-NAME=(TOP-LEVEL-FORM (IN-PACKAGE :FOO)
742   ;; for the function which implements FOO in
743   ;;   (DEFUN BAR (...) (FLET ((FOO (...) ...)) ...))
744   ;; we could have
745   ;;   %SOURCE-NAME=FOO
746   ;;   %DEBUG-NAME=(FLET FOO)
747   ;; and for the function which implements FOO in
748   ;;   (DEFMACRO FOO (...) ...)
749   ;; we could have
750   ;;   %SOURCE-NAME=FOO (or maybe .ANONYMOUS.?)
751   ;;   %DEBUG-NAME=(MACRO-FUNCTION FOO)
752   (%debug-name nil
753                :type (or null (not (satisfies legal-fun-name-p)))
754                :read-only t)
755   ;; some information about how this function is used. These values
756   ;; are meaningful:
757   ;;
758   ;;    NIL
759   ;;    an ordinary function, callable using local call
760   ;;
761   ;;    :LET
762   ;;    a lambda that is used in only one local call, and has in
763   ;;    effect been substituted directly inline. The return node is
764   ;;    deleted, and the result is computed with the actual result
765   ;;    lvar for the call.
766   ;;
767   ;;    :MV-LET
768   ;;    Similar to :LET (as per FUNCTIONAL-LETLIKE-P), but the call
769   ;;    is an MV-CALL.
770   ;;
771   ;;    :ASSIGNMENT
772   ;;    similar to a LET (as per FUNCTIONAL-SOMEWHAT-LETLIKE-P), but
773   ;;    can have other than one call as long as there is at most
774   ;;    one non-tail call.
775   ;;
776   ;;    :OPTIONAL
777   ;;    a lambda that is an entry point for an OPTIONAL-DISPATCH.
778   ;;    Similar to NIL, but requires greater caution, since local call
779   ;;    analysis may create new references to this function. Also, the
780   ;;    function cannot be deleted even if it has *no* references. The
781   ;;    OPTIONAL-DISPATCH is in the LAMDBA-OPTIONAL-DISPATCH.
782   ;;
783   ;;    :EXTERNAL
784   ;;    an external entry point lambda. The function it is an entry
785   ;;    for is in the ENTRY-FUN slot.
786   ;;
787   ;;    :TOPLEVEL
788   ;;    a top level lambda, holding a compiled top level form.
789   ;;    Compiled very much like NIL, but provides an indication of
790   ;;    top level context. A :TOPLEVEL lambda should have *no*
791   ;;    references. Its ENTRY-FUN is a self-pointer.
792   ;;
793   ;;    :TOPLEVEL-XEP
794   ;;    After a component is compiled, we clobber any top level code
795   ;;    references to its non-closure XEPs with dummy FUNCTIONAL
796   ;;    structures having this kind. This prevents the retained
797   ;;    top level code from holding onto the IR for the code it
798   ;;    references.
799   ;;
800   ;;    :ESCAPE
801   ;;    :CLEANUP
802   ;;    special functions used internally by CATCH and UNWIND-PROTECT.
803   ;;    These are pretty much like a normal function (NIL), but are
804   ;;    treated specially by local call analysis and stuff. Neither
805   ;;    kind should ever be given an XEP even though they appear as
806   ;;    args to funny functions. An :ESCAPE function is never actually
807   ;;    called, and thus doesn't need to have code generated for it.
808   ;;
809   ;;    :DELETED
810   ;;    This function has been found to be uncallable, and has been
811   ;;    marked for deletion.
812   ;;
813   ;;    :ZOMBIE
814   ;;    Effectless [MV-]LET; has no BIND node.
815   (kind nil :type (member nil :optional :deleted :external :toplevel
816                           :escape :cleanup :let :mv-let :assignment
817                           :zombie :toplevel-xep))
818   ;; Is this a function that some external entity (e.g. the fasl dumper)
819   ;; refers to, so that even when it appears to have no references, it
820   ;; shouldn't be deleted? In the old days (before
821   ;; sbcl-0.pre7.37.flaky5.2) this was sort of implicitly true when
822   ;; KIND was :TOPLEVEL. Now it must be set explicitly, both for
823   ;; :TOPLEVEL functions and for any other kind of functions that we
824   ;; want to dump or return from #'CL:COMPILE or whatever.
825   (has-external-references-p nil)
826   ;; In a normal function, this is the external entry point (XEP)
827   ;; lambda for this function, if any. Each function that is used
828   ;; other than in a local call has an XEP, and all of the
829   ;; non-local-call references are replaced with references to the
830   ;; XEP.
831   ;;
832   ;; In an XEP lambda (indicated by the :EXTERNAL kind), this is the
833   ;; function that the XEP is an entry-point for. The body contains
834   ;; local calls to all the actual entry points in the function. In a
835   ;; :TOPLEVEL lambda (which is its own XEP) this is a self-pointer.
836   ;;
837   ;; With all other kinds, this is null.
838   (entry-fun nil :type (or functional null))
839   ;; the value of any inline/notinline declaration for a local
840   ;; function (or NIL in any case if no inline expansion is available)
841   (inlinep nil :type inlinep)
842   ;; If we have a lambda that can be used as in inline expansion for
843   ;; this function, then this is it. If there is no source-level
844   ;; lambda corresponding to this function then this is null (but then
845   ;; INLINEP will always be NIL as well.)
846   (inline-expansion nil :type list)
847   ;; the lexical environment that the INLINE-EXPANSION should be converted in
848   (lexenv *lexenv* :type lexenv)
849   ;; the original function or macro lambda list, or :UNSPECIFIED if
850   ;; this is a compiler created function
851   (arg-documentation nil :type (or list (member :unspecified)))
852   ;; Node, allocating closure for this lambda. May be NIL when we are
853   ;; sure that no closure is needed.
854   (allocator nil :type (or null combination))
855   ;; various rare miscellaneous info that drives code generation & stuff
856   (plist () :type list)
857   ;; xref information for this functional (only used for functions with an
858   ;; XEP)
859   (xref () :type list))
860 (defprinter (functional :identity t)
861   %source-name
862   %debug-name
863   #!+sb-show id)
864
865 ;;; Is FUNCTIONAL LET-converted? (where we're indifferent to whether
866 ;;; it returns one value or multiple values)
867 (defun functional-letlike-p (functional)
868   (member (functional-kind functional)
869           '(:let :mv-let)))
870
871 ;;; Is FUNCTIONAL sorta LET-converted? (where even an :ASSIGNMENT counts)
872 ;;;
873 ;;; FIXME: I (WHN) don't understand this one well enough to give a good
874 ;;; definition or even a good function name, it's just a literal copy
875 ;;; of a CMU CL idiom. Does anyone have a better name or explanation?
876 (defun functional-somewhat-letlike-p (functional)
877   (or (functional-letlike-p functional)
878       (eql (functional-kind functional) :assignment)))
879
880 ;;; FUNCTIONAL name operations
881 (defun functional-debug-name (functional)
882   ;; FUNCTIONAL-%DEBUG-NAME takes precedence over FUNCTIONAL-SOURCE-NAME
883   ;; here because we want different debug names for the functions in
884   ;; DEFUN FOO and FLET FOO even though they have the same source name.
885   (or (functional-%debug-name functional)
886       ;; Note that this will cause an error if the function is
887       ;; anonymous. In SBCL (as opposed to CMU CL) we make all
888       ;; FUNCTIONALs have debug names. The CMU CL code didn't bother
889       ;; in many FUNCTIONALs, especially those which were likely to be
890       ;; optimized away before the user saw them. However, getting
891       ;; that right requires a global understanding of the code,
892       ;; which seems bad, so we just require names for everything.
893       (leaf-source-name functional)))
894
895 ;;; The CLAMBDA only deals with required lexical arguments. Special,
896 ;;; optional, keyword and rest arguments are handled by transforming
897 ;;; into simpler stuff.
898 (def!struct (clambda (:include functional)
899                      (:conc-name lambda-)
900                      (:predicate lambda-p)
901                      (:constructor make-lambda)
902                      (:copier copy-lambda))
903   ;; list of LAMBDA-VAR descriptors for arguments
904   (vars nil :type list :read-only t)
905   ;; If this function was ever a :OPTIONAL function (an entry-point
906   ;; for an OPTIONAL-DISPATCH), then this is that OPTIONAL-DISPATCH.
907   ;; The optional dispatch will be :DELETED if this function is no
908   ;; longer :OPTIONAL.
909   (optional-dispatch nil :type (or optional-dispatch null))
910   ;; the BIND node for this LAMBDA. This node marks the beginning of
911   ;; the lambda, and serves to explicitly represent the lambda binding
912   ;; semantics within the flow graph representation. This is null in
913   ;; deleted functions, and also in LETs where we deleted the call and
914   ;; bind (because there are no variables left), but have not yet
915   ;; actually deleted the LAMBDA yet.
916   (bind nil :type (or bind null))
917   ;; the RETURN node for this LAMBDA, or NIL if it has been
918   ;; deleted. This marks the end of the lambda, receiving the result
919   ;; of the body. In a LET, the return node is deleted, and the body
920   ;; delivers the value to the actual lvar. The return may also be
921   ;; deleted if it is unreachable.
922   (return nil :type (or creturn null))
923   ;; If this CLAMBDA is a LET, then this slot holds the LAMBDA whose
924   ;; LETS list we are in, otherwise it is a self-pointer.
925   (home nil :type (or clambda null))
926   ;; all the lambdas that have been LET-substituted in this lambda.
927   ;; This is only non-null in lambdas that aren't LETs.
928   (lets nil :type list)
929   ;; all the ENTRY nodes in this function and its LETs, or null in a LET
930   (entries nil :type list)
931   ;; CLAMBDAs which are locally called by this lambda, and other
932   ;; objects (closed-over LAMBDA-VARs and XEPs) which this lambda
933   ;; depends on in such a way that DFO shouldn't put them in separate
934   ;; components.
935   (calls-or-closes nil :type list)
936   ;; the TAIL-SET that this LAMBDA is in. This is null during creation.
937   ;;
938   ;; In CMU CL, and old SBCL, this was also NILed out when LET
939   ;; conversion happened. That caused some problems, so as of
940   ;; sbcl-0.pre7.37.flaky5.2 when I was trying to get the compiler to
941   ;; emit :EXTERNAL functions directly, and so now the value
942   ;; is no longer NILed out in LET conversion, but instead copied
943   ;; (so that any further optimizations on the rest of the tail
944   ;; set won't modify the value) if necessary.
945   (tail-set nil :type (or tail-set null))
946   ;; the structure which represents the phsical environment that this
947   ;; function's variables are allocated in. This is filled in by
948   ;; physical environment analysis. In a LET, this is EQ to our home's
949   ;; physical environment.
950   (physenv nil :type (or physenv null))
951   ;; In a LET, this is the NODE-LEXENV of the combination node. We
952   ;; retain it so that if the LET is deleted (due to a lack of vars),
953   ;; we will still have caller's lexenv to figure out which cleanup is
954   ;; in effect.
955   (call-lexenv nil :type (or lexenv null))
956   ;; list of embedded lambdas
957   (children nil :type list)
958   (parent nil :type (or clambda null)))
959 (defprinter (clambda :conc-name lambda- :identity t)
960   %source-name
961   %debug-name
962   #!+sb-show id
963   kind
964   (type :test (not (eq type *universal-type*)))
965   (where-from :test (not (eq where-from :assumed)))
966   (vars :prin1 (mapcar #'leaf-source-name vars)))
967
968 ;;; The OPTIONAL-DISPATCH leaf is used to represent hairy lambdas. It
969 ;;; is a FUNCTIONAL, like LAMBDA. Each legal number of arguments has a
970 ;;; function which is called when that number of arguments is passed.
971 ;;; The function is called with all the arguments actually passed. If
972 ;;; additional arguments are legal, then the LEXPR style MORE-ENTRY
973 ;;; handles them. The value returned by the function is the value
974 ;;; which results from calling the OPTIONAL-DISPATCH.
975 ;;;
976 ;;; The theory is that each entry-point function calls the next entry
977 ;;; point tail-recursively, passing all the arguments passed in and
978 ;;; the default for the argument the entry point is for. The last
979 ;;; entry point calls the real body of the function. In the presence
980 ;;; of SUPPLIED-P args and other hair, things are more complicated. In
981 ;;; general, there is a distinct internal function that takes the
982 ;;; SUPPLIED-P args as parameters. The preceding entry point calls
983 ;;; this function with NIL filled in for the SUPPLIED-P args, while
984 ;;; the current entry point calls it with T in the SUPPLIED-P
985 ;;; positions.
986 ;;;
987 ;;; Note that it is easy to turn a call with a known number of
988 ;;; arguments into a direct call to the appropriate entry-point
989 ;;; function, so functions that are compiled together can avoid doing
990 ;;; the dispatch.
991 (def!struct (optional-dispatch (:include functional))
992   ;; the original parsed argument list, for anyone who cares
993   (arglist nil :type list)
994   ;; true if &ALLOW-OTHER-KEYS was supplied
995   (allowp nil :type boolean)
996   ;; true if &KEY was specified (which doesn't necessarily mean that
997   ;; there are any &KEY arguments..)
998   (keyp nil :type boolean)
999   ;; the number of required arguments. This is the smallest legal
1000   ;; number of arguments.
1001   (min-args 0 :type unsigned-byte)
1002   ;; the total number of required and optional arguments. Args at
1003   ;; positions >= to this are &REST, &KEY or illegal args.
1004   (max-args 0 :type unsigned-byte)
1005   ;; list of the (maybe delayed) LAMBDAs which are the entry points
1006   ;; for non-rest, non-key calls. The entry for MIN-ARGS is first,
1007   ;; MIN-ARGS+1 second, ... MAX-ARGS last. The last entry-point always
1008   ;; calls the main entry; in simple cases it may be the main entry.
1009   (entry-points nil :type list)
1010   ;; an entry point which takes MAX-ARGS fixed arguments followed by
1011   ;; an argument context pointer and an argument count. This entry
1012   ;; point deals with listifying rest args and parsing keywords. This
1013   ;; is null when extra arguments aren't legal.
1014   (more-entry nil :type (or clambda null))
1015   ;; the main entry-point into the function, which takes all arguments
1016   ;; including keywords as fixed arguments. The format of the
1017   ;; arguments must be determined by examining the arglist. This may
1018   ;; be used by callers that supply at least MAX-ARGS arguments and
1019   ;; know what they are doing.
1020   (main-entry nil :type (or clambda null)))
1021 (defprinter (optional-dispatch :identity t)
1022   %source-name
1023   %debug-name
1024   #!+sb-show id
1025   (type :test (not (eq type *universal-type*)))
1026   (where-from :test (not (eq where-from :assumed)))
1027   arglist
1028   allowp
1029   keyp
1030   min-args
1031   max-args
1032   (entry-points :test entry-points)
1033   (more-entry :test more-entry)
1034   main-entry)
1035
1036 ;;; The ARG-INFO structure allows us to tack various information onto
1037 ;;; LAMBDA-VARs during IR1 conversion. If we use one of these things,
1038 ;;; then the var will have to be massaged a bit before it is simple
1039 ;;; and lexical.
1040 (def!struct arg-info
1041   ;; true if this arg is to be specially bound
1042   (specialp nil :type boolean)
1043   ;; the kind of argument being described. Required args only have arg
1044   ;; info structures if they are special.
1045   (kind (missing-arg)
1046         :type (member :required :optional :keyword :rest
1047                       :more-context :more-count))
1048   ;; If true, this is the VAR for SUPPLIED-P variable of a keyword or
1049   ;; optional arg. This is true for keywords with non-constant
1050   ;; defaults even when there is no user-specified supplied-p var.
1051   (supplied-p nil :type (or lambda-var null))
1052   ;; the default for a keyword or optional, represented as the
1053   ;; original Lisp code. This is set to NIL in &KEY arguments that are
1054   ;; defaulted using the SUPPLIED-P arg.
1055   (default nil :type t)
1056   ;; the actual key for a &KEY argument. Note that in ANSI CL this is
1057   ;; not necessarily a keyword: (DEFUN FOO (&KEY ((BAR BAR))) ...).
1058   (key nil :type symbol))
1059 (defprinter (arg-info :identity t)
1060   (specialp :test specialp)
1061   kind
1062   (supplied-p :test supplied-p)
1063   (default :test default)
1064   (key :test key))
1065
1066 ;;; The LAMBDA-VAR structure represents a lexical lambda variable.
1067 ;;; This structure is also used during IR1 conversion to describe
1068 ;;; lambda arguments which may ultimately turn out not to be simple
1069 ;;; and lexical.
1070 ;;;
1071 ;;; LAMBDA-VARs with no REFs are considered to be deleted; physical
1072 ;;; environment analysis isn't done on these variables, so the back
1073 ;;; end must check for and ignore unreferenced variables. Note that a
1074 ;;; deleted LAMBDA-VAR may have sets; in this case the back end is
1075 ;;; still responsible for propagating the SET-VALUE to the set's CONT.
1076 (!def-boolean-attribute lambda-var
1077   ;; true if this variable has been declared IGNORE
1078   ignore
1079   ;; This is set by physical environment analysis if it chooses an
1080   ;; indirect (value cell) representation for this variable because it
1081   ;; is both set and closed over.
1082   indirect)
1083
1084 (def!struct (lambda-var (:include basic-var))
1085   (flags (lambda-var-attributes)
1086          :type attributes)
1087   ;; the CLAMBDA that this var belongs to. This may be null when we are
1088   ;; building a lambda during IR1 conversion.
1089   (home nil :type (or null clambda))
1090   ;; The following two slots are only meaningful during IR1 conversion
1091   ;; of hairy lambda vars:
1092   ;;
1093   ;; The ARG-INFO structure which holds information obtained from
1094   ;; &keyword parsing.
1095   (arg-info nil :type (or arg-info null))
1096   ;; if true, the GLOBAL-VAR structure for the special variable which
1097   ;; is to be bound to the value of this argument
1098   (specvar nil :type (or global-var null))
1099   ;; Set of the CONSTRAINTs on this variable. Used by constraint
1100   ;; propagation. This is left null by the lambda pre-pass if it
1101   ;; determine that this is a set closure variable, and is thus not a
1102   ;; good subject for flow analysis.
1103   (constraints nil :type (or sset null)))
1104 (defprinter (lambda-var :identity t)
1105   %source-name
1106   #!+sb-show id
1107   (type :test (not (eq type *universal-type*)))
1108   (where-from :test (not (eq where-from :assumed)))
1109   (flags :test (not (zerop flags))
1110          :prin1 (decode-lambda-var-attributes flags))
1111   (arg-info :test arg-info)
1112   (specvar :test specvar))
1113
1114 (defmacro lambda-var-ignorep (var)
1115   `(lambda-var-attributep (lambda-var-flags ,var) ignore))
1116 (defmacro lambda-var-indirect (var)
1117   `(lambda-var-attributep (lambda-var-flags ,var) indirect))
1118 \f
1119 ;;;; basic node types
1120
1121 ;;; A REF represents a reference to a LEAF. REF-REOPTIMIZE is
1122 ;;; initially (and forever) NIL, since REFs don't receive any values
1123 ;;; and don't have any IR1 optimizer.
1124 (def!struct (ref (:include valued-node (reoptimize nil))
1125                  (:constructor make-ref
1126                                (leaf
1127                                 &aux (leaf-type (leaf-type leaf))
1128                                 (derived-type
1129                                  (make-single-value-type leaf-type))))
1130                  (:copier nil))
1131   ;; The leaf referenced.
1132   (leaf nil :type leaf))
1133 (defprinter (ref :identity t)
1134   #!+sb-show id
1135   leaf)
1136
1137 ;;; Naturally, the IF node always appears at the end of a block.
1138 (def!struct (cif (:include node)
1139                  (:conc-name if-)
1140                  (:predicate if-p)
1141                  (:constructor make-if)
1142                  (:copier copy-if))
1143   ;; LVAR for the predicate
1144   (test (missing-arg) :type lvar)
1145   ;; the blocks that we execute next in true and false case,
1146   ;; respectively (may be the same)
1147   (consequent (missing-arg) :type cblock)
1148   (consequent-constraints nil :type (or null sset))
1149   (alternative (missing-arg) :type cblock)
1150   (alternative-constraints nil :type (or null sset)))
1151 (defprinter (cif :conc-name if- :identity t)
1152   (test :prin1 (lvar-uses test))
1153   consequent
1154   alternative)
1155
1156 (def!struct (cset (:include valued-node
1157                            (derived-type (make-single-value-type
1158                                           *universal-type*)))
1159                   (:conc-name set-)
1160                   (:predicate set-p)
1161                   (:constructor make-set)
1162                   (:copier copy-set))
1163   ;; descriptor for the variable set
1164   (var (missing-arg) :type basic-var)
1165   ;; LVAR for the value form
1166   (value (missing-arg) :type lvar))
1167 (defprinter (cset :conc-name set- :identity t)
1168   var
1169   (value :prin1 (lvar-uses value)))
1170
1171 ;;; The BASIC-COMBINATION structure is used to represent both normal
1172 ;;; and multiple value combinations. In a let-like function call, this
1173 ;;; node appears at the end of its block and the body of the called
1174 ;;; function appears as the successor; the NODE-LVAR is null.
1175 (def!struct (basic-combination (:include valued-node)
1176                                (:constructor nil)
1177                                (:copier nil))
1178   ;; LVAR for the function
1179   (fun (missing-arg) :type lvar)
1180   ;; list of LVARs for the args. In a local call, an argument lvar may
1181   ;; be replaced with NIL to indicate that the corresponding variable
1182   ;; is unreferenced, and thus no argument value need be passed.
1183   (args nil :type list)
1184   ;; the kind of function call being made. :LOCAL means that this is a
1185   ;; local call to a function in the same component, and that argument
1186   ;; syntax checking has been done, etc.  Calls to known global
1187   ;; functions are represented by storing :KNOWN in this slot and the
1188   ;; FUN-INFO for that function in the FUN-INFO slot.  :FULL is a call
1189   ;; to an (as yet) unknown function, or to a known function declared
1190   ;; NOTINLINE. :ERROR is like :FULL, but means that we have
1191   ;; discovered that the call contains an error, and should not be
1192   ;; reconsidered for optimization.
1193   (kind :full :type (member :local :full :error :known))
1194   ;; if a call to a known global function, contains the FUN-INFO.
1195   (fun-info nil :type (or fun-info null))
1196   ;; some kind of information attached to this node by the back end
1197   (info nil)
1198   (step-info))
1199
1200 ;;; The COMBINATION node represents all normal function calls,
1201 ;;; including FUNCALL. This is distinct from BASIC-COMBINATION so that
1202 ;;; an MV-COMBINATION isn't COMBINATION-P.
1203 (def!struct (combination (:include basic-combination)
1204                          (:constructor make-combination (fun))
1205                          (:copier nil)))
1206 (defprinter (combination :identity t)
1207   #!+sb-show id
1208   (fun :prin1 (lvar-uses fun))
1209   (args :prin1 (mapcar (lambda (x)
1210                          (if x
1211                              (lvar-uses x)
1212                              "<deleted>"))
1213                        args)))
1214
1215 ;;; An MV-COMBINATION is to MULTIPLE-VALUE-CALL as a COMBINATION is to
1216 ;;; FUNCALL. This is used to implement all the multiple-value
1217 ;;; receiving forms.
1218 (def!struct (mv-combination (:include basic-combination)
1219                             (:constructor make-mv-combination (fun))
1220                             (:copier nil)))
1221 (defprinter (mv-combination)
1222   (fun :prin1 (lvar-uses fun))
1223   (args :prin1 (mapcar #'lvar-uses args)))
1224
1225 ;;; The BIND node marks the beginning of a lambda body and represents
1226 ;;; the creation and initialization of the variables.
1227 (def!struct (bind (:include node)
1228                   (:copier nil))
1229   ;; the lambda we are binding variables for. Null when we are
1230   ;; creating the LAMBDA during IR1 translation.
1231   (lambda nil :type (or clambda null)))
1232 (defprinter (bind)
1233   lambda)
1234
1235 ;;; The RETURN node marks the end of a lambda body. It collects the
1236 ;;; return values and represents the control transfer on return. This
1237 ;;; is also where we stick information used for TAIL-SET type
1238 ;;; inference.
1239 (def!struct (creturn (:include node)
1240                      (:conc-name return-)
1241                      (:predicate return-p)
1242                      (:constructor make-return)
1243                      (:copier copy-return))
1244   ;; the lambda we are returning from. Null temporarily during
1245   ;; ir1tran.
1246   (lambda nil :type (or clambda null))
1247   ;; the lvar which yields the value of the lambda
1248   (result (missing-arg) :type lvar)
1249   ;; the union of the node-derived-type of all uses of the result
1250   ;; other than by a local call, intersected with the result's
1251   ;; asserted-type. If there are no non-call uses, this is
1252   ;; *EMPTY-TYPE*
1253   (result-type *wild-type* :type ctype))
1254 (defprinter (creturn :conc-name return- :identity t)
1255   lambda
1256   result-type)
1257
1258 ;;; The CAST node represents type assertions. The check for
1259 ;;; TYPE-TO-CHECK is performed and then the VALUE is declared to be of
1260 ;;; type ASSERTED-TYPE.
1261 (def!struct (cast (:include valued-node)
1262                   (:constructor %make-cast))
1263   (asserted-type (missing-arg) :type ctype)
1264   (type-to-check (missing-arg) :type ctype)
1265   ;; an indication of what we have proven about how this type
1266   ;; assertion is satisfied:
1267   ;;
1268   ;; NIL
1269   ;;    No type check is necessary (VALUE type is a subtype of the TYPE-TO-CHECK.)
1270   ;;
1271   ;; :EXTERNAL
1272   ;;    Type check will be performed by NODE-DEST.
1273   ;;
1274   ;; T
1275   ;;    A type check is needed.
1276   (%type-check t :type (member t :external nil))
1277   ;; the lvar which is checked
1278   (value (missing-arg) :type lvar))
1279 (defprinter (cast :identity t)
1280   %type-check
1281   value
1282   asserted-type
1283   type-to-check)
1284 \f
1285 ;;;; non-local exit support
1286 ;;;;
1287 ;;;; In IR1, we insert special nodes to mark potentially non-local
1288 ;;;; lexical exits.
1289
1290 ;;; The ENTRY node serves to mark the start of the dynamic extent of a
1291 ;;; lexical exit. It is the mess-up node for the corresponding :ENTRY
1292 ;;; cleanup.
1293 (def!struct (entry (:include node)
1294                    (:copier nil))
1295   ;; All of the EXIT nodes for potential non-local exits to this point.
1296   (exits nil :type list)
1297   ;; The cleanup for this entry. NULL only temporarily.
1298   (cleanup nil :type (or cleanup null)))
1299 (defprinter (entry :identity t)
1300   #!+sb-show id)
1301
1302 ;;; The EXIT node marks the place at which exit code would be emitted,
1303 ;;; if necessary. This is interposed between the uses of the exit
1304 ;;; continuation and the exit continuation's DEST. Instead of using
1305 ;;; the returned value being delivered directly to the exit
1306 ;;; continuation, it is delivered to our VALUE lvar. The original exit
1307 ;;; lvar is the exit node's LVAR; physenv analysis also makes it the
1308 ;;; lvar of %NLX-ENTRY call.
1309 (def!struct (exit (:include valued-node)
1310                   (:copier nil))
1311   ;; the ENTRY node that this is an exit for. If null, this is a
1312   ;; degenerate exit. A degenerate exit is used to "fill" an empty
1313   ;; block (which isn't allowed in IR1.) In a degenerate exit, Value
1314   ;; is always also null.
1315   (entry nil :type (or entry null))
1316   ;; the lvar yielding the value we are to exit with. If NIL, then no
1317   ;; value is desired (as in GO).
1318   (value nil :type (or lvar null))
1319   (nlx-info nil :type (or nlx-info null)))
1320 (defprinter (exit :identity t)
1321   #!+sb-show id
1322   (entry :test entry)
1323   (value :test value))
1324 \f
1325 ;;;; miscellaneous IR1 structures
1326
1327 (def!struct (undefined-warning
1328             #-no-ansi-print-object
1329             (:print-object (lambda (x s)
1330                              (print-unreadable-object (x s :type t)
1331                                (prin1 (undefined-warning-name x) s))))
1332             (:copier nil))
1333   ;; the name of the unknown thing
1334   (name nil :type (or symbol list))
1335   ;; the kind of reference to NAME
1336   (kind (missing-arg) :type (member :function :type :variable))
1337   ;; the number of times this thing was used
1338   (count 0 :type unsigned-byte)
1339   ;; a list of COMPILER-ERROR-CONTEXT structures describing places
1340   ;; where this thing was used. Note that we only record the first
1341   ;; *UNDEFINED-WARNING-LIMIT* calls.
1342   (warnings () :type list))
1343 \f
1344 ;;; a helper for the POLICY macro, defined late here so that the
1345 ;;; various type tests can be inlined
1346 (declaim (ftype (function ((or list lexenv node functional)) list)
1347                 %coerce-to-policy))
1348 (defun %coerce-to-policy (thing)
1349   (let ((result (etypecase thing
1350                   (list thing)
1351                   (lexenv (lexenv-policy thing))
1352                   (node (lexenv-policy (node-lexenv thing)))
1353                   (functional (lexenv-policy (functional-lexenv thing))))))
1354     ;; Test the first element of the list as a rudimentary sanity
1355     ;; that it really does look like a valid policy.
1356     (aver (or (null result) (policy-quality-name-p (caar result))))
1357     ;; Voila.
1358     result))
1359 \f
1360 ;;;; Freeze some structure types to speed type testing.
1361
1362 #!-sb-fluid
1363 (declaim (freeze-type node leaf lexenv ctran lvar cblock component cleanup
1364                       physenv tail-set nlx-info))