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