0.pre7.88:
[sbcl.git] / src / compiler / node.lisp
index 41d2953..e2635d2 100644 (file)
@@ -84,7 +84,7 @@
   ;; cached type of this continuation's value. If NIL, then this must
   ;; be recomputed: see CONTINUATION-DERIVED-TYPE.
   (%derived-type nil :type (or ctype null))
-  ;; Node where this continuation is used, if unique. This is always
+  ;; the node where this continuation is used, if unique. This is always
   ;; null in :DELETED and :UNUSED continuations, and is never null in
   ;; :INSIDE-BLOCK continuations. In a :BLOCK-START continuation, the
   ;; Block's START-USES indicate whether NIL means no uses or more
   ;; is indicated by the magic ORIGINAL-SOURCE-START marker. The first
   ;; element of the original source is the "form number", which is the
   ;; ordinal number of this form in a depth-first, left-to-right walk
-  ;; of the truly top-level form in which this appears.
+  ;; of the truly-top-level form in which this appears.
   ;;
   ;; Following is a list of integers describing the path taken through
   ;; the source to get to this point:
   ;;     (K L M ...) => (NTH K (NTH L (NTH M ...)))
   ;;
-  ;; The last element in the list is the top-level form number, which
+  ;; The last element in the list is the top level form number, which
   ;; is the ordinal number (in this call to the compiler) of the truly
-  ;; top-level form containing the original source.
+  ;; top level form containing the original source.
   (source-path *current-path* :type list)
   ;; If this node is in a tail-recursive position, then this is set to
