src/compiler/main.lisp

   1 ;;;; the top level interfaces to the compiler, plus some other
   2 ;;;; compiler-related stuff (e.g. CL:CALL-ARGUMENTS-LIMIT) which
   3 ;;;; doesn't obviously belong anywhere else
   4
   5 ;;;; This software is part of the SBCL system. See the README file for
   6 ;;;; more information.
   7 ;;;;
   8 ;;;; This software is derived from the CMU CL system, which was
   9 ;;;; written at Carnegie Mellon University and released into the
  10 ;;;; public domain. The software is in the public domain and is
  11 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
  12 ;;;; files for more information.
  13
  14 (in-package "SB!C")
  15
  16 ;;; FIXME: Doesn't this belong somewhere else, like early-c.lisp?
  17 (declaim (special *constants* *free-vars* *component-being-compiled*
  18                   *code-vector* *next-location* *result-fixups*
  19                   *free-funs* *source-paths*
  20                   *seen-blocks* *seen-funs* *list-conflicts-table*
  21                   *continuation-number* *continuation-numbers*
  22                   *number-continuations* *tn-id* *tn-ids* *id-tns*
  23                   *label-ids* *label-id* *id-labels*
  24                   *undefined-warnings* *compiler-error-count*
  25                   *compiler-warning-count* *compiler-style-warning-count*
  26                   *compiler-note-count*
  27                   *compiler-error-bailout*
  28                   #!+sb-show *compiler-trace-output*
  29                   *last-source-context* *last-original-source*
  30                   *last-source-form* *last-format-string* *last-format-args*
  31                   *last-message-count* *last-error-context*
  32                   *lexenv* *fun-names-in-this-file*
  33                   *allow-instrumenting*))
  34
  35 ;;; Whether call of a function which cannot be defined causes a full
  36 ;;; warning.
  37 (defvar *flame-on-necessarily-undefined-function* nil)
  38
  39 (defvar *check-consistency* nil)
  40 (defvar *all-components*)
  41
  42 ;;; Set to NIL to disable loop analysis for register allocation.
  43 (defvar *loop-analyze* t)
  44
  45 ;;; Bind this to a stream to capture various internal debugging output.
  46 (defvar *compiler-trace-output* nil)
  47
  48 ;;; The current block compilation state. These are initialized to the
  49 ;;; :BLOCK-COMPILE and :ENTRY-POINTS arguments that COMPILE-FILE was
  50 ;;; called with.
  51 ;;;
  52 ;;; *BLOCK-COMPILE-ARG* holds the original value of the :BLOCK-COMPILE
  53 ;;; argument, which overrides any internal declarations.
  54 (defvar *block-compile*)
  55 (defvar *block-compile-arg*)
  56 (declaim (type (member nil t :specified) *block-compile* *block-compile-arg*))
  57 (defvar *entry-points*)
  58 (declaim (list *entry-points*))
  59
  60 ;;; When block compiling, used by PROCESS-FORM to accumulate top level
  61 ;;; lambdas resulting from compiling subforms. (In reverse order.)
  62 (defvar *toplevel-lambdas*)
  63 (declaim (list *toplevel-lambdas*))
  64
  65 ;;; The current non-macroexpanded toplevel form as printed when
  66 ;;; *compile-print* is true.
  67 (defvar *top-level-form-noted* nil)
  68
  69 (defvar sb!xc:*compile-verbose* t
  70   #!+sb-doc
  71   "The default for the :VERBOSE argument to COMPILE-FILE.")
  72 (defvar sb!xc:*compile-print* t
  73   #!+sb-doc
  74   "The default for the :PRINT argument to COMPILE-FILE.")
  75 (defvar *compile-progress* nil
  76   #!+sb-doc
  77   "When this is true, the compiler prints to *STANDARD-OUTPUT* progress
  78   information about the phases of compilation of each function. (This
  79   is useful mainly in large block compilations.)")
  80
  81 (defvar sb!xc:*compile-file-pathname* nil
  82   #!+sb-doc
  83   "The defaulted pathname of the file currently being compiled, or NIL if not
  84   compiling.")
  85 (defvar sb!xc:*compile-file-truename* nil
  86   #!+sb-doc
  87   "The TRUENAME of the file currently being compiled, or NIL if not
  88   compiling.")
  89
  90 (declaim (type (or pathname null)
  91                sb!xc:*compile-file-pathname*
  92                sb!xc:*compile-file-truename*))
  93
  94 ;;; the SOURCE-INFO structure for the current compilation. This is
  95 ;;; null globally to indicate that we aren't currently in any
  96 ;;; identifiable compilation.
  97 (defvar *source-info* nil)
  98
  99 ;;; This is true if we are within a WITH-COMPILATION-UNIT form (which
 100 ;;; normally causes nested uses to be no-ops).
 101 (defvar *in-compilation-unit* nil)
 102
 103 ;;; Count of the number of compilation units dynamically enclosed by
 104 ;;; the current active WITH-COMPILATION-UNIT that were unwound out of.
 105 (defvar *aborted-compilation-unit-count*)
 106
 107 ;;; Mumble conditional on *COMPILE-PROGRESS*.
 108 (defun maybe-mumble (&rest foo)
 109   (when *compile-progress*
 110     (compiler-mumble "~&")
 111     (pprint-logical-block (*standard-output* nil :per-line-prefix "; ")
 112        (apply #'compiler-mumble foo))))
 113
 114 (deftype object () '(or fasl-output core-object null))
 115
 116 (defvar *compile-object* nil)
 117 (declaim (type object *compile-object*))
 118
 119 (defvar *fopcompile-label-counter*)
 120 \f
 121 ;;;; WITH-COMPILATION-UNIT and WITH-COMPILATION-VALUES
 122
 123 (defmacro sb!xc:with-compilation-unit (options &body body)
 124   #!+sb-doc
 125   "WITH-COMPILATION-UNIT ({Key Value}*) Form*
 126   This form affects compilations that take place within its dynamic extent. It
 127   is intended to be wrapped around the compilation of all files in the same
 128   system. These keywords are defined:
 129
 130     :OVERRIDE Boolean-Form
 131         One of the effects of this form is to delay undefined warnings
 132         until the end of the form, instead of giving them at the end of each
 133         compilation. If OVERRIDE is NIL (the default), then the outermost
 134         WITH-COMPILATION-UNIT form grabs the undefined warnings. Specifying
 135         OVERRIDE true causes that form to grab any enclosed warnings, even if
 136         it is enclosed by another WITH-COMPILATION-UNIT.
 137
 138     :SOURCE-PLIST Plist-Form
 139         Attaches the value returned by the Plist-Form to internal debug-source
 140         information of functions compiled in within the dynamic contour.
 141         Primarily for use by development environments, in order to eg. associate
 142         function definitions with editor-buffers. Can be accessed as
 143         SB-INTROSPECT:DEFINITION-SOURCE-PLIST. If multiple, nested
 144         WITH-COMPILATION-UNITs provide :SOURCE-PLISTs, they are appended
 145         togather, innermost left. If  Unaffected by :OVERRIDE."
 146   `(%with-compilation-unit (lambda () ,@body) ,@options))
 147
 148 (defvar *source-plist* nil)
 149
 150 (defun %with-compilation-unit (fn &key override source-plist)
 151   (declare (type function fn))
 152   (let ((succeeded-p nil)
 153         (*source-plist* (append source-plist *source-plist*)))
 154     (if (and *in-compilation-unit* (not override))
 155         ;; Inside another WITH-COMPILATION-UNIT, a WITH-COMPILATION-UNIT is
 156         ;; ordinarily (unless OVERRIDE) basically a no-op.
 157         (unwind-protect
 158              (multiple-value-prog1 (funcall fn) (setf succeeded-p t))
 159           (unless succeeded-p
 160             (incf *aborted-compilation-unit-count*)))
 161         (let ((*aborted-compilation-unit-count* 0)
 162               (*compiler-error-count* 0)
 163               (*compiler-warning-count* 0)
 164               (*compiler-style-warning-count* 0)
 165               (*compiler-note-count* 0)
 166               (*undefined-warnings* nil)
 167               (*in-compilation-unit* t))
 168           (sb!thread:with-recursive-lock (*big-compiler-lock*)
 169             (handler-bind ((parse-unknown-type
 170                             (lambda (c)
 171                               (note-undefined-reference
 172                                (parse-unknown-type-specifier c)
 173                                :type))))
 174               (unwind-protect
 175                    (multiple-value-prog1 (funcall fn) (setf succeeded-p t))
 176                 (unless succeeded-p
 177                   (incf *aborted-compilation-unit-count*))
 178                 (summarize-compilation-unit (not succeeded-p)))))))))
 179
 180 ;;; Is FUN-NAME something that no conforming program can rely on
 181 ;;; defining as a function?
 182 (defun fun-name-reserved-by-ansi-p (fun-name)
 183   (eq (symbol-package (fun-name-block-name fun-name))
 184       *cl-package*))
 185
 186 ;;; This is to be called at the end of a compilation unit. It signals
 187 ;;; any residual warnings about unknown stuff, then prints the total
 188 ;;; error counts. ABORT-P should be true when the compilation unit was
 189 ;;; aborted by throwing out. ABORT-COUNT is the number of dynamically
 190 ;;; enclosed nested compilation units that were aborted.
 191 (defun summarize-compilation-unit (abort-p)
 192   (unless abort-p
 193     (handler-bind ((style-warning #'compiler-style-warning-handler)
 194                    (warning #'compiler-warning-handler))
 195
 196       (let ((undefs (sort *undefined-warnings* #'string<
 197                           :key (lambda (x)
 198                                  (let ((x (undefined-warning-name x)))
 199                                    (if (symbolp x)
 200                                        (symbol-name x)
 201                                        (prin1-to-string x)))))))
 202         (dolist (undef undefs)
 203           (let ((name (undefined-warning-name undef))
 204                 (kind (undefined-warning-kind undef))
 205                 (warnings (undefined-warning-warnings undef))
 206                 (undefined-warning-count (undefined-warning-count undef)))
 207             (dolist (*compiler-error-context* warnings)
 208               (if #-sb-xc-host (and (eq kind :function)
 209                                     (fun-name-reserved-by-ansi-p name)
 210                                     *flame-on-necessarily-undefined-function*)
 211                   #+sb-xc-host nil
 212                   (case name
 213                     ((declare)
 214                      (compiler-warn
 215                       "~@<There is no function named ~S. References to ~S in ~
 216                        some contexts (like starts of blocks) have special ~
 217                        meaning, but here it would have to be a function, ~
 218                        and that shouldn't be right.~:@>"
 219                       name name))
 220                     (t
 221                      (compiler-warn
 222                       "~@<The ~(~A~) ~S is undefined, and its name is ~
 223                        reserved by ANSI CL so that even if it were ~
 224                        defined later, the code doing so would not be ~
 225                        portable.~:@>"
 226                       kind name)))
 227                   (if (eq kind :variable)
 228                       (compiler-warn "undefined ~(~A~): ~S" kind name)
 229                       (compiler-style-warn "undefined ~(~A~): ~S" kind name))))
 230             (let ((warn-count (length warnings)))
 231               (when (and warnings (> undefined-warning-count warn-count))
 232                 (let ((more (- undefined-warning-count warn-count)))
 233                   (if (eq kind :variable)
 234                       (compiler-warn
 235                        "~W more use~:P of undefined ~(~A~) ~S"
 236                        more kind name)
 237                       (compiler-style-warn
 238                        "~W more use~:P of undefined ~(~A~) ~S"
 239                        more kind name)))))))
 240
 241         (dolist (kind '(:variable :function :type))
 242           (let ((summary (mapcar #'undefined-warning-name
 243                                  (remove kind undefs :test #'neq
 244                                          :key #'undefined-warning-kind))))
 245             (when summary
 246               (if (eq kind :variable)
 247                   (compiler-warn
 248                    "~:[This ~(~A~) is~;These ~(~A~)s are~] undefined:~
 249                     ~%  ~{~<~%  ~1:;~S~>~^ ~}"
 250                    (cdr summary) kind summary)
 251                   (compiler-style-warn
 252                    "~:[This ~(~A~) is~;These ~(~A~)s are~] undefined:~
 253                    ~%  ~{~<~%  ~1:;~S~>~^ ~}"
 254                    (cdr summary) kind summary))))))))
 255
 256   (unless (and (not abort-p)
 257                (zerop *aborted-compilation-unit-count*)
 258                (zerop *compiler-error-count*)
 259                (zerop *compiler-warning-count*)
 260                (zerop *compiler-style-warning-count*)
 261                (zerop *compiler-note-count*))
 262     (pprint-logical-block (*error-output* nil :per-line-prefix "; ")
 263       (format *error-output* "~&compilation unit ~:[finished~;aborted~]~
 264                              ~[~:;~:*~&  caught ~W fatal ERROR condition~:P~]~
 265                              ~[~:;~:*~&  caught ~W ERROR condition~:P~]~
 266                              ~[~:;~:*~&  caught ~W WARNING condition~:P~]~
 267                              ~[~:;~:*~&  caught ~W STYLE-WARNING condition~:P~]~
 268                              ~[~:;~:*~&  printed ~W note~:P~]"
 269               abort-p
 270               *aborted-compilation-unit-count*
 271               *compiler-error-count*
 272               *compiler-warning-count*
 273               *compiler-style-warning-count*
 274               *compiler-note-count*))
 275     (terpri *error-output*)
 276     (force-output *error-output*)))
 277
 278 ;;; Evaluate BODY, then return (VALUES BODY-VALUE WARNINGS-P
 279 ;;; FAILURE-P), where BODY-VALUE is the first value of the body, and
 280 ;;; WARNINGS-P and FAILURE-P are as in CL:COMPILE or CL:COMPILE-FILE.
 281 ;;; This also wraps up WITH-IR1-NAMESPACE functionality.
 282 (defmacro with-compilation-values (&body body)
 283   `(with-ir1-namespace
 284     (let ((*warnings-p* nil)
 285           (*failure-p* nil))
 286       (values (progn ,@body)
 287               *warnings-p*
 288               *failure-p*))))
 289 \f
 290 ;;;; component compilation
 291
 292 (defparameter *max-optimize-iterations* 3 ; ARB
 293   #!+sb-doc
 294   "The upper limit on the number of times that we will consecutively do IR1
 295   optimization that doesn't introduce any new code. A finite limit is
 296   necessary, since type inference may take arbitrarily long to converge.")
 297
 298 (defevent ir1-optimize-until-done "IR1-OPTIMIZE-UNTIL-DONE called")
 299 (defevent ir1-optimize-maxed-out "hit *MAX-OPTIMIZE-ITERATIONS* limit")
 300
 301 ;;; Repeatedly optimize COMPONENT until no further optimizations can
 302 ;;; be found or we hit our iteration limit. When we hit the limit, we
 303 ;;; clear the component and block REOPTIMIZE flags to discourage the
 304 ;;; next optimization attempt from pounding on the same code.
 305 (defun ir1-optimize-until-done (component)
 306   (declare (type component component))
 307   (maybe-mumble "opt")
 308   (event ir1-optimize-until-done)
 309   (let ((count 0)
 310         (cleared-reanalyze nil)
 311         (fastp nil))
 312     (loop
 313       (when (component-reanalyze component)
 314         (setq count 0)
 315         (setq cleared-reanalyze t)
 316         (setf (component-reanalyze component) nil))
 317       (setf (component-reoptimize component) nil)
 318       (ir1-optimize component fastp)
 319       (cond ((component-reoptimize component)
 320              (incf count)
 321              (when (and (>= count *max-optimize-iterations*)
 322                         (not (component-reanalyze component))
 323                         (eq (component-reoptimize component) :maybe))
 324                (maybe-mumble "*")
 325                (cond ((retry-delayed-ir1-transforms :optimize)
 326                       (maybe-mumble "+")
 327                       (setq count 0))
 328                      (t
 329                       (event ir1-optimize-maxed-out)
 330                       (setf (component-reoptimize component) nil)
 331                       (do-blocks (block component)
 332                         (setf (block-reoptimize block) nil))
 333                       (return)))))
 334             ((retry-delayed-ir1-transforms :optimize)
 335              (setf count 0)
 336              (maybe-mumble "+"))
 337             (t
 338              (maybe-mumble " ")
 339              (return)))
 340       (setq fastp (>= count *max-optimize-iterations*))
 341       (maybe-mumble (if fastp "-" ".")))
 342     (when cleared-reanalyze
 343       (setf (component-reanalyze component) t)))
 344   (values))
 345
 346 (defparameter *constraint-propagate* t)
 347
 348 ;;; KLUDGE: This was bumped from 5 to 10 in a DTC patch ported by MNA
 349 ;;; from CMU CL into sbcl-0.6.11.44, the same one which allowed IR1
 350 ;;; transforms to be delayed. Either DTC or MNA or both didn't explain
 351 ;;; why, and I don't know what the rationale was. -- WHN 2001-04-28
 352 ;;;
 353 ;;; FIXME: It would be good to document why it's important to have a
 354 ;;; large value here, and what the drawbacks of an excessively large
 355 ;;; value are; and it might also be good to make it depend on
 356 ;;; optimization policy.
 357 (defparameter *reoptimize-after-type-check-max* 10)
 358
 359 (defevent reoptimize-maxed-out
 360   "*REOPTIMIZE-AFTER-TYPE-CHECK-MAX* exceeded.")
 361
 362 ;;; Iterate doing FIND-DFO until no new dead code is discovered.
 363 (defun dfo-as-needed (component)
 364   (declare (type component component))
 365   (when (component-reanalyze component)
 366     (maybe-mumble "DFO")
 367     (loop
 368       (find-dfo component)
 369       (unless (component-reanalyze component)
 370         (maybe-mumble " ")
 371         (return))
 372       (maybe-mumble ".")))
 373   (values))
 374
 375 ;;; Do all the IR1 phases for a non-top-level component.
 376 (defun ir1-phases (component)
 377   (declare (type component component))
 378   (aver-live-component component)
 379   (let ((*constraint-number* 0)
 380         (loop-count 1)
 381         (*delayed-ir1-transforms* nil))
 382     (declare (special *constraint-number* *delayed-ir1-transforms*))
 383     (loop
 384       (ir1-optimize-until-done component)
 385       (when (or (component-new-functionals component)
 386                 (component-reanalyze-functionals component))
 387         (maybe-mumble "locall ")
 388         (locall-analyze-component component))
 389       (dfo-as-needed component)
 390       (when *constraint-propagate*
 391         (maybe-mumble "constraint ")
 392         (constraint-propagate component))
 393       (when (retry-delayed-ir1-transforms :constraint)
 394         (maybe-mumble "Rtran "))
 395       (flet ((want-reoptimization-p ()
 396                (or (component-reoptimize component)
 397                    (component-reanalyze component)
 398                    (component-new-functionals component)
 399                    (component-reanalyze-functionals component))))
 400         (unless (and (want-reoptimization-p)
 401                      ;; We delay the generation of type checks until
 402                      ;; the type constraints have had time to
 403                      ;; propagate, else the compiler can confuse itself.
 404                      (< loop-count (- *reoptimize-after-type-check-max* 4)))
 405           (maybe-mumble "type ")
 406           (generate-type-checks component)
 407           (unless (want-reoptimization-p)
 408             (return))))
 409       (when (>= loop-count *reoptimize-after-type-check-max*)
 410         (maybe-mumble "[reoptimize limit]")
 411         (event reoptimize-maxed-out)
 412         (return))
 413       (incf loop-count)))
 414
 415   (ir1-finalize component)
 416   (values))
 417
 418 (defun %compile-component (component)
 419   (let ((*code-segment* nil)
 420         (*elsewhere* nil))
 421     (maybe-mumble "GTN ")
 422     (gtn-analyze component)
 423     (maybe-mumble "LTN ")
 424     (ltn-analyze component)
 425     (dfo-as-needed component)
 426     (maybe-mumble "control ")
 427     (control-analyze component #'make-ir2-block)
 428
 429     (when (or (ir2-component-values-receivers (component-info component))
 430               (component-dx-lvars component))
 431       (maybe-mumble "stack ")
 432       (stack-analyze component)
 433       ;; Assign BLOCK-NUMBER for any cleanup blocks introduced by
 434       ;; stack analysis. There shouldn't be any unreachable code after
 435       ;; control, so this won't delete anything.
 436       (dfo-as-needed component))
 437
 438     (unwind-protect
 439         (progn
 440           (maybe-mumble "IR2tran ")
 441           (init-assembler)
 442           (entry-analyze component)
 443           (ir2-convert component)
 444
 445           (when (policy *lexenv* (>= speed compilation-speed))
 446             (maybe-mumble "copy ")
 447             (copy-propagate component))
 448
 449           (select-representations component)
 450
 451           (when *check-consistency*
 452             (maybe-mumble "check2 ")
 453             (check-ir2-consistency component))
 454
 455           (delete-unreferenced-tns component)
 456
 457           (maybe-mumble "life ")
 458           (lifetime-analyze component)
 459
 460           (when *compile-progress*
 461             (compiler-mumble "") ; Sync before doing more output.
 462             (pre-pack-tn-stats component *standard-output*))
 463
 464           (when *check-consistency*
 465             (maybe-mumble "check-life ")
 466             (check-life-consistency component))
 467
 468           (maybe-mumble "pack ")
 469           (pack component)
 470
 471           (when *check-consistency*
 472             (maybe-mumble "check-pack ")
 473             (check-pack-consistency component))
 474
 475           (when *compiler-trace-output*
 476             (describe-component component *compiler-trace-output*)
 477             (describe-ir2-component component *compiler-trace-output*))
 478
 479           (maybe-mumble "code ")
 480           (multiple-value-bind (code-length trace-table fixup-notes)
 481               (generate-code component)
 482
 483             #-sb-xc-host
 484             (when *compiler-trace-output*
 485               (format *compiler-trace-output*
 486                       "~|~%disassembly of code for ~S~2%" component)
 487               (sb!disassem:disassemble-assem-segment *code-segment*
 488                                                      *compiler-trace-output*))
 489
 490             (etypecase *compile-object*
 491               (fasl-output
 492                (maybe-mumble "fasl")
 493                (fasl-dump-component component
 494                                     *code-segment*
 495                                     code-length
 496                                     trace-table
 497                                     fixup-notes
 498                                     *compile-object*))
 499               (core-object
 500                (maybe-mumble "core")
 501                (make-core-component component
 502                                     *code-segment*
 503                                     code-length
 504                                     trace-table
 505                                     fixup-notes
 506                                     *compile-object*))
 507               (null))))))
 508
 509   ;; We're done, so don't bother keeping anything around.
 510   (setf (component-info component) :dead)
 511
 512   (values))
 513
 514 ;;; Delete components with no external entry points before we try to
 515 ;;; generate code. Unreachable closures can cause IR2 conversion to
 516 ;;; puke on itself, since it is the reference to the closure which
 517 ;;; normally causes the components to be combined.
 518 (defun delete-if-no-entries (component)
 519   (dolist (fun (component-lambdas component) (delete-component component))
 520     (when (functional-has-external-references-p fun)
 521       (return))
 522     (case (functional-kind fun)
 523       (:toplevel (return))
 524       (:external
 525        (unless (every (lambda (ref)
 526                         (eq (node-component ref) component))
 527                       (leaf-refs fun))
 528          (return))))))
 529
 530 (defun compile-component (component)
 531
 532   ;; miscellaneous sanity checks
 533   ;;
 534   ;; FIXME: These are basically pretty wimpy compared to the checks done
 535   ;; by the old CHECK-IR1-CONSISTENCY code. It would be really nice to
 536   ;; make those internal consistency checks work again and use them.
 537   (aver-live-component component)
 538   (do-blocks (block component)
 539     (aver (eql (block-component block) component)))
 540   (dolist (lambda (component-lambdas component))
 541     ;; sanity check to prevent weirdness from propagating insidiously as
 542     ;; far from its root cause as it did in bug 138: Make sure that
 543     ;; thing-to-COMPONENT links are consistent.
 544     (aver (eql (lambda-component lambda) component))
 545     (aver (eql (node-component (lambda-bind lambda)) component)))
 546
 547   (let* ((*component-being-compiled* component))
 548
 549     ;; Record xref information before optimization. This way the
 550     ;; stored xref data reflects the real source as closely as
 551     ;; possible.
 552     (record-component-xrefs component)
 553
 554     (ir1-phases component)
 555
 556     (when *loop-analyze*
 557       (dfo-as-needed component)
 558       (find-dominators component)
 559       (loop-analyze component))
 560
 561     #|
 562     (when (and *loop-analyze* *compiler-trace-output*)
 563       (labels ((print-blocks (block)
 564                  (format *compiler-trace-output* "    ~A~%" block)
 565                  (when (block-loop-next block)
 566                    (print-blocks (block-loop-next block))))
 567                (print-loop (loop)
 568                  (format *compiler-trace-output* "loop=~A~%" loop)
 569                  (print-blocks (loop-blocks loop))
 570                  (dolist (l (loop-inferiors loop))
 571                    (print-loop l))))
 572         (print-loop (component-outer-loop component))))
 573     |#
 574
 575     ;; FIXME: What is MAYBE-MUMBLE for? Do we need it any more?
 576     (maybe-mumble "env ")
 577     (physenv-analyze component)
 578     (dfo-as-needed component)
 579
 580     (delete-if-no-entries component)
 581
 582     (unless (eq (block-next (component-head component))
 583                 (component-tail component))
 584       (%compile-component component)))
 585
 586   (clear-constant-info)
 587
 588   (values))
 589 \f
 590 ;;;; clearing global data structures
 591 ;;;;
 592 ;;;; FIXME: Is it possible to get rid of this stuff, getting rid of
 593 ;;;; global data structures entirely when possible and consing up the
 594 ;;;; others from scratch instead of clearing and reusing them?
 595
 596 ;;; Clear the INFO in constants in the *FREE-VARS*, etc. In
 597 ;;; addition to allowing stuff to be reclaimed, this is required for
 598 ;;; correct assignment of constant offsets, since we need to assign a
 599 ;;; new offset for each component. We don't clear the FUNCTIONAL-INFO
 600 ;;; slots, since they are used to keep track of functions across
 601 ;;; component boundaries.
 602 (defun clear-constant-info ()
 603   (maphash (lambda (k v)
 604              (declare (ignore k))
 605              (setf (leaf-info v) nil))
 606            *constants*)
 607   (maphash (lambda (k v)
 608              (declare (ignore k))
 609              (when (constant-p v)
 610                (setf (leaf-info v) nil)))
 611            *free-vars*)
 612   (values))
 613
 614 ;;; Blow away the REFS for all global variables, and let COMPONENT
 615 ;;; be recycled.
 616 (defun clear-ir1-info (component)
 617   (declare (type component component))
 618   (labels ((blast (x)
 619              (maphash (lambda (k v)
 620                         (declare (ignore k))
 621                         (when (leaf-p v)
 622                           (setf (leaf-refs v)
 623                                 (delete-if #'here-p (leaf-refs v)))
 624                           (when (basic-var-p v)
 625                             (setf (basic-var-sets v)
 626                                   (delete-if #'here-p (basic-var-sets v))))))
 627                       x))
 628            (here-p (x)
 629              (eq (node-component x) component)))
 630     (blast *free-vars*)
 631     (blast *free-funs*)
 632     (blast *constants*))
 633   (values))
 634
 635 ;;; Clear global variables used by the compiler.
 636 ;;;
 637 ;;; FIXME: It seems kinda nasty and unmaintainable to have to do this,
 638 ;;; and it adds overhead even when people aren't using the compiler.
 639 ;;; Perhaps we could make these global vars unbound except when
 640 ;;; actually in use, so that this function could go away.
 641 (defun clear-stuff (&optional (debug-too t))
 642
 643   ;; Clear global tables.
 644   (when (boundp '*free-funs*)
 645     (clrhash *free-funs*)
 646     (clrhash *free-vars*)
 647     (clrhash *constants*))
 648
 649   ;; Clear debug counters and tables.
 650   (clrhash *seen-blocks*)
 651   (clrhash *seen-funs*)
 652   (clrhash *list-conflicts-table*)
 653
 654   (when debug-too
 655     (clrhash *continuation-numbers*)
 656     (clrhash *number-continuations*)
 657     (setq *continuation-number* 0)
 658     (clrhash *tn-ids*)
 659     (clrhash *id-tns*)
 660     (setq *tn-id* 0)
 661     (clrhash *label-ids*)
 662     (clrhash *id-labels*)
 663     (setq *label-id* 0))
 664
 665   ;; (Note: The CMU CL code used to set CL::*GENSYM-COUNTER* to zero here.
 666   ;; Superficially, this seemed harmful -- the user could reasonably be
 667   ;; surprised if *GENSYM-COUNTER* turned back to zero when something was
 668   ;; compiled. A closer inspection showed that this actually turned out to be
 669   ;; harmless in practice, because CLEAR-STUFF was only called from within
 670   ;; forms which bound CL::*GENSYM-COUNTER* to zero. However, this means that
 671   ;; even though zeroing CL::*GENSYM-COUNTER* here turned out to be harmless in
 672   ;; practice, it was also useless in practice. So we don't do it any more.)
 673
 674   (values))
 675 \f
 676 ;;;; trace output
 677
 678 ;;; Print out some useful info about COMPONENT to STREAM.
 679 (defun describe-component (component *standard-output*)
 680   (declare (type component component))
 681   (format t "~|~%;;;; component: ~S~2%" (component-name component))
 682   (print-all-blocks component)
 683   (values))
 684
 685 (defun describe-ir2-component (component *standard-output*)
 686   (format t "~%~|~%;;;; IR2 component: ~S~2%" (component-name component))
 687   (format t "entries:~%")
 688   (dolist (entry (ir2-component-entries (component-info component)))
 689     (format t "~4TL~D: ~S~:[~; [closure]~]~%"
 690             (label-id (entry-info-offset entry))
 691             (entry-info-name entry)
 692             (entry-info-closure-tn entry)))
 693   (terpri)
 694   (pre-pack-tn-stats component *standard-output*)
 695   (terpri)
 696   (print-ir2-blocks component)
 697   (terpri)
 698   (values))
 699 \f
 700 ;;;; file reading
 701 ;;;;
 702 ;;;; When reading from a file, we have to keep track of some source
 703 ;;;; information. We also exploit our ability to back up for printing
 704 ;;;; the error context and for recovering from errors.
 705 ;;;;
 706 ;;;; The interface we provide to this stuff is the stream-oid
 707 ;;;; SOURCE-INFO structure. The bookkeeping is done as a side effect
 708 ;;;; of getting the next source form.
 709
 710 ;;; A FILE-INFO structure holds all the source information for a
 711 ;;; given file.
 712 (def!struct (file-info (:copier nil))
 713   ;; If a file, the truename of the corresponding source file. If from
 714   ;; a Lisp form, :LISP. If from a stream, :STREAM.
 715   (name (missing-arg) :type (or pathname (member :lisp :stream)))
 716   ;; the external format that we'll call OPEN with, if NAME is a file.
 717   (external-format nil)
 718   ;; the defaulted, but not necessarily absolute file name (i.e. prior
 719   ;; to TRUENAME call.) Null if not a file. This is used to set
 720   ;; *COMPILE-FILE-PATHNAME*, and if absolute, is dumped in the
 721   ;; debug-info.
 722   (untruename nil :type (or pathname null))
 723   ;; the file's write date (if relevant)
 724   (write-date nil :type (or unsigned-byte null))
 725   ;; the source path root number of the first form in this file (i.e.
 726   ;; the total number of forms converted previously in this
 727   ;; compilation)
 728   (source-root 0 :type unsigned-byte)
 729   ;; parallel vectors containing the forms read out of the file and
 730   ;; the file positions that reading of each form started at (i.e. the
 731   ;; end of the previous form)
 732   (forms (make-array 10 :fill-pointer 0 :adjustable t) :type (vector t))
 733   (positions (make-array 10 :fill-pointer 0 :adjustable t) :type (vector t)))
 734
 735 ;;; The SOURCE-INFO structure provides a handle on all the source
 736 ;;; information for an entire compilation.
 737 (def!struct (source-info
 738              #-no-ansi-print-object
 739              (:print-object (lambda (s stream)
 740                               (print-unreadable-object (s stream :type t))))
 741              (:copier nil))
 742   ;; the UT that compilation started at
 743   (start-time (get-universal-time) :type unsigned-byte)
 744   ;; the FILE-INFO structure for this compilation
 745   (file-info nil :type (or file-info null))
 746   ;; the stream that we are using to read the FILE-INFO, or NIL if
 747   ;; no stream has been opened yet
 748   (stream nil :type (or stream null)))
 749
 750 ;;; Given a pathname, return a SOURCE-INFO structure.
 751 (defun make-file-source-info (file external-format)
 752   (let ((file-info (make-file-info :name (truename file)
 753                                    :untruename (merge-pathnames file)
 754                                    :external-format external-format
 755                                    :write-date (file-write-date file))))
 756
 757     (make-source-info :file-info file-info)))
 758
 759 ;;; Return a SOURCE-INFO to describe the incremental compilation of FORM.
 760 (defun make-lisp-source-info (form)
 761   (make-source-info :start-time (get-universal-time)
 762                     :file-info (make-file-info :name :lisp
 763                                                :forms (vector form)
 764                                                :positions '#(0))))
 765
 766 ;;; Return a SOURCE-INFO which will read from STREAM.
 767 (defun make-stream-source-info (stream)
 768   (let ((file-info (make-file-info :name :stream)))
 769     (make-source-info :file-info file-info
 770                       :stream stream)))
 771
 772 ;;; Return a form read from STREAM; or for EOF use the trick,
 773 ;;; popularized by Kent Pitman, of returning STREAM itself. If an
 774 ;;; error happens, then convert it to standard abort-the-compilation
 775 ;;; error condition (possibly recording some extra location
 776 ;;; information).
 777 (defun read-for-compile-file (stream position)
 778   (handler-case (read stream nil stream)
 779     (reader-error (condition)
 780      (error 'input-error-in-compile-file
 781             :condition condition
 782             ;; We don't need to supply :POSITION here because
 783             ;; READER-ERRORs already know their position in the file.
 784             ))
 785     ;; ANSI, in its wisdom, says that READ should return END-OF-FILE
 786     ;; (and that this is not a READER-ERROR) when it encounters end of
 787     ;; file in the middle of something it's trying to read.
 788     (end-of-file (condition)
 789      (error 'input-error-in-compile-file
 790             :condition condition
 791             ;; We need to supply :POSITION here because the END-OF-FILE
 792             ;; condition doesn't carry the position that the user
 793             ;; probably cares about, where the failed READ began.
 794             :position position))))
 795
 796 ;;; If STREAM is present, return it, otherwise open a stream to the
 797 ;;; current file. There must be a current file.
 798 ;;;
 799 ;;; FIXME: This is probably an unnecessarily roundabout way to do
 800 ;;; things now that we process a single file in COMPILE-FILE (unlike
 801 ;;; the old CMU CL code, which accepted multiple files). Also, the old
 802 ;;; comment said
 803 ;;;   When we open a new file, we also reset *PACKAGE* and policy.
 804 ;;;   This gives the effect of rebinding around each file.
 805 ;;; which doesn't seem to be true now. Check to make sure that if
 806 ;;; such rebinding is necessary, it's still done somewhere.
 807 (defun get-source-stream (info)
 808   (declare (type source-info info))
 809   (or (source-info-stream info)
 810       (let* ((file-info (source-info-file-info info))
 811              (name (file-info-name file-info))
 812              (external-format (file-info-external-format file-info)))
 813         (setf sb!xc:*compile-file-truename* name
 814               sb!xc:*compile-file-pathname* (file-info-untruename file-info)
 815               (source-info-stream info)
 816               (open name :direction :input
 817                     :external-format external-format)))))
 818
 819 ;;; Close the stream in INFO if it is open.
 820 (defun close-source-info (info)
 821   (declare (type source-info info))
 822   (let ((stream (source-info-stream info)))
 823     (when stream (close stream)))
 824   (setf (source-info-stream info) nil)
 825   (values))
 826
 827 ;;; Read and compile the source file.
 828 (defun sub-sub-compile-file (info)
 829   (let* ((file-info (source-info-file-info info))
 830          (stream (get-source-stream info)))
 831     (loop
 832      (let* ((pos (file-position stream))
 833             (form (read-for-compile-file stream pos)))
 834        (if (eq form stream) ; i.e., if EOF
 835            (return)
 836            (let* ((forms (file-info-forms file-info))
 837                   (current-idx (+ (fill-pointer forms)
 838                                   (file-info-source-root file-info))))
 839              (vector-push-extend form forms)
 840              (vector-push-extend pos (file-info-positions file-info))
 841              (find-source-paths form current-idx)
 842              (process-toplevel-form form
 843                                     `(original-source-start 0 ,current-idx)
 844                                     nil)))))))
 845
 846 ;;; Return the INDEX'th source form read from INFO and the position
 847 ;;; where it was read.
 848 (defun find-source-root (index info)
 849   (declare (type index index) (type source-info info))
 850   (let ((file-info (source-info-file-info info)))
 851     (values (aref (file-info-forms file-info) index)
 852             (aref (file-info-positions file-info) index))))
 853 \f
 854 ;;;; processing of top level forms
 855
 856 ;;; This is called by top level form processing when we are ready to
 857 ;;; actually compile something. If *BLOCK-COMPILE* is T, then we still
 858 ;;; convert the form, but delay compilation, pushing the result on
 859 ;;; *TOPLEVEL-LAMBDAS* instead.
 860 (defun convert-and-maybe-compile (form path)
 861   (declare (list path))
 862   (if (fopcompilable-p form)
 863       (let ((*fopcompile-label-counter* 0))
 864         (fopcompile form path nil))
 865       (let* ((*top-level-form-noted* (note-top-level-form form t))
 866              (*lexenv* (make-lexenv
 867                         :policy *policy*
 868                         :handled-conditions *handled-conditions*
 869                         :disabled-package-locks *disabled-package-locks*))
 870              (tll (ir1-toplevel form path nil)))
 871         (if (eq *block-compile* t)
 872             (push tll *toplevel-lambdas*)
 873             (compile-toplevel (list tll) nil))
 874         nil)))
 875
 876 ;;; Macroexpand FORM in the current environment with an error handler.
 877 ;;; We only expand one level, so that we retain all the intervening
 878 ;;; forms in the source path.
 879 (defun preprocessor-macroexpand-1 (form)
 880   (handler-case (sb!xc:macroexpand-1 form *lexenv*)
 881     (error (condition)
 882       (compiler-error "(during macroexpansion of ~A)~%~A"
 883                       (let ((*print-level* 2)
 884                             (*print-length* 2))
 885                         (format nil "~S" form))
 886                       condition))))
 887
 888 ;;; Process a PROGN-like portion of a top level form. FORMS is a list of
 889 ;;; the forms, and PATH is the source path of the FORM they came out of.
 890 ;;; COMPILE-TIME-TOO is as in ANSI "3.2.3.1 Processing of Top Level Forms".
 891 (defun process-toplevel-progn (forms path compile-time-too)
 892   (declare (list forms) (list path))
 893   (dolist (form forms)
 894     (process-toplevel-form form path compile-time-too)))
 895
 896 ;;; Process a top level use of LOCALLY, or anything else (e.g.
 897 ;;; MACROLET) at top level which has declarations and ordinary forms.
 898 ;;; We parse declarations and then recursively process the body.
 899 (defun process-toplevel-locally (body path compile-time-too &key vars funs)
 900   (declare (list path))
 901   (multiple-value-bind (forms decls)
 902       (parse-body body :doc-string-allowed nil :toplevel t)
 903     (let* ((*lexenv* (process-decls decls vars funs))
 904            ;; FIXME: VALUES declaration
 905            ;;
 906            ;; Binding *POLICY* is pretty much of a hack, since it
 907            ;; causes LOCALLY to "capture" enclosed proclamations. It
 908            ;; is necessary because CONVERT-AND-MAYBE-COMPILE uses the
 909            ;; value of *POLICY* as the policy. The need for this hack
 910            ;; is due to the quirk that there is no way to represent in
 911            ;; a POLICY that an optimize quality came from the default.
 912            ;;
 913            ;; FIXME: Ideally, something should be done so that DECLAIM
 914            ;; inside LOCALLY works OK. Failing that, at least we could
 915            ;; issue a warning instead of silently screwing up.
 916            (*policy* (lexenv-policy *lexenv*))
 917            ;; This is probably also a hack
 918            (*handled-conditions* (lexenv-handled-conditions *lexenv*))
 919            ;; ditto
 920            (*disabled-package-locks* (lexenv-disabled-package-locks *lexenv*)))
 921       (process-toplevel-progn forms path compile-time-too))))
 922
 923 ;;; Parse an EVAL-WHEN situations list, returning three flags,
 924 ;;; (VALUES COMPILE-TOPLEVEL LOAD-TOPLEVEL EXECUTE), indicating
 925 ;;; the types of situations present in the list.
 926 (defun parse-eval-when-situations (situations)
 927   (when (or (not (listp situations))
 928             (set-difference situations
 929                             '(:compile-toplevel
 930                               compile
 931                               :load-toplevel
 932                               load
 933                               :execute
 934                               eval)))
 935     (compiler-error "bad EVAL-WHEN situation list: ~S" situations))
 936   (let ((deprecated-names (intersection situations '(compile load eval))))
 937     (when deprecated-names
 938       (style-warn "using deprecated EVAL-WHEN situation names~{ ~S~}"
 939                   deprecated-names)))
 940   (values (intersection '(:compile-toplevel compile)
 941                         situations)
 942           (intersection '(:load-toplevel load) situations)
 943           (intersection '(:execute eval) situations)))
 944
 945
 946 ;;; utilities for extracting COMPONENTs of FUNCTIONALs
 947 (defun functional-components (f)
 948   (declare (type functional f))
 949   (etypecase f
 950     (clambda (list (lambda-component f)))
 951     (optional-dispatch (let ((result nil))
 952                          (flet ((maybe-frob (maybe-clambda)
 953                                   (when (and maybe-clambda
 954                                              (promise-ready-p maybe-clambda))
 955                                     (pushnew (lambda-component
 956                                               (force maybe-clambda))
 957                                              result))))
 958                            (map nil #'maybe-frob (optional-dispatch-entry-points f))
 959                            (maybe-frob (optional-dispatch-more-entry f))
 960                            (maybe-frob (optional-dispatch-main-entry f)))
 961                          result))))
 962
 963 (defun make-functional-from-toplevel-lambda (definition
 964                                              &key
 965                                              name
 966                                              (path
 967                                               ;; I'd thought NIL should
 968                                               ;; work, but it doesn't.
 969                                               ;; -- WHN 2001-09-20
 970                                               (missing-arg)))
 971   (let* ((*current-path* path)
 972          (component (make-empty-component))
 973          (*current-component* component))
 974     (setf (component-name component)
 975           (debug-name 'initial-component name))
 976     (setf (component-kind component) :initial)
 977     (let* ((locall-fun (let ((*allow-instrumenting* t))
 978                          (funcall #'ir1-convert-lambdalike
 979                                   definition
 980                                   :source-name name)))
 981            (debug-name (debug-name 'tl-xep name))
 982            (fun (ir1-convert-lambda (make-xep-lambda-expression locall-fun)
 983                                     :source-name (or name '.anonymous.)
 984                                     :debug-name debug-name)))
 985       (when name
 986         (assert-global-function-definition-type name locall-fun))
 987       (setf (functional-entry-fun fun) locall-fun
 988             (functional-kind fun) :external
 989             (functional-has-external-references-p locall-fun) t
 990             (functional-has-external-references-p fun) t)
 991       fun)))
 992
 993 ;;; Compile LAMBDA-EXPRESSION into *COMPILE-OBJECT*, returning a
 994 ;;; description of the result.
 995 ;;;   * If *COMPILE-OBJECT* is a CORE-OBJECT, then write the function
 996 ;;;     into core and return the compiled FUNCTION value.
 997 ;;;   * If *COMPILE-OBJECT* is a fasl file, then write the function
 998 ;;;     into the fasl file and return a dump handle.
 999 ;;;
1000 ;;; If NAME is provided, then we try to use it as the name of the
1001 ;;; function for debugging/diagnostic information.
1002 (defun %compile (lambda-expression
1003                  *compile-object*
1004                  &key
1005                  name
1006                  (path
1007                   ;; This magical idiom seems to be the appropriate
1008                   ;; path for compiling standalone LAMBDAs, judging
1009                   ;; from the CMU CL code and experiment, so it's a
1010                   ;; nice default for things where we don't have a
1011                   ;; real source path (as in e.g. inside CL:COMPILE).
1012                   '(original-source-start 0 0)))
1013   (when name
1014     (legal-fun-name-or-type-error name))
1015   (let* ((*lexenv* (make-lexenv
1016                     :policy *policy*
1017                     :handled-conditions *handled-conditions*
1018                     :disabled-package-locks *disabled-package-locks*))
1019          (*compiler-sset-counter* 0)
1020          (fun (make-functional-from-toplevel-lambda lambda-expression
1021                                                     :name name
1022                                                     :path path)))
1023
1024     ;; FIXME: The compile-it code from here on is sort of a
1025     ;; twisted version of the code in COMPILE-TOPLEVEL. It'd be
1026     ;; better to find a way to share the code there; or
1027     ;; alternatively, to use this code to replace the code there.
1028     ;; (The second alternative might be pretty easy if we used
1029     ;; the :LOCALL-ONLY option to IR1-FOR-LAMBDA. Then maybe the
1030     ;; whole FUNCTIONAL-KIND=:TOPLEVEL case could go away..)
1031
1032     (locall-analyze-clambdas-until-done (list fun))
1033
1034     (multiple-value-bind (components-from-dfo top-components hairy-top)
1035         (find-initial-dfo (list fun))
1036       (declare (ignore hairy-top))
1037
1038       (let ((*all-components* (append components-from-dfo top-components)))
1039         (dolist (component-from-dfo components-from-dfo)
1040           (compile-component component-from-dfo)
1041           (replace-toplevel-xeps component-from-dfo)))
1042
1043       (let ((entry-table (etypecase *compile-object*
1044                            (fasl-output (fasl-output-entry-table
1045                                          *compile-object*))
1046                            (core-object (core-object-entry-table
1047                                          *compile-object*)))))
1048         (multiple-value-bind (result found-p)
1049             (gethash (leaf-info fun) entry-table)
1050           (aver found-p)
1051           (prog1
1052               result
1053             ;; KLUDGE: This code duplicates some other code in this
1054             ;; file. In the great reorganzation, the flow of program
1055             ;; logic changed from the original CMUCL model, and that
1056             ;; path (as of sbcl-0.7.5 in SUB-COMPILE-FILE) was no
1057             ;; longer followed for CORE-OBJECTS, leading to BUG
1058             ;; 156. This place is transparently not the right one for
1059             ;; this code, but I don't have a clear enough overview of
1060             ;; the compiler to know how to rearrange it all so that
1061             ;; this operation fits in nicely, and it was blocking
1062             ;; reimplementation of (DECLAIM (INLINE FOO)) (MACROLET
1063             ;; ((..)) (DEFUN FOO ...))
1064             ;;
1065             ;; FIXME: This KLUDGE doesn't solve all the problem in an
1066             ;; ideal way, as (1) definitions typed in at the REPL
1067             ;; without an INLINE declaration will give a NULL
1068             ;; FUNCTION-LAMBDA-EXPRESSION (allowable, but not ideal)
1069             ;; and (2) INLINE declarations will yield a
1070             ;; FUNCTION-LAMBDA-EXPRESSION headed by
1071             ;; SB-C:LAMBDA-WITH-LEXENV, even for null LEXENV.  -- CSR,
1072             ;; 2002-07-02
1073             ;;
1074             ;; (2) is probably fairly easy to fix -- it is, after all,
1075             ;; a matter of list manipulation (or possibly of teaching
1076             ;; CL:FUNCTION about SB-C:LAMBDA-WITH-LEXENV).  (1) is
1077             ;; significantly harder, as the association between
1078             ;; function object and source is a tricky one.
1079             ;;
1080             ;; FUNCTION-LAMBDA-EXPRESSION "works" (i.e. returns a
1081             ;; non-NULL list) when the function in question has been
1082             ;; compiled by (COMPILE <x> '(LAMBDA ...)); it does not
1083             ;; work when it has been compiled as part of the top-level
1084             ;; EVAL strategy of compiling everything inside (LAMBDA ()
1085             ;; ...).  -- CSR, 2002-11-02
1086             (when (core-object-p *compile-object*)
1087               (fix-core-source-info *source-info* *compile-object* result))
1088
1089             (mapc #'clear-ir1-info components-from-dfo)
1090             (clear-stuff)))))))
1091
1092 (defun process-toplevel-cold-fset (name lambda-expression path)
1093   (unless (producing-fasl-file)
1094     (error "can't COLD-FSET except in a fasl file"))
1095   (legal-fun-name-or-type-error name)
1096   (fasl-dump-cold-fset name
1097                        (%compile lambda-expression
1098                                  *compile-object*
1099                                  :name name
1100                                  :path path)
1101                        *compile-object*)
1102   (values))
1103
1104 (defun note-top-level-form (form &optional finalp)
1105   (when *compile-print*
1106     (cond ((not *top-level-form-noted*)
1107            (let ((*print-length* 2)
1108                  (*print-level* 2)
1109                  (*print-pretty* nil))
1110              (with-compiler-io-syntax
1111                  (compiler-mumble "~&; ~:[compiling~;converting~] ~S"
1112                                   *block-compile* form)))
1113              form)
1114           ((and finalp
1115                 (eq :top-level-forms *compile-print*)
1116                 (neq form *top-level-form-noted*))
1117            (let ((*print-length* 1)
1118                  (*print-level* 1)
1119                  (*print-pretty* nil))
1120              (with-compiler-io-syntax
1121                  (compiler-mumble "~&; ... top level ~S" form)))
1122            form)
1123           (t
1124            *top-level-form-noted*))))
1125
1126 ;;; Process a top level FORM with the specified source PATH.
1127 ;;;  * If this is a magic top level form, then do stuff.
1128 ;;;  * If this is a macro, then expand it.
1129 ;;;  * Otherwise, just compile it.
1130 ;;;
1131 ;;; COMPILE-TIME-TOO is as defined in ANSI
1132 ;;; "3.2.3.1 Processing of Top Level Forms".
1133 (defun process-toplevel-form (form path compile-time-too)
1134   (declare (list path))
1135
1136   (catch 'process-toplevel-form-error-abort
1137     (let* ((path (or (gethash form *source-paths*) (cons form path)))
1138            (*compiler-error-bailout*
1139             (lambda (&optional condition)
1140               (convert-and-maybe-compile
1141                (make-compiler-error-form condition form)
1142                path)
1143               (throw 'process-toplevel-form-error-abort nil))))
1144
1145       (flet ((default-processor (form)
1146                (let ((*top-level-form-noted* (note-top-level-form form)))
1147                  ;; When we're cross-compiling, consider: what should we
1148                  ;; do when we hit e.g.
1149                  ;;   (EVAL-WHEN (:COMPILE-TOPLEVEL)
1150                  ;;     (DEFUN FOO (X) (+ 7 X)))?
1151                  ;; DEFUN has a macro definition in the cross-compiler,
1152                  ;; and a different macro definition in the target
1153                  ;; compiler. The only sensible thing is to use the
1154                  ;; target compiler's macro definition, since the
1155                  ;; cross-compiler's macro is in general into target
1156                  ;; functions which can't meaningfully be executed at
1157                  ;; cross-compilation time. So make sure we do the EVAL
1158                  ;; here, before we macroexpand.
1159                  ;;
1160                  ;; Then things get even dicier with something like
1161                  ;;   (DEFCONSTANT-EQX SB!XC:LAMBDA-LIST-KEYWORDS ..)
1162                  ;; where we have to make sure that we don't uncross
1163                  ;; the SB!XC: prefix before we do EVAL, because otherwise
1164                  ;; we'd be trying to redefine the cross-compilation host's
1165                  ;; constants.
1166                  ;;
1167                  ;; (Isn't it fun to cross-compile Common Lisp?:-)
1168                  #+sb-xc-host
1169                  (progn
1170                    (when compile-time-too
1171                      (eval form)) ; letting xc host EVAL do its own macroexpansion
1172                    (let* (;; (We uncross the operator name because things
1173                           ;; like SB!XC:DEFCONSTANT and SB!XC:DEFTYPE
1174                           ;; should be equivalent to their CL: counterparts
1175                           ;; when being compiled as target code. We leave
1176                           ;; the rest of the form uncrossed because macros
1177                           ;; might yet expand into EVAL-WHEN stuff, and
1178                           ;; things inside EVAL-WHEN can't be uncrossed
1179                           ;; until after we've EVALed them in the
1180                           ;; cross-compilation host.)
1181                           (slightly-uncrossed (cons (uncross (first form))
1182                                                     (rest form)))
1183                           (expanded (preprocessor-macroexpand-1
1184                                      slightly-uncrossed)))
1185                      (if (eq expanded slightly-uncrossed)
1186                          ;; (Now that we're no longer processing toplevel
1187                          ;; forms, and hence no longer need to worry about
1188                          ;; EVAL-WHEN, we can uncross everything.)
1189                          (convert-and-maybe-compile expanded path)
1190                          ;; (We have to demote COMPILE-TIME-TOO to NIL
1191                          ;; here, no matter what it was before, since
1192                          ;; otherwise we'd tend to EVAL subforms more than
1193                          ;; once, because of WHEN COMPILE-TIME-TOO form
1194                          ;; above.)
1195                          (process-toplevel-form expanded path nil))))
1196                  ;; When we're not cross-compiling, we only need to
1197                  ;; macroexpand once, so we can follow the 1-thru-6
1198                  ;; sequence of steps in ANSI's "3.2.3.1 Processing of
1199                  ;; Top Level Forms".
1200                  #-sb-xc-host
1201                  (let ((expanded
1202                         (let ((*current-path* path))
1203                           (preprocessor-macroexpand-1 form))))
1204                    (cond ((eq expanded form)
1205                           (when compile-time-too
1206                             (eval-in-lexenv form *lexenv*))
1207                           (convert-and-maybe-compile form path))
1208                          (t
1209                           (process-toplevel-form expanded
1210                                                  path
1211                                                  compile-time-too)))))))
1212         (if (atom form)
1213             #+sb-xc-host
1214             ;; (There are no xc EVAL-WHEN issues in the ATOM case until
1215             ;; (1) SBCL gets smart enough to handle global
1216             ;; DEFINE-SYMBOL-MACRO or SYMBOL-MACROLET and (2) SBCL
1217             ;; implementors start using symbol macros in a way which
1218             ;; interacts with SB-XC/CL distinction.)
1219             (convert-and-maybe-compile form path)
1220             #-sb-xc-host
1221             (default-processor form)
1222             (flet ((need-at-least-one-arg (form)
1223                      (unless (cdr form)
1224                        (compiler-error "~S form is too short: ~S"
1225                                        (car form)
1226                                        form))))
1227               (case (car form)
1228                 ;; In the cross-compiler, top level COLD-FSET arranges
1229                 ;; for static linking at cold init time.
1230                 #+sb-xc-host
1231                 ((cold-fset)
1232                  (aver (not compile-time-too))
1233                  (destructuring-bind (cold-fset fun-name lambda-expression) form
1234                    (declare (ignore cold-fset))
1235                    (process-toplevel-cold-fset fun-name
1236                                                lambda-expression
1237                                                path)))
1238                 ((eval-when macrolet symbol-macrolet);things w/ 1 arg before body
1239                  (need-at-least-one-arg form)
1240                  (destructuring-bind (special-operator magic &rest body) form
1241                    (ecase special-operator
1242                      ((eval-when)
1243                       ;; CT, LT, and E here are as in Figure 3-7 of ANSI
1244                       ;; "3.2.3.1 Processing of Top Level Forms".
1245                       (multiple-value-bind (ct lt e)
1246                           (parse-eval-when-situations magic)
1247                         (let ((new-compile-time-too (or ct
1248                                                         (and compile-time-too
1249                                                              e))))
1250                           (cond (lt (process-toplevel-progn
1251                                      body path new-compile-time-too))
1252                                 (new-compile-time-too (eval-in-lexenv
1253                                                        `(progn ,@body)
1254                                                        *lexenv*))))))
1255                      ((macrolet)
1256                       (funcall-in-macrolet-lexenv
1257                        magic
1258                        (lambda (&key funs prepend)
1259                          (declare (ignore funs))
1260                          (aver (null prepend))
1261                          (process-toplevel-locally body
1262                                                    path
1263                                                    compile-time-too))
1264                        :compile))
1265                      ((symbol-macrolet)
1266                       (funcall-in-symbol-macrolet-lexenv
1267                        magic
1268                        (lambda (&key vars prepend)
1269                          (aver (null prepend))
1270                          (process-toplevel-locally body
1271                                                    path
1272                                                    compile-time-too
1273                                                    :vars vars))
1274                        :compile)))))
1275                 ((locally)
1276                  (process-toplevel-locally (rest form) path compile-time-too))
1277                 ((progn)
1278                  (process-toplevel-progn (rest form) path compile-time-too))
1279                 (t (default-processor form))))))))
1280
1281   (values))
1282 \f
1283 ;;;; load time value support
1284 ;;;;
1285 ;;;; (See EMIT-MAKE-LOAD-FORM.)
1286
1287 ;;; Return T if we are currently producing a fasl file and hence
1288 ;;; constants need to be dumped carefully.
1289 (defun producing-fasl-file ()
1290   (fasl-output-p *compile-object*))
1291
1292 ;;; Compile FORM and arrange for it to be called at load-time. Return
1293 ;;; the dumper handle and our best guess at the type of the object.
1294 (defun compile-load-time-value (form)
1295   (let ((lambda (compile-load-time-stuff form t)))
1296     (values
1297      (fasl-dump-load-time-value-lambda lambda *compile-object*)
1298      (let ((type (leaf-type lambda)))
1299        (if (fun-type-p type)
1300            (single-value-type (fun-type-returns type))
1301            *wild-type*)))))
1302
1303 ;;; Compile the FORMS and arrange for them to be called (for effect,
1304 ;;; not value) at load time.
1305 (defun compile-make-load-form-init-forms (forms)
1306   (let ((lambda (compile-load-time-stuff `(progn ,@forms) nil)))
1307     (fasl-dump-toplevel-lambda-call lambda *compile-object*)))
1308
1309 ;;; Do the actual work of COMPILE-LOAD-TIME-VALUE or
1310 ;;; COMPILE-MAKE-LOAD-FORM-INIT-FORMS.
1311 (defun compile-load-time-stuff (form for-value)
1312   (with-ir1-namespace
1313    (let* ((*lexenv* (make-null-lexenv))
1314           (lambda (ir1-toplevel form *current-path* for-value)))
1315      (compile-toplevel (list lambda) t)
1316      lambda)))
1317
1318 ;;; This is called by COMPILE-TOPLEVEL when it was passed T for
1319 ;;; LOAD-TIME-VALUE-P (which happens in COMPILE-LOAD-TIME-STUFF). We
1320 ;;; don't try to combine this component with anything else and frob
1321 ;;; the name. If not in a :TOPLEVEL component, then don't bother
1322 ;;; compiling, because it was merged with a run-time component.
1323 (defun compile-load-time-value-lambda (lambdas)
1324   (aver (null (cdr lambdas)))
1325   (let* ((lambda (car lambdas))
1326          (component (lambda-component lambda)))
1327     (when (eql (component-kind component) :toplevel)
1328       (setf (component-name component) (leaf-debug-name lambda))
1329       (compile-component component)
1330       (clear-ir1-info component))))
1331 \f
1332 ;;;; COMPILE-FILE
1333
1334 (defun object-call-toplevel-lambda (tll)
1335   (declare (type functional tll))
1336   (let ((object *compile-object*))
1337     (etypecase object
1338       (fasl-output (fasl-dump-toplevel-lambda-call tll object))
1339       (core-object (core-call-toplevel-lambda      tll object))
1340       (null))))
1341
1342 ;;; Smash LAMBDAS into a single component, compile it, and arrange for
1343 ;;; the resulting function to be called.
1344 (defun sub-compile-toplevel-lambdas (lambdas)
1345   (declare (list lambdas))
1346   (when lambdas
1347     (multiple-value-bind (component tll) (merge-toplevel-lambdas lambdas)
1348       (compile-component component)
1349       (clear-ir1-info component)
1350       (object-call-toplevel-lambda tll)))
1351   (values))
1352
1353 ;;; Compile top level code and call the top level lambdas. We pick off
1354 ;;; top level lambdas in non-top-level components here, calling
1355 ;;; SUB-c-t-l-l on each subsequence of normal top level lambdas.
1356 (defun compile-toplevel-lambdas (lambdas)
1357   (declare (list lambdas))
1358   (let ((len (length lambdas)))
1359     (flet ((loser (start)
1360              (or (position-if (lambda (x)
1361                                 (not (eq (component-kind
1362                                           (node-component (lambda-bind x)))
1363                                          :toplevel)))
1364                               lambdas
1365                               ;; this used to read ":start start", but
1366                               ;; start can be greater than len, which
1367                               ;; is an error according to ANSI - CSR,
1368                               ;; 2002-04-25
1369                               :start (min start len))
1370                  len)))
1371       (do* ((start 0 (1+ loser))
1372             (loser (loser start) (loser start)))
1373            ((>= start len))
1374         (sub-compile-toplevel-lambdas (subseq lambdas start loser))
1375         (unless (= loser len)
1376           (object-call-toplevel-lambda (elt lambdas loser))))))
1377   (values))
1378
1379 ;;; Compile LAMBDAS (a list of CLAMBDAs for top level forms) into the
1380 ;;; object file.
1381 ;;;
1382 ;;; LOAD-TIME-VALUE-P seems to control whether it's MAKE-LOAD-FORM and
1383 ;;; COMPILE-LOAD-TIME-VALUE stuff. -- WHN 20000201
1384 (defun compile-toplevel (lambdas load-time-value-p)
1385   (declare (list lambdas))
1386
1387   (maybe-mumble "locall ")
1388   (locall-analyze-clambdas-until-done lambdas)
1389
1390   (maybe-mumble "IDFO ")
1391   (multiple-value-bind (components top-components hairy-top)
1392       (find-initial-dfo lambdas)
1393     (let ((*all-components* (append components top-components)))
1394       (when *check-consistency*
1395         (maybe-mumble "[check]~%")
1396         (check-ir1-consistency *all-components*))
1397
1398       (dolist (component (append hairy-top top-components))
1399         (pre-physenv-analyze-toplevel component))
1400
1401       (dolist (component components)
1402         (compile-component component)
1403         (replace-toplevel-xeps component))
1404
1405       (when *check-consistency*
1406         (maybe-mumble "[check]~%")
1407         (check-ir1-consistency *all-components*))
1408
1409       (if load-time-value-p
1410           (compile-load-time-value-lambda lambdas)
1411           (compile-toplevel-lambdas lambdas))
1412
1413       (mapc #'clear-ir1-info components)
1414       (clear-stuff)))
1415   (values))
1416
1417 ;;; Actually compile any stuff that has been queued up for block
1418 ;;; compilation.
1419 (defun finish-block-compilation ()
1420   (when *block-compile*
1421     (when *compile-print*
1422       (compiler-mumble "~&; block compiling converted top level forms..."))
1423     (when *toplevel-lambdas*
1424       (compile-toplevel (nreverse *toplevel-lambdas*) nil)
1425       (setq *toplevel-lambdas* ()))
1426     (setq *block-compile* nil)
1427     (setq *entry-points* nil)))
1428
1429 (defun handle-condition-p (condition)
1430   (let ((lexenv
1431          (etypecase *compiler-error-context*
1432            (node
1433             (node-lexenv *compiler-error-context*))
1434            (compiler-error-context
1435             (let ((lexenv (compiler-error-context-lexenv
1436                            *compiler-error-context*)))
1437               (aver lexenv)
1438               lexenv))
1439            (null *lexenv*))))
1440     (let ((muffles (lexenv-handled-conditions lexenv)))
1441       (if (null muffles) ; common case
1442           nil
1443           (dolist (muffle muffles nil)
1444             (destructuring-bind (typespec . restart-name) muffle
1445               (when (and (typep condition typespec)
1446                          (find-restart restart-name condition))
1447                 (return t))))))))
1448
1449 (defun handle-condition-handler (condition)
1450   (let ((lexenv
1451          (etypecase *compiler-error-context*
1452            (node
1453             (node-lexenv *compiler-error-context*))
1454            (compiler-error-context
1455             (let ((lexenv (compiler-error-context-lexenv
1456                            *compiler-error-context*)))
1457               (aver lexenv)
1458               lexenv))
1459            (null *lexenv*))))
1460     (let ((muffles (lexenv-handled-conditions lexenv)))
1461       (aver muffles)
1462       (dolist (muffle muffles (bug "fell through"))
1463         (destructuring-bind (typespec . restart-name) muffle
1464           (when (typep condition typespec)
1465             (awhen (find-restart restart-name condition)
1466               (invoke-restart it))))))))
1467
1468 ;;; Read all forms from INFO and compile them, with output to OBJECT.
1469 ;;; Return (VALUES NIL WARNINGS-P FAILURE-P).
1470 (defun sub-compile-file (info)
1471   (declare (type source-info info))
1472   (let ((*package* (sane-package))
1473         (*readtable* *readtable*)
1474         (sb!xc:*compile-file-pathname* nil) ; really bound in
1475         (sb!xc:*compile-file-truename* nil) ; SUB-SUB-COMPILE-FILE
1476         (*policy* *policy*)
1477         (*handled-conditions* *handled-conditions*)
1478         (*disabled-package-locks* *disabled-package-locks*)
1479         (*lexenv* (make-null-lexenv))
1480         (*block-compile* *block-compile-arg*)
1481         (*source-info* info)
1482         (*toplevel-lambdas* ())
1483         (*fun-names-in-this-file* ())
1484         (*allow-instrumenting* nil)
1485         (*compiler-error-bailout*
1486          (lambda ()
1487            (compiler-mumble "~2&; fatal error, aborting compilation~%")
1488            (return-from sub-compile-file (values nil t t))))
1489         (*current-path* nil)
1490         (*last-source-context* nil)
1491         (*last-original-source* nil)
1492         (*last-source-form* nil)
1493         (*last-format-string* nil)
1494         (*last-format-args* nil)
1495         (*last-message-count* 0)
1496         ;; FIXME: Do we need this rebinding here? It's a literal
1497         ;; translation of the old CMU CL rebinding to
1498         ;; (OR *BACKEND-INFO-ENVIRONMENT* *INFO-ENVIRONMENT*),
1499         ;; and it's not obvious whether the rebinding to itself is
1500         ;; needed that SBCL doesn't need *BACKEND-INFO-ENVIRONMENT*.
1501         (*info-environment* *info-environment*)
1502         (*compiler-sset-counter* 0)
1503         (*gensym-counter* 0))
1504     (handler-case
1505         (handler-bind (((satisfies handle-condition-p) #'handle-condition-handler))
1506           (with-compilation-values
1507               (sb!xc:with-compilation-unit ()
1508                 (clear-stuff)
1509
1510                 (sub-sub-compile-file info)
1511
1512                 (finish-block-compilation)
1513                 (let ((object *compile-object*))
1514                   (etypecase object
1515                     (fasl-output (fasl-dump-source-info info object))
1516                     (core-object (fix-core-source-info info object))
1517                     (null)))
1518                 nil)))
1519       ;; Some errors are sufficiently bewildering that we just fail
1520       ;; immediately, without trying to recover and compile more of
1521       ;; the input file.
1522       (fatal-compiler-error (condition)
1523        (signal condition)
1524        (when *compile-verbose*
1525          (format *standard-output*
1526                  "~@<compilation aborted because of fatal error: ~2I~_~A~:>"
1527                  condition))
1528        (values nil t t)))))
1529
1530 ;;; Return a pathname for the named file. The file must exist.
1531 (defun verify-source-file (pathname-designator)
1532   (let* ((pathname (pathname pathname-designator))
1533          (default-host (make-pathname :host (pathname-host pathname))))
1534     (flet ((try-with-type (path type error-p)
1535              (let ((new (merge-pathnames
1536                          path (make-pathname :type type
1537                                              :defaults default-host))))
1538                (if (probe-file new)
1539                    new
1540                    (and error-p (truename new))))))
1541       (cond ((typep pathname 'logical-pathname)
1542              (try-with-type pathname "LISP" t))
1543             ((probe-file pathname) pathname)
1544             ((try-with-type pathname "lisp"  nil))
1545             ((try-with-type pathname "lisp"  t))))))
1546
1547 (defun elapsed-time-to-string (tsec)
1548   (multiple-value-bind (tmin sec) (truncate tsec 60)
1549     (multiple-value-bind (thr min) (truncate tmin 60)
1550       (format nil "~D:~2,'0D:~2,'0D" thr min sec))))
1551
1552 ;;; Print some junk at the beginning and end of compilation.
1553 (defun print-compile-start-note (source-info)
1554   (declare (type source-info source-info))
1555   (let ((file-info (source-info-file-info source-info)))
1556     (compiler-mumble "~&; compiling file ~S (written ~A):~%"
1557                      (namestring (file-info-name file-info))
1558                      (sb!int:format-universal-time nil
1559                                                    (file-info-write-date
1560                                                     file-info)
1561                                                    :style :government
1562                                                    :print-weekday nil
1563                                                    :print-timezone nil)))
1564   (values))
1565
1566 (defun print-compile-end-note (source-info won)
1567   (declare (type source-info source-info))
1568   (compiler-mumble "~&; compilation ~:[aborted after~;finished in~] ~A~&"
1569                    won
1570                    (elapsed-time-to-string
1571                     (- (get-universal-time)
1572                        (source-info-start-time source-info))))
1573   (values))
1574
1575 ;;; Open some files and call SUB-COMPILE-FILE. If something unwinds
1576 ;;; out of the compile, then abort the writing of the output file, so
1577 ;;; that we don't overwrite it with known garbage.
1578 (defun sb!xc:compile-file
1579     (input-file
1580      &key
1581
1582      ;; ANSI options
1583      (output-file (cfp-output-file-default input-file))
1584      ;; FIXME: ANSI doesn't seem to say anything about
1585      ;; *COMPILE-VERBOSE* and *COMPILE-PRINT* being rebound by this
1586      ;; function..
1587      ((:verbose sb!xc:*compile-verbose*) sb!xc:*compile-verbose*)
1588      ((:print sb!xc:*compile-print*) sb!xc:*compile-print*)
1589      (external-format :default)
1590
1591      ;; extensions
1592      (trace-file nil)
1593      ((:block-compile *block-compile-arg*) nil))
1594   #!+sb-doc
1595   "Compile INPUT-FILE, producing a corresponding fasl file and
1596 returning its filename.
1597
1598   :PRINT
1599      If true, a message per non-macroexpanded top level form is printed
1600      to *STANDARD-OUTPUT*. Top level forms that whose subforms are
1601      processed as top level forms (eg. EVAL-WHEN, MACROLET, PROGN) receive
1602      no such message, but their subforms do.
1603
1604      As an extension to ANSI, if :PRINT is :top-level-forms, a message
1605      per top level form after macroexpansion is printed to *STANDARD-OUTPUT*.
1606      For example, compiling an IN-PACKAGE form will result in a message about
1607      a top level SETQ in addition to the message about the IN-PACKAGE form'
1608      itself.
1609
1610      Both forms of reporting obey the SB-EXT:*COMPILER-PRINT-VARIABLE-ALIST*.
1611
1612   :BLOCK-COMPILE
1613      Though COMPILE-FILE accepts an additional :BLOCK-COMPILE
1614      argument, it is not currently supported. (non-standard)
1615
1616   :TRACE-FILE
1617      If given, internal data structures are dumped to the specified
1618      file, or if a value of T is given, to a file of *.trace type
1619      derived from the input file name. (non-standard)"
1620 ;;; Block compilation is currently broken.
1621 #|
1622   "Also, as a workaround for vaguely-non-ANSI behavior, the
1623 :BLOCK-COMPILE argument is quasi-supported, to determine whether
1624 multiple functions are compiled together as a unit, resolving function
1625 references at compile time. NIL means that global function names are
1626 never resolved at compilation time. Currently NIL is the default
1627 behavior, because although section 3.2.2.3, \"Semantic Constraints\",
1628 of the ANSI spec allows this behavior under all circumstances, the
1629 compiler's runtime scales badly when it tries to do this for large
1630 files. If/when this performance problem is fixed, the block
1631 compilation default behavior will probably be made dependent on the
1632 SPEED and COMPILATION-SPEED optimization values, and the
1633 :BLOCK-COMPILE argument will probably become deprecated."
1634 |#
1635   (let* ((fasl-output nil)
1636          (output-file-name nil)
1637          (compile-won nil)
1638          (warnings-p nil)
1639          (failure-p t) ; T in case error keeps this from being set later
1640          (input-pathname (verify-source-file input-file))
1641          (source-info (make-file-source-info input-pathname external-format))
1642          (*compiler-trace-output* nil)) ; might be modified below
1643
1644     (unwind-protect
1645         (progn
1646           (when output-file
1647             (setq output-file-name
1648                   (sb!xc:compile-file-pathname input-file
1649                                                :output-file output-file))
1650             (setq fasl-output
1651                   (open-fasl-output output-file-name
1652                                     (namestring input-pathname))))
1653           (when trace-file
1654             (let* ((default-trace-file-pathname
1655                      (make-pathname :type "trace" :defaults input-pathname))
1656                    (trace-file-pathname
1657                     (if (eql trace-file t)
1658                         default-trace-file-pathname
1659                         (merge-pathnames trace-file
1660                                          default-trace-file-pathname))))
1661               (setf *compiler-trace-output*
1662                     (open trace-file-pathname
1663                           :if-exists :supersede
1664                           :direction :output))))
1665
1666           (when sb!xc:*compile-verbose*
1667             (print-compile-start-note source-info))
1668           (let ((*compile-object* fasl-output)
1669                 dummy)
1670             (multiple-value-setq (dummy warnings-p failure-p)
1671               (sub-compile-file source-info)))
1672           (setq compile-won t))
1673
1674       (close-source-info source-info)
1675
1676       (when fasl-output
1677         (close-fasl-output fasl-output (not compile-won))
1678         (setq output-file-name
1679               (pathname (fasl-output-stream fasl-output)))
1680         (when (and compile-won sb!xc:*compile-verbose*)
1681           (compiler-mumble "~2&; ~A written~%" (namestring output-file-name))))
1682
1683       (when sb!xc:*compile-verbose*
1684         (print-compile-end-note source-info compile-won))
1685
1686       (when *compiler-trace-output*
1687         (close *compiler-trace-output*)))
1688
1689     (values (if output-file
1690                 ;; Hack around filesystem race condition...
1691                 (or (probe-file output-file-name) output-file-name)
1692                 nil)
1693             warnings-p
1694             failure-p)))
1695 \f
1696 ;;; a helper function for COMPILE-FILE-PATHNAME: the default for
1697 ;;; the OUTPUT-FILE argument
1698 ;;;
1699 ;;; ANSI: The defaults for the OUTPUT-FILE are taken from the pathname
1700 ;;; that results from merging the INPUT-FILE with the value of
1701 ;;; *DEFAULT-PATHNAME-DEFAULTS*, except that the type component should
1702 ;;; default to the appropriate implementation-defined default type for
1703 ;;; compiled files.
1704 (defun cfp-output-file-default (input-file)
1705   (let* ((defaults (merge-pathnames input-file *default-pathname-defaults*))
1706          (retyped (make-pathname :type *fasl-file-type* :defaults defaults)))
1707     retyped))
1708
1709 ;;; KLUDGE: Part of the ANSI spec for this seems contradictory:
1710 ;;;   If INPUT-FILE is a logical pathname and OUTPUT-FILE is unsupplied,
1711 ;;;   the result is a logical pathname. If INPUT-FILE is a logical
1712 ;;;   pathname, it is translated into a physical pathname as if by
1713 ;;;   calling TRANSLATE-LOGICAL-PATHNAME.
1714 ;;; So I haven't really tried to make this precisely ANSI-compatible
1715 ;;; at the level of e.g. whether it returns logical pathname or a
1716 ;;; physical pathname. Patches to make it more correct are welcome.
1717 ;;; -- WHN 2000-12-09
1718 (defun sb!xc:compile-file-pathname (input-file
1719                                     &key
1720                                     (output-file nil output-file-p)
1721                                     &allow-other-keys)
1722   #!+sb-doc
1723   "Return a pathname describing what file COMPILE-FILE would write to given
1724    these arguments."
1725   (if output-file-p
1726       (merge-pathnames output-file (cfp-output-file-default input-file))
1727       (cfp-output-file-default input-file)))
1728 \f
1729 ;;;; MAKE-LOAD-FORM stuff
1730
1731 ;;; The entry point for MAKE-LOAD-FORM support. When IR1 conversion
1732 ;;; finds a constant structure, it invokes this to arrange for proper
1733 ;;; dumping. If it turns out that the constant has already been
1734 ;;; dumped, then we don't need to do anything.
1735 ;;;
1736 ;;; If the constant hasn't been dumped, then we check to see whether
1737 ;;; we are in the process of creating it. We detect this by
1738 ;;; maintaining the special *CONSTANTS-BEING-CREATED* as a list of all
1739 ;;; the constants we are in the process of creating. Actually, each
1740 ;;; entry is a list of the constant and any init forms that need to be
1741 ;;; processed on behalf of that constant.
1742 ;;;
1743 ;;; It's not necessarily an error for this to happen. If we are
1744 ;;; processing the init form for some object that showed up *after*
1745 ;;; the original reference to this constant, then we just need to
1746 ;;; defer the processing of that init form. To detect this, we
1747 ;;; maintain *CONSTANTS-CREATED-SINCE-LAST-INIT* as a list of the
1748 ;;; constants created since the last time we started processing an
1749 ;;; init form. If the constant passed to emit-make-load-form shows up
1750 ;;; in this list, then there is a circular chain through creation
1751 ;;; forms, which is an error.
1752 ;;;
1753 ;;; If there is some intervening init form, then we blow out of
1754 ;;; processing it by throwing to the tag PENDING-INIT. The value we
1755 ;;; throw is the entry from *CONSTANTS-BEING-CREATED*. This is so the
1756 ;;; offending init form can be tacked onto the init forms for the
1757 ;;; circular object.
1758 ;;;
1759 ;;; If the constant doesn't show up in *CONSTANTS-BEING-CREATED*, then
1760 ;;; we have to create it. We call MAKE-LOAD-FORM and check to see
1761 ;;; whether the creation form is the magic value
1762 ;;; :SB-JUST-DUMP-IT-NORMALLY. If it is, then we don't do anything. The
1763 ;;; dumper will eventually get its hands on the object and use the
1764 ;;; normal structure dumping noise on it.
1765 ;;;
1766 ;;; Otherwise, we bind *CONSTANTS-BEING-CREATED* and
1767 ;;; *CONSTANTS-CREATED-SINCE- LAST-INIT* and compile the creation form
1768 ;;; much the way LOAD-TIME-VALUE does. When this finishes, we tell the
1769 ;;; dumper to use that result instead whenever it sees this constant.
1770 ;;;
1771 ;;; Now we try to compile the init form. We bind
1772 ;;; *CONSTANTS-CREATED-SINCE-LAST-INIT* to NIL and compile the init
1773 ;;; form (and any init forms that were added because of circularity
1774 ;;; detection). If this works, great. If not, we add the init forms to
1775 ;;; the init forms for the object that caused the problems and let it
1776 ;;; deal with it.
1777 (defvar *constants-being-created* nil)
1778 (defvar *constants-created-since-last-init* nil)
1779 ;;; FIXME: Shouldn't these^ variables be unbound outside LET forms?
1780 (defun emit-make-load-form (constant)
1781   (aver (fasl-output-p *compile-object*))
1782   (unless (or (fasl-constant-already-dumped-p constant *compile-object*)
1783               ;; KLUDGE: This special hack is because I was too lazy
1784               ;; to rework DEF!STRUCT so that the MAKE-LOAD-FORM
1785               ;; function of LAYOUT returns nontrivial forms when
1786               ;; building the cross-compiler but :IGNORE-IT when
1787               ;; cross-compiling or running under the target Lisp. --
1788               ;; WHN 19990914
1789               #+sb-xc-host (typep constant 'layout))
1790     (let ((circular-ref (assoc constant *constants-being-created* :test #'eq)))
1791       (when circular-ref
1792         (when (find constant *constants-created-since-last-init* :test #'eq)
1793           (throw constant t))
1794         (throw 'pending-init circular-ref)))
1795     (multiple-value-bind (creation-form init-form)
1796         (handler-case
1797             (sb!xc:make-load-form constant (make-null-lexenv))
1798           (error (condition)
1799             (compiler-error condition)))
1800       (case creation-form
1801         (:sb-just-dump-it-normally
1802          (fasl-validate-structure constant *compile-object*)
1803          t)
1804         (:ignore-it
1805          nil)
1806         (t
1807          (let* ((name (write-to-string constant :level 1 :length 2))
1808                 (info (if init-form
1809                           (list constant name init-form)
1810                           (list constant))))
1811            (let ((*constants-being-created*
1812                   (cons info *constants-being-created*))
1813                  (*constants-created-since-last-init*
1814                   (cons constant *constants-created-since-last-init*)))
1815              (when
1816                  (catch constant
1817                    (fasl-note-handle-for-constant
1818                     constant
1819                     (compile-load-time-value
1820                      creation-form)
1821                     *compile-object*)
1822                    nil)
1823                (compiler-error "circular references in creation form for ~S"
1824                                constant)))
1825            (when (cdr info)
1826              (let* ((*constants-created-since-last-init* nil)
1827                     (circular-ref
1828                      (catch 'pending-init
1829                        (loop for (name form) on (cdr info) by #'cddr
1830                          collect name into names
1831                          collect form into forms
1832                          finally (compile-make-load-form-init-forms forms))
1833                        nil)))
1834                (when circular-ref
1835                  (setf (cdr circular-ref)
1836                        (append (cdr circular-ref) (cdr info))))))))))))
1837
1838 \f
1839 ;;;; Host compile time definitions
1840 #+sb-xc-host
1841 (defun compile-in-lexenv (name lambda lexenv)
1842   (declare (ignore lexenv))
1843   (compile name lambda))
1844
1845 #+sb-xc-host
1846 (defun eval-in-lexenv (form lexenv)
1847   (declare (ignore lexenv))
1848   (eval form))