src/compiler/main.lisp

   1 ;;;; the top-level interfaces to the compiler
   2
   3 ;;;; This software is part of the SBCL system. See the README file for
   4 ;;;; more information.
   5 ;;;;
   6 ;;;; This software is derived from the CMU CL system, which was
   7 ;;;; written at Carnegie Mellon University and released into the
   8 ;;;; public domain. The software is in the public domain and is
   9 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
  10 ;;;; files for more information.
  11
  12 (in-package "SB!C")
  13
  14 ;;; FIXME: Doesn't this belong somewhere else, like early-c.lisp?
  15 (declaim (special *constants* *free-variables* *component-being-compiled*
  16                   *code-vector* *next-location* *result-fixups*
  17                   *free-functions* *source-paths*
  18                   *seen-blocks* *seen-functions* *list-conflicts-table*
  19                   *continuation-number* *continuation-numbers*
  20                   *number-continuations* *tn-id* *tn-ids* *id-tns*
  21                   *label-ids* *label-id* *id-labels*
  22                   *undefined-warnings* *compiler-error-count*
  23                   *compiler-warning-count* *compiler-style-warning-count*
  24                   *compiler-note-count*
  25                   *compiler-error-bailout*
  26                   #!+sb-show *compiler-trace-output*
  27                   *last-source-context* *last-original-source*
  28                   *last-source-form* *last-format-string* *last-format-args*
  29                   *last-message-count* *lexenv*))
  30
  31 (defvar *byte-compile-default* :maybe
  32   #!+sb-doc
  33   "the default value for the :BYTE-COMPILE argument to COMPILE-FILE")
  34
  35 (defvar *byte-compile-top-level*
  36   #-sb-xc-host t
  37   #+sb-xc-host nil ; since the byte compiler isn't supported in cross-compiler
  38   #!+sb-doc
  39   "Similar to *BYTE-COMPILE-DEFAULT*, but controls the compilation of top-level
  40    forms (evaluated at load-time) when the :BYTE-COMPILE argument is :MAYBE
  41    (the default.)  When true, we decide to byte-compile.")
  42
  43 ;;; default value of the :BYTE-COMPILE argument to the compiler
  44 (defvar *byte-compile* :maybe)
  45
  46 ;;; Bound by COMPILE-COMPONENT to T when byte-compiling, and NIL when
  47 ;;; native compiling. During IR1 conversion this can also be :MAYBE,
  48 ;;; in which case we must look at the policy, see (byte-compiling).
  49 (defvar *byte-compiling* :maybe)
  50 (declaim (type (member t nil :maybe) *byte-compile* *byte-compiling*
  51                *byte-compile-default*))
  52
  53 (defvar *check-consistency* nil)
  54 (defvar *all-components*)
  55
  56 ;;; Bind this to a stream to capture various internal debugging output.
  57 #!+sb-show
  58 (defvar *compiler-trace-output* nil)
  59
  60 ;;; The current block compilation state. These are initialized to the
  61 ;;; :BLOCK-COMPILE and :ENTRY-POINTS arguments that COMPILE-FILE was
  62 ;;; called with.
  63 ;;;
  64 ;;; *BLOCK-COMPILE-ARGUMENT* holds the original value of the
  65 ;;; :BLOCK-COMPILE argument, which overrides any internal
  66 ;;; declarations.
  67 (defvar *block-compile*)
  68 (defvar *block-compile-argument*)
  69 (declaim (type (member nil t :specified)
  70                *block-compile* *block-compile-argument*))
  71 (defvar *entry-points*)
  72 (declaim (list *entry-points*))
  73
  74 ;;; When block compiling, used by PROCESS-FORM to accumulate top-level
  75 ;;; lambdas resulting from compiling subforms. (In reverse order.)
  76 (defvar *top-level-lambdas*)
  77 (declaim (list *top-level-lambdas*))
  78
  79 (defvar sb!xc:*compile-verbose* t
  80   #!+sb-doc
  81   "The default for the :VERBOSE argument to COMPILE-FILE.")
  82 (defvar sb!xc:*compile-print* t
  83   #!+sb-doc
  84   "The default for the :PRINT argument to COMPILE-FILE.")
  85 (defvar *compile-progress* nil
  86   #!+sb-doc
  87   "When this is true, the compiler prints to *ERROR-OUTPUT* progress
  88   information about the phases of compilation of each function. (This
  89   is useful mainly in large block compilations.)")
  90
  91 (defvar sb!xc:*compile-file-pathname* nil
  92   #!+sb-doc
  93   "The defaulted pathname of the file currently being compiled, or NIL if not
  94   compiling.")
  95 (defvar sb!xc:*compile-file-truename* nil
  96   #!+sb-doc
  97   "The TRUENAME of the file currently being compiled, or NIL if not
  98   compiling.")
  99
 100 (declaim (type (or pathname null)
 101                sb!xc:*compile-file-pathname*
 102                sb!xc:*compile-file-truename*))
 103
 104 ;;; the values of *PACKAGE* and policy when compilation started
 105 (defvar *initial-package*)
 106 (defvar *initial-cookie*)
 107 (defvar *initial-interface-cookie*)
 108
 109 ;;; The source-info structure for the current compilation. This is null
 110 ;;; globally to indicate that we aren't currently in any identifiable
 111 ;;; compilation.
 112 (defvar *source-info* nil)
 113
 114 ;;; True if we are within a WITH-COMPILATION-UNIT form (which normally
 115 ;;; causes nested uses to be no-ops).
 116 (defvar *in-compilation-unit* nil)
 117
 118 ;;; Count of the number of compilation units dynamically enclosed by
 119 ;;; the current active WITH-COMPILATION-UNIT that were unwound out of.
 120 (defvar *aborted-compilation-unit-count*)
 121
 122 ;;; Mumble conditional on *COMPILE-PROGRESS*.
 123 (defun maybe-mumble (&rest foo)
 124   (when *compile-progress*
 125     (compiler-mumble "~&")
 126     (pprint-logical-block (*error-output* nil :per-line-prefix "; ")
 127        (apply #'compiler-mumble foo))))
 128
 129 (deftype object () '(or fasl-file core-object null))
 130
 131 (defvar *compile-object* nil)
 132 (declaim (type object *compile-object*))
 133 \f
 134 ;;;; WITH-COMPILATION-UNIT and WITH-COMPILATION-VALUES
 135
 136 (defmacro sb!xc:with-compilation-unit (options &body body)
 137   #!+sb-doc
 138   "WITH-COMPILATION-UNIT ({Key Value}*) Form*
 139   This form affects compilations that take place within its dynamic extent. It
 140   is intended to be wrapped around the compilation of all files in the same
 141   system. These keywords are defined:
 142     :OVERRIDE Boolean-Form
 143         One of the effects of this form is to delay undefined warnings
 144         until the end of the form, instead of giving them at the end of each
 145         compilation. If OVERRIDE is NIL (the default), then the outermost
 146         WITH-COMPILATION-UNIT form grabs the undefined warnings. Specifying
 147         OVERRIDE true causes that form to grab any enclosed warnings, even if
 148         it is enclosed by another WITH-COMPILATION-UNIT."
 149   `(%with-compilation-unit (lambda () ,@body) ,@options))
 150
 151 (defun %with-compilation-unit (fn &key override)
 152   (let ((succeeded-p nil))
 153     (if (and *in-compilation-unit* (not override))
 154         ;; Inside another WITH-COMPILATION-UNIT, a WITH-COMPILATION-UNIT is
 155         ;; ordinarily (unless OVERRIDE) basically a no-op.
 156         (unwind-protect
 157             (multiple-value-prog1 (funcall fn) (setf succeeded-p t))
 158           (unless succeeded-p
 159             (incf *aborted-compilation-unit-count*)))
 160         ;; FIXME: Now *COMPILER-FOO-COUNT* stuff is bound in more than
 161         ;; one place. If we can get rid of the IR1 interpreter, this
 162         ;; should be easier to clean up.
 163         (let ((*aborted-compilation-unit-count* 0)
 164               (*compiler-error-count* 0)
 165               (*compiler-warning-count* 0)
 166               (*compiler-style-warning-count* 0)
 167               (*compiler-note-count* 0)
 168               (*undefined-warnings* nil)
 169               (*in-compilation-unit* t))
 170           (handler-bind ((parse-unknown-type
 171                           (lambda (c)
 172                             (note-undefined-reference
 173                              (parse-unknown-type-specifier c)
 174                              :type))))
 175             (unwind-protect
 176                 (multiple-value-prog1 (funcall fn) (setf succeeded-p t))
 177               (unless succeeded-p
 178                 (incf *aborted-compilation-unit-count*))
 179               (summarize-compilation-unit (not succeeded-p))))))))
 180
 181 ;;; This is to be called at the end of a compilation unit. It signals
 182 ;;; any residual warnings about unknown stuff, then prints the total
 183 ;;; error counts. ABORT-P should be true when the compilation unit was
 184 ;;; aborted by throwing out. ABORT-COUNT is the number of dynamically
 185 ;;; enclosed nested compilation units that were aborted.
 186 (defun summarize-compilation-unit (abort-p)
 187   (unless abort-p
 188     (handler-bind ((style-warning #'compiler-style-warning-handler)
 189                    (warning #'compiler-warning-handler))
 190
 191       (let ((undefs (sort *undefined-warnings* #'string<
 192                           :key #'(lambda (x)
 193                                    (let ((x (undefined-warning-name x)))
 194                                      (if (symbolp x)
 195                                          (symbol-name x)
 196                                          (prin1-to-string x)))))))
 197         (unless *converting-for-interpreter*
 198           (dolist (undef undefs)
 199             (let ((name (undefined-warning-name undef))
 200                   (kind (undefined-warning-kind undef))
 201                   (warnings (undefined-warning-warnings undef))
 202                   (undefined-warning-count (undefined-warning-count undef)))
 203               (dolist (*compiler-error-context* warnings)
 204                 (compiler-style-warning "undefined ~(~A~): ~S" kind name))
 205
 206               (let ((warn-count (length warnings)))
 207                 (when (and warnings (> undefined-warning-count warn-count))
 208                   (let ((more (- undefined-warning-count warn-count)))
 209                     (compiler-style-warning
 210                      "~D more use~:P of undefined ~(~A~) ~S"
 211                      more kind name)))))))
 212
 213         (dolist (kind '(:variable :function :type))
 214           (let ((summary (mapcar #'undefined-warning-name
 215                                  (remove kind undefs :test-not #'eq
 216                                          :key #'undefined-warning-kind))))
 217             (when summary
 218               (compiler-style-warning
 219                "~:[This ~(~A~) is~;These ~(~A~)s are~] undefined:~
 220                 ~%  ~{~<~%  ~1:;~S~>~^ ~}"
 221                (cdr summary) kind summary)))))))
 222
 223   (unless (or *converting-for-interpreter*
 224               (and (not abort-p)
 225                    (zerop *aborted-compilation-unit-count*)
 226                    (zerop *compiler-error-count*)
 227                    (zerop *compiler-warning-count*)
 228                    (zerop *compiler-style-warning-count*)
 229                    (zerop *compiler-note-count*)))
 230     (format *error-output* "~&")
 231     (pprint-logical-block (*error-output* nil :per-line-prefix "; ")
 232       (compiler-mumble "compilation unit ~:[finished~;aborted~]~
 233                        ~[~:;~:*~&  caught ~D fatal ERROR condition~:P~]~
 234                        ~[~:;~:*~&  caught ~D ERROR condition~:P~]~
 235                        ~[~:;~:*~&  caught ~D WARNING condition~:P~]~
 236                        ~[~:;~:*~&  caught ~D STYLE-WARNING condition~:P~]~
 237                        ~[~:;~:*~&  printed ~D note~:P~]"
 238                        abort-p
 239                        *aborted-compilation-unit-count*
 240                        *compiler-error-count*
 241                        *compiler-warning-count*
 242                        *compiler-style-warning-count*
 243                        *compiler-note-count*)))
 244   (format *error-output* "~&"))
 245
 246 ;;; Evaluate BODY, then return (VALUES BODY-VALUE WARNINGS-P
 247 ;;; FAILURE-P), where BODY-VALUE is the first value of the body, and
 248 ;;; WARNINGS-P and FAILURE-P are as in CL:COMPILE or CL:COMPILE-FILE.
 249 ;;; This also wraps up WITH-IR1-NAMESPACE functionality.
 250 (defmacro with-compilation-values (&body body)
 251   `(with-ir1-namespace
 252     (let ((*warnings-p* nil)
 253           (*failure-p* nil))
 254       (values (progn ,@body)
 255               *warnings-p*
 256               *failure-p*))))
 257 \f
 258 ;;;; component compilation
 259
 260 (defparameter *max-optimize-iterations* 3 ; ARB
 261   #!+sb-doc
 262   "The upper limit on the number of times that we will consecutively do IR1
 263   optimization that doesn't introduce any new code. A finite limit is
 264   necessary, since type inference may take arbitrarily long to converge.")
 265
 266 (defevent ir1-optimize-until-done "IR1-OPTIMIZE-UNTIL-DONE called")
 267 (defevent ir1-optimize-maxed-out "hit *MAX-OPTIMIZE-ITERATIONS* limit")
 268
 269 ;;; Repeatedly optimize COMPONENT until no further optimizations can
 270 ;;; be found or we hit our iteration limit. When we hit the limit, we
 271 ;;; clear the component and block REOPTIMIZE flags to discourage the
 272 ;;; next optimization attempt from pounding on the same code.
 273 (defun ir1-optimize-until-done (component)
 274   (declare (type component component))
 275   (maybe-mumble "opt")
 276   (event ir1-optimize-until-done)
 277   (let ((count 0)
 278         (cleared-reanalyze nil))
 279     (loop
 280       (when (component-reanalyze component)
 281         (setq count 0)
 282         (setq cleared-reanalyze t)
 283         (setf (component-reanalyze component) nil))
 284       (setf (component-reoptimize component) nil)
 285       (ir1-optimize component)
 286       (unless (component-reoptimize component)
 287         (maybe-mumble " ")
 288         (return))
 289       (incf count)
 290       (when (= count *max-optimize-iterations*)
 291         (event ir1-optimize-maxed-out)
 292         (maybe-mumble "* ")
 293         (setf (component-reoptimize component) nil)
 294         (do-blocks (block component)
 295           (setf (block-reoptimize block) nil))
 296         (return))
 297       (maybe-mumble "."))
 298     (when cleared-reanalyze
 299       (setf (component-reanalyze component) t)))
 300   (values))
 301
 302 (defparameter *constraint-propagate* t)
 303 (defparameter *reoptimize-after-type-check-max* 5)
 304
 305 (defevent reoptimize-maxed-out
 306   "*REOPTIMIZE-AFTER-TYPE-CHECK-MAX* exceeded.")
 307
 308 ;;; Iterate doing FIND-DFO until no new dead code is discovered.
 309 (defun dfo-as-needed (component)
 310   (declare (type component component))
 311   (when (component-reanalyze component)
 312     (maybe-mumble "DFO")
 313     (loop
 314       (find-dfo component)
 315       (unless (component-reanalyze component)
 316         (maybe-mumble " ")
 317         (return))
 318       (maybe-mumble ".")))
 319   (values))
 320
 321 ;;; Do all the IR1 phases for a non-top-level component.
 322 (defun ir1-phases (component)
 323   (declare (type component component))
 324   (let ((*constraint-number* 0)
 325         (loop-count 1))
 326     (declare (special *constraint-number*))
 327     (loop
 328       (ir1-optimize-until-done component)
 329       (when (or (component-new-functions component)
 330                 (component-reanalyze-functions component))
 331         (maybe-mumble "locall ")
 332         (local-call-analyze component))
 333       (dfo-as-needed component)
 334       (when *constraint-propagate*
 335         (maybe-mumble "constraint ")
 336         (constraint-propagate component))
 337       (maybe-mumble "type ")
 338       ;; Delay the generation of type checks until the type
 339       ;; constraints have had time to propagate, else the compiler can
 340       ;; confuse itself.
 341       (unless (and (or (component-reoptimize component)
 342                        (component-reanalyze component)
 343                        (component-new-functions component)
 344                        (component-reanalyze-functions component))
 345                    (< loop-count (- *reoptimize-after-type-check-max* 2)))
 346         (generate-type-checks component)
 347         (unless (or (component-reoptimize component)
 348                     (component-reanalyze component)
 349                     (component-new-functions component)
 350                     (component-reanalyze-functions component))
 351           (return)))
 352       (when (>= loop-count *reoptimize-after-type-check-max*)
 353         (maybe-mumble "[reoptimize limit]")
 354         (event reoptimize-maxed-out)
 355         (return))
 356       (incf loop-count)))
 357
 358   (ir1-finalize component)
 359   (values))
 360
 361 (defun native-compile-component (component)
 362   (let ((*code-segment* nil)
 363         (*elsewhere* nil))
 364     (maybe-mumble "GTN ")
 365     (gtn-analyze component)
 366     (maybe-mumble "LTN ")
 367     (ltn-analyze component)
 368     (dfo-as-needed component)
 369     (maybe-mumble "control ")
 370     (control-analyze component #'make-ir2-block)
 371
 372     (when (ir2-component-values-receivers (component-info component))
 373       (maybe-mumble "stack ")
 374       (stack-analyze component)
 375       ;; Assign BLOCK-NUMBER for any cleanup blocks introduced by
 376       ;; stack analysis. There shouldn't be any unreachable code after
 377       ;; control, so this won't delete anything.
 378       (dfo-as-needed component))
 379
 380     (unwind-protect
 381         (progn
 382           (maybe-mumble "IR2tran ")
 383           (init-assembler)
 384           (entry-analyze component)
 385           (ir2-convert component)
 386
 387           (when (policy nil (>= speed cspeed))
 388             (maybe-mumble "copy ")
 389             (copy-propagate component))
 390
 391           (select-representations component)
 392
 393           (when *check-consistency*
 394             (maybe-mumble "check2 ")
 395             (check-ir2-consistency component))
 396
 397           (delete-unreferenced-tns component)
 398
 399           (maybe-mumble "life ")
 400           (lifetime-analyze component)
 401
 402           (when *compile-progress*
 403             (compiler-mumble "") ; Sync before doing more output.
 404             (pre-pack-tn-stats component *error-output*))
 405
 406           (when *check-consistency*
 407             (maybe-mumble "check-life ")
 408             (check-life-consistency component))
 409
 410           (maybe-mumble "pack ")
 411           (pack component)
 412
 413           (when *check-consistency*
 414             (maybe-mumble "check-pack ")
 415             (check-pack-consistency component))
 416
 417           #!+sb-show
 418           (when *compiler-trace-output*
 419             (describe-component component *compiler-trace-output*)
 420             (describe-ir2-component component *compiler-trace-output*))
 421
 422           (maybe-mumble "code ")
 423           (multiple-value-bind (code-length trace-table fixups)
 424               (generate-code component)
 425
 426             #!+sb-show
 427             (when *compiler-trace-output*
 428               (format *compiler-trace-output*
 429                       "~|~%disassembly of code for ~S~2%" component)
 430               (sb!disassem:disassemble-assem-segment *code-segment*
 431                                                      *compiler-trace-output*))
 432
 433             (etypecase *compile-object*
 434               (fasl-file
 435                (maybe-mumble "fasl")
 436                (fasl-dump-component component
 437                                     *code-segment*
 438                                     code-length
 439                                     trace-table
 440                                     fixups
 441                                     *compile-object*))
 442               (core-object
 443                (maybe-mumble "core")
 444                (make-core-component component
 445                                     *code-segment*
 446                                     code-length
 447                                     trace-table
 448                                     fixups
 449                                     *compile-object*))
 450               (null))))))
 451
 452   ;; We are done, so don't bother keeping anything around.
 453   (setf (component-info component) nil)
 454
 455   (values))
 456
 457 ;;; Return our best guess for whether we will byte compile code
 458 ;;; currently being IR1 converted. This is only a guess because the
 459 ;;; decision is made on a per-component basis.
 460 ;;;
 461 ;;; FIXME: This should be called something more mnemonic, e.g.
 462 ;;; PROBABLY-BYTE-COMPILING
 463 (defun byte-compiling ()
 464   (if (eq *byte-compiling* :maybe)
 465       (or (eq *byte-compile* t)
 466           (policy nil (zerop speed) (<= debug 1)))
 467       (and *byte-compile* *byte-compiling*)))
 468
 469 ;;; Delete components with no external entry points before we try to
 470 ;;; generate code. Unreachable closures can cause IR2 conversion to
 471 ;;; puke on itself, since it is the reference to the closure which
 472 ;;; normally causes the components to be combined. This doesn't really
 473 ;;; cover all cases...
 474 (defun delete-if-no-entries (component)
 475   (dolist (fun (component-lambdas component)
 476                (delete-component component))
 477     (case (functional-kind fun)
 478       (:top-level (return))
 479       (:external
 480        (unless (every #'(lambda (ref)
 481                           (eq (block-component (node-block ref))
 482                               component))
 483                       (leaf-refs fun))
 484          (return))))))
 485
 486 (defun compile-component (component)
 487   (let* ((*component-being-compiled* component)
 488          (*byte-compiling*
 489           (ecase *byte-compile*
 490             ((t) t)
 491             ((nil) nil)
 492             (:maybe
 493              (dolist (fun (component-lambdas component) t)
 494                (unless (policy (lambda-bind fun)
 495                                (zerop speed) (<= debug 1))
 496                  (return nil)))))))
 497
 498     (when sb!xc:*compile-print*
 499       (compiler-mumble "~&; ~:[~;byte ~]compiling ~A: "
 500                        *byte-compiling*
 501                        (component-name component)))
 502
 503     (ir1-phases component)
 504
 505     ;; FIXME: What is MAYBE-MUMBLE for? Do we need it any more?
 506     (maybe-mumble "env ")
 507     (environment-analyze component)
 508     (dfo-as-needed component)
 509
 510     (delete-if-no-entries component)
 511
 512     (unless (eq (block-next (component-head component))
 513                 (component-tail component))
 514       (if *byte-compiling*
 515           (byte-compile-component component)
 516           (native-compile-component component))))
 517
 518   (clear-constant-info)
 519
 520   (when sb!xc:*compile-print*
 521     (compiler-mumble "~&"))
 522
 523   (values))
 524 \f
 525 ;;;; clearing global data structures
 526 ;;;;
 527 ;;;; FIXME: Is it possible to get rid of this stuff, getting rid of
 528 ;;;; global data structures entirely when possible and consing up the
 529 ;;;; others from scratch instead of clearing and reusing them?
 530
 531 ;;; Clear the INFO in constants in the *FREE-VARIABLES*, etc. In
 532 ;;; addition to allowing stuff to be reclaimed, this is required for
 533 ;;; correct assignment of constant offsets, since we need to assign a
 534 ;;; new offset for each component. We don't clear the FUNCTIONAL-INFO
 535 ;;; slots, since they are used to keep track of functions across
 536 ;;; component boundaries.
 537 (defun clear-constant-info ()
 538   (maphash #'(lambda (k v)
 539                (declare (ignore k))
 540                (setf (leaf-info v) nil))
 541            *constants*)
 542   (maphash #'(lambda (k v)
 543                (declare (ignore k))
 544                (when (constant-p v)
 545                  (setf (leaf-info v) nil)))
 546            *free-variables*)
 547   (values))
 548
 549 ;;; Blow away the REFS for all global variables, and let COMPONENT
 550 ;;; be recycled.
 551 (defun clear-ir1-info (component)
 552   (declare (type component component))
 553   (labels ((blast (x)
 554              (maphash #'(lambda (k v)
 555                           (declare (ignore k))
 556                           (when (leaf-p v)
 557                             (setf (leaf-refs v)
 558                                   (delete-if #'here-p (leaf-refs v)))
 559                             (when (basic-var-p v)
 560                               (setf (basic-var-sets v)
 561                                     (delete-if #'here-p (basic-var-sets v))))))
 562                       x))
 563            (here-p (x)
 564              (eq (block-component (node-block x)) component)))
 565     (blast *free-variables*)
 566     (blast *free-functions*)
 567     (blast *constants*))
 568   (values))
 569
 570 ;;; Clear global variables used by the compiler.
 571 ;;;
 572 ;;; FIXME: It seems kinda nasty and unmaintainable to have to do this,
 573 ;;; and it adds overhead even when people aren't using the compiler.
 574 ;;; Perhaps we could make these global vars unbound except when
 575 ;;; actually in use, so that this function could go away.
 576 (defun clear-stuff (&optional (debug-too t))
 577
 578   ;; Clear global tables.
 579   (when (boundp '*free-functions*)
 580     (clrhash *free-functions*)
 581     (clrhash *free-variables*)
 582     (clrhash *constants*))
 583
 584   ;; Clear debug counters and tables.
 585   (clrhash *seen-blocks*)
 586   (clrhash *seen-functions*)
 587   (clrhash *list-conflicts-table*)
 588
 589   (when debug-too
 590     (clrhash *continuation-numbers*)
 591     (clrhash *number-continuations*)
 592     (setq *continuation-number* 0)
 593     (clrhash *tn-ids*)
 594     (clrhash *id-tns*)
 595     (setq *tn-id* 0)
 596     (clrhash *label-ids*)
 597     (clrhash *id-labels*)
 598     (setq *label-id* 0)
 599
 600     ;; Clear some Pack data structures (for GC purposes only).
 601     (assert (not *in-pack*))
 602     (dolist (sb *backend-sb-list*)
 603       (when (finite-sb-p sb)
 604         (fill (finite-sb-live-tns sb) nil))))
 605
 606   ;; (Note: The CMU CL code used to set CL::*GENSYM-COUNTER* to zero here.
 607   ;; Superficially, this seemed harmful -- the user could reasonably be
 608   ;; surprised if *GENSYM-COUNTER* turned back to zero when something was
 609   ;; compiled. A closer inspection showed that this actually turned out to be
 610   ;; harmless in practice, because CLEAR-STUFF was only called from within
 611   ;; forms which bound CL::*GENSYM-COUNTER* to zero. However, this means that
 612   ;; even though zeroing CL::*GENSYM-COUNTER* here turned out to be harmless in
 613   ;; practice, it was also useless in practice. So we don't do it any more.)
 614
 615   (values))
 616 \f
 617 ;;;; trace output
 618
 619 ;;; Print out some useful info about Component to Stream.
 620 (defun describe-component (component *standard-output*)
 621   (declare (type component component))
 622   (format t "~|~%;;;; component: ~S~2%" (component-name component))
 623   (print-blocks component)
 624   (values))
 625
 626 (defun describe-ir2-component (component *standard-output*)
 627   (format t "~%~|~%;;;; IR2 component: ~S~2%" (component-name component))
 628   (format t "entries:~%")
 629   (dolist (entry (ir2-component-entries (component-info component)))
 630     (format t "~4TL~D: ~S~:[~; [closure]~]~%"
 631             (label-id (entry-info-offset entry))
 632             (entry-info-name entry)
 633             (entry-info-closure-p entry)))
 634   (terpri)
 635   (pre-pack-tn-stats component *standard-output*)
 636   (terpri)
 637   (print-ir2-blocks component)
 638   (terpri)
 639   (values))
 640 \f
 641 ;;;; file reading
 642 ;;;;
 643 ;;;; When reading from a file, we have to keep track of some source
 644 ;;;; information. We also exploit our ability to back up for printing
 645 ;;;; the error context and for recovering from errors.
 646 ;;;;
 647 ;;;; The interface we provide to this stuff is the stream-oid
 648 ;;;; Source-Info structure. The bookkeeping is done as a side-effect
 649 ;;;; of getting the next source form.
 650
 651 ;;; The File-Info structure holds all the source information for a
 652 ;;; given file.
 653 (defstruct file-info
 654   ;; If a file, the truename of the corresponding source file. If from a Lisp
 655   ;; form, :LISP, if from a stream, :STREAM.
 656   (name (required-argument) :type (or pathname (member :lisp :stream)))
 657   ;; The defaulted, but not necessarily absolute file name (i.e. prior to
 658   ;; TRUENAME call.)  Null if not a file. This is used to set
 659   ;; *COMPILE-FILE-PATHNAME*, and if absolute, is dumped in the debug-info.
 660   (untruename nil :type (or pathname null))
 661   ;; The file's write date (if relevant.)
 662   (write-date nil :type (or unsigned-byte null))
 663   ;; The source path root number of the first form in this file (i.e. the
 664   ;; total number of forms converted previously in this compilation.)
 665   (source-root 0 :type unsigned-byte)
 666   ;; Parallel vectors containing the forms read out of the file and the file
 667   ;; positions that reading of each form started at (i.e. the end of the
 668   ;; previous form.)
 669   (forms (make-array 10 :fill-pointer 0 :adjustable t) :type (vector t))
 670   (positions (make-array 10 :fill-pointer 0 :adjustable t) :type (vector t)))
 671
 672 ;;; The SOURCE-INFO structure provides a handle on all the source
 673 ;;; information for an entire compilation.
 674 (defstruct (source-info
 675             #-no-ansi-print-object
 676             (:print-object (lambda (s stream)
 677                              (print-unreadable-object (s stream :type t)))))
 678   ;; the UT that compilation started at
 679   (start-time (get-universal-time) :type unsigned-byte)
 680   ;; a list of the FILE-INFO structures for this compilation
 681   (files nil :type list)
 682   ;; the tail of the FILES for the file we are currently reading
 683   (current-file nil :type list)
 684   ;; the stream that we are using to read the CURRENT-FILE, or NIL if
 685   ;; no stream has been opened yet
 686   (stream nil :type (or stream null)))
 687
 688 ;;; Given a list of pathnames, return a SOURCE-INFO structure.
 689 (defun make-file-source-info (files)
 690   (declare (list files))
 691   (let ((file-info
 692          (mapcar (lambda (x)
 693                    (make-file-info :name (truename x)
 694                                    :untruename x
 695                                    :write-date (file-write-date x)))
 696                  files)))
 697
 698     (make-source-info :files file-info
 699                       :current-file file-info)))
 700
 701 ;;; Return a SOURCE-INFO to describe the incremental compilation of
 702 ;;; FORM. Also used by SB!EVAL:INTERNAL-EVAL.
 703 (defun make-lisp-source-info (form)
 704   (make-source-info
 705    :start-time (get-universal-time)
 706    :files (list (make-file-info :name :lisp
 707                                 :forms (vector form)
 708                                 :positions '#(0)))))
 709
 710 ;;; Return a SOURCE-INFO which will read from Stream.
 711 (defun make-stream-source-info (stream)
 712   (let ((files (list (make-file-info :name :stream))))
 713     (make-source-info
 714      :files files
 715      :current-file files
 716      :stream stream)))
 717
 718 ;;; Print an error message for a non-EOF error on STREAM. OLD-POS is a
 719 ;;; preceding file position that hopefully comes before the beginning
 720 ;;; of the line. Of course, this only works on streams that support
 721 ;;; the file-position operation.
 722 (defun normal-read-error (stream old-pos condition)
 723   (declare (type stream stream) (type unsigned-byte old-pos))
 724   (let ((pos (file-position stream)))
 725     (file-position stream old-pos)
 726     (let ((start old-pos))
 727       (loop
 728         (let ((line (read-line stream nil))
 729               (end (file-position stream)))
 730           (when (>= end pos)
 731             ;; FIXME: READER-ERROR also prints the file position. Do we really
 732             ;; need to try to give position information here?
 733             (compiler-abort "read error at ~D:~% \"~A/\\~A\"~%~A"
 734                             pos
 735                             (string-left-trim "         "
 736                                               (subseq line 0 (- pos start)))
 737                             (subseq line (- pos start))
 738                             condition)
 739             (return))
 740           (setq start end)))))
 741   (values))
 742
 743 ;;; Back STREAM up to the position Pos, then read a form with
 744 ;;; *READ-SUPPRESS* on, discarding the result. If an error happens
 745 ;;; during this read, then bail out using COMPILER-ERROR (fatal in
 746 ;;; this context).
 747 (defun ignore-error-form (stream pos)
 748   (declare (type stream stream) (type unsigned-byte pos))
 749   (file-position stream pos)
 750   (handler-case (let ((*read-suppress* t))
 751                   (read stream))
 752     (error (condition)
 753       (declare (ignore condition))
 754       (compiler-error "unable to recover from read error"))))
 755
 756 ;;; Print an error message giving some context for an EOF error. We
 757 ;;; print the first line after POS that contains #\" or #\(, or
 758 ;;; lacking that, the first non-empty line.
 759 (defun unexpected-eof-error (stream pos condition)
 760   (declare (type stream stream) (type unsigned-byte pos))
 761   (let ((res nil))
 762     (file-position stream pos)
 763     (loop
 764       (let ((line (read-line stream nil nil)))
 765         (unless line (return))
 766         (when (or (find #\" line) (find #\( line))
 767           (setq res line)
 768           (return))
 769         (unless (or res (zerop (length line)))
 770           (setq res line))))
 771     (compiler-abort "read error in form starting at ~D:~%~@[ \"~A\"~%~]~A"
 772                     pos
 773                     res
 774                     condition))
 775   (file-position stream (file-length stream))
 776   (values))
 777
 778 ;;; Read a form from STREAM, returning EOF at EOF. If a read error
 779 ;;; happens, then attempt to recover if possible, returning a proxy
 780 ;;; error form.
 781 ;;;
 782 ;;; FIXME: This seems like quite a lot of complexity, and it seems
 783 ;;; impossible to get it quite right. (E.g. the `(CERROR ..) form
 784 ;;; returned here won't do the right thing if it's not in a position
 785 ;;; for an executable form.) I think it might be better to just stop
 786 ;;; trying to recover from read errors, punting all this noise
 787 ;;; (including UNEXPECTED-EOF-ERROR and IGNORE-ERROR-FORM) and doing a
 788 ;;; COMPILER-ABORT instead.
 789 (defun careful-read (stream eof pos)
 790   (handler-case (read stream nil eof)
 791     (error (condition)
 792       (let ((new-pos (file-position stream)))
 793         (cond ((= new-pos (file-length stream))
 794                (unexpected-eof-error stream pos condition))
 795               (t
 796                (normal-read-error stream pos condition)
 797                (ignore-error-form stream pos))))
 798       '(cerror "Skip this form."
 799                "compile-time read error"))))
 800
 801 ;;; If Stream is present, return it, otherwise open a stream to the
 802 ;;; current file. There must be a current file. When we open a new
 803 ;;; file, we also reset *PACKAGE* and policy. This gives the effect of
 804 ;;; rebinding around each file.
 805 ;;;
 806 ;;; FIXME: Since we now do the standard ANSI thing of only one file
 807 ;;; per compile (unlike the CMU CL extended COMPILE-FILE) can't this
 808 ;;; complexity (including ADVANCE-SOURCE-FILE) go away?
 809 (defun get-source-stream (info)
 810   (declare (type source-info info))
 811   (cond ((source-info-stream info))
 812         (t
 813          (setq *package* *initial-package*)
 814          (setq *default-cookie* (copy-cookie *initial-cookie*))
 815          (setq *default-interface-cookie*
 816                (copy-cookie *initial-interface-cookie*))
 817          (let* ((finfo (first (source-info-current-file info)))
 818                 (name (file-info-name finfo)))
 819            (setq sb!xc:*compile-file-truename* name)
 820            (setq sb!xc:*compile-file-pathname* (file-info-untruename finfo))
 821            (setf (source-info-stream info)
 822                  (open name :direction :input))))))
 823
 824 ;;; Close the stream in INFO if it is open.
 825 (defun close-source-info (info)
 826   (declare (type source-info info))
 827   (let ((stream (source-info-stream info)))
 828     (when stream (close stream)))
 829   (setf (source-info-stream info) nil)
 830   (values))
 831
 832 ;;; Advance INFO to the next source file. If there is no next source
 833 ;;; file, return NIL, otherwise T.
 834 (defun advance-source-file (info)
 835   (declare (type source-info info))
 836   (close-source-info info)
 837   (let ((prev (pop (source-info-current-file info))))
 838     (if (source-info-current-file info)
 839         (let ((current (first (source-info-current-file info))))
 840           (setf (file-info-source-root current)
 841                 (+ (file-info-source-root prev)
 842                    (length (file-info-forms prev))))
 843           t)
 844         nil)))
 845
 846 ;;; Read the sources from the source files and process them.
 847 (defun process-sources (info)
 848   (let* ((file (first (source-info-current-file info)))
 849          (stream (get-source-stream info)))
 850     (loop
 851      (let* ((pos (file-position stream))
 852             (eof '(*eof*))
 853             (form (careful-read stream eof pos)))
 854        (if (eq form eof)
 855          (return)
 856          (let* ((forms (file-info-forms file))
 857                 (current-idx (+ (fill-pointer forms)
 858                                 (file-info-source-root file))))
 859            (vector-push-extend form forms)
 860            (vector-push-extend pos (file-info-positions file))
 861            (clrhash *source-paths*)
 862            (find-source-paths form current-idx)
 863            (process-top-level-form form
 864                                    `(original-source-start 0 ,current-idx))))))
 865     (when (advance-source-file info)
 866       (process-sources info))))
 867
 868 ;;; Return the FILE-INFO describing the INDEX'th form.
 869 (defun find-file-info (index info)
 870   (declare (type index index) (type source-info info))
 871   (dolist (file (source-info-files info))
 872     (when (> (+ (length (file-info-forms file))
 873                 (file-info-source-root file))
 874              index)
 875       (return file))))
 876
 877 ;;; Return the INDEX'th source form read from INFO and the position
 878 ;;; where it was read.
 879 (defun find-source-root (index info)
 880   (declare (type source-info info) (type index index))
 881   (let* ((file (find-file-info index info))
 882          (idx (- index (file-info-source-root file))))
 883     (values (aref (file-info-forms file) idx)
 884             (aref (file-info-positions file) idx))))
 885 \f
 886 ;;;; top-level form processing
 887
 888 ;;; This is called by top-level form processing when we are ready to
 889 ;;; actually compile something. If *BLOCK-COMPILE* is T, then we still
 890 ;;; convert the form, but delay compilation, pushing the result on
 891 ;;; *TOP-LEVEL-LAMBDAS* instead.
 892 (defun convert-and-maybe-compile (form path)
 893   (declare (list path))
 894   (let* ((*lexenv* (make-lexenv :cookie *default-cookie*
 895                                 :interface-cookie *default-interface-cookie*))
 896          (tll (ir1-top-level form path nil)))
 897     (cond ((eq *block-compile* t) (push tll *top-level-lambdas*))
 898           (t (compile-top-level (list tll) nil)))))
 899
 900 ;;; Process a PROGN-like portion of a top-level form. Forms is a list of
 901 ;;; the forms, and Path is source path of the form they came out of.
 902 (defun process-top-level-progn (forms path)
 903   (declare (list forms) (list path))
 904   (dolist (form forms)
 905     (process-top-level-form form path)))
 906
 907 ;;; Macroexpand form in the current environment with an error handler.
 908 ;;; We only expand one level, so that we retain all the intervening
 909 ;;; forms in the source path.
 910 (defun preprocessor-macroexpand (form)
 911   (handler-case (sb!xc:macroexpand-1 form *lexenv*)
 912     (error (condition)
 913        (compiler-error "(during macroexpansion)~%~A" condition))))
 914
 915 ;;; Process a top-level use of LOCALLY. We parse declarations and then
 916 ;;; recursively process the body.
 917 ;;;
 918 ;;; Binding *DEFAULT-xxx-COOKIE* is pretty much of a hack, since it
 919 ;;; causes LOCALLY to "capture" enclosed proclamations. It is
 920 ;;; necessary because CONVERT-AND-MAYBE-COMPILE uses the value of
 921 ;;; *DEFAULT-COOKIE* as the policy. The need for this hack is due to
 922 ;;; the quirk that there is no way to represent in a cookie that an
 923 ;;; optimize quality came from the default.
 924 (defun process-top-level-locally (form path)
 925   (declare (list path))
 926   (multiple-value-bind (forms decls) (sb!sys:parse-body (cdr form) nil)
 927     (let* ((*lexenv*
 928             (process-decls decls nil nil (make-continuation)))
 929            (*default-cookie* (lexenv-cookie *lexenv*))
 930            (*default-interface-cookie* (lexenv-interface-cookie *lexenv*)))
 931       (process-top-level-progn forms path))))
 932
 933 ;;; Force any pending top-level forms to be compiled and dumped so
 934 ;;; that they will be evaluated in the correct package environment.
 935 ;;; Dump the form to be evaled at (cold) load time, and if EVAL is
 936 ;;; true, eval the form immediately.
 937 (defun process-cold-load-form (form path eval)
 938   (let ((object *compile-object*))
 939     (etypecase object
 940       (fasl-file
 941        (compile-top-level-lambdas () t)
 942        (fasl-dump-cold-load-form form object))
 943       ((or null core-object)
 944        (convert-and-maybe-compile form path)))
 945     (when eval
 946       (eval form))))
 947
 948 (declaim (special *compiler-error-bailout*))
 949
 950 ;;; Process a top-level FORM with the specified source PATH.
 951 ;;;  * If this is a magic top-level form, then do stuff.
 952 ;;;  * If this is a macro, then expand it.
 953 ;;;  * Otherwise, just compile it.
 954 (defun process-top-level-form (form path)
 955
 956   (declare (list path))
 957
 958   (catch 'process-top-level-form-error-abort
 959     (let* ((path (or (gethash form *source-paths*) (cons form path)))
 960            (*compiler-error-bailout*
 961             #'(lambda ()
 962                 (convert-and-maybe-compile
 963                  `(error "execution of a form compiled with errors:~% ~S"
 964                          ',form)
 965                  path)
 966                 (throw 'process-top-level-form-error-abort nil))))
 967       (if (atom form)
 968           (convert-and-maybe-compile form path)
 969           (case (car form)
 970             ;; FIXME: It's not clear to me why we would want this
 971             ;; special case; it might have been needed for some
 972             ;; variation of the old GENESIS system, but it certainly
 973             ;; doesn't seem to be needed for ours. Sometime after the
 974             ;; system is running I'd like to remove it tentatively and
 975             ;; see whether anything breaks, and if nothing does break,
 976             ;; remove it permanently. (And if we *do* want special
 977             ;; treatment of all these, we probably want to treat WARN
 978             ;; the same way..)
 979             ((error cerror break signal)
 980              (process-cold-load-form form path nil))
 981             ;; FIXME: ANSI seems to encourage things like DEFSTRUCT to
 982             ;; be done with EVAL-WHEN, without this kind of one-off
 983             ;; compiler magic.
 984             (sb!kernel:%compiler-defstruct
 985              (convert-and-maybe-compile form path)
 986              (compile-top-level-lambdas () t))
 987             ((eval-when)
 988              (unless (>= (length form) 2)
 989                (compiler-error "EVAL-WHEN form is too short: ~S" form))
 990              (do-eval-when-stuff
 991               (cadr form) (cddr form)
 992               #'(lambda (forms)
 993                   (process-top-level-progn forms path))))
 994             ((macrolet)
 995              (unless (>= (length form) 2)
 996                (compiler-error "MACROLET form is too short: ~S" form))
 997              (do-macrolet-stuff
 998               (cadr form)
 999               #'(lambda ()
1000                   (process-top-level-progn (cddr form) path))))
1001             (locally (process-top-level-locally form path))
1002             (progn (process-top-level-progn (cdr form) path))
1003             (t
1004              (let* ((uform (uncross form))
1005                     (exp (preprocessor-macroexpand uform)))
1006                (if (eq exp uform)
1007                    (convert-and-maybe-compile uform path)
1008                    (process-top-level-form exp path))))))))
1009
1010   (values))
1011 \f
1012 ;;;; load time value support
1013 ;;;;
1014 ;;;; (See EMIT-MAKE-LOAD-FORM.)
1015
1016 ;;; Returns T iff we are currently producing a fasl-file and hence
1017 ;;; constants need to be dumped carefully.
1018 (defun producing-fasl-file ()
1019   (unless *converting-for-interpreter*
1020     (fasl-file-p *compile-object*)))
1021
1022 ;;; Compile FORM and arrange for it to be called at load-time. Return
1023 ;;; the dumper handle and our best guess at the type of the object.
1024 (defun compile-load-time-value
1025        (form &optional
1026              (name (let ((*print-level* 2) (*print-length* 3))
1027                      (format nil "load time value of ~S"
1028                              (if (and (listp form)
1029                                       (eq (car form) 'make-value-cell))
1030                                  (second form)
1031                                  form)))))
1032   (let ((lambda (compile-load-time-stuff form name t)))
1033     (values
1034      (fasl-dump-load-time-value-lambda lambda *compile-object*)
1035      (let ((type (leaf-type lambda)))
1036        (if (function-type-p type)
1037            (single-value-type (function-type-returns type))
1038            *wild-type*)))))
1039
1040 ;;; Compile the FORMS and arrange for them to be called (for effect,
1041 ;;; not value) at load time.
1042 (defun compile-make-load-form-init-forms (forms name)
1043   (let ((lambda (compile-load-time-stuff `(progn ,@forms) name nil)))
1044     (fasl-dump-top-level-lambda-call lambda *compile-object*)))
1045
1046 ;;; Does the actual work of COMPILE-LOAD-TIME-VALUE or
1047 ;;; COMPILE-MAKE-LOAD-FORM- INIT-FORMS.
1048 (defun compile-load-time-stuff (form name for-value)
1049   (with-ir1-namespace
1050    (let* ((*lexenv* (make-null-lexenv))
1051           (lambda (ir1-top-level form *current-path* for-value)))
1052      (setf (leaf-name lambda) name)
1053      (compile-top-level (list lambda) t)
1054      lambda)))
1055
1056 ;;; Called by COMPILE-TOP-LEVEL when it was pased T for
1057 ;;; LOAD-TIME-VALUE-P (which happens in COMPILE-LOAD-TIME-STUFF). We
1058 ;;; don't try to combine this component with anything else and frob
1059 ;;; the name. If not in a :TOP-LEVEL component, then don't bother
1060 ;;; compiling, because it was merged with a run-time component.
1061 (defun compile-load-time-value-lambda (lambdas)
1062   (assert (null (cdr lambdas)))
1063   (let* ((lambda (car lambdas))
1064          (component (block-component (node-block (lambda-bind lambda)))))
1065     (when (eq (component-kind component) :top-level)
1066       (setf (component-name component) (leaf-name lambda))
1067       (compile-component component)
1068       (clear-ir1-info component))))
1069
1070 ;;; The entry point for MAKE-LOAD-FORM support. When IR1 conversion
1071 ;;; finds a constant structure, it invokes this to arrange for proper
1072 ;;; dumping. If it turns out that the constant has already been
1073 ;;; dumped, then we don't need to do anything.
1074 ;;;
1075 ;;; If the constant hasn't been dumped, then we check to see whether
1076 ;;; we are in the process of creating it. We detect this by
1077 ;;; maintaining the special *CONSTANTS-BEING-CREATED* as a list of all
1078 ;;; the constants we are in the process of creating. Actually, each
1079 ;;; entry is a list of the constant and any init forms that need to be
1080 ;;; processed on behalf of that constant.
1081 ;;;
1082 ;;; It's not necessarily an error for this to happen. If we are
1083 ;;; processing the init form for some object that showed up *after*
1084 ;;; the original reference to this constant, then we just need to
1085 ;;; defer the processing of that init form. To detect this, we
1086 ;;; maintain *CONSTANTS-CREATED-SINCE-LAST-INIT* as a list of the
1087 ;;; constants created since the last time we started processing an
1088 ;;; init form. If the constant passed to emit-make-load-form shows up
1089 ;;; in this list, then there is a circular chain through creation
1090 ;;; forms, which is an error.
1091 ;;;
1092 ;;; If there is some intervening init form, then we blow out of
1093 ;;; processing it by throwing to the tag PENDING-INIT. The value we
1094 ;;; throw is the entry from *CONSTANTS-BEING-CREATED*. This is so the
1095 ;;; offending init form can be tacked onto the init forms for the
1096 ;;; circular object.
1097 ;;;
1098 ;;; If the constant doesn't show up in *CONSTANTS-BEING-CREATED*, then
1099 ;;; we have to create it. We call MAKE-LOAD-FORM and check to see
1100 ;;; whether the creation form is the magic value
1101 ;;; :JUST-DUMP-IT-NORMALLY. If it is, then we don't do anything. The
1102 ;;; dumper will eventually get its hands on the object and use the
1103 ;;; normal structure dumping noise on it.
1104 ;;;
1105 ;;; Otherwise, we bind *CONSTANTS-BEING-CREATED* and
1106 ;;; *CONSTANTS-CREATED-SINCE- LAST-INIT* and compile the creation form
1107 ;;; much the way LOAD-TIME-VALUE does. When this finishes, we tell the
1108 ;;; dumper to use that result instead whenever it sees this constant.
1109 ;;;
1110 ;;; Now we try to compile the init form. We bind
1111 ;;; *CONSTANTS-CREATED-SINCE- LAST-INIT* to NIL and compile the init
1112 ;;; form (and any init forms that were added because of circularity
1113 ;;; detection). If this works, great. If not, we add the init forms to
1114 ;;; the init forms for the object that caused the problems and let it
1115 ;;; deal with it.
1116 (defvar *constants-being-created* nil)
1117 (defvar *constants-created-since-last-init* nil)
1118 ;;; FIXME: Shouldn't these^ variables be bound in LET forms?
1119 (defun emit-make-load-form (constant)
1120   (assert (fasl-file-p *compile-object*))
1121   (unless (or (fasl-constant-already-dumped constant *compile-object*)
1122               ;; KLUDGE: This special hack is because I was too lazy
1123               ;; to rework DEF!STRUCT so that the MAKE-LOAD-FORM
1124               ;; function of LAYOUT returns nontrivial forms when
1125               ;; building the cross-compiler but :IGNORE-IT when
1126               ;; cross-compiling or running under the target Lisp. --
1127               ;; WHN 19990914
1128               #+sb-xc-host (typep constant 'layout))
1129     (let ((circular-ref (assoc constant *constants-being-created* :test #'eq)))
1130       (when circular-ref
1131         (when (find constant *constants-created-since-last-init* :test #'eq)
1132           (throw constant t))
1133         (throw 'pending-init circular-ref)))
1134     (multiple-value-bind (creation-form init-form)
1135         (handler-case
1136             (sb!xc:make-load-form constant (make-null-lexenv))
1137           (error (condition)
1138                  (compiler-error "(while making load form for ~S)~%~A"
1139                                  constant
1140                                  condition)))
1141       (case creation-form
1142         (:just-dump-it-normally
1143          (fasl-validate-structure constant *compile-object*)
1144          t)
1145         (:ignore-it
1146          nil)
1147         (t
1148          (compile-top-level-lambdas () t)
1149          (when (fasl-constant-already-dumped constant *compile-object*)
1150            (return-from emit-make-load-form nil))
1151          (let* ((name (let ((*print-level* 1) (*print-length* 2))
1152                         (with-output-to-string (stream)
1153                           (write constant :stream stream))))
1154                 (info (if init-form
1155                           (list constant name init-form)
1156                           (list constant))))
1157            (let ((*constants-being-created*
1158                   (cons info *constants-being-created*))
1159                  (*constants-created-since-last-init*
1160                   (cons constant *constants-created-since-last-init*)))
1161              (when
1162                  (catch constant
1163                    (fasl-note-handle-for-constant
1164                     constant
1165                     (compile-load-time-value
1166                      creation-form
1167                      (format nil "creation form for ~A" name))
1168                     *compile-object*)
1169                    nil)
1170                (compiler-error "circular references in creation form for ~S"
1171                                constant)))
1172            (when (cdr info)
1173              (let* ((*constants-created-since-last-init* nil)
1174                     (circular-ref
1175                      (catch 'pending-init
1176                        (loop for (name form) on (cdr info) by #'cddr
1177                          collect name into names
1178                          collect form into forms
1179                          finally
1180                          (compile-make-load-form-init-forms
1181                           forms
1182                           (format nil "init form~:[~;s~] for ~{~A~^, ~}"
1183                                   (cdr forms) names)))
1184                        nil)))
1185                (when circular-ref
1186                  (setf (cdr circular-ref)
1187                        (append (cdr circular-ref) (cdr info))))))))))))
1188 \f
1189 ;;;; COMPILE-FILE
1190
1191 ;;; We build a list of top-level lambdas, and then periodically smash
1192 ;;; them together into a single component and compile it.
1193 (defvar *pending-top-level-lambdas*)
1194
1195 ;;; The maximum number of top-level lambdas we put in a single
1196 ;;; top-level component.
1197 ;;;
1198 ;;; CMU CL 18b used this nontrivially by default (setting it to 10)
1199 ;;; but consequently suffered from the inability to execute some
1200 ;;; troublesome constructs correctly, e.g. inability to load a fasl
1201 ;;; file compiled from the source file
1202 ;;;   (defpackage "FOO" (:use "CL"))
1203 ;;;   (print 'foo::bar)
1204 ;;; because it would dump data-setup fops (including a FOP-PACKAGE for
1205 ;;; "FOO") for the second form before dumping the the code in the
1206 ;;; first form, or the fop to execute the code in the first form. By
1207 ;;; setting this value to 0 by default, we avoid this badness. This
1208 ;;; increases the number of toplevel form functions, and so increases
1209 ;;; the size of object files.
1210 ;;;
1211 ;;; The variable is still supported because when we are compiling the
1212 ;;; SBCL system itself, which is known not contain any troublesome
1213 ;;; constructs, we can set it to a nonzero value, which reduces the
1214 ;;; number of toplevel form objects, reducing the peak memory usage in
1215 ;;; GENESIS, which is desirable, since at least for SBCL version
1216 ;;; 0.6.7, this is the high water mark for memory usage during system
1217 ;;; construction.
1218 (defparameter *top-level-lambda-max* 0)
1219
1220 (defun object-call-top-level-lambda (tll)
1221   (declare (type functional tll))
1222   (let ((object *compile-object*))
1223     (etypecase object
1224       (fasl-file
1225        (fasl-dump-top-level-lambda-call tll object))
1226       (core-object
1227        (core-call-top-level-lambda tll object))
1228       (null))))
1229
1230 ;;; Add LAMBDAS to the pending lambdas. If this leaves more than
1231 ;;; *TOP-LEVEL-LAMBDA-MAX* lambdas in the list, or if FORCE-P is true,
1232 ;;; then smash the lambdas into a single component, compile it, and
1233 ;;; call the resulting function.
1234 (defun sub-compile-top-level-lambdas (lambdas force-p)
1235   (declare (list lambdas))
1236   (setq *pending-top-level-lambdas*
1237         (append *pending-top-level-lambdas* lambdas))
1238   (let ((pending *pending-top-level-lambdas*))
1239     (when (and pending
1240                (or (> (length pending) *top-level-lambda-max*)
1241                    force-p))
1242       (multiple-value-bind (component tll) (merge-top-level-lambdas pending)
1243         (setq *pending-top-level-lambdas* ())
1244         (let ((*byte-compile* (if (eq *byte-compile* :maybe)
1245                                   *byte-compile-top-level*
1246                                   *byte-compile*)))
1247           (compile-component component))
1248         (clear-ir1-info component)
1249         (object-call-top-level-lambda tll))))
1250   (values))
1251
1252 ;;; Compile top-level code and call the top-level lambdas. We pick off
1253 ;;; top-level lambdas in non-top-level components here, calling
1254 ;;; SUB-c-t-l-l on each subsequence of normal top-level lambdas.
1255 (defun compile-top-level-lambdas (lambdas force-p)
1256   (declare (list lambdas))
1257   (let ((len (length lambdas)))
1258     (flet ((loser (start)
1259              (or (position-if #'(lambda (x)
1260                                   (not (eq (component-kind
1261                                             (block-component
1262                                              (node-block
1263                                               (lambda-bind x))))
1264                                            :top-level)))
1265                               lambdas
1266                               :start start)
1267                  len)))
1268       (do* ((start 0 (1+ loser))
1269             (loser (loser start) (loser start)))
1270            ((>= start len)
1271             (when force-p
1272               (sub-compile-top-level-lambdas nil t)))
1273         (sub-compile-top-level-lambdas (subseq lambdas start loser)
1274                                        (or force-p (/= loser len)))
1275         (unless (= loser len)
1276           (object-call-top-level-lambda (elt lambdas loser))))))
1277   (values))
1278
1279 ;;; Compile LAMBDAS (a list of the lambdas for top-level forms) into
1280 ;;; the object file. We loop doing local call analysis until it
1281 ;;; converges, since a single pass might miss something due to
1282 ;;; components being joined by LET conversion.
1283 ;;;
1284 ;;; LOAD-TIME-VALUE-P seems to control whether it's MAKE-LOAD-FORM and
1285 ;;; COMPILE-LOAD-TIME-VALUE stuff. -- WHN 20000201
1286 (defun compile-top-level (lambdas load-time-value-p)
1287   (declare (list lambdas))
1288   (maybe-mumble "locall ")
1289   (loop
1290     (let ((did-something nil))
1291       (dolist (lambda lambdas)
1292         (let* ((component (block-component (node-block (lambda-bind lambda))))
1293                (*all-components* (list component)))
1294           (when (component-new-functions component)
1295             (setq did-something t)
1296             (local-call-analyze component))))
1297       (unless did-something (return))))
1298
1299   (maybe-mumble "IDFO ")
1300   (multiple-value-bind (components top-components hairy-top)
1301       (find-initial-dfo lambdas)
1302     (let ((*all-components* (append components top-components))
1303           (top-level-closure nil))
1304       (when *check-consistency*
1305         (maybe-mumble "[check]~%")
1306         (check-ir1-consistency *all-components*))
1307
1308       (dolist (component (append hairy-top top-components))
1309         (when (pre-environment-analyze-top-level component)
1310           (setq top-level-closure t)))
1311
1312       (let ((*byte-compile*
1313              (if (and top-level-closure (eq *byte-compile* :maybe))
1314                  nil
1315                  *byte-compile*)))
1316         (dolist (component components)
1317           (compile-component component)
1318           (when (replace-top-level-xeps component)
1319             (setq top-level-closure t)))
1320
1321         (when *check-consistency*
1322           (maybe-mumble "[check]~%")
1323           (check-ir1-consistency *all-components*))
1324
1325         (if load-time-value-p
1326             (compile-load-time-value-lambda lambdas)
1327             (compile-top-level-lambdas lambdas top-level-closure)))
1328
1329       (dolist (component components)
1330         (clear-ir1-info component))
1331       (clear-stuff)))
1332   (values))
1333
1334 ;;; Actually compile any stuff that has been queued up for block
1335 ;;; compilation.
1336 (defun finish-block-compilation ()
1337   (when *block-compile*
1338     (when *top-level-lambdas*
1339       (compile-top-level (nreverse *top-level-lambdas*) nil)
1340       (setq *top-level-lambdas* ()))
1341     (setq *block-compile* nil)
1342     (setq *entry-points* nil)))
1343
1344 ;;; Read all forms from INFO and compile them, with output to OBJECT.
1345 ;;; Return (VALUES NIL WARNINGS-P FAILURE-P).
1346 (defun sub-compile-file (info &optional d-s-info)
1347   (declare (type source-info info))
1348   (let* (;; These are bound in WITH-COMPILATION-UNIT now. -- WHN 20000308
1349          #+nil (*compiler-error-count* 0)
1350          #+nil (*compiler-warning-count* 0)
1351          #+nil (*compiler-style-warning-count* 0)
1352          #+nil (*compiler-note-count* 0)
1353          (*block-compile* *block-compile-argument*)
1354          (*package* (sane-package))
1355          (*initial-package* (sane-package))
1356          (*initial-cookie* *default-cookie*)
1357          (*initial-interface-cookie* *default-interface-cookie*)
1358          (*default-cookie* (copy-cookie *initial-cookie*))
1359          (*default-interface-cookie*
1360           (copy-cookie *initial-interface-cookie*))
1361          (*lexenv* (make-null-lexenv))
1362          (*converting-for-interpreter* nil)
1363          (*source-info* info)
1364          (sb!xc:*compile-file-pathname* nil)
1365          (sb!xc:*compile-file-truename* nil)
1366          (*top-level-lambdas* ())
1367          (*pending-top-level-lambdas* ())
1368          (*compiler-error-bailout*
1369           (lambda ()
1370             (compiler-mumble "~2&; fatal error, aborting compilation~%")
1371             (return-from sub-compile-file (values nil t t))))
1372          (*current-path* nil)
1373          (*last-source-context* nil)
1374          (*last-original-source* nil)
1375          (*last-source-form* nil)
1376          (*last-format-string* nil)
1377          (*last-format-args* nil)
1378          (*last-message-count* 0)
1379          (*info-environment* (or *backend-info-environment*
1380                                  *info-environment*))
1381          (*gensym-counter* 0))
1382     (with-compilation-values
1383       (sb!xc:with-compilation-unit ()
1384         (clear-stuff)
1385
1386         (process-sources info)
1387
1388         (finish-block-compilation)
1389         (compile-top-level-lambdas () t)
1390         (let ((object *compile-object*))
1391           (etypecase object
1392             (fasl-file (fasl-dump-source-info info object))
1393             (core-object (fix-core-source-info info object d-s-info))
1394             (null)))
1395         nil))))
1396
1397 ;;; Return a list of pathnames for the named files. All the files must
1398 ;;; exist.
1399 (defun verify-source-files (stuff)
1400   (let* ((stuff (if (listp stuff) stuff (list stuff)))
1401          (default-host (make-pathname
1402                         :host (pathname-host (pathname (first stuff))))))
1403     (flet ((try-with-type (path type error-p)
1404              (let ((new (merge-pathnames
1405                          path (make-pathname :type type
1406                                              :defaults default-host))))
1407                (if (probe-file new)
1408                    new
1409                    (and error-p (truename new))))))
1410       (unless stuff
1411         (error "can't compile with no source files"))
1412       (mapcar #'(lambda (x)
1413                   (let ((x (pathname x)))
1414                     (cond ((typep x 'logical-pathname)
1415                            (try-with-type x "LISP" t))
1416                           ((probe-file x) x)
1417                           ((try-with-type x "lisp"  nil))
1418                           ((try-with-type x "lisp"  t)))))
1419               stuff))))
1420
1421 (defun elapsed-time-to-string (tsec)
1422   (multiple-value-bind (tmin sec) (truncate tsec 60)
1423     (multiple-value-bind (thr min) (truncate tmin 60)
1424       (format nil "~D:~2,'0D:~2,'0D" thr min sec))))
1425
1426 ;;; Print some junk at the beginning and end of compilation.
1427 (defun start-error-output (source-info)
1428   (declare (type source-info source-info))
1429   (dolist (x (source-info-files source-info))
1430     (compiler-mumble "~&; compiling file ~S (written ~A):~%"
1431                      (namestring (file-info-name x))
1432                      (sb!int:format-universal-time nil
1433                                                    (file-info-write-date x)
1434                                                    :style :government
1435                                                    :print-weekday nil
1436                                                    :print-timezone nil)))
1437   (values))
1438
1439 (defun finish-error-output (source-info won)
1440   (declare (type source-info source-info))
1441   (compiler-mumble "~&; compilation ~:[aborted after~;finished in~] ~A~&"
1442                    won
1443                    (elapsed-time-to-string
1444                     (- (get-universal-time)
1445                        (source-info-start-time source-info))))
1446   (values))
1447
1448 ;;; Open some files and call SUB-COMPILE-FILE. If something unwinds
1449 ;;; out of the compile, then abort the writing of the output file, so
1450 ;;; we don't overwrite it with known garbage.
1451 (defun sb!xc:compile-file
1452     (input-file
1453      &key
1454      (output-file (cfp-output-file-default input-file))
1455      ;; FIXME: ANSI doesn't seem to say anything about
1456      ;; *COMPILE-VERBOSE* and *COMPILE-PRINT* being rebound by this
1457      ;; function..
1458      ((:verbose sb!xc:*compile-verbose*) sb!xc:*compile-verbose*)
1459      ((:print sb!xc:*compile-print*) sb!xc:*compile-print*)
1460      (external-format :default)
1461      ((:block-compile *block-compile-argument*) nil)
1462      ((:entry-points *entry-points*) nil)
1463      ((:byte-compile *byte-compile*) *byte-compile-default*))
1464   #!+sb-doc
1465   "Compile INPUT-FILE, producing a corresponding fasl file.
1466    :Output-File
1467       The name of the fasl to output.
1468    :Block-Compile
1469       Determines whether multiple functions are compiled together as a unit,
1470       resolving function references at compile time. NIL means that global
1471       function names are never resolved at compilation time.
1472    :Entry-Points
1473       This specifies a list of function names for functions in the file(s) that
1474       must be given global definitions. This only applies to block
1475       compilation. If the value is NIL (the default) then all functions
1476       will be globally defined.
1477    :Byte-Compile {T | NIL | :MAYBE}
1478       Determines whether to compile into interpreted byte code instead of
1479       machine instructions. Byte code is several times smaller, but much
1480       slower. If :MAYBE, then only byte-compile when SPEED is 0 and
1481       DEBUG <= 1. The default is the value of SB-EXT:*BYTE-COMPILE-DEFAULT*,
1482       which is initially :MAYBE."
1483   (unless (eq external-format :default)
1484     (error "Non-:DEFAULT EXTERNAL-FORMAT values are not supported."))
1485   (let* ((fasl-file nil)
1486          (output-file-name nil)
1487          (compile-won nil)
1488          (warnings-p nil)
1489          (failure-p t) ; T in case error keeps this from being set later
1490          ;; KLUDGE: The listifying and unlistifying in the next calls
1491          ;; is to interface to old CMU CL code which accepted and
1492          ;; returned lists of multiple source files. It would be
1493          ;; cleaner to redo VERIFY-SOURCE-FILES and as
1494          ;; VERIFY-SOURCE-FILE, accepting a single source file, and
1495          ;; do a similar transformation on MAKE-FILE-SOURCE-INFO too.
1496          ;; -- WHN 20000201
1497          (input-pathname (first (verify-source-files (list input-file))))
1498          (source-info (make-file-source-info (list input-pathname))))
1499     (unwind-protect
1500         (progn
1501           (when output-file
1502             (setq output-file-name
1503                   (sb!xc:compile-file-pathname input-file
1504                                                :output-file output-file))
1505             (setq fasl-file
1506                   (open-fasl-file output-file-name
1507                                   (namestring input-pathname)
1508                                   (eq *byte-compile* t))))
1509
1510           (when sb!xc:*compile-verbose*
1511             (start-error-output source-info))
1512           (let ((*compile-object* fasl-file)
1513                 dummy)
1514             (multiple-value-setq (dummy warnings-p failure-p)
1515               (sub-compile-file source-info)))
1516           (setq compile-won t))
1517
1518       (close-source-info source-info)
1519
1520       (when fasl-file
1521         (close-fasl-file fasl-file (not compile-won))
1522         (setq output-file-name (pathname (fasl-file-stream fasl-file)))
1523         (when (and compile-won sb!xc:*compile-verbose*)
1524           (compiler-mumble "~2&; ~A written~%" (namestring output-file-name))))
1525
1526       (when sb!xc:*compile-verbose*
1527         (finish-error-output source-info compile-won)))
1528
1529     (values (if output-file
1530                 ;; Hack around filesystem race condition...
1531                 (or (probe-file output-file-name) output-file-name)
1532                 nil)
1533             warnings-p
1534             failure-p)))
1535 \f
1536 ;;; a helper function for COMPILE-FILE-PATHNAME: the default for
1537 ;;; the OUTPUT-FILE argument
1538 ;;;
1539 ;;; ANSI: The defaults for the OUTPUT-FILE are taken from the pathname
1540 ;;; that results from merging the INPUT-FILE with the value of
1541 ;;; *DEFAULT-PATHNAME-DEFAULTS*, except that the type component should
1542 ;;; default to the appropriate implementation-defined default type for
1543 ;;; compiled files.
1544 (defun cfp-output-file-default (input-file)
1545   (let* ((output-type (make-pathname :type *backend-fasl-file-type*))
1546          (merge1 (merge-pathnames output-type input-file))
1547          (merge2 (merge-pathnames merge1 *default-pathname-defaults*)))
1548     merge2))
1549
1550 ;;; KLUDGE: Part of the ANSI spec for this seems contradictory:
1551 ;;;   If INPUT-FILE is a logical pathname and OUTPUT-FILE is unsupplied,
1552 ;;;   the result is a logical pathname. If INPUT-FILE is a logical
1553 ;;;   pathname, it is translated into a physical pathname as if by
1554 ;;;   calling TRANSLATE-LOGICAL-PATHNAME.
1555 ;;; So I haven't really tried to make this precisely ANSI-compatible
1556 ;;; at the level of e.g. whether it returns logical pathname or a
1557 ;;; physical pathname. Patches to make it more correct are welcome.
1558 ;;; -- WHN 2000-12-09
1559 (defun sb!xc:compile-file-pathname (input-file
1560                                     &key
1561                                     (output-file (cfp-output-file-default
1562                                                   input-file))
1563                                     &allow-other-keys)
1564   #!+sb-doc
1565   "Return a pathname describing what file COMPILE-FILE would write to given
1566    these arguments."
1567   (pathname output-file))