X-Git-Url: http://repo.macrolet.net/gitweb/?a=blobdiff_plain;f=src%2Fcompiler%2Fmeta-vmdef.lisp;h=0e2975b360188b07ecb5f5220711514f5e034300;hb=0dcc957ae6bf24809fda82fd59c134e70058c42a;hp=61a30790a4c59613bd66efaf696cbfe667718185;hpb=cfb9e3640e34706acdfccd26236024de259f3b4f;p=sbcl.git diff --git a/src/compiler/meta-vmdef.lisp b/src/compiler/meta-vmdef.lisp index 61a3079..0e2975b 100644 --- a/src/compiler/meta-vmdef.lisp +++ b/src/compiler/meta-vmdef.lisp @@ -20,21 +20,17 @@ ;;;; storage class and storage base definition -;;; Enter the basic structure at meta-compile time, and then fill in the -;;; missing slots at load time. +;;; Define a storage base having the specified NAME. KIND may be :FINITE, +;;; :UNBOUNDED or :NON-PACKED. The following keywords are legal: +;;; :SIZE specifies the number of locations in a :FINITE SB or +;;; the initial size of an :UNBOUNDED SB. +;;; +;;; We enter the basic structure at meta-compile time, and then fill +;;; in the missing slots at load time. (defmacro define-storage-base (name kind &key size) - #!+sb-doc - "Define-Storage-Base Name Kind {Key Value}* - Define a storage base having the specified Name. Kind may be :Finite, - :Unbounded or :Non-Packed. The following keywords are legal: - :Size - Specify the number of locations in a :Finite SB or the initial size of a - :Unbounded SB." - - ;; FIXME: Replace with DECLARE. - (check-type name symbol) - (check-type kind (member :finite :unbounded :non-packed)) + (declare (type symbol name)) + (declare (type (member :finite :unbounded :non-packed) kind)) ;; SIZE is either mandatory or forbidden. (ecase kind @@ -43,7 +39,7 @@ (error "A size specification is meaningless in a ~S SB." kind))) ((:finite :unbounded) (unless size (error "Size is not specified in a ~S SB." kind)) - (check-type size unsigned-byte))) + (aver (typep size 'unsigned-byte)))) (let ((res (if (eq kind :non-packed) (make-sb :name name :kind kind) @@ -87,54 +83,48 @@ (/show0 "finished with DEFINE-STORAGE-BASE expansion") ',name))) +;;; Define a storage class Name that uses the named Storage-Base. Number is a +;;; small, non-negative integer that is used as an alias. The following +;;; keywords are defined: +;;; +;;; :Element-Size Size +;;; The size of objects in this SC in whatever units the SB uses. This +;;; defaults to 1. +;;; +;;; :Alignment Size +;;; The alignment restrictions for this SC. TNs will only be allocated at +;;; offsets that are an even multiple of this number. Defaults to 1. +;;; +;;; :Locations (Location*) +;;; If the SB is :Finite, then this is a list of the offsets within the SB +;;; that are in this SC. +;;; +;;; :Reserve-Locations (Location*) +;;; A subset of the Locations that the register allocator should try to +;;; reserve for operand loading (instead of to hold variable values.) +;;; +;;; :Save-P {T | NIL} +;;; If T, then values stored in this SC must be saved in one of the +;;; non-save-p :Alternate-SCs across calls. +;;; +;;; :Alternate-SCs (SC*) +;;; Indicates other SCs that can be used to hold values from this SC across +;;; calls or when storage in this SC is exhausted. The SCs should be +;;; specified in order of decreasing \"goodness\". There must be at least +;;; one SC in an unbounded SB, unless this SC is only used for restricted or +;;; wired TNs. +;;; +;;; :Constant-SCs (SC*) +;;; A list of the names of all the constant SCs that can be loaded into this +;;; SC by a move function. (defmacro define-storage-class (name number sb-name &key (element-size '1) (alignment '1) locations reserve-locations save-p alternate-scs constant-scs) - #!+sb-doc - "Define-Storage-Class Name Number Storage-Base {Key Value}* - Define a storage class Name that uses the named Storage-Base. Number is a - small, non-negative integer that is used as an alias. The following - keywords are defined: - - :Element-Size Size - The size of objects in this SC in whatever units the SB uses. This - defaults to 1. - - :Alignment Size - The alignment restrictions for this SC. TNs will only be allocated at - offsets that are an even multiple of this number. Defaults to 1. - - :Locations (Location*) - If the SB is :Finite, then this is a list of the offsets within the SB - that are in this SC. - - :Reserve-Locations (Location*) - A subset of the Locations that the register allocator should try to - reserve for operand loading (instead of to hold variable values.) - - :Save-P {T | NIL} - If T, then values stored in this SC must be saved in one of the - non-save-p :Alternate-SCs across calls. - - :Alternate-SCs (SC*) - Indicates other SCs that can be used to hold values from this SC across - calls or when storage in this SC is exhausted. The SCs should be - specified in order of decreasing \"goodness\". There must be at least - one SC in an unbounded SB, unless this SC is only used for restricted or - wired TNs. - - :Constant-SCs (SC*) - A list of the names of all the constant SCs that can be loaded into this - SC by a move function." - - (check-type name symbol) - (check-type number sc-number) - (check-type sb-name symbol) - (check-type locations list) - (check-type reserve-locations list) - (check-type save-p boolean) - (check-type alternate-scs list) - (check-type constant-scs list) + (declare (type symbol name)) + (declare (type sc-number number)) + (declare (type symbol sb-name)) + (declare (type list locations reserve-locations alternate-scs constant-scs)) + (declare (type boolean save-p)) (unless (= (logcount alignment) 1) (error "alignment not a power of two: ~D" alignment)) @@ -142,9 +132,9 @@ (if (eq (sb-kind sb) :finite) (let ((size (sb-size sb)) (element-size (eval element-size))) - (check-type element-size unsigned-byte) + (declare (type unsigned-byte element-size)) (dolist (el locations) - (check-type el unsigned-byte) + (declare (type unsigned-byte el)) (unless (<= 1 (+ el element-size) size) (error "SC element ~D out of bounds for ~S" el sb)))) (when locations @@ -210,18 +200,17 @@ (let ((,to-sc-var (meta-sc-or-lose to))) ,@body)))))) +;;; Define the function NAME and note it as the function used for +;;; moving operands from the From-SCs to the To-SCs. Cost is the cost +;;; of this move operation. The function is called with three +;;; arguments: the VOP (for context), and the source and destination +;;; TNs. An ASSEMBLE form is wrapped around the body. All uses of +;;; DEFINE-MOVE-FUNCTION should be compiled before any uses of +;;; DEFINE-VOP. (defmacro define-move-function ((name cost) lambda-list scs &body body) - #!+sb-doc - "Define-Move-Function (Name Cost) lambda-list ({(From-SC*) (To-SC*)}*) form* - Define the function Name and note it as the function used for moving operands - from the From-SCs to the To-SCs. Cost is the cost of this move operation. - The function is called with three arguments: the VOP (for context), and the - source and destination TNs. An ASSEMBLE form is wrapped around the body. - All uses of DEFINE-MOVE-FUNCTION should be compiled before any uses of - DEFINE-VOP." + (declare (type index cost)) (when (or (oddp (length scs)) (null scs)) (error "malformed SCs spec: ~S" scs)) - (check-type cost index) `(progn (eval-when (:compile-toplevel :load-toplevel :execute) (do-sc-pairs (from-sc to-sc ',scs) @@ -279,24 +268,16 @@ (or (gethash name *backend-meta-primitive-type-names*) (error "~S is not a defined primitive type." name)))) -;;; If the PRIMITIVE-TYPE structure already exists, we destructively -;;; modify it so that existing references in templates won't be -;;; invalidated. -(defmacro def-primitive-type (name scs &key (type name)) - #!+sb-doc - "Def-Primitive-Type Name (SC*) {Key Value}* - Define a primitive type Name. Each SC specifies a Storage Class that values - of this type may be allocated in. The following keyword options are - defined: - - :Type - The type descriptor for the Lisp type that is equivalent to this type - (defaults to Name.)" - (check-type name symbol) - (check-type scs list) +;;; Define a primitive type NAME. Each SCS entry specifies a storage +;;; class that values of this type may be allocated in. TYPE is the +;;; type descriptor for the Lisp type that is equivalent to this type. +(defmacro !def-primitive-type (name scs &key (type name)) + (declare (type symbol name) (type list scs)) (let ((scns (mapcar #'meta-sc-number-or-lose scs)) (get-type `(specifier-type ',type))) `(progn + (/show0 "doing !DEF-PRIMITIVE-TYPE, NAME=..") + (/primitive-print ,(symbol-name name)) (eval-when (#-sb-xc :compile-toplevel :load-toplevel :execute) (setf (gethash ',name *backend-meta-primitive-type-names*) (make-primitive-type :name ',name @@ -305,21 +286,31 @@ ,(once-only ((n-old `(gethash ',name *backend-primitive-type-names*)) (n-type get-type)) `(progn + ;; If the PRIMITIVE-TYPE structure already exists, we + ;; destructively modify it so that existing references in + ;; templates won't be invalidated. FIXME: This should no + ;; longer be an issue in SBCL, since we don't try to do + ;; serious surgery on ourselves. Probably this should + ;; just become an assertion that N-OLD is NIL, so that we + ;; don't have to try to maintain the correctness of the + ;; never-ordinarily-used clause. + (/show0 "in !DEF-PRIMITIVE-TYPE, about to COND") (cond (,n-old + (/show0 "in ,N-OLD clause of COND") (setf (primitive-type-scs ,n-old) ',scns) (setf (primitive-type-type ,n-old) ,n-type)) (t + (/show0 "in T clause of COND") (setf (gethash ',name *backend-primitive-type-names*) (make-primitive-type :name ',name :scs ',scns :type ,n-type)))) + (/show0 "done with !DEF-PRIMITIVE-TYPE") ',name))))) -;;; Just record the translation. -(defmacro def-primitive-type-alias (name result) - #!+sb-doc - "DEF-PRIMITIVE-TYPE-ALIAS Name Result - Define name to be an alias for Result in VOP operand type restrictions." +;;; Define NAME to be an alias for RESULT in VOP operand type restrictions. +(defmacro !def-primitive-type-alias (name result) + ;; Just record the translation. `(eval-when (:compile-toplevel :load-toplevel :execute) (setf (gethash ',name *backend-primitive-type-aliases*) ',result) ',name)) @@ -613,7 +604,7 @@ (declare (type operand-parse temp)) (let ((sc (operand-parse-sc temp)) (offset (operand-parse-offset temp))) - (assert sc) + (aver sc) (setf (aref results index) (if offset (+ (ash offset (1+ sc-bits)) @@ -885,7 +876,7 @@ ;;; operands, and a single OPERAND-PARSE describing any more operand. ;;; If we are inheriting a VOP, we default attributes to the inherited ;;; operand of the same name. -(defun parse-operands (parse specs kind) +(defun !parse-vop-operands (parse specs kind) (declare (list specs) (type (member :argument :result) kind)) (let ((num -1) @@ -932,21 +923,21 @@ (let ((value (second key))) (case (first key) (:scs - (check-type value list) + (aver (typep value 'list)) (setf (operand-parse-scs res) (remove-duplicates value))) (:load-tn - (check-type value symbol) + (aver (typep value 'symbol)) (setf (operand-parse-load-tn res) value)) (:load-if (setf (operand-parse-load res) value)) (:more - (check-type value boolean) + (aver (typep value 'boolean)) (setf (operand-parse-kind res) (if (eq kind :argument) :more-argument :more-result)) (setf (operand-parse-load res) nil) (setq more res)) (:target - (check-type value symbol) + (aver (typep value 'symbol)) (setf (operand-parse-target res) value)) (:from (unless (eq kind :result) @@ -1000,13 +991,13 @@ (vop-spec-arg opt 'symbol 1 nil))) (:offset (let ((offset (eval (second opt)))) - (check-type offset unsigned-byte) + (aver (typep offset 'unsigned-byte)) (setf (operand-parse-offset res) offset))) (:from (setf (operand-parse-born res) (parse-time-spec (second opt)))) (:to (setf (operand-parse-dies res) (parse-time-spec (second opt)))) - ;; Backward compatibility... + ;; backward compatibility... (:scs (let ((scs (vop-spec-arg opt 'list 1 nil))) (unless (= (length scs) 1) @@ -1041,12 +1032,12 @@ (case (first spec) (:args (multiple-value-bind (fixed more) - (parse-operands parse (rest spec) :argument) + (!parse-vop-operands parse (rest spec) :argument) (setf (vop-parse-args parse) fixed) (setf (vop-parse-more-args parse) more))) (:results (multiple-value-bind (fixed more) - (parse-operands parse (rest spec) :result) + (!parse-vop-operands parse (rest spec) :result) (setf (vop-parse-results parse) fixed) (setf (vop-parse-more-results parse) more)) (setf (vop-parse-conditional-p parse) nil)) @@ -1090,10 +1081,10 @@ (setf (vop-parse-note parse) (vop-spec-arg spec '(or string null)))) (:arg-types (setf (vop-parse-arg-types parse) - (parse-operand-types (rest spec) t))) + (!parse-vop-operand-types (rest spec) t))) (:result-types (setf (vop-parse-result-types parse) - (parse-operand-types (rest spec) nil))) + (!parse-vop-operand-types (rest spec) nil))) (:translate (setf (vop-parse-translate parse) (rest spec))) (:guard @@ -1169,7 +1160,7 @@ (make-array sc-number-limit :initial-element 0)) (defparameter *no-loads* - (make-array sc-number-limit :initial-element 't)) + (make-array sc-number-limit :initial-element t)) ;;; Pick off the case of operands with no restrictions. (defun compute-loading-costs-if-any (op load-p) @@ -1213,9 +1204,9 @@ ;;;; operand checking and stuff -;;; Given a list of arg/result restrictions, check for valid syntax and -;;; convert to canonical form. -(defun parse-operand-types (specs args-p) +;;; Given a list of arg/result restrictions, check for valid syntax +;;; and convert to canonical form. +(defun !parse-vop-operand-types (specs args-p) (declare (list specs)) (labels ((parse-operand-type (spec) (cond ((eq spec '*) spec) @@ -1271,7 +1262,7 @@ ;;; satisfy the first test, and omit the second. (defun check-operand-type-scs (parse op type load-p) (declare (type vop-parse parse) (type operand-parse op)) - (let ((ptypes (if (eq type '*) (list 't) (rest type))) + (let ((ptypes (if (eq type '*) (list t) (rest type))) (scs (operand-parse-scs op))) (when scs (multiple-value-bind (costs load-scs) (compute-loading-costs op load-p) @@ -1340,7 +1331,7 @@ ;;; Compute stuff that can only be computed after we are done parsing ;;; everying. We set the VOP-Parse-Operands, and do various error checks. -(defun grovel-operands (parse) +(defun !grovel-vop-operands (parse) (declare (type vop-parse parse)) (setf (vop-parse-operands parse) @@ -1409,9 +1400,9 @@ (make-list (+ (length ops) (if more-ops 1 0)) :initial-element '*) types)) -;;; Return a list of forms to use as keyword args to Make-VOP-Info for +;;; Return a list of forms to use as &KEY args to MAKE-VOP-INFO for ;;; setting up the template argument and result types. Here we make an -;;; initial dummy Template-Type, since it is awkward to compute the +;;; initial dummy TEMPLATE-TYPE, since it is awkward to compute the ;;; type until the template has been made. (defun make-vop-info-types (parse) (let* ((more-args (vop-parse-more-args parse)) @@ -1428,8 +1419,7 @@ (more-result (when more-results (car (last all-results)))) (conditional (vop-parse-conditional-p parse))) - `( - :type (specifier-type '(function () nil)) + `(:type (specifier-type '(function () nil)) :arg-types (list ,@(mapcar #'make-operand-type args)) :more-args-type ,(when more-args (make-operand-type more-arg)) :result-types ,(if conditional @@ -1444,14 +1434,14 @@ (defparameter *slot-inherit-alist* '((:generator-function . vop-info-generator-function)))) -;;; Something to help with inheriting VOP-Info slots. We return a -;;; keyword/value pair that can be passed to the constructor. SLOT is -;;; the keyword name of the slot, Parse is a form that evaluates to -;;; the VOP-Parse structure for the VOP inherited. If PARSE is NIL, -;;; then we do nothing. If the TEST form evaluates to true, then we -;;; return a form that selects the named slot from the VOP-Info -;;; structure corresponding to PARSE. Otherwise, we return the FORM so -;;; that the slot is recomputed. +;;; This is something to help with inheriting VOP-Info slots. We +;;; return a keyword/value pair that can be passed to the constructor. +;;; SLOT is the keyword name of the slot, Parse is a form that +;;; evaluates to the VOP-Parse structure for the VOP inherited. If +;;; PARSE is NIL, then we do nothing. If the TEST form evaluates to +;;; true, then we return a form that selects the named slot from the +;;; VOP-Info structure corresponding to PARSE. Otherwise, we return +;;; the FORM so that the slot is recomputed. (defmacro inherit-vop-info (slot parse test form) `(if (and ,parse ,test) (list ,slot `(,',(or (cdr (assoc slot *slot-inherit-alist*)) @@ -1495,164 +1485,169 @@ (make-generator-function parse))) :variant (list ,@variant)))) -;;; Parse the syntax into a VOP-Parse structure, and then expand into -;;; code that creates the appropriate VOP-Info structure at load time. -;;; We implement inheritance by copying the VOP-Parse structure for -;;; the inherited structure. +;;; Define the symbol NAME to be a Virtual OPeration in the compiler. +;;; If specified, INHERITS is the name of a VOP that we default +;;; unspecified information from. Each SPEC is a list beginning with a +;;; keyword indicating the interpretation of the other forms in the +;;; SPEC: +;;; +;;; :Args {(Name {Key Value}*)}* +;;; :Results {(Name {Key Value}*)}* +;;; The Args and Results are specifications of the operand TNs passed +;;; to the VOP. If there is an inherited VOP, any unspecified options +;;; are defaulted from the inherited argument (or result) of the same +;;; name. The following operand options are defined: +;;; +;;; :SCs (SC*) +;;; :SCs specifies good SCs for this operand. Other SCs will be +;;; penalized according to move costs. A load TN will be allocated if +;;; necessary, guaranteeing that the operand is always one of the +;;; specified SCs. +;;; +;;; :Load-TN Load-Name +;;; Load-Name is bound to the load TN allocated for this operand, +;;; or to NIL if no load TN was allocated. +;;; +;;; :Load-If EXPRESSION +;;; Controls whether automatic operand loading is done. +;;; EXPRESSION is evaluated with the fixed operand TNs bound. +;;; If EXPRESSION is true,then loading is done and the variable +;;; is bound to the load TN in the generator body. Otherwise, +;;; loading is not done, and the variable is bound to the actual +;;; operand. +;;; +;;; :More T-or-NIL +;;; If specified, Name is bound to the TN-Ref for the first +;;; argument or result following the fixed arguments or results. +;;; A :MORE operand must appear last, and cannot be targeted or +;;; restricted. +;;; +;;; :Target Operand +;;; This operand is targeted to the named operand, indicating a +;;; desire to pack in the same location. Not legal for results. +;;; +;;; :From Time-Spec +;;; :To Time-Spec +;;; Specify the beginning or end of the operand's lifetime. +;;; :FROM can only be used with results, and :TO only with +;;; arguments. The default for the N'th argument/result is +;;; (:ARGUMENT N)/(:RESULT N). These options are necessary +;;; primarily when operands are read or written out of order. +;;; +;;; :Conditional +;;; This is used in place of :RESULTS with conditional branch VOPs. +;;; There are no result values: the result is a transfer of control. +;;; The target label is passed as the first :INFO arg. The second +;;; :INFO arg is true if the sense of the test should be negated. +;;; A side-effect is to set the PREDICATE attribute for functions +;;; in the :TRANSLATE option. +;;; +;;; :Temporary ({Key Value}*) Name* +;;; Allocate a temporary TN for each Name, binding that variable to +;;; the TN within the body of the generators. In addition to :TARGET +;;; (which is is the same as for operands), the following options are +;;; defined: +;;; +;;; :SC SC-Name +;;; :Offset SB-Offset +;;; Force the temporary to be allocated in the specified SC with the +;;; specified offset. Offset is evaluated at macroexpand time. If +;;; Offset is emitted, the register allocator chooses a free +;;; location in SC. If both SC and Offset are omitted, then the +;;; temporary is packed according to its primitive type. +;;; +;;; :From Time-Spec +;;; :To Time-Spec +;;; Similar to the argument/result option, this specifies the start and +;;; end of the temporaries' lives. The defaults are :Load and :Save, +;;; i.e. the duration of the VOP. The other intervening phases are +;;; :Argument,:Eval and :Result. Non-zero sub-phases can be specified +;;; by a list, e.g. by default the second argument's life ends at +;;; (:Argument 1). +;;; +;;; :Generator Cost Form* +;;; Specifies the translation into assembly code. Cost is the +;;; estimated cost of the code emitted by this generator. The body +;;; is arbitrary Lisp code that emits the assembly language +;;; translation of the VOP. An ASSEMBLE form is wrapped around +;;; the body, so code may be emitted by using the local INST macro. +;;; During the evaluation of the body, the names of the operands +;;; and temporaries are bound to the actual TNs. +;;; +;;; :Effects Effect* +;;; :Affected Effect* +;;; Specifies the side effects that this VOP has and the side +;;; effects that effect its execution. If unspecified, these +;;; default to the worst case. +;;; +;;; :Info Name* +;;; Define some magic arguments that are passed directly to the code +;;; generator. The corresponding trailing arguments to VOP or +;;; %PRIMITIVE are stored in the VOP structure. Within the body +;;; of the generators, the named variables are bound to these +;;; values. Except in the case of :Conditional VOPs, :Info arguments +;;; cannot be specified for VOPS that are the direct translation +;;; for a function (specified by :Translate). +;;; +;;; :Ignore Name* +;;; Causes the named variables to be declared IGNORE in the +;;; generator body. +;;; +;;; :Variant Thing* +;;; :Variant-Vars Name* +;;; These options provide a way to parameterize families of VOPs +;;; that differ only trivially. :Variant makes the specified +;;; evaluated Things be the "variant" associated with this VOP. +;;; :VARIANT-VARS causes the named variables to be bound to the +;;; corresponding Things within the body of the generator. +;;; +;;; :Variant-Cost Cost +;;; Specifies the cost of this VOP, overriding the cost of any +;;; inherited generator. +;;; +;;; :Note {String | NIL} +;;; A short noun-like phrase describing what this VOP "does", i.e. +;;; the implementation strategy. If supplied, efficency notes will +;;; be generated when type uncertainty prevents :TRANSLATE from +;;; working. NIL inhibits any efficency note. +;;; +;;; :Arg-Types {* | PType | (:OR PType*) | (:CONSTANT Type)}* +;;; :Result-Types {* | PType | (:OR PType*)}* +;;; Specify the template type restrictions used for automatic translation. +;;; If there is a :More operand, the last type is the more type. :CONSTANT +;;; specifies that the argument must be a compile-time constant of the +;;; specified Lisp type. The constant values of :CONSTANT arguments are +;;; passed as additional :INFO arguments rather than as :ARGS. +;;; +;;; :Translate Name* +;;; This option causes the VOP template to be entered as an IR2 +;;; translation for the named functions. +;;; +;;; :Policy {:Small | :Fast | :Safe | :Fast-Safe} +;;; Specifies the policy under which this VOP is the best translation. +;;; +;;; :Guard Form +;;; Specifies a Form that is evaluated in the global environment. If +;;; form returns NIL, then emission of this VOP is prohibited even when +;;; all other restrictions are met. +;;; +;;; :VOP-Var Name +;;; :Node-Var Name +;;; In the generator, bind the specified variable to the VOP or +;;; the Node that generated this VOP. +;;; +;;; :Save-P {NIL | T | :Compute-Only | :Force-To-Stack} +;;; Indicates how a VOP wants live registers saved. +;;; +;;; :Move-Args {NIL | :Full-Call | :Local-Call | :Known-Return} +;;; Indicates if and how the more args should be moved into a +;;; different frame. (def!macro define-vop ((name &optional inherits) &rest specs) - #!+sb-doc - "Define-VOP (Name [Inherits]) Spec* - Define the symbol Name to be a Virtual OPeration in the compiler. If - specified, Inherits is the name of a VOP that we default unspecified - information from. Each Spec is a list beginning with a keyword indicating - the interpretation of the other forms in the Spec: - - :Args {(Name {Key Value}*)}* - :Results {(Name {Key Value}*)}* - The Args and Results are specifications of the operand TNs passed to the - VOP. If there is an inherited VOP, any unspecified options are defaulted - from the inherited argument (or result) of the same name. The following - operand options are defined: - - :SCs (SC*) - :SCs specifies good SCs for this operand. Other SCs will be - penalized according to move costs. A load TN will be allocated if - necessary, guaranteeing that the operand is always one of the - specified SCs. - - :Load-TN Load-Name - Load-Name is bound to the load TN allocated for this operand, or to - NIL if no load TN was allocated. - - :Load-If Expression - Controls whether automatic operand loading is done. Expression is - evaluated with the fixed operand TNs bound. If Expression is true, - then loading is done and the variable is bound to the load TN in - the generator body. Otherwise, loading is not done, and the variable - is bound to the actual operand. - - :More T-or-NIL - If specified, Name is bound to the TN-Ref for the first argument or - result following the fixed arguments or results. A more operand must - appear last, and cannot be targeted or restricted. - - :Target Operand - This operand is targeted to the named operand, indicating a desire to - pack in the same location. Not legal for results. - - :From Time-Spec - :To Time-Spec - Specify the beginning or end of the operand's lifetime. :From can - only be used with results, and :To only with arguments. The default - for the N'th argument/result is (:ARGUMENT N)/(:RESULT N). These - options are necessary primarily when operands are read or written out - of order. - - :Conditional - This is used in place of :RESULTS with conditional branch VOPs. There - are no result values: the result is a transfer of control. The target - label is passed as the first :INFO arg. The second :INFO arg is true if - the sense of the test should be negated. A side-effect is to set the - PREDICATE attribute for functions in the :TRANSLATE option. - - :Temporary ({Key Value}*) Name* - Allocate a temporary TN for each Name, binding that variable to the TN - within the body of the generators. In addition to :Target (which is - is the same as for operands), the following options are - defined: - - :SC SC-Name - :Offset SB-Offset - Force the temporary to be allocated in the specified SC with the - specified offset. Offset is evaluated at macroexpand time. If - Offset is emitted, the register allocator chooses a free location in - SC. If both SC and Offset are omitted, then the temporary is packed - according to its primitive type. - - :From Time-Spec - :To Time-Spec - Similar to the argument/result option, this specifies the start and - end of the temporaries' lives. The defaults are :Load and :Save, - i.e. the duration of the VOP. The other intervening phases are - :Argument,:Eval and :Result. Non-zero sub-phases can be specified - by a list, e.g. by default the second argument's life ends at - (:Argument 1). - - :Generator Cost Form* - Specifies the translation into assembly code. Cost is the estimated cost - of the code emitted by this generator. The body is arbitrary Lisp code - that emits the assembly language translation of the VOP. An Assemble - form is wrapped around the body, so code may be emitted by using the - local Inst macro. During the evaluation of the body, the names of the - operands and temporaries are bound to the actual TNs. - - :Effects Effect* - :Affected Effect* - Specifies the side effects that this VOP has and the side effects that - effect its execution. If unspecified, these default to the worst case. - - :Info Name* - Define some magic arguments that are passed directly to the code - generator. The corresponding trailing arguments to VOP or %Primitive are - stored in the VOP structure. Within the body of the generators, the - named variables are bound to these values. Except in the case of - :Conditional VOPs, :Info arguments cannot be specified for VOPS that are - the direct translation for a function (specified by :Translate). - - :Ignore Name* - Causes the named variables to be declared IGNORE in the generator body. - - :Variant Thing* - :Variant-Vars Name* - These options provide a way to parameterize families of VOPs that differ - only trivially. :Variant makes the specified evaluated Things be the - \"variant\" associated with this VOP. :Variant-Vars causes the named - variables to be bound to the corresponding Things within the body of the - generator. - - :Variant-Cost Cost - Specifies the cost of this VOP, overriding the cost of any inherited - generator. - - :Note {String | NIL} - A short noun-like phrase describing what this VOP \"does\", i.e. the - implementation strategy. If supplied, efficency notes will be generated - when type uncertainty prevents :TRANSLATE from working. NIL inhibits any - efficency note. - - :Arg-Types {* | PType | (:OR PType*) | (:CONSTANT Type)}* - :Result-Types {* | PType | (:OR PType*)}* - Specify the template type restrictions used for automatic translation. - If there is a :More operand, the last type is the more type. :CONSTANT - specifies that the argument must be a compile-time constant of the - specified Lisp type. The constant values of :CONSTANT arguments are - passed as additional :INFO arguments rather than as :ARGS. - - :Translate Name* - This option causes the VOP template to be entered as an IR2 translation - for the named functions. - - :Policy {:Small | :Fast | :Safe | :Fast-Safe} - Specifies the policy under which this VOP is the best translation. - - :Guard Form - Specifies a Form that is evaluated in the global environment. If - form returns NIL, then emission of this VOP is prohibited even when - all other restrictions are met. - - :VOP-Var Name - :Node-Var Name - In the generator, bind the specified variable to the VOP or the Node that - generated this VOP. - - :Save-P {NIL | T | :Compute-Only | :Force-To-Stack} - Indicates how a VOP wants live registers saved. - - :Move-Args {NIL | :Full-Call | :Local-Call | :Known-Return} - Indicates if and how the more args should be moved into a different - frame." - (check-type name symbol) - + (declare (type symbol name)) + ;; Parse the syntax into a VOP-PARSE structure, and then expand into + ;; code that creates the appropriate VOP-INFO structure at load time. + ;; We implement inheritance by copying the VOP-PARSE structure for + ;; the inherited structure. (let* ((inherited-parse (when inherits (vop-parse-or-lose inherits))) (parse (if inherits @@ -1663,7 +1658,7 @@ (setf (vop-parse-inherits parse) inherits) (parse-define-vop parse specs) - (grovel-operands parse) + (!grovel-vop-operands parse) `(progn (eval-when (:compile-toplevel :load-toplevel :execute) @@ -1710,11 +1705,11 @@ (values (forms) (binds) n-head)))) +;;; Emit-Template Node Block Template Args Results [Info] +;;; +;;; Call the emit function for Template, linking the result in at the +;;; end of Block. (defmacro emit-template (node block template args results &optional info) - #!+sb-doc - "Emit-Template Node Block Template Args Results [Info] - Call the emit function for Template, linking the result in at the end of - Block." (let ((n-first (gensym)) (n-last (gensym))) (once-only ((n-node node) @@ -1726,20 +1721,21 @@ ,@(when info `(,info))) (insert-vop-sequence ,n-first ,n-last ,n-block nil))))) +;;; VOP Name Node Block Arg* Info* Result* +;;; +;;; Emit the VOP (or other template) Name at the end of the IR2-Block +;;; Block, using Node for the source context. The interpretation of +;;; the remaining arguments depends on the number of operands of +;;; various kinds that are declared in the template definition. VOP +;;; cannot be used for templates that have more-args or more-results, +;;; since the number of arguments and results is indeterminate for +;;; these templates. Use VOP* instead. +;;; +;;; Args and Results are the TNs that are to be referenced by the +;;; template as arguments and results. If the template has +;;; codegen-info arguments, then the appropriate number of Info forms +;;; following the Arguments are used for codegen info. (defmacro vop (name node block &rest operands) - #!+sb-doc - "VOP Name Node Block Arg* Info* Result* - Emit the VOP (or other template) Name at the end of the IR2-Block Block, - using Node for the source context. The interpretation of the remaining - arguments depends on the number of operands of various kinds that are - declared in the template definition. VOP cannot be used for templates that - have more-args or more-results, since the number of arguments and results is - indeterminate for these templates. Use VOP* instead. - - Args and Results are the TNs that are to be referenced by the template - as arguments and results. If the template has codegen-info arguments, then - the appropriate number of Info forms following the Arguments are used for - codegen info." (let* ((parse (vop-parse-or-lose name)) (arg-count (length (vop-parse-args parse))) (result-count (length (vop-parse-results parse))) @@ -1781,22 +1777,23 @@ `((list ,@(ivars))))) (values))))))) +;;; VOP* Name Node Block (Arg* More-Args) (Result* More-Results) Info* +;;; +;;; This is like VOP, but allows for emission of templates with +;;; arbitrary numbers of arguments, and for emission of templates +;;; using already-created TN-Ref lists. +;;; +;;; The Arguments and Results are TNs to be referenced as the first +;;; arguments and results to the template. More-Args and More-Results +;;; are heads of TN-Ref lists that are added onto the end of the +;;; TN-Refs for the explicitly supplied operand TNs. The TN-Refs for +;;; the more operands must have the TN and Write-P slots correctly +;;; initialized. +;;; +;;; As with VOP, the Info forms are evaluated and passed as codegen +;;; info arguments. (defmacro vop* (name node block args results &rest info) - #!+sb-doc - "VOP* Name Node Block (Arg* More-Args) (Result* More-Results) Info* - Like VOP, but allows for emission of templates with arbitrary numbers of - arguments, and for emission of templates using already-created TN-Ref lists. - - The Arguments and Results are TNs to be referenced as the first arguments - and results to the template. More-Args and More-Results are heads of TN-Ref - lists that are added onto the end of the TN-Refs for the explicitly supplied - operand TNs. The TN-Refs for the more operands must have the TN and Write-P - slots correctly initialized. - - As with VOP, the Info forms are evaluated and passed as codegen info - arguments." - (check-type args cons) - (check-type results cons) + (declare (type cons args results)) (let* ((parse (vop-parse-or-lose name)) (arg-count (length (vop-parse-args parse))) (result-count (length (vop-parse-results parse))) @@ -1835,13 +1832,14 @@ ;;;; miscellaneous macros +;;; SC-Case TN {({(SC-Name*) | SC-Name | T} Form*)}* +;;; +;;; Case off of TN's SC. The first clause containing TN's SC is +;;; evaluated, returning the values of the last form. A clause +;;; beginning with T specifies a default. If it appears, it must be +;;; last. If no default is specified, and no clause matches, then an +;;; error is signalled. (def!macro sc-case (tn &rest forms) - #!+sb-doc - "SC-Case TN {({(SC-Name*) | SC-Name | T} Form*)}* - Case off of TN's SC. The first clause containing TN's SC is evaluated, - returning the values of the last form. A clause beginning with T specifies a - default. If it appears, it must be last. If no default is specified, and no - clause matches, then an error is signalled." (let ((n-sc (gensym)) (n-tn (gensym))) (collect ((clauses)) @@ -1868,30 +1866,25 @@ (,n-sc (sc-number (tn-sc ,n-tn)))) (cond ,@(clauses)))))) +;;; Return true if TNs SC is any of the named SCs, false otherwise. (defmacro sc-is (tn &rest scs) - #!+sb-doc - "SC-Is TN SC* - Returns true if TNs SC is any of the named SCs, false otherwise." (once-only ((n-sc `(sc-number (tn-sc ,tn)))) `(or ,@(mapcar #'(lambda (x) `(eql ,n-sc ,(meta-sc-number-or-lose x))) scs)))) +;;; Iterate over the IR2 blocks in component, in emission order. (defmacro do-ir2-blocks ((block-var component &optional result) &body forms) - #!+sb-doc - "Do-IR2-Blocks (Block-Var Component [Result]) Form* - Iterate over the IR2 blocks in component, in emission order." `(do ((,block-var (block-info (component-head ,component)) (ir2-block-next ,block-var))) ((null ,block-var) ,result) ,@forms)) +;;; Iterate over all the TNs live at some point, with the live set +;;; represented by a local conflicts bit-vector and the IR2-Block +;;; containing the location. (defmacro do-live-tns ((tn-var live block &optional result) &body body) - #!+sb-doc - "DO-LIVE-TNS (TN-Var Live Block [Result]) Form* - Iterate over all the TNs live at some point, with the live set represented by - a local conflicts bit-vector and the IR2-Block containing the location." (let ((n-conf (gensym)) (n-bod (gensym)) (i (gensym)) @@ -1924,11 +1917,9 @@ (when (and ,tn-var (not (eq ,tn-var :more))) (,n-bod ,tn-var))))))))))) +;;; Iterate over all the IR2 blocks in the environment Env, in emit order. (defmacro do-environment-ir2-blocks ((block-var env &optional result) &body body) - #!+sb-doc - "DO-ENVIRONMENT-IR2-BLOCKS (Block-Var Env [Result]) Form* - Iterate over all the IR2 blocks in the environment Env, in emit order." (once-only ((n-env env)) (once-only ((n-first `(node-block (lambda-bind