0.9.10.26
[sbcl.git] / src / compiler / early-c.lisp
1 ;;;; This file contains compiler code and compiler-related stuff which
2 ;;;; can be built early on. Some of the stuff may be here because it's
3 ;;;; needed early on, some other stuff (e.g. constants) just because
4 ;;;; it might as well be done early so we don't have to think about
5 ;;;; whether it's done early enough.
6
7 ;;;; This software is part of the SBCL system. See the README file for
8 ;;;; more information.
9 ;;;;
10 ;;;; This software is derived from the CMU CL system, which was
11 ;;;; written at Carnegie Mellon University and released into the
12 ;;;; public domain. The software is in the public domain and is
13 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
14 ;;;; files for more information.
15
16 (in-package "SB!C")
17
18 ;;; ANSI limits on compilation
19 (def!constant sb!xc:call-arguments-limit sb!xc:most-positive-fixnum
20   #!+sb-doc
21   "The exclusive upper bound on the number of arguments which may be passed
22   to a function, including &REST args.")
23 (def!constant sb!xc:lambda-parameters-limit sb!xc:most-positive-fixnum
24   #!+sb-doc
25   "The exclusive upper bound on the number of parameters which may be specifed
26   in a given lambda list. This is actually the limit on required and &OPTIONAL
27   parameters. With &KEY and &AUX you can get more.")
28 (def!constant sb!xc:multiple-values-limit sb!xc:most-positive-fixnum
29   #!+sb-doc
30   "The exclusive upper bound on the number of multiple VALUES that you can
31   return.")
32
33 (defconstant-eqx sb!xc:lambda-list-keywords
34   '(&allow-other-keys
35     &aux
36     &body
37     &environment
38     &key
39     &more
40     &optional
41     &rest
42     &whole)
43   #'equal
44   #!+sb-doc
45   "symbols which are magical in a lambda list")
46 \f
47 ;;;; cross-compiler-only versions of CL special variables, so that we
48 ;;;; don't have weird interactions with the host compiler
49
50 (defvar sb!xc:*compile-file-pathname*)
51 (defvar sb!xc:*compile-file-truename*)
52 (defvar sb!xc:*compile-print*)
53 (defvar sb!xc:*compile-verbose*)
54 \f
55 ;;;; miscellaneous types used both in the cross-compiler and on the target
56
57 ;;;; FIXME: The INDEX and LAYOUT-DEPTHOID definitions probably belong
58 ;;;; somewhere else, not "early-c", since they're after all not part
59 ;;;; of the compiler.
60
61 ;;; the type of LAYOUT-DEPTHOID slot values
62 (def!type sb!kernel::layout-depthoid () '(or index (integer -1 -1)))
63 \f
64 ;;; possible values for the INLINE-ness of a function.
65 (deftype inlinep ()
66   '(member :inline :maybe-inline :notinline nil))
67 (defparameter *inlinep-translations*
68   '((inline . :inline)
69     (notinline . :notinline)
70     (maybe-inline . :maybe-inline)))
71
72 ;;; the lexical environment we are currently converting in
73 (defvar *lexenv*)
74 (declaim (type lexenv *lexenv*))
75
76 ;;; *FREE-VARS* translates from the names of variables referenced
77 ;;; globally to the LEAF structures for them. *FREE-FUNS* is like
78 ;;; *FREE-VARS*, only it deals with function names.
79 (defvar *free-vars*)
80 (defvar *free-funs*)
81 (declaim (type hash-table *free-vars* *free-funs*))
82
83 ;;; We use the same CONSTANT structure to represent all equal anonymous
84 ;;; constants. This hashtable translates from constants to the LEAFs that
85 ;;; represent them.
86 (defvar *constants*)
87 (declaim (type hash-table *constants*))
88
89 ;;; *ALLOW-INSTRUMENTING* controls whether we should allow the
90 ;;; insertion of instrumenting code (like a (CATCH ...)) around code
91 ;;; to allow the debugger RETURN and STEP commands to function (we
92 ;;; disallow it for internal stuff).
93 (defvar *allow-instrumenting*)
94
95 ;;; miscellaneous forward declarations
96 (defvar *code-segment*)
97 #!+sb-dyncount (defvar *collect-dynamic-statistics*)
98 (defvar *component-being-compiled*)
99 (defvar *compiler-error-context*)
100 (defvar *compiler-error-count*)
101 (defvar *compiler-warning-count*)
102 (defvar *compiler-style-warning-count*)
103 (defvar *compiler-note-count*)
104 (defvar *compiler-trace-output*)
105 (defvar *constraint-number*)
106 (defvar *count-vop-usages*)
107 (defvar *current-path*)
108 (defvar *current-component*)
109 (defvar *delayed-ir1-transforms*)
110 (defvar *handled-conditions*)
111 (defvar *disabled-package-locks*)
112 (defvar *policy*)
113 (defvar *dynamic-counts-tn*)
114 (defvar *elsewhere*)
115 (defvar *event-info*)
116 (defvar *event-note-threshold*)
117 (defvar *failure-p*)
118 (defvar *fixup-notes*)
119 (defvar *in-pack*)
120 (defvar *info-environment*)
121 (defvar *lexenv*)
122 (defvar *source-info*)
123 (defvar *trace-table*)
124 (defvar *undefined-warnings*)
125 (defvar *warnings-p*)
126
127 ;;; This lock is seized in the compiler, and related areas: the
128 ;;; compiler is not presently thread-safe
129 (defvar *big-compiler-lock*
130   (sb!thread:make-mutex :name "big compiler lock"))
131
132 ;;; unique ID for the next object created (to let us track object
133 ;;; identity even across GC, useful for understanding weird compiler
134 ;;; bugs where something is supposed to be unique but is instead
135 ;;; exists as duplicate objects)
136 #!+sb-show
137 (progn
138   (defvar *object-id-counter* 0)
139   (defun new-object-id ()
140     (prog1
141         *object-id-counter*
142       (incf *object-id-counter*))))
143 \f
144 ;;;; miscellaneous utilities
145
146 ;;; Delete any undefined warnings for NAME and KIND. This is for the
147 ;;; benefit of the compiler, but it's sometimes called from stuff like
148 ;;; type-defining code which isn't logically part of the compiler.
149 (declaim (ftype (function ((or symbol cons) keyword) (values))
150                 note-name-defined))
151 (defun note-name-defined (name kind)
152   ;; We do this BOUNDP check because this function can be called when
153   ;; not in a compilation unit (as when loading top level forms).
154   (when (boundp '*undefined-warnings*)
155     (setq *undefined-warnings*
156           (delete-if (lambda (x)
157                        (and (equal (undefined-warning-name x) name)
158                             (eq (undefined-warning-kind x) kind)))
159                      *undefined-warnings*)))
160   (values))
161
162 ;;; to be called when a variable is lexically bound
163 (declaim (ftype (function (symbol) (values)) note-lexical-binding))
164 (defun note-lexical-binding (symbol)
165     ;; This check is intended to protect us from getting silently
166     ;; burned when we define
167     ;;   foo.lisp:
168     ;;     (DEFVAR *FOO* -3)
169     ;;     (DEFUN FOO (X) (+ X *FOO*))
170     ;;   bar.lisp:
171     ;;     (DEFUN BAR (X)
172     ;;       (LET ((*FOO* X))
173     ;;         (FOO 14)))
174     ;; and then we happen to compile bar.lisp before foo.lisp.
175   (when (looks-like-name-of-special-var-p symbol)
176     ;; FIXME: should be COMPILER-STYLE-WARNING?
177     (style-warn "using the lexical binding of the symbol ~S, not the~@
178 dynamic binding, even though the symbol name follows the usual naming~@
179 convention (names like *FOO*) for special variables" symbol))
180   (values))
181
182 (defvar *debug-name-level* 6)
183
184 (defun debug-name (type thing)
185   (labels ((walk (x level)
186              (if (> *debug-name-level* (incf level))
187                  (typecase x
188                    (cons
189                     (cons (walk (car x) level) (walk (cdr x) level)))
190                    ((or symbol number string)
191                     x)
192                    (t
193                     (format nil "#<~S>" (type-of x))))
194                  "#<...>")))
195     ;; FIXME: It might be nice to put markers in the tree instead of
196     ;; this #<...> business, so that they would evantually be printed
197     ;; without the quotes.
198     (let ((name (list type (walk thing 0))))
199       (when (legal-fun-name-p name)
200         (bug "~S is a legal function name, and cannot be used as a ~
201               debug name." name))
202       name)))