-  ;; T. At the end of IR1 (in environment analysis) this is computed
-  ;; for all nodes (after cleanup code has been emitted). Before then,
-  ;; a non-null value indicates that IR1 optimization has converted a
-  ;; tail local call to a direct transfer.
+  ;; T. At the end of IR1 (in physical environment analysis) this is
+  ;; computed for all nodes (after cleanup code has been emitted).
+  ;; Before then, a non-null value indicates that IR1 optimization has
+  ;; converted a tail local call to a direct transfer.
   ;;
   ;; If the back-end breaks tail-recursion for some reason, then it
   ;; can null out this slot.
   (test-constraint nil :type (or sset null)))
 (def!method print-object ((cblock cblock) stream)
   (print-unreadable-object (cblock stream :type t :identity t)
-    (format stream ":START c~D" (cont-num (block-start cblock)))))
+    (format stream ":START c~W" (cont-num (block-start cblock)))))
 
 ;;; The BLOCK-ANNOTATION class is inherited (via :INCLUDE) by
 ;;; different BLOCK-INFO annotation structures so that code
 (defstruct (block-annotation (:constructor nil)
                             (:copier nil))
   ;; The IR1 block that this block is in the INFO for.
-  (block (required-argument) :type cblock)
+  (block (missing-arg) :type cblock)
   ;; the next and previous block in emission order (not DFO). This
   ;; determines which block we drop though to, and also used to chain
   ;; together overflow blocks that result from splitting of IR2 blocks
 ;;; A COMPONENT structure provides a handle on a connected piece of
 ;;; the flow graph. Most of the passes in the compiler operate on
 ;;; COMPONENTs rather than on the entire flow graph.
+;;;
+;;; According to the CMU CL internals/front.tex, the reason for
+;;; separating compilation into COMPONENTs is
+;;;   to increase the efficiency of large block compilations. In
+;;;   addition to improving locality of reference and reducing the
+;;;   size of flow analysis problems, this allows back-end data
+;;;   structures to be reclaimed after the compilation of each
+;;;   component.
 (defstruct (component (:copier nil))
   ;; the kind of component
   ;;
   ;; The possibilities are:
   ;;   NIL
   ;;     an ordinary component, containing non-top-level code
-  ;;   :TOP-LEVEL
+  ;;   :TOPLEVEL
   ;;     a component containing only load-time code
-  ;;   :COMPLEX-TOP-LEVEL
+  ;;   :COMPLEX-TOPLEVEL
   ;;     In the old system, before FUNCTIONAL-HAS-EXTERNAL-REFERENCES-P
   ;;     was defined, this was necessarily a component containing both
-  ;;     top-level and run-time code. Now this state is also used for
+  ;;     top level and run-time code. Now this state is also used for
   ;;     a component with HAS-EXTERNAL-REFERENCES-P functionals in it.
   ;;   :INITIAL
   ;;     the result of initial IR1 conversion, on which component
   ;;   :DELETED
   ;;     debris left over from component analysis
   ;;
-  ;; See also COMPONENT-TOP-LEVELISH-P.
-  (kind nil :type (member nil :top-level :complex-top-level :initial :deleted))
+  ;; See also COMPONENT-TOPLEVELISH-P.
+  (kind nil :type (member nil :toplevel :complex-toplevel :initial :deleted))
   ;; the blocks that are the dummy head and tail of the DFO
   ;;
   ;; Entry/exit points have these blocks as their
   ;; predecessors/successors. Null temporarily. The start and return
   ;; from each non-deleted function is linked to the component head
-  ;; and tail. Until environment analysis links NLX entry stubs to the
-  ;; component head, every successor of the head is a function start
-  ;; (i.e. begins with a BIND node.)
+  ;; and tail. Until physical environment analysis links NLX entry
+  ;; stubs to the component head, every successor of the head is a
+  ;; function start (i.e. begins with a BIND node.)
   (head nil :type (or null cblock))
   (tail nil :type (or null cblock))
   ;; This becomes a list of the CLAMBDA structures for all functions
   ;; deleted or LET lambdas.
   ;;
   ;; Note that logical associations between CLAMBDAs and COMPONENTs
-  ;; seem to exist for a while before this is initialized. In
-  ;; particular, I got burned by writing some code to use this value
-  ;; to decide which components need LOCAL-CALL-ANALYZE, when it turns
-  ;; out that LOCAL-CALL-ANALYZE had a role in initializing this value
+  ;; seem to exist for a while before this is initialized. See e.g.
+  ;; the NEW-FUNS slot. In particular, I got burned by writing some
+  ;; code to use this value to decide which components need
+  ;; LOCALL-ANALYZE-COMPONENT, when it turns out that
+  ;; LOCALL-ANALYZE-COMPONENT had a role in initializing this value
   ;; (and DFO stuff does too, maybe). Also, even after it's
   ;; initialized, it might change as CLAMBDAs are deleted or merged.
   ;; -- WHN 2001-09-30
   (lambdas () :type list)
-  ;; a list of FUNCTIONAL structures for functions that are newly
-  ;; converted, and haven't been local-call analyzed yet. Initially
-  ;; functions are not in the LAMBDAS list. LOCAL-CALL-ANALYZE moves
-  ;; them there (possibly as LETs, or implicitly as XEPs if an
-  ;; OPTIONAL-DISPATCH.) Between runs of LOCAL-CALL-ANALYZE there may
-  ;; be some debris of converted or even deleted functions in this
-  ;; list.
-  (new-functions () :type list)
+  ;; a list of FUNCTIONALs for functions that are newly converted, and
+  ;; haven't been local-call analyzed yet. Initially functions are not
+  ;; in the LAMBDAS list. Local call analysis moves them there
+  ;; (possibly as LETs, or implicitly as XEPs if an OPTIONAL-DISPATCH.)
+  ;; Between runs of local call analysis there may be some debris of
+  ;; converted or even deleted functions in this list.
+  (new-funs () :type list)
   ;; If this is true, then there is stuff in this component that could
   ;; benefit from further IR1 optimization.
   (reoptimize t :type boolean)
   ;; optimization of the node failed. The description is an alist
   ;; (TRANSFORM . ARGS), where TRANSFORM is the structure describing
   ;; the transform that failed, and ARGS is either a list of format
-  ;; arguments for the note, or the FUNCTION-TYPE that would have
+  ;; arguments for the note, or the FUN-TYPE that would have
   ;; enabled the transformation but failed to match.
   (failed-optimizations (make-hash-table :test 'eq) :type hash-table)
-  ;; This is similar to NEW-FUNCTIONS, but is used when a function has
+  ;; This is similar to NEW-FUNS, but is used when a function has
   ;; already been analyzed, but new references have been added by
-  ;; inline expansion. Unlike NEW-FUNCTIONS, this is not disjoint from
+  ;; inline expansion. Unlike NEW-FUNS, this is not disjoint from
   ;; COMPONENT-LAMBDAS.
-  (reanalyze-functions nil :type list))
+  (reanalyze-funs nil :type list))
 (defprinter (component :identity t)
   name
   (reanalyze :test reanalyze))
 
-;;; Before sbcl-0.7.0, there were :TOP-LEVEL things which were magical
+;;; Before sbcl-0.7.0, there were :TOPLEVEL things which were magical
 ;;; in multiple ways. That's since been refactored into the orthogonal
 ;;; properties "optimized for locall with no arguments" and "externally
 ;;; visible/referenced (so don't delete it)". The code <0.7.0 did a lot
 ;;; this function is a sort of literal translation of those tests into
 ;;; the new world.
 ;;;
-;;; FIXME: After things settle down, bare :TOP-LEVEL might go away, at
+;;; FIXME: After things settle down, bare :TOPLEVEL might go away, at
 ;;; which time it might be possible to replace the COMPONENT-KIND
-;;; :TOP-LEVEL mess with a flag COMPONENT-HAS-EXTERNAL-REFERENCES-P
+;;; :TOPLEVEL mess with a flag COMPONENT-HAS-EXTERNAL-REFERENCES-P
 ;;; along the lines of FUNCTIONAL-HAS-EXTERNAL-REFERENCES-P.
-(defun lambda-top-levelish-p (clambda)
-  (or (eql (lambda-kind clambda) :top-level)
+(defun lambda-toplevelish-p (clambda)
+  (or (eql (lambda-kind clambda) :toplevel)
       (lambda-has-external-references-p clambda)))
-(defun component-top-levelish-p (component)
+(defun component-toplevelish-p (component)
   (member (component-kind component)
-         '(:top-level :complex-top-level)))
+         '(:toplevel :complex-toplevel)))
 
 ;;; A CLEANUP structure represents some dynamic binding action. Blocks
 ;;; are annotated with the current CLEANUP so that dynamic bindings
 ;;; change.
 (defstruct (cleanup (:copier nil))
   ;; the kind of thing that has to be cleaned up
-  (kind (required-argument)
+  (kind (missing-arg)
        :type (member :special-bind :catch :unwind-protect :block :tagbody))
   ;; the node that messes things up. This is the last node in the
   ;; non-messed-up environment. Null only temporarily. This could be
   ;; deleted due to unreachability.
   (mess-up nil :type (or node null))
   ;; a list of all the NLX-INFO structures whose NLX-INFO-CLEANUP is
-  ;; this cleanup. This is filled in by environment analysis.
+  ;; this cleanup. This is filled in by physical environment analysis.
   (nlx-info nil :type list))
 (defprinter (cleanup :identity t)
   kind
   mess-up
   (nlx-info :test nlx-info))
 
-;;; original CMU CL comment:
-;;;   An ENVIRONMENT structure represents the result of environment
-;;;   analysis.
+;;; A PHYSENV represents the result of physical environment analysis.
 ;;;
 ;;; As far as I can tell from reverse engineering, this IR1 structure
 ;;; represents the physical environment (which is probably not the
 ;;; FROB-THINGS and FROBBING-ONE-THING are all in the inner LAMBDA's
 ;;; lexical environment, but of those only THING, PATTERN, and
 ;;; FROB-THINGS are in its physical environment. In IR1, we largely
-;;; just collect the names of these things; in IR2 an IR2-ENVIRONMENT
+;;; just collect the names of these things; in IR2 an IR2-PHYSENV
 ;;; structure is attached to INFO and used to keep track of
 ;;; associations between these names and less-abstract things (like
 ;;; TNs, or eventually stack slots and registers). -- WHN 2001-09-29
-(defstruct (environment (:copier nil))
-  ;; the function that allocates this environment
-  (function (required-argument) :type clambda)
-  ;; a list of all the lambdas that allocate variables in this environment
+(defstruct (physenv (:copier nil))
+  ;; the function that allocates this physical environment
+  (lambda (missing-arg) :type clambda :read-only t)
+  #| ; seems not to be used as of sbcl-0.pre7.51
+  ;; a list of all the lambdas that allocate variables in this
+  ;; physical environment
   (lambdas nil :type list)
+  |#
   ;; This ultimately converges to a list of all the LAMBDA-VARs and
   ;; NLX-INFOs needed from enclosing environments by code in this
-  ;; environment. In the meantime, it may be
+  ;; physical environment. In the meantime, it may be
   ;;   * NIL at object creation time
   ;;   * a superset of the correct result, generated somewhat later
   ;;   * smaller and smaller sets converging to the correct result as
   ;;     we notice and delete unused elements in the superset
   (closure nil :type list)
   ;; a list of NLX-INFO structures describing all the non-local exits
-  ;; into this environment
+  ;; into this physical environment
   (nlx-info nil :type list)
   ;; some kind of info used by the back end
   (info nil))
-(defprinter (environment :identity t)
-  function
+(defprinter (physenv :identity t)
+  lambda
   (closure :test closure)
   (nlx-info :test nlx-info))
 
 ;;; end up tail-recursive causes TAIL-SET merging.
 (defstruct (tail-set)
   ;; a list of all the LAMBDAs in this tail set
-  (functions nil :type list)
+  (funs nil :type list)
   ;; our current best guess of the type returned by these functions.
   ;; This is the union across all the functions of the return node's
   ;; RESULT-TYPE, excluding local calls.
   ;; some info used by the back end
   (info nil))
 (defprinter (tail-set :identity t)
-  functions
+  funs
   type
   (info :test info))
 
 ;;; The NLX-Info structure is used to collect various information
 ;;; about non-local exits. This is effectively an annotation on the
 ;;; CONTINUATION, although it is accessed by searching in the
-;;; ENVIRONMENT-NLX-INFO.
+;;; PHYSENV-NLX-INFO.
 (def!struct (nlx-info (:make-load-form-fun ignore-it))
   ;; the cleanup associated with this exit. In a catch or
   ;; unwind-protect, this is the :CATCH or :UNWIND-PROTECT cleanup,
   ;; and not the cleanup for the escape block. The CLEANUP-KIND of
   ;; this thus provides a good indication of what kind of exit is
   ;; being done.
-  (cleanup (required-argument) :type cleanup)
+  (cleanup (missing-arg) :type cleanup)
   ;; the continuation exited to (the CONT of the EXIT nodes). If this
   ;; exit is from an escape function (CATCH or UNWIND-PROTECT), then
-  ;; environment analysis deletes the escape function and instead has
-  ;; the %NLX-ENTRY use this continuation.
+  ;; physical environment analysis deletes the escape function and
+  ;; instead has the %NLX-ENTRY use this continuation.
   ;;
   ;; This slot is primarily an indication of where this exit delivers
   ;; its values to (if any), but it is also used as a sort of name to
   ;; For this purpose, the Entry must also be used to disambiguate,
   ;; since exits to different places may deliver their result to the
   ;; same continuation.
-  (continuation (required-argument) :type continuation)
-  ;; the entry stub inserted by environment analysis. This is a block
-  ;; containing a call to the %NLX-Entry funny function that has the
-  ;; original exit destination as its successor. Null only
+  (continuation (missing-arg) :type continuation)
+  ;; the entry stub inserted by physical environment analysis. This is
+  ;; a block containing a call to the %NLX-Entry funny function that
+  ;; has the original exit destination as its successor. Null only
   ;; temporarily.
   (target nil :type (or cblock null))
   ;; some kind of info used by the back end
 ;;; hacking the flow graph.
 (def!struct (leaf (:make-load-form-fun ignore-it)
                  (:constructor nil))
-  ;; some name for this leaf. The exact significance of the name
-  ;; depends on what kind of leaf it is. In a LAMBDA-VAR or
-  ;; GLOBAL-VAR, this is the symbol name of the variable. In a
-  ;; functional that is from a DEFUN, this is the defined name. In
-  ;; other functionals, this is a descriptive string.
-  (name nil :type t)
+  ;; (For public access to this slot, use LEAF-SOURCE-NAME.)
+  ;;
+  ;; the name of LEAF as it appears in the source, e.g. 'FOO or '(SETF
+  ;; FOO) or 'N or '*Z*, or the special .ANONYMOUS. value if there's
+  ;; no name for this thing in the source (as can happen for
+  ;; FUNCTIONALs, e.g. for anonymous LAMBDAs or for functions for
+  ;; top-level forms; and can also happen for anonymous constants) or
+  ;; perhaps also if the match between the name and the thing is
+  ;; skewed enough (e.g. for macro functions or method functions) that
+  ;; we don't want to have that name affect compilation
+  ;;
+  ;; The value of this slot in can affect ordinary runtime behavior,
+  ;; e.g. of special variables and known functions, not just debugging.
+  ;;
+  ;; See also the LEAF-DEBUG-NAME function and the
+  ;; FUNCTIONAL-%DEBUG-NAME slot.
+  (%source-name (missing-arg)
+               :type (or symbol (and cons (satisfies legal-fun-name-p)))
+               :read-only t)
   ;; the type which values of this leaf must have
   (type *universal-type* :type ctype)
   ;; where the TYPE information came from:
   ;; some kind of info used by the back end
   (info nil))
 
+;;; LEAF name operations
+;;;
+;;; KLUDGE: wants CLOS..
+(defun leaf-has-source-name-p (leaf)
+  (not (eq (leaf-%source-name leaf)
+          '.anonymous.)))
+(defun leaf-source-name (leaf)
+  (aver (leaf-has-source-name-p leaf))
+  (leaf-%source-name leaf))
+(defun leaf-debug-name (leaf)
+  (if (functional-p leaf)
+      ;; FUNCTIONALs have additional %DEBUG-NAME behavior.
+      (functional-debug-name leaf)
+      ;; Other objects just use their source name.
+      ;;
+      ;; (As of sbcl-0.pre7.85, there are a few non-FUNCTIONAL
+      ;; anonymous objects, (anonymous constants..) and those would
+      ;; fail here if we ever tried to get debug names from them, but
+      ;; it looks as though it's never interesting to get debug names
+      ;; from them, so it's moot. -- WHN)
+      (leaf-source-name leaf)))
+
 ;;; The CONSTANT structure is used to represent known constant values.
 ;;; If NAME is not null, then it is the name of the named constant
 ;;; which this leaf corresponds to, otherwise this is an anonymous
   ;; the value of the constant
   (value nil :type t))
 (defprinter (constant :identity t)
-  (name :test name)
+  (%source-name :test %source-name)
   value)
 
 ;;; The BASIC-VAR structure represents information common to all
 ;;; variables which don't correspond to known local functions.
-(def!struct (basic-var (:include leaf) (:constructor nil))
+(def!struct (basic-var (:include leaf)
+                      (:constructor nil))
   ;; Lists of the set nodes for this variable.
   (sets () :type list))
 
 ;;; constant, but don't know what the value is at compile time.
 (def!struct (global-var (:include basic-var))
   ;; kind of variable described
-  (kind (required-argument)
-       :type (member :special :global-function :constant :global)))
+  (kind (missing-arg)
+       :type (member :special :global-function :global)))
 (defprinter (global-var :identity t)
-  name
+  %source-name
   (type :test (not (eq type *universal-type*)))
   (where-from :test (not (eq where-from :assumed)))
   kind)
                                     (where-from :defined)
                                     (kind :global-function)))
   ;; The description of the structure that this is an accessor for.
-  (for (required-argument) :type sb!xc:class)
+  (for (missing-arg) :type sb!xc:class)
   ;; The slot description of the slot.
-  (slot (required-argument)))
+  (slot (missing-arg)))
 (defprinter (slot-accessor :identity t)
-  name
+  %source-name
   for
   slot)
 
-;;; The DEFINED-FUNCTION structure represents functions that are
-;;; defined in the same compilation block, or that have inline
-;;; expansions, or have a non-NIL INLINEP value. Whenever we change
-;;; the INLINEP state (i.e. an inline proclamation) we copy the
-;;; structure so that former INLINEP values are preserved.
-(def!struct (defined-function (:include global-var
-                                       (where-from :defined)
-                                       (kind :global-function)))
+;;; A DEFINED-FUN represents a function that is defined in the same
+;;; compilation block, or that has an inline expansion, or that has a
+;;; non-NIL INLINEP value. Whenever we change the INLINEP state (i.e.
+;;; an inline proclamation) we copy the structure so that former
+;;; INLINEP values are preserved.
+(def!struct (defined-fun (:include global-var
+                                  (where-from :defined)
+                                  (kind :global-function)))
   ;; The values of INLINEP and INLINE-EXPANSION initialized from the
   ;; global environment.
   (inlinep nil :type inlinep)
   (inline-expansion nil :type (or cons null))
-  ;; The block-local definition of this function (either because it
-  ;; was semi-inline, or because it was defined in this block.) If
+  ;; the block-local definition of this function (either because it
+  ;; was semi-inline, or because it was defined in this block). If
   ;; this function is not an entry point, then this may be deleted or
-  ;; let-converted. Null if we haven't converted the expansion yet.
+  ;; LET-converted. Null if we haven't converted the expansion yet.
   (functional nil :type (or functional null)))
-(defprinter (defined-function :identity t)
-  name
+(defprinter (defined-fun :identity t)
+  %source-name
   inlinep
   (functional :test functional))
 \f
 ;;; We don't normally manipulate function types for defined functions,
 ;;; but if someone wants to know, an approximation is there.
 (def!struct (functional (:include leaf
+                                 (%source-name '.anonymous.)
                                  (where-from :defined)
                                  (type (specifier-type 'function))))
-  ;; Some information about how this function is used. These values are
-  ;; meaningful:
+  ;; (For public access to this slot, use LEAF-DEBUG-NAME.)
+  ;;
+  ;; the name of FUNCTIONAL for debugging purposes, or NIL if we
+  ;; should just let the SOURCE-NAME fall through
+  ;; 
+  ;; Unlike the SOURCE-NAME slot, this slot's value should never
+  ;; affect ordinary code behavior, only debugging/diagnostic behavior.
+  ;;
+  ;; The value of this slot can be anything, except that it shouldn't
+  ;; be a legal function name, since otherwise debugging gets
+  ;; confusing. (If a legal function name is a good name for the
+  ;; function, it should be in %SOURCE-NAME, and then we shouldn't
+  ;; need a %DEBUG-NAME.) In SBCL as of 0.pre7.87, it's always a
+  ;; string unless it's NIL, since that's how CMU CL represented debug
+  ;; names. However, eventually I (WHN) think it we should start using
+  ;; list values instead, since they have much nicer print properties
+  ;; (abbreviation, skipping package prefixes when unneeded, and
+  ;; renaming package prefixes when we do things like renaming SB!EXT
+  ;; to SB-EXT).
+  ;;
+  ;; E.g. for the function which implements (DEFUN FOO ...), we could
+  ;; have
+  ;;   %SOURCE-NAME=FOO
+  ;;   %DEBUG-NAME=NIL
+  ;; for the function which implements the top level form
+  ;; (IN-PACKAGE :FOO) we could have
+  ;;   %SOURCE-NAME=NIL
+  ;;   %DEBUG-NAME="top level form (IN-PACKAGE :FOO)"
+  ;; for the function which implements FOO in
+  ;;   (DEFUN BAR (...) (FLET ((FOO (...) ...)) ...))
+  ;; we could have
+  ;;   %SOURCE-NAME=FOO
+  ;;   %DEBUG-NAME="FLET FOO in BAR"
+  ;; and for the function which implements FOO in
+  ;;   (DEFMACRO FOO (...) ...)
+  ;; we could have
+  ;;   %SOURCE-NAME=FOO (or maybe .ANONYMOUS.?)
+  ;;   %DEBUG-NAME="DEFMACRO FOO"
+  (%debug-name nil
+              :type (or null (not (satisfies legal-fun-name-p)))
+              :read-only t)
+  ;; some information about how this function is used. These values
+  ;; are meaningful:
   ;;
   ;;    NIL
   ;;   an ordinary function, callable using local call
   ;;
   ;;    :EXTERNAL
   ;;   an external entry point lambda. The function it is an entry
-  ;;   for is in the ENTRY-FUNCTION slot.
+  ;;   for is in the ENTRY-FUN slot.
   ;;
-  ;;    :TOP-LEVEL
-  ;;   a top-level lambda, holding a compiled top-level form.
+  ;;    :TOPLEVEL
+  ;;   a top level lambda, holding a compiled top level form.
   ;;   Compiled very much like NIL, but provides an indication of
-  ;;   top-level context. A top-level lambda should have *no*
-  ;;   references. Its Entry-Function is a self-pointer.
+  ;;   top level context. A :TOPLEVEL lambda should have *no*
+  ;;   references. Its ENTRY-FUN is a self-pointer.
   ;;
-  ;;    :TOP-LEVEL-XEP
-  ;;   After a component is compiled, we clobber any top-level code
+  ;;    :TOPLEVEL-XEP
+  ;;   After a component is compiled, we clobber any top level code
   ;;   references to its non-closure XEPs with dummy FUNCTIONAL
   ;;   structures having this kind. This prevents the retained
-  ;;   top-level code from holding onto the IR for the code it
+  ;;   top level code from holding onto the IR for the code it
   ;;   references.
   ;;
   ;;    :ESCAPE
   ;;    :DELETED
   ;;   This function has been found to be uncallable, and has been
   ;;   marked for deletion.
-  (kind nil :type (member nil :optional :deleted :external :top-level
+  (kind nil :type (member nil :optional :deleted :external :toplevel
                          :escape :cleanup :let :mv-let :assignment
-                         :top-level-xep))
+                         :toplevel-xep))
   ;; Is this a function that some external entity (e.g. the fasl dumper)
   ;; refers to, so that even when it appears to have no references, it
   ;; shouldn't be deleted? In the old days (before
   ;; sbcl-0.pre7.37.flaky5.2) this was sort of implicitly true when
-  ;; KIND was :TOP-LEVEL. Now it must be set explicitly, both for
-  ;; :TOP-LEVEL functions and for any other kind of functions that we
+  ;; KIND was :TOPLEVEL. Now it must be set explicitly, both for
+  ;; :TOPLEVEL functions and for any other kind of functions that we
   ;; want to dump or return from #'CL:COMPILE or whatever.
   (has-external-references-p nil) 
   ;; In a normal function, this is the external entry point (XEP)
   ;; In an XEP lambda (indicated by the :EXTERNAL kind), this is the
   ;; function that the XEP is an entry-point for. The body contains
   ;; local calls to all the actual entry points in the function. In a
-  ;; :TOP-LEVEL lambda (which is its own XEP) this is a self-pointer.
+  ;; :TOPLEVEL lambda (which is its own XEP) this is a self-pointer.
   ;;
   ;; With all other kinds, this is null.
-  (entry-function nil :type (or functional null))
+  (entry-fun nil :type (or functional null))
   ;; the value of any inline/notinline declaration for a local function
   (inlinep nil :type inlinep)
   ;; If we have a lambda that can be used as in inline expansion for
   ;; various rare miscellaneous info that drives code generation & stuff
   (plist () :type list))
 (defprinter (functional :identity t)
-  name)
+  %source-name
+  %debug-name)
+
+;;; FUNCTIONAL name operations
+(defun functional-debug-name (functional)
+  ;; FUNCTIONAL-%DEBUG-NAME takes precedence over FUNCTIONAL-SOURCE-NAME
+  ;; here because we want different debug names for the functions in
+  ;; DEFUN FOO and FLET FOO even though they have the same source name.
+  (or (functional-%debug-name functional)
+      ;; Note that this will cause an error if the function is
+      ;; anonymous. In SBCL (as opposed to CMU CL) we make all
+      ;; FUNCTIONALs have debug names. The CMU CL code didn't bother
+      ;; in many FUNCTIONALs, especially those which were likely to be
+      ;; optimized away before the user saw them. However, getting 
+      ;; that right requires a global understanding of the code,
+      ;; which seems bad, so we just require names for everything.
+      (leaf-source-name functional)))
 
 ;;; The CLAMBDA only deals with required lexical arguments. Special,
 ;;; optional, keyword and rest arguments are handled by transforming
                     (:predicate lambda-p)
                     (:constructor make-lambda)
                     (:copier copy-lambda))
-  ;; list of LAMBDA-VAR descriptors for args
-  (vars nil :type list)
+  ;; list of LAMBDA-VAR descriptors for arguments
+  (vars nil :type list :read-only t)
   ;; If this function was ever a :OPTIONAL function (an entry-point
   ;; for an OPTIONAL-DISPATCH), then this is that OPTIONAL-DISPATCH.
   ;; The optional dispatch will be :DELETED if this function is no
   ;; If this CLAMBDA is a LET, then this slot holds the LAMBDA whose
   ;; LETS list we are in, otherwise it is a self-pointer.
   (home nil :type (or clambda null))
-  ;; a list of all the all the lambdas that have been LET-substituted
-  ;; in this lambda. This is only non-null in lambdas that aren't
-  ;; LETs.
-  (lets () :type list)
-  ;; a list of all the ENTRY nodes in this function and its LETs, or
-  ;; null in a LET
-  (entries () :type list)
-  ;; a list of all the functions directly called from this function
-  ;; (or one of its LETs) using a non-LET local call. This may include
-  ;; deleted functions because nobody bothers to clear them out.
-  (calls () :type list)
+  ;; all the lambdas that have been LET-substituted in this lambda.
+  ;; This is only non-null in lambdas that aren't LETs.
+  (lets nil :type list)
+  ;; all the ENTRY nodes in this function and its LETs, or null in a LET
+  (entries nil :type list)
+  ;; CLAMBDAs which are locally called by this lambda, and other
+  ;; objects (closed-over LAMBDA-VARs and XEPs) which this lambda
+  ;; depends on in such a way that DFO shouldn't put them in separate
+  ;; components.
+  (calls-or-closes nil :type list)
   ;; the TAIL-SET that this LAMBDA is in. This is null during creation.
   ;;
   ;; In CMU CL, and old SBCL, this was also NILed out when LET
   ;; (so that any further optimizations on the rest of the tail
   ;; set won't modify the value) if necessary.
   (tail-set nil :type (or tail-set null))
-  ;; the structure which represents the environment that this
+  ;; the structure which represents the phsical environment that this
   ;; function's variables are allocated in. This is filled in by
-  ;; environment analysis. In a LET, this is EQ to our home's
-  ;; environment.
-  (environment nil :type (or environment null))
+  ;; physical environment analysis. In a LET, this is EQ to our home's
+  ;; physical environment.
+  (physenv nil :type (or physenv null))
   ;; In a LET, this is the NODE-LEXENV of the combination node. We
   ;; retain it so that if the LET is deleted (due to a lack of vars),
   ;; we will still have caller's lexenv to figure out which cleanup is
   ;; in effect.
   (call-lexenv nil :type (or lexenv null)))
 (defprinter (clambda :conc-name lambda- :identity t)
-  name
+  %source-name
+  %debug-name
   (type :test (not (eq type *universal-type*)))
   (where-from :test (not (eq where-from :assumed)))
-  (vars :prin1 (mapcar #'leaf-name vars)))
+  (vars :prin1 (mapcar #'leaf-source-name vars)))
 
 ;;; The OPTIONAL-DISPATCH leaf is used to represent hairy lambdas. It
 ;;; is a FUNCTIONAL, like LAMBDA. Each legal number of arguments has a
   ;; know what they are doing.
   (main-entry nil :type (or clambda null)))
 (defprinter (optional-dispatch :identity t)
-  name
+  %source-name
+  %debug-name
   (type :test (not (eq type *universal-type*)))
   (where-from :test (not (eq where-from :assumed)))
   arglist
   (specialp nil :type boolean)
   ;; the kind of argument being described. Required args only have arg
   ;; info structures if they are special.
-  (kind (required-argument) :type (member :required :optional :keyword :rest
-                                         :more-context :more-count))
+  (kind (missing-arg)
+       :type (member :required :optional :keyword :rest
+                     :more-context :more-count))
   ;; If true, this is the VAR for SUPPLIED-P variable of a keyword or
   ;; optional arg. This is true for keywords with non-constant
   ;; defaults even when there is no user-specified supplied-p var.
   ;; original Lisp code. This is set to NIL in &KEY arguments that are
   ;; defaulted using the SUPPLIED-P arg.
   (default nil :type t)
-  ;; the actual key for a &KEY argument. Note that in ANSI CL this is not
-  ;; necessarily a keyword: (DEFUN FOO (&KEY ((BAR BAR))) ..).
+  ;; the actual key for a &KEY argument. Note that in ANSI CL this is
+  ;; not necessarily a keyword: (DEFUN FOO (&KEY ((BAR BAR))) ...).
   (key nil :type symbol))
 (defprinter (arg-info :identity t)
   (specialp :test specialp)
 ;;; lambda arguments which may ultimately turn out not to be simple
 ;;; and lexical.
 ;;;
-;;; LAMBDA-VARs with no REFs are considered to be deleted; environment
-;;; analysis isn't done on these variables, so the back end must check
-;;; for and ignore unreferenced variables. Note that a deleted
-;;; lambda-var may have sets; in this case the back end is still
-;;; responsible for propagating the Set-Value to the set's Cont.
+;;; LAMBDA-VARs with no REFs are considered to be deleted; physical
+;;; environment analysis isn't done on these variables, so the back
+;;; end must check for and ignore unreferenced variables. Note that a
+;;; deleted LAMBDA-VAR may have sets; in this case the back end is
+;;; still responsible for propagating the SET-VALUE to the set's CONT.
 (def!struct (lambda-var (:include basic-var))
   ;; true if this variable has been declared IGNORE
   (ignorep nil :type boolean)
   ;; the CLAMBDA that this var belongs to. This may be null when we are
   ;; building a lambda during IR1 conversion.
   (home nil :type (or null clambda))
-  ;; This is set by environment analysis if it chooses an indirect
-  ;; (value cell) representation for this variable because it is both
-  ;; set and closed over.
+  ;; This is set by physical environment analysis if it chooses an
+  ;; indirect (value cell) representation for this variable because it
+  ;; is both set and closed over.
   (indirect nil :type boolean)
   ;; The following two slots are only meaningful during IR1 conversion
   ;; of hairy lambda vars:
   ;; good subject for flow analysis.
   (constraints nil :type (or sset null)))
 (defprinter (lambda-var :identity t)
-  name
+  %source-name
   (type :test (not (eq type *universal-type*)))
   (where-from :test (not (eq where-from :assumed)))
   (ignorep :test ignorep)
                (:constructor make-if)
                (:copier copy-if))
   ;; CONTINUATION for the predicate
-  (test (required-argument) :type continuation)
+  (test (missing-arg) :type continuation)
   ;; the blocks that we execute next in true and false case,
   ;; respectively (may be the same)
-  (consequent (required-argument) :type cblock)
-  (alternative (required-argument) :type cblock))
+  (consequent (missing-arg) :type cblock)
+  (alternative (missing-arg) :type cblock))
 (defprinter (cif :conc-name if- :identity t)
   (test :prin1 (continuation-use test))
   consequent
                 (:constructor make-set)
                 (:copier copy-set))
   ;; descriptor for the variable set
-  (var (required-argument) :type basic-var)
+  (var (missing-arg) :type basic-var)
   ;; continuation for the value form
-  (value (required-argument) :type continuation))
+  (value (missing-arg) :type continuation))
 (defprinter (cset :conc-name set- :identity t)
   var
   (value :prin1 (continuation-use value)))
                              (:constructor nil)
                              (:copier nil))
   ;; continuation for the function
-  (fun (required-argument) :type continuation)
+  (fun (missing-arg) :type continuation)
   ;; list of CONTINUATIONs for the args. In a local call, an argument
   ;; continuation may be replaced with NIL to indicate that the
   ;; corresponding variable is unreferenced, and thus no argument
   ;; ir1tran.
   (lambda nil :type (or clambda null))
   ;; the continuation which yields the value of the lambda
-  (result (required-argument) :type continuation)
+  (result (missing-arg) :type continuation)
   ;; the union of the node-derived-type of all uses of the result
   ;; other than by a local call, intersected with the result's
   ;; asserted-type. If there are no non-call uses, this is
 ;;; original exit continuation is the exit node's CONT.
 (defstruct (exit (:include node)
                 (:copier nil))
-  ;; The Entry node that this is an exit for. If null, this is a
+  ;; the ENTRY node that this is an exit for. If null, this is a
   ;; degenerate exit. A degenerate exit is used to "fill" an empty
   ;; block (which isn't allowed in IR1.) In a degenerate exit, Value
   ;; is always also null.
   (entry nil :type (or entry null))
-  ;; The continuation yeilding the value we are to exit with. If NIL,
+  ;; the continuation yielding the value we are to exit with. If NIL,
   ;; then no value is desired (as in GO).
   (value nil :type (or continuation null)))
 (defprinter (exit :identity t)
   ;; the name of the unknown thing
   (name nil :type (or symbol list))
   ;; the kind of reference to NAME
-  (kind (required-argument) :type (member :function :type :variable))
+  (kind (missing-arg) :type (member :function :type :variable))
   ;; the number of times this thing was used
   (count 0 :type unsigned-byte)
   ;; a list of COMPILER-ERROR-CONTEXT structures describing places
 
 #!-sb-fluid
 (declaim (freeze-type node leaf lexenv continuation cblock component cleanup
-                     environment tail-set nlx-info))
+                     physenv tail-set nlx-info))