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