source: branches/qres/ccl/lib/nfcomp.lisp @ 14259

Last change on this file since 14259 was 14259, checked in by gz, 9 years ago

r14258 from trunk (defstruct changes)

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 88.7 KB
Line 
1;;-*-Mode: LISP; Package: CCL -*-
2;;;
3;;;   Copyright (C) 2009 Clozure Associates
4;;;   Copyright (C) 1994-2001 Digitool, Inc
5;;;   This file is part of Clozure CL. 
6;;;
7;;;   Clozure CL is licensed under the terms of the Lisp Lesser GNU Public
8;;;   License , known as the LLGPL and distributed with Clozure CL as the
9;;;   file "LICENSE".  The LLGPL consists of a preamble and the LGPL,
10;;;   which is distributed with Clozure CL as the file "LGPL".  Where these
11;;;   conflict, the preamble takes precedence. 
12;;;
13;;;   Clozure CL is referenced in the preamble as the "LIBRARY."
14;;;
15;;;   The LLGPL is also available online at
16;;;   http://opensource.franz.com/preamble.html
17
18(in-package "CCL")
19
20;; :lib:nfcomp.lisp - New fasl compiler.
21
22(eval-when (:compile-toplevel :load-toplevel :execute)
23   (require 'level-2))
24
25(require 'optimizers)
26(require 'hash)
27
28(eval-when (:compile-toplevel :execute)
29
30(require 'backquote)
31(require 'defstruct-macros)
32
33(defmacro short-fixnum-p (fixnum)
34  `(and (fixnump ,fixnum) (< (integer-length ,fixnum) 16)))
35
36(require "FASLENV" "ccl:xdump;faslenv")
37
38#+ppc32-target
39(require "PPC32-ARCH")
40#+ppc64-target
41(require "PPC64-ARCH")
42#+x8632-target
43(require "X8632-ARCH")
44#+x8664-target
45(require "X8664-ARCH")
46) ;eval-when (:compile-toplevel :execute)
47
48
49;File compiler options.  Not all of these need to be exported/documented, but
50;they should be in the product just in case we need them for patches....
51(defvar *fasl-save-local-symbols* t)
52(defvar *fasl-save-doc-strings*  t)
53(defvar *fasl-save-definitions* nil)
54
55(defvar *fasl-deferred-warnings* nil)
56(defvar *fasl-non-style-warnings-signalled-p* nil)
57(defvar *fasl-warnings-signalled-p* nil)
58
59(defvar *compile-verbose* nil ; Might wind up getting called *compile-FILE-verbose*
60  "The default for the :VERBOSE argument to COMPILE-FILE.")
61(defvar *compile-file-pathname* nil
62  "The defaulted pathname of the file currently being compiled, or NIL if not
63  compiling.") ; pathname of src arg to COMPILE-FILE
64(defvar *compile-file-truename* nil
65  "The TRUENAME of the file currently being compiled, or NIL if not
66  compiling.") ; truename ...
67(defvar *fasl-target* (backend-name *host-backend*))
68(defvar *fasl-backend* *host-backend*)
69(defvar *fasl-host-big-endian*
70  (arch::target-big-endian (backend-target-arch *host-backend*)))
71(defvar *fasl-target-big-endian* *fasl-host-big-endian*)
72(defvar *fcomp-external-format* :default)
73
74(defvar *fasl-break-on-program-errors* #+ccl-qres nil #-ccl-qres :defer
75  "Controls what happens when the compiler detects PROGRAM-ERROR's during file compilation.
76
77  If T, the compiler signals an error immediately when it detects the program-error.
78
79  If :DEFER, program errors are reported as compiler warnings, and in addition, an error
80    is signalled at the end of file compilation.  This allows all warnings for the file
81    to be reported, but prevents the creation of a fasl file.
82
83  If NIL, program errors are treated the same as any other error condition detected by
84   the compiler, i.e. they are reported as compiler warnings and do not cause any
85   error to be signalled at compile time.")
86 
87
88(defvar *compile-print* nil ; Might wind up getting called *compile-FILE-print*
89  "The default for the :PRINT argument to COMPILE-FILE.")
90
91;Note: errors need to rebind this to NIL if they do any reading without
92; unwinding the stack!
93(declaim (special *compiling-file*)) ; defined in l1-init.
94
95(defvar *fasl-source-file* nil "Name of file currently being read from.
96Will differ from *compiling-file* during an INCLUDE")
97
98(defparameter *fasl-package-qualified-symbols* '(*loading-file-source-file* set-package %define-package)
99  "These symbols are always fasdumped with full package qualification.")
100
101(defun setup-target-features (backend features)
102  (if (eq backend *host-backend*)
103    features
104    (let* ((new nil)
105           (nope (backend-target-specific-features *host-backend*)))
106      (dolist (f features)
107        (unless (memq f nope) (pushnew f new)))
108      (dolist (f (backend-target-specific-features backend)
109               (progn (pushnew :cross-compiling new) new))
110        (pushnew f new)))))
111
112(defun compile-file-pathname (pathname &rest ignore &key output-file &allow-other-keys)
113  "Return a pathname describing what file COMPILE-FILE would write to given
114   these arguments."
115  (declare (ignore ignore))
116  (setq pathname (merge-pathnames pathname))
117  (merge-pathnames (if output-file
118                     (merge-pathnames output-file *.fasl-pathname*)
119                     *.fasl-pathname*) 
120                   pathname))
121
122(defun compile-file (src &key output-file
123                         (verbose *compile-verbose*)
124                         (print *compile-print*)
125                         load
126                         features
127                         (target *fasl-target* target-p)
128                         (save-local-symbols *fasl-save-local-symbols*)
129                         (save-doc-strings *fasl-save-doc-strings*)
130                         (save-definitions *fasl-save-definitions*)
131                         (save-source-locations *save-source-locations*)
132                         (external-format :default)
133                         force
134                         ;; src may be a temp file with a section of the real source,
135                         ;; then this is the real source file name.
136                         compile-file-original-truename
137                         (compile-file-original-buffer-offset 0)
138                         (break-on-program-errors (if compile-file-original-truename
139                                                    t  ;; really SLIME being interactive...
140                                                    *fasl-break-on-program-errors*)))
141  "Compile SRC, producing a corresponding fasl file and returning its filename."
142  (let* ((backend *target-backend*))
143    (when (and target-p (not (setq backend (find-backend target))))
144      (warn "Unknown :TARGET : ~S.  Reverting to ~s ..." target *fasl-target*)
145      (setq target *fasl-target*  backend *target-backend*))
146    (multiple-value-bind (output-file truename warnings-p serious-p)
147        (loop
148          (restart-case
149              (return (%compile-file src output-file verbose print features
150                                     save-local-symbols save-doc-strings save-definitions
151                                     save-source-locations break-on-program-errors
152                                     force backend external-format
153                                     compile-file-original-truename compile-file-original-buffer-offset))
154            (retry-compile-file ()
155              :report (lambda (stream) (format stream "Retry compiling ~s" src))
156              nil)
157            (skip-compile-file ()
158              :report (lambda (stream)
159                        (if load
160                          (format stream "Skip compiling and loading ~s" src)
161                          (format stream "Skip compiling ~s" src)))
162              (return-from compile-file))))
163      (when load (load output-file :verbose (or verbose *load-verbose*)))
164      (values truename warnings-p serious-p))))
165
166
167(defvar *fasl-compile-time-env* nil)
168
169(defun %compile-file (src output-file verbose print features
170                          save-local-symbols save-doc-strings save-definitions
171                          save-source-locations break-on-program-errors
172                          force target-backend external-format
173                          compile-file-original-truename compile-file-original-buffer-offset)
174  (let* ((orig-src (merge-pathnames src))
175         (output-default-type (backend-target-fasl-pathname target-backend))
176         (*fasl-non-style-warnings-signalled-p* nil)
177         (*fasl-warnings-signalled-p* nil))
178    (setq src (fcomp-find-file orig-src))
179    (let* ((newtype (pathname-type src)))
180      (when (and newtype (not (pathname-type orig-src)))
181        (setq orig-src (merge-pathnames orig-src (make-pathname :type newtype :defaults nil)))))
182    (setq output-file (merge-pathnames
183                       (if output-file  ; full-pathname in case output-file is relative
184                         (full-pathname (merge-pathnames output-file output-default-type) :no-error nil) 
185                         output-default-type)
186                       orig-src))
187    ;; This should not be necessary, but it is.
188    (setq output-file (namestring output-file))
189    (when (physical-pathname-p orig-src) ; only back-translate to things likely to exist at load time
190      (setq orig-src (back-translate-pathname orig-src '("home" "ccl"))))
191    (when (and (not force)
192               (probe-file output-file)
193               (not (fasl-file-p output-file)))
194      (cerror "overwrite it anyway"
195              "Compile destination ~S is not a ~A file!"
196              output-file (pathname-type
197                           (backend-target-fasl-pathname
198                            *target-backend*))))
199    (let* ((*features* (append (if (listp features) features (list features)) (setup-target-features target-backend *features*)))
200           (*fasl-deferred-warnings* nil) ; !!! WITH-COMPILATION-UNIT ...
201           (*fasl-save-local-symbols* save-local-symbols)
202           (*save-source-locations* save-source-locations)
203           (*fasl-save-doc-strings* save-doc-strings)
204           (*fasl-save-definitions* save-definitions)
205           (*fasl-break-on-program-errors* break-on-program-errors)
206           (*fcomp-warnings-header* nil)
207           (*compile-file-pathname* orig-src)
208           (*compile-file-truename* (truename src))
209           (*package* *package*)
210           (*readtable* *readtable*)
211           (*compile-print* print)
212           (*compile-verbose* verbose)
213           (*fasl-target* (backend-name target-backend))
214           (*fasl-backend* target-backend)
215           (*fasl-target-big-endian* (arch::target-big-endian
216                                      (backend-target-arch target-backend)))
217           (*target-ftd* (backend-target-foreign-type-data target-backend))
218           (defenv (new-definition-environment))
219           (lexenv (new-lexical-environment defenv))
220           (*fasl-compile-time-env* (new-lexical-environment (new-definition-environment)))
221           (*fcomp-external-format* external-format)
222           (forms nil))
223      (let ((current *outstanding-deferred-warnings*) last)
224        (when (and current
225                   (setq last (deferred-warnings.last-file current))
226                   (equalp *compile-file-pathname* (cdr last)))
227          ;; Discard previous deferred warnings when recompiling exactly the same file again,
228          ;; since most likely this is due to an interactive "retry compilation" request and
229          ;; we want to avoid duplicate warnings.
230          (setf (deferred-warnings.last-file current) nil)))
231
232      (let* ((*outstanding-deferred-warnings* (%defer-warnings nil)))
233        (rplacd (defenv.type defenv) *outstanding-deferred-warnings*)
234        (setf (defenv.defined defenv) (deferred-warnings.defs *outstanding-deferred-warnings*))
235
236        (setq forms (fcomp-file src
237                                (or compile-file-original-truename (namestring orig-src))
238                                compile-file-original-buffer-offset
239                                lexenv))
240
241        (setf (deferred-warnings.warnings *outstanding-deferred-warnings*) 
242              (append *fasl-deferred-warnings* (deferred-warnings.warnings *outstanding-deferred-warnings*)))
243        (when *compile-verbose* (fresh-line))
244        (multiple-value-bind (any harsh) (report-deferred-warnings *compile-file-pathname*)
245          (setq *fasl-warnings-signalled-p* (or *fasl-warnings-signalled-p* any)
246                *fasl-non-style-warnings-signalled-p* (if (eq harsh :very) :very
247                                                        (or *fasl-non-style-warnings-signalled-p* harsh)))))
248      (when (and *fasl-break-on-program-errors* (eq *fasl-non-style-warnings-signalled-p* :very))
249        (cerror "create the output file despite the errors"
250                "Serious errors encountered during compilation of ~s"
251                src))
252      (fasl-scan-forms-and-dump-file forms output-file lexenv)
253      (values output-file
254              (truename (pathname output-file)) 
255              *fasl-warnings-signalled-p* 
256              (and *fasl-non-style-warnings-signalled-p* t)))))
257
258(defvar *fcomp-locked-hash-tables*)
259(defvar *fcomp-load-forms-environment* nil)
260
261; This is separated out so that dump-forms-to-file can use it
262(defun fasl-scan-forms-and-dump-file (forms output-file &optional env)
263  (let ((*fcomp-locked-hash-tables* nil)
264        (*fcomp-load-forms-environment* env))
265    (unwind-protect
266      (multiple-value-bind (hash gnames goffsets) (fasl-scan forms)
267        (fasl-dump-file gnames goffsets forms hash output-file))
268      (fasl-unlock-hash-tables))))
269
270#-bccl
271(defun nfcomp (src &optional dest &rest keys)
272  (when (keywordp dest) (setq keys (cons dest keys) dest nil))
273  (apply #'compile-file src :output-file dest keys))
274
275#-bccl
276(%fhave 'fcomp #'nfcomp)
277
278(defparameter *default-file-compilation-policy* (new-compiler-policy))
279
280(defun current-file-compiler-policy ()
281  *default-file-compilation-policy*)
282
283(defun set-current-file-compiler-policy (&optional new-policy)
284  (setq *default-file-compilation-policy* 
285        (if new-policy (require-type new-policy 'compiler-policy) (new-compiler-policy))))
286
287(defparameter *compile-time-evaluation-policy*
288  (new-compiler-policy :force-boundp-checks t))
289
290(defun %compile-time-eval (form env)
291  (declare (ignore env))
292  (let* ((*target-backend* *host-backend*)
293         (*loading-toplevel-location* (or (fcomp-source-note form)
294                                          *loading-toplevel-location*))
295         (lambda `(lambda () ,form)))
296    (fcomp-note-source-transformation form lambda)
297    ;; The HANDLER-BIND here is supposed to note WARNINGs that're
298    ;; signaled during (eval-when (:compile-toplevel) processing; this
299    ;; in turn is supposed to satisfy a pedantic interpretation of the
300    ;; spec's requirement that COMPILE-FILE's second and third return
301    ;; values reflect (all) conditions "detected by the compiler."
302    ;; (It's kind of sad that CL language design is influenced so
303    ;; strongly by the views of pedants these days.)
304    (handler-bind ((warning (lambda (c)
305                              (setq *fasl-warnings-signalled-p* t)
306                              (unless (typep c 'style-warning)
307                                (setq *fasl-non-style-warnings-signalled-p* t))
308                              (signal c))))
309      (funcall (compile-named-function
310                lambda
311                :compile-code-coverage nil
312                :source-notes *fcomp-source-note-map*
313                :env *fasl-compile-time-env*
314                :policy *compile-time-evaluation-policy*)))))
315
316
317;;; No methods by default, not even for structures.  This really sux.
318(defgeneric make-load-form (object &optional environment))
319
320;;; Well, no usable methods by default.  How this is better than
321;;; getting a NO-APPLICABLE-METHOD error frankly escapes me,
322;;; [Hint: this is called even when there is an applicable method]
323(defun no-make-load-form-for (object)
324  (error "No ~S method is defined for ~s" 'make-load-form object))
325
326(defmethod make-load-form ((s standard-object) &optional environment)
327  (declare (ignore environment))
328  (no-make-load-form-for s))
329
330(defmethod make-load-form ((s structure-object) &optional environment)
331  (declare (ignore environment))
332  (no-make-load-form-for s))
333
334(defmethod make-load-form ((c condition) &optional environment)
335  (declare (ignore environment))
336  (no-make-load-form-for c))
337
338(defmethod make-load-form ((c class) &optional environment)
339  (let* ((name (class-name c))
340         (found (if name (find-class name nil environment))))
341    (if (eq found c)
342      `(find-class ',name)
343      (error "Class ~s does not have a proper name." c))))
344
345
346;;;;          FCOMP-FILE - read & compile file
347;;;;          Produces a list of (opcode . args) to run on loading, intermixed
348;;;;          with read packages.
349
350(defparameter *fasl-eof-forms* nil)
351
352(defparameter cfasl-load-time-eval-sym (make-symbol "LOAD-TIME-EVAL"))
353(%macro-have cfasl-load-time-eval-sym
354    #'(lambda (call env) (declare (ignore env)) (list 'eval (list 'quote call))))
355;Make it a constant so compiler will barf if try to bind it, e.g. (LET #,foo ...)
356(define-constant cfasl-load-time-eval-sym cfasl-load-time-eval-sym)
357
358
359(defparameter *reading-for-cfasl* nil "Used by the reader for #,")
360
361
362
363(declaim (special *nx-compile-time-types*
364;The following are the global proclaimed values.  Since compile-file binds
365;them, this means you can't ever globally proclaim these things from within a
366;file compile (e.g. from within eval-when compile, or loading a file) - the
367;proclamations get lost when compile-file exits.  This is sort of intentional
368;(or at least the set of things which fall in this category as opposed to
369;having a separate compile-time variable is sort of intentional).
370                    *nx-proclaimed-inline*    ; inline and notinline
371                    *nx-proclaimed-ignore*    ; ignore and unignore
372                    *nx-known-declarations*   ; declaration
373                    *nx-speed*                ; optimize speed
374                    *nx-space*                ; optimize space
375                    *nx-safety*               ; optimize safety
376                    *nx-cspeed*))             ; optimize compiler-speed
377
378(defvar *fcomp-load-time*)
379(defvar *fcomp-inside-eval-always* nil)
380(defvar *fcomp-eval-always-functions* nil)   ; used by the LISP package
381(defvar *fcomp-output-list*)
382(defvar *fcomp-toplevel-forms*)
383(defvar *fcomp-source-note-map* nil)
384(defvar *fcomp-loading-toplevel-location*)
385(defvar *fcomp-warnings-header*)
386(defvar *fcomp-stream-position* nil)
387(defvar *fcomp-previous-position* nil)
388(defvar *fcomp-indentation*)
389(defvar *fcomp-print-handler-plist* nil)
390(defvar *fcomp-last-compile-print*
391  '(INCLUDE (NIL . T)
392    DEFSTRUCT ("Defstruct" . T) 
393    DEFCONSTANT "Defconstant" 
394    DEFSETF "Defsetf" 
395    DEFTYPE "Deftype" 
396    DEFCLASS "Defclass" 
397    DEFGENERIC "Defgeneric"
398    DEFMETHOD "Defmethod"
399    DEFMACRO "Defmacro" 
400    DEFPARAMETER "Defparameter" 
401    DEFVAR "Defvar" 
402    DEFUN ""))
403
404(setf (getf *fcomp-print-handler-plist* 'defun) ""
405      (getf *fcomp-print-handler-plist* 'defvar) "Defvar"
406      (getf *fcomp-print-handler-plist* 'defparameter) "Defparameter"
407      (getf *fcomp-print-handler-plist* 'defmacro) "Defmacro"
408      (getf *fcomp-print-handler-plist* 'defmethod) "Defmethod"  ; really want more than name (use the function option)
409      (getf *fcomp-print-handler-plist* 'defgeneric) "Defgeneric"
410      (getf *fcomp-print-handler-plist* 'defclass) "Defclass"
411      (getf *fcomp-print-handler-plist* 'deftype) "Deftype"
412      (getf *fcomp-print-handler-plist* 'defsetf) "Defsetf"
413      (getf *fcomp-print-handler-plist* 'defconstant) "Defconstant"
414      (getf *fcomp-print-handler-plist* 'defstruct) '("Defstruct" . t)
415      (getf *fcomp-print-handler-plist* 'include) '(nil . t))
416
417
418(defun fcomp-file (filename orig-file orig-offset env)  ; orig-file is back-translated
419  (let* ((*package* *package*)
420         (*compiling-file* filename)
421         (*nx-compile-time-types* *nx-compile-time-types*)
422         (*nx-proclaimed-inline* *nx-proclaimed-inline*)
423         (*nx-known-declarations* *nx-known-declarations*)
424         (*nx-proclaimed-ignore* *nx-proclaimed-ignore*)
425         (*nx-speed* *nx-speed*)
426         (*nx-space* *nx-space*)
427         (*nx-debug* *nx-debug*)
428         (*nx-safety* *nx-safety*)
429         (*nx-cspeed* *nx-cspeed*)
430         (*fcomp-load-time* t)
431         (*fcomp-output-list* nil)
432         (*fcomp-indentation* 0)
433         (*fcomp-last-compile-print* (cons nil (cons nil nil))))
434    (push (list $fasl-platform (backend-target-platform *fasl-backend*)) *fcomp-output-list*)
435    (fcomp-read-loop filename orig-file orig-offset env :not-compile-time)
436    (nreverse *fcomp-output-list*)))
437
438(defun fcomp-find-file (file &aux path)
439  (unless (or (setq path (probe-file file))
440              (setq path (probe-file (merge-pathnames file *.lisp-pathname*))))
441    (error 'file-error :pathname file :error-type "File ~S not found"))
442  (namestring path))
443
444;;; orig-file is back-translated when from fcomp-file
445;;; when from fcomp-include it's included filename merged with *compiling-file*
446;;; which is not back translated
447(defun fcomp-read-loop (filename orig-file orig-offset env processing-mode)
448  (when *compile-verbose*
449    (format t "~&;~A ~S..."
450            (if (eq filename *compiling-file*) "Compiling" " Including")
451            filename))
452  (with-open-file (stream filename
453                          :element-type 'base-char
454                          :external-format *fcomp-external-format*)
455    (let* ((old-file (and (neq filename *compiling-file*) *fasl-source-file*))
456           (*fasl-source-file* (or orig-file filename))
457           (*fcomp-toplevel-forms* nil)
458           (*fasl-eof-forms* nil)
459           (*loading-file-source-file* orig-file)
460           (*fcomp-source-note-map* (and (or *save-source-locations* *compile-code-coverage*)
461                                         (make-hash-table :test #'eq :shared nil)))
462           (*loading-toplevel-location* nil)
463           (*fcomp-loading-toplevel-location* nil)
464           (eofval (cons nil nil))
465           (read-package nil)
466           form)
467
468      (fcomp-output-form $fasl-src env *loading-file-source-file*)
469      (let* ((*fcomp-previous-position* nil))
470        (loop
471          (let* ((*fcomp-stream-position* (file-position stream))
472                 (*nx-warnings* nil)) ;; catch any warnings from :compile-toplevel forms
473            (when (and *fcomp-stream-position* orig-offset)
474              (incf *fcomp-stream-position* orig-offset))
475            (unless (eq read-package *package*)
476              (fcomp-compile-toplevel-forms env)
477              (setq read-package *package*))
478            (let ((*reading-for-cfasl*
479                   (and *fcomp-load-time* cfasl-load-time-eval-sym)))
480              (declare (special *reading-for-cfasl*))
481              (let ((pos (file-position stream)))
482                (handler-bind
483                    ((error #'(lambda (c) ; we should distinguish read errors from others?
484                                (format *error-output* "~&Read error between positions ~a and ~a in ~a." pos (file-position stream) filename)
485                                (signal c))))
486                  (multiple-value-setq (form *loading-toplevel-location*)
487                    (read-recording-source stream
488                                           :eofval eofval
489                                           :file-name *loading-file-source-file*
490                                           :start-offset orig-offset
491                                           :map *fcomp-source-note-map*
492                                           :save-source-text (neq *save-source-locations* :no-text))))))
493            (when (eq eofval form)
494              (require-type *loading-toplevel-location* 'null)
495              (return))
496            (fcomp-form form env processing-mode)
497            (fcomp-signal-or-defer-warnings *nx-warnings* env)
498            (setq *fcomp-previous-position* *fcomp-stream-position*))))
499      (when *compile-code-coverage*
500        (fcomp-compile-toplevel-forms env)
501        (let* ((fns (fcomp-code-covered-functions))
502               (v (nreverse (coerce fns 'vector)))
503               (id (fcomp-file-checksum stream)))
504          (map nil #'fcomp-digest-code-notes v)
505          (fcomp-random-toplevel-form `(register-code-covered-functions ',v
506                                                                        ',*fcomp-external-format*
507                                                                        ,id)
508                                      env)))
509      (while (setq form *fasl-eof-forms*)
510        (setq *fasl-eof-forms* nil)
511        (fcomp-form-list form env processing-mode))
512      (when old-file
513        (fcomp-output-form $fasl-src env (namestring *compile-file-pathname*)))
514      (fcomp-compile-toplevel-forms env))))
515
516(defvar *crc32-table* (let ((crc-table (make-array 256 :element-type '(unsigned-byte 32))))
517                        (loop for i from 0 below 255 as crc = i
518                              do (loop for j from 0 below 8
519                                       do (setq crc (ash crc -1))
520                                       do (when (oddp crc)
521                                            (setq crc (logxor crc  #xEDB88320))))
522                              do (setf (aref crc-table i) crc))
523                        crc-table))
524(declaim (type (simple-array (unsigned-byte 32) (256)) *crc32-table*))
525
526(defun fcomp-stream-checksum (stream)
527  ;; Could consider crc16 for 32-bit targets, but this is only used with code
528  ;; coverage so don't worry about efficiency anyway.
529  (file-position stream 0)
530  (let ((crc 0))
531    (declare (type (unsigned-byte 32) crc))
532    (loop for char base-char = (read-char stream nil) while char
533          do (setq crc (logxor
534                         (%ilogand (ash crc -8) #x00FFFFFF)
535                         (aref *crc32-table* (logand (logxor crc (char-code char)) #xFF)))))
536    (logior (ash (file-position stream) 32) crc)))
537
538(defun fcomp-file-checksum (filename &key (external-format *fcomp-external-format*))
539  (when (setq filename (probe-file filename))
540    (with-open-file (stream filename
541                            :element-type 'base-char
542                            :external-format external-format)
543      (fcomp-stream-checksum stream))))
544
545(defun fcomp-code-covered-functions ()
546  (loop for op in *fcomp-output-list*
547        when (consp op)
548          nconc (if (eq (car op) $fasl-lfuncall)
549                  ;; Don't collect the toplevel lfun itself, it leads to spurious markings.
550                  ;; Instead, descend one level and collect any referenced fns.
551                  (destructuring-bind (fn) (cdr op)
552                    (lfunloop for imm in fn when (functionp imm) collect imm))
553                  (loop for arg in (cdr op) when (functionp arg) collect arg))))
554
555
556(defun fcomp-form (form env processing-mode
557                        &aux print-stuff 
558                        (load-time (and processing-mode (neq processing-mode :compile-time)))
559                        (compile-time-too (or (eq processing-mode :compile-time) 
560                                              (eq processing-mode :compile-time-too))))
561  (let* ((*fcomp-indentation* *fcomp-indentation*)
562         (*compile-print* *compile-print*))
563    (when *compile-print*
564      (cond ((and (consp form) (setq print-stuff (getf *fcomp-print-handler-plist* (car form))))
565             (rplaca (rplacd (cdr *fcomp-last-compile-print*) nil) nil)
566             (rplaca *fcomp-last-compile-print* nil)         
567             (let ((print-recurse nil))
568               (when (consp print-stuff)
569                 (setq print-recurse (cdr print-stuff) print-stuff (car print-stuff)))
570               (cond ((stringp print-stuff)
571                      (if (equal print-stuff "")
572                        (format t "~&~vT~S~%" *fcomp-indentation* (second form))
573                        (format t "~&~vT~S [~A]~%" *fcomp-indentation* (second form) print-stuff)))
574                     ((not (null print-stuff))
575                      (format t "~&~vT" *fcomp-indentation*)
576                      (funcall print-stuff form *standard-output*)
577                      (terpri *standard-output*)))
578               (if print-recurse
579                 (setq *fcomp-indentation* (+ *fcomp-indentation* 4))
580                 (setq *compile-print* nil))))
581            (t (unless (and (eq load-time (car *fcomp-last-compile-print*))
582                            (eq compile-time-too (cadr *fcomp-last-compile-print*))
583                            (eq *fcomp-indentation* (cddr *fcomp-last-compile-print*)))
584                 (rplaca *fcomp-last-compile-print* load-time)
585                 (rplaca (rplacd (cdr *fcomp-last-compile-print*) compile-time-too) *fcomp-indentation*)
586                 (format t "~&~vTToplevel Forms...~A~%"
587                         *fcomp-indentation*
588                         (if load-time
589                           (if compile-time-too
590                             "  (Compiletime, Loadtime)"
591                             "")
592                           (if compile-time-too
593                             "  (Compiletime)"
594                             "")))))))
595    (fcomp-form-1 form env processing-mode)))
596
597(defun fcomp-form-1 (form env processing-mode &aux sym body)
598  (if (consp form) (setq sym (%car form) body (%cdr form)))
599  (case sym
600    (progn (fcomp-form-list body env processing-mode))
601    (eval-when (fcomp-eval-when form env processing-mode))
602    (compiler-let (fcomp-compiler-let form env processing-mode))
603    (locally (fcomp-locally form env processing-mode))
604    (macrolet (fcomp-macrolet form env processing-mode))
605    (symbol-macrolet (fcomp-symbol-macrolet form env processing-mode))
606    ((%include include) (fcomp-include form env processing-mode))
607    (t
608     ;;Need to macroexpand to see if get more progn's/eval-when's and so should
609     ;;stay at toplevel.  But don't expand if either the evaluator or the
610     ;;compiler might not - better safe than sorry...
611     ;; Good advice, but the hard part is knowing which is which.
612     (cond 
613       ((and (non-nil-symbol-p sym)
614             (macro-function sym env)
615             (not (compiler-macro-function sym env))
616             (not (eq sym '%defvar-init)) ;  a macro that we want to special-case
617             (multiple-value-bind (new win) (fcomp-macroexpand-1 form env)
618               (if win (setq form new))
619               win))
620        (fcomp-form form env processing-mode))
621       ((and (not *fcomp-inside-eval-always*)
622             (memq sym *fcomp-eval-always-functions*))
623        (let* ((*fcomp-inside-eval-always* t)
624               (new `(eval-when (:execute :compile-toplevel :load-toplevel) ,form)))
625          (fcomp-form-1 new env processing-mode)))
626       (t
627        (when (or (eq processing-mode :compile-time) (eq processing-mode :compile-time-too))
628          (%compile-time-eval form env))
629        (when (and processing-mode (neq processing-mode :compile-time))
630          (case sym
631            ((%defconstant) (fcomp-load-%defconstant form env))
632            ((%defparameter) (fcomp-load-%defparameter form env))
633            ((%defvar %defvar-init) (fcomp-load-defvar form env))
634            ((%defun) (fcomp-load-%defun form env))
635            ((set-package %define-package)
636             (fcomp-random-toplevel-form form env)
637             (fcomp-compile-toplevel-forms env))
638            ((%macro) (fcomp-load-%macro form env))
639            ;; ((%deftype) (fcomp-load-%deftype form))
640            ;; ((define-setf-method) (fcomp-load-define-setf-method form))
641            (t (fcomp-random-toplevel-form form env)))))))))
642
643(defun fcomp-form-list (forms env processing-mode)
644  (let* ((outer *loading-toplevel-location*))
645    (dolist (form forms)
646      (setq *loading-toplevel-location* (or (fcomp-source-note form) outer))
647      (fcomp-form form env processing-mode))
648    (setq *loading-toplevel-location* outer)))
649
650(defun fcomp-compiler-let (form env processing-mode &aux vars varinits (body (%cdr form)))
651  (fcomp-compile-toplevel-forms env)
652  (dolist (pair (car body))
653    (push (nx-pair-name pair) vars)
654    (push (%compile-time-eval (nx-pair-initform pair) env) varinits))
655  (progv (nreverse vars) (nreverse varinits)
656    (fcomp-form-list (cdr body) env processing-mode)
657    (fcomp-compile-toplevel-forms env)))
658
659(defun fcomp-locally (form env processing-mode &aux (body (%cdr form)))
660  (fcomp-compile-toplevel-forms env)
661  (multiple-value-bind (body decls) (parse-body body env)
662    (let* ((decl-specs (decl-specs-from-declarations decls))
663           (env (augment-environment env :declare decl-specs))
664           (*fasl-compile-time-env* (augment-environment *fasl-compile-time-env*
665                                                         :declare decl-specs)))
666      (fcomp-form-list body env processing-mode)
667      (fcomp-compile-toplevel-forms env))))
668
669(defun fcomp-macrolet (form env processing-mode &aux (body (%cdr form)))
670  (fcomp-compile-toplevel-forms env)
671  (flet ((augment-with-macros (e defs)
672           (augment-environment e
673                                :macro
674                                (mapcar #'(lambda (m)
675                                            (destructuring-bind (name arglist &body body) m
676                                              (list name (enclose (parse-macro name arglist body env)
677                                                                  e))))
678                                        defs))))
679           
680    (let* ((macros (car body))
681           (outer-env (augment-with-macros env macros)))
682      (multiple-value-bind (body decls) (parse-body (cdr body) outer-env)
683        (let* ((decl-specs (decl-specs-from-declarations decls))
684               (env (augment-environment 
685                     outer-env
686                     :declare decl-specs))
687               (*fasl-compile-time-env* (augment-environment
688                                         (augment-with-macros
689                                          *fasl-compile-time-env*
690                                          macros)
691                                         :declare decl-specs)))
692          (fcomp-form-list body env processing-mode)
693          (fcomp-compile-toplevel-forms env))))))
694
695(defun fcomp-symbol-macrolet (form env processing-mode &aux (body (%cdr form)))
696  (fcomp-compile-toplevel-forms env)
697  (let* ((defs (car body))
698         (outer-env (augment-environment env :symbol-macro defs)))
699    (multiple-value-bind (body decls) (parse-body (cdr body) env)
700      (let* ((decl-specs (decl-specs-from-declarations decls))
701             (env (augment-environment outer-env 
702                                       :declare decl-specs))
703             (*fasl-compile-time-env* (augment-environment *fasl-compile-time-env*
704                                                           :symbol-macro defs
705                                                           :declare decl-specs)))
706        (fcomp-form-list body env processing-mode)
707        (fcomp-compile-toplevel-forms env)))))
708
709(defun fcomp-eval-when (form env processing-mode &aux (body (%cdr form)) (eval-times (pop body)))
710  (let* ((compile-time-too  (eq processing-mode :compile-time-too))
711         (compile-time-only (eq processing-mode :compile-time))
712         (at-compile-time nil)
713         (at-load-time nil)
714         (at-eval-time nil))
715    (dolist (when eval-times)
716      (if (or (eq when 'compile) (eq when :compile-toplevel))
717        (setq at-compile-time t)
718        (if (or (eq when 'eval) (eq when :execute))
719          (setq at-eval-time t)
720          (if (or (eq when 'load) (eq when :load-toplevel))
721            (setq at-load-time t)
722            (warn "Unknown EVAL-WHEN time ~s in ~S while compiling ~S."
723                  when eval-times *fasl-source-file*)))))
724    (fcomp-compile-toplevel-forms env)        ; always flush the suckers
725    (cond (compile-time-only
726           (if at-eval-time (fcomp-form-list body env :compile-time)))
727          (at-load-time
728           (fcomp-form-list body env (if (or at-compile-time (and at-eval-time compile-time-too))
729                                       :compile-time-too
730                                       :not-compile-time)))
731          ((or at-compile-time (and at-eval-time compile-time-too))
732           (fcomp-form-list body env :compile-time))))
733  (fcomp-compile-toplevel-forms env))
734
735(defun fcomp-include (form env processing-mode &aux file)
736  (fcomp-compile-toplevel-forms env)
737  (verify-arg-count form 1 1)
738  (setq file (nx-transform (%cadr form) env))
739  (unless (constantp file) (report-bad-arg file '(or string pathname)))
740  (let ((actual (merge-pathnames (eval-constant file)
741                                 (directory-namestring *compiling-file*))))
742    (when *compile-print* (format t "~&~vTIncluding file ~A~%" *fcomp-indentation* actual))
743    (let ((*fcomp-indentation* (+ 4 *fcomp-indentation*))
744          (*package* *package*))
745      (fcomp-read-loop (fcomp-find-file actual) actual 0 env processing-mode)
746      (fcomp-output-form $fasl-src env *loading-file-source-file*))
747    (when *compile-print* (format t "~&~vTFinished included file ~A~%" *fcomp-indentation* actual))))
748
749(defun define-compile-time-constant (symbol initform env)
750  (note-variable-info symbol t env)
751  (let ((compile-time-defenv (definition-environment *fasl-compile-time-env*))
752        (definition-env (definition-environment env)))
753    (when (or compile-time-defenv definition-env)
754      (multiple-value-bind (value error) 
755                           (ignore-errors (values (%compile-time-eval initform env) nil))
756        (when error
757          (warn "Compile-time evaluation of DEFCONSTANT initial value form for ~S while ~
758                 compiling ~S signalled the error: ~&~A" symbol *fasl-source-file* error))
759        (let ((cell (cons symbol (if error (%unbound-marker-8) value))))
760          (when definition-env
761            (push cell (defenv.constants definition-env)))
762          (when compile-time-defenv
763            (push cell (defenv.constants compile-time-defenv))))))
764    symbol))
765
766(defun fcomp-load-%defconstant (form env)
767  (destructuring-bind (sym valform &optional doc) (cdr form)
768    (unless *fasl-save-doc-strings*
769      (setq doc nil))
770    (if (quoted-form-p sym)
771      (setq sym (%cadr sym)))
772    (if (and (typep sym 'symbol) (or (quoted-form-p valform) (self-evaluating-p valform)))
773      (fcomp-output-form $fasl-defconstant env sym (eval-constant valform) (eval-constant doc))
774      (fcomp-random-toplevel-form form env))))
775
776(defun fcomp-load-%defparameter (form env)
777  (destructuring-bind (sym valform &optional doc) (cdr form)
778    (unless *fasl-save-doc-strings*
779      (setq doc nil))
780    (if (quoted-form-p sym)
781      (setq sym (%cadr sym)))
782    (let* ((sym-p (typep sym 'symbol))
783           (fn (and sym-p (fcomp-function-arg valform env))))
784      (if (and sym-p (or fn (constantp valform)))
785        (fcomp-output-form $fasl-defparameter env sym (or fn (eval-constant valform)) (eval-constant doc))
786        (fcomp-random-toplevel-form form env)))))
787
788; Both the simple %DEFVAR and the initial-value case (%DEFVAR-INIT) come here.
789; Only try to dump this as a special fasl operator if the initform is missing
790;  or is "harmless" to evaluate whether needed or not (constant or function.)
791; Hairier initforms could be handled by another fasl operator that takes a thunk
792; and conditionally calls it.
793(defun fcomp-load-defvar (form env)
794  (destructuring-bind (sym &optional (valform nil val-p) doc) (cdr form)
795    (unless *fasl-save-doc-strings*
796      (setq doc nil))
797    (if (quoted-form-p sym)             ; %defvar quotes its arg, %defvar-init doesn't.
798      (setq sym (%cadr sym)))
799    (let* ((sym-p (typep sym 'symbol)))
800      (if (and sym-p (not val-p))
801        (fcomp-output-form $fasl-defvar env sym)
802        (let* ((fn (if sym-p (fcomp-function-arg valform env))))
803          (if (and sym-p (or fn (constantp valform)))
804            (fcomp-output-form $fasl-defvar-init env sym (or fn (eval-constant valform)) (eval-constant doc))
805            (fcomp-random-toplevel-form form env)))))))
806     
807(defun define-compile-time-macro (name lambda-expression env)
808  (let ((compile-time-defenv (definition-environment *fasl-compile-time-env*))
809        (definition-env (definition-environment env)))
810    (when (or definition-env compile-time-defenv)
811      (let ((cell (list* name 
812                         'macro 
813                         (compile-named-function lambda-expression :name name :env env))))
814        (when compile-time-defenv
815          (push cell (defenv.functions compile-time-defenv)))
816        (when definition-env
817          (push cell (defenv.functions definition-env))))
818      (record-function-info name (%cons-def-info 'defmacro) env))
819    name))
820
821(defun define-compile-time-symbol-macro (name expansion env)
822  (let ((compile-time-defenv (definition-environment *fasl-compile-time-env*))
823        (definition-env (definition-environment env)))
824    (let* ((info (variable-information name env)))
825      (when (or (eq info :special)
826                (eq info :constant))
827        (signal-program-error "Can't define ~s as a symbol-macro; already defined as a ~a." name (string-downcase info))))
828    (when (or definition-env compile-time-defenv)
829      (let ((cell (cons name expansion)))
830        (when compile-time-defenv
831          (push cell (defenv.symbol-macros compile-time-defenv)))
832        (when definition-env
833          (push cell (defenv.symbol-macros definition-env)))))
834    name))
835
836
837(defun fcomp-proclaim-type (type syms env)
838  (if (every #'symbolp syms)
839    (progn
840      (specifier-type-if-known type env :whine t)
841      (dolist (sym syms)
842        (push (cons sym type) *nx-compile-time-types*)))
843    (nx-bad-decls `(,type ,@syms))))
844
845(defun compile-time-proclamation (specs env &aux  sym (defenv (definition-environment env)))
846  (when defenv
847    (dolist (spec specs)
848      (setq sym (pop spec))
849      (case sym
850        (type
851         (fcomp-proclaim-type (car spec) (cdr spec) env))
852        (special
853         (if (every #'symbolp spec)
854           (dolist (sym spec)
855             (push (cons sym nil) (defenv.specials defenv)))
856           (nx-bad-decls `(,sym ,@spec))))
857        (notspecial
858         (if (every #'symbolp spec)
859           (let ((specials (defenv.specials defenv)))
860             (dolist (sym spec (setf (defenv.specials defenv) specials))
861               (let ((pair (assq sym specials)))
862                 (when pair (setq specials (nremove pair specials))))))
863           (nx-bad-decls `(,sym ,@spec))))
864        (optimize
865           (handler-case (%proclaim-optimize spec)
866             (program-error () (nx-bad-decls `(,sym ,@spec)))))
867        (inline
868         (if (every (lambda (v) (or (symbolp v) (setf-function-name-p v))) spec)
869           (dolist (sym spec)
870             (push (cons (maybe-setf-function-name sym) (cons 'inline 'inline)) (lexenv.fdecls defenv)))
871           (nx-bad-decls `(,sym ,@spec))))
872        (notinline
873         (if (every (lambda (v) (or (symbolp v) (setf-function-name-p v))) spec)
874           (dolist (sym spec)
875             (unless (compiler-special-form-p sym)
876               (push (cons (maybe-setf-function-name sym) (cons 'inline 'notinline)) (lexenv.fdecls defenv))))
877           (nx-bad-decls `(,sym ,@spec))))
878        (declaration
879         (if (every #'symbolp spec)
880           (dolist (sym spec)
881             (pushnew sym *nx-known-declarations*))
882           (nx-bad-decls `(,sym ,@spec))))
883        (ignore
884         (if (every #'symbolp spec)
885           (dolist (sym spec)
886             (push (cons sym t) *nx-proclaimed-ignore*))
887           (nx-bad-decls `(,sym ,@spec))))
888        (unignore
889         (if (every #'symbolp spec)
890           (dolist (sym spec)
891             (push (cons sym nil) *nx-proclaimed-ignore*))
892           (nx-bad-decls `(,sym ,@spec))))
893        (ftype 
894         (let ((ftype (car spec))
895               (fnames (cdr spec)))
896           (if (every (lambda (v) (or (symbolp v) (setf-function-name-p v))) fnames)
897             (when (specifier-type-if-known ftype env :whine t)
898               ;; ----- this part may be redundant, now that the lexenv.fdecls part is being done
899               (if (and (consp ftype)
900                        (consp fnames)
901                        (eq (%car ftype) 'function))
902                 (dolist (fname fnames)
903                   (note-function-info fname nil env)))
904               (dolist (fname fnames)
905                 (push (list* (maybe-setf-function-name fname) sym ftype) (lexenv.fdecls defenv))))
906             (nx-bad-decls `(ftype ,@spec)))))
907        (otherwise
908         (unless (memq sym *nx-known-declarations*)
909           ;; Any type name is now (ANSI CL) a valid declaration.
910           (if (specifier-type-if-known sym env)
911             (fcomp-proclaim-type sym spec env)
912             (nx-bad-decls `(,sym ,@spec)))))))))
913
914(defun fcomp-load-%defun (form env)
915  (destructuring-bind (fn &optional doc) (cdr form)
916    (unless *fasl-save-doc-strings*
917      (if (consp doc)
918        (if (and (eq (car doc) 'quote) (consp (cadr doc)))
919          (setf (car (cadr doc)) nil))
920        (setq doc nil)))
921    (when (and (consp fn) (eq (%car fn) 'nfunction))
922      (note-function-info (cadr fn) (caddr fn) env))
923    (if (and (constantp doc)
924             (setq fn (fcomp-function-arg fn env)))
925      (progn
926        (setq doc (eval-constant doc))
927        (fcomp-output-form $fasl-defun env fn doc))
928      (fcomp-random-toplevel-form form env))))
929
930(defun fcomp-load-%macro (form env &aux fn doc)
931  (verify-arg-count form 1 2)
932  (if (and (constantp (setq doc (caddr form)))
933           (setq fn (fcomp-function-arg (cadr form) env)))
934    (progn
935      (setq doc (eval-constant doc))
936      (fcomp-output-form $fasl-macro env fn doc))
937    (fcomp-random-toplevel-form form env)))
938
939(defun define-compile-time-structure (sd refnames predicate env)
940  (let ((defenv (definition-environment env))
941        (class-name (and (not (sd-type sd)) (symbolp (sd-name sd)) (sd-name sd))))
942    (when defenv
943      (when class-name
944        (note-type-info class-name 'class env)
945        (push (make-instance 'compile-time-class :name class-name)
946              (defenv.classes defenv)))
947      (setf (defenv.structures defenv) (alist-adjoin (sd-name sd) sd (defenv.structures defenv)))
948      (let* ((structrefs (defenv.structrefs defenv)))
949        (when (and predicate class-name)
950          (setq structrefs (alist-adjoin predicate class-name structrefs)))
951        (dolist (slot (sd-slots sd))
952          (unless (fixnump (ssd-name slot))
953            (setq structrefs
954                (alist-adjoin (if refnames (pop refnames) (ssd-name slot))
955                              (cons (ssd-type-and-refinfo slot) class-name)
956                              structrefs))))
957        (setf (defenv.structrefs defenv) structrefs)))))
958
959(defun fcomp-source-note (form &aux (notes *fcomp-source-note-map*))
960  (and notes (gethash form notes)))
961
962(defun (setf fcomp-source-note) (note form &aux (notes *fcomp-source-note-map*))
963  (and notes (setf (gethash form notes) note)))
964
965(defun fcomp-note-source-transformation (original new)
966  (let* ((*nx-source-note-map* *fcomp-source-note-map*))
967    (nx-note-source-transformation original new)))
968
969(defun fcomp-macroexpand-1 (form env)
970  (handler-bind ((warning (lambda (c)
971                            (nx1-whine :program-error c)
972                            (muffle-warning c)))
973                 (program-error (lambda (c)
974                                  (if *fasl-break-on-program-errors*
975                                    (cerror "continue compilation ignoring this form" c)
976                                    (progn
977                                      (when (typep c 'compile-time-program-error)
978                                        (setq c (make-condition 'simple-program-error
979                                                  :format-control (simple-condition-format-control c)
980                                                  :format-arguments (simple-condition-format-arguments c))))
981                                      (nx1-whine :program-error c)))
982                                  (return-from fcomp-macroexpand-1 (values nil t)))))
983    (let* ((*nx-source-note-map* *fcomp-source-note-map*))
984      (multiple-value-bind (new win)
985          (macroexpand-1 form env)
986        (when win
987          (nx-note-source-transformation form new))
988        (values new win)))))
989
990(defun fcomp-transform (form env)
991  (let* ((*nx-source-note-map* *fcomp-source-note-map*))
992    (nx-transform form env)))
993
994
995(defun fcomp-random-toplevel-form (form env)
996  (unless (constantp form)
997    (unless (or (atom form)
998                (compiler-special-form-p (%car form)))
999      ;;Pre-compile any lfun args.  This is an efficiency hack, since compiler
1000      ;;reentering itself for inner lambdas tends to be more expensive than
1001      ;;top-level compiles.
1002      ;;This assumes the form has been macroexpanded, or at least none of the
1003      ;;non-evaluated macro arguments could look like functions.
1004      (let ((new-form (make-list (length form))))
1005        (declare (dynamic-extent new-form))
1006        (loop for arg in (%cdr form) for newptr on (%cdr new-form)
1007              do (setf (%car newptr)
1008                       (multiple-value-bind (new win) (fcomp-transform arg env)
1009                         (let ((lfun (fcomp-function-arg new env)))
1010                           (when lfun
1011                             (setq new `',lfun win t)
1012                             (fcomp-note-source-transformation arg new)))
1013                         (if win new arg))))
1014        (unless (every #'eq (%cdr form) (%cdr new-form))
1015          (setf (%car new-form) (%car form))
1016          (fcomp-note-source-transformation form (setq form (copy-list new-form))))))
1017    ;; At some point we will dump the toplevel forms, make sure that when that happens,
1018    ;;; the loading location for this form is stored in *fcomp-loading-toplevel-location*,
1019    ;; because *loading-toplevel-location* will be long gone by then.
1020    (fcomp-ensure-source env)
1021    (push form *fcomp-toplevel-forms*)))
1022
1023(defun fcomp-function-arg (expr env)
1024  (when (consp expr)
1025    (multiple-value-bind (lambda-expr name win)
1026        (cond ((and (eq (%car expr) 'nfunction)
1027                    (lambda-expression-p (cadr (%cdr expr))))
1028               (values (%caddr expr) (%cadr expr) t))
1029              ((and (eq (%car expr) 'function)
1030                    (lambda-expression-p (car (%cdr expr))))
1031               (values (%cadr expr) nil t)))
1032      (when win
1033        (fcomp-named-function lambda-expr name env
1034                              (or (fcomp-source-note expr)
1035                                  (fcomp-source-note lambda-expr)
1036                                  *loading-toplevel-location*))))))
1037
1038(defun fcomp-compile-toplevel-forms (env)
1039  (when *fcomp-toplevel-forms*
1040    (let* ((forms (nreverse *fcomp-toplevel-forms*))
1041           (*fcomp-stream-position* *fcomp-previous-position*)
1042           (*loading-toplevel-location* *fcomp-loading-toplevel-location*)
1043           (body (if T ;; (null (cdr forms))
1044                   `(progn ,@forms)
1045                   `(macrolet ((load-time-value (value)
1046                                 (declare (ignore value))
1047                                 (compiler-function-overflow)))
1048                      ,@forms)))
1049           (lambda `(lambda () ,body)))
1050      ;; Don't assign a location to the lambda so it doesn't confuse acode printing, but
1051      ;; arrange to assign it to any inner lambdas.
1052      (setf (fcomp-source-note body) *loading-toplevel-location*)
1053      (setq *fcomp-toplevel-forms* nil)
1054      ;(format t "~& Random toplevel form: ~s" lambda)
1055      (handler-case (fcomp-output-form
1056                     $fasl-lfuncall
1057                     env
1058                     (fcomp-named-function lambda nil env #|*loading-toplevel-location*|#))
1059        (compiler-function-overflow ()
1060          (if (null (cdr forms))
1061            (error "Form ~s cannot be compiled - size exceeds compiler limitation"
1062                   (%car forms))
1063            ; else compile each half :
1064            (progn
1065              (dotimes (i (floor (length forms) 2))
1066                (declare (fixnum i))
1067                (push (pop forms) *fcomp-toplevel-forms*))
1068              (fcomp-compile-toplevel-forms env)
1069              (setq *fcomp-toplevel-forms* (nreverse forms))
1070              (fcomp-compile-toplevel-forms env))))))))
1071
1072(defun fcomp-ensure-source (env)
1073  ;; if source location saving is off, both values are NIL, so this will do nothing,
1074  ;; don't need to check explicitly.
1075  (unless (eq *fcomp-loading-toplevel-location* *loading-toplevel-location*)
1076    (setq *fcomp-loading-toplevel-location* *loading-toplevel-location*)
1077    (fcomp-output-form $fasl-toplevel-location env *loading-toplevel-location*)))
1078
1079(defun fcomp-output-form (opcode env &rest args)
1080  (fcomp-ensure-source env)
1081  (when *fcomp-toplevel-forms* (fcomp-compile-toplevel-forms env))
1082  (push (cons opcode args) *fcomp-output-list*))
1083
1084
1085;;; Compile a lambda expression for the sole purpose of putting it in a fasl
1086;;; file.  The result will not be funcalled.  This really shouldn't bother
1087;;; making an lfun, but it's simpler this way...
1088(defun fcomp-named-function (def name env &optional source-note)
1089  (let* ((env (new-lexical-environment env))
1090         (*nx-break-on-program-errors* (not (memq *fasl-break-on-program-errors* '(nil :defer)))))
1091    (multiple-value-bind (lfun warnings)
1092        (compile-named-function def
1093                                :name name
1094                                :env env
1095                                :function-note source-note
1096                                :keep-lambda *fasl-save-definitions*
1097                                :keep-symbols *fasl-save-local-symbols*
1098                                :policy *default-file-compilation-policy*
1099                                :source-notes *fcomp-source-note-map*
1100                                :load-time-eval-token cfasl-load-time-eval-sym
1101                                :target *fasl-target*)
1102      (fcomp-signal-or-defer-warnings warnings env)
1103      lfun)))
1104
1105
1106;; Convert parent-notes to immediate indices.  The reason this is necessary is to avoid hitting
1107;; the fasdumper's 64K limit on multiply-referenced objects.  This removes the reference
1108;; from parent slots, making notes less likely to be multiply-referenced.
1109(defun fcomp-digest-code-notes (lfun &optional refs)
1110  (unless (memq lfun refs)
1111    (let* ((lfv (function-to-function-vector lfun))
1112           (start #+ppc-target 0 #+x86-target (%function-code-words lfun))
1113           (refs (cons lfun refs)))
1114      (declare (dynamic-extent refs))
1115      (loop for i from start below (uvsize lfv) as imm = (uvref lfv i)
1116            do (typecase imm
1117                 (code-note
1118                  (let* ((parent (code-note-parent-note imm))
1119                         (pos (when (code-note-p parent)
1120                                (loop for j from start below i
1121                                      do (when (eq parent (uvref lfv j)) (return j))))))
1122                    (when pos
1123                      (setf (code-note-parent-note imm) pos))))
1124                 (function
1125                  (fcomp-digest-code-notes imm refs)))))))
1126
1127; For now, defer only UNDEFINED-REFERENCEs, signal all others via WARN.
1128; Well, maybe not WARN, exactly.
1129(defun fcomp-signal-or-defer-warnings (warnings env)
1130  (let ((init (null *fcomp-warnings-header*))
1131        (some *fasl-warnings-signalled-p*)
1132        (harsh *fasl-non-style-warnings-signalled-p*))
1133    (dolist (w warnings)
1134      (unless (compiler-warning-source-note w)
1135        (setf (compiler-warning-source-note w)
1136              (make-source-note :source nil
1137                                :filename *fasl-source-file*
1138                                :start-pos *fcomp-stream-position*
1139                                :end-pos *fcomp-stream-position*)))
1140      (if (and (typep w 'undefined-reference) 
1141               (eq w (setq w (macro-too-late-p w env))))
1142        (push w *fasl-deferred-warnings*)
1143        (progn
1144          (multiple-value-setq (harsh some *fcomp-warnings-header*)
1145                               (signal-compiler-warning w init *fcomp-warnings-header* harsh some))
1146          (setq init nil))))
1147    (setq *fasl-warnings-signalled-p* some
1148          *fasl-non-style-warnings-signalled-p* harsh)))
1149
1150; If W is an UNDEFINED-FUNCTION-REFERENCE which refers to a macro (either at compile-time in ENV
1151; or globally), cons up a MACRO-USED-BEFORE-DEFINITION warning and return it; else return W.
1152
1153(defun macro-too-late-p (w env)
1154  (let* ((args (compiler-warning-args w))
1155         (name (car args)))
1156    (if (typep w 'undefined-function-reference)
1157      (if (or (macro-function name)
1158              (let* ((defenv (definition-environment env))
1159                     (info (if defenv (assq name (defenv.functions defenv)))))
1160                (and (consp (cdr info))
1161                     (eq 'macro (cadr info)))))
1162          (make-instance 'macro-used-before-definition
1163            :source-note (compiler-warning-source-note w)
1164            :function-name (compiler-warning-function-name w)
1165            :warning-type ':macro-used-before-definition
1166            :args args)
1167          w)
1168      w)))
1169
1170
1171             
1172;;;;          fasl-scan - dumping reference counting
1173;;;;
1174;;;;
1175;These should be constants, but it's too much trouble when need to change 'em.
1176(defparameter FASL-FILE-ID #xFF00)  ;Overall file format, shouldn't change much
1177(defparameter FASL-VERSION #xFF5b)  ;Fasl block format. ($fasl-vers)
1178
1179(defvar *fasdump-hash*)
1180(defvar *fasdump-read-package*)
1181(defvar *fasdump-global-offsets*)
1182(defvar *make-load-form-hash*)
1183
1184;;;Return a hash table containing subexp's which are referenced more than once.
1185(defun fasl-scan (forms)
1186  (let* ((*fasdump-hash* (make-hash-table :size (length forms)          ; Crude estimate
1187                                          :rehash-threshold 0.9
1188                                          :test 'eq
1189                                          :shared nil))
1190         (*make-load-form-hash* (make-hash-table :test 'eq :shared nil))
1191         (*fasdump-read-package* nil)
1192         (*fasdump-global-offsets* nil)
1193         (gsymbols nil))
1194    (dolist (op forms)
1195      (if (packagep op) ; old magic treatment of *package*
1196        (setq *fasdump-read-package* op)
1197        (dolist (arg (cdr op)) (fasl-scan-form arg))))
1198
1199    #-bccl (when (eq *compile-verbose* :debug)
1200             (format t "~&~S forms, ~S entries -> "
1201                     (length forms)
1202                     (hash-table-count *fasdump-hash*)))
1203    (maphash #'(lambda (key val)
1204                 (when (%izerop val) (remhash key *fasdump-hash*)))
1205             *fasdump-hash*)
1206    #-bccl (when (eq *compile-verbose* :debug)
1207             (format t "~S." (hash-table-count *fasdump-hash*)))
1208    (values *fasdump-hash*
1209            gsymbols
1210            *fasdump-global-offsets*)))
1211
1212;;; During scanning, *fasdump-hash* values are one of the following:
1213;;;  nil - form hasn't been referenced yet.
1214;;;   0 - form has been referenced exactly once
1215;;;   T - form has been referenced more than once
1216;;;  (load-form scanning-p referenced-p initform)
1217;;;     form should be replaced by load-form
1218;;;     scanning-p is true while we're scanning load-form
1219;;;     referenced-p is nil if unreferenced,
1220;;;                     T if referenced but not dumped yet,
1221;;;                     0 if dumped already (fasl-dump-form uses this)
1222;;;     initform is a compiled version of the user's initform
1223(defun fasl-scan-form (form)
1224  (when form
1225    (let ((info (gethash form *fasdump-hash*)))
1226      (cond ((null info)
1227             (fasl-scan-dispatch form))
1228            ((eql info 0)
1229             (puthash form *fasdump-hash* t))
1230            ((listp info)               ; a make-load-form form
1231             (when (cadr info)
1232               (error "Circularity in ~S for ~S" 'make-load-form form))
1233             (let ((referenced-cell (cddr info)))
1234               (setf (car referenced-cell) t)   ; referenced-p
1235               (setf (gethash (car info) *fasdump-hash*) t)))))))
1236
1237
1238
1239
1240(defun fasl-scan-dispatch (exp)
1241  (when exp
1242    (let ((type-code (typecode exp)))
1243      (declare (fixnum type-code))
1244      (case type-code
1245        (#.target::tag-fixnum
1246         (fasl-scan-fixnum exp))
1247        (#.target::fulltag-cons (fasl-scan-list exp))
1248        #+ppc32-target
1249        (#.ppc32::tag-imm)
1250        #+ppc64-target
1251        ((#.ppc64::fulltag-imm-0
1252          #.ppc64::fulltag-imm-1
1253          #.ppc64::fulltag-imm-2
1254          #.ppc64::fulltag-imm-3))
1255        #+x8632-target
1256        (#.x8632::tag-imm)
1257        #+x8664-target
1258        ((#.x8664::fulltag-imm-0
1259          #.x8664::fulltag-imm-1))
1260        (t
1261         (if
1262           #+ppc32-target
1263           (= (the fixnum (logand type-code ppc32::full-tag-mask)) ppc32::fulltag-immheader)
1264           #+ppc64-target
1265           (= (the fixnum (logand type-code ppc64::lowtagmask)) ppc64::lowtag-immheader)
1266           #+x8632-target
1267           (= (the fixnum (logand type-code x8632::fulltagmask)) x8632::fulltag-immheader)
1268           #+x8664-target
1269           (and (= (the fixnum (lisptag exp)) x8664::tag-misc)
1270                (logbitp (the (unsigned-byte 16) (logand type-code x8664::fulltagmask))
1271                         (logior (ash 1 x8664::fulltag-immheader-0)
1272                                 (ash 1 x8664::fulltag-immheader-1)
1273                                 (ash 1 x8664::fulltag-immheader-2))))
1274           (case type-code
1275             (#.target::subtag-dead-macptr (fasl-unknown exp))
1276             (#.target::subtag-macptr
1277              ;; Treat untyped pointers to the high/low 64K of the address
1278              ;; space as constants.  Refuse to dump other pointers.
1279              (unless (and (zerop (%macptr-type exp))
1280                           (<= (%macptr-domain exp) 1))
1281                (error "Can't dump typed pointer ~s" exp))
1282              (let* ((addr (%ptr-to-int exp)))
1283                (unless (or (< addr #x10000)
1284                            (>= addr (- (ash 1 target::nbits-in-word)
1285                                        #x10000)))
1286                  (error "Can't dump pointer ~s : address is not in the low or high 64K of the address space." exp))))
1287             (t (fasl-scan-ref exp)))
1288           (case type-code
1289             ((#.target::subtag-pool #.target::subtag-weak #.target::subtag-lock) (fasl-unknown exp))
1290             (#+ppc-target #.target::subtag-symbol
1291              #+x8632-target #.target::subtag-symbol
1292              #+x8664-target #.target::tag-symbol (fasl-scan-symbol exp))
1293             ((#.target::subtag-instance #.target::subtag-struct)
1294              (fasl-scan-user-form exp))
1295             (#.target::subtag-package (fasl-scan-ref exp))
1296             (#.target::subtag-istruct
1297              (if (memq (istruct-type-name exp) *istruct-make-load-form-types*)
1298                (progn
1299                  (if (hash-table-p exp)
1300                    (fasl-lock-hash-table exp))
1301                  (fasl-scan-user-form exp))
1302                (fasl-scan-gvector exp)))
1303             #+x8632-target
1304             (#.target::subtag-function (fasl-scan-clfun exp))
1305             #+x8664-target
1306             (#.target::tag-function (fasl-scan-clfun exp))
1307             (t (fasl-scan-gvector exp)))))))))
1308             
1309
1310(defun fasl-scan-ref (form)
1311  (puthash form *fasdump-hash* 0))
1312
1313(defun fasl-scan-fixnum (fixnum)
1314  (unless (short-fixnum-p fixnum) (fasl-scan-ref fixnum)))
1315
1316(defparameter *istruct-make-load-form-types*
1317  '(lexical-environment shared-library-descriptor shared-library-entry-point
1318    external-entry-point foreign-variable
1319    ctype unknown-ctype class-ctype foreign-ctype union-ctype member-ctype 
1320    array-ctype numeric-ctype hairy-ctype named-ctype constant-ctype args-ctype
1321    hash-table package-ref type-cell class-cell slot-id))
1322
1323
1324
1325
1326(defun fasl-scan-gvector (vec)
1327  (fasl-scan-ref vec)
1328  (dotimes (i (uvsize vec)) 
1329    (declare (fixnum i))
1330    (fasl-scan-form (%svref vec i))))
1331
1332#+x86-target
1333(defun fasl-scan-clfun (f)
1334  (let* ((fv (function-to-function-vector f))
1335         (size (uvsize fv))
1336         (ncode-words (%function-code-words f)))
1337    (fasl-scan-ref f)
1338    (do* ((k ncode-words (1+ k)))
1339         ((= k size))
1340      (fasl-scan-form (uvref fv k)))))
1341
1342(defun funcall-lfun-p (form)
1343  (and (listp form)
1344       (eq (%car form) 'funcall)
1345       (listp (%cdr form))
1346       (or (functionp (%cadr form))
1347           (eql (typecode (%cadr form)) target::subtag-xfunction))
1348       (null (%cddr form))))
1349
1350;;; We currently represent istruct-cells as conses.  That's not
1351;;; incredibly efficient (among other things, we have to do this
1352;;; check when scanning/dumping any list), but it's probably not
1353;;; worth burning a tag on them.  There are currently about 50
1354;;; entries on the *istruct-cells* list.
1355(defun istruct-cell-p (x)
1356  (and (consp x)
1357       (typep (%car x) 'symbol)
1358       (atom (%cdr x))
1359       (not (null (memq x *istruct-cells*)))))
1360
1361(defun fasl-scan-list (list)
1362  (cond ((eq (%car list) cfasl-load-time-eval-sym)
1363         (let ((form (car (%cdr list))))
1364           (fasl-scan-form (if (funcall-lfun-p form)
1365                             (%cadr form)
1366                             form))))
1367        ((istruct-cell-p list)
1368         (fasl-scan-form (%car list)))
1369        (t (when list
1370             (fasl-scan-ref list)
1371             (fasl-scan-form (%car list))
1372             (fasl-scan-form (%cdr list))))))
1373
1374(defun fasl-scan-user-form (form)
1375  (when (or (source-note-p form)
1376            (code-note-p form))
1377    (return-from fasl-scan-user-form (fasl-scan-gvector form)))
1378  (multiple-value-bind (load-form init-form) (make-load-form form *fcomp-load-forms-environment*)
1379    (labels ((simple-load-form (form)
1380               (or (atom form)
1381                   (let ((function (car form)))
1382                     (or (eq function 'quote)
1383                         (and (symbolp function)
1384                              ;; using fboundp instead of symbol-function
1385                              ;; see comments in symbol-function
1386                              (or (functionp (fboundp function))
1387                                  (eq function 'progn))
1388                              ;; (every #'simple-load-form (cdr form))
1389                              (dolist (arg (cdr form) t)
1390                                (unless (simple-load-form arg)
1391                                  (return nil))))))))
1392             (load-time-eval-form (load-form form type)
1393               (cond ((quoted-form-p load-form)
1394                      (%cadr load-form))
1395                     ((self-evaluating-p load-form)
1396                      load-form)
1397                     ((simple-load-form load-form)
1398                      `(,cfasl-load-time-eval-sym ,load-form))
1399                     (t (multiple-value-bind (lfun warnings)
1400                                             (or
1401                                              (gethash load-form *make-load-form-hash*)
1402                                              (fcomp-named-function `(lambda () ,load-form) nil nil))
1403                          (when warnings
1404                            (cerror "Ignore the warnings"
1405                                    "Compiling the ~s ~a form for~%~s~%produced warnings."
1406                                    'make-load-form type form))
1407                          (setf (gethash load-form *make-load-form-hash*) lfun)
1408                          `(,cfasl-load-time-eval-sym (funcall ,lfun)))))))
1409      (declare (dynamic-extent #'simple-load-form #'load-time-eval-form))
1410      (let* ((compiled-initform
1411              (and init-form (load-time-eval-form init-form form "initialization")))
1412             (info (list (load-time-eval-form load-form form "creation")
1413                         T              ; scanning-p
1414                         nil            ; referenced-p
1415                         compiled-initform  ;initform-info
1416                         )))
1417        (puthash form *fasdump-hash* info)
1418        (fasl-scan-form (%car info))
1419        (setf (cadr info) nil)        ; no longer scanning load-form
1420        (when init-form
1421          (fasl-scan-form compiled-initform))))))
1422
1423(defun fasl-scan-symbol (form)
1424  (fasl-scan-ref form)
1425  (fasl-scan-form (symbol-package form)))
1426 
1427
1428
1429;;;;          Pass 3 - dumping
1430;;;;
1431;;;;
1432(defvar *fasdump-epush*)
1433(defvar *fasdump-stream*)
1434(defvar *fasdump-eref*)
1435
1436(defun fasl-dump-file (gnames goffsets forms hash filename)
1437  (let ((opened? nil)
1438        (finished? nil))
1439    (unwind-protect
1440      (with-open-file (*fasdump-stream* filename :direction :output
1441                                        :element-type '(unsigned-byte 8)
1442                                        :if-exists :supersede
1443                                        :if-does-not-exist :create)
1444        (setq opened? t)
1445        (fasl-set-filepos 0)
1446        (fasl-out-word 0)             ;Will become the ID word
1447        (fasl-out-word 1)             ;One block in the file
1448        (fasl-out-long 12)            ;Block starts at file pos 12
1449        (fasl-out-long 0)             ;Length will go here
1450        (fasl-dump-block gnames goffsets forms hash)  ;Write the block
1451        (let ((pos (fasl-filepos)))
1452          (fasl-set-filepos 8)        ;Back to length longword
1453          (fasl-out-long (- pos 12))) ;Write length
1454        (fasl-set-filepos 0)          ;Seem to have won, make us legal
1455        (fasl-out-word FASL-FILE-ID)
1456        (setq finished? t)
1457        filename)
1458      (when (and opened? (not finished?))
1459        (delete-file filename)))))
1460
1461(defun fasl-dump-block (gnames goffsets forms hash)
1462  (let ((etab-size (hash-table-count hash)))
1463    (fasl-out-word FASL-VERSION)          ; Word 0
1464    (fasl-out-long  0)
1465    (fasl-out-byte $fasl-vetab-alloc)
1466    (fasl-out-count etab-size)
1467    (fasl-dump gnames goffsets forms hash)
1468    (fasl-out-byte $fasl-end)))
1469
1470(defun fasl-dump (gnames goffsets forms hash)
1471  (let* ((*fasdump-hash* hash)
1472         (*fasdump-read-package* nil)
1473         (*fasdump-epush* nil)
1474         (*fasdump-eref* -1)
1475         (*fasdump-global-offsets* goffsets))
1476    (when gnames
1477      (fasl-out-byte $fasl-globals)
1478      (fasl-dump-form gnames))
1479    (dolist (op forms)
1480      (if (packagep op)
1481        (setq *fasdump-read-package* op)
1482        (progn
1483          (fasl-out-byte (car op))
1484          (dolist (arg (cdr op)) (fasl-dump-form arg)))))))
1485
1486;;;During dumping, *fasdump-hash* values are one of the following:
1487;;;   nil - form has no load form, is referenced at most once.
1488;;;   fixnum - form has already been dumped, fixnum is the etab index.
1489;;;   T - form hasn't been dumped yet, is referenced more than once.
1490;;;  (load-form . nil) - form should be replaced by load-form.
1491(defun fasl-dump-form (form)
1492  (let ((info (gethash form *fasdump-hash*)))
1493    (cond ((fixnump info)
1494           (fasl-out-byte $fasl-veref)
1495           (fasl-out-count info))
1496          ((consp info)
1497           (fasl-dump-user-form form info))
1498          (t
1499           (setq *fasdump-epush* info)
1500           (fasl-dump-dispatch form)))))
1501
1502(defun fasl-dump-user-form (form info)
1503  (let* ((load-form (car info))
1504         (referenced-p (caddr info))
1505         (initform (cadddr info)))
1506    (when referenced-p
1507      (unless (gethash load-form *fasdump-hash*)
1508        (error "~s was not in ~s.  This shouldn't happen." 'load-form '*fasdump-hash*)))
1509    (when initform
1510      (fasl-out-byte $fasl-prog1))      ; ignore the initform
1511    (fasl-dump-form load-form)
1512    (when referenced-p
1513      (setf (gethash form *fasdump-hash*) (gethash load-form *fasdump-hash*)))
1514    (when initform
1515      (fasl-dump-form initform))))
1516
1517(defun fasl-out-opcode (opcode form)
1518  (if *fasdump-epush*
1519    (progn
1520      (setq *fasdump-epush* nil)
1521      (fasl-out-byte (fasl-epush-op opcode))
1522      (fasl-dump-epush form))
1523    (fasl-out-byte opcode)))
1524
1525(defun fasl-dump-epush (form)
1526  #-bccl (when (fixnump (gethash form *fasdump-hash*))
1527           (error "Bug! Duplicate epush for ~S" form))
1528  (puthash form *fasdump-hash* (setq *fasdump-eref* (1+ *fasdump-eref*))))
1529
1530
1531(defun fasl-dump-dispatch (exp)
1532  (etypecase exp
1533    ((signed-byte 16) (fasl-dump-s16 exp))
1534    ((signed-byte 32) (fasl-dump-s32 exp))
1535    ((signed-byte 64) (fasl-dump-s64 exp))
1536    (bignum (fasl-dump-32-bit-ivector exp $fasl-bignum32))
1537    (character (fasl-dump-char exp))
1538    (list (fasl-dump-list exp))
1539    (immediate (fasl-dump-t_imm exp))
1540    (double-float (fasl-dump-dfloat exp))
1541    (single-float (fasl-dump-sfloat exp))
1542    (simple-string (let* ((n (length exp)))
1543                     (fasl-out-opcode $fasl-nvstr exp)
1544                     (fasl-out-count n)
1545                     (fasl-out-simple-string exp 0 n)))
1546    (simple-bit-vector (fasl-dump-bit-vector exp))
1547    ((simple-array (unsigned-byte 8) (*))
1548     (fasl-dump-8-bit-ivector exp $fasl-u8-vector))
1549    ((simple-array (signed-byte 8) (*))
1550     (fasl-dump-8-bit-ivector exp $fasl-s8-vector))
1551    ((simple-array (unsigned-byte 16) (*))
1552     (fasl-dump-16-bit-ivector exp $fasl-u16-vector))
1553    ((simple-array (signed-byte 16) (*))
1554     (fasl-dump-16-bit-ivector exp $fasl-s16-vector))
1555    ((simple-array (unsigned-byte 32) (*))
1556     (fasl-dump-32-bit-ivector exp $fasl-u32-vector))
1557    ((simple-array (signed-byte 32) (*))
1558     (fasl-dump-32-bit-ivector exp $fasl-s32-vector))
1559    ((simple-array single-float (*))
1560     (fasl-dump-32-bit-ivector exp $fasl-single-float-vector))
1561    ((simple-array double-float (*))
1562     (fasl-dump-double-float-vector exp))
1563    (symbol (fasl-dump-symbol exp))
1564    (package (fasl-dump-package exp))
1565    (function (fasl-dump-function exp))
1566    (xfunction (fasl-dump-function exp))
1567    (code-vector (fasl-dump-codevector exp))
1568    (xcode-vector (fasl-dump-codevector exp))
1569    (simple-vector (fasl-dump-gvector exp $fasl-t-vector))
1570    (ratio (fasl-dump-ratio exp))
1571    (complex (fasl-dump-complex exp))
1572    #+(and 64-bit-target (not cross-compiling))
1573    ((simple-array (unsigned-byte 64) (*))
1574     (fasl-dump-64-bit-ivector exp $fasl-u64-vector))
1575    #+(and 64-bit-target (not cross-compiling))
1576    ((simple-array (signed-byte 64) (*))
1577     (fasl-dump-64-bit-ivector exp $fasl-s64-vector))
1578    (ivector
1579     (unless (eq (backend-target-arch-name *target-backend*)
1580                 (backend-target-arch-name *host-backend*))
1581       (error "can't cross-compile constant reference to ~s" exp))
1582     (let* ((typecode (typecode exp))
1583            (n (uvsize exp))
1584            (nb (subtag-bytes typecode n)))
1585       (declare (fixnum n nb typecode))
1586       (fasl-out-opcode $fasl-vivec exp)
1587       (fasl-out-byte typecode)
1588       (fasl-out-count n)
1589       (fasl-out-ivect exp 0 nb)))
1590    (vector (fasl-dump-gvector exp $fasl-vector-header))
1591    (array (fasl-dump-gvector exp $fasl-array-header))
1592
1593    (gvector
1594     (if (= (typecode exp) target::subtag-istruct)
1595       (fasl-dump-gvector exp $fasl-istruct)
1596       (progn
1597         (unless (eq (backend-target-arch-name *target-backend*)
1598                     (backend-target-arch-name *host-backend*))
1599           (error "can't cross-compile constant reference to ~s" exp))
1600         (let* ((typecode (typecode exp))
1601                (n (uvsize exp)))
1602           (declare (fixnum n typecode))
1603           (fasl-out-opcode $fasl-vgvec exp)
1604           (fasl-out-byte typecode)
1605           (fasl-out-count n)
1606           (dotimes (i n)
1607             (fasl-dump-form (%svref exp i)))))))))
1608
1609(defun fasl-dump-gvector (v op)
1610  (let* ((n (uvsize v)))
1611    (fasl-out-opcode op v)
1612    (fasl-out-count n)
1613    (dotimes (i n)
1614      (fasl-dump-form (%svref v i)))))
1615
1616(defun fasl-dump-ratio (v)
1617  (fasl-out-opcode $fasl-ratio v)
1618  (fasl-dump-form (%svref v target::ratio.numer-cell))
1619  (fasl-dump-form (%svref v target::ratio.denom-cell)))
1620
1621(defun fasl-dump-complex (v)
1622  (fasl-out-opcode $fasl-complex v)
1623  (fasl-dump-form (%svref v target::complex.realpart-cell))
1624  (fasl-dump-form (%svref v target::complex.imagpart-cell)))
1625
1626(defun fasl-dump-bit-vector (v)
1627  (let* ((n (uvsize v)))
1628    (fasl-out-opcode $fasl-bit-vector v)
1629    (fasl-out-count n)
1630    (if (eq *fasl-host-big-endian* *fasl-target-big-endian*)
1631      (let* ((nb (ash (+ n 7) -3)))
1632        (fasl-out-ivect v 0 nb))
1633      (compiler-bug "need to byte-swap ~a" v))))
1634
1635(defun fasl-dump-8-bit-ivector (v op)
1636  (let* ((n (uvsize v)))
1637    (fasl-out-opcode op v)
1638    (fasl-out-count n)
1639    (let* ((nb n))
1640      (fasl-out-ivect v 0 nb))))
1641
1642(defun fasl-dump-16-bit-ivector (v op)
1643  (let* ((n (uvsize v)))
1644    (fasl-out-opcode op v)
1645    (fasl-out-count n)
1646    (if (eq *fasl-host-big-endian* *fasl-target-big-endian*)
1647      (let* ((nb (ash n 1)))
1648        (fasl-out-ivect v 0 nb))
1649      (dotimes (i n)
1650        (let* ((k (uvref v i)))
1651          (fasl-out-byte (ldb (byte 8 0) k))
1652          (fasl-out-byte (ldb (byte 8 8) k)))))))
1653
1654(defun fasl-dump-32-bit-ivector (v op)
1655  (let* ((n (uvsize v)))
1656    (fasl-out-opcode op v)
1657    (fasl-out-count n)
1658    (if (eq *fasl-host-big-endian* *fasl-target-big-endian*)
1659      (let* ((nb (ash n 2)))
1660        (fasl-out-ivect v 0 nb))
1661      (dotimes (i n)
1662        (let* ((k (uvref v i)))
1663          (fasl-out-byte (ldb (byte 8 0) k))
1664          (fasl-out-byte (ldb (byte 8 8) k))
1665          (fasl-out-byte (ldb (byte 8 16) k))
1666          (fasl-out-byte (ldb (byte 8 24) k)))))))
1667
1668
1669(defun fasl-dump-64-bit-ivector (v op)
1670  (let* ((n (uvsize v)))
1671    (fasl-out-opcode op v)
1672    (fasl-out-count n)
1673    (if (eq *fasl-host-big-endian* *fasl-target-big-endian*)
1674      (let* ((nb (ash n 3)))
1675        (fasl-out-ivect v 0 nb))
1676      (compiler-bug "need to byte-swap ~a" v))))
1677
1678(defun fasl-dump-double-float-vector (v)
1679  (let* ((n (uvsize v)))
1680    (fasl-out-opcode $fasl-double-float-vector v)
1681    (fasl-out-count n)
1682    (if (eq *fasl-host-big-endian* *fasl-target-big-endian*)
1683      (let* ((nb (ash n 3)))
1684        (fasl-out-ivect v (- target::misc-dfloat-offset
1685                             target::misc-data-offset) nb))
1686      (compiler-bug "need to byte-swap ~a" v))))
1687
1688;;; This is used to dump functions and "xfunctions".
1689;;; If we're cross-compiling, we shouldn't reference any
1690;;; (host) functions as constants; try to detect that
1691;;; case.
1692#-x86-target
1693(defun fasl-dump-function (f)
1694  (if (and (not (eq *fasl-backend* *host-backend*))
1695           (typep f 'function))
1696    (compiler-bug "Dumping a native function constant ~s during cross-compilation." f))
1697  (if (and (= (typecode f) target::subtag-xfunction)
1698           (= (typecode (uvref f 0)) target::subtag-u8-vector))
1699    (fasl-xdump-clfun f)
1700    (let* ((n (uvsize f)))
1701      (fasl-out-opcode $fasl-function f)
1702      (fasl-out-count n)
1703      (dotimes (i n)
1704        (fasl-dump-form (%svref f i))))))
1705
1706#+x86-target
1707(defun fasl-dump-function (f)
1708  (if (and (not (eq *fasl-backend* *host-backend*))
1709           (typep f 'function))
1710    (compiler-bug "Dumping a native function constant ~s during cross-compilation." f))
1711  (if (and (= (typecode f) target::subtag-xfunction)
1712           (= (typecode (uvref f 0)) target::subtag-u8-vector))
1713    (fasl-xdump-clfun f)
1714    (let* ((code-size (%function-code-words f))
1715           (function-vector (function-to-function-vector f))
1716           (function-size (uvsize function-vector)))
1717      (fasl-out-opcode $fasl-clfun f)
1718      (fasl-out-count function-size)
1719      (fasl-out-count code-size)
1720      (fasl-out-ivect function-vector 0 (ash code-size target::word-shift))
1721      (do* ((k code-size (1+ k)))
1722           ((= k function-size))
1723        (declare (fixnum k))
1724        (fasl-dump-form (uvref function-vector k))))))
1725       
1726
1727 
1728
1729;;; Write a "concatenated function".
1730(defun fasl-xdump-clfun (f)
1731  (target-arch-case
1732   (:x8632
1733    (let* ((code (uvref f 0))
1734           (function-size (ash (uvsize code) -2))
1735           (imm-words (dpb (uvref code 1) (byte 8 8) (uvref code 0)))
1736           (imm-bytes (ash imm-words 2))
1737           (other-words (- function-size imm-words)))
1738      (assert (= other-words (1- (uvsize f))))
1739      (fasl-out-opcode $fasl-clfun f)
1740      (fasl-out-count function-size)
1741      (fasl-out-count imm-words)
1742      (fasl-out-ivect code 0 imm-bytes)
1743      (do ((i 1 (1+ i))
1744           (n (uvsize f)))
1745          ((= i n))
1746        (declare (fixnum i n))
1747        (fasl-dump-form (%svref f i)))))
1748   (:x8664
1749    (let* ((code (uvref f 0))
1750           (code-size (dpb (uvref code 3)
1751                           (byte 8 24)
1752                           (dpb (uvref code 2)
1753                                (byte 8 16)
1754                                (dpb (uvref code 1)
1755                                     (byte 8 8)
1756                                     (uvref code 0)))))
1757           (function-size (ash (uvsize code) -3)))
1758      (assert (= (- function-size code-size) (1- (uvsize f))))
1759      (fasl-out-opcode $fasl-clfun f)
1760      (fasl-out-count function-size)
1761      (fasl-out-count code-size)
1762      (fasl-out-ivect code 0 (ash code-size 3))
1763      (do* ((i 1 (1+ i))
1764            (n (uvsize f)))
1765           ((= i n))
1766        (declare (fixnum i n))
1767        (fasl-dump-form (%svref f i)))))))
1768
1769(defun fasl-dump-codevector (c)
1770  (if (and (not (eq *fasl-backend* *host-backend*))
1771           (typep c 'code-vector))
1772    (compiler-bug "Dumping a native code-vector constant ~s during cross-compilation." c))
1773  (let* ((n (uvsize c)))
1774    (fasl-out-opcode $fasl-code-vector c)
1775    (fasl-out-count n)
1776    (fasl-out-ivect c)))
1777
1778(defun fasl-dump-t_imm (imm)
1779  (fasl-out-opcode $fasl-timm imm)
1780  (fasl-out-long (%address-of imm)))
1781
1782(defun fasl-dump-char (char)     ; << maybe not
1783  (let ((code (%char-code char)))
1784    (fasl-out-opcode $fasl-char char)
1785    (fasl-out-count code)))
1786
1787;;; Always write big-endian.
1788(defun fasl-dump-s16 (s16)
1789  (fasl-out-opcode $fasl-word-fixnum s16)
1790  (fasl-out-word s16))
1791
1792;;; Always write big-endian
1793(defun fasl-dump-s32 (s32)
1794  (fasl-out-opcode $fasl-s32 s32)
1795  (fasl-out-word (ldb (byte 16 16) s32))
1796  (fasl-out-word (ldb (byte 16 0) s32)))
1797
1798;;; Always write big-endian
1799(defun fasl-dump-s64 (s64)
1800  (fasl-out-opcode $fasl-s64 s64)
1801  (fasl-out-word (ldb (byte 16 48) s64))
1802  (fasl-out-word (ldb (byte 16 32) s64))
1803  (fasl-out-word (ldb (byte 16 16) s64))
1804  (fasl-out-word (ldb (byte 16 0) s64)))
1805
1806
1807
1808(defun fasl-dump-dfloat (float)
1809  (fasl-out-opcode $fasl-dfloat float)
1810  (multiple-value-bind (high low) (double-float-bits float)
1811    (fasl-out-long high)
1812    (fasl-out-long low)))
1813
1814(defun fasl-dump-sfloat (float)
1815  (fasl-out-opcode $fasl-sfloat float)
1816  (fasl-out-long (single-float-bits float)))
1817
1818
1819(defun fasl-dump-package (pkg)
1820  (let ((name (package-name pkg)))
1821    (fasl-out-opcode $fasl-nvpkg pkg)
1822    (fasl-out-nvstring name)))
1823
1824
1825
1826(defun fasl-dump-list (list)
1827  (cond ((null list) (fasl-out-opcode $fasl-nil list))
1828        ((eq (%car list) cfasl-load-time-eval-sym)
1829         (let* ((form (car (%cdr list)))
1830                (opcode $fasl-eval))
1831           (when (funcall-lfun-p form)
1832             (setq opcode $fasl-lfuncall
1833                   form (%cadr form)))
1834           (if *fasdump-epush*
1835             (progn
1836               (fasl-out-byte (fasl-epush-op opcode))
1837               (fasl-dump-form form)
1838               (fasl-dump-epush list))
1839             (progn
1840               (fasl-out-byte opcode)
1841               (fasl-dump-form form)))))
1842        ((istruct-cell-p list)
1843         (fasl-out-opcode $fasl-istruct-cell (car list))
1844         (fasl-dump-symbol (car list)))
1845        (t (fasl-dump-cons list))))
1846
1847(defun fasl-dump-cons (cons &aux (end cons) (cdr-len 0))
1848  (declare (fixnum cdr-len))
1849  (while (and (consp (setq end (%cdr end)))
1850              (null (gethash end *fasdump-hash*)))
1851    (incf cdr-len))
1852  (if (eql 0 cdr-len)
1853    (fasl-out-opcode $fasl-cons cons)
1854    (progn
1855      (fasl-out-opcode (if end $fasl-vlist* $fasl-vlist) cons)
1856      (fasl-out-count cdr-len)))
1857  (dotimes (i (the fixnum (1+ cdr-len)))
1858    (fasl-dump-form (%car cons))
1859    (setq cons (%cdr cons)))
1860  (when (or (eql 0 cdr-len) end)      ;cons or list*
1861    (fasl-dump-form end)))
1862
1863
1864
1865(defun fasl-dump-symbol (sym)
1866  (let* ((pkg (symbol-package sym))
1867         (name (symbol-name sym))
1868         (idx (let* ((i (%svref (symptr->symvector (%symbol->symptr sym)) target::symbol.binding-index-cell)))
1869                (declare (fixnum i))
1870                (unless (zerop i) i))))
1871    (cond ((null pkg) 
1872           (progn 
1873             (fasl-out-opcode (if idx $fasl-nvmksym-special $fasl-nvmksym) sym)
1874             (fasl-out-nvstring name)))
1875          (*fasdump-epush*
1876           (progn
1877             (fasl-out-byte (fasl-epush-op (if idx
1878                                             $fasl-nvpkg-intern-special
1879                                             $fasl-nvpkg-intern)))
1880             (fasl-dump-form pkg)
1881             (fasl-dump-epush sym)
1882             (fasl-out-nvstring name)))
1883          (t
1884           (progn
1885             (fasl-out-byte (if idx
1886                              $fasl-nvpkg-intern-special
1887                              $fasl-nvpkg-intern))
1888             (fasl-dump-form pkg)
1889             (fasl-out-nvstring name))))))
1890
1891
1892(defun fasl-unknown (exp)
1893  (error "Can't dump ~S - unknown type" exp))
1894
1895(defun fasl-out-simple-string (str start end)
1896  (declare (simple-string str) (fixnum start end))
1897  (do* ((k start (1+ k)))
1898       ((= k end))
1899    (declare (fixnum k))
1900    (fasl-out-count (char-code (schar str k)))))
1901
1902(defun fasl-out-nvstring (str)
1903  (fasl-out-count (length str))
1904  (fasl-out-simple-string str 0 (length str)))
1905
1906(defun fasl-out-ivect (iv &optional 
1907                          (start 0) 
1908                          (nb 
1909                           (subtag-bytes (typecode iv) (uvsize iv))))
1910  (stream-write-ivector *fasdump-stream* iv start nb))
1911
1912
1913(defun fasl-out-long (long)
1914  (fasl-out-word (ash long -16))
1915  (fasl-out-word (logand long #xFFFF)))
1916
1917(defun fasl-out-word (word)
1918  (fasl-out-byte (ash word -8))
1919  (fasl-out-byte word))
1920
1921(defun fasl-out-byte (byte)
1922  (write-byte (%ilogand2 byte #xFF) *fasdump-stream*))
1923
1924;;; Write an unsigned integer in 7-bit chunks.
1925(defun fasl-out-count (val)
1926  (do* ((b (ldb (byte 7 0) val) (ldb (byte 7 0) val))
1927        (done nil))
1928       (done)
1929    (when (zerop (setq val (ash val -7)))
1930      (setq b (logior #x80 b) done t))
1931    (fasl-out-byte b)))
1932
1933(defun fasl-filepos ()
1934  (file-position *fasdump-stream*))
1935
1936(defun fasl-set-filepos (pos)
1937  (file-position *fasdump-stream* pos)
1938  #-bccl (unless (eq (file-position *fasdump-stream*) pos)
1939           (error "Unable to set file position to ~S" pos)))
1940
1941;;; Concatenate fasl files.
1942
1943;;; Format of a fasl file as expected by the fasloader.
1944;;;
1945;;; #xFF00         2 bytes - File version
1946;;; Block Count    2 bytes - Number of blocks in the file
1947;;; addr[0]        4 bytes - address of 0th block
1948;;; length[0]      4 bytes - length of 0th block
1949;;; addr[1]        4 bytes - address of 1st block
1950;;; length[1]      4 bytes - length of 1st block
1951;;; ...
1952;;; addr[n-1]      4 bytes
1953;;; length[n-1]    4 bytes
1954;;; length[0] + length[1] + ... + length [n-1] bytes of data
1955
1956;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1957;;
1958;; (fasl-concatenate out-file fasl-files &key :if-exists)
1959;;
1960;; out-file     name of file in which to store the concatenation
1961;; fasl-files   list of names of fasl files to concatenate
1962;; if-exists    as for OPEN, defaults to :error
1963;;
1964;; function result: pathname to the output file.
1965;; It works to use the output of one invocation of fasl-concatenate
1966;; as an input of another invocation.
1967;;
1968(defun fasl-concatenate (out-file fasl-files &key (if-exists :error))
1969  (%fasl-concatenate out-file fasl-files if-exists (pathname-type *.fasl-pathname*)))
1970
1971(defun %fasl-concatenate (out-file fasl-files if-exists file-ext)
1972  (let ((count 0)
1973        (created? nil)
1974        (finished? nil)
1975        (ext-pathname (make-pathname :type file-ext)))
1976    (declare (fixnum count))
1977    (flet ((fasl-read-halfword (f)
1978             (dpb (read-byte f) (byte 8 8) (read-byte f)))
1979           (fasl-write-halfword (h f)
1980             (write-byte (ldb (byte 8 8) h) f)
1981             (write-byte (ldb (byte 8 0) h) f)
1982             h))
1983      (flet ((fasl-read-fullword (f)
1984               (dpb (fasl-read-halfword f) (byte 16 16) (fasl-read-halfword f)))
1985             (fasl-write-fullword (w f)
1986               (fasl-write-halfword (ldb (byte 16 16) w) f)
1987               (fasl-write-halfword (ldb (byte 16 0) w) f)
1988               w))
1989        (dolist (file fasl-files)
1990          (setq file (merge-pathnames file ext-pathname))
1991          (unless (equal (pathname-type file) file-ext)
1992            (error "Not a ~A file: ~s" file-ext file))
1993          (with-open-file (instream file :element-type '(unsigned-byte 8))
1994            (unless (eql fasl-file-id (fasl-read-halfword instream))
1995              (error "Bad ~A file ID in ~s" file-ext file))
1996            (incf count (fasl-read-halfword instream))))
1997        (unwind-protect
1998             (with-open-file (outstream
1999                              (setq out-file (merge-pathnames out-file ext-pathname))
2000                              :element-type '(unsigned-byte 8)
2001                              :direction :output
2002                              :if-does-not-exist :create
2003                              :if-exists if-exists)
2004               (setq created? t)
2005               (let ((addr-address 4)
2006                     (data-address (+ 4 (* count 8))))
2007                 (fasl-write-halfword 0 outstream) ;  will be $fasl-id
2008                 (fasl-write-halfword count outstream)
2009                 (dotimes (i (* 2 count))
2010                   (fasl-write-fullword 0 outstream)) ; for addresses/lengths
2011                 (dolist (file fasl-files)
2012                   (with-open-file (instream (merge-pathnames file ext-pathname)
2013                                             :element-type '(unsigned-byte 8))
2014                     (fasl-read-halfword instream) ; skip ID
2015                     (let* ((fasl-count (fasl-read-halfword instream))
2016                            (addrs (make-array fasl-count))
2017                            (sizes (make-array fasl-count))
2018                            addr0)
2019                       (declare (fixnum fasl-count)
2020                                (dynamic-extent addrs sizes))
2021                       (dotimes (i fasl-count)
2022                         (setf (svref addrs i) (fasl-read-fullword instream)
2023                               (svref sizes i) (fasl-read-fullword instream)))
2024                       (setq addr0 (svref addrs 0))
2025                       (file-position outstream addr-address)
2026                       (dotimes (i fasl-count)
2027                         (fasl-write-fullword
2028                          (+ data-address (- (svref addrs i) addr0))
2029                          outstream)
2030                         (fasl-write-fullword (svref sizes i) outstream)
2031                         (incf addr-address 8))
2032                       (file-position outstream data-address)
2033                       (dotimes (i fasl-count)
2034                         (file-position instream (svref addrs i))
2035                         (let ((fasl-length (svref sizes i)))
2036                           (dotimes (j fasl-length)
2037                             (write-byte (read-byte instream) outstream))
2038                           (incf data-address fasl-length))))))
2039                 (stream-length outstream data-address)
2040                 (file-position outstream 0)
2041                 (fasl-write-halfword fasl-file-id outstream)
2042                 (setq finished? t)))
2043          (when (and created? (not finished?))
2044            (delete-file out-file))))
2045      out-file)))
2046
2047;;; Cross-compilation environment stuff.  Some of this involves
2048;;; setting up the TARGET and OS packages.
2049(defun ensure-package-nickname (name package)
2050  (let* ((old (find-package name)))
2051    (unless (eq old package)
2052      (rename-package old (package-name old) (delete name (package-nicknames old) :test #'string=))
2053      (rename-package package (package-name package) (cons name (package-nicknames package)))
2054      old)))
2055
2056(defmacro with-cross-compilation-package ((name target) &body body)
2057  (let* ((old-package (gensym))
2058         (name-var (gensym))
2059         (target-var (gensym)))
2060    `(let* ((,name-var ,name)
2061            (,target-var ,target)
2062            (,old-package (ensure-package-nickname ,name-var ,target-var)))
2063      (unwind-protect
2064           (progn ,@body)
2065        (when ,old-package (ensure-package-nickname ,name-var
2066                                                          ,old-package))))))
2067
2068(defun %with-cross-compilation-target (target thunk)
2069  (let* ((backend (find-backend target)))
2070    (if (null backend)
2071      (error "No known compilation target named ~s." target)
2072      (let* ((arch (backend-target-arch backend))
2073             (arch-package-name (arch::target-package-name arch))
2074             (ftd (backend-target-foreign-type-data backend))
2075             (ftd-package-name (ftd-interface-package-name ftd)))
2076        (or (find-package arch-package-name)
2077            (make-package arch-package-name))
2078        (or (find-package ftd-package-name)
2079            (make-package ftd-package-name :use "COMMON-LISP"))
2080        (with-cross-compilation-package ("OS" ftd-package-name)
2081          (with-cross-compilation-package ("TARGET" arch-package-name)
2082            (let* ((*target-ftd* ftd))
2083               (funcall thunk))))))))
2084
2085(defmacro with-cross-compilation-target ((target) &body body)
2086  `(%with-cross-compilation-target ,target #'(lambda () ,@body)))
2087             
2088
2089 
2090
2091(provide 'nfcomp)
2092
Note: See TracBrowser for help on using the repository browser.