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