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