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