X-Git-Url: http://repo.macrolet.net/gitweb/?a=blobdiff_plain;f=src%2Fcompiler%2Fir1util.lisp;h=2f96290dbe10a278b50ea1639f3678b3e5ff1ac4;hb=11214915e9b3151ec66dc3e30e1aa7638c676428;hp=7bb508d0209d67d3a15eaeb318c4076bd1898d50;hpb=6c765578c8dc4bcc7798e37c9918715f198b30da;p=sbcl.git diff --git a/src/compiler/ir1util.lisp b/src/compiler/ir1util.lisp index 7bb508d..2f96290 100644 --- a/src/compiler/ir1util.lisp +++ b/src/compiler/ir1util.lisp @@ -14,9 +14,9 @@ ;;;; cleanup hackery -;;; Return the innermost cleanup enclosing Node, or NIL if there is none in -;;; its function. If Node has no cleanup, but is in a let, then we must still -;;; check the environment that the call is in. +;;; Return the innermost cleanup enclosing NODE, or NIL if there is +;;; none in its function. If NODE has no cleanup, but is in a LET, +;;; then we must still check the environment that the call is in. (defun node-enclosing-cleanup (node) (declare (type node node)) (do ((lexenv (node-lexenv node) @@ -25,17 +25,18 @@ (let ((cup (lexenv-cleanup lexenv))) (when cup (return cup))))) -;;; Convert the Form in a block inserted between Block1 and Block2 as an -;;; implicit MV-Prog1. The inserted block is returned. Node is used for IR1 -;;; context when converting the form. Note that the block is not assigned a -;;; number, and is linked into the DFO at the beginning. We indicate that we -;;; have trashed the DFO by setting Component-Reanalyze. If Cleanup is -;;; supplied, then convert with that cleanup. +;;; Convert the FORM in a block inserted between BLOCK1 and BLOCK2 as +;;; an implicit MV-PROG1. The inserted block is returned. NODE is used +;;; for IR1 context when converting the form. Note that the block is +;;; not assigned a number, and is linked into the DFO at the +;;; beginning. We indicate that we have trashed the DFO by setting +;;; COMPONENT-REANALYZE. If CLEANUP is supplied, then convert with +;;; that cleanup. (defun insert-cleanup-code (block1 block2 node form &optional cleanup) (declare (type cblock block1 block2) (type node node) (type (or cleanup null) cleanup)) (setf (component-reanalyze (block-component block1)) t) - (with-ir1-environment node + (with-ir1-environment-from-node node (let* ((start (make-continuation)) (block (continuation-starts-block start)) (cont (make-continuation)) @@ -60,9 +61,9 @@ (:unused nil) (:deleted nil))) -;;; Update continuation use information so that Node is no longer a -;;; use of its Cont. If the old continuation doesn't start its block, -;;; then we don't update the Block-Start-Uses, since it will be +;;; Update continuation use information so that NODE is no longer a +;;; use of its CONT. If the old continuation doesn't start its block, +;;; then we don't update the BLOCK-START-USES, since it will be ;;; deleted when we are done. ;;; ;;; Note: if you call this function, you may have to do a @@ -87,8 +88,8 @@ (setf (node-cont node) nil)) (values)) -;;; Update continuation use information so that Node uses Cont. If -;;; Cont is :Unused, then we set its block to Node's Node-Block (which +;;; Update continuation use information so that NODE uses CONT. If +;;; CONT is :UNUSED, then we set its block to NODE's NODE-BLOCK (which ;;; must be set.) ;;; ;;; Note: if you call this function, you may have to do a @@ -115,8 +116,8 @@ (setf (node-cont node) cont) (values)) -;;; Return true if Cont is the Node-Cont for Node and Cont is transferred to -;;; immediately after the evaluation of Node. +;;; Return true if CONT is the NODE-CONT for NODE and CONT is +;;; transferred to immediately after the evaluation of NODE. (defun immediately-used-p (cont node) (declare (type continuation cont) (type node node)) (and (eq (node-cont node) cont) @@ -130,9 +131,9 @@ ;;;; continuation substitution -;;; In Old's Dest, replace Old with New. New's Dest must initially be NIL. -;;; When we are done, we call Flush-Dest on Old to clear its Dest and to note -;;; potential optimization opportunities. +;;; In OLD's DEST, replace OLD with NEW. NEW's DEST must initially be +;;; NIL. When we are done, we call FLUSH-DEST on OLD to clear its DEST +;;; and to note potential optimization opportunities. (defun substitute-continuation (new old) (declare (type continuation old new)) (aver (not (continuation-dest new))) @@ -202,13 +203,14 @@ (:block-start (continuation-block cont)))) -;;; Ensure that Cont is the start of a block (or deleted) so that the use -;;; set can be freely manipulated. -;;; -- If the continuation is :Unused or is :Inside-Block and the Cont of Last -;;; in its block, then we make it the start of a new deleted block. -;;; -- If the continuation is :Inside-Block inside a block, then we split the -;;; block using Node-Ends-Block, which makes the continuation be a -;;; :Block-Start. +;;; Ensure that CONT is the start of a block (or deleted) so that +;;; the use set can be freely manipulated. +;;; -- If the continuation is :UNUSED or is :INSIDE-BLOCK and the +;;; CONT of LAST in its block, then we make it the start of a new +;;; deleted block. +;;; -- If the continuation is :INSIDE-BLOCK inside a block, then we +;;; split the block using Node-Ends-Block, which makes the +;;; continuation be a :BLOCK-START. (defun ensure-block-start (cont) (declare (type continuation cont)) (let ((kind (continuation-kind cont))) @@ -229,10 +231,10 @@ ;;;; miscellaneous shorthand functions -;;; Return the home (i.e. enclosing non-let) lambda for Node. Since the -;;; LEXENV-LAMBDA may be deleted, we must chain up the LAMBDA-CALL-LEXENV -;;; thread until we find a lambda that isn't deleted, and then return its home. -(declaim (maybe-inline node-home-lambda)) +;;; Return the home (i.e. enclosing non-LET) CLAMBDA for NODE. Since +;;; the LEXENV-LAMBDA may be deleted, we must chain up the +;;; LAMBDA-CALL-LEXENV thread until we find a CLAMBDA that isn't +;;; deleted, and then return its home. (defun node-home-lambda (node) (declare (type node node)) (do ((fun (lexenv-lambda (node-lexenv node)) @@ -242,18 +244,24 @@ (when (eq (lambda-home fun) fun) (return fun)))) -#!-sb-fluid (declaim (inline node-block node-tlf-number)) -(declaim (maybe-inline node-environment)) (defun node-block (node) (declare (type node node)) (the cblock (continuation-block (node-prev node)))) -(defun node-environment (node) +(defun node-component (node) (declare (type node node)) - #!-sb-fluid (declare (inline node-home-lambda)) - (the environment (lambda-environment (node-home-lambda node)))) + (block-component (node-block node))) +(defun node-physenv (node) + (declare (type node node)) + (the physenv (lambda-physenv (node-home-lambda node)))) + +(defun lambda-block (clambda) + (declare (type clambda clambda)) + (node-block (lambda-bind clambda))) +(defun lambda-component (clambda) + (block-component (lambda-block clambda))) -;;; Return the enclosing cleanup for environment of the first or last node -;;; in Block. +;;; Return the enclosing cleanup for environment of the first or last +;;; node in BLOCK. (defun block-start-cleanup (block) (declare (type cblock block)) (node-enclosing-cleanup (continuation-next (block-start block)))) @@ -261,31 +269,67 @@ (declare (type cblock block)) (node-enclosing-cleanup (block-last block))) -;;; Return the non-let lambda that holds Block's code. -(defun block-home-lambda (block) +;;; Return the non-LET LAMBDA that holds BLOCK's code, or NIL +;;; if there is none. +;;; +;;; There can legitimately be no home lambda in dead code early in the +;;; IR1 conversion process, e.g. when IR1-converting the SETQ form in +;;; (BLOCK B (RETURN-FROM B) (SETQ X 3)) +;;; where the block is just a placeholder during parsing and doesn't +;;; actually correspond to code which will be written anywhere. +(defun block-home-lambda-or-null (block) (declare (type cblock block)) - #!-sb-fluid (declare (inline node-home-lambda)) - (node-home-lambda (block-last block))) + (if (node-p (block-last block)) + ;; This is the old CMU CL way of doing it. + (node-home-lambda (block-last block)) + ;; Now that SBCL uses this operation more aggressively than CMU + ;; CL did, the old CMU CL way of doing it can fail in two ways. + ;; 1. It can fail in a few cases even when a meaningful home + ;; lambda exists, e.g. in IR1-CONVERT of one of the legs of + ;; an IF. + ;; 2. It can fail when converting a form which is born orphaned + ;; so that it never had a meaningful home lambda, e.g. a form + ;; which follows a RETURN-FROM or GO form. + (let ((pred-list (block-pred block))) + ;; To deal with case 1, we reason that + ;; previous-in-target-execution-order blocks should be in the + ;; same lambda, and that they seem in practice to be + ;; previous-in-compilation-order blocks too, so we look back + ;; to find one which is sufficiently initialized to tell us + ;; what the home lambda is. + (if pred-list + ;; We could get fancy about this, flooding through the + ;; graph of all the previous blocks, but in practice it + ;; seems to work just to grab the first previous block and + ;; use it. + (node-home-lambda (block-last (first pred-list))) + ;; In case 2, we end up with an empty PRED-LIST and + ;; have to punt: There's no home lambda. + nil)))) + +;;; Return the non-LET LAMBDA that holds BLOCK's code. +(defun block-home-lambda (block) + (the clambda + (block-home-lambda-or-null block))) -;;; Return the IR1 environment for Block. -(defun block-environment (block) +;;; Return the IR1 physical environment for BLOCK. +(defun block-physenv (block) (declare (type cblock block)) - #!-sb-fluid (declare (inline node-home-lambda)) - (lambda-environment (node-home-lambda (block-last block)))) + (lambda-physenv (block-home-lambda block))) -;;; Return the Top Level Form number of path, i.e. the ordinal number -;;; of its original source's top-level form in its compilation unit. +;;; Return the Top Level Form number of PATH, i.e. the ordinal number +;;; of its original source's top level form in its compilation unit. (defun source-path-tlf-number (path) (declare (list path)) (car (last path))) -;;; Return the (reversed) list for the path in the original source +;;; Return the (reversed) list for the PATH in the original source ;;; (with the Top Level Form number last). (defun source-path-original-source (path) (declare (list path) (inline member)) (cddr (member 'original-source-start path :test #'eq))) -;;; Return the Form Number of Path's original source inside the Top +;;; Return the Form Number of PATH's original source inside the Top ;;; Level Form that contains it. This is determined by the order that ;;; we walk the subforms of the top level source form. (defun source-path-form-number (path) @@ -298,7 +342,7 @@ (defun source-path-forms (path) (subseq path 0 (position 'original-source-start path))) -;;; Return the innermost source form for Node. +;;; Return the innermost source form for NODE. (defun node-source-form (node) (declare (type node node)) (let* ((path (node-source-path node)) @@ -314,6 +358,29 @@ (if use (values (node-source-form use) t) (values nil nil)))) + +;;; Return the LAMBDA that is CONT's home, or NIL if there is none. +(defun continuation-home-lambda-or-null (cont) + ;; KLUDGE: This function is a post-CMU-CL hack by WHN, and this + ;; implementation might not be quite right, or might be uglier than + ;; necessary. It appears that the original Python never found a need + ;; to do this operation. The obvious things based on + ;; NODE-HOME-LAMBDA of CONTINUATION-USE usually work; then if that + ;; fails, BLOCK-HOME-LAMBDA of CONTINUATION-BLOCK works, given that + ;; we generalize it enough to grovel harder when the simple CMU CL + ;; approach fails, and furthermore realize that in some exceptional + ;; cases it might return NIL. -- WHN 2001-12-04 + (cond ((continuation-use cont) + (node-home-lambda (continuation-use cont))) + ((continuation-block cont) + (block-home-lambda-or-null (continuation-block cont))) + (t + (error "internal error: confused about home lambda for ~S")))) + +;;; Return the LAMBDA that is CONT's home. +(defun continuation-home-lambda (cont) + (the clambda + (continuation-home-lambda-or-null cont))) ;;; Return a new LEXENV just like DEFAULT except for the specified ;;; slot values. Values for the alist slots are NCONCed to the @@ -341,7 +408,6 @@ ;;;; flow/DFO/component hackery ;;; Join BLOCK1 and BLOCK2. -#!-sb-fluid (declaim (inline link-blocks)) (defun link-blocks (block1 block2) (declare (type cblock block1 block2)) (setf (block-succ block1) @@ -356,10 +422,10 @@ (aver (not (member block2 succ1 :test #'eq))) (cons block2 succ1))) -;;; Like LINK-BLOCKS, but we separate BLOCK1 and BLOCK2. If this leaves a -;;; successor with a single predecessor that ends in an IF, then set -;;; BLOCK-TEST-MODIFIED so that any test constraint will now be able to be -;;; propagated to the successor. +;;; This is like LINK-BLOCKS, but we separate BLOCK1 and BLOCK2. If +;;; this leaves a successor with a single predecessor that ends in an +;;; IF, then set BLOCK-TEST-MODIFIED so that any test constraint will +;;; now be able to be propagated to the successor. (defun unlink-blocks (block1 block2) (declare (type cblock block1 block2)) (let ((succ1 (block-succ block1))) @@ -379,11 +445,11 @@ (setf (block-test-modified pred-block) t))))) (values)) -;;; Swing the succ/pred link between Block and Old to be between Block and -;;; New. If Block ends in an IF, then we have to fix up the -;;; consequent/alternative blocks to point to New. We also set -;;; BLOCK-TEST-MODIFIED so that any test constraint will be applied to the new -;;; successor. +;;; Swing the succ/pred link between BLOCK and OLD to be between BLOCK +;;; and NEW. If BLOCK ends in an IF, then we have to fix up the +;;; consequent/alternative blocks to point to NEW. We also set +;;; BLOCK-TEST-MODIFIED so that any test constraint will be applied to +;;; the new successor. (defun change-block-successor (block old new) (declare (type cblock new old block) (inline member)) (unlink-blocks block old) @@ -412,9 +478,8 @@ (values)) ;;; Unlink a block from the next/prev chain. We also null out the -;;; Component. +;;; COMPONENT. (declaim (ftype (function (cblock) (values)) remove-from-dfo)) -#!-sb-fluid (declaim (inline remove-from-dfo)) (defun remove-from-dfo (block) (let ((next (block-next block)) (prev (block-prev block))) @@ -423,9 +488,8 @@ (setf (block-prev next) prev)) (values)) -;;; Add Block to the next/prev chain following After. We also set the -;;; Component to be the same as for After. -#!-sb-fluid (declaim (inline add-to-dfo)) +;;; Add BLOCK to the next/prev chain following AFTER. We also set the +;;; Component to be the same as for AFTER. (defun add-to-dfo (block after) (declare (type cblock block after)) (let ((next (block-next after)) @@ -438,8 +502,8 @@ (setf (block-prev next) block)) (values)) -;;; Set the Flag for all the blocks in Component to NIL, except for the head -;;; and tail which are set to T. +;;; Set the FLAG for all the blocks in COMPONENT to NIL, except for +;;; the head and tail which are set to T. (declaim (ftype (function (component) (values)) clear-flags)) (defun clear-flags (component) (let ((head (component-head component)) @@ -450,7 +514,7 @@ (setf (block-flag block) nil))) (values)) -;;; Make a component with no blocks in it. The Block-Flag is initially +;;; Make a component with no blocks in it. The BLOCK-FLAG is initially ;;; true in the head and tail blocks. (declaim (ftype (function nil component) make-empty-component)) (defun make-empty-component () @@ -465,8 +529,8 @@ (setf (block-prev tail) head) res)) -;;; Makes Node the Last node in its block, splitting the block if necessary. -;;; The new block is added to the DFO immediately following Node's block. +;;; Make NODE the LAST node in its block, splitting the block if necessary. +;;; The new block is added to the DFO immediately following NODE's block. (defun node-ends-block (node) (declare (type node node)) (let* ((block (node-block node)) @@ -505,15 +569,16 @@ ;;;; deleting stuff -;;; Deal with deleting the last (read) reference to a lambda-var. We -;;; iterate over all local calls flushing the corresponding argument, allowing -;;; the computation of the argument to be deleted. We also mark the let for -;;; reoptimization, since it may be that we have deleted the last variable. +;;; Deal with deleting the last (read) reference to a LAMBDA-VAR. We +;;; iterate over all local calls flushing the corresponding argument, +;;; allowing the computation of the argument to be deleted. We also +;;; mark the let for reoptimization, since it may be that we have +;;; deleted the last variable. ;;; -;;; The lambda-var may still have some sets, but this doesn't cause too much -;;; difficulty, since we can efficiently implement write-only variables. We -;;; iterate over the sets, marking their blocks for dead code flushing, since -;;; we can delete sets whose value is unused. +;;; The LAMBDA-VAR may still have some SETs, but this doesn't cause +;;; too much difficulty, since we can efficiently implement write-only +;;; variables. We iterate over the sets, marking their blocks for dead +;;; code flushing, since we can delete sets whose value is unused. (defun delete-lambda-var (leaf) (declare (type lambda-var leaf)) (let* ((fun (lambda-var-home leaf)) @@ -535,9 +600,9 @@ (values)) -;;; Note that something interesting has happened to Var. We only deal with -;;; LET variables, marking the corresponding initial value arg as needing to be -;;; reoptimized. +;;; Note that something interesting has happened to VAR. We only deal +;;; with LET variables, marking the corresponding initial value arg as +;;; needing to be reoptimized. (defun reoptimize-lambda-var (var) (declare (type lambda-var var)) (let ((fun (lambda-var-home var))) @@ -553,37 +618,39 @@ (reoptimize-continuation (car args)))))) (values)) -;;; This function deletes functions that have no references. This need only -;;; be called on functions that never had any references, since otherwise +;;; Delete a function that has no references. This need only be called +;;; on functions that never had any references, since otherwise ;;; DELETE-REF will handle the deletion. (defun delete-functional (fun) (aver (and (null (leaf-refs fun)) - (not (functional-entry-function fun)))) + (not (functional-entry-fun fun)))) (etypecase fun (optional-dispatch (delete-optional-dispatch fun)) (clambda (delete-lambda fun))) (values)) -;;; Deal with deleting the last reference to a lambda. Since there is only -;;; one way into a lambda, deleting the last reference to a lambda ensures that -;;; there is no way to reach any of the code in it. So we just set the -;;; Functional-Kind for Fun and its Lets to :Deleted, causing IR1 optimization -;;; to delete blocks in that lambda. +;;; Deal with deleting the last reference to a LAMBDA. Since there is +;;; only one way into a LAMBDA, deleting the last reference to a +;;; LAMBDA ensures that there is no way to reach any of the code in +;;; it. So we just set the FUNCTIONAL-KIND for FUN and its LETs to +;;; :DELETED, causing IR1 optimization to delete blocks in that +;;; lambda. ;;; -;;; If the function isn't a Let, we unlink the function head and tail from -;;; the component head and tail to indicate that the code is unreachable. We -;;; also delete the function from Component-Lambdas (it won't be there before -;;; local call analysis, but no matter.) If the lambda was never referenced, -;;; we give a note. +;;; If the function isn't a LET, we unlink the function head and tail +;;; from the component head and tail to indicate that the code is +;;; unreachable. We also delete the function from COMPONENT-LAMBDAS +;;; (it won't be there before local call analysis, but no matter.) If +;;; the lambda was never referenced, we give a note. ;;; -;;; If the lambda is an XEP, then we null out the Entry-Function in its -;;; Entry-Function so that people will know that it is not an entry point +;;; If the lambda is an XEP, then we null out the ENTRY-FUN in its +;;; ENTRY-FUN so that people will know that it is not an entry point ;;; anymore. (defun delete-lambda (leaf) (declare (type clambda leaf)) (let ((kind (functional-kind leaf)) (bind (lambda-bind leaf))) - (aver (not (member kind '(:deleted :optional :top-level)))) + (aver (not (member kind '(:deleted :optional :toplevel)))) + (aver (not (functional-has-external-references-p leaf))) (setf (functional-kind leaf) :deleted) (setf (lambda-bind leaf) nil) (dolist (let (lambda-lets leaf)) @@ -600,46 +667,47 @@ (unless (leaf-ever-used leaf) (let ((*compiler-error-context* bind)) (compiler-note "deleting unused function~:[.~;~:*~% ~S~]" - (leaf-name leaf)))) + (leaf-debug-name leaf)))) (unlink-blocks (component-head component) bind-block) (when return (unlink-blocks (node-block return) (component-tail component))) (setf (component-reanalyze component) t) (let ((tails (lambda-tail-set leaf))) - (setf (tail-set-functions tails) - (delete leaf (tail-set-functions tails))) + (setf (tail-set-funs tails) + (delete leaf (tail-set-funs tails))) (setf (lambda-tail-set leaf) nil)) (setf (component-lambdas component) (delete leaf (component-lambdas component))))) (when (eq kind :external) - (let ((fun (functional-entry-function leaf))) - (setf (functional-entry-function fun) nil) + (let ((fun (functional-entry-fun leaf))) + (setf (functional-entry-fun fun) nil) (when (optional-dispatch-p fun) (delete-optional-dispatch fun))))) (values)) -;;; Deal with deleting the last reference to an Optional-Dispatch. We have -;;; to be a bit more careful than with lambdas, since Delete-Ref is used both -;;; before and after local call analysis. Afterward, all references to -;;; still-existing optional-dispatches have been moved to the XEP, leaving it -;;; with no references at all. So we look at the XEP to see whether an -;;; optional-dispatch is still really being used. But before local call -;;; analysis, there are no XEPs, and all references are direct. +;;; Deal with deleting the last reference to an OPTIONAL-DISPATCH. We +;;; have to be a bit more careful than with lambdas, since DELETE-REF +;;; is used both before and after local call analysis. Afterward, all +;;; references to still-existing OPTIONAL-DISPATCHes have been moved +;;; to the XEP, leaving it with no references at all. So we look at +;;; the XEP to see whether an optional-dispatch is still really being +;;; used. But before local call analysis, there are no XEPs, and all +;;; references are direct. ;;; -;;; When we do delete the optional-dispatch, we grovel all of its -;;; entry-points, making them be normal lambdas, and then deleting the ones -;;; with no references. This deletes any e-p lambdas that were either never -;;; referenced, or couldn't be deleted when the last deference was deleted (due -;;; to their :OPTIONAL kind.) +;;; When we do delete the OPTIONAL-DISPATCH, we grovel all of its +;;; entry-points, making them be normal lambdas, and then deleting the +;;; ones with no references. This deletes any e-p lambdas that were +;;; either never referenced, or couldn't be deleted when the last +;;; deference was deleted (due to their :OPTIONAL kind.) ;;; -;;; Note that the last optional ep may alias the main entry, so when we process -;;; the main entry, its kind may have been changed to NIL or even converted to -;;; a let. +;;; Note that the last optional ep may alias the main entry, so when +;;; we process the main entry, its kind may have been changed to NIL +;;; or even converted to a let. (defun delete-optional-dispatch (leaf) (declare (type optional-dispatch leaf)) - (let ((entry (functional-entry-function leaf))) + (let ((entry (functional-entry-fun leaf))) (unless (and entry (leaf-refs entry)) (aver (or (not entry) (eq (functional-kind entry) :deleted))) (setf (functional-kind leaf) :deleted) @@ -667,9 +735,9 @@ (values)) -;;; Do stuff to delete the semantic attachments of a Ref node. When this -;;; leaves zero or one reference, we do a type dispatch off of the leaf to -;;; determine if a special action is appropriate. +;;; Do stuff to delete the semantic attachments of a REF node. When +;;; this leaves zero or one reference, we do a type dispatch off of +;;; the leaf to determine if a special action is appropriate. (defun delete-ref (ref) (declare (type ref ref)) (let* ((leaf (ref-leaf ref)) @@ -678,11 +746,12 @@ (cond ((null refs) (typecase leaf - (lambda-var (delete-lambda-var leaf)) + (lambda-var + (delete-lambda-var leaf)) (clambda (ecase (functional-kind leaf) ((nil :let :mv-let :assignment :escape :cleanup) - (aver (not (functional-entry-function leaf))) + (aver (not (functional-entry-fun leaf))) (delete-lambda leaf)) (:external (delete-lambda leaf)) @@ -701,17 +770,17 @@ (values)) -;;; This function is called by people who delete nodes; it provides a way to -;;; indicate that the value of a continuation is no longer used. We null out -;;; the Continuation-Dest, set Flush-P in the blocks containing uses of Cont -;;; and set Component-Reoptimize. If the Prev of the use is deleted, then we -;;; blow off reoptimization. +;;; This function is called by people who delete nodes; it provides a +;;; way to indicate that the value of a continuation is no longer +;;; used. We null out the CONTINUATION-DEST, set FLUSH-P in the blocks +;;; containing uses of CONT and set COMPONENT-REOPTIMIZE. If the PREV +;;; of the use is deleted, then we blow off reoptimization. ;;; -;;; If the continuation is :Deleted, then we don't do anything, since all -;;; semantics have already been flushed. :Deleted-Block-Start start -;;; continuations are treated just like :Block-Start; it is possible that the -;;; continuation may be given a new dest (e.g. by SUBSTITUTE-CONTINUATION), so -;;; we don't want to delete it. +;;; If the continuation is :Deleted, then we don't do anything, since +;;; all semantics have already been flushed. :DELETED-BLOCK-START +;;; start continuations are treated just like :BLOCK-START; it is +;;; possible that the continuation may be given a new dest (e.g. by +;;; SUBSTITUTE-CONTINUATION), so we don't want to delete it. (defun flush-dest (cont) (declare (type continuation cont)) @@ -730,8 +799,8 @@ (values)) -;;; Do a graph walk backward from Block, marking all predecessor blocks with -;;; the DELETE-P flag. +;;; Do a graph walk backward from BLOCK, marking all predecessor +;;; blocks with the DELETE-P flag. (defun mark-for-deletion (block) (declare (type cblock block)) (unless (block-delete-p block) @@ -741,15 +810,16 @@ (mark-for-deletion pred))) (values)) -;;; Delete Cont, eliminating both control and value semantics. We set -;;; FLUSH-P and COMPONENT-REOPTIMIZE similarly to in FLUSH-DEST. Here we must -;;; get the component from the use block, since the continuation may be a -;;; :DELETED-BLOCK-START. +;;; Delete CONT, eliminating both control and value semantics. We set +;;; FLUSH-P and COMPONENT-REOPTIMIZE similarly to in FLUSH-DEST. Here +;;; we must get the component from the use block, since the +;;; continuation may be a :DELETED-BLOCK-START. ;;; -;;; If Cont has DEST, then it must be the case that the DEST is unreachable, -;;; since we can't compute the value desired. In this case, we call -;;; MARK-FOR-DELETION to cause the DEST block and its predecessors to tell -;;; people to ignore them, and to cause them to be deleted eventually. +;;; If CONT has DEST, then it must be the case that the DEST is +;;; unreachable, since we can't compute the value desired. In this +;;; case, we call MARK-FOR-DELETION to cause the DEST block and its +;;; predecessors to tell people to ignore them, and to cause them to +;;; be deleted eventually. (defun delete-continuation (cont) (declare (type continuation cont)) (aver (not (eq (continuation-kind cont) :deleted))) @@ -814,10 +884,10 @@ (ref (delete-ref node)) (cif (flush-dest (if-test node))) - ;; The next two cases serve to maintain the invariant that a LET always - ;; has a well-formed COMBINATION, REF and BIND. We delete the lambda - ;; whenever we delete any of these, but we must be careful that this LET - ;; has not already been partially deleted. + ;; The next two cases serve to maintain the invariant that a LET + ;; always has a well-formed COMBINATION, REF and BIND. We delete + ;; the lambda whenever we delete any of these, but we must be + ;; careful that this LET has not already been partially deleted. (basic-combination (when (and (eq (basic-combination-kind node) :local) ;; Guards COMBINATION-LAMBDA agains the REF being deleted. @@ -858,8 +928,8 @@ (remove-from-dfo block) (values)) -;;; Do stuff to indicate that the return node Node is being deleted. We set -;;; the RETURN to NIL. +;;; Do stuff to indicate that the return node Node is being deleted. +;;; We set the RETURN to NIL. (defun delete-return (node) (declare (type creturn node)) (let ((fun (return-lambda node))) @@ -867,8 +937,8 @@ (setf (lambda-return fun) nil)) (values)) -;;; If any of the Vars in fun were never referenced and was not declared -;;; IGNORE, then complain. +;;; If any of the VARS in FUN was never referenced and was not +;;; declared IGNORE, then complain. (defun note-unreferenced-vars (fun) (declare (type clambda fun)) (dolist (var (lambda-vars fun)) @@ -877,18 +947,19 @@ (let ((*compiler-error-context* (lambda-bind fun))) (unless (policy *compiler-error-context* (= inhibit-warnings 3)) ;; ANSI section "3.2.5 Exceptional Situations in the Compiler" - ;; requires this to be a STYLE-WARNING. + ;; requires this to be no more than a STYLE-WARNING. (compiler-style-warning "The variable ~S is defined but never used." - (leaf-name var))) - (setf (leaf-ever-used var) t)))) + (leaf-debug-name var))) + (setf (leaf-ever-used var) t)))) ; to avoid repeated warnings? -- WHN (values)) (defvar *deletion-ignored-objects* '(t nil)) -;;; Return true if we can find Obj in Form, NIL otherwise. We bound our -;;; recursion so that we don't get lost in circular structures. We ignore the -;;; car of forms if they are a symbol (to prevent confusing function -;;; referencess with variables), and we also ignore anything inside ' or #'. +;;; Return true if we can find OBJ in FORM, NIL otherwise. We bound +;;; our recursion so that we don't get lost in circular structures. We +;;; ignore the car of forms if they are a symbol (to prevent confusing +;;; function referencess with variables), and we also ignore anything +;;; inside ' or #'. (defun present-in-form (obj form depth) (declare (type (integer 0 20) depth)) (cond ((= depth 20) nil) @@ -909,22 +980,24 @@ (when (present-in-form obj (car l) depth) (return t))))))))) -;;; This function is called on a block immediately before we delete it. We -;;; check to see whether any of the code about to die appeared in the original -;;; source, and emit a note if so. +;;; This function is called on a block immediately before we delete +;;; it. We check to see whether any of the code about to die appeared +;;; in the original source, and emit a note if so. ;;; -;;; If the block was in a lambda is now deleted, then we ignore the whole -;;; block, since this case is picked off in DELETE-LAMBDA. We also ignore -;;; the deletion of CRETURN nodes, since it is somewhat reasonable for a -;;; function to not return, and there is a different note for that case anyway. +;;; If the block was in a lambda is now deleted, then we ignore the +;;; whole block, since this case is picked off in DELETE-LAMBDA. We +;;; also ignore the deletion of CRETURN nodes, since it is somewhat +;;; reasonable for a function to not return, and there is a different +;;; note for that case anyway. ;;; -;;; If the actual source is an atom, then we use a bunch of heuristics to -;;; guess whether this reference really appeared in the original source: +;;; If the actual source is an atom, then we use a bunch of heuristics +;;; to guess whether this reference really appeared in the original +;;; source: ;;; -- If a symbol, it must be interned and not a keyword. -;;; -- It must not be an easily introduced constant (T or NIL, a fixnum or a -;;; character.) -;;; -- The atom must be "present" in the original source form, and present in -;;; all intervening actual source forms. +;;; -- It must not be an easily introduced constant (T or NIL, a fixnum +;;; or a character.) +;;; -- The atom must be "present" in the original source form, and +;;; present in all intervening actual source forms. (defun note-block-deletion (block) (let ((home (block-home-lambda block))) (unless (eq (functional-kind home) :deleted) @@ -950,19 +1023,21 @@ (return)))))) (values)) -;;; Delete a node from a block, deleting the block if there are no nodes -;;; left. We remove the node from the uses of its CONT, but we don't deal with -;;; cleaning up any type-specific semantic attachments. If the CONT is :UNUSED -;;; after deleting this use, then we delete CONT. (Note :UNUSED is not the -;;; same as no uses. A continuation will only become :UNUSED if it was -;;; :INSIDE-BLOCK before.) +;;; Delete a node from a block, deleting the block if there are no +;;; nodes left. We remove the node from the uses of its CONT, but we +;;; don't deal with cleaning up any type-specific semantic +;;; attachments. If the CONT is :UNUSED after deleting this use, then +;;; we delete CONT. (Note :UNUSED is not the same as no uses. A +;;; continuation will only become :UNUSED if it was :INSIDE-BLOCK +;;; before.) ;;; -;;; If the node is the last node, there must be exactly one successor. We -;;; link all of our precedessors to the successor and unlink the block. In -;;; this case, we return T, otherwise NIL. If no nodes are left, and the block -;;; is a successor of itself, then we replace the only node with a degenerate -;;; exit node. This provides a way to represent the bodyless infinite loop, -;;; given the prohibition on empty blocks in IR1. +;;; If the node is the last node, there must be exactly one successor. +;;; We link all of our precedessors to the successor and unlink the +;;; block. In this case, we return T, otherwise NIL. If no nodes are +;;; left, and the block is a successor of itself, then we replace the +;;; only node with a degenerate exit node. This provides a way to +;;; represent the bodyless infinite loop, given the prohibition on +;;; empty blocks in IR1. (defun unlink-node (node) (declare (type node node)) (let* ((cont (node-cont node)) @@ -1000,11 +1075,11 @@ (aver (and succ (null (cdr succ)))) (cond ((member block succ) - (with-ir1-environment node + (with-ir1-environment-from-node node (let ((exit (make-exit)) (dummy (make-continuation))) (setf (continuation-next prev) nil) - (prev-link exit prev) + (link-node-to-previous-continuation exit prev) (add-continuation-use exit dummy) (setf (block-last block) exit))) (setf (node-prev node) nil) @@ -1024,8 +1099,8 @@ (setf (node-prev node) nil) t))))))) -;;; Return true if NODE has been deleted, false if it is still a valid part -;;; of IR1. +;;; Return true if NODE has been deleted, false if it is still a valid +;;; part of IR1. (defun node-deleted (node) (declare (type node node)) (let ((prev (node-prev node))) @@ -1035,18 +1110,18 @@ (and (block-component block) (not (block-delete-p block)))))))) -;;; Delete all the blocks and functions in Component. We scan first marking -;;; the blocks as delete-p to prevent weird stuff from being triggered by -;;; deletion. +;;; Delete all the blocks and functions in COMPONENT. We scan first +;;; marking the blocks as DELETE-P to prevent weird stuff from being +;;; triggered by deletion. (defun delete-component (component) (declare (type component component)) - (aver (null (component-new-functions component))) + (aver (null (component-new-funs component))) (setf (component-kind component) :deleted) (do-blocks (block component) (setf (block-delete-p block) t)) (dolist (fun (component-lambdas component)) (setf (functional-kind fun) nil) - (setf (functional-entry-function fun) nil) + (setf (functional-entry-fun fun) nil) (setf (leaf-refs fun) nil) (delete-functional fun)) (do-blocks (block component) @@ -1077,7 +1152,7 @@ (unless (combination-p inside) (give-up-ir1-transform)) (let ((inside-fun (combination-fun inside))) - (unless (eq (continuation-function-name inside-fun) fun) + (unless (eq (continuation-fun-name inside-fun) fun) (give-up-ir1-transform)) (let ((inside-args (combination-args inside))) (unless (= (length inside-args) num-args) @@ -1101,7 +1176,7 @@ ;;;; leaf hackery -;;; Change the Leaf that a Ref refers to. +;;; Change the LEAF that a REF refers to. (defun change-ref-leaf (ref leaf) (declare (type ref ref) (type leaf leaf)) (unless (eq (ref-leaf ref) leaf) @@ -1109,20 +1184,20 @@ (delete-ref ref) (setf (ref-leaf ref) leaf) (let ((ltype (leaf-type leaf))) - (if (function-type-p ltype) + (if (fun-type-p ltype) (setf (node-derived-type ref) ltype) (derive-node-type ref ltype))) (reoptimize-continuation (node-cont ref))) (values)) -;;; Change all Refs for Old-Leaf to New-Leaf. +;;; Change all REFS for OLD-LEAF to NEW-LEAF. (defun substitute-leaf (new-leaf old-leaf) (declare (type leaf new-leaf old-leaf)) (dolist (ref (leaf-refs old-leaf)) (change-ref-leaf ref new-leaf)) (values)) -;;; Like SUBSITIUTE-LEAF, only there is a predicate on the Ref to tell +;;; Like SUBSITUTE-LEAF, only there is a predicate on the REF to tell ;;; whether to substitute. (defun substitute-leaf-if (test new-leaf old-leaf) (declare (type leaf new-leaf old-leaf) (type function test)) @@ -1131,37 +1206,37 @@ (change-ref-leaf ref new-leaf))) (values)) -;;; Return a LEAF which represents the specified constant object. If the -;;; object is not in *CONSTANTS*, then we create a new constant LEAF and -;;; enter it. -#!-sb-fluid (declaim (maybe-inline find-constant)) +;;; Return a LEAF which represents the specified constant object. If +;;; the object is not in *CONSTANTS*, then we create a new constant +;;; LEAF and enter it. (defun find-constant (object) - (if (typep object '(or symbol number character instance)) - (or (gethash object *constants*) - (setf (gethash object *constants*) - (make-constant :value object - :name nil - :type (ctype-of object) - :where-from :defined))) - (make-constant :value object - :name nil - :type (ctype-of object) - :where-from :defined))) + (if (typep object + ;; FIXME: What is the significance of this test? ("things + ;; that are worth uniquifying"?) + '(or symbol number character instance)) + (or (gethash object *constants*) + (setf (gethash object *constants*) + (make-constant :value object + :%source-name '.anonymous. + :type (ctype-of object) + :where-from :defined))) + (make-constant :value object + :%source-name '.anonymous. + :type (ctype-of object) + :where-from :defined))) -;;; If there is a non-local exit noted in Entry's environment that exits to -;;; Cont in that entry, then return it, otherwise return NIL. +;;; If there is a non-local exit noted in ENTRY's environment that +;;; exits to CONT in that entry, then return it, otherwise return NIL. (defun find-nlx-info (entry cont) (declare (type entry entry) (type continuation cont)) (let ((entry-cleanup (entry-cleanup entry))) - (dolist (nlx (environment-nlx-info (node-environment entry)) nil) + (dolist (nlx (physenv-nlx-info (node-physenv entry)) nil) (when (and (eq (nlx-info-continuation nlx) cont) (eq (nlx-info-cleanup nlx) entry-cleanup)) (return nlx))))) ;;;; functional hackery -;;; If Functional is a Lambda, just return it; if it is an -;;; optional-dispatch, return the main-entry. (declaim (ftype (function (functional) clambda) main-entry)) (defun main-entry (functional) (etypecase functional @@ -1169,10 +1244,10 @@ (optional-dispatch (optional-dispatch-main-entry functional)))) -;;; Returns true if Functional is a thing that can be treated like -;;; MV-Bind when it appears in an MV-Call. All fixed arguments must be -;;; optional with null default and no supplied-p. There must be a rest -;;; arg with no references. +;;; RETURN true if FUNCTIONAL is a thing that can be treated like +;;; MV-BIND when it appears in an MV-CALL. All fixed arguments must be +;;; optional with null default and no SUPPLIED-P. There must be a +;;; &REST arg with no references. (declaim (ftype (function (functional) boolean) looks-like-an-mv-bind)) (defun looks-like-an-mv-bind (functional) (and (optional-dispatch-p functional) @@ -1189,45 +1264,45 @@ (t (return nil))))))) -;;; Return true if function is an XEP. This is true of normal XEPs -;;; (:External kind) and top-level lambdas (:Top-Level kind.) -#!-sb-fluid (declaim (inline external-entry-point-p)) -(defun external-entry-point-p (fun) +;;; Return true if function is an external entry point. This is true +;;; of normal XEPs (:EXTERNAL kind) and also of top level lambdas +;;; (:TOPLEVEL kind.) +(defun xep-p (fun) (declare (type functional fun)) - (not (null (member (functional-kind fun) '(:external :top-level))))) + (not (null (member (functional-kind fun) '(:external :toplevel))))) -;;; If Cont's only use is a non-notinline global function reference, then -;;; return the referenced symbol, otherwise NIL. If Notinline-OK is true, then -;;; we don't care if the leaf is notinline. -(defun continuation-function-name (cont &optional notinline-ok) +;;; If CONT's only use is a non-notinline global function reference, +;;; then return the referenced symbol, otherwise NIL. If NOTINLINE-OK +;;; is true, then we don't care if the leaf is NOTINLINE. +(defun continuation-fun-name (cont &optional notinline-ok) (declare (type continuation cont)) (let ((use (continuation-use cont))) (if (ref-p use) (let ((leaf (ref-leaf use))) (if (and (global-var-p leaf) (eq (global-var-kind leaf) :global-function) - (or (not (defined-function-p leaf)) - (not (eq (defined-function-inlinep leaf) :notinline)) + (or (not (defined-fun-p leaf)) + (not (eq (defined-fun-inlinep leaf) :notinline)) notinline-ok)) - (leaf-name leaf) + (leaf-source-name leaf) nil)) nil))) -;;; Return the COMBINATION node that is the call to the let Fun. +;;; Return the COMBINATION node that is the call to the LET FUN. (defun let-combination (fun) (declare (type clambda fun)) (aver (member (functional-kind fun) '(:let :mv-let))) (continuation-dest (node-cont (first (leaf-refs fun))))) -;;; Return the initial value continuation for a let variable or NIL if none. +;;; Return the initial value continuation for a LET variable, or NIL +;;; if there is none. (defun let-var-initial-value (var) (declare (type lambda-var var)) (let ((fun (lambda-var-home var))) (elt (combination-args (let-combination fun)) (position-or-lose var (lambda-vars fun))))) -;;; Return the LAMBDA that is called by the local Call. -#!-sb-fluid (declaim (inline combination-lambda)) +;;; Return the LAMBDA that is called by the local CALL. (defun combination-lambda (call) (declare (type basic-combination call)) (aver (eq (basic-combination-kind call) :local)) @@ -1235,10 +1310,10 @@ (defvar *inline-expansion-limit* 200 #!+sb-doc - "An upper limit on the number of inline function calls that will be expanded - in any given code object (single function or block compilation.)") + "an upper limit on the number of inline function calls that will be expanded + in any given code object (single function or block compilation)") -;;; Check whether Node's component has exceeded its inline expansion +;;; Check whether NODE's component has exceeded its inline expansion ;;; limit, and warn if so, returning NIL. (defun inline-expansion-ok (node) (let ((expanded (incf (component-inline-expansions @@ -1246,516 +1321,25 @@ (node-block node)))))) (cond ((> expanded *inline-expansion-limit*) nil) ((= expanded *inline-expansion-limit*) + ;; FIXME: If the objective is to stop the recursive + ;; expansion of inline functions, wouldn't it be more + ;; correct to look back through surrounding expansions + ;; (which are, I think, stored in the *CURRENT-PATH*, and + ;; possibly stored elsewhere too) and suppress expansion + ;; and print this warning when the function being proposed + ;; for inline expansion is found there? (I don't like the + ;; arbitrary numerical limit in principle, and I think + ;; it'll be a nuisance in practice if we ever want the + ;; compiler to be able to use WITH-COMPILATION-UNIT on + ;; arbitrarily huge blocks of code. -- WHN) (let ((*compiler-error-context* node)) - (compiler-note "*INLINE-EXPANSION-LIMIT* (~D) was exceeded, ~ + (compiler-note "*INLINE-EXPANSION-LIMIT* (~W) was exceeded, ~ probably trying to~% ~ inline a recursive function." *inline-expansion-limit*)) nil) (t t)))) -;;;; compiler error context determination - -(declaim (special *current-path*)) - -;;; We bind print level and length when printing out messages so that -;;; we don't dump huge amounts of garbage. -;;; -;;; FIXME: It's not possible to get the defaults right for everyone. -;;; So: Should these variables be in the SB-EXT package? Or should we -;;; just get rid of them completely and just use the bare -;;; CL:*PRINT-FOO* variables instead? -(declaim (type (or unsigned-byte null) - *compiler-error-print-level* - *compiler-error-print-length* - *compiler-error-print-lines*)) -(defvar *compiler-error-print-level* 5 - #!+sb-doc - "the value for *PRINT-LEVEL* when printing compiler error messages") -(defvar *compiler-error-print-length* 10 - #!+sb-doc - "the value for *PRINT-LENGTH* when printing compiler error messages") -(defvar *compiler-error-print-lines* 12 - #!+sb-doc - "the value for *PRINT-LINES* when printing compiler error messages") - -(defvar *enclosing-source-cutoff* 1 - #!+sb-doc - "The maximum number of enclosing non-original source forms (i.e. from - macroexpansion) that we print in full. For additional enclosing forms, we - print only the CAR.") -(declaim (type unsigned-byte *enclosing-source-cutoff*)) - -;;; We separate the determination of compiler error contexts from the actual -;;; signalling of those errors by objectifying the error context. This allows -;;; postponement of the determination of how (and if) to signal the error. -;;; -;;; We take care not to reference any of the IR1 so that pending potential -;;; error messages won't prevent the IR1 from being GC'd. To this end, we -;;; convert source forms to strings so that source forms that contain IR1 -;;; references (e.g. %DEFUN) don't hold onto the IR. -(defstruct (compiler-error-context - #-no-ansi-print-object - (:print-object (lambda (x stream) - (print-unreadable-object (x stream :type t)))) - (:copier nil)) - ;; A list of the stringified CARs of the enclosing non-original source forms - ;; exceeding the *enclosing-source-cutoff*. - (enclosing-source nil :type list) - ;; A list of stringified enclosing non-original source forms. - (source nil :type list) - ;; The stringified form in the original source that expanded into Source. - (original-source (required-argument) :type simple-string) - ;; A list of prefixes of "interesting" forms that enclose original-source. - (context nil :type list) - ;; The FILE-INFO-NAME for the relevant FILE-INFO. - (file-name (required-argument) - :type (or pathname (member :lisp :stream))) - ;; The file position at which the top-level form starts, if applicable. - (file-position nil :type (or index null)) - ;; The original source part of the source path. - (original-source-path nil :type list)) - -;;; If true, this is the node which is used as context in compiler warning -;;; messages. -(declaim (type (or null compiler-error-context node) *compiler-error-context*)) -(defvar *compiler-error-context* nil) - -;;; a hashtable mapping macro names to source context parsers. Each parser -;;; function returns the source-context list for that form. -(defvar *source-context-methods* (make-hash-table)) - -;;; documentation originally from cmu-user.tex: -;;; This macro defines how to extract an abbreviated source context from -;;; the \var{name}d form when it appears in the compiler input. -;;; \var{lambda-list} is a \code{defmacro} style lambda-list used to -;;; parse the arguments. The \var{body} should return a list of -;;; subforms that can be printed on about one line. There are -;;; predefined methods for \code{defstruct}, \code{defmethod}, etc. If -;;; no method is defined, then the first two subforms are returned. -;;; Note that this facility implicitly determines the string name -;;; associated with anonymous functions. -;;; So even though SBCL itself only uses this macro within this file, it's a -;;; reasonable thing to put in SB-EXT in case some dedicated user wants to do -;;; some heavy tweaking to make SBCL give more informative output about his -;;; code. -(defmacro def-source-context (name lambda-list &body body) - #!+sb-doc - "DEF-SOURCE-CONTEXT Name Lambda-List Form* - This macro defines how to extract an abbreviated source context from the - Named form when it appears in the compiler input. Lambda-List is a DEFMACRO - style lambda-list used to parse the arguments. The Body should return a - list of subforms suitable for a \"~{~S ~}\" format string." - (let ((n-whole (gensym))) - `(setf (gethash ',name *source-context-methods*) - #'(lambda (,n-whole) - (destructuring-bind ,lambda-list ,n-whole ,@body))))) - -(def-source-context defstruct (name-or-options &rest slots) - (declare (ignore slots)) - `(defstruct ,(if (consp name-or-options) - (car name-or-options) - name-or-options))) - -(def-source-context function (thing) - (if (and (consp thing) (eq (first thing) 'lambda) (consp (rest thing))) - `(lambda ,(second thing)) - `(function ,thing))) - -;;; Return the first two elements of FORM if FORM is a list. Take the -;;; CAR of the second form if appropriate. -(defun source-form-context (form) - (cond ((atom form) nil) - ((>= (length form) 2) - (funcall (gethash (first form) *source-context-methods* - #'(lambda (x) - (declare (ignore x)) - (list (first form) (second form)))) - (rest form))) - (t - form))) - -;;; Given a source path, return the original source form and a description -;;; of the interesting aspects of the context in which it appeared. The -;;; context is a list of lists, one sublist per context form. The sublist is a -;;; list of some of the initial subforms of the context form. -;;; -;;; For now, we use the first two subforms of each interesting form. A form is -;;; interesting if the first element is a symbol beginning with "DEF" and it is -;;; not the source form. If there is no DEF-mumble, then we use the outermost -;;; containing form. If the second subform is a list, then in some cases we -;;; return the car of that form rather than the whole form (i.e. don't show -;;; defstruct options, etc.) -(defun find-original-source (path) - (declare (list path)) - (let* ((rpath (reverse (source-path-original-source path))) - (tlf (first rpath)) - (root (find-source-root tlf *source-info*))) - (collect ((context)) - (let ((form root) - (current (rest rpath))) - (loop - (when (atom form) - (aver (null current)) - (return)) - (let ((head (first form))) - (when (symbolp head) - (let ((name (symbol-name head))) - (when (and (>= (length name) 3) (string= name "DEF" :end1 3)) - (context (source-form-context form)))))) - (when (null current) (return)) - (setq form (nth (pop current) form))) - - (cond ((context) - (values form (context))) - ((and path root) - (let ((c (source-form-context root))) - (values form (if c (list c) nil)))) - (t - (values '(unable to locate source) - '((some strange place))))))))) - -;;; Convert a source form to a string, suitably formatted for use in -;;; compiler warnings. -(defun stringify-form (form &optional (pretty t)) - (let ((*print-level* *compiler-error-print-level*) - (*print-length* *compiler-error-print-length*) - (*print-lines* *compiler-error-print-lines*) - (*print-pretty* pretty)) - (if pretty - (format nil "~<~@; ~S~:>" (list form)) - (prin1-to-string form)))) - -;;; Return a COMPILER-ERROR-CONTEXT structure describing the current -;;; error context, or NIL if we can't figure anything out. ARGS is a -;;; list of things that are going to be printed out in the error -;;; message, and can thus be blown off when they appear in the source -;;; context. -(defun find-error-context (args) - (let ((context *compiler-error-context*)) - (if (compiler-error-context-p context) - context - (let ((path (or *current-path* - (if context - (node-source-path context) - nil)))) - (when (and *source-info* path) - (multiple-value-bind (form src-context) (find-original-source path) - (collect ((full nil cons) - (short nil cons)) - (let ((forms (source-path-forms path)) - (n 0)) - (dolist (src (if (member (first forms) args) - (rest forms) - forms)) - (if (>= n *enclosing-source-cutoff*) - (short (stringify-form (if (consp src) - (car src) - src) - nil)) - (full (stringify-form src))) - (incf n))) - - (let* ((tlf (source-path-tlf-number path)) - (file (find-file-info tlf *source-info*))) - (make-compiler-error-context - :enclosing-source (short) - :source (full) - :original-source (stringify-form form) - :context src-context - :file-name (file-info-name file) - :file-position - (multiple-value-bind (ignore pos) - (find-source-root tlf *source-info*) - (declare (ignore ignore)) - pos) - :original-source-path - (source-path-original-source path)))))))))) - -;;;; printing error messages - -;;; We save the context information that we printed out most recently -;;; so that we don't print it out redundantly. - -;;; The last COMPILER-ERROR-CONTEXT that we printed. -(defvar *last-error-context* nil) -(declaim (type (or compiler-error-context null) *last-error-context*)) - -;;; The format string and args for the last error we printed. -(defvar *last-format-string* nil) -(defvar *last-format-args* nil) -(declaim (type (or string null) *last-format-string*)) -(declaim (type list *last-format-args*)) - -;;; The number of times that the last error message has been emitted, -;;; so that we can compress duplicate error messages. -(defvar *last-message-count* 0) -(declaim (type index *last-message-count*)) - -;;; If the last message was given more than once, then print out an -;;; indication of how many times it was repeated. We reset the message count -;;; when we are done. -(defun note-message-repeats (&optional (terpri t)) - (cond ((= *last-message-count* 1) - (when terpri (terpri *error-output*))) - ((> *last-message-count* 1) - (format *error-output* "~&; [Last message occurs ~D times.]~2%" - *last-message-count*))) - (setq *last-message-count* 0)) - -;;; Print out the message, with appropriate context if we can find it. -;;; If the context is different from the context of the last message -;;; we printed, then we print the context. If the original source is -;;; different from the source we are working on, then we print the -;;; current source in addition to the original source. -;;; -;;; We suppress printing of messages identical to the previous, but -;;; record the number of times that the message is repeated. -(defun print-compiler-message (format-string format-args) - - (declare (type simple-string format-string)) - (declare (type list format-args)) - - (let ((stream *error-output*) - (context (find-error-context format-args))) - (cond - (context - (let ((file (compiler-error-context-file-name context)) - (in (compiler-error-context-context context)) - (form (compiler-error-context-original-source context)) - (enclosing (compiler-error-context-enclosing-source context)) - (source (compiler-error-context-source context)) - (last *last-error-context*)) - - (unless (and last - (equal file (compiler-error-context-file-name last))) - (when (pathnamep file) - (note-message-repeats) - (setq last nil) - (format stream "~2&; file: ~A~%" (namestring file)))) - - (unless (and last - (equal in (compiler-error-context-context last))) - (note-message-repeats) - (setq last nil) - (format stream "~&") - (pprint-logical-block (stream nil :per-line-prefix "; ") - (format stream "in:~{~<~% ~4:;~{ ~S~}~>~^ =>~}" in)) - (format stream "~%")) - - - (unless (and last - (string= form - (compiler-error-context-original-source last))) - (note-message-repeats) - (setq last nil) - (format stream "~&") - (pprint-logical-block (stream nil :per-line-prefix "; ") - (format stream " ~A" form)) - (format stream "~&")) - - (unless (and last - (equal enclosing - (compiler-error-context-enclosing-source last))) - (when enclosing - (note-message-repeats) - (setq last nil) - (format stream "~&; --> ~{~<~%; --> ~1:;~A~> ~}~%" enclosing))) - - (unless (and last - (equal source (compiler-error-context-source last))) - (setq *last-format-string* nil) - (when source - (note-message-repeats) - (dolist (src source) - (format stream "~&") - (write-string "; ==>" stream) - (format stream "~&") - (pprint-logical-block (stream nil :per-line-prefix "; ") - (write-string src stream))))))) - (t - (format stream "~&") - (note-message-repeats) - (setq *last-format-string* nil) - (format stream "~&"))) - - (setq *last-error-context* context) - - (unless (and (equal format-string *last-format-string*) - (tree-equal format-args *last-format-args*)) - (note-message-repeats nil) - (setq *last-format-string* format-string) - (setq *last-format-args* format-args) - (let ((*print-level* *compiler-error-print-level*) - (*print-length* *compiler-error-print-length*) - (*print-lines* *compiler-error-print-lines*)) - (format stream "~&") - (pprint-logical-block (stream nil :per-line-prefix "; ") - (format stream "~&~?" format-string format-args)) - (format stream "~&")))) - - (incf *last-message-count*) - (values)) - -(defun print-compiler-condition (condition) - (declare (type condition condition)) - (let (;; These different classes of conditions have different - ;; effects on the return codes of COMPILE-FILE, so it's nice - ;; for users to be able to pick them out by lexical search - ;; through the output. - (what (etypecase condition - (style-warning 'style-warning) - (warning 'warning) - (error 'error)))) - (multiple-value-bind (format-string format-args) - (if (typep condition 'simple-condition) - (values (simple-condition-format-control condition) - (simple-condition-format-arguments condition)) - (values "~A" - (list (with-output-to-string (s) - (princ condition s))))) - (print-compiler-message (format nil - "caught ~S:~% ~A" - what - format-string) - format-args))) - (values)) - -;;; COMPILER-NOTE is vaguely like COMPILER-ERROR and the other -;;; condition-signalling functions, but it just writes some output instead of -;;; signalling. (In CMU CL, it did signal a condition, but this didn't seem to -;;; work all that well; it was weird to have COMPILE-FILE return with -;;; WARNINGS-P set when the only problem was that the compiler couldn't figure -;;; out how to compile something as efficiently as it liked.) -(defun compiler-note (format-string &rest format-args) - (unless (if *compiler-error-context* - (policy *compiler-error-context* (= inhibit-warnings 3)) - (policy nil (= inhibit-warnings 3))) - (incf *compiler-note-count*) - (print-compiler-message (format nil "note: ~A" format-string) - format-args)) - (values)) - -;;; Issue a note when we might or might not be in the compiler. -(defun maybe-compiler-note (&rest rest) - (if (boundp '*lexenv*) ; if we're in the compiler - (apply #'compiler-note rest) - (let ((stream *error-output*)) - (pprint-logical-block (stream nil :per-line-prefix ";") - - (format stream " note: ~3I~_") - (pprint-logical-block (stream nil) - (apply #'format stream rest))) - (fresh-line stream)))) ; (outside logical block, no per-line-prefix) - -;;; The politically correct way to print out progress messages and -;;; such like. We clear the current error context so that we know that -;;; it needs to be reprinted, and we also Force-Output so that the -;;; message gets seen right away. -(declaim (ftype (function (string &rest t) (values)) compiler-mumble)) -(defun compiler-mumble (format-string &rest format-args) - (note-message-repeats) - (setq *last-error-context* nil) - (apply #'format *error-output* format-string format-args) - (force-output *error-output*) - (values)) - -;;; Return a string that somehow names the code in COMPONENT. We use -;;; the source path for the bind node for an arbitrary entry point to -;;; find the source context, then return that as a string. -(declaim (ftype (function (component) simple-string) find-component-name)) -(defun find-component-name (component) - (let ((ep (first (block-succ (component-head component))))) - (aver ep) ; else no entry points?? - (multiple-value-bind (form context) - (find-original-source - (node-source-path (continuation-next (block-start ep)))) - (declare (ignore form)) - (let ((*print-level* 2) - (*print-pretty* nil)) - (format nil "~{~{~S~^ ~}~^ => ~}" context))))) - -;;;; condition system interface - -;;; Keep track of how many times each kind of condition happens. -(defvar *compiler-error-count*) -(defvar *compiler-warning-count*) -(defvar *compiler-style-warning-count*) -(defvar *compiler-note-count*) - -;;; Keep track of whether any surrounding COMPILE or COMPILE-FILE call -;;; should return WARNINGS-P or FAILURE-P. -(defvar *failure-p*) -(defvar *warnings-p*) - -;;; condition handlers established by the compiler. We re-signal the -;;; condition, then if it isn't handled, we increment our warning -;;; counter and print the error message. -(defun compiler-error-handler (condition) - (signal condition) - (incf *compiler-error-count*) - (setf *warnings-p* t - *failure-p* t) - (print-compiler-condition condition) - (continue condition)) -(defun compiler-warning-handler (condition) - (signal condition) - (incf *compiler-warning-count*) - (setf *warnings-p* t - *failure-p* t) - (print-compiler-condition condition) - (muffle-warning condition)) -(defun compiler-style-warning-handler (condition) - (signal condition) - (incf *compiler-style-warning-count*) - (setf *warnings-p* t) - (print-compiler-condition condition) - (muffle-warning condition)) - -;;;; undefined warnings - -(defvar *undefined-warning-limit* 3 - #!+sb-doc - "If non-null, then an upper limit on the number of unknown function or type - warnings that the compiler will print for any given name in a single - compilation. This prevents excessive amounts of output when the real - problem is a missing definition (as opposed to a typo in the use.)") - -;;; Make an entry in the *UNDEFINED-WARNINGS* describing a reference -;;; to NAME of the specified KIND. If we have exceeded the warning -;;; limit, then just increment the count, otherwise note the current -;;; error context. -;;; -;;; Undefined types are noted by a condition handler in -;;; WITH-COMPILATION-UNIT, which can potentially be invoked outside -;;; the compiler, hence the BOUNDP check. -(defun note-undefined-reference (name kind) - (unless (and - ;; (POLICY NIL ..) isn't well-defined except in IR1 - ;; conversion. This BOUNDP test seems to be a test for - ;; whether IR1 conversion is going on. - (boundp '*lexenv*) - ;; FIXME: I'm pretty sure the INHIBIT-WARNINGS test below - ;; isn't a good idea; we should have INHIBIT-WARNINGS - ;; affect compiler notes, not STYLE-WARNINGs. And I'm not - ;; sure what the BOUNDP '*LEXENV* test above is for; it's - ;; likely a good idea, but it probably deserves an - ;; explanatory comment. - (policy nil (= inhibit-warnings 3))) - (let* ((found (dolist (warning *undefined-warnings* nil) - (when (and (equal (undefined-warning-name warning) name) - (eq (undefined-warning-kind warning) kind)) - (return warning)))) - (res (or found - (make-undefined-warning :name name :kind kind)))) - (unless found (push res *undefined-warnings*)) - (when (or (not *undefined-warning-limit*) - (< (undefined-warning-count res) *undefined-warning-limit*)) - (push (find-error-context (list name)) - (undefined-warning-warnings res))) - (incf (undefined-warning-count res)))) - (values)) - ;;;; careful call ;;; Apply a function to some arguments, returning a list of the values @@ -1822,9 +1406,8 @@ (defun %event (info node) (incf (event-info-count info)) (when (and (>= (event-info-level info) *event-note-threshold*) - (if node - (policy node (= inhibit-warnings 0)) - (policy nil (= inhibit-warnings 0)))) + (policy (or node *lexenv*) + (= inhibit-warnings 0))) (let ((*compiler-error-context* node)) (compiler-note (event-info-description info))))