X-Git-Url: http://repo.macrolet.net/gitweb/?a=blobdiff_plain;ds=inline;f=src%2Fcompiler%2Fir1tran.lisp;h=728a23a310c2f013d7c1d65e88bc1c4b0518bdac;hb=374667fd8a38e79869e63d56bacde7ad98a40852;hp=268afc5f4ad1085396e6dd07ad4933e4c123d53c;hpb=1d941f3d8f343f5779526b66b2358b4893a17281;p=sbcl.git diff --git a/src/compiler/ir1tran.lisp b/src/compiler/ir1tran.lisp index 268afc5..728a23a 100644 --- a/src/compiler/ir1tran.lisp +++ b/src/compiler/ir1tran.lisp @@ -14,16 +14,41 @@ (declaim (special *compiler-error-bailout*)) +;;; *CURRENT-FORM-NUMBER* is used in FIND-SOURCE-PATHS to compute the +;;; form number to associate with a source path. This should be bound +;;; to an initial value of 0 before the processing of each truly +;;; top level form. +(declaim (type index *current-form-number*)) +(defvar *current-form-number*) + ;;; *SOURCE-PATHS* is a hashtable from source code forms to the path ;;; taken through the source to reach the form. This provides a way to ;;; keep track of the location of original source forms, even when ;;; macroexpansions and other arbitary permutations of the code -;;; happen. This table is initialized by calling Find-Source-Paths on +;;; happen. This table is initialized by calling FIND-SOURCE-PATHS on ;;; the original source. +;;; +;;; It is fairly useless to store symbols, characters, or fixnums in +;;; this table, as 42 is EQ to 42 no matter where in the source it +;;; appears. GET-SOURCE-PATH and NOTE-SOURCE-PATH functions should be +;;; always used to access this table. (declaim (hash-table *source-paths*)) (defvar *source-paths*) -;;; *CURRENT-COMPONENT* is the Component structure which we link +(declaim (inline source-form-has-path-p)) +(defun source-form-has-path-p (form) + (not (typep form '(or symbol fixnum character)))) + +(defun get-source-path (form) + (when (source-form-has-path-p form) + (gethash form *source-paths*))) + +(defun note-source-path (form &rest arguments) + (when (source-form-has-path-p form) + (setf (gethash form *source-paths*) + (apply #'list* 'original-source-start *current-form-number* arguments)))) + +;;; *CURRENT-COMPONENT* is the COMPONENT structure which we link ;;; blocks into as we generate them. This just serves to glue the ;;; emitted blocks together until local call analysis and flow graph ;;; canonicalization figure out what is really going on. We need to @@ -33,312 +58,387 @@ ;;; FIXME: It's confusing having one variable named *CURRENT-COMPONENT* ;;; and another named *COMPONENT-BEING-COMPILED*. (In CMU CL they ;;; were called *CURRENT-COMPONENT* and *COMPILE-COMPONENT* respectively, -;;; which also confusing.) +;;; which was also confusing.) (declaim (type (or component null) *current-component*)) (defvar *current-component*) ;;; *CURRENT-PATH* is the source path of the form we are currently ;;; translating. See NODE-SOURCE-PATH in the NODE structure. (declaim (list *current-path*)) -(defvar *current-path* nil) - -;;; *CONVERTING-FOR-INTERPRETER* is true when we are creating IR1 to -;;; be interpreted rather than compiled. This inhibits source -;;; tranformations and stuff. -(defvar *converting-for-interpreter* nil) -;;; FIXME: Rename to *IR1-FOR-INTERPRETER-NOT-COMPILER-P*. - -;;; FIXME: This nastiness was one of my original motivations to start -;;; hacking CMU CL. The non-ANSI behavior can be useful, but it should -;;; be made not the default, and perhaps should be controlled by -;;; DECLAIM instead of a variable like this. And whether or not this -;;; kind of checking is on, declarations should be assertions to the -;;; extent practical, and code which can't be compiled efficiently -;;; while adhering to that principle should give warnings. -(defvar *derive-function-types* t - #!+sb-doc - "(Caution: Soon, this might change its semantics somewhat, or even go away.) - If true, argument and result type information derived from compilation of - DEFUNs is used when compiling calls to that function. If false, only - information from FTYPE proclamations will be used.") +(defvar *current-path*) + +(defvar *derive-function-types* nil + "Should the compiler assume that function types will never change, + so that it can use type information inferred from current definitions + to optimize code which uses those definitions? Setting this true + gives non-ANSI, early-CMU-CL behavior. It can be useful for improving + the efficiency of stable code.") + +(defvar *fun-names-in-this-file* nil) + +(defvar *post-binding-variable-lexenv* nil) ;;;; namespace management utilities +(defun fun-lexically-notinline-p (name) + (let ((fun (lexenv-find name funs :test #'equal))) + ;; a declaration will trump a proclamation + (if (and fun (defined-fun-p fun)) + (eq (defined-fun-inlinep fun) :notinline) + (eq (info :function :inlinep name) :notinline)))) + +;; This will get redefined in PCL boot. +(declaim (notinline update-info-for-gf)) +(defun maybe-update-info-for-gf (name) + (declare (ignorable name)) + (values)) + ;;; Return a GLOBAL-VAR structure usable for referencing the global ;;; function NAME. -(defun find-free-really-function (name) +(defun find-global-fun (name latep) (unless (info :function :kind name) (setf (info :function :kind name) :function) (setf (info :function :where-from name) :assumed)) - (let ((where (info :function :where-from name))) - (when (eq where :assumed) + (when (and (eq where :assumed) + ;; In the ordinary target Lisp, it's silly to report + ;; undefinedness when the function is defined in the + ;; running Lisp. But at cross-compile time, the current + ;; definedness of a function is irrelevant to the + ;; definedness at runtime, which is what matters. + #-sb-xc-host (not (fboundp name)) + ;; LATEP is true when the user has indicated that + ;; late-late binding is desired by using eg. a quoted + ;; symbol -- in which case it makes little sense to + ;; complain about undefined functions. + (not latep)) (note-undefined-reference name :function)) - (make-global-var :kind :global-function - :name name - :type (if (or *derive-function-types* - (eq where :declared)) - (info :function :type name) - (specifier-type 'function)) - :where-from where))) - -;;; Return a SLOT-ACCESSOR structure usable for referencing the slot -;;; accessor NAME. CLASS is the structure class. -(defun find-structure-slot-accessor (class name) - (declare (type sb!xc:class class)) - (let* ((info (layout-info - (or (info :type :compiler-layout (sb!xc:class-name class)) - (class-layout class)))) - (accessor (if (listp name) (cadr name) name)) - (slot (find accessor (dd-slots info) :key #'sb!kernel:dsd-accessor)) - (type (dd-name info)) - (slot-type (dsd-type slot))) - (assert slot () "Can't find slot ~S." type) - (make-slot-accessor - :name name - :type (specifier-type - (if (listp name) - `(function (,slot-type ,type) ,slot-type) - `(function (,type) ,slot-type))) - :for class - :slot slot))) - -;;; If NAME is already entered in *FREE-FUNCTIONS*, then return the -;;; value. Otherwise, make a new GLOBAL-VAR using information from the -;;; global environment and enter it in *FREE-FUNCTIONS*. If NAME names -;;; a macro or special form, then we error out using the supplied -;;; context which indicates what we were trying to do that demanded a -;;; function. -(defun find-free-function (name context) - (declare (string context)) - (declare (values global-var)) - (or (gethash name *free-functions*) + (make-global-var + :kind :global-function + :%source-name name + :type (if (or (eq where :declared) + (and (not latep) + (or *derive-function-types* + (eq where :defined-method) + (and (not (fun-lexically-notinline-p name)) + (member name *fun-names-in-this-file* + :test #'equal))))) + (progn + (maybe-update-info-for-gf name) + (info :function :type name)) + (specifier-type 'function)) + :defined-type (if (eq where :defined) + (info :function :type name) + *universal-type*) + :where-from where))) + +;;; Have some DEFINED-FUN-FUNCTIONALS of a *FREE-FUNS* entry become invalid? +;;; Drop 'em. +;;; +;;; This was added to fix bug 138 in SBCL. It is possible for a *FREE-FUNS* +;;; entry to contain a DEFINED-FUN whose DEFINED-FUN-FUNCTIONAL object +;;; contained IR1 stuff (NODEs, BLOCKs...) referring to an already compiled +;;; (aka "dead") component. When this IR1 stuff was reused in a new component, +;;; under further obscure circumstances it could be used by +;;; WITH-IR1-ENVIRONMENT-FROM-NODE to generate a binding for +;;; *CURRENT-COMPONENT*. At that point things got all confused, since IR1 +;;; conversion was sending code to a component which had already been compiled +;;; and would never be compiled again. +;;; +;;; Note: as of 1.0.24.41 this seems to happen only in XC, and the original +;;; BUGS entry also makes it seem like this might not be an issue at all on +;;; target. +(defun clear-invalid-functionals (free-fun) + ;; There might be other reasons that *FREE-FUN* entries could + ;; become invalid, but the only one we've been bitten by so far + ;; (sbcl-0.pre7.118) is this one: + (when (defined-fun-p free-fun) + (setf (defined-fun-functionals free-fun) + (delete-if (lambda (functional) + (or (eq (functional-kind functional) :deleted) + (when (lambda-p functional) + (or + ;; (The main reason for this first test is to bail + ;; out early in cases where the LAMBDA-COMPONENT + ;; call in the second test would fail because links + ;; it needs are uninitialized or invalid.) + ;; + ;; If the BIND node for this LAMBDA is null, then + ;; according to the slot comments, the LAMBDA has + ;; been deleted or its call has been deleted. In + ;; that case, it seems rather questionable to reuse + ;; it, and certainly it shouldn't be necessary to + ;; reuse it, so we cheerfully declare it invalid. + (not (lambda-bind functional)) + ;; If this IR1 stuff belongs to a dead component, + ;; then we can't reuse it without getting into + ;; bizarre confusion. + (eq (component-info (lambda-component functional)) + :dead))))) + (defined-fun-functionals free-fun))) + nil)) + +;;; If NAME already has a valid entry in *FREE-FUNS*, then return +;;; the value. Otherwise, make a new GLOBAL-VAR using information from +;;; the global environment and enter it in *FREE-FUNS*. If NAME +;;; names a macro or special form, then we error out using the +;;; supplied context which indicates what we were trying to do that +;;; demanded a function. +(declaim (ftype (sfunction (t string) global-var) find-free-fun)) +(defun find-free-fun (name context) + (or (let ((old-free-fun (gethash name *free-funs*))) + (when old-free-fun + (clear-invalid-functionals old-free-fun) + old-free-fun)) (ecase (info :function :kind name) - ;; FIXME: The :MACRO and :SPECIAL-FORM cases could be merged. - (:macro - (compiler-error "The macro name ~S was found ~A." name context)) - (:special-form - (compiler-error "The special form name ~S was found ~A." - name - context)) - ((:function nil) - (check-function-name name) - (note-if-setf-function-and-macro name) - (let ((expansion (info :function :inline-expansion name)) - (inlinep (info :function :inlinep name))) - (setf (gethash name *free-functions*) - (if (or expansion inlinep) - (make-defined-function - :name name - :inline-expansion expansion - :inlinep inlinep - :where-from (info :function :where-from name) - :type (info :function :type name)) - (let ((info (info :function :accessor-for name))) - (etypecase info - (null - (find-free-really-function name)) - (sb!xc:structure-class - (find-structure-slot-accessor info name)) - (sb!xc:class - (if (typep (layout-info (info :type :compiler-layout - (sb!xc:class-name - info))) - 'defstruct-description) - (find-structure-slot-accessor info name) - (find-free-really-function name)))))))))))) + ;; FIXME: The :MACRO and :SPECIAL-FORM cases could be merged. + (:macro + (compiler-error "The macro name ~S was found ~A." name context)) + (:special-form + (compiler-error "The special form name ~S was found ~A." + name + context)) + ((:function nil) + (check-fun-name name) + (note-if-setf-fun-and-macro name) + (let ((expansion (fun-name-inline-expansion name)) + (inlinep (info :function :inlinep name))) + (setf (gethash name *free-funs*) + (if (or expansion inlinep) + (make-defined-fun + :%source-name name + :inline-expansion expansion + :inlinep inlinep + :where-from (info :function :where-from name) + :type (if (eq inlinep :notinline) + (specifier-type 'function) + (info :function :type name))) + (find-global-fun name nil)))))))) ;;; Return the LEAF structure for the lexically apparent function ;;; definition of NAME. -(declaim (ftype (function (t string) leaf) find-lexically-apparent-function)) -(defun find-lexically-apparent-function (name context) - (let ((var (lexenv-find name functions :test #'equal))) +(declaim (ftype (sfunction (t string) leaf) find-lexically-apparent-fun)) +(defun find-lexically-apparent-fun (name context) + (let ((var (lexenv-find name funs :test #'equal))) (cond (var - (unless (leaf-p var) - (assert (and (consp var) (eq (car var) 'macro))) - (compiler-error "found macro name ~S ~A" name context)) - var) - (t - (find-free-function name context))))) + (unless (leaf-p var) + (aver (and (consp var) (eq (car var) 'macro))) + (compiler-error "found macro name ~S ~A" name context)) + var) + (t + (find-free-fun name context))))) + +(defun maybe-find-free-var (name) + (gethash name *free-vars*)) ;;; Return the LEAF node for a global variable reference to NAME. If -;;; NAME is already entered in *FREE-VARIABLES*, then we just return -;;; the corresponding value. Otherwise, we make a new leaf using +;;; NAME is already entered in *FREE-VARS*, then we just return the +;;; corresponding value. Otherwise, we make a new leaf using ;;; information from the global environment and enter it in -;;; *FREE-VARIABLES*. If the variable is unknown, then we emit a -;;; warning. -(defun find-free-variable (name) - (declare (values (or leaf heap-alien-info))) +;;; *FREE-VARS*. If the variable is unknown, then we emit a warning. +(declaim (ftype (sfunction (t) (or leaf cons heap-alien-info)) find-free-var)) +(defun find-free-var (name) (unless (symbolp name) (compiler-error "Variable name is not a symbol: ~S." name)) - (or (gethash name *free-variables*) + (or (gethash name *free-vars*) (let ((kind (info :variable :kind name)) - (type (info :variable :type name)) - (where-from (info :variable :where-from name))) - (when (and (eq where-from :assumed) (eq kind :global)) - (note-undefined-reference name :variable)) - - (setf (gethash name *free-variables*) - (if (eq kind :alien) - (info :variable :alien-info name) - (multiple-value-bind (val valp) - (info :variable :constant-value name) - (if (and (eq kind :constant) valp) - (make-constant :value val - :name name - :type (ctype-of val) - :where-from where-from) - (make-global-var :kind kind - :name name - :type type - :where-from where-from)))))))) + (type (info :variable :type name)) + (where-from (info :variable :where-from name))) + (when (eq kind :unknown) + (note-undefined-reference name :variable)) + (setf (gethash name *free-vars*) + (case kind + (:alien + (info :variable :alien-info name)) + ;; FIXME: The return value in this case should really be + ;; of type SB!C::LEAF. I don't feel too badly about it, + ;; because the MACRO idiom is scattered throughout this + ;; file, but it should be cleaned up so we're not + ;; throwing random conses around. --njf 2002-03-23 + (:macro + (let ((expansion (info :variable :macro-expansion name)) + (type (type-specifier (info :variable :type name)))) + `(macro . (the ,type ,expansion)))) + (:constant + (let ((value (symbol-value name))) + ;; Override the values of standard symbols in XC, + ;; since we can't redefine them. + #+sb-xc-host + (when (eql (find-symbol (symbol-name name) :cl) name) + (multiple-value-bind (xc-value foundp) + (info :variable :xc-constant-value name) + (cond (foundp + (setf value xc-value)) + ((not (eq value name)) + (compiler-warn + "Using cross-compilation host's definition of ~S: ~A~%" + name (symbol-value name)))))) + (find-constant value name))) + (t + (make-global-var :kind kind + :%source-name name + :type type + :where-from where-from))))))) ;;; Grovel over CONSTANT checking for any sub-parts that need to be ;;; processed with MAKE-LOAD-FORM. We have to be careful, because ;;; CONSTANT might be circular. We also check that the constant (and ;;; any subparts) are dumpable at all. -(defconstant list-to-hash-table-threshold 32) -(defun maybe-emit-make-load-forms (constant) - (let ((things-processed nil) - (count 0)) - ;; FIXME: Does this LIST-or-HASH-TABLE messiness give much benefit? - (declare (type (or list hash-table) things-processed) - (type (integer 0 #.(1+ list-to-hash-table-threshold)) count) - (inline member)) - (labels ((grovel (value) - ;; Unless VALUE is an object which which obviously - ;; can't contain other objects - (unless (typep value - '(or #-sb-xc-host unboxed-array - symbol - number - character - string)) - (etypecase things-processed - (list - (when (member value things-processed :test #'eq) - (return-from grovel nil)) - (push value things-processed) - (incf count) - (when (> count list-to-hash-table-threshold) - (let ((things things-processed)) - (setf things-processed - (make-hash-table :test 'eq)) - (dolist (thing things) - (setf (gethash thing things-processed) t))))) - (hash-table - (when (gethash value things-processed) - (return-from grovel nil)) - (setf (gethash value things-processed) t))) - (typecase value - (cons - (grovel (car value)) - (grovel (cdr value))) - (simple-vector - (dotimes (i (length value)) - (grovel (svref value i)))) - ((vector t) - (dotimes (i (length value)) - (grovel (aref value i)))) - ((simple-array t) - ;; Even though the (ARRAY T) branch does the exact - ;; same thing as this branch we do this separately - ;; so that the compiler can use faster versions of - ;; array-total-size and row-major-aref. - (dotimes (i (array-total-size value)) - (grovel (row-major-aref value i)))) - ((array t) - (dotimes (i (array-total-size value)) - (grovel (row-major-aref value i)))) - (;; In the target SBCL, we can dump any instance, - ;; but in the cross-compilation host, - ;; %INSTANCE-FOO functions don't work on general - ;; instances, only on STRUCTURE!OBJECTs. - #+sb-xc-host structure!object - #-sb-xc-host instance - (when (emit-make-load-form value) - (dotimes (i (%instance-length value)) - (grovel (%instance-ref value i))))) - (t - (compiler-error - "Objects of type ~S can't be dumped into fasl files." - (type-of value))))))) - (grovel constant))) +(defun maybe-emit-make-load-forms (constant &optional (name nil namep)) + (let ((xset (alloc-xset))) + (labels ((trivialp (value) + (typep value + '(or + #-sb-xc-host unboxed-array + #+sb-xc-host (simple-array (unsigned-byte 8) (*)) + symbol + number + character + string))) + (grovel (value) + ;; Unless VALUE is an object which which obviously + ;; can't contain other objects + (unless (trivialp value) + (if (xset-member-p value xset) + (return-from grovel nil) + (add-to-xset value xset)) + (typecase value + (cons + (grovel (car value)) + (grovel (cdr value))) + (simple-vector + (dotimes (i (length value)) + (grovel (svref value i)))) + ((vector t) + (dotimes (i (length value)) + (grovel (aref value i)))) + ((simple-array t) + ;; Even though the (ARRAY T) branch does the exact + ;; same thing as this branch we do this separately + ;; so that the compiler can use faster versions of + ;; array-total-size and row-major-aref. + (dotimes (i (array-total-size value)) + (grovel (row-major-aref value i)))) + ((array t) + (dotimes (i (array-total-size value)) + (grovel (row-major-aref value i)))) + (#+sb-xc-host structure!object + #-sb-xc-host instance + ;; In the target SBCL, we can dump any instance, but + ;; in the cross-compilation host, %INSTANCE-FOO + ;; functions don't work on general instances, only on + ;; STRUCTURE!OBJECTs. + ;; + ;; FIXME: What about funcallable instances with + ;; user-defined MAKE-LOAD-FORM methods? + (when (emit-make-load-form value) + (dotimes (i (- (%instance-length value) + #+sb-xc-host 0 + #-sb-xc-host (layout-n-untagged-slots + (%instance-ref value 0)))) + (grovel (%instance-ref value i))))) + (t + (compiler-error + "Objects of type ~S can't be dumped into fasl files." + (type-of value))))))) + ;; Dump all non-trivial named constants using the name. + (if (and namep (not (typep constant '(or symbol character + ;; FIXME: Cold init breaks if we + ;; try to reference FP constants + ;; thru their names. + #+sb-xc-host number + #-sb-xc-host fixnum)))) + (emit-make-load-form constant name) + (grovel constant)))) (values)) ;;;; some flow-graph hacking utilities ;;; This function sets up the back link between the node and the -;;; continuation which continues at it. -#!-sb-fluid (declaim (inline prev-link)) -(defun prev-link (node cont) - (declare (type node node) (type continuation cont)) - (assert (not (continuation-next cont))) - (setf (continuation-next cont) node) - (setf (node-prev node) cont)) - -;;; This function is used to set the continuation for a node, and thus -;;; determine what receives the value and what is evaluated next. If -;;; the continuation has no block, then we make it be in the block -;;; that the node is in. If the continuation heads its block, we end -;;; our block and link it to that block. If the continuation is not -;;; currently used, then we set the derived-type for the continuation -;;; to that of the node, so that a little type propagation gets done. -;;; -;;; We also deal with a bit of THE's semantics here: we weaken the -;;; assertion on CONT to be no stronger than the assertion on CONT in -;;; our scope. See the IR1-CONVERT method for THE. -#!-sb-fluid (declaim (inline use-continuation)) -(defun use-continuation (node cont) - (declare (type node node) (type continuation cont)) - (let ((node-block (continuation-block (node-prev node)))) - (case (continuation-kind cont) - (:unused - (setf (continuation-block cont) node-block) - (setf (continuation-kind cont) :inside-block) - (setf (continuation-use cont) node) - (setf (node-cont node) cont)) - (t - (%use-continuation node cont))))) -(defun %use-continuation (node cont) - (declare (type node node) (type continuation cont) (inline member)) - (let ((block (continuation-block cont)) - (node-block (continuation-block (node-prev node)))) - (assert (eq (continuation-kind cont) :block-start)) - (assert (not (block-last node-block)) () "~S has already ended." - node-block) +;;; ctran which continues at it. +(defun link-node-to-previous-ctran (node ctran) + (declare (type node node) (type ctran ctran)) + (aver (not (ctran-next ctran))) + (setf (ctran-next ctran) node) + (setf (node-prev node) ctran)) + +;;; This function is used to set the ctran for a node, and thus +;;; determine what is evaluated next. If the ctran has no block, then +;;; we make it be in the block that the node is in. If the ctran heads +;;; its block, we end our block and link it to that block. +#!-sb-fluid (declaim (inline use-ctran)) +(defun use-ctran (node ctran) + (declare (type node node) (type ctran ctran)) + (if (eq (ctran-kind ctran) :unused) + (let ((node-block (ctran-block (node-prev node)))) + (setf (ctran-block ctran) node-block) + (setf (ctran-kind ctran) :inside-block) + (setf (ctran-use ctran) node) + (setf (node-next node) ctran)) + (%use-ctran node ctran))) +(defun %use-ctran (node ctran) + (declare (type node node) (type ctran ctran) (inline member)) + (let ((block (ctran-block ctran)) + (node-block (ctran-block (node-prev node)))) + (aver (eq (ctran-kind ctran) :block-start)) + (when (block-last node-block) + (error "~S has already ended." node-block)) (setf (block-last node-block) node) - (assert (null (block-succ node-block)) () "~S already has successors." - node-block) + (when (block-succ node-block) + (error "~S already has successors." node-block)) (setf (block-succ node-block) (list block)) - (assert (not (member node-block (block-pred block) :test #'eq)) () - "~S is already a predecessor of ~S." node-block block) - (push node-block (block-pred block)) - (add-continuation-use node cont) - (unless (eq (continuation-asserted-type cont) *wild-type*) - (let ((new (values-type-union (continuation-asserted-type cont) - (or (lexenv-find cont type-restrictions) - *wild-type*)))) - (when (type/= new (continuation-asserted-type cont)) - (setf (continuation-asserted-type cont) new) - (reoptimize-continuation cont)))))) + (when (memq node-block (block-pred block)) + (error "~S is already a predecessor of ~S." node-block block)) + (push node-block (block-pred block)))) + +;;; Insert NEW before OLD in the flow-graph. +(defun insert-node-before (old new) + (let ((prev (node-prev old)) + (temp (make-ctran))) + (ensure-block-start prev) + (setf (ctran-next prev) nil) + (link-node-to-previous-ctran new prev) + (use-ctran new temp) + (link-node-to-previous-ctran old temp)) + (values)) + +;;; This function is used to set the ctran for a node, and thus +;;; determine what receives the value. +(defun use-lvar (node lvar) + (declare (type valued-node node) (type (or lvar null) lvar)) + (aver (not (node-lvar node))) + (when lvar + (setf (node-lvar node) lvar) + (cond ((null (lvar-uses lvar)) + (setf (lvar-uses lvar) node)) + ((listp (lvar-uses lvar)) + (aver (not (memq node (lvar-uses lvar)))) + (push node (lvar-uses lvar))) + (t + (aver (neq node (lvar-uses lvar))) + (setf (lvar-uses lvar) (list node (lvar-uses lvar))))) + (reoptimize-lvar lvar))) + +#!-sb-fluid(declaim (inline use-continuation)) +(defun use-continuation (node ctran lvar) + (use-ctran node ctran) + (use-lvar node lvar)) ;;;; exported functions -;;; This function takes a form and the top-level form number for that +;;; This function takes a form and the top level form number for that ;;; form, and returns a lambda representing the translation of that -;;; form in the current global environment. The lambda is top-level -;;; lambda that can be called to cause evaluation of the forms. This -;;; lambda is in the initial component. If FOR-VALUE is T, then the -;;; value of the form is returned from the function, otherwise NIL is -;;; returned. +;;; form in the current global environment. The returned lambda is a +;;; top level lambda that can be called to cause evaluation of the +;;; forms. This lambda is in the initial component. If FOR-VALUE is T, +;;; then the value of the form is returned from the function, +;;; otherwise NIL is returned. ;;; ;;; This function may have arbitrary effects on the global environment -;;; due to processing of PROCLAIMs and EVAL-WHENs. All syntax error -;;; checking is done, with erroneous forms being replaced by a proxy -;;; which signals an error if it is evaluated. Warnings about possibly -;;; inconsistent or illegal changes to the global environment will -;;; also be given. +;;; due to processing of EVAL-WHENs. All syntax error checking is +;;; done, with erroneous forms being replaced by a proxy which signals +;;; an error if it is evaluated. Warnings about possibly inconsistent +;;; or illegal changes to the global environment will also be given. ;;; ;;; We make the initial component and convert the form in a PROGN (and ;;; an optional NIL tacked on the end.) We then return the lambda. We @@ -349,31 +449,27 @@ ;;; The hashtables used to hold global namespace info must be ;;; reallocated elsewhere. Note also that *LEXENV* is not bound, so ;;; that local macro definitions can be introduced by enclosing code. -(defun ir1-top-level (form path for-value) +(defun ir1-toplevel (form path for-value &optional (allow-instrumenting t)) (declare (list path)) (let* ((*current-path* path) - (component (make-empty-component)) - (*current-component* component)) - (setf (component-name component) "initial component") + (component (make-empty-component)) + (*current-component* component) + (*allow-instrumenting* allow-instrumenting)) + (setf (component-name component) 'initial-component) (setf (component-kind component) :initial) (let* ((forms (if for-value `(,form) `(,form nil))) - (res (ir1-convert-lambda-body forms ()))) - (setf (leaf-name res) "top-level form") - (setf (functional-entry-function res) res) - (setf (functional-arg-documentation res) ()) - (setf (functional-kind res) :top-level) + (res (ir1-convert-lambda-body + forms () + :debug-name (debug-name 'top-level-form #+sb-xc-host nil #-sb-xc-host form)))) + (setf (functional-entry-fun res) res + (functional-arg-documentation res) () + (functional-kind res) :toplevel) res))) -;;; *CURRENT-FORM-NUMBER* is used in FIND-SOURCE-PATHS to compute the -;;; form number to associate with a source path. This should be bound -;;; to 0 around the processing of each truly top-level form. -(declaim (type index *current-form-number*)) -(defvar *current-form-number*) - ;;; This function is called on freshly read forms to record the ;;; initial location of each form (and subform.) Form is the form to -;;; find the paths in, and TLF-Num is the top-level form number of the -;;; truly top-level form. +;;; find the paths in, and TLF-NUM is the top level form number of the +;;; truly top level form. ;;; ;;; This gets a bit interesting when the source code is circular. This ;;; can (reasonably?) happen in the case of circular list constants. @@ -383,358 +479,585 @@ (sub-find-source-paths form (list tlf-num))) (values)) (defun sub-find-source-paths (form path) - (unless (gethash form *source-paths*) - (setf (gethash form *source-paths*) - (list* 'original-source-start *current-form-number* path)) + (unless (get-source-path form) + (note-source-path form path) (incf *current-form-number*) (let ((pos 0) - (subform form) - (trail form)) + (subform form) + (trail form)) (declare (fixnum pos)) (macrolet ((frob () - '(progn - (when (atom subform) (return)) - (let ((fm (car subform))) - (when (consp fm) - (sub-find-source-paths fm (cons pos path))) - (incf pos)) - (setq subform (cdr subform)) - (when (eq subform trail) (return))))) - (loop - (frob) - (frob) - (setq trail (cdr trail))))))) + '(progn + (when (atom subform) (return)) + (let ((fm (car subform))) + (if (consp fm) + ;; If it's a cons, recurse + (sub-find-source-paths fm (cons pos path)) + ;; Otherwise store the containing form. It's + ;; not perfect, but better than nothing. + (unless (zerop pos) + (note-source-path subform pos path))) + (incf pos)) + (setq subform (cdr subform)) + (when (eq subform trail) (return))))) + (loop + (frob) + (frob) + (setq trail (cdr trail))))))) ;;;; IR1-CONVERT, macroexpansion and special form dispatching +(declaim (ftype (sfunction (ctran ctran (or lvar null) t) (values)) + ir1-convert)) (macrolet (;; Bind *COMPILER-ERROR-BAILOUT* to a function that throws - ;; out of the body and converts a proxy form instead. - (ir1-error-bailout ((start - cont - form - &optional - (proxy ``(error "execution of a form compiled with errors:~% ~S" - ',,form))) - &body body) - (let ((skip (gensym "SKIP"))) - `(block ,skip - (catch 'ir1-error-abort - (let ((*compiler-error-bailout* - #'(lambda () - (throw 'ir1-error-abort nil)))) - ,@body - (return-from ,skip nil))) - (ir1-convert ,start ,cont ,proxy))))) + ;; out of the body and converts a condition signalling form + ;; instead. The source form is converted to a string since it + ;; may contain arbitrary non-externalizable objects. + (ir1-error-bailout ((start next result form) &body body) + (with-unique-names (skip condition) + `(block ,skip + (let ((,condition (catch 'ir1-error-abort + (let ((*compiler-error-bailout* + (lambda (&optional e) + (throw 'ir1-error-abort e)))) + ,@body + (return-from ,skip nil))))) + (ir1-convert ,start ,next ,result + (make-compiler-error-form ,condition + ,form))))))) ;; Translate FORM into IR1. The code is inserted as the NEXT of the - ;; continuation START. CONT is the continuation which receives the - ;; value of the FORM to be translated. The translators call this - ;; function recursively to translate their subnodes. + ;; CTRAN START. RESULT is the LVAR which receives the value of the + ;; FORM to be translated. The translators call this function + ;; recursively to translate their subnodes. ;; ;; As a special hack to make life easier in the compiler, a LEAF ;; IR1-converts into a reference to that LEAF structure. This allows ;; the creation using backquote of forms that contain leaf ;; references, without having to introduce dummy names into the ;; namespace. - (declaim (ftype (function (continuation continuation t) (values)) ir1-convert)) - (defun ir1-convert (start cont form) - (ir1-error-bailout (start cont form) - (let ((*current-path* (or (gethash form *source-paths*) - (cons form *current-path*)))) - (if (atom form) - (cond ((and (symbolp form) (not (keywordp form))) - (ir1-convert-variable start cont form)) - ((leaf-p form) - (reference-leaf start cont form)) - (t - (reference-constant start cont form))) - (let ((fun (car form))) - (cond - ((symbolp fun) - (let ((lexical-def (lexenv-find fun functions))) - (typecase lexical-def - (null (ir1-convert-global-functoid start cont form)) - (functional - (ir1-convert-local-combination start - cont - form - lexical-def)) - (global-var - (ir1-convert-srctran start cont lexical-def form)) - (t - (assert (and (consp lexical-def) - (eq (car lexical-def) 'macro))) - (ir1-convert start cont - (careful-expand-macro (cdr lexical-def) - form)))))) - ((or (atom fun) (not (eq (car fun) 'lambda))) - (compiler-error "illegal function call")) - (t - (ir1-convert-combination start - cont - form - (ir1-convert-lambda fun)))))))) + (defun ir1-convert (start next result form) + (ir1-error-bailout (start next result form) + (let* ((*current-path* (or (get-source-path form) + (cons form *current-path*))) + (start (instrument-coverage start nil form))) + (cond ((atom form) + (cond ((and (symbolp form) (not (keywordp form))) + (ir1-convert-var start next result form)) + ((leaf-p form) + (reference-leaf start next result form)) + (t + (reference-constant start next result form)))) + (t + (ir1-convert-functoid start next result form))))) (values)) ;; Generate a reference to a manifest constant, creating a new leaf - ;; if necessary. If we are producing a fasl-file, make sure that - ;; MAKE-LOAD-FORM gets used on any parts of the constant that it - ;; needs to be. - (defun reference-constant (start cont value) - (declare (type continuation start cont) - (inline find-constant)) - (ir1-error-bailout - (start cont value - '(error "attempt to reference undumpable constant")) - (when (producing-fasl-file) - (maybe-emit-make-load-forms value)) - (let* ((leaf (find-constant value)) - (res (make-ref (leaf-type leaf) leaf))) - (push res (leaf-refs leaf)) - (prev-link res start) - (use-continuation res cont))) + ;; if necessary. + (defun reference-constant (start next result value) + (declare (type ctran start next) + (type (or lvar null) result)) + (ir1-error-bailout (start next result value) + (let* ((leaf (find-constant value)) + (res (make-ref leaf))) + (push res (leaf-refs leaf)) + (link-node-to-previous-ctran res start) + (use-continuation res next result))) (values))) -;;; Add Fun to the COMPONENT-REANALYZE-FUNCTIONS. Fun is returned. - (defun maybe-reanalyze-function (fun) - (declare (type functional fun)) - (when (typep fun '(or optional-dispatch clambda)) - (pushnew fun (component-reanalyze-functions *current-component*))) - fun) +;;; Add FUNCTIONAL to the COMPONENT-REANALYZE-FUNCTIONALS, unless it's +;;; some trivial type for which reanalysis is a trivial no-op, or +;;; unless it doesn't belong in this component at all. +;;; +;;; FUNCTIONAL is returned. +(defun maybe-reanalyze-functional (functional) + + (aver (not (eql (functional-kind functional) :deleted))) ; bug 148 + (aver-live-component *current-component*) + + ;; When FUNCTIONAL is of a type for which reanalysis isn't a trivial + ;; no-op + (when (typep functional '(or optional-dispatch clambda)) + + ;; When FUNCTIONAL knows its component + (when (lambda-p functional) + (aver (eql (lambda-component functional) *current-component*))) + + (pushnew functional + (component-reanalyze-functionals *current-component*))) + + functional) -;;; Generate a Ref node for LEAF, frobbing the LEAF structure as +;;; Generate a REF node for LEAF, frobbing the LEAF structure as ;;; needed. If LEAF represents a defined function which has already ;;; been converted, and is not :NOTINLINE, then reference the ;;; functional instead. -(defun reference-leaf (start cont leaf) - (declare (type continuation start cont) (type leaf leaf)) - (let* ((leaf (or (and (defined-function-p leaf) - (not (eq (defined-function-inlinep leaf) - :notinline)) - (let ((fun (defined-function-functional leaf))) - (when (and fun (not (functional-kind fun))) - (maybe-reanalyze-function fun)))) - leaf)) - (res (make-ref (or (lexenv-find leaf type-restrictions) - (leaf-type leaf)) - leaf))) - (push res (leaf-refs leaf)) +(defun reference-leaf (start next result leaf &optional (name '.anonymous.)) + (declare (type ctran start next) (type (or lvar null) result) (type leaf leaf)) + (when (functional-p leaf) + (assure-functional-live-p leaf)) + (let* ((type (lexenv-find leaf type-restrictions)) + (leaf (or (and (defined-fun-p leaf) + (not (eq (defined-fun-inlinep leaf) + :notinline)) + (let ((functional (defined-fun-functional leaf))) + (when (and functional + (not (functional-kind functional)) + ;; Bug MISC.320: ir1-transform + ;; can create a reference to a + ;; inline-expanded function, + ;; defined in another component. + (not (and (lambda-p functional) + (neq (lambda-component functional) + *current-component*)))) + (maybe-reanalyze-functional functional)))) + (when (and (lambda-p leaf) + (memq (functional-kind leaf) + '(nil :optional))) + (maybe-reanalyze-functional leaf)) + leaf)) + (ref (make-ref leaf name))) + (push ref (leaf-refs leaf)) (setf (leaf-ever-used leaf) t) - (prev-link res start) - (use-continuation res cont))) + (link-node-to-previous-ctran ref start) + (cond (type (let* ((ref-ctran (make-ctran)) + (ref-lvar (make-lvar)) + (cast (make-cast ref-lvar + (make-single-value-type type) + (lexenv-policy *lexenv*)))) + (setf (lvar-dest ref-lvar) cast) + (use-continuation ref ref-ctran ref-lvar) + (link-node-to-previous-ctran cast ref-ctran) + (use-continuation cast next result))) + (t (use-continuation ref next result))))) ;;; Convert a reference to a symbolic constant or variable. If the -;;; symbol is entered in the LEXENV-VARIABLES we use that definition, +;;; symbol is entered in the LEXENV-VARS we use that definition, ;;; otherwise we find the current global definition. This is also -;;; where we pick off symbol macro and Alien variable references. -(defun ir1-convert-variable (start cont name) - (declare (type continuation start cont) (symbol name)) - (let ((var (or (lexenv-find name variables) (find-free-variable name)))) - (etypecase var - (leaf - (when (and (lambda-var-p var) (lambda-var-ignorep var)) - ;; (ANSI's specification for the IGNORE declaration requires - ;; that this be a STYLE-WARNING, not a full WARNING.) - (compiler-style-warning "reading an ignored variable: ~S" name)) - (reference-leaf start cont var)) - (cons - (assert (eq (car var) 'MACRO)) - (ir1-convert start cont (cdr var))) - (heap-alien-info - (ir1-convert start cont `(%heap-alien ',var))))) +;;; where we pick off symbol macro and alien variable references. +(defun ir1-convert-var (start next result name) + (declare (type ctran start next) (type (or lvar null) result) (symbol name)) + (let ((var (or (lexenv-find name vars) (find-free-var name)))) + (if (and (global-var-p var) (not result)) + ;; KLUDGE: If the reference is dead, convert using SYMBOL-VALUE + ;; which is not flushable, so that unbound dead variables signal + ;; an error (bug 412). + (ir1-convert start next result + (if (eq (global-var-kind var) :global) + `(symbol-global-value ',name) + `(symbol-value ',name))) + (etypecase var + (leaf + (when (lambda-var-p var) + (let ((home (ctran-home-lambda-or-null start))) + (when home + (sset-adjoin var (lambda-calls-or-closes home)))) + (when (lambda-var-ignorep var) + ;; (ANSI's specification for the IGNORE declaration requires + ;; that this be a STYLE-WARNING, not a full WARNING.) + #-sb-xc-host + (compiler-style-warn "reading an ignored variable: ~S" name) + ;; there's no need for us to accept ANSI's lameness when + ;; processing our own code, though. + #+sb-xc-host + (warn "reading an ignored variable: ~S" name))) + (reference-leaf start next result var name)) + (cons + (aver (eq (car var) 'macro)) + ;; FIXME: [Free] type declarations. -- APD, 2002-01-26 + (ir1-convert start next result (cdr var))) + (heap-alien-info + (ir1-convert start next result `(%heap-alien ',var)))))) (values)) -;;; Convert anything that looks like a special form, global function -;;; or macro call. -(defun ir1-convert-global-functoid (start cont form) - (declare (type continuation start cont) (list form)) - (let* ((fun (first form)) - (translator (info :function :ir1-convert fun)) - (cmacro (info :function :compiler-macro-function fun))) - (cond (translator (funcall translator start cont form)) - ((and cmacro (not *converting-for-interpreter*) - (not (eq (info :function :inlinep fun) :notinline))) - (let ((res (careful-expand-macro cmacro form))) - (if (eq res form) - (ir1-convert-global-functoid-no-cmacro start cont form fun) - (ir1-convert start cont res)))) - (t - (ir1-convert-global-functoid-no-cmacro start cont form fun))))) - -;;; Handle the case of where the call was not a compiler macro, or was a -;;; compiler macro and passed. -(defun ir1-convert-global-functoid-no-cmacro (start cont form fun) - (declare (type continuation start cont) (list form)) +;;; Find a compiler-macro for a form, taking FUNCALL into account. +(defun find-compiler-macro (opname form) + (if (eq opname 'funcall) + (let ((fun-form (cadr form))) + (cond ((and (consp fun-form) (eq 'function (car fun-form))) + (let ((real-fun (cadr fun-form))) + (if (legal-fun-name-p real-fun) + (values (sb!xc:compiler-macro-function real-fun *lexenv*) + real-fun) + (values nil nil)))) + ((sb!xc:constantp fun-form *lexenv*) + (let ((fun (constant-form-value fun-form *lexenv*))) + (if (legal-fun-name-p fun) + ;; CLHS tells us that local functions must shadow + ;; compiler-macro-functions, but since the call is + ;; through a name, we are obviously interested + ;; in the global function. + (values (sb!xc:compiler-macro-function fun nil) fun) + (values nil nil)))) + (t + (values nil nil)))) + (if (legal-fun-name-p opname) + (values (sb!xc:compiler-macro-function opname *lexenv*) opname) + (values nil nil)))) + +;;; Picks of special forms and compiler-macro expansions, and hands +;;; the rest to IR1-CONVERT-COMMON-FUNCTOID +(defun ir1-convert-functoid (start next result form) + (let* ((op (car form)) + (translator (and (symbolp op) (info :function :ir1-convert op)))) + (cond (translator + (when (sb!xc:compiler-macro-function op *lexenv*) + (compiler-warn "ignoring compiler macro for special form")) + (funcall translator start next result form)) + (t + (multiple-value-bind (cmacro-fun cmacro-fun-name) + (find-compiler-macro op form) + (if (and cmacro-fun + ;; CLHS 3.2.2.1.3 specifies that NOTINLINE + ;; suppresses compiler-macros. + (not (fun-lexically-notinline-p cmacro-fun-name))) + (let ((res (careful-expand-macro cmacro-fun form))) + (cond ((eq res form) + (ir1-convert-common-functoid start next result form op)) + (t + (unless (policy *lexenv* (zerop store-xref-data)) + (record-call cmacro-fun-name (ctran-block start) *current-path*)) + (ir1-convert start next result res)))) + (ir1-convert-common-functoid start next result form op))))))) + +;;; Handles the "common" cases: any other forms except special forms +;;; and compiler-macros. +(defun ir1-convert-common-functoid (start next result form op) + (cond ((or (symbolp op) (leaf-p op)) + (let ((lexical-def (if (leaf-p op) op (lexenv-find op funs)))) + (typecase lexical-def + (null + (ir1-convert-global-functoid start next result form op)) + (functional + (ir1-convert-local-combination start next result form + lexical-def)) + (global-var + (ir1-convert-srctran start next result lexical-def form)) + (t + (aver (and (consp lexical-def) (eq (car lexical-def) 'macro))) + (ir1-convert start next result + (careful-expand-macro (cdr lexical-def) form)))))) + ((or (atom op) (not (eq (car op) 'lambda))) + (compiler-error "illegal function call")) + (t + ;; implicitly (LAMBDA ..) because the LAMBDA expression is + ;; the CAR of an executed form. + (ir1-convert-combination + start next result form + (ir1-convert-lambda op + :debug-name (debug-name 'inline-lambda op)))))) + +;;; Convert anything that looks like a global function call. +(defun ir1-convert-global-functoid (start next result form fun) + (declare (type ctran start next) (type (or lvar null) result) + (list form)) ;; FIXME: Couldn't all the INFO calls here be converted into - ;; standard CL functions, like MACRO-FUNCTION or something? - ;; And what happens with lexically-defined (MACROLET) macros - ;; here, anyway? + ;; standard CL functions, like MACRO-FUNCTION or something? And what + ;; happens with lexically-defined (MACROLET) macros here, anyway? (ecase (info :function :kind fun) (:macro - (ir1-convert start - cont - (careful-expand-macro (info :function :macro-function fun) - form))) + (ir1-convert start next result + (careful-expand-macro (info :function :macro-function fun) + form)) + (unless (policy *lexenv* (zerop store-xref-data)) + (record-macroexpansion fun (ctran-block start) *current-path*))) ((nil :function) - (ir1-convert-srctran start cont (find-free-function fun "Eh?") form)))) + (ir1-convert-srctran start next result + (find-free-fun fun "shouldn't happen! (no-cmacro)") + form)))) (defun muffle-warning-or-die () (muffle-warning) - (error "internal error -- no MUFFLE-WARNING restart")) + (bug "no MUFFLE-WARNING restart")) -;;; Trap errors during the macroexpansion. +;;; Expand FORM using the macro whose MACRO-FUNCTION is FUN, trapping +;;; errors which occur during the macroexpansion. (defun careful-expand-macro (fun form) - (handler-bind (;; When cross-compiling, we can get style warnings - ;; about e.g. undefined functions. An unhandled - ;; CL:STYLE-WARNING (as opposed to a - ;; SB!C::COMPILER-NOTE) would cause FAILURE-P to be - ;; set on the return from #'SB!XC:COMPILE-FILE, which - ;; would falsely indicate an error sufficiently - ;; serious that we should stop the build process. To - ;; avoid this, we translate CL:STYLE-WARNING - ;; conditions from the host Common Lisp into - ;; cross-compiler SB!C::COMPILER-NOTE calls. (It - ;; might be cleaner to just make Python use - ;; CL:STYLE-WARNING internally, so that the - ;; significance of any host Common Lisp - ;; CL:STYLE-WARNINGs is understood automatically. But - ;; for now I'm not motivated to do this. -- WHN - ;; 19990412) - (style-warning (lambda (c) - (compiler-note "(during macroexpansion)~%~A" - c) - (muffle-warning-or-die))) - ;; KLUDGE: CMU CL in its wisdom (version 2.4.6 for - ;; Debian Linux, anyway) raises a CL:WARNING - ;; condition (not a CL:STYLE-WARNING) for undefined - ;; symbols when converting interpreted functions, - ;; causing COMPILE-FILE to think the file has a real - ;; problem, causing COMPILE-FILE to return FAILURE-P - ;; set (not just WARNINGS-P set). Since undefined - ;; symbol warnings are often harmless forward - ;; references, and since it'd be inordinately painful - ;; to try to eliminate all such forward references, - ;; these warnings are basically unavoidable. Thus, we - ;; need to coerce the system to work through them, - ;; and this code does so, by crudely suppressing all - ;; warnings in cross-compilation macroexpansion. -- - ;; WHN 19990412 - #+cmu - (warning (lambda (c) - (compiler-note - "(during macroexpansion)~%~ - ~A~%~ - (KLUDGE: That was a non-STYLE WARNING.~%~ - Ordinarily that would cause compilation to~%~ - fail. However, since we're running under~%~ - CMU CL, and since CMU CL emits non-STYLE~%~ - warnings for safe, hard-to-fix things (e.g.~%~ - references to not-yet-defined functions)~%~ - we're going to have to ignore it and proceed~%~ - anyway. Hopefully we're not ignoring anything~%~ - horrible here..)~%" - c) - (muffle-warning-or-die))) - (error (lambda (c) - (compiler-error "(during macroexpansion)~%~A" c)))) - (funcall sb!xc:*macroexpand-hook* - fun - form - *lexenv*))) + (let (;; a hint I (WHN) wish I'd known earlier + (hint "(hint: For more precise location, try *BREAK-ON-SIGNALS*.)")) + (flet (;; Return a string to use as a prefix in error reporting, + ;; telling something about which form caused the problem. + (wherestring () + (let ((*print-pretty* nil) + ;; We rely on the printer to abbreviate FORM. + (*print-length* 3) + (*print-level* 3)) + (format + nil + #-sb-xc-host "(in macroexpansion of ~S)" + ;; longer message to avoid ambiguity "Was it the xc host + ;; or the cross-compiler which encountered the problem?" + #+sb-xc-host "(in cross-compiler macroexpansion of ~S)" + form)))) + (handler-bind ((style-warning (lambda (c) + (compiler-style-warn + "~@<~A~:@_~A~@:_~A~:>" + (wherestring) hint c) + (muffle-warning-or-die))) + ;; KLUDGE: CMU CL in its wisdom (version 2.4.6 for + ;; Debian Linux, anyway) raises a CL:WARNING + ;; condition (not a CL:STYLE-WARNING) for undefined + ;; symbols when converting interpreted functions, + ;; causing COMPILE-FILE to think the file has a real + ;; problem, causing COMPILE-FILE to return FAILURE-P + ;; set (not just WARNINGS-P set). Since undefined + ;; symbol warnings are often harmless forward + ;; references, and since it'd be inordinately painful + ;; to try to eliminate all such forward references, + ;; these warnings are basically unavoidable. Thus, we + ;; need to coerce the system to work through them, + ;; and this code does so, by crudely suppressing all + ;; warnings in cross-compilation macroexpansion. -- + ;; WHN 19990412 + #+(and cmu sb-xc-host) + (warning (lambda (c) + (compiler-notify + "~@<~A~:@_~ + ~A~:@_~ + ~@<(KLUDGE: That was a non-STYLE WARNING. ~ + Ordinarily that would cause compilation to ~ + fail. However, since we're running under ~ + CMU CL, and since CMU CL emits non-STYLE ~ + warnings for safe, hard-to-fix things (e.g. ~ + references to not-yet-defined functions) ~ + we're going to have to ignore it and ~ + proceed anyway. Hopefully we're not ~ + ignoring anything horrible here..)~:@>~:>" + (wherestring) + c) + (muffle-warning-or-die))) + #-(and cmu sb-xc-host) + (warning (lambda (c) + (warn "~@<~A~:@_~A~@:_~A~:>" + (wherestring) hint c) + (muffle-warning-or-die))) + (error (lambda (c) + (compiler-error "~@<~A~:@_~A~@:_~A~:>" + (wherestring) hint c)))) + (funcall sb!xc:*macroexpand-hook* fun form *lexenv*))))) ;;;; conversion utilities ;;; Convert a bunch of forms, discarding all the values except the ;;; last. If there aren't any forms, then translate a NIL. -(declaim (ftype (function (continuation continuation list) (values)) - ir1-convert-progn-body)) -(defun ir1-convert-progn-body (start cont body) +(declaim (ftype (sfunction (ctran ctran (or lvar null) list) (values)) + ir1-convert-progn-body)) +(defun ir1-convert-progn-body (start next result body) (if (endp body) - (reference-constant start cont nil) + (reference-constant start next result nil) (let ((this-start start) - (forms body)) - (loop - (let ((form (car forms))) - (when (endp (cdr forms)) - (ir1-convert this-start cont form) - (return)) - (let ((this-cont (make-continuation))) - (ir1-convert this-start this-cont form) - (setq this-start this-cont forms (cdr forms))))))) + (forms body)) + (loop + (let ((form (car forms))) + (setf this-start + (maybe-instrument-progn-like this-start forms form)) + (when (endp (cdr forms)) + (ir1-convert this-start next result form) + (return)) + (let ((this-ctran (make-ctran))) + (ir1-convert this-start this-ctran nil form) + (setq this-start this-ctran + forms (cdr forms))))))) (values)) + + +;;;; code coverage + +;;; Check the policy for whether we should generate code coverage +;;; instrumentation. If not, just return the original START +;;; ctran. Otherwise insert code coverage instrumentation after +;;; START, and return the new ctran. +(defun instrument-coverage (start mode form) + ;; We don't actually use FORM for anything, it's just convenient to + ;; have around when debugging the instrumentation. + (declare (ignore form)) + (if (and (policy *lexenv* (> store-coverage-data 0)) + *code-coverage-records* + *allow-instrumenting*) + (let ((path (source-path-original-source *current-path*))) + (when mode + (push mode path)) + (if (member (ctran-block start) + (gethash path *code-coverage-blocks*)) + ;; If this source path has already been instrumented in + ;; this block, don't instrument it again. + start + (let ((store + ;; Get an interned record cons for the path. A cons + ;; with the same object identity must be used for + ;; each instrument for the same block. + (or (gethash path *code-coverage-records*) + (setf (gethash path *code-coverage-records*) + (cons path +code-coverage-unmarked+)))) + (next (make-ctran)) + (*allow-instrumenting* nil)) + (push (ctran-block start) + (gethash path *code-coverage-blocks*)) + (let ((*allow-instrumenting* nil)) + (ir1-convert start next nil + `(locally + (declare (optimize speed + (safety 0) + (debug 0) + (check-constant-modification 0))) + ;; We're being naughty here, and + ;; modifying constant data. That's ok, + ;; we know what we're doing. + (%rplacd ',store t)))) + next))) + start)) + +;;; In contexts where we don't have a source location for FORM +;;; e.g. due to it not being a cons, but where we have a source +;;; location for the enclosing cons, use the latter source location if +;;; available. This works pretty well in practice, since many PROGNish +;;; macroexpansions will just directly splice a block of forms into +;;; some enclosing form with `(progn ,@body), thus retaining the +;;; EQness of the conses. +(defun maybe-instrument-progn-like (start forms form) + (or (when (and *allow-instrumenting* + (not (get-source-path form))) + (let ((*current-path* (get-source-path forms))) + (when *current-path* + (instrument-coverage start nil form)))) + start)) + +(defun record-code-coverage (info cc) + (setf (gethash info *code-coverage-info*) cc)) + +(defun clear-code-coverage () + (clrhash *code-coverage-info*)) + +(defun reset-code-coverage () + (maphash (lambda (info cc) + (declare (ignore info)) + (dolist (cc-entry cc) + (setf (cdr cc-entry) +code-coverage-unmarked+))) + *code-coverage-info*)) + +(defun code-coverage-record-marked (record) + (aver (consp record)) + (ecase (cdr record) + ((#.+code-coverage-unmarked+) nil) + ((t) t))) + ;;;; converting combinations -;;; Convert a function call where the function (Fun) is a Leaf. We -;;; return the Combination node so that we can poke at it if we want to. -(declaim (ftype (function (continuation continuation list leaf) combination) - ir1-convert-combination)) -(defun ir1-convert-combination (start cont form fun) - (let ((fun-cont (make-continuation))) - (reference-leaf start fun-cont fun) - (ir1-convert-combination-args fun-cont cont (cdr form)))) - -;;; Convert the arguments to a call and make the Combination node. Fun-Cont -;;; is the continuation which yields the function to call. Form is the source -;;; for the call. Args is the list of arguments for the call, which defaults -;;; to the cdr of source. We return the Combination node. -(defun ir1-convert-combination-args (fun-cont cont args) - (declare (type continuation fun-cont cont) (list args)) - (let ((node (make-combination fun-cont))) - (setf (continuation-dest fun-cont) node) - (assert-continuation-type fun-cont - (specifier-type '(or function symbol))) - (collect ((arg-conts)) - (let ((this-start fun-cont)) - (dolist (arg args) - (let ((this-cont (make-continuation node))) - (ir1-convert this-start this-cont arg) - (setq this-start this-cont) - (arg-conts this-cont))) - (prev-link node this-start) - (use-continuation node cont) - (setf (combination-args node) (arg-conts)))) +;;; Does this form look like something that we should add single-stepping +;;; instrumentation for? +(defun step-form-p (form) + (flet ((step-symbol-p (symbol) + (not (member (symbol-package symbol) + (load-time-value + ;; KLUDGE: packages we're not interested in + ;; stepping. + (mapcar #'find-package '(sb!c sb!int sb!impl + sb!kernel sb!pcl))))))) + (and *allow-instrumenting* + (policy *lexenv* (= insert-step-conditions 3)) + (listp form) + (symbolp (car form)) + (step-symbol-p (car form))))) + +;;; Convert a function call where the function FUN is a LEAF. FORM is +;;; the source for the call. We return the COMBINATION node so that +;;; the caller can poke at it if it wants to. +(declaim (ftype (sfunction (ctran ctran (or lvar null) list leaf) combination) + ir1-convert-combination)) +(defun ir1-convert-combination (start next result form fun) + (let ((ctran (make-ctran)) + (fun-lvar (make-lvar))) + (ir1-convert start ctran fun-lvar `(the (or function symbol) ,fun)) + (let ((combination + (ir1-convert-combination-args fun-lvar ctran next result + (cdr form)))) + (when (step-form-p form) + ;; Store a string representation of the form in the + ;; combination node. This will let the IR2 translator know + ;; that we want stepper instrumentation for this node. The + ;; string will be stored in the debug-info by DUMP-1-LOCATION. + (setf (combination-step-info combination) + (let ((*print-pretty* t) + (*print-circle* t) + (*print-readably* nil)) + (prin1-to-string form)))) + combination))) + +;;; Convert the arguments to a call and make the COMBINATION +;;; node. FUN-LVAR yields the function to call. ARGS is the list of +;;; arguments for the call, which defaults to the cdr of source. We +;;; return the COMBINATION node. +(defun ir1-convert-combination-args (fun-lvar start next result args) + (declare (type ctran start next) + (type lvar fun-lvar) + (type (or lvar null) result) + (list args)) + (let ((node (make-combination fun-lvar))) + (setf (lvar-dest fun-lvar) node) + (collect ((arg-lvars)) + (let ((this-start start) + (forms args)) + (dolist (arg args) + (setf this-start + (maybe-instrument-progn-like this-start forms arg)) + (setf forms (cdr forms)) + (let ((this-ctran (make-ctran)) + (this-lvar (make-lvar node))) + (ir1-convert this-start this-ctran this-lvar arg) + (setq this-start this-ctran) + (arg-lvars this-lvar))) + (link-node-to-previous-ctran node this-start) + (use-continuation node next result) + (setf (combination-args node) (arg-lvars)))) node)) ;;; Convert a call to a global function. If not :NOTINLINE, then we do ;;; source transforms and try out any inline expansion. If there is no -;;; expansion, but is :INLINE, then give an efficiency note (unless a known -;;; function which will quite possibly be open-coded.) Next, we go to -;;; ok-combination conversion. -(defun ir1-convert-srctran (start cont var form) - (declare (type continuation start cont) (type global-var var)) - (let ((inlinep (when (defined-function-p var) - (defined-function-inlinep var)))) - (cond - ((eq inlinep :notinline) - (ir1-convert-combination start cont form var)) - (*converting-for-interpreter* - (ir1-convert-combination-checking-type start cont form var)) - (t - (let ((transform (info :function :source-transform (leaf-name var)))) - (cond - (transform - (multiple-value-bind (result pass) (funcall transform form) - (if pass - (ir1-convert-maybe-predicate start cont form var) - (ir1-convert start cont result)))) - (t - (ir1-convert-maybe-predicate start cont form var)))))))) - -;;; If the function has the Predicate attribute, and the CONT's DEST isn't -;;; an IF, then we convert (IF