;;;; stuff which is not specific to any particular build phase, but
;;;; used by most of them
;;;;
;;;; Note: It's specifically not used when bootstrapping PCL, because
;;;; we do SAVE-LISP after that, and we don't want to save extraneous
;;;; bootstrapping machinery into the frozen image which will
;;;; subsequently be used as the mother of all Lisp sessions.

;;;; This software is part of the SBCL system. See the README file for
;;;; more information.
;;;;
;;;; This software is derived from the CMU CL system, which was
;;;; written at Carnegie Mellon University and released into the
;;;; public domain. The software is in the public domain and is
;;;; provided with absolutely no warranty. See the COPYING and CREDITS
;;;; files for more information.

;;; SB-COLD holds stuff used to build the initial SBCL core file
;;; (including not only the final construction of the core file, but
;;; also the preliminary steps like e.g. building the cross-compiler
;;; and running the cross-compiler to produce target FASL files).
(defpackage "SB-COLD"
  (:use "CL")
  (:export genesis))

#+nil ; change to #+sbcl if desired, but at your own risk!
(when (sb-sys:find-dynamic-foreign-symbol-address "show_gc_generation_throughput")
  (setf (extern-alien "show_gc_generation_throughput" int) 1))

#+sbcl ; prevent "illegal to redefine standard type: RATIONAL" etc
(when (member "SB-XC" (package-nicknames "CL") :test 'string=)
  (sb-ext:unlock-package "CL")
  (rename-package "CL" "COMMON-LISP" '("CL"))
  (sb-ext:lock-package "CL"))

(in-package "SB-COLD")

(defun parse-make-host-parallelism (str)
  (multiple-value-bind (value1 end) (parse-integer str :junk-allowed t)
    (when value1
      (let ((value2 (if (and value1
                             (< end (1- (length str))) ; ~ /,[\d]+/
                             (eql (char str end) #\,))
                        (parse-integer str :start (1+ end)))))
        ;; If only 1 integer, assume same parallelism for both passes.
        (unless value2
          (setq value2 value1))
        ;; 0 means no parallelism. 1 means use at most one subjob,
        ;; just in case you want to test the controlling loop.
        (when (eql value1 0) (setq value1 nil))
        (when (eql value2 0) (setq value2 nil))
        ;; Parallelism on pass 1 works only if LOAD does not compile.
        ;; Otherwise it's slower than compiling serially.
        ;; (And this has only been tested with sb-fasteval, not sb-eval.)
        (cons (and (find-package "SB-INTERPRETER") value1)
              value2)))))

(defvar *make-host-parallelism* nil)
(defvar *fail-on-warnings* t)
(defun make-host-1-parallelism () (car *make-host-parallelism*))
(defun make-host-2-parallelism () (cdr *make-host-parallelism*))

#+sbcl
(progn
  (setq *make-host-parallelism*
        (let ((envvar (sb-ext:posix-getenv "SBCL_MAKE_PARALLEL")))
          (when envvar
            (require :sb-posix)
            (parse-make-host-parallelism envvar))))
  (defmacro with-subprocesses (&rest body) `(progn ,@body))
  (let ((f (multiple-value-bind (sym access) (find-symbol "OS-EXIT" "SB-SYS")
             (if (eq access :external) sym 'sb-unix:unix-exit))))
    (defun exit-process (arg) (funcall f arg))
    (defun exit-subprocess (arg) (funcall f arg)))
  ;; Lazily reference sb-posix because it may not be loaded
  (defun posix-fork () (funcall (intern "FORK" "HOST-SB-POSIX")))
  (defun getpid () (funcall (intern "UNIX-GETPID" "HOST-SB-UNIX")))
  (defun posix-wait () (funcall (intern "WAIT" "HOST-SB-POSIX"))))

#+clisp
(progn
  (setq *make-host-parallelism*
        (let ((envvar (ext:getenv "SBCL_MAKE_PARALLEL")))
          (when envvar
            (parse-make-host-parallelism envvar))))
  ;; FFI symbols won't exist if libffcall could not be found at build time.
  (defmacro with-subprocesses (&rest rest)
    (cons (or (find-symbol "WITH-SUBPROCESSES" "POSIX") 'progn) rest))
  ;; clisp doesn't expose fork() and consequently doesn't behave
  ;; correctly when (EXT:EXIT) is called in a forked child process.
  (defun exit-process (arg) (ext:exit arg))
  #+#.(cl:if (cl:find-package "FFI") '(and) '(or))
  (progn (ffi:def-call-out exit-subprocess (:name "exit") (:arguments (arg ffi:int))
                  (:library :default) (:language :stdc))
         (ffi:def-call-out posix-fork (:name "fork") (:return-type ffi:int)
                  (:library :default) (:language :stdc)))
  (defun getpid () (posix:process-id))
  (defun posix-wait ()
    (multiple-value-bind (pid status code) (posix:wait)
      (if (eql status :exited)
          (values pid code)
          (values pid (- code))))))

;;; If TRUE, then COMPILE-FILE is being invoked only to process
;;; :COMPILE-TOPLEVEL forms, not to produce an output file.
;;; This is part of the implementation of parallelized make-host-2.
(defvar *compile-for-effect-only* nil)

;;; prefixes for filename stems when cross-compiling. These are quite arbitrary
;;; (although of course they shouldn't collide with anything we don't want to
;;; write over). In particular, they can be either relative path names (e.g.
;;; "host-objects/" or absolute pathnames (e.g. "/tmp/sbcl-xc-host-objects/").
;;;
;;; The cross-compilation process will force the creation of these directories
;;; by executing CL:ENSURE-DIRECTORIES-EXIST (on the xc host Common Lisp).
;;;
;;; With suitable settings of these prefixes it is possible to run simultaneous
;;; builds from one source tree.
(defvar *host-obj-prefix*)
(defvar *target-obj-prefix*)

(defvar *target-obj-suffix*
  ;; Target fasl files are LOADed (actually only quasi-LOADed, in
  ;; GENESIS) only by SBCL code, and it doesn't care about particular
  ;; extensions, so we can use something arbitrary.
  ".lisp-obj")
(defvar *target-assem-obj-suffix*
  ;; Target fasl files from SB-C:ASSEMBLE-FILE are LOADed via GENESIS.
  ;; The source files are compiled once as assembly files and once as
  ;; normal lisp files.  In the past, they were kept separate by
  ;; clever symlinking in the source tree, but that became less clean
  ;; as ports to host environments without symlinks started appearing.
  ;; In order to keep them separate, we have the assembled versions
  ;; with a separate suffix.
  ".assem-obj")

;;; a function of one functional argument, which calls its functional argument
;;; in an environment suitable for compiling the target. (This environment
;;; includes e.g. a suitable *READTABLE* that looks in SB-XC:*FEATURES*
;;; when it reads #- and #+ syntax)
(declaim (type function *in-target-compilation-mode-fn*))
(defvar *in-target-compilation-mode-fn*)

;;;; some tools

;;; Take the file named X and make it into a file named Y. Sorta like
;;; UNIX, and unlike Common Lisp's bare RENAME-FILE, we don't allow
;;; information from the original filename to influence the final
;;; filename. (The reason that it's only sorta like UNIX is that in
;;; UNIX "mv foo bar/" will work, but the analogous
;;; (RENAME-FILE-A-LA-UNIX "foo" "bar/") should fail.)
;;;
;;; (This is a workaround for the weird behavior of Debian CMU CL
;;; 2.4.6, where (RENAME-FILE "dir/x" "dir/y") tries to create a file
;;; called "dir/dir/y". If that behavior goes away, then we should be
;;; able to get rid of this function and use plain RENAME-FILE in the
;;; COMPILE-STEM function above. -- WHN 19990321
(defun rename-file-a-la-unix (x y)

  (let ((path    ;; (Note that the TRUENAME expression here is lifted from an
                 ;; example in the ANSI spec for TRUENAME.)
         (with-open-file (stream y :direction :output)
           (close stream)
           ;; From the ANSI spec: "In this case, the file is closed
           ;; when the truename is tried, so the truename
           ;; information is reliable."
           (truename stream))))
    (delete-file path)
    (rename-file x path)))
(compile 'rename-file-a-la-unix)

(export '(*target-sbcl-version* *generated-sources-root*
          *build-dependent-generated-sources-root*
          stem-source-path find-bootstrap-file read-from-file))
(defvar *sources-root* "")
(defvar *generated-sources-root* "")
(defvar *build-dependent-generated-sources-root* "")
(defvar *src-cold-shared-pathname* *load-pathname*)

;;; See remark in COMPILE-STEM about strings vs. The Common Lisp Way
(defun find-bootstrap-file (namestring &optional build-dependent)
  (cond ((char= (char namestring 0) #\^)
         ;; If it starts with a "^" then it means "src/cold/..."
         (let ((this *src-cold-shared-pathname*)
               (name (subseq namestring 1)))
           (make-pathname :host (pathname-host this)
                          :device (pathname-device this)
                          :directory (pathname-directory this)
                          :name (pathname-name name)
                          :type (or (pathname-type name) (pathname-type this)))))
        ((find #\/ namestring)
         ;; Otherwise if it contains a slash, then it's a source file which is either
         ;; in the tree as checked in, or generated by a prior build step.
         (concatenate 'string
                      (if (eql (mismatch "output/" namestring) 7) ; a generated source
                          (if build-dependent
                              *build-dependent-generated-sources-root*
                              *generated-sources-root*)
                          *sources-root*)
                      namestring))
        (t
         ;; Else, it's an optional user-supplied customization file,
         ;; or a generated data file in the root directory such as "version.lisp-expr"
         namestring)))
(compile 'find-bootstrap-file) ; seems in vogue to compile everything in this file

;;; Return an expression read from the file named NAMESTRING.
;;; For user-supplied inputs, protect against more than one expression
;;; appearing in the file.  (Our ^build-order.lisp-expr file has more than
;;; one expression in it, so we need to be able to not enforce.)
(defun read-from-file (namestring &key (enforce-single-expr t) build-dependent)
  (with-open-file (s (find-bootstrap-file namestring build-dependent))
    (let* ((result (read s))
           (eof-result (cons nil nil)))
      (unless enforce-single-expr
        (return-from read-from-file result))
      (unless (eq (read s nil eof-result) eof-result)
        (error "more than one expression in file ~S" namestring))
      result)))
(compile 'read-from-file)

#+sbcl (let ((ext (find-package "SB-EXT")))
         ;; prevent things from working by accident when they would not work in
         ;; ANSI lisp, e.g. ~/print-symbol-with-prefix/ (missing SB-EXT:)
         (when (member ext (package-use-list "CL-USER"))
           (unuse-package ext "CL-USER")))

#+cmu
(progn
  ;; too much noise, can't see the actual warnings
  (setq cl:*compile-print* nil
        ext:*gc-verbose* nil))

#+sbcl
(progn
  (setq cl:*compile-print* nil)
  (load (find-bootstrap-file "^muffler"))
  ;; Let's just say we never care to see these.
  (declaim (sb-ext:muffle-conditions
            (satisfies unable-to-optimize-note-p)
            (satisfies optional+key-style-warning-p)
            sb-ext:code-deletion-note)))

;;;; special read-macros for building the cold system (and even for
;;;; building some of our tools for building the cold system)

(load (find-bootstrap-file "^shebang"))

(defun custom-or-default (var default)
  (if (boundp var) (symbol-value var) default))

;;; Subfeatures could be assigned as late as the beginning of make-host-2,
;;; but I don't want to introduce another mechanism for delaying reading
;;; of the customizer just because we can.
;;; But it's not well-advertised; does it really merit a customization file?
(export 'backend-subfeatures)
(defvar backend-subfeatures
  (let* ((customizer-file-name
          (custom-or-default 'cl-user::*sbcl-backend-subfeatures-file*
                             "customize-backend-subfeatures.lisp")))
    (when (probe-file customizer-file-name)
      (copy-list (funcall (compile nil (read-from-file customizer-file-name)) nil)))))

;;; When cross-compiling, the *FEATURES* set for the target Lisp is
;;; not in general the same as the *FEATURES* set for the host Lisp.
;;; In order to refer to target features specifically, we refer to
;;; SB-XC:*FEATURES* instead of CL:*FEATURES*.
;;;
;;; To support building in a read-only filesystem, the 'local-target-features'
;;; file might not be directly located here, since it's a generated file.
;;; In as much as we use files as the means of passing parameters to
;;; our Lisp scripts - because we can't in general assume that we can read
;;; the command-line arguments in any Lisp - it doesn't make sense to have
;;; another file specifying the name of the local-target-features file.
;;; The compromise is to examine a variable specifying a path
;;; (and it can't go in SB-COLD because the package is not made soon enough)
(setf sb-xc:*features*
      (let* ((pathname (custom-or-default 'cl-user::*sbcl-local-target-features-file*
                                          "local-target-features.lisp-expr"))
             (default-features
               (funcall (compile nil (read-from-file pathname))
                        (read-from-file "^base-target-features.lisp-expr")))
             (customizer-file-name
              (custom-or-default 'cl-user::*sbcl-customize-target-features-file*
                                 "customize-target-features.lisp"))
             (customizer (if (probe-file customizer-file-name)
                             (compile nil
                                      (read-from-file customizer-file-name))
                             #'identity))
             ;; Bind temporarily so that TARGET-FEATUREP and TARGET-PLATFORM-KEYWORD
             ;; can see the tentative list.
             (sb-xc:*features* (funcall customizer default-features))
             (gc (intersection '(:cheneygc :gencgc :mark-region-gc)
                               sb-xc:*features*))
             (arch (target-platform-keyword)))
        (when (member :mark-region-gc sb-xc:*features*)
          (setf sb-xc:*features* (remove :gencgc sb-xc:*features*)
                gc (remove :gencgc gc)))
        (unless (and gc (not (cdr gc)))
          (error "Exactly 1 GC implementation needs to be selected"))
        (setq gc (car gc))
        ;; all our GCs are generational
        (when (member gc '(:gencgc :mark-region-gc))
          (pushnew :generational sb-xc:*features*))
        (when (eq gc :mark-region-gc)
          (setq sb-xc:*features* (remove :immobile-space sb-xc:*features*)))
        ;; Win32 conditionally adds :sb-futex in grovel-features.sh
        ;; Futexes aren't available in all macos versions, but they are available in
        ;; all versions that support arm, so always enable them there
        (when (target-featurep '(:and :sb-thread (:or :linux :freebsd :openbsd (:and :darwin :arm64))))
          (pushnew :sb-futex sb-xc:*features*))
        (when (target-featurep '(:and :sb-thread (:or :arm64 :x86-64)))
          (pushnew :system-tlabs sb-xc:*features*))
        (when (target-featurep '(:and (:or :permgen :immobile-space) :x86-64))
          (pushnew :compact-instance-header sb-xc:*features*))
        (when (target-featurep :sb-cover-for-internals)
          ;; coverage of internals currently works substantially
          ;; better if we preserve more information, and don't do
          ;; various link-time optimizations.
          (pushnew :sb-devel sb-xc:*features*))
        (when (target-featurep :immobile-space)
          (pushnew :immobile-code sb-xc:*features*))
        (when (target-featurep '(:and :sb-thread (:or (:and :darwin (:not (:or :ppc :x86))) :openbsd)))
          (push :os-thread-stack sb-xc:*features*))
        (when (target-featurep '(:and :sb-thread :x86-64 (:or :darwin :linux)
                                      (:not :mark-region-gc)))
          (push :tls-load-indirect sb-xc:*features*))
        (when (target-featurep '(:and :x86 :int4-breakpoints))
          ;; 0xCE is a perfectly good 32-bit instruction,
          ;; unlike on x86-64 where it is illegal. It's therefore
          ;; confusing to allow this feature in a 32-bit build.
          ;; But it's annoying to have a build script that otherwise works
          ;; for a native x86/x86-64 build except for needing one change.
          ;; Just print something and go on with life.
          (setq sb-xc:*features* (remove :int4-breakpoints sb-xc:*features*))
          (warn "Removed :INT4-BREAKPOINTS from target features"))
        (when (target-featurep :x86-64)
          (let ((int3-enable (target-featurep :int3-breakpoints))
                (int4-enable (target-featurep :int4-breakpoints))
                (ud2-enable (target-featurep :ud2-breakpoints)))
            (when (or ud2-enable int4-enable)
              (setq sb-xc:*features* (remove :int3-breakpoints sb-xc:*features*))
              (when (and ud2-enable int4-enable)
                (error "UD2-BREAKPOINTS and INT4-BREAKPOINTS are mutually exclusive choices")))
            (unless (or int3-enable int4-enable ud2-enable)
              ;; don't love the name, but couldn't think of a better one
              (push :sw-int-avoidance sb-xc:*features*))))
        (when (or (target-featurep :arm64)
                  (and (target-featurep :x86-64)
                       (member :sse4 backend-subfeatures)))
          (push :round-float sb-xc:*features*))
        (when (target-featurep '(:and :arm64 :darwin))
          (push :arm-v8.1 backend-subfeatures))
        (when (target-featurep '(:and :ppc64 :little-endian))
          (push :fsqrt backend-subfeatures))

        ;; Putting arch and gc choice first is visually convenient, versus
        ;; having to parse a random place in the line to figure out the value
        ;; of a binary choice {cheney vs gencgc} and architecture.
        ;; De-duplicate the rest of the symbols because the command line
        ;; can add redundant --with-mumble options.
        (list* arch gc (sort (remove-duplicates
                              (remove arch (remove gc sb-xc:*features*)))
                             #'string<))))

;;; Call for effect of signaling an error if no target picked.
(target-platform-keyword)

;;; You can get all the way through make-host-1 without either one of these
;;; features, but then 'bit-bash' will fail to cross-compile.
(unless (intersection '(:big-endian :little-endian) sb-xc:*features*)
  (warn "You'll have bad time without either endian-ness defined"))

;;; Some feature combinations simply don't work, and sometimes don't
;;; fail until quite a ways into the build.  Pick off the more obvious
;;; combinations now, and provide a description of what the actual
;;; failure is (not always obvious from when the build fails).
(let ((feature-compatibility-tests
       '(("(and sb-safepoint (not sb-thread))" ":SB-SAFEPOINT requires :SB-THREAD")
         ("(and sb-thread (not (or riscv ppc ppc64 x86 x86-64 arm64 loongarch64)))"
          ":SB-THREAD not supported on selected architecture")
         ("(and mark-region-gc (not (or x86-64 arm64)))"
          "mark-region is not supported on selected architecture")
         ("(and mark-region-gc (not sb-thread))" "mark-region requires threads")
         ("(and (not sb-thread) (or arm64 ppc64))"
          "The selected architecture requires :SB-THREAD")
         ("(and gencgc cheneygc)"
          ":GENCGC and :CHENEYGC are incompatible")
         ("(and sb-safepoint (not (and (or arm64 x86 x86-64) (or darwin linux win32))))"
          ":SB-SAFEPOINT not supported on selected arch/OS")
         ("(not (or elf mach-o win32))"
          "No execute object file format feature defined")
         ("(and cons-profiling (not sb-thread))" ":CONS-PROFILING requires :SB-THREAD")
         ("(and sb-linkable-runtime (not (or arm arm64 x86 x86-64 ppc ppc64)))"
          ":SB-LINKABLE-RUNTIME not supported on selected architecture")
         ("(and sb-linkable-runtime (not (or darwin freebsd linux win32)))"
          ":SB-LINKABLE-RUNTIME not supported on selected operating system")
         ("(and sb-eval sb-fasteval)"
          ;; It sorta kinda works to have both, but there should be no need,
          ;; and it's not really supported.
          "At most one interpreter can be selected")
         ("(and immobile-space permgen)"
          ":IMMOBILE-SPACE and :PERMGEN are mutually exclusive options")
         ("(and compact-instance-header (not (or permgen immobile-space)))"
          ":COMPACT-INSTANCE-HEADER requires :IMMOBILE-SPACE feature")
         ("(and immobile-code (not immobile-space))"
          ":IMMOBILE-CODE requires :IMMOBILE-SPACE feature")
         ("(and immobile-symbols (not immobile-space))"
          ":IMMOBILE-SYMBOLS requires :IMMOBILE-SPACE feature")
         ("(and system-tlabs (not sb-thread))"
          ":SYSTEM-TLABS requires SB-THREAD")
         ("(and sb-futex (not sb-thread))"
          "Can't enable SB-FUTEX on platforms lacking thread support")
         ("(and relocatable-static-space (not (or arm64 x86-64)))"
          "Relocatable-static-space not supported for chosen architecture")
         ("(and relocatable-static-space arm64 (not immobile-space))"
          "Relocatable-static-space requires immobile-space")
         ;; There is still hope to make multithreading on DragonFly x86-64
         ("(and sb-thread x86 dragonfly)"
          ":SB-THREAD not supported on selected architecture")
         ("(and nonstop-foreign-call (not (and (or arm64 x86-64) sb-thread (not sb-safepoint))))"
          ":NONSTOP-FOREIGN-CALL not supported with this combination of features")))
      (failed-test-descriptions nil))
  (dolist (test feature-compatibility-tests)
    (let ((*readtable* *xc-readtable*))
      (when (read-from-string (concatenate 'string "#+" (first test) "T NIL"))
        (push (second test) failed-test-descriptions))))
  (when failed-test-descriptions
    (error "Feature compatibility check failed, ~S"
           (reverse failed-test-descriptions))))

;;;; cold-init-related PACKAGE and SYMBOL tools

;;; Once we're done with possibly ANSIfying the COMMON-LISP package,
;;; it's probably a mistake if we change it (beyond changing the
;;; values of special variables such as *** and +, anyway). Set up
;;; machinery to warn us when/if we change it.
;;;
;;; All code depending on this is itself dependent on #+SB-SHOW.
(defvar *cl-snapshot*)
(when (member :sb-show sb-xc:*features*)
  (load (find-bootstrap-file "^snapshot"))
  (setq *cl-snapshot* (take-snapshot "COMMON-LISP")))

;;;; master list of source files and their properties

;;; flags which can be used to describe properties of source files
(defparameter *expected-stem-flags*
  '(;; meaning: This file is needed to generate C headers if doing so
    ;; independently of make-host-1
    :c-headers
    ;; meaning: This file is not to be compiled when building the
    ;; cross-compiler which runs on the host ANSI Lisp. ("not host
    ;; code", i.e. does not execute on host -- but may still be
    ;; cross-compiled by the host, so that it executes on the target)
    :not-host
    ;; meaning: This file is not to be compiled as part of the target
    ;; SBCL. ("not target code" -- but still presumably host code,
    ;; used to support the cross-compilation process)
    :not-target
    ;; meaning: The #'COMPILE-STEM argument :TRACE-FILE should be T.
    ;; When the compiler is SBCL's COMPILE-FILE or something like it,
    ;; compiling "foo.lisp" will generate "foo.trace" which contains lots
    ;; of exciting low-level information about representation selection,
    ;; VOPs used by the compiler, and bits of assembly.
    :trace-file
    ;; meaning: When cold-loading this file while producing the
    ;; initial cold core, genesis should produce a trace file of the
    ;; fops (fasl operations) executed.
    :foptrace-file
    ;; meaning: The #'COMPILE-STEM argument :BLOCK-COMPILE should be
    ;; T. That is, the entire file will be block compiled. Like
    ;; :TRACE-FILE, this applies to all COMPILE-FILEs which support
    ;; something like :BLOCK-COMPILE.
    :block-compile
    ;; meaning: This file is to be processed with the SBCL assembler,
    ;; not COMPILE-FILE. (Note that this doesn't make sense unless
    ;; :NOT-HOST is also set, since the SBCL assembler doesn't exist
    ;; while the cross-compiler is being built in the host ANSI Lisp.)
    :assem
    ;; meaning: ignore this flag.
    ;; This works around nonstandard behavior of "#." in certain hosts.
    ;; When the evaluated form yields 0 values, ECL and CLISP treat it
    ;; as though if yielded NIL:
    ;; * (read-from-string "#(#.(cl:if (cl:eql 1 2) x (values)))")
    ;;   => #(NIL)
    ;; The correct value for the above expression - as obtained in SBCL,
    ;; CCL, and ABCL - is #() because _any_ reader macro is permitted
    ;; to produce 0 values. In fact you can demonstrate this by actually
    ;; implementing your own "#." which conditionally returns 0 values,
    ;; and seeing that it works in any lisp including the suspect ones.
    ;; The oft-used idiom of "#+#.(cl:if (test) '(and) '(or)) X"
    ;; is sufficiently unclear that its worth allowing a spurious NIL
    ;; just to avoid that ugly mess.
    nil))

(defmacro do-stems-and-flags ((stem flags build-phase) &body body)
  (let ((stem-and-flags (gensym "STEM-AND-FLAGS")))
    `(dolist (,stem-and-flags (get-stems-and-flags ,build-phase))
       (let ((,stem (first ,stem-and-flags))
             (,flags (rest ,stem-and-flags)))
         ,@body))))

;;; Given a STEM, remap the path components "/{arch}/" and "/asm-target/"
;;; to suitable directories.
(defun stem-remap-target (stem)
  (flet ((try-replacing (this that)
           (let ((position (search this stem)))
             (when position
               (concatenate 'string
                            (subseq stem 0 (1+ position))
                            (string-downcase that)
                            (subseq stem (+ position (length this) -1)))))))
    (or (try-replacing "/{arch}/" (target-platform-keyword))
        (try-replacing "/asm-target/" (backend-assembler-target-name))
        stem)))
(compile 'stem-remap-target)

;;; Determine the source path for a stem by remapping from the abstract name
;;; if it contains "/{arch}/" and appending a ".lisp" suffix.
;;; Assume that STEM is source-tree-relative unless it starts with "output/"
;;; in which case the file is not under source control, but has a generator script.
(defun stem-source-path (stem)
  ;; Tell FIND-BOOTSTRAP-FILE that the stem is BUILD-DEPENDENT for generated files,
  ;; because "output/stuff-groveled-from-headers" can be sensitive to the
  ;; architecture even for a single OS - e.g.
  ;;  (define-alien-type wst-blksize-t (signed 32)) ; arm64 Linux
  ;;  (define-alien-type wst-blksize-t (signed 64)) ; x86-64 Linux
  ;; If running multiarchitecture builds at the same time out of one tree,
  ;; it is essential that we look in *BUILD-DEPENDENT-GENERATED-SOURCES-ROOT*.
  (concatenate 'string (find-bootstrap-file (stem-remap-target stem) t) ".lisp"))
(compile 'stem-source-path)

;;; Determine the object path for a stem/flags/mode combination.
(export 'stem-object-path)
(defun stem-object-path (stem flags mode)
  (multiple-value-bind (obj-prefix obj-suffix)
      (ecase mode
        (:host-compile
         ;; On some xc hosts, it's impossible to LOAD a fasl file unless it
         ;; has the same extension that the host uses for COMPILE-FILE
         ;; output, so we have to be careful to use the xc host's preferred
         ;; extension.
         (values *host-obj-prefix*
                 (concatenate 'string "."
                              (pathname-type (compile-file-pathname stem)))))
        (:target-compile
         (values *target-obj-prefix*
                 (cond ((find :assem flags) *target-assem-obj-suffix*)
                       (t *target-obj-suffix*)))))
    (concatenate 'string obj-prefix (stem-remap-target stem) obj-suffix)))
(compile 'stem-object-path)

(defvar *stems-and-flags* nil)
;;; Read the set of files to compile with respect to a build phase, 1 or 2.
(defun get-stems-and-flags (build-phase)
  (when (and *stems-and-flags* (eql (car *stems-and-flags*) build-phase))
    (return-from get-stems-and-flags (cdr *stems-and-flags*)))
  (let* ((feature (aref #(:sb-xc-host :sb-xc) (1- build-phase)))
         (list
          ;; The build phase feature goes into CL:*FEATURES*, not SB-XC:*FEATURES*
          ;; because firstly we don't use feature expressions to control the set of
          ;; files pertinent to the build phase - that is governed by :NOT-{HOST,TARGET}
          ;; flags, and secondly we can not assume existence of the SB-XC package in
          ;; warm build. The sole reason for this hack is to allow testing for CMU
          ;; as the build host in make-host-1 which apparently needs to be allowed
          ;; to produce warnings as a bug workaround.
          (let ((cl:*features* (cons feature cl:*features*))
                (*readtable* *xc-readtable*))
            (read-from-file "^build-order.lisp-expr" :enforce-single-expr nil))))
    (setf *stems-and-flags* (cons build-phase list)))
  ;; Now check for duplicate stems and bogus flags.
  (let ((stems (make-hash-table :test 'equal)))
    (do-stems-and-flags (stem flags build-phase)
    ;; We do duplicate stem comparison based on the object path in
    ;; order to cover the case of stems with an :assem flag, which
    ;; have two entries but separate object paths for each.  KLUDGE:
    ;; We have to bind *target-obj-prefix* here because it's normally
    ;; set up later in the build process and we don't actually care
    ;; what it is so long as it doesn't change while we're checking
    ;; for duplicate stems.
      (let* ((*target-obj-prefix* "")
             (object-path (stem-object-path stem flags :target-compile)))
        (if (gethash object-path stems)
            (error "duplicate stem ~S in *STEMS-AND-FLAGS*" stem)
            (setf (gethash object-path stems) t)))
    ;; Check for stupid typos in FLAGS list keywords.
    ;; FIXME: We should make sure that the :assem flag is only used
    ;; when paired with :not-host.
      (let ((set-difference (set-difference flags *expected-stem-flags*)))
        (when set-difference
          (error "found unexpected flag(s) in *STEMS-AND-FLAGS*: ~S"
                 set-difference)))))
  (cdr *stems-and-flags*))

;;;; tools to compile SBCL sources to create the cross-compiler

;;; a wrapper for compilation/assembly, used mostly to centralize
;;; the procedure for finding full filenames from "stems"
;;;
;;; Compile the source file whose basic name is STEM, using some
;;; standard-for-the-SBCL-build-process procedures to generate the
;;; full pathnames of source file and object file. Return the pathname
;;; of the object file for STEM.
;;;
;;; STEM and FLAGS are as per DO-STEMS-AND-FLAGS.  MODE is one of
;;; :HOST-COMPILE and :TARGET-COMPILE.
(defun compile-stem (stem flags mode)
  (let* ((src (stem-source-path stem))
         (obj (stem-object-path stem flags mode))
         ;; Compile-for-effect happens simultaneously with a forked compile,
         ;; so we need the for-effect output not to stomp on the real output.
         (tmp-obj
           (concatenate 'string obj
                        (if *compile-for-effect-only* "-scratch" "-tmp")))
         (compilation-fn
                       (ecase mode
                         (:host-compile
                          #+abcl ; ABCL complains about its own deficiency and then returns T
                          ;; for warnings and failure. "Unable to compile function" is not our problem,
                          ;; but I tried everything to muffle it, and nothing worked; so if it occurs,
                          ;; treat the file as a success despite any actual problems that may exist.
                          (lambda (&rest args)
                            (let (compiler-bug)
                              ;; Even though COMPILER-UNSUPPORTED-FEATURE-ERROR is a condition class,
                              ;; HANDLER-BIND seems unable to match it. What the hell? Bugs all the way down.
                              (handler-bind ((condition
                                              (lambda (c)
                                                (when (search "Using interpreted form" (princ-to-string c))
                                                  (setq compiler-bug t)))))
                                (multiple-value-bind (fasl warn err) (apply #'compile-file args)
                                  (if compiler-bug (values fasl nil nil) (values fasl warn err))))))
                          #+ccl ; CCL doesn't like NOTINLINE on unknown functions
                          (lambda (&rest args)
                            (handler-bind ((ccl:compiler-warning
                                             (lambda (c)
                                               (when (eq (ccl::compiler-warning-warning-type c)
                                                         :unknown-declaration-function)
                                                 (muffle-warning c)))))
                              (apply #'compile-file args)))
                          #-(or abcl ccl) #'compile-file)
                         (:target-compile
                          (intern (if (find :assem flags) "ASSEMBLE-FILE" "COMPILE-FILE")
                                  "SB-C"))))
         (trace-file (if (find :trace-file flags) t nil))
         (block-compile (if (find :block-compile flags) t :specified)))
    (declare (type (or function symbol) compilation-fn))

    (ensure-directories-exist obj :verbose cl:*compile-print*) ; host's value

    ;; We're about to set about building a new object file. First, we
    ;; delete any preexisting object file in order to avoid confusing
    ;; ourselves later should we happen to bail out of compilation
    ;; with an error.
    (when (and (not *compile-for-effect-only*) (probe-file obj))
      (delete-file obj))

    ;; Original comment:
    ;;
    ;;   Work around a bug in CLISP 1999-01-08 #'COMPILE-FILE: CLISP
    ;;   mangles relative pathnames passed as :OUTPUT-FILE arguments,
    ;;   but works OK with absolute pathnames.
    ;;
    ;; following discussion on cmucl-imp 2002-07
    ;; "COMPILE-FILE-PATHNAME", it would seem safer to deal with
    ;; absolute pathnames all the time; it is no longer clear that the
    ;; original behaviour in CLISP was wrong or that the current
    ;; behaviour is right; and in any case absolutifying the pathname
    ;; insulates us against changes of behaviour. -- CSR, 2002-08-09
    (setf tmp-obj
          ;; (Note that this idiom is taken from the ANSI
          ;; documentation for TRUENAME.)
          (with-open-file (stream tmp-obj
                                  :direction :output
                                  ;; Compilation would overwrite the
                                  ;; temporary object anyway and overly
                                  ;; strict implementations default
                                  ;; to :ERROR.
                                  :if-exists :supersede)
            (close stream)
            (truename stream)))
    ;; and some compilers (e.g. OpenMCL) will complain if they're
    ;; asked to write over a file that exists already (and isn't
    ;; recognizeably a fasl file), so
    (when (probe-file tmp-obj)
      (delete-file tmp-obj))

    ;; Try to use the compiler to generate a new temporary object file.
    (flet ((report-recompile-restart (stream)
             (format stream "Recompile file ~S" src))
           (report-continue-restart (stream)
             (format stream "Continue, using possibly bogus file ~S" obj)))
      (tagbody
       retry-compile
         (multiple-value-bind (output-truename warnings-p failure-p)
             (restart-case
                 (apply compilation-fn src
                        :output-file tmp-obj
                        :block-compile (and
                                        ;; Block compilation was
                                        ;; completely broken from the
                                        ;; beginning of SBCL history
                                        ;; until version 2.0.2.
                                        #+sbcl
                                        (or (eq mode :target-compile)
                                            (and (find-symbol "SPLIT-VERSION-STRING" "HOST-SB-C")
                                                 (funcall (find-symbol "VERSION>=" "HOST-SB-C")
                                                          (funcall (find-symbol "SPLIT-VERSION-STRING" "HOST-SB-C")
                                                                   (lisp-implementation-version))
                                                          '(2 0 2))))
                                        block-compile)
                        :allow-other-keys t
                        ;; If tracing, also print, but don't specify :PRINT unless specifying
                        ;; :TRACE-FILE so that whatever the default is for *COMPILE-PRINT*
                        ;; prevails, insensitively to whether it's the SB-XC: or CL: symbol.
                        (when trace-file
                          '(:trace-file t :print t)))
               (recompile ()
                 :report report-recompile-restart
                 (go retry-compile)))
           (declare (ignore warnings-p))
           (cond ((not output-truename)
                  (error "couldn't compile ~S" src))
                 (failure-p
                  (unwind-protect
                       (restart-case
                           (error "FAILURE-P was set when creating ~S."
                                  obj)
                         (recompile ()
                           :report report-recompile-restart
                           (go retry-compile))
                         (continue ()
                           :report report-continue-restart
                           (setf failure-p nil)))
                    ;; Don't leave failed object files lying around.
                    (when (and failure-p (probe-file tmp-obj))
                      (delete-file tmp-obj)
                      (format t "~&deleted ~S~%" tmp-obj))))
                 ;; Otherwise: success, just fall through.
                 (t nil)))))

    ;; If we get to here, compilation succeeded, so it's OK to rename
    ;; the temporary output file to the permanent object file.
    (cond ((not *compile-for-effect-only*)
           (rename-file-a-la-unix tmp-obj obj))
          ((probe-file tmp-obj)
           (delete-file tmp-obj)))      ; clean up the trash

    ;; nice friendly traditional return value
    (pathname obj)))
(compile 'compile-stem)

(defparameter *host-quirks*
  (or #+cmu  '(:host-quirks-cmu)
      #+ecl  '(:host-quirks-ecl)
      #+ccl  '(:host-quirks-ccl)
      #+sbcl '(:host-quirks-sbcl))) ; not so much a "quirk", but consistent anyway

;;; Execute function FN in an environment appropriate for compiling the
;;; cross-compiler's source code in the cross-compilation host.
(defun in-host-compilation-mode (fn)
  (declare (type function fn))
  (let ((sb-xc:*features* (append '(:sb-xc-host) *host-quirks* sb-xc:*features*))
        (*readtable* *xc-readtable*))
    (funcall fn)))
(compile 'in-host-compilation-mode)

;;; Process a file as source code for the cross-compiler, compiling it
;;; (if necessary) in the appropriate environment, then loading it
;;; into the cross-compilation host Common lisp.
(defun host-cload-stem (stem flags)
  (loop
   (with-simple-restart (recompile "Recompile")
     (let ((compiled-filename (in-host-compilation-mode
                               (lambda ()
                                 (compile-stem stem flags :host-compile)))))
       (return
         (load compiled-filename))))))
(compile 'host-cload-stem)

;;; like HOST-CLOAD-STEM, except that we don't bother to compile
(defun host-load-stem (stem flags)
  (loop
   (with-simple-restart (recompile "Reload")
     (return (load (stem-object-path stem flags :host-compile))))))
(compile 'host-load-stem)

;;;; tools to compile SBCL sources to create object files which will
;;;; be used to create the target SBCL .core file

(defun lpnify-stem (stem)
  ;; Don't want genfiles path to sneak in - avoid (STEM-SOURCE-PATH ...) here.
  (let ((string (stem-remap-target stem)))
    ;; Distrust that random hosts don't bork up the translation.
    ;; Simply replace '/' with ';' and be done.
    (format nil "SYS:~:@(~A~).LISP" (substitute #\; #\/ string))))
(compile 'lpnify-stem)

;;; Run the cross-compiler on a file in the source directory tree to
;;; produce a corresponding file in the target object directory tree.
(defun target-compile-stem (stem flags)
  (let ((system-tlab-p
         (or (search "src/pcl" stem)
             (search "src/code/alieneval" stem)
             (search "src/code/arena" stem)
             (search "src/code/avltree" stem)
             (search "src/code/brothertree" stem)
             (search "src/code/early-classoid" stem)
             (search "src/code/type-class" stem)
             (search "src/code/class" stem)
             (search "src/code/debug" stem) ; also matches debug-{info,int,var-io}
             (search "src/code/early-defmethod" stem)
             (search "src/code/final" stem)
             (search "src/code/format" stem)
             (search "src/code/solist" stem))))
    (funcall *in-target-compilation-mode-fn*
           (lambda ()
             (progv (list (intern "*SOURCE-NAMESTRING*" "SB-C")
                          (intern "*FORCE-SYSTEM-TLAB*" "SB-C"))
                    (list (lpnify-stem stem)
                          system-tlab-p)
               (loop
                (with-simple-restart (recompile "Recompile")
                  (return (compile-stem stem flags :target-compile)))))))))
(compile 'target-compile-stem)

;;; (This function is not used by the build process, but is intended
;;; for interactive use when experimenting with the system. It runs
;;; the cross-compiler on test files with arbitrary filenames, not
;;; necessarily in the source tree, e.g. in "/tmp".)
(defun target-compile-file (filename)
  (funcall *in-target-compilation-mode-fn*
           (lambda ()
             (funcall (intern "COMPILE-FILE" "SB-XC") filename))))
(compile 'target-compile-file)

(defvar *math-ops-memoization* (make-hash-table :test 'equal))
(defun math-journal-pathname (direction)
  ;; Initialy we read from the file in the source tree, but writeback occurs
  ;; to a new local file. Then if re-reading we read the local copy of the cache.
  ;; This should allow multiple builds to happen (via make-all-targets.sh) in a
  ;; single source tree. If exactly one target is built, we can mv the local file
  ;; on top of the source file. For more than one, we could either merge them
  ;; or just ignore any modifications.
  (let* ((base "xfloat-math.lisp-expr")
         (final (concatenate 'string "output/" base))
         (local (concatenate 'string *host-obj-prefix* base)))
    (pathname
     (ecase direction
       (:input (if (probe-file local) local final))
       (:output local)))))

(defun count-lines-of (pathname &aux (n 0))
  (with-open-file (f pathname)
    (loop (let ((line (read-line f nil)))
            (if line (incf n) (return n))))))

(defmacro with-math-journal (&body body)
  `(let* ((table *math-ops-memoization*)
          (memo (cons table (hash-table-count table))))
     (assert (atom table)) ; prevent nested use of this macro
     (let ((*math-ops-memoization* memo))
       ,@body)
     (when nil ; *compile-verbose*
       (funcall (intern "SHOW-INTERNED-NUMBERS" "SB-IMPL") *standard-output*))
     (when (> (hash-table-count table) (cdr memo))
       (let ((filename (math-journal-pathname :output)))
         (with-open-file (stream filename :direction :output
                                          :if-exists :supersede)
           (funcall (intern "DUMP-MATH-MEMOIZATION-TABLE" "SB-IMPL")
                    table stream))
         ;; Enforce absence of spurious newlines from pretty-printing or whatever
         ;; If this assertion is wrong on other lisps we can just remove it
         (assert (= (count-lines-of filename) (+ (hash-table-count table) 5)))
         (format t "~&; Math journal: wrote ~S (~d entries)"
                 filename (hash-table-count table))))))

;;;; One more journal file because the math file isn't enough
;;; Define this before renaming the SB- packages
;;; A non-parallelized compile using a sufficiently new SBCL as the host
;;; will use a paravirtualized implementation of generate-perfect-hash-sexpr
;;; which is to say, it just uses the host; as a side-effect it records
;;; the generated string so that we can replay it for any host
;;; or for parallelized build.
(defvar *perfect-hash-generator-mode* :PLAYBACK)
(defvar *perfect-hash-generator-memo* nil)

;;; A separate file is used for each possible value of N-FIXNUM-BITS.
;;; Therefore any particular set of symbols appears at most once per file.
(defun perfect-hash-generator-journal (direction)
  (let* ((bits (symbol-value (intern "N-FIXNUM-BITS" "SB-VM")))
         (stem (ecase bits
                 ((30 61 63)
                  (format nil "xperfecthash~D.lisp-expr" bits)))))
    (ecase direction
      (:input stem)
      (:output (if (search "/xbuild/" *host-obj-prefix*)
                   ;; parallel build writes to a subdirectory
                   (concatenate 'string *target-obj-prefix* stem)
                   ;; normal build writes the file in place
                   stem)))))

(defun perfect-hash-generator-program ()
  ;; The path depends on what the host is, not what the target is
  #+unix "tools-for-build/perfecthash"
  #+win32 "tools-for-build/perfecthash.exe")

#+(or sbcl ecl ccl clisp cmucl)
(when (probe-file (perfect-hash-generator-program))
  (pushnew :use-host-hash-generator cl:*features*)
  (setq *perfect-hash-generator-mode* :RECORD))

;;; I want this to work using the host-native readtable if sb-cold:*xc-readtable*
;;; isn't established. The caller should bind *READTABLE* to ours if reading
;;; on a non-SBCL host; it's purposely not done here.
(defun preload-perfect-hash-generator (pathname)
  (with-open-file (stream pathname :if-does-not-exist nil)
    (when stream
      (let ((entries (let ((*read-base* 16)) (read stream)))
            (uniqueness-checker (make-hash-table :test 'equalp))
            (errors 0)
            (linenum 0))
        (setq *perfect-hash-generator-memo*
              ;; Compute the XOR of all the hashes of each entry as a quick pass/fail
              ;; when searching, assuming thst EQUALP compares (CAR CONS) before
              ;; the CDR, which is almost surely, though not necessarily, what it does.
              (mapcar (lambda (entry)
                        (incf linenum)
                        (destructuring-bind (array identifier expression) entry
                          ;; ARRAY is read as simple-vector, not UB32.
                          ;; (It actually doesn't matter how it's stored in memory)
                          (setq array (coerce array '(simple-array (unsigned-byte 32) (*))))
                          ;; assert that the entry was stored in canonical form
                          (assert (equalp array (sort (copy-seq array) #'<)))
                          ;; assert that there are not redundant lines.
                          ;; (Changing the pretty-printing from C must not write
                          ;; a distinct line if its key already existed)
                          (let ((existsp (gethash array uniqueness-checker)))
                            (cond ((not existsp)
                                   (setf (gethash array uniqueness-checker)
                                         (list expression linenum)))
                                  (t
                                   (warn "~X maps to~%~{~S from line ~D~}~%~S from line ~D~%"
                                         array existsp expression linenum)
                                   (incf errors))))
                          (let ((digest (reduce #'logxor array)))
                            (list* (cons digest array) identifier expression))))
                      entries))
        (when (plusp errors)
          (error "hash generator duplicates: ~D" errors))))))
(compile 'preload-perfect-hash-generator)

#+use-host-hash-generator
(defun run-perfecthash (input)
  (with-output-to-string (result)
    (flet (#+sbcl
           (launch ()
             (let ((process (sb-ext:run-program (perfect-hash-generator-program)
                                                '()
                                                :input :stream :output :stream
                                                :wait nil
                                                :allow-other-keys t
                                                :use-posix-spawn t)))
               (values (sb-ext:process-output process)
                       (sb-ext:process-input process)
                       process)))
           #+sbcl
           (wait (process)
             (sb-ext:process-wait process)
             (sb-ext:process-close process)
             (unless (zerop (sb-ext:process-exit-code process))
               (error "Error running perfecthash: exit code ~D"
                      (sb-ext:process-exit-code process))))
           #+cmu
           (launch ()
             (let ((process (ext:run-program (perfect-hash-generator-program)
                                             '()
                                             :input :stream :output :stream
                                             :wait nil)))
               (values (ext:process-output process)
                       (ext:process-input process)
                       process)))
           #+cmu
           (wait (process)
             (ext:process-wait process)
             (ext:process-close process)
             (unless (zerop (ext:process-exit-code process))
               (error "Error running perfecthash: exit code ~D"
                      (ext:process-exit-code process))))
           #+clisp
           (launch ()
             (multiple-value-bind (io-stream input-stream output-stream)
                 (ext:run-program (perfect-hash-generator-program)
                                  :input :stream :output :stream)
               (declare (ignore io-stream))
               (values input-stream output-stream nil)))
           #+(or clisp ccl)
           (wait (process)
             process)
           #+ecl
           (launch ()
             (let ((process
                     (nth-value 2 (ext:run-program (perfect-hash-generator-program)
                                                   ()
                                                   :input :stream :output :stream
                                                   :wait nil))))
               (values (ext:external-process-output process)
                       (ext:external-process-input process)
                       process)))
           #+ecl
           (wait (process)
             (multiple-value-bind (status code) (ext:external-process-wait process t)
               (unless (and (eq status :exited)
                            (zerop code))
                 (error "Error running perfecthash: exit code ~D" code))))
           #+ccl
           (launch ()
             (let ((process
                     (ccl:run-program (perfect-hash-generator-program)
                                      ()
                                      :wait nil
                                      :input :stream :output :stream)))
               (values (ccl:external-process-output-stream process)
                       (ccl:external-process-input-stream process)
                       process))))
      (multiple-value-bind (input-stream output-stream process) (launch)
        (format output-stream "~{~X~%~}" (coerce input 'list))
        (close output-stream)
        (loop for char = (read-char input-stream nil)
              while char
              do (write-char char result))
        (close input-stream)
        (wait process)))))


(defun emulate-generate-perfect-hash-sexpr (array identifier digest)
  (declare #-use-host-hash-generator (ignore identifier))
  ;; Entries are written to disk with hashes sorted in ascending order so that
  ;; comparing as sets can be done using EQUALP.
  ;; Sort nondestructively in case something else looks at the value as supplied.
  (let* ((canonical-array (sort (copy-seq array) #'<))
         (match (assoc (cons digest canonical-array) *perfect-hash-generator-memo*
                       :test #'equalp)))
    (when match
      (return-from emulate-generate-perfect-hash-sexpr (cddr match)))
    (ecase *perfect-hash-generator-mode*
      (:playback
       (error "perfect hash file is missing a needed entry for ~x" array))
      #+use-host-hash-generator
      (:record
       ;; This will only display anything when we didn't have the data,
       ;; so it's actually not too "noisy" in a normal build.
       (let ((string (run-perfecthash array))
             computed)
         (let* (;; don't need the final newline, it looks un-lispy in the file
                (l (length string)))
           (assert (char= (char string (1- l)) #\newline))
           (setq computed (subseq string 0 (1- l))))
         (let ((*print-right-margin* 200) (*print-level* nil) (*print-length* nil))
           (format t "~&Recording perfect hash:~%~S~%~X~%"
                   identifier array))
         (setf *perfect-hash-generator-memo*
               (nconc *perfect-hash-generator-memo*
                      (list (list* (cons digest canonical-array)
                                   identifier
                                   computed))))
         computed)))))

;;; Unlike xfloat-math which expresses universal truths, the perfect-hash file
;;; expresses facts about the behavior of a _particular_ SBCL revision.
;;; It was overly challenging to alter the calc-symbol-name-hash algorithm
;;; without being forced to re-run every cross-build to determine what the 32-bit
;;; inputs would be to the perfect hash generator. By storing a representations of
;;; objects that contributed to the key calculation, we can in theory recreate the
;;; perfect hash file for all relevant objects without a rebuild under every
;;; combination of architectures and features. A few difficulties:
;;; * Hashes should be emitted in base 16 because the C program wants that,
;;;   but our extended array syntax uses base 10 since it's more natural.
;;;   i..e "#A((16) (unsigned-byte 8) ...)"
;;; * Packages have to exist when the file is read, so we can't read symbols
;;;   into an architecture-specific package like sb-arm-asm.
;;;   Since symbol-name-hash is based solely on print-name, it's irrelevant what
;;;   the package is, so it's always OK to use keywords.
;;;
;;; I screwed this up multiple differerent ways when developing it.
;;; For example the symbol ADD was getting printed without a colon, and reparsed
;;; as 2781 in base 16.
;;; Finally I hit upon a solution which solves just about everything:
;;; write the identifying information as a string, which works around nonexistence
;;; of the following, among others:
;;;  - symbol SB-KERNEL:SIMD-PACK-TYPE for #-x86-64
;;;  - symbol SB-KERNEL:HANDLE-WIN32-EXCEPTION for #-win32
;;;  - package SB-APROF for #-x86-64
;;;
;;; Separating the files by N-FIXNUM-TAG-BITS works to nearly guarantee
;;; that any particular set of symbols appears once and once only, so you don't
;;; have to wonder why it appears more than once, and under what circumstance
;;; the hashes should be different for the same symbols.
;;; Unfortunately, that was too aspirational. The problem stems from NIL in a
;;; list of symbols. Since the address of NIL depends on the architecture,
;;; and not only that, the particular *FEATURES*, we might have different
;;; hashes for NIL. Like without sb-thread, there will be an alloc-region
;;; placed in static space below NIL which shifts NIL's address higher,
;;; which changes its hash.
(defun save-perfect-hashfuns (pathname entries)
  (with-open-file (*standard-output* pathname
                   :direction :output
                   :if-exists :supersede
                   :if-does-not-exist :create)
    (write-string "(
")
    (let ((*print-pretty* t) (*print-length* nil) (*print-level* nil)
          (*print-lines* nil) (*print-right-margin* 128))
      (dolist (entry entries)
        (destructuring-bind ((digest . array) identifier . string) entry
          (declare (ignore digest))
          (unless (stringp identifier)
            ;; If this entry was read from the file, it's already a string
            (setq identifier
                  (let ((*package* (find-package "SB-KERNEL")))
                    (write-to-string identifier :escape :t :pretty nil))))
          (format t "(~X~% ~S~% ~S)~%" array identifier string))))
    (write-string ")
;; EOF
")))
(compile 'save-perfect-hashfuns)

(defun update-perfect-hashfuns (sources destination)
  (flet ((load-file (pathname)
           (mapcar (lambda (entry)
                     (destructuring-bind (array identifier expression) entry
                       (setq array (coerce array '(simple-array (unsigned-byte 32) (*))))
                       (assert (equalp array (sort (copy-seq array) #'<)))
                       (let ((digest (reduce #'logxor array)))
                         (list* (cons digest array) identifier expression))))
                   (with-open-file (stream pathname :if-does-not-exist nil)
                     (when stream
                       (let ((*read-base* 16)) (read stream))))))
         (compare (a1 a2)
           (do ((i 0 (1+ i)))
               ((or (= i (length a1)) (= i (length a2)))
                (= i (length a1)))
             (unless (= (aref a1 i) (aref a2 i))
               (return (< (aref a1 i) (aref a2 i)))))))
    (let ((entries (load-file destination)))
      (dolist (source sources)
        (dolist (entry (load-file source))
          (unless (assoc (car entry) entries :test #'equalp)
            (push entry entries))))
      (setq entries (sort entries #'compare :key #'cdar))
      (save-perfect-hashfuns destination entries))))

(defun maybe-save-perfect-hashfuns-for-playback ()
  ;; Check again for corruption
  (let ((uniqueness-checker (make-hash-table :test 'equalp)))
    (dolist (entry *perfect-hash-generator-memo*)
      (let ((array (cdar entry)))
        (assert (not (gethash array uniqueness-checker)))
        (setf (gethash array uniqueness-checker) t))))
  #+(and use-host-hash-generator sbcl)
  (when (eq *perfect-hash-generator-mode* :record)
    (save-perfect-hashfuns (perfect-hash-generator-journal :output)
                           *perfect-hash-generator-memo*))
  t)

;;;; Please avoid writing "consecutive" (un-nested) reader conditionals
;;;; in this file, whether for the same or different feature test.
;;;; The following example prints 3 different results in 3 different lisp
;;;; implementations all of which have feature :linux (and not :nofeat).
#|
(let ((i 0))
  (dolist (s '("#-nofeat #+linux a b c d e"
               "#-nofeat #-linux a b c d e"
               "#+nofeat #-linux a b c d e"
               "#+nofeat #+linux a b c d e"
               "#+linux #-nofeat a b c d e"
               "#-linux #-nofeat a b c d e"
               "#-linux #+nofeat a b c d e"
               "#+linux #+nofeat a b c d e"
               "#+linux #-linux a b c d e"
               "#-linux #-linux a b c d e"
               "#-linux #+linux a b c d e"
               "#+linux #+linux a b c d e"
               "#+nofeat #-nofeat a b c d e"
               "#-nofeat #-nofeat a b c d e"
               "#-nofeat #+nofeat a b c d e"
               "#+nofeat #+nofeat a b c d e"))
  (format t "test ~2d: ~a ~s~%"
          (incf i)
          (let ((stream (make-string-input-stream s)))
            (list (read stream) (read stream) (read stream)))
          s)))
|#
