1.0.6.13: minor fix to the compiler's interval-arithmetic
[sbcl/simd.git] / src / compiler / ir1tran.lisp
blob8f80aefc5a35f4d7b9957c2b816b24902dc6e575
1 ;;;; This file contains code which does the translation from Lisp code
2 ;;;; to the first intermediate representation (IR1).
4 ;;;; This software is part of the SBCL system. See the README file for
5 ;;;; more information.
6 ;;;;
7 ;;;; This software is derived from the CMU CL system, which was
8 ;;;; written at Carnegie Mellon University and released into the
9 ;;;; public domain. The software is in the public domain and is
10 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
11 ;;;; files for more information.
13 (in-package "SB!C")
15 (declaim (special *compiler-error-bailout*))
17 ;;; *SOURCE-PATHS* is a hashtable from source code forms to the path
18 ;;; taken through the source to reach the form. This provides a way to
19 ;;; keep track of the location of original source forms, even when
20 ;;; macroexpansions and other arbitary permutations of the code
21 ;;; happen. This table is initialized by calling FIND-SOURCE-PATHS on
22 ;;; the original source.
23 (declaim (hash-table *source-paths*))
24 (defvar *source-paths*)
26 ;;; *CURRENT-COMPONENT* is the COMPONENT structure which we link
27 ;;; blocks into as we generate them. This just serves to glue the
28 ;;; emitted blocks together until local call analysis and flow graph
29 ;;; canonicalization figure out what is really going on. We need to
30 ;;; keep track of all the blocks generated so that we can delete them
31 ;;; if they turn out to be unreachable.
32 ;;;
33 ;;; FIXME: It's confusing having one variable named *CURRENT-COMPONENT*
34 ;;; and another named *COMPONENT-BEING-COMPILED*. (In CMU CL they
35 ;;; were called *CURRENT-COMPONENT* and *COMPILE-COMPONENT* respectively,
36 ;;; which was also confusing.)
37 (declaim (type (or component null) *current-component*))
38 (defvar *current-component*)
40 ;;; *CURRENT-PATH* is the source path of the form we are currently
41 ;;; translating. See NODE-SOURCE-PATH in the NODE structure.
42 (declaim (list *current-path*))
43 (defvar *current-path*)
45 (defvar *derive-function-types* nil
46 "Should the compiler assume that function types will never change,
47 so that it can use type information inferred from current definitions
48 to optimize code which uses those definitions? Setting this true
49 gives non-ANSI, early-CMU-CL behavior. It can be useful for improving
50 the efficiency of stable code.")
52 (defvar *fun-names-in-this-file* nil)
54 (defvar *post-binding-variable-lexenv* nil)
56 ;;;; namespace management utilities
58 (defun fun-lexically-notinline-p (name)
59 (let ((fun (lexenv-find name funs :test #'equal)))
60 ;; a declaration will trump a proclamation
61 (if (and fun (defined-fun-p fun))
62 (eq (defined-fun-inlinep fun) :notinline)
63 (eq (info :function :inlinep name) :notinline))))
65 ;;; Return a GLOBAL-VAR structure usable for referencing the global
66 ;;; function NAME.
67 (defun find-global-fun (name latep)
68 (unless (info :function :kind name)
69 (setf (info :function :kind name) :function)
70 (setf (info :function :where-from name) :assumed))
71 (let ((where (info :function :where-from name)))
72 (when (and (eq where :assumed)
73 ;; In the ordinary target Lisp, it's silly to report
74 ;; undefinedness when the function is defined in the
75 ;; running Lisp. But at cross-compile time, the current
76 ;; definedness of a function is irrelevant to the
77 ;; definedness at runtime, which is what matters.
78 #-sb-xc-host (not (fboundp name))
79 ;; LATEP is true when the user has indicated that
80 ;; late-late binding is desired by using eg. a quoted
81 ;; symbol -- in which case it makes little sense to
82 ;; complain about undefined functions.
83 (not latep))
84 (note-undefined-reference name :function))
85 (make-global-var
86 :kind :global-function
87 :%source-name name
88 :type (if (and (not latep)
89 (or *derive-function-types*
90 (eq where :declared)
91 (and (member name *fun-names-in-this-file*
92 :test #'equal)
93 (not (fun-lexically-notinline-p name)))))
94 (info :function :type name)
95 (specifier-type 'function))
96 :where-from where)))
98 ;;; Has the *FREE-FUNS* entry FREE-FUN become invalid?
99 ;;;
100 ;;; In CMU CL, the answer was implicitly always true, so this
101 ;;; predicate didn't exist.
103 ;;; This predicate was added to fix bug 138 in SBCL. In some obscure
104 ;;; circumstances, it was possible for a *FREE-FUNS* entry to contain a
105 ;;; DEFINED-FUN whose DEFINED-FUN-FUNCTIONAL object contained IR1
106 ;;; stuff (NODEs, BLOCKs...) referring to an already compiled (aka
107 ;;; "dead") component. When this IR1 stuff was reused in a new
108 ;;; component, under further obscure circumstances it could be used by
109 ;;; WITH-IR1-ENVIRONMENT-FROM-NODE to generate a binding for
110 ;;; *CURRENT-COMPONENT*. At that point things got all confused, since
111 ;;; IR1 conversion was sending code to a component which had already
112 ;;; been compiled and would never be compiled again.
113 (defun invalid-free-fun-p (free-fun)
114 ;; There might be other reasons that *FREE-FUN* entries could
115 ;; become invalid, but the only one we've been bitten by so far
116 ;; (sbcl-0.pre7.118) is this one:
117 (and (defined-fun-p free-fun)
118 (let ((functional (defined-fun-functional free-fun)))
119 (or (and functional
120 (eql (functional-kind functional) :deleted))
121 (and (lambda-p functional)
123 ;; (The main reason for this first test is to bail
124 ;; out early in cases where the LAMBDA-COMPONENT
125 ;; call in the second test would fail because links
126 ;; it needs are uninitialized or invalid.)
128 ;; If the BIND node for this LAMBDA is null, then
129 ;; according to the slot comments, the LAMBDA has
130 ;; been deleted or its call has been deleted. In
131 ;; that case, it seems rather questionable to reuse
132 ;; it, and certainly it shouldn't be necessary to
133 ;; reuse it, so we cheerfully declare it invalid.
134 (null (lambda-bind functional))
135 ;; If this IR1 stuff belongs to a dead component,
136 ;; then we can't reuse it without getting into
137 ;; bizarre confusion.
138 (eql (component-info (lambda-component functional))
139 :dead)))))))
141 ;;; If NAME already has a valid entry in *FREE-FUNS*, then return
142 ;;; the value. Otherwise, make a new GLOBAL-VAR using information from
143 ;;; the global environment and enter it in *FREE-FUNS*. If NAME
144 ;;; names a macro or special form, then we error out using the
145 ;;; supplied context which indicates what we were trying to do that
146 ;;; demanded a function.
147 (declaim (ftype (sfunction (t string) global-var) find-free-fun))
148 (defun find-free-fun (name context)
149 (or (let ((old-free-fun (gethash name *free-funs*)))
150 (and (not (invalid-free-fun-p old-free-fun))
151 old-free-fun))
152 (ecase (info :function :kind name)
153 ;; FIXME: The :MACRO and :SPECIAL-FORM cases could be merged.
154 (:macro
155 (compiler-error "The macro name ~S was found ~A." name context))
156 (:special-form
157 (compiler-error "The special form name ~S was found ~A."
158 name
159 context))
160 ((:function nil)
161 (check-fun-name name)
162 (note-if-setf-fun-and-macro name)
163 (let ((expansion (fun-name-inline-expansion name))
164 (inlinep (info :function :inlinep name)))
165 (setf (gethash name *free-funs*)
166 (if (or expansion inlinep)
167 (make-defined-fun
168 :%source-name name
169 :inline-expansion expansion
170 :inlinep inlinep
171 :where-from (info :function :where-from name)
172 :type (if (eq inlinep :notinline)
173 (specifier-type 'function)
174 (info :function :type name)))
175 (find-global-fun name nil))))))))
177 ;;; Return the LEAF structure for the lexically apparent function
178 ;;; definition of NAME.
179 (declaim (ftype (sfunction (t string) leaf) find-lexically-apparent-fun))
180 (defun find-lexically-apparent-fun (name context)
181 (let ((var (lexenv-find name funs :test #'equal)))
182 (cond (var
183 (unless (leaf-p var)
184 (aver (and (consp var) (eq (car var) 'macro)))
185 (compiler-error "found macro name ~S ~A" name context))
186 var)
188 (find-free-fun name context)))))
190 ;;; Return the LEAF node for a global variable reference to NAME. If
191 ;;; NAME is already entered in *FREE-VARS*, then we just return the
192 ;;; corresponding value. Otherwise, we make a new leaf using
193 ;;; information from the global environment and enter it in
194 ;;; *FREE-VARS*. If the variable is unknown, then we emit a warning.
195 (declaim (ftype (sfunction (t) (or leaf cons heap-alien-info)) find-free-var))
196 (defun find-free-var (name)
197 (unless (symbolp name)
198 (compiler-error "Variable name is not a symbol: ~S." name))
199 (or (gethash name *free-vars*)
200 (let ((kind (info :variable :kind name))
201 (type (info :variable :type name))
202 (where-from (info :variable :where-from name)))
203 (when (and (eq where-from :assumed) (eq kind :global))
204 (note-undefined-reference name :variable))
205 (setf (gethash name *free-vars*)
206 (case kind
207 (:alien
208 (info :variable :alien-info name))
209 ;; FIXME: The return value in this case should really be
210 ;; of type SB!C::LEAF. I don't feel too badly about it,
211 ;; because the MACRO idiom is scattered throughout this
212 ;; file, but it should be cleaned up so we're not
213 ;; throwing random conses around. --njf 2002-03-23
214 (:macro
215 (let ((expansion (info :variable :macro-expansion name))
216 (type (type-specifier (info :variable :type name))))
217 `(macro . (the ,type ,expansion))))
218 (:constant
219 (let ((value (info :variable :constant-value name)))
220 (make-constant :value value
221 :%source-name name
222 :type (ctype-of value)
223 :where-from where-from)))
225 (make-global-var :kind kind
226 :%source-name name
227 :type type
228 :where-from where-from)))))))
230 ;;; Grovel over CONSTANT checking for any sub-parts that need to be
231 ;;; processed with MAKE-LOAD-FORM. We have to be careful, because
232 ;;; CONSTANT might be circular. We also check that the constant (and
233 ;;; any subparts) are dumpable at all.
234 (eval-when (:compile-toplevel :load-toplevel :execute)
235 ;; The EVAL-WHEN is necessary for #.(1+ LIST-TO-HASH-TABLE-THRESHOLD)
236 ;; below. -- AL 20010227
237 (def!constant list-to-hash-table-threshold 32))
238 (defun maybe-emit-make-load-forms (constant)
239 (let ((things-processed nil)
240 (count 0))
241 ;; FIXME: Does this LIST-or-HASH-TABLE messiness give much benefit?
242 (declare (type (or list hash-table) things-processed)
243 (type (integer 0 #.(1+ list-to-hash-table-threshold)) count)
244 (inline member))
245 (labels ((grovel (value)
246 ;; Unless VALUE is an object which which obviously
247 ;; can't contain other objects
248 (unless (typep value
249 '(or #-sb-xc-host unboxed-array
250 #+sb-xc-host (simple-array (unsigned-byte 8) (*))
251 symbol
252 number
253 character
254 string))
255 (etypecase things-processed
256 (list
257 (when (member value things-processed :test #'eq)
258 (return-from grovel nil))
259 (push value things-processed)
260 (incf count)
261 (when (> count list-to-hash-table-threshold)
262 (let ((things things-processed))
263 (setf things-processed
264 (make-hash-table :test 'eq))
265 (dolist (thing things)
266 (setf (gethash thing things-processed) t)))))
267 (hash-table
268 (when (gethash value things-processed)
269 (return-from grovel nil))
270 (setf (gethash value things-processed) t)))
271 (typecase value
272 (cons
273 (grovel (car value))
274 (grovel (cdr value)))
275 (simple-vector
276 (dotimes (i (length value))
277 (grovel (svref value i))))
278 ((vector t)
279 (dotimes (i (length value))
280 (grovel (aref value i))))
281 ((simple-array t)
282 ;; Even though the (ARRAY T) branch does the exact
283 ;; same thing as this branch we do this separately
284 ;; so that the compiler can use faster versions of
285 ;; array-total-size and row-major-aref.
286 (dotimes (i (array-total-size value))
287 (grovel (row-major-aref value i))))
288 ((array t)
289 (dotimes (i (array-total-size value))
290 (grovel (row-major-aref value i))))
291 (;; In the target SBCL, we can dump any instance,
292 ;; but in the cross-compilation host,
293 ;; %INSTANCE-FOO functions don't work on general
294 ;; instances, only on STRUCTURE!OBJECTs.
295 #+sb-xc-host structure!object
296 #-sb-xc-host instance
297 (when (emit-make-load-form value)
298 (dotimes (i (- (%instance-length value)
299 #+sb-xc-host 0
300 #-sb-xc-host (layout-n-untagged-slots
301 (%instance-ref value 0))))
302 (grovel (%instance-ref value i)))))
304 (compiler-error
305 "Objects of type ~S can't be dumped into fasl files."
306 (type-of value)))))))
307 (grovel constant)))
308 (values))
310 ;;;; some flow-graph hacking utilities
312 ;;; This function sets up the back link between the node and the
313 ;;; ctran which continues at it.
314 (defun link-node-to-previous-ctran (node ctran)
315 (declare (type node node) (type ctran ctran))
316 (aver (not (ctran-next ctran)))
317 (setf (ctran-next ctran) node)
318 (setf (node-prev node) ctran))
320 ;;; This function is used to set the ctran for a node, and thus
321 ;;; determine what is evaluated next. If the ctran has no block, then
322 ;;; we make it be in the block that the node is in. If the ctran heads
323 ;;; its block, we end our block and link it to that block.
324 #!-sb-fluid (declaim (inline use-ctran))
325 (defun use-ctran (node ctran)
326 (declare (type node node) (type ctran ctran))
327 (if (eq (ctran-kind ctran) :unused)
328 (let ((node-block (ctran-block (node-prev node))))
329 (setf (ctran-block ctran) node-block)
330 (setf (ctran-kind ctran) :inside-block)
331 (setf (ctran-use ctran) node)
332 (setf (node-next node) ctran))
333 (%use-ctran node ctran)))
334 (defun %use-ctran (node ctran)
335 (declare (type node node) (type ctran ctran) (inline member))
336 (let ((block (ctran-block ctran))
337 (node-block (ctran-block (node-prev node))))
338 (aver (eq (ctran-kind ctran) :block-start))
339 (when (block-last node-block)
340 (error "~S has already ended." node-block))
341 (setf (block-last node-block) node)
342 (when (block-succ node-block)
343 (error "~S already has successors." node-block))
344 (setf (block-succ node-block) (list block))
345 (when (memq node-block (block-pred block))
346 (error "~S is already a predecessor of ~S." node-block block))
347 (push node-block (block-pred block))))
349 ;;; This function is used to set the ctran for a node, and thus
350 ;;; determine what receives the value.
351 (defun use-lvar (node lvar)
352 (declare (type valued-node node) (type (or lvar null) lvar))
353 (aver (not (node-lvar node)))
354 (when lvar
355 (setf (node-lvar node) lvar)
356 (cond ((null (lvar-uses lvar))
357 (setf (lvar-uses lvar) node))
358 ((listp (lvar-uses lvar))
359 (aver (not (memq node (lvar-uses lvar))))
360 (push node (lvar-uses lvar)))
362 (aver (neq node (lvar-uses lvar)))
363 (setf (lvar-uses lvar) (list node (lvar-uses lvar)))))
364 (reoptimize-lvar lvar)))
366 #!-sb-fluid(declaim (inline use-continuation))
367 (defun use-continuation (node ctran lvar)
368 (use-ctran node ctran)
369 (use-lvar node lvar))
371 ;;;; exported functions
373 ;;; This function takes a form and the top level form number for that
374 ;;; form, and returns a lambda representing the translation of that
375 ;;; form in the current global environment. The returned lambda is a
376 ;;; top level lambda that can be called to cause evaluation of the
377 ;;; forms. This lambda is in the initial component. If FOR-VALUE is T,
378 ;;; then the value of the form is returned from the function,
379 ;;; otherwise NIL is returned.
381 ;;; This function may have arbitrary effects on the global environment
382 ;;; due to processing of EVAL-WHENs. All syntax error checking is
383 ;;; done, with erroneous forms being replaced by a proxy which signals
384 ;;; an error if it is evaluated. Warnings about possibly inconsistent
385 ;;; or illegal changes to the global environment will also be given.
387 ;;; We make the initial component and convert the form in a PROGN (and
388 ;;; an optional NIL tacked on the end.) We then return the lambda. We
389 ;;; bind all of our state variables here, rather than relying on the
390 ;;; global value (if any) so that IR1 conversion will be reentrant.
391 ;;; This is necessary for EVAL-WHEN processing, etc.
393 ;;; The hashtables used to hold global namespace info must be
394 ;;; reallocated elsewhere. Note also that *LEXENV* is not bound, so
395 ;;; that local macro definitions can be introduced by enclosing code.
396 (defun ir1-toplevel (form path for-value &optional (allow-instrumenting t))
397 (declare (list path))
398 (let* ((*current-path* path)
399 (component (make-empty-component))
400 (*current-component* component)
401 (*allow-instrumenting* allow-instrumenting))
402 (setf (component-name component) 'initial-component)
403 (setf (component-kind component) :initial)
404 (let* ((forms (if for-value `(,form) `(,form nil)))
405 (res (ir1-convert-lambda-body
406 forms ()
407 :debug-name (debug-name 'top-level-form form))))
408 (setf (functional-entry-fun res) res
409 (functional-arg-documentation res) ()
410 (functional-kind res) :toplevel)
411 res)))
413 ;;; *CURRENT-FORM-NUMBER* is used in FIND-SOURCE-PATHS to compute the
414 ;;; form number to associate with a source path. This should be bound
415 ;;; to an initial value of 0 before the processing of each truly
416 ;;; top level form.
417 (declaim (type index *current-form-number*))
418 (defvar *current-form-number*)
420 ;;; This function is called on freshly read forms to record the
421 ;;; initial location of each form (and subform.) Form is the form to
422 ;;; find the paths in, and TLF-NUM is the top level form number of the
423 ;;; truly top level form.
425 ;;; This gets a bit interesting when the source code is circular. This
426 ;;; can (reasonably?) happen in the case of circular list constants.
427 (defun find-source-paths (form tlf-num)
428 (declare (type index tlf-num))
429 (let ((*current-form-number* 0))
430 (sub-find-source-paths form (list tlf-num)))
431 (values))
432 (defun sub-find-source-paths (form path)
433 (unless (gethash form *source-paths*)
434 (setf (gethash form *source-paths*)
435 (list* 'original-source-start *current-form-number* path))
436 (incf *current-form-number*)
437 (let ((pos 0)
438 (subform form)
439 (trail form))
440 (declare (fixnum pos))
441 (macrolet ((frob ()
442 '(progn
443 (when (atom subform) (return))
444 (let ((fm (car subform)))
445 (if (consp fm)
446 ;; If it's a cons, recurse
447 (sub-find-source-paths fm (cons pos path))
448 ;; Otherwise store the containing form. It's
449 ;; not perfect, but better than nothing.
450 (setf (gethash subform *source-paths*)
451 (list* 'original-source-start
452 *current-form-number*
454 path)))
455 (incf pos))
456 (setq subform (cdr subform))
457 (when (eq subform trail) (return)))))
458 (loop
459 (frob)
460 (frob)
461 (setq trail (cdr trail)))))))
463 ;;;; IR1-CONVERT, macroexpansion and special form dispatching
465 (declaim (ftype (sfunction (ctran ctran (or lvar null) t) (values))
466 ir1-convert))
467 (macrolet (;; Bind *COMPILER-ERROR-BAILOUT* to a function that throws
468 ;; out of the body and converts a condition signalling form
469 ;; instead. The source form is converted to a string since it
470 ;; may contain arbitrary non-externalizable objects.
471 (ir1-error-bailout ((start next result form) &body body)
472 (with-unique-names (skip condition)
473 `(block ,skip
474 (let ((,condition (catch 'ir1-error-abort
475 (let ((*compiler-error-bailout*
476 (lambda (&optional e)
477 (throw 'ir1-error-abort e))))
478 ,@body
479 (return-from ,skip nil)))))
480 (ir1-convert ,start ,next ,result
481 (make-compiler-error-form ,condition
482 ,form)))))))
484 ;; Translate FORM into IR1. The code is inserted as the NEXT of the
485 ;; CTRAN START. RESULT is the LVAR which receives the value of the
486 ;; FORM to be translated. The translators call this function
487 ;; recursively to translate their subnodes.
489 ;; As a special hack to make life easier in the compiler, a LEAF
490 ;; IR1-converts into a reference to that LEAF structure. This allows
491 ;; the creation using backquote of forms that contain leaf
492 ;; references, without having to introduce dummy names into the
493 ;; namespace.
494 (defun ir1-convert (start next result form)
495 (ir1-error-bailout (start next result form)
496 (let* ((*current-path* (or (gethash form *source-paths*)
497 (cons form *current-path*)))
498 (start (instrument-coverage start nil form)))
499 (cond ((atom form)
500 (cond ((and (symbolp form) (not (keywordp form)))
501 (ir1-convert-var start next result form))
502 ((leaf-p form)
503 (reference-leaf start next result form))
505 (reference-constant start next result form))))
507 (ir1-convert-functoid start next result form)))))
508 (values))
510 ;; Generate a reference to a manifest constant, creating a new leaf
511 ;; if necessary. If we are producing a fasl file, make sure that
512 ;; MAKE-LOAD-FORM gets used on any parts of the constant that it
513 ;; needs to be.
514 (defun reference-constant (start next result value)
515 (declare (type ctran start next)
516 (type (or lvar null) result)
517 (inline find-constant))
518 (ir1-error-bailout (start next result value)
519 (when (producing-fasl-file)
520 (maybe-emit-make-load-forms value))
521 (let* ((leaf (find-constant value))
522 (res (make-ref leaf)))
523 (push res (leaf-refs leaf))
524 (link-node-to-previous-ctran res start)
525 (use-continuation res next result)))
526 (values)))
528 ;;; Add FUNCTIONAL to the COMPONENT-REANALYZE-FUNCTIONALS, unless it's
529 ;;; some trivial type for which reanalysis is a trivial no-op, or
530 ;;; unless it doesn't belong in this component at all.
532 ;;; FUNCTIONAL is returned.
533 (defun maybe-reanalyze-functional (functional)
535 (aver (not (eql (functional-kind functional) :deleted))) ; bug 148
536 (aver-live-component *current-component*)
538 ;; When FUNCTIONAL is of a type for which reanalysis isn't a trivial
539 ;; no-op
540 (when (typep functional '(or optional-dispatch clambda))
542 ;; When FUNCTIONAL knows its component
543 (when (lambda-p functional)
544 (aver (eql (lambda-component functional) *current-component*)))
546 (pushnew functional
547 (component-reanalyze-functionals *current-component*)))
549 functional)
551 ;;; Generate a REF node for LEAF, frobbing the LEAF structure as
552 ;;; needed. If LEAF represents a defined function which has already
553 ;;; been converted, and is not :NOTINLINE, then reference the
554 ;;; functional instead.
555 (defun reference-leaf (start next result leaf)
556 (declare (type ctran start next) (type (or lvar null) result) (type leaf leaf))
557 (when (functional-p leaf)
558 (assure-functional-live-p leaf))
559 (let* ((type (lexenv-find leaf type-restrictions))
560 (leaf (or (and (defined-fun-p leaf)
561 (not (eq (defined-fun-inlinep leaf)
562 :notinline))
563 (let ((functional (defined-fun-functional leaf)))
564 (when (and functional
565 (not (functional-kind functional))
566 ;; Bug MISC.320: ir1-transform
567 ;; can create a reference to a
568 ;; inline-expanded function,
569 ;; defined in another component.
570 (not (and (lambda-p functional)
571 (neq (lambda-component functional)
572 *current-component*))))
573 (maybe-reanalyze-functional functional))))
574 (when (and (lambda-p leaf)
575 (memq (functional-kind leaf)
576 '(nil :optional)))
577 (maybe-reanalyze-functional leaf))
578 leaf))
579 (ref (make-ref leaf)))
580 (push ref (leaf-refs leaf))
581 (setf (leaf-ever-used leaf) t)
582 (link-node-to-previous-ctran ref start)
583 (cond (type (let* ((ref-ctran (make-ctran))
584 (ref-lvar (make-lvar))
585 (cast (make-cast ref-lvar
586 (make-single-value-type type)
587 (lexenv-policy *lexenv*))))
588 (setf (lvar-dest ref-lvar) cast)
589 (use-continuation ref ref-ctran ref-lvar)
590 (link-node-to-previous-ctran cast ref-ctran)
591 (use-continuation cast next result)))
592 (t (use-continuation ref next result)))))
594 ;;; Convert a reference to a symbolic constant or variable. If the
595 ;;; symbol is entered in the LEXENV-VARS we use that definition,
596 ;;; otherwise we find the current global definition. This is also
597 ;;; where we pick off symbol macro and alien variable references.
598 (defun ir1-convert-var (start next result name)
599 (declare (type ctran start next) (type (or lvar null) result) (symbol name))
600 (let ((var (or (lexenv-find name vars) (find-free-var name))))
601 (if (and (global-var-p var) (not result))
602 ;; KLUDGE: If the reference is dead, convert using SYMBOL-VALUE
603 ;; which is not flushable, so that unbound dead variables signal
604 ;; an error (bug 412).
605 (ir1-convert start next result `(symbol-value ',name))
606 (etypecase var
607 (leaf
608 (when (lambda-var-p var)
609 (let ((home (ctran-home-lambda-or-null start)))
610 (when home
611 (sset-adjoin var (lambda-calls-or-closes home))))
612 (when (lambda-var-ignorep var)
613 ;; (ANSI's specification for the IGNORE declaration requires
614 ;; that this be a STYLE-WARNING, not a full WARNING.)
615 #-sb-xc-host
616 (compiler-style-warn "reading an ignored variable: ~S" name)
617 ;; there's no need for us to accept ANSI's lameness when
618 ;; processing our own code, though.
619 #+sb-xc-host
620 (warn "reading an ignored variable: ~S" name)))
621 (reference-leaf start next result var))
622 (cons
623 (aver (eq (car var) 'macro))
624 ;; FIXME: [Free] type declarations. -- APD, 2002-01-26
625 (ir1-convert start next result (cdr var)))
626 (heap-alien-info
627 (ir1-convert start next result `(%heap-alien ',var))))))
628 (values))
630 ;;; Find a compiler-macro for a form, taking FUNCALL into account.
631 (defun find-compiler-macro (opname form)
632 (if (eq opname 'funcall)
633 (let ((fun-form (cadr form)))
634 (cond ((and (consp fun-form) (eq 'function (car fun-form)))
635 (let ((real-fun (cadr fun-form)))
636 (if (legal-fun-name-p real-fun)
637 (values (sb!xc:compiler-macro-function real-fun *lexenv*)
638 real-fun)
639 (values nil nil))))
640 ((sb!xc:constantp fun-form *lexenv*)
641 (let ((fun (constant-form-value fun-form *lexenv*)))
642 (if (legal-fun-name-p fun)
643 ;; CLHS tells us that local functions must shadow
644 ;; compiler-macro-functions, but since the call is
645 ;; through a name, we are obviously interested
646 ;; in the global function.
647 (values (sb!xc:compiler-macro-function fun nil) fun)
648 (values nil nil))))
650 (values nil nil))))
651 (if (legal-fun-name-p opname)
652 (values (sb!xc:compiler-macro-function opname *lexenv*) opname)
653 (values nil nil))))
655 ;;; Picks of special forms and compiler-macro expansions, and hands
656 ;;; the rest to IR1-CONVERT-COMMON-FUNCTOID
657 (defun ir1-convert-functoid (start next result form)
658 (let* ((op (car form))
659 (translator (and (symbolp op) (info :function :ir1-convert op))))
660 (cond (translator
661 (when (sb!xc:compiler-macro-function op *lexenv*)
662 (compiler-warn "ignoring compiler macro for special form"))
663 (funcall translator start next result form))
665 (multiple-value-bind (cmacro-fun cmacro-fun-name)
666 (find-compiler-macro op form)
667 (if (and cmacro-fun
668 ;; CLHS 3.2.2.1.3 specifies that NOTINLINE
669 ;; suppresses compiler-macros.
670 (not (fun-lexically-notinline-p cmacro-fun-name)))
671 (let ((res (careful-expand-macro cmacro-fun form)))
672 (if (eq res form)
673 (ir1-convert-common-functoid start next result form
675 (ir1-convert start next result res)))
676 (ir1-convert-common-functoid start next result form op)))))))
678 ;;; Handles the "common" cases: any other forms except special forms
679 ;;; and compiler-macros.
680 (defun ir1-convert-common-functoid (start next result form op)
681 (cond ((or (symbolp op) (leaf-p op))
682 (let ((lexical-def (if (leaf-p op) op (lexenv-find op funs))))
683 (typecase lexical-def
684 (null
685 (ir1-convert-global-functoid start next result form op))
686 (functional
687 (ir1-convert-local-combination start next result form
688 lexical-def))
689 (global-var
690 (ir1-convert-srctran start next result lexical-def form))
692 (aver (and (consp lexical-def) (eq (car lexical-def) 'macro)))
693 (ir1-convert start next result
694 (careful-expand-macro (cdr lexical-def) form))))))
695 ((or (atom op) (not (eq (car op) 'lambda)))
696 (compiler-error "illegal function call"))
698 ;; implicitly (LAMBDA ..) because the LAMBDA expression is
699 ;; the CAR of an executed form.
700 (ir1-convert-combination
701 start next result form
702 (ir1-convert-lambda op
703 :debug-name (debug-name 'inline-lambda op))))))
705 ;;; Convert anything that looks like a global function call.
706 (defun ir1-convert-global-functoid (start next result form fun)
707 (declare (type ctran start next) (type (or lvar null) result)
708 (list form))
709 ;; FIXME: Couldn't all the INFO calls here be converted into
710 ;; standard CL functions, like MACRO-FUNCTION or something? And what
711 ;; happens with lexically-defined (MACROLET) macros here, anyway?
712 (ecase (info :function :kind fun)
713 (:macro
714 (ir1-convert start next result
715 (careful-expand-macro (info :function :macro-function fun)
716 form))
717 (unless (policy *lexenv* (zerop store-xref-data))
718 (record-macroexpansion fun (ctran-block start) *current-path*)))
719 ((nil :function)
720 (ir1-convert-srctran start next result
721 (find-free-fun fun "shouldn't happen! (no-cmacro)")
722 form))))
724 (defun muffle-warning-or-die ()
725 (muffle-warning)
726 (bug "no MUFFLE-WARNING restart"))
728 ;;; Expand FORM using the macro whose MACRO-FUNCTION is FUN, trapping
729 ;;; errors which occur during the macroexpansion.
730 (defun careful-expand-macro (fun form)
731 (let (;; a hint I (WHN) wish I'd known earlier
732 (hint "(hint: For more precise location, try *BREAK-ON-SIGNALS*.)"))
733 (flet (;; Return a string to use as a prefix in error reporting,
734 ;; telling something about which form caused the problem.
735 (wherestring ()
736 (let ((*print-pretty* nil)
737 ;; We rely on the printer to abbreviate FORM.
738 (*print-length* 3)
739 (*print-level* 1))
740 (format
742 #-sb-xc-host "(in macroexpansion of ~S)"
743 ;; longer message to avoid ambiguity "Was it the xc host
744 ;; or the cross-compiler which encountered the problem?"
745 #+sb-xc-host "(in cross-compiler macroexpansion of ~S)"
746 form))))
747 (handler-bind ((style-warning (lambda (c)
748 (compiler-style-warn
749 "~@<~A~:@_~A~@:_~A~:>"
750 (wherestring) hint c)
751 (muffle-warning-or-die)))
752 ;; KLUDGE: CMU CL in its wisdom (version 2.4.6 for
753 ;; Debian Linux, anyway) raises a CL:WARNING
754 ;; condition (not a CL:STYLE-WARNING) for undefined
755 ;; symbols when converting interpreted functions,
756 ;; causing COMPILE-FILE to think the file has a real
757 ;; problem, causing COMPILE-FILE to return FAILURE-P
758 ;; set (not just WARNINGS-P set). Since undefined
759 ;; symbol warnings are often harmless forward
760 ;; references, and since it'd be inordinately painful
761 ;; to try to eliminate all such forward references,
762 ;; these warnings are basically unavoidable. Thus, we
763 ;; need to coerce the system to work through them,
764 ;; and this code does so, by crudely suppressing all
765 ;; warnings in cross-compilation macroexpansion. --
766 ;; WHN 19990412
767 #+(and cmu sb-xc-host)
768 (warning (lambda (c)
769 (compiler-notify
770 "~@<~A~:@_~
771 ~A~:@_~
772 ~@<(KLUDGE: That was a non-STYLE WARNING. ~
773 Ordinarily that would cause compilation to ~
774 fail. However, since we're running under ~
775 CMU CL, and since CMU CL emits non-STYLE ~
776 warnings for safe, hard-to-fix things (e.g. ~
777 references to not-yet-defined functions) ~
778 we're going to have to ignore it and ~
779 proceed anyway. Hopefully we're not ~
780 ignoring anything horrible here..)~:@>~:>"
781 (wherestring)
783 (muffle-warning-or-die)))
784 #-(and cmu sb-xc-host)
785 (warning (lambda (c)
786 (warn "~@<~A~:@_~A~@:_~A~:>"
787 (wherestring) hint c)
788 (muffle-warning-or-die)))
789 (error (lambda (c)
790 (compiler-error "~@<~A~:@_~A~@:_~A~:>"
791 (wherestring) hint c))))
792 (funcall sb!xc:*macroexpand-hook* fun form *lexenv*)))))
794 ;;;; conversion utilities
796 ;;; Convert a bunch of forms, discarding all the values except the
797 ;;; last. If there aren't any forms, then translate a NIL.
798 (declaim (ftype (sfunction (ctran ctran (or lvar null) list) (values))
799 ir1-convert-progn-body))
800 (defun ir1-convert-progn-body (start next result body)
801 (if (endp body)
802 (reference-constant start next result nil)
803 (let ((this-start start)
804 (forms body))
805 (loop
806 (let ((form (car forms)))
807 (setf this-start
808 (maybe-instrument-progn-like this-start forms form))
809 (when (endp (cdr forms))
810 (ir1-convert this-start next result form)
811 (return))
812 (let ((this-ctran (make-ctran)))
813 (ir1-convert this-start this-ctran nil form)
814 (setq this-start this-ctran
815 forms (cdr forms)))))))
816 (values))
819 ;;;; code coverage
821 ;;; Check the policy for whether we should generate code coverage
822 ;;; instrumentation. If not, just return the original START
823 ;;; ctran. Otherwise ninsert code coverage instrumentation after
824 ;;; START, and return the new ctran.
825 (defun instrument-coverage (start mode form)
826 ;; We don't actually use FORM for anything, it's just convenient to
827 ;; have around when debugging the instrumentation.
828 (declare (ignore form))
829 (if (and (policy *lexenv* (> store-coverage-data 0))
830 *code-coverage-records*
831 *allow-instrumenting*)
832 (let ((path (source-path-original-source *current-path*)))
833 (when mode
834 (push mode path))
835 (if (member (ctran-block start)
836 (gethash path *code-coverage-blocks*))
837 ;; If this source path has already been instrumented in
838 ;; this block, don't instrument it again.
839 start
840 (let ((store
841 ;; Get an interned record cons for the path. A cons
842 ;; with the same object identity must be used for
843 ;; each instrument for the same block.
844 (or (gethash path *code-coverage-records*)
845 (setf (gethash path *code-coverage-records*)
846 (cons path nil))))
847 (next (make-ctran))
848 (*allow-instrumenting* nil))
849 (push (ctran-block start)
850 (gethash path *code-coverage-blocks*))
851 (let ((*allow-instrumenting* nil))
852 (ir1-convert start next nil
853 `(locally
854 (declare (optimize speed
855 (safety 0)
856 (debug 0)))
857 ;; We're being naughty here, and
858 ;; modifying constant data. That's ok,
859 ;; we know what we're doing.
860 (%rplacd ',store t))))
861 next)))
862 start))
864 ;;; In contexts where we don't have a source location for FORM
865 ;;; e.g. due to it not being a cons, but where we have a source
866 ;;; location for the enclosing cons, use the latter source location if
867 ;;; available. This works pretty well in practice, since many PROGNish
868 ;;; macroexpansions will just directly splice a block of forms into
869 ;;; some enclosing form with `(progn ,@body), thus retaining the
870 ;;; EQness of the conses.
871 (defun maybe-instrument-progn-like (start forms form)
872 (or (when (and *allow-instrumenting*
873 (not (gethash form *source-paths*)))
874 (let ((*current-path* (gethash forms *source-paths*)))
875 (when *current-path*
876 (instrument-coverage start :progn form))))
877 start))
879 (defun record-code-coverage (info cc)
880 (setf (gethash info *code-coverage-info*) cc))
882 (defun clear-code-coverage ()
883 (clrhash *code-coverage-info*))
885 (defun reset-code-coverage ()
886 (maphash (lambda (info cc)
887 (declare (ignore info))
888 (dolist (cc-entry cc)
889 (setf (cdr cc-entry) nil)))
890 *code-coverage-info*))
893 ;;;; converting combinations
895 ;;; Does this form look like something that we should add single-stepping
896 ;;; instrumentation for?
897 (defun step-form-p (form)
898 (flet ((step-symbol-p (symbol)
899 (not (member (symbol-package symbol)
900 (load-time-value
901 ;; KLUDGE: packages we're not interested in
902 ;; stepping.
903 (mapcar #'find-package '(sb!c sb!int sb!impl
904 sb!kernel sb!pcl)))))))
905 (and *allow-instrumenting*
906 (policy *lexenv* (= insert-step-conditions 3))
907 (listp form)
908 (symbolp (car form))
909 (step-symbol-p (car form)))))
911 ;;; Convert a function call where the function FUN is a LEAF. FORM is
912 ;;; the source for the call. We return the COMBINATION node so that
913 ;;; the caller can poke at it if it wants to.
914 (declaim (ftype (sfunction (ctran ctran (or lvar null) list leaf) combination)
915 ir1-convert-combination))
916 (defun ir1-convert-combination (start next result form fun)
917 (let ((ctran (make-ctran))
918 (fun-lvar (make-lvar)))
919 (ir1-convert start ctran fun-lvar `(the (or function symbol) ,fun))
920 (let ((combination
921 (ir1-convert-combination-args fun-lvar ctran next result
922 (cdr form))))
923 (when (step-form-p form)
924 ;; Store a string representation of the form in the
925 ;; combination node. This will let the IR2 translator know
926 ;; that we want stepper instrumentation for this node. The
927 ;; string will be stored in the debug-info by DUMP-1-LOCATION.
928 (setf (combination-step-info combination)
929 (let ((*print-pretty* t)
930 (*print-circle* t)
931 (*print-readably* nil))
932 (prin1-to-string form))))
933 combination)))
935 ;;; Convert the arguments to a call and make the COMBINATION
936 ;;; node. FUN-LVAR yields the function to call. ARGS is the list of
937 ;;; arguments for the call, which defaults to the cdr of source. We
938 ;;; return the COMBINATION node.
939 (defun ir1-convert-combination-args (fun-lvar start next result args)
940 (declare (type ctran start next)
941 (type lvar fun-lvar)
942 (type (or lvar null) result)
943 (list args))
944 (let ((node (make-combination fun-lvar)))
945 (setf (lvar-dest fun-lvar) node)
946 (collect ((arg-lvars))
947 (let ((this-start start)
948 (forms args))
949 (dolist (arg args)
950 (setf this-start
951 (maybe-instrument-progn-like this-start forms arg))
952 (setf forms (cdr forms))
953 (let ((this-ctran (make-ctran))
954 (this-lvar (make-lvar node)))
955 (ir1-convert this-start this-ctran this-lvar arg)
956 (setq this-start this-ctran)
957 (arg-lvars this-lvar)))
958 (link-node-to-previous-ctran node this-start)
959 (use-continuation node next result)
960 (setf (combination-args node) (arg-lvars))))
961 node))
963 ;;; Convert a call to a global function. If not :NOTINLINE, then we do
964 ;;; source transforms and try out any inline expansion. If there is no
965 ;;; expansion, but is :INLINE, then give an efficiency note (unless a
966 ;;; known function which will quite possibly be open-coded.) Next, we
967 ;;; go to ok-combination conversion.
968 (defun ir1-convert-srctran (start next result var form)
969 (declare (type ctran start next) (type (or lvar null) result)
970 (type global-var var))
971 (let ((inlinep (when (defined-fun-p var)
972 (defined-fun-inlinep var))))
973 (if (eq inlinep :notinline)
974 (ir1-convert-combination start next result form var)
975 (let ((transform (info :function
976 :source-transform
977 (leaf-source-name var))))
978 (if transform
979 (multiple-value-bind (transformed pass) (funcall transform form)
980 (if pass
981 (ir1-convert-maybe-predicate start next result form var)
982 (ir1-convert start next result transformed)))
983 (ir1-convert-maybe-predicate start next result form var))))))
985 ;;; KLUDGE: If we insert a synthetic IF for a function with the PREDICATE
986 ;;; attribute, don't generate any branch coverage instrumentation for it.
987 (defvar *instrument-if-for-code-coverage* t)
989 ;;; If the function has the PREDICATE attribute, and the RESULT's DEST
990 ;;; isn't an IF, then we convert (IF <form> T NIL), ensuring that a
991 ;;; predicate always appears in a conditional context.
993 ;;; If the function isn't a predicate, then we call
994 ;;; IR1-CONVERT-COMBINATION-CHECKING-TYPE.
995 (defun ir1-convert-maybe-predicate (start next result form var)
996 (declare (type ctran start next)
997 (type (or lvar null) result)
998 (list form)
999 (type global-var var))
1000 (let ((info (info :function :info (leaf-source-name var))))
1001 (if (and info
1002 (ir1-attributep (fun-info-attributes info) predicate)
1003 (not (if-p (and result (lvar-dest result)))))
1004 (let ((*instrument-if-for-code-coverage* nil))
1005 (ir1-convert start next result `(if ,form t nil)))
1006 (ir1-convert-combination-checking-type start next result form var))))
1008 ;;; Actually really convert a global function call that we are allowed
1009 ;;; to early-bind.
1011 ;;; If we know the function type of the function, then we check the
1012 ;;; call for syntactic legality with respect to the declared function
1013 ;;; type. If it is impossible to determine whether the call is correct
1014 ;;; due to non-constant keywords, then we give up, marking the call as
1015 ;;; :FULL to inhibit further error messages. We return true when the
1016 ;;; call is legal.
1018 ;;; If the call is legal, we also propagate type assertions from the
1019 ;;; function type to the arg and result lvars. We do this now so that
1020 ;;; IR1 optimize doesn't have to redundantly do the check later so
1021 ;;; that it can do the type propagation.
1022 (defun ir1-convert-combination-checking-type (start next result form var)
1023 (declare (type ctran start next) (type (or lvar null) result)
1024 (list form)
1025 (type leaf var))
1026 (let* ((node (ir1-convert-combination start next result form var))
1027 (fun-lvar (basic-combination-fun node))
1028 (type (leaf-type var)))
1029 (when (validate-call-type node type t)
1030 (setf (lvar-%derived-type fun-lvar)
1031 (make-single-value-type type))
1032 (setf (lvar-reoptimize fun-lvar) nil)))
1033 (values))
1035 ;;; Convert a call to a local function, or if the function has already
1036 ;;; been LET converted, then throw FUNCTIONAL to
1037 ;;; LOCALL-ALREADY-LET-CONVERTED. The THROW should only happen when we
1038 ;;; are converting inline expansions for local functions during
1039 ;;; optimization.
1040 (defun ir1-convert-local-combination (start next result form functional)
1041 (assure-functional-live-p functional)
1042 (ir1-convert-combination start next result
1043 form
1044 (maybe-reanalyze-functional functional)))
1046 ;;;; PROCESS-DECLS
1048 ;;; Given a list of LAMBDA-VARs and a variable name, return the
1049 ;;; LAMBDA-VAR for that name, or NIL if it isn't found. We return the
1050 ;;; *last* variable with that name, since LET* bindings may be
1051 ;;; duplicated, and declarations always apply to the last.
1052 (declaim (ftype (sfunction (list symbol) (or lambda-var list))
1053 find-in-bindings))
1054 (defun find-in-bindings (vars name)
1055 (let ((found nil))
1056 (dolist (var vars)
1057 (cond ((leaf-p var)
1058 (when (eq (leaf-source-name var) name)
1059 (setq found var))
1060 (let ((info (lambda-var-arg-info var)))
1061 (when info
1062 (let ((supplied-p (arg-info-supplied-p info)))
1063 (when (and supplied-p
1064 (eq (leaf-source-name supplied-p) name))
1065 (setq found supplied-p))))))
1066 ((and (consp var) (eq (car var) name))
1067 (setf found (cdr var)))))
1068 found))
1070 ;;; Called by PROCESS-DECLS to deal with a variable type declaration.
1071 ;;; If a LAMBDA-VAR being bound, we intersect the type with the var's
1072 ;;; type, otherwise we add a type restriction on the var. If a symbol
1073 ;;; macro, we just wrap a THE around the expansion.
1074 (defun process-type-decl (decl res vars context)
1075 (declare (list decl vars) (type lexenv res))
1076 (let ((type (compiler-specifier-type (first decl))))
1077 (collect ((restr nil cons)
1078 (new-vars nil cons))
1079 (dolist (var-name (rest decl))
1080 (when (boundp var-name)
1081 (program-assert-symbol-home-package-unlocked
1082 context var-name "declaring the type of ~A"))
1083 (let* ((bound-var (find-in-bindings vars var-name))
1084 (var (or bound-var
1085 (lexenv-find var-name vars)
1086 (find-free-var var-name))))
1087 (etypecase var
1088 (leaf
1089 (flet
1090 ((process-var (var bound-var)
1091 (let* ((old-type (or (lexenv-find var type-restrictions)
1092 (leaf-type var)))
1093 (int (if (or (fun-type-p type)
1094 (fun-type-p old-type))
1095 type
1096 (type-approx-intersection2
1097 old-type type))))
1098 (cond ((eq int *empty-type*)
1099 (unless (policy *lexenv* (= inhibit-warnings 3))
1100 (warn
1101 'type-warning
1102 :format-control
1103 "The type declarations ~S and ~S for ~S conflict."
1104 :format-arguments
1105 (list
1106 (type-specifier old-type)
1107 (type-specifier type)
1108 var-name))))
1109 (bound-var (setf (leaf-type bound-var) int))
1111 (restr (cons var int)))))))
1112 (process-var var bound-var)
1113 (awhen (and (lambda-var-p var)
1114 (lambda-var-specvar var))
1115 (process-var it nil))))
1116 (cons
1117 ;; FIXME: non-ANSI weirdness
1118 (aver (eq (car var) 'macro))
1119 (new-vars `(,var-name . (macro . (the ,(first decl)
1120 ,(cdr var))))))
1121 (heap-alien-info
1122 (compiler-error
1123 "~S is an alien variable, so its type can't be declared."
1124 var-name)))))
1126 (if (or (restr) (new-vars))
1127 (make-lexenv :default res
1128 :type-restrictions (restr)
1129 :vars (new-vars))
1130 res))))
1132 ;;; This is somewhat similar to PROCESS-TYPE-DECL, but handles
1133 ;;; declarations for function variables. In addition to allowing
1134 ;;; declarations for functions being bound, we must also deal with
1135 ;;; declarations that constrain the type of lexically apparent
1136 ;;; functions.
1137 (defun process-ftype-decl (spec res names fvars context)
1138 (declare (type list names fvars)
1139 (type lexenv res))
1140 (let ((type (compiler-specifier-type spec)))
1141 (collect ((res nil cons))
1142 (dolist (name names)
1143 (when (fboundp name)
1144 (program-assert-symbol-home-package-unlocked
1145 context name "declaring the ftype of ~A"))
1146 (let ((found (find name fvars :key #'leaf-source-name :test #'equal)))
1147 (cond
1148 (found
1149 (setf (leaf-type found) type)
1150 (assert-definition-type found type
1151 :unwinnage-fun #'compiler-notify
1152 :where "FTYPE declaration"))
1154 (res (cons (find-lexically-apparent-fun
1155 name "in a function type declaration")
1156 type))))))
1157 (if (res)
1158 (make-lexenv :default res :type-restrictions (res))
1159 res))))
1161 ;;; Process a special declaration, returning a new LEXENV. A non-bound
1162 ;;; special declaration is instantiated by throwing a special variable
1163 ;;; into the variables if BINDING-FORM-P is NIL, or otherwise into
1164 ;;; *POST-BINDING-VARIABLE-LEXENV*.
1165 (defun process-special-decl (spec res vars binding-form-p context)
1166 (declare (list spec vars) (type lexenv res))
1167 (collect ((new-venv nil cons))
1168 (dolist (name (cdr spec))
1169 (program-assert-symbol-home-package-unlocked
1170 context name "declaring ~A special")
1171 (let ((var (find-in-bindings vars name)))
1172 (etypecase var
1173 (cons
1174 (aver (eq (car var) 'macro))
1175 (compiler-error
1176 "~S is a symbol-macro and thus can't be declared special."
1177 name))
1178 (lambda-var
1179 (when (lambda-var-ignorep var)
1180 ;; ANSI's definition for "Declaration IGNORE, IGNORABLE"
1181 ;; requires that this be a STYLE-WARNING, not a full WARNING.
1182 (compiler-style-warn
1183 "The ignored variable ~S is being declared special."
1184 name))
1185 (setf (lambda-var-specvar var)
1186 (specvar-for-binding name)))
1187 (null
1188 (unless (or (assoc name (new-venv) :test #'eq))
1189 (new-venv (cons name (specvar-for-binding name))))))))
1190 (cond (binding-form-p
1191 (setf *post-binding-variable-lexenv*
1192 (append (new-venv) *post-binding-variable-lexenv*))
1193 res)
1194 ((new-venv)
1195 (make-lexenv :default res :vars (new-venv)))
1197 res))))
1199 ;;; Return a DEFINED-FUN which copies a GLOBAL-VAR but for its INLINEP
1200 ;;; (and TYPE if notinline), plus type-restrictions from the lexenv.
1201 (defun make-new-inlinep (var inlinep local-type)
1202 (declare (type global-var var) (type inlinep inlinep))
1203 (let* ((type (if (and (eq inlinep :notinline)
1204 (not (eq (leaf-where-from var) :declared)))
1205 (specifier-type 'function)
1206 (leaf-type var)))
1207 (res (make-defined-fun
1208 :%source-name (leaf-source-name var)
1209 :where-from (leaf-where-from var)
1210 :type (if local-type
1211 (type-intersection local-type type)
1212 type)
1213 :inlinep inlinep)))
1214 (when (defined-fun-p var)
1215 (setf (defined-fun-inline-expansion res)
1216 (defined-fun-inline-expansion var))
1217 (setf (defined-fun-functional res)
1218 (defined-fun-functional var)))
1219 ;; FIXME: Is this really right? Needs we not set the FUNCTIONAL
1220 ;; to the original global-var?
1221 res))
1223 ;;; Parse an inline/notinline declaration. If it's a local function we're
1224 ;;; defining, set its INLINEP. If a global function, add a new FENV entry.
1225 (defun process-inline-decl (spec res fvars)
1226 (let ((sense (cdr (assoc (first spec) *inlinep-translations* :test #'eq)))
1227 (new-fenv ()))
1228 (dolist (name (rest spec))
1229 (let ((fvar (find name fvars :key #'leaf-source-name :test #'equal)))
1230 (if fvar
1231 (setf (functional-inlinep fvar) sense)
1232 (let ((found (find-lexically-apparent-fun
1233 name "in an inline or notinline declaration")))
1234 (etypecase found
1235 (functional
1236 (when (policy *lexenv* (>= speed inhibit-warnings))
1237 (compiler-notify "ignoring ~A declaration not at ~
1238 definition of local function:~% ~S"
1239 sense name)))
1240 (global-var
1241 (let ((type
1242 (cdr (assoc found (lexenv-type-restrictions res)))))
1243 (push (cons name (make-new-inlinep found sense type))
1244 new-fenv))))))))
1245 (if new-fenv
1246 (make-lexenv :default res :funs new-fenv)
1247 res)))
1249 ;;; like FIND-IN-BINDINGS, but looks for #'FOO in the FVARS
1250 (defun find-in-bindings-or-fbindings (name vars fvars)
1251 (declare (list vars fvars))
1252 (if (consp name)
1253 (destructuring-bind (wot fn-name) name
1254 (unless (eq wot 'function)
1255 (compiler-error "The function or variable name ~S is unrecognizable."
1256 name))
1257 (find fn-name fvars :key #'leaf-source-name :test #'equal))
1258 (find-in-bindings vars name)))
1260 ;;; Process an ignore/ignorable declaration, checking for various losing
1261 ;;; conditions.
1262 (defun process-ignore-decl (spec vars fvars)
1263 (declare (list spec vars fvars))
1264 (dolist (name (rest spec))
1265 (let ((var (find-in-bindings-or-fbindings name vars fvars)))
1266 (cond
1267 ((not var)
1268 ;; ANSI's definition for "Declaration IGNORE, IGNORABLE"
1269 ;; requires that this be a STYLE-WARNING, not a full WARNING.
1270 (compiler-style-warn "declaring unknown variable ~S to be ignored"
1271 name))
1272 ;; FIXME: This special case looks like non-ANSI weirdness.
1273 ((and (consp var) (eq (car var) 'macro))
1274 ;; Just ignore the IGNORE decl.
1276 ((functional-p var)
1277 (setf (leaf-ever-used var) t))
1278 ((and (lambda-var-specvar var) (eq (first spec) 'ignore))
1279 ;; ANSI's definition for "Declaration IGNORE, IGNORABLE"
1280 ;; requires that this be a STYLE-WARNING, not a full WARNING.
1281 (compiler-style-warn "declaring special variable ~S to be ignored"
1282 name))
1283 ((eq (first spec) 'ignorable)
1284 (setf (leaf-ever-used var) t))
1286 (setf (lambda-var-ignorep var) t)))))
1287 (values))
1289 (defun process-dx-decl (names vars fvars)
1290 (flet ((maybe-notify (control &rest args)
1291 (when (policy *lexenv* (> speed inhibit-warnings))
1292 (apply #'compiler-notify control args))))
1293 (if (policy *lexenv* (= stack-allocate-dynamic-extent 3))
1294 (dolist (name names)
1295 (cond
1296 ((symbolp name)
1297 (let* ((bound-var (find-in-bindings vars name))
1298 (var (or bound-var
1299 (lexenv-find name vars)
1300 (find-free-var name))))
1301 (etypecase var
1302 (leaf
1303 (if bound-var
1304 (setf (leaf-dynamic-extent var) t)
1305 (maybe-notify
1306 "ignoring DYNAMIC-EXTENT declaration for free ~S"
1307 name)))
1308 (cons
1309 (compiler-error "DYNAMIC-EXTENT on symbol-macro: ~S" name))
1310 (heap-alien-info
1311 (compiler-error "DYNAMIC-EXTENT on heap-alien-info: ~S"
1312 name)))))
1313 ((and (consp name)
1314 (eq (car name) 'function)
1315 (null (cddr name))
1316 (valid-function-name-p (cadr name)))
1317 (let* ((fname (cadr name))
1318 (bound-fun (find fname fvars
1319 :key #'leaf-source-name
1320 :test #'equal)))
1321 (etypecase bound-fun
1322 (leaf
1323 #!+stack-allocatable-closures
1324 (setf (leaf-dynamic-extent bound-fun) t)
1325 #!-stack-allocatable-closures
1326 (maybe-notify
1327 "ignoring DYNAMIC-EXTENT declaration on a function ~S ~
1328 (not supported on this platform)." fname))
1329 (cons
1330 (compiler-error "DYNAMIC-EXTENT on macro: ~S" fname))
1331 (null
1332 (maybe-notify
1333 "ignoring DYNAMIC-EXTENT declaration for free ~S"
1334 fname)))))
1335 (t (compiler-error "DYNAMIC-EXTENT on a weird thing: ~S" name))))
1336 (maybe-notify "ignoring DYNAMIC-EXTENT declarations for ~S" names))))
1338 ;;; FIXME: This is non-ANSI, so the default should be T, or it should
1339 ;;; go away, I think.
1340 (defvar *suppress-values-declaration* nil
1341 #!+sb-doc
1342 "If true, processing of the VALUES declaration is inhibited.")
1344 ;;; Process a single declaration spec, augmenting the specified LEXENV
1345 ;;; RES. Return RES and result type. VARS and FVARS are as described
1346 ;;; PROCESS-DECLS.
1347 (defun process-1-decl (raw-spec res vars fvars binding-form-p context)
1348 (declare (type list raw-spec vars fvars))
1349 (declare (type lexenv res))
1350 (let ((spec (canonized-decl-spec raw-spec))
1351 (result-type *wild-type*))
1352 (values
1353 (case (first spec)
1354 (special (process-special-decl spec res vars binding-form-p context))
1355 (ftype
1356 (unless (cdr spec)
1357 (compiler-error "no type specified in FTYPE declaration: ~S" spec))
1358 (process-ftype-decl (second spec) res (cddr spec) fvars context))
1359 ((inline notinline maybe-inline)
1360 (process-inline-decl spec res fvars))
1361 ((ignore ignorable)
1362 (process-ignore-decl spec vars fvars)
1363 res)
1364 (optimize
1365 (make-lexenv
1366 :default res
1367 :policy (process-optimize-decl spec (lexenv-policy res))))
1368 (muffle-conditions
1369 (make-lexenv
1370 :default res
1371 :handled-conditions (process-muffle-conditions-decl
1372 spec (lexenv-handled-conditions res))))
1373 (unmuffle-conditions
1374 (make-lexenv
1375 :default res
1376 :handled-conditions (process-unmuffle-conditions-decl
1377 spec (lexenv-handled-conditions res))))
1378 (type
1379 (process-type-decl (cdr spec) res vars context))
1380 (values
1381 (unless *suppress-values-declaration*
1382 (let ((types (cdr spec)))
1383 (setq result-type
1384 (compiler-values-specifier-type
1385 (if (singleton-p types)
1386 (car types)
1387 `(values ,@types)))))
1388 res))
1389 (dynamic-extent
1390 (process-dx-decl (cdr spec) vars fvars)
1391 res)
1392 ((disable-package-locks enable-package-locks)
1393 (make-lexenv
1394 :default res
1395 :disabled-package-locks (process-package-lock-decl
1396 spec (lexenv-disabled-package-locks res))))
1398 (unless (info :declaration :recognized (first spec))
1399 (compiler-warn "unrecognized declaration ~S" raw-spec))
1400 res))
1401 result-type)))
1403 ;;; Use a list of DECLARE forms to annotate the lists of LAMBDA-VAR
1404 ;;; and FUNCTIONAL structures which are being bound. In addition to
1405 ;;; filling in slots in the leaf structures, we return a new LEXENV,
1406 ;;; which reflects pervasive special and function type declarations,
1407 ;;; (NOT)INLINE declarations and OPTIMIZE declarations, and type of
1408 ;;; VALUES declarations. If BINDING-FORM-P is true, the third return
1409 ;;; value is a list of VARs that should not apply to the lexenv of the
1410 ;;; initialization forms for the bindings, but should apply to the body.
1412 ;;; This is also called in main.lisp when PROCESS-FORM handles a use
1413 ;;; of LOCALLY.
1414 (defun process-decls (decls vars fvars &key
1415 (lexenv *lexenv*) (binding-form-p nil) (context :compile))
1416 (declare (list decls vars fvars))
1417 (let ((result-type *wild-type*)
1418 (*post-binding-variable-lexenv* nil))
1419 (dolist (decl decls)
1420 (dolist (spec (rest decl))
1421 (unless (consp spec)
1422 (compiler-error "malformed declaration specifier ~S in ~S" spec decl))
1423 (multiple-value-bind (new-env new-result-type)
1424 (process-1-decl spec lexenv vars fvars binding-form-p context)
1425 (setq lexenv new-env)
1426 (unless (eq new-result-type *wild-type*)
1427 (setq result-type
1428 (values-type-intersection result-type new-result-type))))))
1429 (values lexenv result-type *post-binding-variable-lexenv*)))
1431 (defun %processing-decls (decls vars fvars ctran lvar binding-form-p fun)
1432 (multiple-value-bind (*lexenv* result-type post-binding-lexenv)
1433 (process-decls decls vars fvars :binding-form-p binding-form-p)
1434 (cond ((eq result-type *wild-type*)
1435 (funcall fun ctran lvar post-binding-lexenv))
1437 (let ((value-ctran (make-ctran))
1438 (value-lvar (make-lvar)))
1439 (multiple-value-prog1
1440 (funcall fun value-ctran value-lvar post-binding-lexenv)
1441 (let ((cast (make-cast value-lvar result-type
1442 (lexenv-policy *lexenv*))))
1443 (link-node-to-previous-ctran cast value-ctran)
1444 (setf (lvar-dest value-lvar) cast)
1445 (use-continuation cast ctran lvar))))))))
1446 (defmacro processing-decls ((decls vars fvars ctran lvar
1447 &optional post-binding-lexenv)
1448 &body forms)
1449 (check-type ctran symbol)
1450 (check-type lvar symbol)
1451 (let ((post-binding-lexenv-p (not (null post-binding-lexenv)))
1452 (post-binding-lexenv (or post-binding-lexenv (gensym))))
1453 `(%processing-decls ,decls ,vars ,fvars ,ctran ,lvar
1454 ,post-binding-lexenv-p
1455 (lambda (,ctran ,lvar ,post-binding-lexenv)
1456 (declare (ignorable ,post-binding-lexenv))
1457 ,@forms))))
1459 ;;; Return the SPECVAR for NAME to use when we see a local SPECIAL
1460 ;;; declaration. If there is a global variable of that name, then
1461 ;;; check that it isn't a constant and return it. Otherwise, create an
1462 ;;; anonymous GLOBAL-VAR.
1463 (defun specvar-for-binding (name)
1464 (cond ((not (eq (info :variable :where-from name) :assumed))
1465 (let ((found (find-free-var name)))
1466 (when (heap-alien-info-p found)
1467 (compiler-error
1468 "~S is an alien variable and so can't be declared special."
1469 name))
1470 (unless (global-var-p found)
1471 (compiler-error
1472 "~S is a constant and so can't be declared special."
1473 name))
1474 found))
1476 (make-global-var :kind :special
1477 :%source-name name
1478 :where-from :declared))))