source: branches/working-0711/ccl/lib/nfcomp.lisp @ 10939

Last change on this file since 10939 was 10939, checked in by gz, 11 years ago

Fix to r10938: add any defconstants and defmacros to compile time eval env

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