X-Git-Url: http://repo.macrolet.net/gitweb/?a=blobdiff_plain;f=src%2Fcompiler%2Fvop.lisp;h=29d1a491939b8cbf5059421e6f842c8dcd23aff5;hb=c1aeac123df223746249567a9c0d2f656d1222cb;hp=697730189153e0da5ec943935f3ae80fbf7c5202;hpb=7c07a6f965c51828d8f452b47e0620d8e6cf2959;p=sbcl.git diff --git a/src/compiler/vop.lisp b/src/compiler/vop.lisp index 6977301..29d1a49 100644 --- a/src/compiler/vop.lisp +++ b/src/compiler/vop.lisp @@ -47,7 +47,7 @@ (scs nil :type list) ;; the Lisp type equivalent to this type. If this type could never be ;; returned by PRIMITIVE-TYPE, then this is the NIL (or empty) type - (type (required-argument) :type ctype) + (type (missing-arg) :type ctype) ;; the template used to check that an object is of this type. This is a ;; template of one argument and one result, both of primitive-type T. If ;; the argument is of the correct type, then it is delivered into the @@ -77,8 +77,8 @@ ;;; environment pointer should be saved after the binding is ;;; instantiated. ;;; -;;; Environment-Info -;;; Holds the IR2-Environment structure. +;;; Physenv-Info +;;; Holds the Ir2-Physenv structure. ;;; ;;; Tail-Set-Info ;;; Holds the Return-Info structure. @@ -312,7 +312,7 @@ ;;; IR2 conversion may need to compile a forward reference. In this ;;; case the slots aren't actually initialized until entry analysis runs. (defstruct (entry-info (:copier nil)) - ;; true if this function has a non-null closure environment + ;; Does this function have a non-null closure environment? (closure-p nil :type boolean) ;; a label pointing to the entry vector for this function, or NIL ;; before ENTRY-ANALYZE runs @@ -328,25 +328,28 @@ ;; of this function (type 'function :type (or list (member function)))) -;;; An IR2-ENVIRONMENT is used to annotate non-LET lambdas with their -;;; passing locations. It is stored in the Environment-Info. -(defstruct (ir2-environment (:copier nil)) - ;; the TNs that hold the passed environment within the function. - ;; This is an alist translating from the NLX-Info or lambda-var to - ;; the TN that holds the corresponding value within this function. - ;; This list is in the same order as the ENVIRONMENT-CLOSURE. - (environment nil :type list) +;;; An IR2-PHYSENV is used to annotate non-LET LAMBDAs with their +;;; passing locations. It is stored in the PHYSENV-INFO. +(defstruct (ir2-physenv (:copier nil)) + ;; TN info for closed-over things within the function: an alist + ;; mapping from NLX-INFOs and LAMBDA-VARs to TNs holding the + ;; corresponding thing within this function + ;; + ;; Elements of this list have a one-to-one correspondence with + ;; elements of the PHYSENV-CLOSURE list of the PHYSENV object that + ;; links to us. + (closure (missing-arg) :type list :read-only t) ;; the TNs that hold the OLD-FP and RETURN-PC within the function. ;; We always save these so that the debugger can do a backtrace, ;; even if the function has no return (and thus never uses them). ;; Null only temporarily. (old-fp nil :type (or tn null)) (return-pc nil :type (or tn null)) - ;; The passing location for the Return-PC. The return PC is treated + ;; The passing location for the RETURN-PC. The return PC is treated ;; differently from the other arguments, since in some ;; implementations we may use a call instruction that requires the ;; return PC to be passed in a particular place. - (return-pc-pass (required-argument) :type tn) + (return-pc-pass (missing-arg) :type tn :read-only t) ;; True if this function has a frame on the number stack. This is ;; set by representation selection whenever it is possible that some ;; function in our tail set will make use of the number stack. @@ -355,8 +358,8 @@ (live-tns nil :type list) ;; a list of all the :DEBUG-ENVIRONMENT TNs live in this environment (debug-live-tns nil :type list) - ;; a label that marks the start of elsewhere code for this function. - ;; Null until this label is assigned by codegen. Used for + ;; a label that marks the start of elsewhere code for this function, + ;; or null until this label is assigned by codegen. Used for ;; maintaining the debug source map. (elsewhere-start nil :type (or label null)) ;; a label that marks the first location in this function at which @@ -364,8 +367,8 @@ ;; from their passing locations, etc. This is the start of the ;; function as far as the debugger is concerned. (environment-start nil :type (or label null))) -(defprinter (ir2-environment) - environment +(defprinter (ir2-physenv) + closure old-fp return-pc return-pc-pass) @@ -377,11 +380,11 @@ ;; The return convention used: ;; -- If :UNKNOWN, we use the standard return convention. ;; -- If :FIXED, we use the known-values convention. - (kind (required-argument) :type (member :fixed :unknown)) + (kind (missing-arg) :type (member :fixed :unknown)) ;; the number of values returned, or :UNKNOWN if we don't know. ;; COUNT may be known when KIND is :UNKNOWN, since we may choose the ;; standard return convention for other reasons. - (count (required-argument) :type (or index (member :unknown))) + (count (missing-arg) :type (or index (member :unknown))) ;; If count isn't :UNKNOWN, then this is a list of the ;; primitive-types of each value. (types () :type list) @@ -400,13 +403,13 @@ ;; block pointer. In the other cases nobody directly references the ;; unwind-block, so we leave this slot null. (home nil :type (or tn null)) - ;; The saved control stack pointer. - (save-sp (required-argument) :type tn) - ;; The list of dynamic state save TNs. + ;; the saved control stack pointer + (save-sp (missing-arg) :type tn) + ;; the list of dynamic state save TNs (dynamic-state (list* (make-stack-pointer-tn) (make-dynamic-state-tns)) :type list) - ;; The target label for NLX entry. + ;; the target label for NLX entry (target (gen-label) :type label)) (defprinter (ir2-nlx-info) home @@ -419,30 +422,30 @@ ;;; operands to the operation. (defstruct (vop (:constructor make-vop (block node info args results)) (:copier nil)) - ;; VOP-Info structure containing static info about the operation. + ;; VOP-Info structure containing static info about the operation (info nil :type (or vop-info null)) - ;; The IR2-Block this VOP is in. - (block (required-argument) :type ir2-block) + ;; the IR2-Block this VOP is in + (block (missing-arg) :type ir2-block) ;; VOPs evaluated after and before this one. Null at the ;; beginning/end of the block, and temporarily during IR2 ;; translation. (next nil :type (or vop null)) (prev nil :type (or vop null)) - ;; Heads of the TN-Ref lists for operand TNs, linked using the - ;; Across slot. + ;; heads of the TN-Ref lists for operand TNs, linked using the + ;; Across slot (args nil :type (or tn-ref null)) (results nil :type (or tn-ref null)) - ;; Head of the list of write refs for each explicitly allocated - ;; temporary, linked together using the Across slot. + ;; head of the list of write refs for each explicitly allocated + ;; temporary, linked together using the Across slot (temps nil :type (or tn-ref null)) - ;; Head of the list of all TN-refs for references in this VOP, + ;; head of the list of all TN-refs for references in this VOP, ;; linked by the Next-Ref slot. There will be one entry for each ;; operand and two (a read and a write) for each temporary. (refs nil :type (or tn-ref null)) - ;; Stuff that is passed uninterpreted from IR2 conversion to + ;; stuff that is passed uninterpreted from IR2 conversion to ;; codegen. The meaning of this slot is totally dependent on the VOP. codegen-info - ;; Node that generated this VOP, for keeping track of debug info. + ;; the node that generated this VOP, for keeping track of debug info (node nil :type (or node null)) ;; Local-TN bit vector representing the set of TNs live after args ;; are read and before results are written. This is only filled in @@ -460,7 +463,7 @@ (defstruct (tn-ref (:constructor make-tn-ref (tn write-p)) (:copier nil)) ;; the TN referenced - (tn (required-argument) :type tn) + (tn (missing-arg) :type tn) ;; Is this is a write reference? (as opposed to a read reference) (write-p nil :type boolean) ;; the link for a list running through all TN-Refs for this TN of @@ -497,7 +500,7 @@ ;; the arg/result type restrictions. We compute this from the ;; PRIMITIVE-TYPE restrictions to make life easier for IR1 phases ;; that need to anticipate LTN's template selection. - (type (required-argument) :type function-type) + (type (missing-arg) :type fun-type) ;; lists of restrictions on the argument and result types. A ;; restriction may take several forms: ;; -- The restriction * is no restriction at all. @@ -512,7 +515,7 @@ ;; the type constraint as a Lisp function type. ;; ;; If RESULT-TYPES is :CONDITIONAL, then this is an IF-FOO style - ;; conditional that yeilds its result as a control transfer. The + ;; conditional that yields its result as a control transfer. The ;; emit function takes two info arguments: the target label and a ;; boolean flag indicating whether to negate the sense of the test. (arg-types nil :type list) @@ -531,15 +534,15 @@ ;; the policy under which this template is the best translation. ;; Note that LTN might use this template under other policies if it ;; can't figure out anything better to do. - (ltn-policy (required-argument) :type ltn-policy) + (ltn-policy (missing-arg) :type ltn-policy) ;; the base cost for this template, given optimistic assumptions ;; such as no operand loading, etc. - (cost (required-argument) :type index) + (cost (missing-arg) :type index) ;; If true, then this is a short noun-like phrase describing what ;; this VOP "does", i.e. the implementation strategy. This is for ;; use in efficiency notes. (note nil :type (or string null)) - ;; The number of trailing arguments to VOP or %PRIMITIVE that we + ;; the number of trailing arguments to VOP or %PRIMITIVE that we ;; bundle into a list and pass into the emit function. This provides ;; a way to pass uninterpreted stuff directly to the code generator. (info-arg-count 0 :type index) @@ -555,7 +558,7 @@ ;; Two values are returned: the first and last VOP emitted. This vop ;; sequence must be linked into the VOP Next/Prev chain for the ;; block. At least one VOP is always emitted. - (emit-function (required-argument) :type function)) + (emit-function (missing-arg) :type function)) (defprinter (template) name arg-types @@ -575,8 +578,8 @@ (:make-load-form-fun ignore-it)) ;; side-effects of this VOP and side-effects that affect the value ;; of this VOP - (effects (required-argument) :type attributes) - (affected (required-argument) :type attributes) + (effects (missing-arg) :type attributes) + (affected (missing-arg) :type attributes) ;; If true, causes special casing of TNs live after this VOP that ;; aren't results: ;; -- If T, all such TNs that are allocated in a SC with a defined @@ -626,13 +629,13 @@ (arg-load-scs nil :type list) (result-load-scs nil :type list) ;; if true, a function that is called with the VOP to do operand - ;; targeting. This is done by modifiying the TN-Ref-Target slots in - ;; the TN-Refs so that they point to other TN-Refs in the same VOP. + ;; targeting. This is done by modifying the TN-REF-TARGET slots in + ;; the TN-REFS so that they point to other TN-REFS in the same VOP. (target-function nil :type (or null function)) ;; a function that emits assembly code for a use of this VOP when it - ;; is called with the VOP structure. Null if this VOP has no - ;; specified generator (i.e. it exists only to be inherited by other - ;; VOPs.) + ;; is called with the VOP structure. This is null if this VOP has no + ;; specified generator (i.e. if it exists only to be inherited by + ;; other VOPs). (generator-function nil :type (or function null)) ;; a list of things that are used to parameterize an inherited ;; generator. This allows the same generator function to be used for @@ -696,42 +699,42 @@ ;;; The SB structure represents the global information associated with ;;; a storage base. (def!struct (sb (:make-load-form-fun just-dump-it-normally)) - ;; Name, for printing and reference. + ;; name, for printing and reference (name nil :type symbol) - ;; The kind of storage base (which determines the packing - ;; algorithm). + ;; the kind of storage base (which determines the packing + ;; algorithm) (kind :non-packed :type (member :finite :unbounded :non-packed)) - ;; The number of elements in the SB. If finite, this is the total + ;; the number of elements in the SB. If finite, this is the total ;; size. If unbounded, this is the size that the SB is initially ;; allocated at. (size 0 :type index)) (defprinter (sb) name) -;;; The Finite-SB structure holds information needed by the packing -;;; algorithm for finite SBs. +;;; A FINITE-SB holds information needed by the packing algorithm for +;;; finite SBs. (def!struct (finite-sb (:include sb)) - ;; The number of locations currently allocated in this SB. + ;; the number of locations currently allocated in this SB (current-size 0 :type index) - ;; The last location packed in, used by pack to scatter TNs to + ;; the last location packed in, used by pack to scatter TNs to ;; prevent a few locations from getting all the TNs, and thus ;; getting overcrowded, reducing the possibilities for targeting. (last-offset 0 :type index) - ;; A vector containing, for each location in this SB, a vector + ;; a vector containing, for each location in this SB, a vector ;; indexed by IR2 block numbers, holding local conflict bit vectors. ;; A TN must not be packed in a given location within a particular ;; block if the LTN number for that TN in that block corresponds to ;; a set bit in the bit-vector. (conflicts '#() :type simple-vector) - ;; A vector containing, for each location in this SB, a bit-vector + ;; a vector containing, for each location in this SB, a bit-vector ;; indexed by IR2 block numbers. If the bit corresponding to a block ;; is set, then the location is in use somewhere in the block, and ;; thus has a conflict for always-live TNs. (always-live '#() :type simple-vector) - ;; A vector containing the TN currently live in each location in the + ;; a vector containing the TN currently live in each location in the ;; SB, or NIL if the location is unused. This is used during load-tn pack. (live-tns '#() :type simple-vector) - ;; The number of blocks for which the ALWAYS-LIVE and CONFLICTS + ;; the number of blocks for which the ALWAYS-LIVE and CONFLICTS ;; might not be virgin, and thus must be reinitialized when PACK ;; starts. Less then the length of those vectors when not all of the ;; length was used on the previously packed component. @@ -837,10 +840,10 @@ ;; ;; :SAVE ;; :SAVE-ONCE - ;; A TN used for saving a :Normal TN across function calls. The + ;; A TN used for saving a :NORMAL TN across function calls. The ;; lifetime information slots are unitialized: get the original - ;; TN our of the SAVE-TN slot and use it for conflicts. Save-Once - ;; is like :Save, except that it is only save once at the single + ;; TN our of the SAVE-TN slot and use it for conflicts. SAVE-ONCE + ;; is like :SAVE, except that it is only save once at the single ;; writer of the original TN. ;; ;; :SPECIFIED-SAVE @@ -855,11 +858,11 @@ ;; determination method. ;; ;; :CONSTANT - ;; Represents a constant, with TN-Leaf a Constant leaf. Lifetime + ;; Represents a constant, with TN-LEAF a CONSTANT leaf. Lifetime ;; information isn't computed, since the value isn't allocated by ;; pack, but is instead generated as a load at each use. Since - ;; lifetime analysis isn't done on :Constant TNs, they don't have - ;; Local-Numbers and similar stuff. + ;; lifetime analysis isn't done on :CONSTANT TNs, they don't have + ;; LOCAL-NUMBERs and similar stuff. ;; ;; :ALIAS ;; A special kind of TN used to represent initialization of local @@ -869,24 +872,24 @@ ;; as :NORMAL, but then at the end merges the conflict info into ;; the original TN and replaces all uses of the alias with the ;; original TN. SAVE-TN holds the aliased TN. - (kind (required-argument) + (kind (missing-arg) :type (member :normal :environment :debug-environment :save :save-once :specified-save :load :constant :component :alias)) - ;; The primitive-type for this TN's value. Null in restricted or + ;; the primitive-type for this TN's value. Null in restricted or ;; wired TNs. (primitive-type nil :type (or primitive-type null)) ;; If this TN represents a variable or constant, then this is the ;; corresponding Leaf. (leaf nil :type (or leaf null)) - ;; Thread that links TNs together so that we can find them. + ;; thread that links TNs together so that we can find them (next nil :type (or tn null)) - ;; Head of TN-Ref lists for reads and writes of this TN. + ;; head of TN-Ref lists for reads and writes of this TN (reads nil :type (or tn-ref null)) (writes nil :type (or tn-ref null)) - ;; A link we use when building various temporary TN lists. + ;; a link we use when building various temporary TN lists (next* nil :type (or tn null)) - ;; Some block that contains a reference to this TN, or Nil if we + ;; some block that contains a reference to this TN, or Nil if we ;; haven't seen any reference yet. If the TN is local, then this is ;; the block it is local to. (local nil :type (or ir2-block null)) @@ -895,18 +898,18 @@ ;; number during the conflicts analysis of that block. If the TN has ;; no local number within the block, then this is Nil. (local-number nil :type (or local-tn-number null)) - ;; If a local TN, a bit-vector with 1 for the local-number of every - ;; TN that we conflict with. + ;; If this object is a local TN, this slot is a bit-vector with 1 + ;; for the local-number of every TN that we conflict with. (local-conflicts (make-array local-tn-limit :element-type 'bit :initial-element 0) :type local-tn-bit-vector) - ;; Head of the list of Global-Conflicts structures for a global TN. + ;; head of the list of GLOBAL-CONFLICTS structures for a global TN. ;; This list is sorted by block number (i.e. reverse DFO), allowing ;; the intersection between the lifetimes for two global TNs to be ;; easily found. If null, then this TN is a local TN. (global-conflicts nil :type (or global-conflicts null)) - ;; During lifetime analysis, this is used as a pointer into the - ;; conflicts chain, for scanning through blocks in reverse DFO. + ;; during lifetime analysis, this is used as a pointer into the + ;; conflicts chain, for scanning through blocks in reverse DFO (current-conflict nil) ;; In a :SAVE TN, this is the TN saved. In a :NORMAL or :ENVIRONMENT ;; TN, this is the associated save TN. In TNs with no save TN, this @@ -915,14 +918,14 @@ ;; After pack, the SC we packed into. Beforehand, the SC we want to ;; pack into, or null if we don't know. (sc nil :type (or sc null)) - ;; The offset within the SB that this TN is packed into. This is what - ;; indicates that the TN is packed. + ;; the offset within the SB that this TN is packed into. This is what + ;; indicates that the TN is packed (offset nil :type (or index null)) - ;; Some kind of info about how important this TN is. + ;; some kind of info about how important this TN is (cost 0 :type fixnum) - ;; If a :ENVIRONMENT or :DEBUG-ENVIRONMENT TN, this is the environment that - ;; the TN is live throughout. - (environment nil :type (or environment null))) + ;; If a :ENVIRONMENT or :DEBUG-ENVIRONMENT TN, this is the + ;; physical environment that the TN is live throughout. + (physenv nil :type (or physenv null))) (def!method print-object ((tn tn) stream) (print-unreadable-object (tn stream :type t) ;; KLUDGE: The distinction between PRINT-TN and PRINT-OBJECT on TN is @@ -938,12 +941,12 @@ (defstruct (global-conflicts (:constructor make-global-conflicts (kind tn block number)) (:copier nil)) - ;; The IR2-Block that this structure represents the conflicts for. - (block (required-argument) :type ir2-block) - ;; Thread running through all the Global-Conflict for Block. This - ;; thread is sorted by TN number. + ;; the IR2-Block that this structure represents the conflicts for + (block (missing-arg) :type ir2-block) + ;; thread running through all the Global-Conflict for Block. This + ;; thread is sorted by TN number (next nil :type (or global-conflicts null)) - ;; The way that TN is used by Block: + ;; the way that TN is used by Block ;; ;; :READ ;; The TN is read before it is written. It starts the block live, @@ -961,7 +964,7 @@ ;; :LIVE ;; The TN is not referenced. It is live everywhere in the block. (kind :read-only :type (member :read :write :read-only :live)) - ;; A local conflicts vector representing conflicts with TNs live in + ;; a local conflicts vector representing conflicts with TNs live in ;; Block. The index for the local TN number of each TN we conflict ;; with in this block is 1. To find the full conflict set, the :Live ;; TNs for Block must also be included. This slot is not meaningful @@ -970,9 +973,9 @@ :element-type 'bit :initial-element 0) :type local-tn-bit-vector) - ;; The TN we are recording conflicts for. - (tn (required-argument) :type tn) - ;; Thread through all the Global-Conflicts for TN. + ;; the TN we are recording conflicts for. + (tn (missing-arg) :type tn) + ;; thread through all the Global-Conflicts for TN (tn-next nil :type (or global-conflicts null)) ;; TN's local TN number in Block. :Live TNs don't have local numbers. (number nil :type (or local-tn-number null)))