1.0.31.13: working XREF for inlined lambda with hairy lambda-lists
[sbcl.git] / src / compiler / vop.lisp
1 ;;;; structures for the second (virtual machine) intermediate
2 ;;;; representation in the compiler, IR2
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 largest number of TNs whose liveness changes that we can have
16 ;;; in any block
17 (def!constant local-tn-limit 64)
18
19 (deftype local-tn-number () `(integer 0 (,local-tn-limit)))
20 (deftype local-tn-count () `(integer 0 ,local-tn-limit))
21 (deftype local-tn-vector () `(simple-vector ,local-tn-limit))
22 (deftype local-tn-bit-vector () `(simple-bit-vector ,local-tn-limit))
23
24 ;;; type of an SC number
25 (deftype sc-number () `(integer 0 (,sc-number-limit)))
26
27 ;;; types for vectors indexed by SC numbers
28 (deftype sc-vector () `(simple-vector ,sc-number-limit))
29 (deftype sc-bit-vector () `(simple-bit-vector ,sc-number-limit))
30
31 ;;; the different policies we can use to determine the coding strategy
32 (deftype ltn-policy ()
33   '(member :safe :small :fast :fast-safe))
34 \f
35 ;;;; PRIMITIVE-TYPEs
36
37 ;;; A PRIMITIVE-TYPE is used to represent the aspects of type
38 ;;; interesting to the VM. Selection of IR2 translation templates is
39 ;;; done on the basis of the primitive types of the operands, and the
40 ;;; primitive type of a value is used to constrain the possible
41 ;;; representations of that value.
42 (defstruct (primitive-type (:copier nil))
43   ;; the name of this PRIMITIVE-TYPE
44   (name nil :type symbol)
45   ;; a list of the SC numbers for all the SCs that a TN of this type
46   ;; can be allocated in
47   (scs nil :type list)
48   ;; the Lisp type equivalent to this type. If this type could never be
49   ;; returned by PRIMITIVE-TYPE, then this is the NIL (or empty) type
50   (specifier (missing-arg) :type type-specifier)
51   ;; the template used to check that an object is of this type. This is a
52   ;; template of one argument and one result, both of primitive-type T. If
53   ;; the argument is of the correct type, then it is delivered into the
54   ;; result. If the type is incorrect, then an error is signalled.
55   (check nil :type (or template null)))
56
57 (defprinter (primitive-type)
58   name)
59 \f
60 ;;;; IR1 annotations used for IR2 conversion
61
62 ;;; BLOCK-INFO
63 ;;;    Holds the IR2-BLOCK structure. If there are overflow blocks,
64 ;;;    then this points to the first IR2-BLOCK. The BLOCK-INFO of the
65 ;;;    dummy component head and tail are dummy IR2 blocks that begin
66 ;;;    and end the emission order thread.
67 ;;;
68 ;;; COMPONENT-INFO
69 ;;;    Holds the IR2-COMPONENT structure.
70 ;;;
71 ;;; LVAR-INFO
72 ;;;    Holds the IR2-LVAR structure. LVARs whose values aren't used
73 ;;;    won't have any. XXX
74 ;;;
75 ;;; CLEANUP-INFO
76 ;;;    If non-null, then a TN in which the affected dynamic
77 ;;;    environment pointer should be saved after the binding is
78 ;;;    instantiated.
79 ;;;
80 ;;; PHYSENV-INFO
81 ;;;    Holds the IR2-PHYSENV structure.
82 ;;;
83 ;;; TAIL-SET-INFO
84 ;;;    Holds the RETURN-INFO structure.
85 ;;;
86 ;;; NLX-INFO-INFO
87 ;;;    Holds the IR2-NLX-INFO structure.
88 ;;;
89 ;;; LEAF-INFO
90 ;;;    If a non-set lexical variable, the TN that holds the value in
91 ;;;    the home environment. If a constant, then the corresponding
92 ;;;    constant TN. If an XEP lambda, then the corresponding
93 ;;;    Entry-Info structure.
94 ;;;
95 ;;; BASIC-COMBINATION-INFO
96 ;;;    The template chosen by LTN, or
97 ;;;     :FULL if this is definitely a full call.
98 ;;;     :FUNNY if this is an oddball thing with IR2-convert.
99 ;;;     :LOCAL if this is a local call.
100 ;;;
101 ;;; NODE-TAIL-P
102 ;;;    After LTN analysis, this is true only in combination nodes that are
103 ;;;    truly tail recursive.
104
105 ;;; An IR2-BLOCK holds information about a block that is used during
106 ;;; and after IR2 conversion. It is stored in the BLOCK-INFO slot for
107 ;;; the associated block.
108 (defstruct (ir2-block (:include block-annotation)
109                       (:constructor make-ir2-block (block))
110                       (:copier nil))
111   ;; the IR2-BLOCK's number, which differs from BLOCK's BLOCK-NUMBER
112   ;; if any blocks are split. This is assigned by lifetime analysis.
113   (number nil :type (or index null))
114   ;; information about unknown-values LVARs that is used by stack
115   ;; analysis to do stack simulation. An UNKNOWN-VALUES LVAR is PUSHED
116   ;; if its DEST is in another block. Similarly, a LVAR is POPPED if
117   ;; its DEST is in this block but has its uses elsewhere. The LVARs
118   ;; are in the order that are pushed/popped in the block. Note that
119   ;; the args to a single MV-COMBINATION appear reversed in POPPED,
120   ;; since we must effectively pop the last argument first. All pops
121   ;; must come before all pushes (although internal MV uses may be
122   ;; interleaved.) POPPED is computed by LTN, and PUSHED is computed
123   ;; by stack analysis.
124   (pushed () :type list)
125   (popped () :type list)
126   ;; the result of stack analysis: lists of all the unknown-values
127   ;; LVARs on the stack at the block start and end, topmost LVAR
128   ;; first.
129   (start-stack () :type list)
130   (end-stack () :type list)
131   ;; the first and last VOP in this block. If there are none, both
132   ;; slots are null.
133   (start-vop nil :type (or vop null))
134   (last-vop nil :type (or vop null))
135   ;; the number of local TNs actually allocated
136   (local-tn-count 0 :type local-tn-count)
137   ;; a vector that maps local TN numbers to TNs. Some entries may be
138   ;; NIL, indicating that that number is unused. (This allows us to
139   ;; delete local conflict information without compressing the LTN
140   ;; numbers.)
141   ;;
142   ;; If an entry is :MORE, then this block contains only a single VOP.
143   ;; This VOP has so many more arguments and/or results that they
144   ;; cannot all be assigned distinct LTN numbers. In this case, we
145   ;; assign all the more args one LTN number, and all the more results
146   ;; another LTN number. We can do this, since more operands are
147   ;; referenced simultaneously as far as conflict analysis is
148   ;; concerned. Note that all these :MORE TNs will be global TNs.
149   (local-tns (make-array local-tn-limit) :type local-tn-vector)
150   ;; Bit-vectors used during lifetime analysis to keep track of
151   ;; references to local TNs. When indexed by the LTN number, the
152   ;; index for a TN is non-zero in WRITTEN if it is ever written in
153   ;; the block, and in LIVE-OUT if the first reference is a read.
154   (written (make-array local-tn-limit :element-type 'bit
155                        :initial-element 0)
156            :type local-tn-bit-vector)
157   (live-out (make-array local-tn-limit :element-type 'bit)
158             :type local-tn-bit-vector)
159   ;; This is similar to the above, but is updated by lifetime flow
160   ;; analysis to have a 1 for LTN numbers of TNs live at the end of
161   ;; the block. This takes into account all TNs that aren't :LIVE.
162   (live-in (make-array local-tn-limit :element-type 'bit :initial-element 0)
163            :type local-tn-bit-vector)
164   ;; a thread running through the global-conflicts structures for this
165   ;; block, sorted by TN number
166   (global-tns nil :type (or global-conflicts null))
167   ;; the assembler label that points to the beginning of the code for
168   ;; this block, or NIL when we haven't assigned a label yet
169   (%label nil)
170   ;; list of LOCATION-INFO structures describing all the interesting
171   ;; (to the debugger) locations in this block
172   (locations nil :type list))
173
174 (defprinter (ir2-block)
175   (pushed :test pushed)
176   (popped :test popped)
177   (start-vop :test start-vop)
178   (last-vop :test last-vop)
179   (local-tn-count :test (not (zerop local-tn-count)))
180   (%label :test %label))
181
182 ;;; An IR2-LVAR structure is used to annotate LVARs that are used as a
183 ;;; function result LVARs or that receive MVs.
184 (defstruct (ir2-lvar
185             (:constructor make-ir2-lvar (primitive-type))
186             (:copier nil))
187   ;; If this is :DELAYED, then this is a single value LVAR for which
188   ;; the evaluation of the use is to be postponed until the evaluation
189   ;; of destination. This can be done for ref nodes or predicates
190   ;; whose destination is an IF.
191   ;;
192   ;; If this is :FIXED, then this LVAR has a fixed number of values,
193   ;; with the TNs in LOCS.
194   ;;
195   ;; If this is :UNKNOWN, then this is an unknown-values LVAR, using
196   ;; the passing locations in LOCS.
197   ;;
198   ;; If this is :UNUSED, then this LVAR should never actually be used
199   ;; as the destination of a value: it is only used tail-recursively.
200   (kind :fixed :type (member :delayed :fixed :unknown :unused))
201   ;; The primitive-type of the first value of this LVAR. This is
202   ;; primarily for internal use during LTN, but it also records the
203   ;; type restriction on delayed references. In multiple-value
204   ;; contexts, this is null to indicate that it is meaningless. This
205   ;; is always (primitive-type (lvar-type cont)), which may be more
206   ;; restrictive than the tn-primitive-type of the value TN. This is
207   ;; becase the value TN must hold any possible type that could be
208   ;; computed (before type checking.) XXX
209   (primitive-type nil :type (or primitive-type null))
210   ;; Locations used to hold the values of the LVAR. If the number of
211   ;; values if fixed, then there is one TN per value. If the number of
212   ;; values is unknown, then this is a two-list of TNs holding the
213   ;; start of the values glob and the number of values. Note that
214   ;; since type checking is the responsibility of the values receiver,
215   ;; these TNs primitive type is only based on the proven type
216   ;; information.
217   (locs nil :type list)
218   (stack-pointer nil :type (or tn null)))
219
220 (defprinter (ir2-lvar)
221   kind
222   primitive-type
223   locs)
224
225 ;;; An IR2-COMPONENT serves mostly to accumulate non-code information
226 ;;; about the component being compiled.
227 (defstruct (ir2-component (:copier nil))
228   ;; the counter used to allocate global TN numbers
229   (global-tn-counter 0 :type index)
230   ;; NORMAL-TNS is the head of the list of all the normal TNs that
231   ;; need to be packed, linked through the Next slot. We place TNs on
232   ;; this list when we allocate them so that Pack can find them.
233   ;;
234   ;; RESTRICTED-TNS are TNs that must be packed within a finite SC. We
235   ;; pack these TNs first to ensure that the restrictions will be
236   ;; satisfied (if possible).
237   ;;
238   ;; WIRED-TNs are TNs that must be packed at a specific location. The
239   ;; SC and OFFSET are already filled in.
240   ;;
241   ;; CONSTANT-TNs are non-packed TNs that represent constants.
242   (normal-tns nil :type (or tn null))
243   (restricted-tns nil :type (or tn null))
244   (wired-tns nil :type (or tn null))
245   (constant-tns nil :type (or tn null))
246   ;; a list of all the :COMPONENT TNs (live throughout the component).
247   ;; These TNs will also appear in the {NORMAL,RESTRICTED,WIRED} TNs
248   ;; as appropriate to their location.
249   (component-tns () :type list)
250   ;; If this component has a NFP, then this is it.
251   (nfp nil :type (or tn null))
252   ;; a list of the explicitly specified save TNs (kind
253   ;; :SPECIFIED-SAVE). These TNs will also appear in the
254   ;; {NORMAL,RESTRICTED,WIRED} TNs as appropriate to their location.
255   (specified-save-tns () :type list)
256   ;; a list of all the blocks whose IR2-BLOCK has a non-null value for
257   ;; POPPED. This slot is initialized by LTN-ANALYZE as an input to
258   ;; STACK-ANALYZE.
259   (values-receivers nil :type list)
260   ;; an adjustable vector that records all the constants in the
261   ;; constant pool. A non-immediate :CONSTANT TN with offset 0 refers
262   ;; to the constant in element 0, etc. Normal constants are
263   ;; represented by the placing the CONSTANT leaf in this vector. A
264   ;; load-time constant is distinguished by being a cons (KIND .
265   ;; WHAT). KIND is a keyword indicating how the constant is computed,
266   ;; and WHAT is some context.
267   ;;
268   ;; These load-time constants are recognized:
269   ;;
270   ;; (:entry . <function>)
271   ;;    Is replaced by the code pointer for the specified function.
272   ;;    This is how compiled code (including DEFUN) gets its hands on
273   ;;    a function. <function> is the XEP lambda for the called
274   ;;    function; its LEAF-INFO should be an ENTRY-INFO structure.
275   ;;
276   ;; (:label . <label>)
277   ;;    Is replaced with the byte offset of that label from the start
278   ;;    of the code vector (including the header length.)
279   ;;
280   ;; A null entry in this vector is a placeholder for implementation
281   ;; overhead that is eventually stuffed in somehow.
282   (constants (make-array 10 :fill-pointer 0 :adjustable t) :type vector)
283   ;; some kind of info about the component's run-time representation.
284   ;; This is filled in by the VM supplied SELECT-COMPONENT-FORMAT function.
285   format
286   ;; a list of the ENTRY-INFO structures describing all of the entries
287   ;; into this component. Filled in by entry analysis.
288   (entries nil :type list)
289   ;; head of the list of :ALIAS TNs in this component, threaded by TN-NEXT
290   (alias-tns nil :type (or tn null))
291   ;; SPILLED-VOPS is a hashtable translating from "interesting" VOPs
292   ;; to a list of the TNs spilled at that VOP. This is used when
293   ;; computing debug info so that we don't consider the TN's value to
294   ;; be valid when it is in fact somewhere else. SPILLED-TNS has T for
295   ;; every "interesting" TN that is ever spilled, providing a
296   ;; representation that is more convenient some places.
297   (spilled-vops (make-hash-table :test 'eq) :type hash-table)
298   (spilled-tns (make-hash-table :test 'eq) :type hash-table)
299   ;; dynamic vop count info. This is needed by both ir2-convert and
300   ;; setup-dynamic-count-info. (But only if we are generating code to
301   ;; collect dynamic statistics.)
302   #!+sb-dyncount
303   (dyncount-info nil :type (or null dyncount-info)))
304
305 ;;; An ENTRY-INFO condenses all the information that the dumper needs
306 ;;; to create each XEP's function entry data structure. ENTRY-INFO
307 ;;; structures are sometimes created before they are initialized,
308 ;;; since IR2 conversion may need to compile a forward reference. In
309 ;;; this case the slots aren't actually initialized until entry
310 ;;; analysis runs.
311 (defstruct (entry-info (:copier nil))
312   ;; TN, containing closure (if needed) for this function in the home
313   ;; environment.
314   (closure-tn nil :type (or null tn))
315   ;; a label pointing to the entry vector for this function, or NIL
316   ;; before ENTRY-ANALYZE runs
317   (offset nil :type (or label null))
318   ;; If this function was defined using DEFUN, then this is the name
319   ;; of the function, a symbol or (SETF <symbol>). Otherwise, this is
320   ;; some string that is intended to be informative.
321   (name "<not computed>" :type (or simple-string list symbol))
322   ;; the argument list that the function was defined with.
323   (arguments nil :type list)
324   ;; a function type specifier representing the arguments and results
325   ;; of this function
326   (type 'function :type (or list (member function)))
327   ;; docstring and/or xref information for the XEP
328   (info nil :type (or null simple-vector string (cons string simple-vector))))
329
330 ;;; An IR2-PHYSENV is used to annotate non-LET LAMBDAs with their
331 ;;; passing locations. It is stored in the PHYSENV-INFO.
332 (defstruct (ir2-physenv (:copier nil))
333   ;; TN info for closed-over things within the function: an alist
334   ;; mapping from NLX-INFOs and LAMBDA-VARs to TNs holding the
335   ;; corresponding thing within this function
336   ;;
337   ;; Elements of this list have a one-to-one correspondence with
338   ;; elements of the PHYSENV-CLOSURE list of the PHYSENV object that
339   ;; links to us.
340   (closure (missing-arg) :type list :read-only t)
341   ;; the TNs that hold the OLD-FP and RETURN-PC within the function.
342   ;; We always save these so that the debugger can do a backtrace,
343   ;; even if the function has no return (and thus never uses them).
344   ;; Null only temporarily.
345   (old-fp nil :type (or tn null))
346   (return-pc nil :type (or tn null))
347   ;; The passing location for the RETURN-PC. The return PC is treated
348   ;; differently from the other arguments, since in some
349   ;; implementations we may use a call instruction that requires the
350   ;; return PC to be passed in a particular place.
351   (return-pc-pass (missing-arg) :type tn :read-only t)
352   ;; True if this function has a frame on the number stack. This is
353   ;; set by representation selection whenever it is possible that some
354   ;; function in our tail set will make use of the number stack.
355   (number-stack-p nil :type boolean)
356   ;; a list of all the :ENVIRONMENT TNs live in this environment
357   (live-tns nil :type list)
358   ;; a list of all the :DEBUG-ENVIRONMENT TNs live in this environment
359   (debug-live-tns nil :type list)
360   ;; a label that marks the start of elsewhere code for this function,
361   ;; or null until this label is assigned by codegen. Used for
362   ;; maintaining the debug source map.
363   (elsewhere-start nil :type (or label null))
364   ;; a label that marks the first location in this function at which
365   ;; the environment is properly initialized, i.e. arguments moved
366   ;; from their passing locations, etc. This is the start of the
367   ;; function as far as the debugger is concerned.
368   (environment-start nil :type (or label null)))
369 (defprinter (ir2-physenv)
370   closure
371   old-fp
372   return-pc
373   return-pc-pass)
374
375 ;;; A RETURN-INFO is used by GTN to represent the return strategy and
376 ;;; locations for all the functions in a given TAIL-SET. It is stored
377 ;;; in the TAIL-SET-INFO.
378 (defstruct (return-info (:copier nil))
379   ;; The return convention used:
380   ;; -- If :UNKNOWN, we use the standard return convention.
381   ;; -- If :FIXED, we use the known-values convention.
382   (kind (missing-arg) :type (member :fixed :unknown))
383   ;; the number of values returned, or :UNKNOWN if we don't know.
384   ;; COUNT may be known when KIND is :UNKNOWN, since we may choose the
385   ;; standard return convention for other reasons.
386   (count (missing-arg) :type (or index (member :unknown)))
387   ;; If count isn't :UNKNOWN, then this is a list of the
388   ;; primitive-types of each value.
389   (types () :type list)
390   ;; If kind is :FIXED, then this is the list of the TNs that we
391   ;; return the values in.
392   (locations () :type list))
393 (defprinter (return-info)
394   kind
395   count
396   types
397   locations)
398
399 (defstruct (ir2-nlx-info (:copier nil))
400   ;; If the kind is :ENTRY (a lexical exit), then in the home
401   ;; environment, this holds a VALUE-CELL object containing the unwind
402   ;; block pointer. In the other cases nobody directly references the
403   ;; unwind-block, so we leave this slot null.
404   (home nil :type (or tn null))
405   ;; the saved control stack pointer
406   (save-sp (missing-arg) :type tn)
407   ;; the list of dynamic state save TNs
408   (dynamic-state (list* (make-stack-pointer-tn)
409                         (make-dynamic-state-tns))
410                  :type list)
411   ;; the target label for NLX entry
412   (target (gen-label) :type label))
413 (defprinter (ir2-nlx-info)
414   home
415   save-sp
416   dynamic-state)
417
418 (defstruct (cloop (:conc-name loop-)
419                   (:predicate loop-p)
420                   (:constructor make-loop)
421                   (:copier copy-loop))
422   ;; The kind of loop that this is.  These values are legal:
423   ;;
424   ;;    :OUTER
425   ;;        This is the outermost loop structure, and represents all the
426   ;;        code in a component.
427   ;;
428   ;;    :NATURAL
429   ;;        A normal loop with only one entry.
430   ;;
431   ;;    :STRANGE
432   ;;        A segment of a "strange loop" in a non-reducible flow graph.
433   (kind (missing-arg) :type (member :outer :natural :strange))
434   ;; The first and last blocks in the loop.  There may be more than one tail,
435   ;; since there may be multiple back branches to the same head.
436   (head nil :type (or cblock null))
437   (tail nil :type list)
438   ;; A list of all the blocks in this loop or its inferiors that have a
439   ;; successor outside of the loop.
440   (exits nil :type list)
441   ;; The loop that this loop is nested within.  This is null in the outermost
442   ;; loop structure.
443   (superior nil :type (or cloop null))
444   ;; A list of the loops nested directly within this one.
445   (inferiors nil :type list)
446   (depth 0 :type fixnum)
447   ;; The head of the list of blocks directly within this loop.  We must recurse
448   ;; on INFERIORS to find all the blocks.
449   (blocks nil :type (or null cblock))
450   ;; Backend saves the first emitted block of each loop here.
451   (info nil))
452
453 (defprinter (cloop :conc-name loop-)
454   kind
455   head
456   tail
457   exits
458   depth)
459 \f
460 ;;;; VOPs and templates
461
462 ;;; A VOP is a Virtual Operation. It represents an operation and the
463 ;;; operands to the operation.
464 (def!struct (vop (:constructor make-vop (block node info args results))
465                  (:copier nil))
466   ;; VOP-INFO structure containing static info about the operation
467   (info nil :type (or vop-info null))
468   ;; the IR2-BLOCK this VOP is in
469   (block (missing-arg) :type ir2-block)
470   ;; VOPs evaluated after and before this one. Null at the
471   ;; beginning/end of the block, and temporarily during IR2
472   ;; translation.
473   (next nil :type (or vop null))
474   (prev nil :type (or vop null))
475   ;; heads of the TN-REF lists for operand TNs, linked using the
476   ;; ACROSS slot
477   (args nil :type (or tn-ref null))
478   (results nil :type (or tn-ref null))
479   ;; head of the list of write refs for each explicitly allocated
480   ;; temporary, linked together using the ACROSS slot
481   (temps nil :type (or tn-ref null))
482   ;; head of the list of all TN-REFs for references in this VOP,
483   ;; linked by the NEXT-REF slot. There will be one entry for each
484   ;; operand and two (a read and a write) for each temporary.
485   (refs nil :type (or tn-ref null))
486   ;; stuff that is passed uninterpreted from IR2 conversion to
487   ;; codegen. The meaning of this slot is totally dependent on the VOP.
488   codegen-info
489   ;; the node that generated this VOP, for keeping track of debug info
490   (node nil :type (or node null))
491   ;; LOCAL-TN-BIT-VECTOR representing the set of TNs live after args
492   ;; are read and before results are written. This is only filled in
493   ;; when VOP-INFO-SAVE-P is non-null.
494   (save-set nil :type (or local-tn-bit-vector null)))
495 (defprinter (vop)
496   (info :prin1 (vop-info-name info))
497   args
498   results
499   (codegen-info :test codegen-info))
500
501 ;;; A TN-REF object contains information about a particular reference
502 ;;; to a TN. The information in TN-REFs largely determines how TNs are
503 ;;; packed.
504 (def!struct (tn-ref (:constructor make-tn-ref (tn write-p))
505                     (:copier nil))
506   ;; the TN referenced
507   (tn (missing-arg) :type tn)
508   ;; Is this is a write reference? (as opposed to a read reference)
509   (write-p nil :type boolean)
510   ;; the link for a list running through all TN-REFs for this TN of
511   ;; the same kind (read or write)
512   (next nil :type (or tn-ref null))
513   ;; the VOP where the reference happens, or NIL temporarily
514   (vop nil :type (or vop null))
515   ;; the link for a list of all TN-REFs in VOP, in reverse order of
516   ;; reference
517   (next-ref nil :type (or tn-ref null))
518   ;; the link for a list of the TN-REFs in VOP of the same kind
519   ;; (argument, result, temp)
520   (across nil :type (or tn-ref null))
521   ;; If true, this is a TN-REF also in VOP whose TN we would like
522   ;; packed in the same location as our TN. Read and write refs are
523   ;; always paired: TARGET in the read points to the write, and
524   ;; vice-versa.
525   (target nil :type (or null tn-ref))
526   ;; the load TN allocated for this operand, if any
527   (load-tn nil :type (or tn null)))
528 (defprinter (tn-ref)
529   tn
530   write-p
531   (vop :test vop :prin1 (vop-info-name (vop-info vop))))
532
533 ;;; A TEMPLATE object represents a particular IR2 coding strategy for
534 ;;; a known function.
535 (def!struct (template (:constructor nil)
536                       #-sb-xc-host (:pure t))
537   ;; the symbol name of this VOP. This is used when printing the VOP
538   ;; and is also used to provide a handle for definition and
539   ;; translation.
540   (name nil :type symbol)
541   ;; the arg/result type restrictions. We compute this from the
542   ;; PRIMITIVE-TYPE restrictions to make life easier for IR1 phases
543   ;; that need to anticipate LTN's template selection.
544   (type (missing-arg) :type ctype)
545   ;; lists of restrictions on the argument and result types. A
546   ;; restriction may take several forms:
547   ;; -- The restriction * is no restriction at all.
548   ;; -- A restriction (:OR <primitive-type>*) means that the operand
549   ;;    must have one of the specified primitive types.
550   ;; -- A restriction (:CONSTANT <predicate> <type-spec>) means that the
551   ;;    argument (not a result) must be a compile-time constant that
552   ;;    satisfies the specified predicate function. In this case, the
553   ;;    constant value will be passed as an info argument rather than
554   ;;    as a normal argument. <type-spec> is a Lisp type specifier for
555   ;;    the type tested by the predicate, used when we want to represent
556   ;;    the type constraint as a Lisp function type.
557   ;;
558   ;; If RESULT-TYPES is :CONDITIONAL, then this is an IF-FOO style
559   ;; conditional that yields its result as a control transfer. The
560   ;; emit function takes two info arguments: the target label and a
561   ;; boolean flag indicating whether to negate the sense of the test.
562   ;;
563   ;; If RESULT-TYPES is a cons whose car is :CONDITIONAL, then this is
564   ;; a flag-setting VOP. The rest is a list of condition descriptors to
565   ;; be interpreted by the BRANCH-IF VOP (see $ARCH/pred.lisp).
566   (arg-types nil :type list)
567   (result-types nil :type (or list (member :conditional) (cons (eql :conditional))))
568   ;; the primitive type restriction applied to each extra argument or
569   ;; result following the fixed operands. If NIL, no extra
570   ;; args/results are allowed. Otherwise, either * or a (:OR ...) list
571   ;; as described for the {ARG,RESULT}-TYPES.
572   (more-args-type nil :type (or (member nil *) cons))
573   (more-results-type nil :type (or (member nil *) cons))
574   ;; If true, this is a function that is called with no arguments to
575   ;; see whether this template can be emitted. This is used to
576   ;; conditionally compile for different target hardware
577   ;; configuarations (e.g. FP hardware.)
578   (guard nil :type (or function null))
579   ;; the policy under which this template is the best translation.
580   ;; Note that LTN might use this template under other policies if it
581   ;; can't figure out anything better to do.
582   (ltn-policy (missing-arg) :type ltn-policy)
583   ;; the base cost for this template, given optimistic assumptions
584   ;; such as no operand loading, etc.
585   (cost (missing-arg) :type index)
586   ;; If true, then this is a short noun-like phrase describing what
587   ;; this VOP "does", i.e. the implementation strategy. This is for
588   ;; use in efficiency notes.
589   (note nil :type (or string null))
590   ;; the number of trailing arguments to VOP or %PRIMITIVE that we
591   ;; bundle into a list and pass into the emit function. This provides
592   ;; a way to pass uninterpreted stuff directly to the code generator.
593   (info-arg-count 0 :type index)
594   ;; a function that emits the VOPs for this template. Arguments:
595   ;;  1] Node for source context.
596   ;;  2] IR2-BLOCK that we place the VOP in.
597   ;;  3] This structure.
598   ;;  4] Head of argument TN-REF list.
599   ;;  5] Head of result TN-REF list.
600   ;;  6] If INFO-ARG-COUNT is non-zero, then a list of the magic
601   ;;     arguments.
602   ;;
603   ;; Two values are returned: the first and last VOP emitted. This vop
604   ;; sequence must be linked into the VOP Next/Prev chain for the
605   ;; block. At least one VOP is always emitted.
606   (emit-function (missing-arg) :type function))
607 (defprinter (template)
608   name
609   arg-types
610   result-types
611   (more-args-type :test more-args-type :prin1 more-args-type)
612   (more-results-type :test more-results-type :prin1 more-results-type)
613   ltn-policy
614   cost
615   (note :test note)
616   (info-arg-count :test (not (zerop info-arg-count))))
617
618 ;;; A VOP-INFO object holds the constant information for a given
619 ;;; virtual operation. We include TEMPLATE so that functions with a
620 ;;; direct VOP equivalent can be translated easily.
621 (def!struct (vop-info
622              (:include template)
623              (:make-load-form-fun ignore-it))
624   ;; side effects of this VOP and side effects that affect the value
625   ;; of this VOP
626   (effects (missing-arg) :type attributes)
627   (affected (missing-arg) :type attributes)
628   ;; If true, causes special casing of TNs live after this VOP that
629   ;; aren't results:
630   ;; -- If T, all such TNs that are allocated in a SC with a defined
631   ;;    save-sc will be saved in a TN in the save SC before the VOP
632   ;;    and restored after the VOP. This is used by call VOPs. A bit
633   ;;    vector representing the live TNs is stored in the VOP-SAVE-SET.
634   ;; -- If :FORCE-TO-STACK, all such TNs will made into :ENVIRONMENT TNs
635   ;;    and forced to be allocated in SCs without any save-sc. This is
636   ;;    used by NLX entry vops.
637   ;; -- If :COMPUTE-ONLY, just compute the save set, don't do any saving.
638   ;;    This is used to get the live variables for debug info.
639   (save-p nil :type (member t nil :force-to-stack :compute-only))
640   ;; info for automatic emission of move-arg VOPs by representation
641   ;; selection. If NIL, then do nothing special. If non-null, then
642   ;; there must be a more arg. Each more arg is moved to its passing
643   ;; location using the appropriate representation-specific MOVE-ARG
644   ;; VOP. The first (fixed) argument must be the control-stack frame
645   ;; pointer for the frame to move into. The first info arg is the
646   ;; list of passing locations.
647   ;;
648   ;; Additional constraints depend on the value:
649   ;;
650   ;; :FULL-CALL
651   ;;     None.
652   ;;
653   ;; :LOCAL-CALL
654   ;;     The second (fixed) arg is the NFP for the called function (from
655   ;;     ALLOCATE-FRAME.)
656   ;;
657   ;; :KNOWN-RETURN
658   ;;     If needed, the old NFP is computed using COMPUTE-OLD-NFP.
659   (move-args nil :type (member nil :full-call :local-call :known-return))
660   ;; a list of sc-vectors representing the loading costs of each fixed
661   ;; argument and result
662   (arg-costs nil :type list)
663   (result-costs nil :type list)
664   ;; if true, SC-VECTORs representing the loading costs for any more
665   ;; args and results
666   (more-arg-costs nil :type (or sc-vector null))
667   (more-result-costs nil :type (or sc-vector null))
668   ;; lists of SC-VECTORs mapping each SC to the SCs that we can load
669   ;; into. If a SC is directly acceptable to the VOP, then the entry
670   ;; is T. Otherwise, it is a list of the SC numbers of all the SCs
671   ;; that we can load into. This list will be empty if there is no
672   ;; load function which loads from that SC to an SC allowed by the
673   ;; operand SC restriction.
674   (arg-load-scs nil :type list)
675   (result-load-scs nil :type list)
676   ;; if true, a function that is called with the VOP to do operand
677   ;; targeting. This is done by modifying the TN-REF-TARGET slots in
678   ;; the TN-REFS so that they point to other TN-REFS in the same VOP.
679   (target-fun nil :type (or null function))
680   ;; a function that emits assembly code for a use of this VOP when it
681   ;; is called with the VOP structure. This is null if this VOP has no
682   ;; specified generator (i.e. if it exists only to be inherited by
683   ;; other VOPs).
684   (generator-function nil :type (or function null))
685   ;; a list of things that are used to parameterize an inherited
686   ;; generator. This allows the same generator function to be used for
687   ;; a group of VOPs with similar implementations.
688   (variant nil :type list)
689   ;; the number of arguments and results. Each regular arg/result
690   ;; counts as one, and all the more args/results together count as 1.
691   (num-args 0 :type index)
692   (num-results 0 :type index)
693   ;; a vector of the temporaries the vop needs. See EMIT-GENERIC-VOP
694   ;; in vmdef for information on how the temps are encoded.
695   (temps nil :type (or null (specializable-vector (unsigned-byte 16))))
696   ;; the order all the refs for this vop should be put in. Each
697   ;; operand is assigned a number in the following ordering: args,
698   ;; more-args, results, more-results, temps. This vector represents
699   ;; the order the operands should be put into in the next-ref link.
700   (ref-ordering nil :type (or null (specializable-vector (unsigned-byte 8))))
701   ;; a vector of the various targets that should be done. Each element
702   ;; encodes the source ref (shifted 8, it is also encoded in
703   ;; MAX-VOP-TN-REFS) and the dest ref index.
704   (targets nil :type (or null (specializable-vector (unsigned-byte 16)))))
705 \f
706 ;;;; SBs and SCs
707
708 ;;; copied from docs/internals/retargeting.tex by WHN 19990707:
709 ;;;
710 ;;; A Storage Base represents a physical storage resource such as a
711 ;;; register set or stack frame. Storage bases for non-global
712 ;;; resources such as the stack are relativized by the environment
713 ;;; that the TN is allocated in. Packing conflict information is kept
714 ;;; in the storage base, but non-packed storage resources such as
715 ;;; closure environments also have storage bases.
716 ;;;
717 ;;; Some storage bases:
718 ;;;     General purpose registers
719 ;;;     Floating point registers
720 ;;;     Boxed (control) stack environment
721 ;;;     Unboxed (number) stack environment
722 ;;;     Closure environment
723 ;;;
724 ;;; A storage class is a potentially arbitrary set of the elements in
725 ;;; a storage base. Although conceptually there may be a hierarchy of
726 ;;; storage classes such as "all registers", "boxed registers", "boxed
727 ;;; scratch registers", this doesn't exist at the implementation
728 ;;; level. Such things can be done by specifying storage classes whose
729 ;;; locations overlap. A TN shouldn't have lots of overlapping SC's as
730 ;;; legal SC's, since time would be wasted repeatedly attempting to
731 ;;; pack in the same locations.
732 ;;;
733 ;;; ...
734 ;;;
735 ;;; Some SCs:
736 ;;;     Reg: any register (immediate objects)
737 ;;;     Save-Reg: a boxed register near r15 (registers easily saved in a call)
738 ;;;     Boxed-Reg: any boxed register (any boxed object)
739 ;;;     Unboxed-Reg: any unboxed register (any unboxed object)
740 ;;;     Float-Reg, Double-Float-Reg: float in FP register.
741 ;;;     Stack: boxed object on the stack (on control stack)
742 ;;;     Word: any 32bit unboxed object on nstack.
743 ;;;     Double: any 64bit unboxed object on nstack.
744
745 ;;; The SB structure represents the global information associated with
746 ;;; a storage base.
747 (def!struct (sb (:make-load-form-fun just-dump-it-normally))
748   ;; name, for printing and reference
749   (name nil :type symbol)
750   ;; the kind of storage base (which determines the packing
751   ;; algorithm)
752   (kind :non-packed :type (member :finite :unbounded :non-packed))
753   ;; the number of elements in the SB. If finite, this is the total
754   ;; size. If unbounded, this is the size that the SB is initially
755   ;; allocated at.
756   (size 0 :type index))
757 (defprinter (sb)
758   name)
759
760 ;;; A FINITE-SB holds information needed by the packing algorithm for
761 ;;; finite SBs.
762 (def!struct (finite-sb (:include sb))
763   ;; the number of locations currently allocated in this SB
764   (current-size 0 :type index)
765   ;; the last location packed in, used by pack to scatter TNs to
766   ;; prevent a few locations from getting all the TNs, and thus
767   ;; getting overcrowded, reducing the possibilities for targeting.
768   (last-offset 0 :type index)
769   ;; a vector containing, for each location in this SB, a vector
770   ;; indexed by IR2 block numbers, holding local conflict bit vectors.
771   ;; A TN must not be packed in a given location within a particular
772   ;; block if the LTN number for that TN in that block corresponds to
773   ;; a set bit in the bit-vector.
774   (conflicts '#() :type simple-vector)
775   ;; a vector containing, for each location in this SB, a bit-vector
776   ;; indexed by IR2 block numbers. If the bit corresponding to a block
777   ;; is set, then the location is in use somewhere in the block, and
778   ;; thus has a conflict for always-live TNs.
779   (always-live '#() :type simple-vector)
780   (always-live-count '#() :type simple-vector)
781   ;; a vector containing the TN currently live in each location in the
782   ;; SB, or NIL if the location is unused. This is used during load-tn pack.
783   (live-tns '#() :type simple-vector)
784   ;; the number of blocks for which the ALWAYS-LIVE and CONFLICTS
785   ;; might not be virgin, and thus must be reinitialized when PACK
786   ;; starts. Less then the length of those vectors when not all of the
787   ;; length was used on the previously packed component.
788   (last-block-count 0 :type index))
789
790 ;;; the SC structure holds the storage base that storage is allocated
791 ;;; in and information used to select locations within the SB
792 (def!struct (sc (:copier nil))
793   ;; name, for printing and reference
794   (name nil :type symbol)
795   ;; the number used to index SC cost vectors
796   (number 0 :type sc-number)
797   ;; the storage base that this SC allocates storage from
798   (sb nil :type (or sb null))
799   ;; the size of elements in this SC, in units of locations in the SB
800   (element-size 0 :type index)
801   ;; if our SB is finite, a list of the locations in this SC
802   (locations nil :type list)
803   ;; a list of the alternate (save) SCs for this SC
804   (alternate-scs nil :type list)
805   ;; a list of the constant SCs that can me moved into this SC
806   (constant-scs nil :type list)
807   ;; true if the values in this SC needs to be saved across calls
808   (save-p nil :type boolean)
809   ;; vectors mapping from SC numbers to information about how to load
810   ;; from the index SC to this one. MOVE-FUNS holds the names of
811   ;; the functions used to do loading, and LOAD-COSTS holds the cost
812   ;; of the corresponding move functions. If loading is impossible,
813   ;; then the entries are NIL. LOAD-COSTS is initialized to have a 0
814   ;; for this SC.
815   (move-funs (make-array sc-number-limit :initial-element nil)
816              :type sc-vector)
817   (load-costs (make-array sc-number-limit :initial-element nil)
818               :type sc-vector)
819   ;; a vector mapping from SC numbers to possibly
820   ;; representation-specific move and coerce VOPs. Each entry is a
821   ;; list of VOP-INFOs for VOPs that move/coerce an object in the
822   ;; index SC's representation into this SC's representation. This
823   ;; vector is filled out with entries for all SCs that can somehow be
824   ;; coerced into this SC, not just those VOPs defined to directly
825   ;; move into this SC (i.e. it allows for operand loading on the move
826   ;; VOP's operands.)
827   ;;
828   ;; When there are multiple applicable VOPs, the template arg and
829   ;; result type restrictions are used to determine which one to use.
830   ;; The list is sorted by increasing cost, so the first applicable
831   ;; VOP should be used.
832   ;;
833   ;; Move (or move-arg) VOPs with descriptor results shouldn't have
834   ;; TNs wired in the standard argument registers, since there may
835   ;; already be live TNs wired in those locations holding the values
836   ;; that we are setting up for unknown-values return.
837   (move-vops (make-array sc-number-limit :initial-element nil)
838              :type sc-vector)
839   ;; the costs corresponding to the MOVE-VOPS. Separate because this
840   ;; info is needed at meta-compile time, while the MOVE-VOPs don't
841   ;; exist till load time. If no move is defined, then the entry is
842   ;; NIL.
843   (move-costs (make-array sc-number-limit :initial-element nil)
844               :type sc-vector)
845   ;; similar to Move-VOPs, except that we only ever use the entries
846   ;; for this SC and its alternates, since we never combine complex
847   ;; representation conversion with argument passing.
848   (move-arg-vops (make-array sc-number-limit :initial-element nil)
849                  :type sc-vector)
850   ;; true if this SC or one of its alternates in in the NUMBER-STACK SB.
851   (number-stack-p nil :type boolean)
852   ;; alignment restriction. The offset must be an even multiple of this.
853   (alignment 1 :type (and index (integer 1)))
854   ;; a list of locations that we avoid packing in during normal
855   ;; register allocation to ensure that these locations will be free
856   ;; for operand loading. This prevents load-TN packing from thrashing
857   ;; by spilling a lot.
858   (reserve-locations nil :type list))
859 (defprinter (sc)
860   name)
861 \f
862 ;;;; TNs
863
864 (def!struct (tn (:include sset-element)
865                (:constructor make-random-tn)
866                (:constructor make-tn (number kind primitive-type sc))
867                (:copier nil))
868   ;; The kind of TN this is:
869   ;;
870   ;;   :NORMAL
871   ;;    A normal, non-constant TN, representing a variable or temporary.
872   ;;    Lifetime information is computed so that packing can be done.
873   ;;
874   ;;   :ENVIRONMENT
875   ;;    A TN that has hidden references (debugger or NLX), and thus must be
876   ;;    allocated for the duration of the environment it is referenced in.
877   ;;
878   ;;   :DEBUG-ENVIRONMENT
879   ;;    Like :ENVIRONMENT, but is used for TNs that we want to be able to
880   ;;    target to/from and that don't absolutely have to be live
881   ;;    everywhere. These TNs are live in all blocks in the environment
882   ;;    that don't reference this TN.
883   ;;
884   ;;   :COMPONENT
885   ;;    A TN that implicitly conflicts with all other TNs. No conflict
886   ;;    info is computed.
887   ;;
888   ;;   :SAVE
889   ;;   :SAVE-ONCE
890   ;;    A TN used for saving a :NORMAL TN across function calls. The
891   ;;    lifetime information slots are unitialized: get the original
892   ;;    TN our of the SAVE-TN slot and use it for conflicts. SAVE-ONCE
893   ;;    is like :SAVE, except that it is only save once at the single
894   ;;    writer of the original TN.
895   ;;
896   ;;   :SPECIFIED-SAVE
897   ;;    A TN that was explicitly specified as the save TN for another TN.
898   ;;    When we actually get around to doing the saving, this will be
899   ;;    changed to :SAVE or :SAVE-ONCE.
900   ;;
901   ;;   :LOAD
902   ;;    A load-TN used to compute an argument or result that is
903   ;;    restricted to some finite SB. Load TNs don't have any conflict
904   ;;    information. Load TN pack uses a special local conflict
905   ;;    determination method.
906   ;;
907   ;;   :CONSTANT
908   ;;    Represents a constant, with TN-LEAF a CONSTANT leaf. Lifetime
909   ;;    information isn't computed, since the value isn't allocated by
910   ;;    pack, but is instead generated as a load at each use. Since
911   ;;    lifetime analysis isn't done on :CONSTANT TNs, they don't have
912   ;;    LOCAL-NUMBERs and similar stuff.
913   ;;
914   ;;   :ALIAS
915   ;;    A special kind of TN used to represent initialization of local
916   ;;    call arguments in the caller. It provides another name for the
917   ;;    argument TN so that lifetime analysis doesn't get confused by
918   ;;    self-recursive calls. Lifetime analysis treats this the same
919   ;;    as :NORMAL, but then at the end merges the conflict info into
920   ;;    the original TN and replaces all uses of the alias with the
921   ;;    original TN. SAVE-TN holds the aliased TN.
922   (kind (missing-arg)
923         :type (member :normal :environment :debug-environment
924                       :save :save-once :specified-save :load :constant
925                       :component :alias))
926   ;; the primitive-type for this TN's value. Null in restricted or
927   ;; wired TNs.
928   (primitive-type nil :type (or primitive-type null))
929   ;; If this TN represents a variable or constant, then this is the
930   ;; corresponding LEAF.
931   (leaf nil :type (or leaf null))
932   ;; thread that links TNs together so that we can find them
933   (next nil :type (or tn null))
934   ;; head of TN-REF lists for reads and writes of this TN
935   (reads nil :type (or tn-ref null))
936   (writes nil :type (or tn-ref null))
937   ;; a link we use when building various temporary TN lists
938   (next* nil :type (or tn null))
939   ;; some block that contains a reference to this TN, or NIL if we
940   ;; haven't seen any reference yet. If the TN is local, then this is
941   ;; the block it is local to.
942   (local nil :type (or ir2-block null))
943   ;; If a local TN, the block relative number for this TN. Global TNs
944   ;; whose liveness changes within a block are also assigned a local
945   ;; number during the conflicts analysis of that block. If the TN has
946   ;; no local number within the block, then this is NIL.
947   (local-number nil :type (or local-tn-number null))
948   ;; If this object is a local TN, this slot is a bit-vector with 1
949   ;; for the local-number of every TN that we conflict with.
950   (local-conflicts (make-array local-tn-limit
951                                :element-type 'bit
952                                :initial-element 0)
953                    :type local-tn-bit-vector)
954   ;; head of the list of GLOBAL-CONFLICTS structures for a global TN.
955   ;; This list is sorted by block number (i.e. reverse DFO), allowing
956   ;; the intersection between the lifetimes for two global TNs to be
957   ;; easily found. If null, then this TN is a local TN.
958   (global-conflicts nil :type (or global-conflicts null))
959   ;; During lifetime analysis, this is used as a pointer into the
960   ;; conflicts chain, for scanning through blocks in reverse DFO.
961   (current-conflict nil)
962   ;; In a :SAVE TN, this is the TN saved. In a :NORMAL or :ENVIRONMENT
963   ;; TN, this is the associated save TN. In TNs with no save TN, this
964   ;; is null.
965   (save-tn nil :type (or tn null))
966   ;; After pack, the SC we packed into. Beforehand, the SC we want to
967   ;; pack into, or null if we don't know.
968   (sc nil :type (or sc null))
969   ;; the offset within the SB that this TN is packed into. This is what
970   ;; indicates that the TN is packed
971   (offset nil :type (or index null))
972   ;; some kind of info about how important this TN is
973   (cost 0 :type fixnum)
974   ;; If a :ENVIRONMENT or :DEBUG-ENVIRONMENT TN, this is the
975   ;; physical environment that the TN is live throughout.
976   (physenv nil :type (or physenv null))
977   ;; The depth of the deepest loop that this TN is used in.
978   (loop-depth 0 :type fixnum))
979 (def!method print-object ((tn tn) stream)
980   (print-unreadable-object (tn stream :type t)
981     ;; KLUDGE: The distinction between PRINT-TN and PRINT-OBJECT on TN is
982     ;; not very mnemonic. -- WHN 20000124
983     (print-tn-guts tn stream)))
984
985 ;;; The GLOBAL-CONFLICTS structure represents the conflicts for global
986 ;;; TNs. Each global TN has a list of these structures, one for each
987 ;;; block that it is live in. In addition to repsenting the result of
988 ;;; lifetime analysis, the global conflicts structure is used during
989 ;;; lifetime analysis to represent the set of TNs live at the start of
990 ;;; the IR2 block.
991 (defstruct (global-conflicts
992             (:constructor make-global-conflicts (kind tn block number))
993             (:copier nil))
994   ;; the IR2-BLOCK that this structure represents the conflicts for
995   (block (missing-arg) :type ir2-block)
996   ;; thread running through all the GLOBAL-CONFLICTSs for BLOCK. This
997   ;; thread is sorted by TN number
998   (next-blockwise nil :type (or global-conflicts null))
999   ;; the way that TN is used by BLOCK
1000   ;;
1001   ;;   :READ
1002   ;;     The TN is read before it is written. It starts the block live,
1003   ;;     but is written within the block.
1004   ;;
1005   ;;   :WRITE
1006   ;;     The TN is written before any read. It starts the block dead,
1007   ;;     and need not have a read within the block.
1008   ;;
1009   ;;   :READ-ONLY
1010   ;;     The TN is read, but never written. It starts the block live,
1011   ;;     and is not killed by the block. Lifetime analysis will promote
1012   ;;     :READ-ONLY TNs to :LIVE if they are live at the block end.
1013   ;;
1014   ;;   :LIVE
1015   ;;     The TN is not referenced. It is live everywhere in the block.
1016   (kind :read-only :type (member :read :write :read-only :live))
1017   ;; a local conflicts vector representing conflicts with TNs live in
1018   ;; BLOCK. The index for the local TN number of each TN we conflict
1019   ;; with in this block is 1. To find the full conflict set, the :LIVE
1020   ;; TNs for BLOCK must also be included. This slot is not meaningful
1021   ;; when KIND is :LIVE.
1022   (conflicts (make-array local-tn-limit
1023                          :element-type 'bit
1024                          :initial-element 0)
1025              :type local-tn-bit-vector)
1026   ;; the TN we are recording conflicts for.
1027   (tn (missing-arg) :type tn)
1028   ;; thread through all the GLOBAL-CONFLICTSs for TN
1029   (next-tnwise nil :type (or global-conflicts null))
1030   ;; TN's local TN number in BLOCK. :LIVE TNs don't have local numbers.
1031   (number nil :type (or local-tn-number null)))
1032 (defprinter (global-conflicts)
1033   tn
1034   block
1035   kind
1036   (number :test number))