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