1.0.3.13: working NaN comparison tests outside Darwin
[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 ;;; *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*)
25
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*)
39
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*)
44
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.")
51
52 (defvar *fun-names-in-this-file* nil)
53
54 (defvar *post-binding-variable-lexenv* nil)
55 \f
56 ;;;; namespace management utilities
57
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))))
64
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)))
97
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.
102 ;;;
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)
122                   (or
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.)
127                    ;;
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)))))))
140
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))))))))
176
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)
187           (t
188            (find-free-fun name context)))))
189
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)))
224                 (t
225                  (make-global-var :kind kind
226                                   :%source-name name
227                                   :type type
228                                   :where-from where-from)))))))
229 \f
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)))))
303                    (t
304                     (compiler-error
305                      "Objects of type ~S can't be dumped into fasl files."
306                      (type-of value)))))))
307       (grovel constant)))
308   (values))
309 \f
310 ;;;; some flow-graph hacking utilities
311
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))
319
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))))
348
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)))
361           (t
362            (aver (neq node (lvar-uses lvar)))
363            (setf (lvar-uses lvar) (list node (lvar-uses lvar)))))
364     (reoptimize-lvar lvar)))
365
366 #!-sb-fluid(declaim (inline use-continuation))
367 (defun use-continuation (node ctran lvar)
368   (use-ctran node ctran)
369   (use-lvar node lvar))
370 \f
371 ;;;; exported functions
372
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.
380 ;;;
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.
386 ;;;
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.
392 ;;;
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)
397   (declare (list path))
398   (let* ((*current-path* path)
399          (component (make-empty-component))
400          (*current-component* component)
401          (*allow-instrumenting* t))
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)))
412
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*)
419
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.
424 ;;;
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                         (when (consp fm)
446                           (sub-find-source-paths fm (cons pos path)))
447                         (incf pos))
448                       (setq subform (cdr subform))
449                       (when (eq subform trail) (return)))))
450         (loop
451           (frob)
452           (frob)
453           (setq trail (cdr trail)))))))
454 \f
455 ;;;; IR1-CONVERT, macroexpansion and special form dispatching
456
457 (declaim (ftype (sfunction (ctran ctran (or lvar null) t) (values))
458                 ir1-convert))
459 (macrolet (;; Bind *COMPILER-ERROR-BAILOUT* to a function that throws
460            ;; out of the body and converts a condition signalling form
461            ;; instead. The source form is converted to a string since it
462            ;; may contain arbitrary non-externalizable objects.
463            (ir1-error-bailout ((start next result form) &body body)
464              (with-unique-names (skip condition)
465                `(block ,skip
466                  (let ((,condition (catch 'ir1-error-abort
467                                      (let ((*compiler-error-bailout*
468                                             (lambda (&optional e)
469                                               (throw 'ir1-error-abort e))))
470                                        ,@body
471                                        (return-from ,skip nil)))))
472                    (ir1-convert ,start ,next ,result
473                                 (make-compiler-error-form ,condition
474                                                           ,form)))))))
475
476   ;; Translate FORM into IR1. The code is inserted as the NEXT of the
477   ;; CTRAN START. RESULT is the LVAR which receives the value of the
478   ;; FORM to be translated. The translators call this function
479   ;; recursively to translate their subnodes.
480   ;;
481   ;; As a special hack to make life easier in the compiler, a LEAF
482   ;; IR1-converts into a reference to that LEAF structure. This allows
483   ;; the creation using backquote of forms that contain leaf
484   ;; references, without having to introduce dummy names into the
485   ;; namespace.
486   (defun ir1-convert (start next result form)
487     (ir1-error-bailout (start next result form)
488       (let ((*current-path* (or (gethash form *source-paths*)
489                                 (cons form *current-path*))))
490         (cond ((atom form)
491                (cond ((and (symbolp form) (not (keywordp form)))
492                       (ir1-convert-var start next result form))
493                      ((leaf-p form)
494                       (reference-leaf start next result form))
495                      (t
496                       (reference-constant start next result form))))
497               (t
498                (ir1-convert-functoid start next result form)))))
499     (values))
500
501   ;; Generate a reference to a manifest constant, creating a new leaf
502   ;; if necessary. If we are producing a fasl file, make sure that
503   ;; MAKE-LOAD-FORM gets used on any parts of the constant that it
504   ;; needs to be.
505   (defun reference-constant (start next result value)
506     (declare (type ctran start next)
507              (type (or lvar null) result)
508              (inline find-constant))
509     (ir1-error-bailout (start next result value)
510      (when (producing-fasl-file)
511        (maybe-emit-make-load-forms value))
512      (let* ((leaf (find-constant value))
513             (res (make-ref leaf)))
514        (push res (leaf-refs leaf))
515        (link-node-to-previous-ctran res start)
516        (use-continuation res next result)))
517     (values)))
518
519 ;;; Add FUNCTIONAL to the COMPONENT-REANALYZE-FUNCTIONALS, unless it's
520 ;;; some trivial type for which reanalysis is a trivial no-op, or
521 ;;; unless it doesn't belong in this component at all.
522 ;;;
523 ;;; FUNCTIONAL is returned.
524 (defun maybe-reanalyze-functional (functional)
525
526   (aver (not (eql (functional-kind functional) :deleted))) ; bug 148
527   (aver-live-component *current-component*)
528
529   ;; When FUNCTIONAL is of a type for which reanalysis isn't a trivial
530   ;; no-op
531   (when (typep functional '(or optional-dispatch clambda))
532
533     ;; When FUNCTIONAL knows its component
534     (when (lambda-p functional)
535       (aver (eql (lambda-component functional) *current-component*)))
536
537     (pushnew functional
538              (component-reanalyze-functionals *current-component*)))
539
540   functional)
541
542 ;;; Generate a REF node for LEAF, frobbing the LEAF structure as
543 ;;; needed. If LEAF represents a defined function which has already
544 ;;; been converted, and is not :NOTINLINE, then reference the
545 ;;; functional instead.
546 (defun reference-leaf (start next result leaf)
547   (declare (type ctran start next) (type (or lvar null) result) (type leaf leaf))
548   (when (functional-p leaf)
549     (assure-functional-live-p leaf))
550   (let* ((type (lexenv-find leaf type-restrictions))
551          (leaf (or (and (defined-fun-p leaf)
552                         (not (eq (defined-fun-inlinep leaf)
553                                  :notinline))
554                         (let ((functional (defined-fun-functional leaf)))
555                           (when (and functional
556                                      (not (functional-kind functional))
557                                      ;; Bug MISC.320: ir1-transform
558                                      ;; can create a reference to a
559                                      ;; inline-expanded function,
560                                      ;; defined in another component.
561                                      (not (and (lambda-p functional)
562                                                (neq (lambda-component functional)
563                                                     *current-component*))))
564                             (maybe-reanalyze-functional functional))))
565                    (when (and (lambda-p leaf)
566                               (memq (functional-kind leaf)
567                                     '(nil :optional)))
568                      (maybe-reanalyze-functional leaf))
569                    leaf))
570          (ref (make-ref leaf)))
571     (push ref (leaf-refs leaf))
572     (setf (leaf-ever-used leaf) t)
573     (link-node-to-previous-ctran ref start)
574     (cond (type (let* ((ref-ctran (make-ctran))
575                        (ref-lvar (make-lvar))
576                        (cast (make-cast ref-lvar
577                                         (make-single-value-type type)
578                                         (lexenv-policy *lexenv*))))
579                   (setf (lvar-dest ref-lvar) cast)
580                   (use-continuation ref ref-ctran ref-lvar)
581                   (link-node-to-previous-ctran cast ref-ctran)
582                   (use-continuation cast next result)))
583           (t (use-continuation ref next result)))))
584
585 ;;; Convert a reference to a symbolic constant or variable. If the
586 ;;; symbol is entered in the LEXENV-VARS we use that definition,
587 ;;; otherwise we find the current global definition. This is also
588 ;;; where we pick off symbol macro and alien variable references.
589 (defun ir1-convert-var (start next result name)
590   (declare (type ctran start next) (type (or lvar null) result) (symbol name))
591   (let ((var (or (lexenv-find name vars) (find-free-var name))))
592     (etypecase var
593       (leaf
594        (when (lambda-var-p var)
595          (let ((home (ctran-home-lambda-or-null start)))
596            (when home
597              (sset-adjoin var (lambda-calls-or-closes home))))
598          (when (lambda-var-ignorep var)
599            ;; (ANSI's specification for the IGNORE declaration requires
600            ;; that this be a STYLE-WARNING, not a full WARNING.)
601            #-sb-xc-host
602            (compiler-style-warn "reading an ignored variable: ~S" name)
603            ;; there's no need for us to accept ANSI's lameness when
604            ;; processing our own code, though.
605            #+sb-xc-host
606            (warn "reading an ignored variable: ~S" name)))
607        (reference-leaf start next result var))
608       (cons
609        (aver (eq (car var) 'macro))
610        ;; FIXME: [Free] type declarations. -- APD, 2002-01-26
611        (ir1-convert start next result (cdr var)))
612       (heap-alien-info
613        (ir1-convert start next result `(%heap-alien ',var)))))
614   (values))
615
616 ;;; Find a compiler-macro for a form, taking FUNCALL into account.
617 (defun find-compiler-macro (opname form)
618   (if (eq opname 'funcall)
619       (let ((fun-form (cadr form)))
620         (cond ((and (consp fun-form) (eq 'function (car fun-form)))
621                (let ((real-fun (cadr fun-form)))
622                  (if (legal-fun-name-p real-fun)
623                      (values (sb!xc:compiler-macro-function real-fun *lexenv*)
624                              real-fun)
625                      (values nil nil))))
626               ((sb!xc:constantp fun-form *lexenv*)
627                (let ((fun (constant-form-value fun-form *lexenv*)))
628                  (if (legal-fun-name-p fun)
629                      ;; CLHS tells us that local functions must shadow
630                      ;; compiler-macro-functions, but since the call is
631                      ;; through a name, we are obviously interested
632                      ;; in the global function.
633                      (values (sb!xc:compiler-macro-function fun nil) fun)
634                      (values nil nil))))
635               (t
636                (values nil nil))))
637       (if (legal-fun-name-p opname)
638           (values (sb!xc:compiler-macro-function opname *lexenv*) opname)
639           (values nil nil))))
640
641 ;;; Picks of special forms and compiler-macro expansions, and hands
642 ;;; the rest to IR1-CONVERT-COMMON-FUNCTOID
643 (defun ir1-convert-functoid (start next result form)
644   (let* ((op (car form))
645          (translator (and (symbolp op) (info :function :ir1-convert op))))
646     (cond (translator
647            (when (sb!xc:compiler-macro-function op *lexenv*)
648              (compiler-warn "ignoring compiler macro for special form"))
649            (funcall translator start next result form))
650           (t
651            (multiple-value-bind (cmacro-fun cmacro-fun-name)
652                (find-compiler-macro op form)
653              (if (and cmacro-fun
654                       ;; CLHS 3.2.2.1.3 specifies that NOTINLINE
655                       ;; suppresses compiler-macros.
656                       (not (fun-lexically-notinline-p cmacro-fun-name)))
657                  (let ((res (careful-expand-macro cmacro-fun form)))
658                    (if (eq res form)
659                        (ir1-convert-common-functoid start next result form
660                                                     op)
661                        (ir1-convert start next result res)))
662                  (ir1-convert-common-functoid start next result form op)))))))
663
664 ;;; Handles the "common" cases: any other forms except special forms
665 ;;; and compiler-macros.
666 (defun ir1-convert-common-functoid (start next result form op)
667   (cond ((or (symbolp op) (leaf-p op))
668          (let ((lexical-def (if (leaf-p op) op (lexenv-find op funs))))
669            (typecase lexical-def
670              (null
671               (ir1-convert-global-functoid start next result form op))
672              (functional
673               (ir1-convert-local-combination start next result form
674                                              lexical-def))
675              (global-var
676               (ir1-convert-srctran start next result lexical-def form))
677              (t
678               (aver (and (consp lexical-def) (eq (car lexical-def) 'macro)))
679               (ir1-convert start next result
680                            (careful-expand-macro (cdr lexical-def) form))))))
681         ((or (atom op) (not (eq (car op) 'lambda)))
682          (compiler-error "illegal function call"))
683         (t
684          ;; implicitly (LAMBDA ..) because the LAMBDA expression is
685          ;; the CAR of an executed form.
686          (ir1-convert-combination
687           start next result form
688           (ir1-convert-lambda op
689                               :debug-name (debug-name 'inline-lambda op))))))
690
691 ;;; Convert anything that looks like a global function call.
692 (defun ir1-convert-global-functoid (start next result form fun)
693   (declare (type ctran start next) (type (or lvar null) result)
694            (list form))
695   ;; FIXME: Couldn't all the INFO calls here be converted into
696   ;; standard CL functions, like MACRO-FUNCTION or something? And what
697   ;; happens with lexically-defined (MACROLET) macros here, anyway?
698   (ecase (info :function :kind fun)
699     (:macro
700      (ir1-convert start next result
701                   (careful-expand-macro (info :function :macro-function fun)
702                                         form))
703      (unless (policy *lexenv* (zerop store-xref-data))
704        (record-macroexpansion fun (ctran-block start) *current-path*)))
705     ((nil :function)
706      (ir1-convert-srctran start next result
707                           (find-free-fun fun "shouldn't happen! (no-cmacro)")
708                           form))))
709
710 (defun muffle-warning-or-die ()
711   (muffle-warning)
712   (bug "no MUFFLE-WARNING restart"))
713
714 ;;; Expand FORM using the macro whose MACRO-FUNCTION is FUN, trapping
715 ;;; errors which occur during the macroexpansion.
716 (defun careful-expand-macro (fun form)
717   (let (;; a hint I (WHN) wish I'd known earlier
718         (hint "(hint: For more precise location, try *BREAK-ON-SIGNALS*.)"))
719     (flet (;; Return a string to use as a prefix in error reporting,
720            ;; telling something about which form caused the problem.
721            (wherestring ()
722              (let ((*print-pretty* nil)
723                    ;; We rely on the printer to abbreviate FORM.
724                    (*print-length* 3)
725                    (*print-level* 1))
726                (format
727                 nil
728                 #-sb-xc-host "(in macroexpansion of ~S)"
729                 ;; longer message to avoid ambiguity "Was it the xc host
730                 ;; or the cross-compiler which encountered the problem?"
731                 #+sb-xc-host "(in cross-compiler macroexpansion of ~S)"
732                 form))))
733       (handler-bind ((style-warning (lambda (c)
734                                       (compiler-style-warn
735                                        "~@<~A~:@_~A~@:_~A~:>"
736                                        (wherestring) hint c)
737                                       (muffle-warning-or-die)))
738                      ;; KLUDGE: CMU CL in its wisdom (version 2.4.6 for
739                      ;; Debian Linux, anyway) raises a CL:WARNING
740                      ;; condition (not a CL:STYLE-WARNING) for undefined
741                      ;; symbols when converting interpreted functions,
742                      ;; causing COMPILE-FILE to think the file has a real
743                      ;; problem, causing COMPILE-FILE to return FAILURE-P
744                      ;; set (not just WARNINGS-P set). Since undefined
745                      ;; symbol warnings are often harmless forward
746                      ;; references, and since it'd be inordinately painful
747                      ;; to try to eliminate all such forward references,
748                      ;; these warnings are basically unavoidable. Thus, we
749                      ;; need to coerce the system to work through them,
750                      ;; and this code does so, by crudely suppressing all
751                      ;; warnings in cross-compilation macroexpansion. --
752                      ;; WHN 19990412
753                      #+(and cmu sb-xc-host)
754                      (warning (lambda (c)
755                                 (compiler-notify
756                                  "~@<~A~:@_~
757                                   ~A~:@_~
758                                   ~@<(KLUDGE: That was a non-STYLE WARNING. ~
759                                   Ordinarily that would cause compilation to ~
760                                   fail. However, since we're running under ~
761                                   CMU CL, and since CMU CL emits non-STYLE ~
762                                   warnings for safe, hard-to-fix things (e.g. ~
763                                   references to not-yet-defined functions) ~
764                                   we're going to have to ignore it and ~
765                                   proceed anyway. Hopefully we're not ~
766                                   ignoring anything  horrible here..)~:@>~:>"
767                                  (wherestring)
768                                  c)
769                                 (muffle-warning-or-die)))
770                      #-(and cmu sb-xc-host)
771                      (warning (lambda (c)
772                                 (warn "~@<~A~:@_~A~@:_~A~:>"
773                                       (wherestring) hint c)
774                                 (muffle-warning-or-die)))
775                      (error (lambda (c)
776                               (compiler-error "~@<~A~:@_~A~@:_~A~:>"
777                                               (wherestring) hint c))))
778         (funcall sb!xc:*macroexpand-hook* fun form *lexenv*)))))
779 \f
780 ;;;; conversion utilities
781
782 ;;; Convert a bunch of forms, discarding all the values except the
783 ;;; last. If there aren't any forms, then translate a NIL.
784 (declaim (ftype (sfunction (ctran ctran (or lvar null) list) (values))
785                 ir1-convert-progn-body))
786 (defun ir1-convert-progn-body (start next result body)
787   (if (endp body)
788       (reference-constant start next result nil)
789       (let ((this-start start)
790             (forms body))
791         (loop
792           (let ((form (car forms)))
793             (when (endp (cdr forms))
794               (ir1-convert this-start next result form)
795               (return))
796             (let ((this-ctran (make-ctran)))
797               (ir1-convert this-start this-ctran nil form)
798               (setq this-start this-ctran
799                     forms (cdr forms)))))))
800   (values))
801 \f
802 ;;;; converting combinations
803
804 ;;; Does this form look like something that we should add single-stepping
805 ;;; instrumentation for?
806 (defun step-form-p (form)
807   (flet ((step-symbol-p (symbol)
808            (not (member (symbol-package symbol)
809                         (load-time-value
810                          ;; KLUDGE: packages we're not interested in
811                          ;; stepping.
812                          (mapcar #'find-package '(sb!c sb!int sb!impl
813                                                   sb!kernel sb!pcl)))))))
814     (and *allow-instrumenting*
815          (policy *lexenv* (= insert-step-conditions 3))
816          (listp form)
817          (symbolp (car form))
818          (step-symbol-p (car form)))))
819
820 ;;; Convert a function call where the function FUN is a LEAF. FORM is
821 ;;; the source for the call. We return the COMBINATION node so that
822 ;;; the caller can poke at it if it wants to.
823 (declaim (ftype (sfunction (ctran ctran (or lvar null) list leaf) combination)
824                 ir1-convert-combination))
825 (defun ir1-convert-combination (start next result form fun)
826   (let ((ctran (make-ctran))
827         (fun-lvar (make-lvar)))
828     (ir1-convert start ctran fun-lvar `(the (or function symbol) ,fun))
829     (let ((combination
830            (ir1-convert-combination-args fun-lvar ctran next result
831                                          (cdr form))))
832       (when (step-form-p form)
833         ;; Store a string representation of the form in the
834         ;; combination node. This will let the IR2 translator know
835         ;; that we want stepper instrumentation for this node. The
836         ;; string will be stored in the debug-info by DUMP-1-LOCATION.
837         (setf (combination-step-info combination)
838               (let ((*print-pretty* t)
839                     (*print-circle* t)
840                     (*print-readably* nil))
841                 (prin1-to-string form))))
842       combination)))
843
844 ;;; Convert the arguments to a call and make the COMBINATION
845 ;;; node. FUN-LVAR yields the function to call. ARGS is the list of
846 ;;; arguments for the call, which defaults to the cdr of source. We
847 ;;; return the COMBINATION node.
848 (defun ir1-convert-combination-args (fun-lvar start next result args)
849   (declare (type ctran start next)
850            (type lvar fun-lvar)
851            (type (or lvar null) result)
852            (list args))
853   (let ((node (make-combination fun-lvar)))
854     (setf (lvar-dest fun-lvar) node)
855     (collect ((arg-lvars))
856       (let ((this-start start))
857         (dolist (arg args)
858           (let ((this-ctran (make-ctran))
859                 (this-lvar (make-lvar node)))
860             (ir1-convert this-start this-ctran this-lvar arg)
861             (setq this-start this-ctran)
862             (arg-lvars this-lvar)))
863         (link-node-to-previous-ctran node this-start)
864         (use-continuation node next result)
865         (setf (combination-args node) (arg-lvars))))
866     node))
867
868 ;;; Convert a call to a global function. If not :NOTINLINE, then we do
869 ;;; source transforms and try out any inline expansion. If there is no
870 ;;; expansion, but is :INLINE, then give an efficiency note (unless a
871 ;;; known function which will quite possibly be open-coded.) Next, we
872 ;;; go to ok-combination conversion.
873 (defun ir1-convert-srctran (start next result var form)
874   (declare (type ctran start next) (type (or lvar null) result)
875            (type global-var var))
876   (let ((inlinep (when (defined-fun-p var)
877                    (defined-fun-inlinep var))))
878     (if (eq inlinep :notinline)
879         (ir1-convert-combination start next result form var)
880         (let ((transform (info :function
881                                :source-transform
882                                (leaf-source-name var))))
883           (if transform
884               (multiple-value-bind (transformed pass) (funcall transform form)
885                 (if pass
886                     (ir1-convert-maybe-predicate start next result form var)
887                     (ir1-convert start next result transformed)))
888               (ir1-convert-maybe-predicate start next result form var))))))
889
890 ;;; If the function has the PREDICATE attribute, and the RESULT's DEST
891 ;;; isn't an IF, then we convert (IF <form> T NIL), ensuring that a
892 ;;; predicate always appears in a conditional context.
893 ;;;
894 ;;; If the function isn't a predicate, then we call
895 ;;; IR1-CONVERT-COMBINATION-CHECKING-TYPE.
896 (defun ir1-convert-maybe-predicate (start next result form var)
897   (declare (type ctran start next)
898            (type (or lvar null) result)
899            (list form)
900            (type global-var var))
901   (let ((info (info :function :info (leaf-source-name var))))
902     (if (and info
903              (ir1-attributep (fun-info-attributes info) predicate)
904              (not (if-p (and result (lvar-dest result)))))
905         (ir1-convert start next result `(if ,form t nil))
906         (ir1-convert-combination-checking-type start next result form var))))
907
908 ;;; Actually really convert a global function call that we are allowed
909 ;;; to early-bind.
910 ;;;
911 ;;; If we know the function type of the function, then we check the
912 ;;; call for syntactic legality with respect to the declared function
913 ;;; type. If it is impossible to determine whether the call is correct
914 ;;; due to non-constant keywords, then we give up, marking the call as
915 ;;; :FULL to inhibit further error messages. We return true when the
916 ;;; call is legal.
917 ;;;
918 ;;; If the call is legal, we also propagate type assertions from the
919 ;;; function type to the arg and result lvars. We do this now so that
920 ;;; IR1 optimize doesn't have to redundantly do the check later so
921 ;;; that it can do the type propagation.
922 (defun ir1-convert-combination-checking-type (start next result form var)
923   (declare (type ctran start next) (type (or lvar null) result)
924            (list form)
925            (type leaf var))
926   (let* ((node (ir1-convert-combination start next result form var))
927          (fun-lvar (basic-combination-fun node))
928          (type (leaf-type var)))
929     (when (validate-call-type node type t)
930       (setf (lvar-%derived-type fun-lvar)
931             (make-single-value-type type))
932       (setf (lvar-reoptimize fun-lvar) nil)))
933   (values))
934
935 ;;; Convert a call to a local function, or if the function has already
936 ;;; been LET converted, then throw FUNCTIONAL to
937 ;;; LOCALL-ALREADY-LET-CONVERTED. The THROW should only happen when we
938 ;;; are converting inline expansions for local functions during
939 ;;; optimization.
940 (defun ir1-convert-local-combination (start next result form functional)
941   (assure-functional-live-p functional)
942   (ir1-convert-combination start next result
943                            form
944                            (maybe-reanalyze-functional functional)))
945 \f
946 ;;;; PROCESS-DECLS
947
948 ;;; Given a list of LAMBDA-VARs and a variable name, return the
949 ;;; LAMBDA-VAR for that name, or NIL if it isn't found. We return the
950 ;;; *last* variable with that name, since LET* bindings may be
951 ;;; duplicated, and declarations always apply to the last.
952 (declaim (ftype (sfunction (list symbol) (or lambda-var list))
953                 find-in-bindings))
954 (defun find-in-bindings (vars name)
955   (let ((found nil))
956     (dolist (var vars)
957       (cond ((leaf-p var)
958              (when (eq (leaf-source-name var) name)
959                (setq found var))
960              (let ((info (lambda-var-arg-info var)))
961                (when info
962                  (let ((supplied-p (arg-info-supplied-p info)))
963                    (when (and supplied-p
964                               (eq (leaf-source-name supplied-p) name))
965                      (setq found supplied-p))))))
966             ((and (consp var) (eq (car var) name))
967              (setf found (cdr var)))))
968     found))
969
970 ;;; Called by PROCESS-DECLS to deal with a variable type declaration.
971 ;;; If a LAMBDA-VAR being bound, we intersect the type with the var's
972 ;;; type, otherwise we add a type restriction on the var. If a symbol
973 ;;; macro, we just wrap a THE around the expansion.
974 (defun process-type-decl (decl res vars context)
975   (declare (list decl vars) (type lexenv res))
976   (let ((type (compiler-specifier-type (first decl))))
977     (collect ((restr nil cons)
978              (new-vars nil cons))
979       (dolist (var-name (rest decl))
980         (when (boundp var-name)
981           (program-assert-symbol-home-package-unlocked
982            context var-name "declaring the type of ~A"))
983         (let* ((bound-var (find-in-bindings vars var-name))
984                (var (or bound-var
985                         (lexenv-find var-name vars)
986                         (find-free-var var-name))))
987           (etypecase var
988             (leaf
989              (flet
990                  ((process-var (var bound-var)
991                     (let* ((old-type (or (lexenv-find var type-restrictions)
992                                          (leaf-type var)))
993                            (int (if (or (fun-type-p type)
994                                         (fun-type-p old-type))
995                                     type
996                                     (type-approx-intersection2
997                                      old-type type))))
998                       (cond ((eq int *empty-type*)
999                              (unless (policy *lexenv* (= inhibit-warnings 3))
1000                                (warn
1001                                 'type-warning
1002                                 :format-control
1003                                 "The type declarations ~S and ~S for ~S conflict."
1004                                 :format-arguments
1005                                 (list
1006                                  (type-specifier old-type)
1007                                  (type-specifier type)
1008                                  var-name))))
1009                             (bound-var (setf (leaf-type bound-var) int))
1010                             (t
1011                              (restr (cons var int)))))))
1012                (process-var var bound-var)
1013                (awhen (and (lambda-var-p var)
1014                            (lambda-var-specvar var))
1015                       (process-var it nil))))
1016             (cons
1017              ;; FIXME: non-ANSI weirdness
1018              (aver (eq (car var) 'macro))
1019              (new-vars `(,var-name . (macro . (the ,(first decl)
1020                                                 ,(cdr var))))))
1021             (heap-alien-info
1022              (compiler-error
1023               "~S is an alien variable, so its type can't be declared."
1024               var-name)))))
1025
1026       (if (or (restr) (new-vars))
1027           (make-lexenv :default res
1028                        :type-restrictions (restr)
1029                        :vars (new-vars))
1030           res))))
1031
1032 ;;; This is somewhat similar to PROCESS-TYPE-DECL, but handles
1033 ;;; declarations for function variables. In addition to allowing
1034 ;;; declarations for functions being bound, we must also deal with
1035 ;;; declarations that constrain the type of lexically apparent
1036 ;;; functions.
1037 (defun process-ftype-decl (spec res names fvars context)
1038   (declare (type list names fvars)
1039            (type lexenv res))
1040   (let ((type (compiler-specifier-type spec)))
1041     (collect ((res nil cons))
1042       (dolist (name names)
1043         (when (fboundp name)
1044           (program-assert-symbol-home-package-unlocked
1045            context name "declaring the ftype of ~A"))
1046         (let ((found (find name fvars :key #'leaf-source-name :test #'equal)))
1047           (cond
1048            (found
1049             (setf (leaf-type found) type)
1050             (assert-definition-type found type
1051                                     :unwinnage-fun #'compiler-notify
1052                                     :where "FTYPE declaration"))
1053            (t
1054             (res (cons (find-lexically-apparent-fun
1055                         name "in a function type declaration")
1056                        type))))))
1057       (if (res)
1058           (make-lexenv :default res :type-restrictions (res))
1059           res))))
1060
1061 ;;; Process a special declaration, returning a new LEXENV. A non-bound
1062 ;;; special declaration is instantiated by throwing a special variable
1063 ;;; into the variables if BINDING-FORM-P is NIL, or otherwise into
1064 ;;; *POST-BINDING-VARIABLE-LEXENV*.
1065 (defun process-special-decl (spec res vars binding-form-p context)
1066   (declare (list spec vars) (type lexenv res))
1067   (collect ((new-venv nil cons))
1068     (dolist (name (cdr spec))
1069       (program-assert-symbol-home-package-unlocked
1070        context name "declaring ~A special")
1071       (let ((var (find-in-bindings vars name)))
1072         (etypecase var
1073           (cons
1074            (aver (eq (car var) 'macro))
1075            (compiler-error
1076             "~S is a symbol-macro and thus can't be declared special."
1077             name))
1078           (lambda-var
1079            (when (lambda-var-ignorep var)
1080              ;; ANSI's definition for "Declaration IGNORE, IGNORABLE"
1081              ;; requires that this be a STYLE-WARNING, not a full WARNING.
1082              (compiler-style-warn
1083               "The ignored variable ~S is being declared special."
1084               name))
1085            (setf (lambda-var-specvar var)
1086                  (specvar-for-binding name)))
1087           (null
1088            (unless (or (assoc name (new-venv) :test #'eq))
1089              (new-venv (cons name (specvar-for-binding name))))))))
1090     (cond (binding-form-p
1091            (setf *post-binding-variable-lexenv*
1092                  (append (new-venv) *post-binding-variable-lexenv*))
1093            res)
1094           ((new-venv)
1095            (make-lexenv :default res :vars (new-venv)))
1096           (t
1097            res))))
1098
1099 ;;; Return a DEFINED-FUN which copies a GLOBAL-VAR but for its INLINEP
1100 ;;; (and TYPE if notinline), plus type-restrictions from the lexenv.
1101 (defun make-new-inlinep (var inlinep local-type)
1102   (declare (type global-var var) (type inlinep inlinep))
1103   (let* ((type (if (and (eq inlinep :notinline)
1104                         (not (eq (leaf-where-from var) :declared)))
1105                    (specifier-type 'function)
1106                    (leaf-type var)))
1107          (res (make-defined-fun
1108                :%source-name (leaf-source-name var)
1109                :where-from (leaf-where-from var)
1110                :type (if local-type
1111                          (type-intersection local-type type)
1112                          type)
1113                :inlinep inlinep)))
1114     (when (defined-fun-p var)
1115       (setf (defined-fun-inline-expansion res)
1116             (defined-fun-inline-expansion var))
1117       (setf (defined-fun-functional res)
1118             (defined-fun-functional var)))
1119     ;; FIXME: Is this really right? Needs we not set the FUNCTIONAL
1120     ;; to the original global-var?
1121     res))
1122
1123 ;;; Parse an inline/notinline declaration. If it's a local function we're
1124 ;;; defining, set its INLINEP. If a global function, add a new FENV entry.
1125 (defun process-inline-decl (spec res fvars)
1126   (let ((sense (cdr (assoc (first spec) *inlinep-translations* :test #'eq)))
1127         (new-fenv ()))
1128     (dolist (name (rest spec))
1129       (let ((fvar (find name fvars :key #'leaf-source-name :test #'equal)))
1130         (if fvar
1131             (setf (functional-inlinep fvar) sense)
1132             (let ((found (find-lexically-apparent-fun
1133                           name "in an inline or notinline declaration")))
1134               (etypecase found
1135                 (functional
1136                  (when (policy *lexenv* (>= speed inhibit-warnings))
1137                    (compiler-notify "ignoring ~A declaration not at ~
1138                                      definition of local function:~%  ~S"
1139                                     sense name)))
1140                 (global-var
1141                  (let ((type
1142                         (cdr (assoc found (lexenv-type-restrictions res)))))
1143                    (push (cons name (make-new-inlinep found sense type))
1144                          new-fenv))))))))
1145     (if new-fenv
1146         (make-lexenv :default res :funs new-fenv)
1147         res)))
1148
1149 ;;; like FIND-IN-BINDINGS, but looks for #'FOO in the FVARS
1150 (defun find-in-bindings-or-fbindings (name vars fvars)
1151   (declare (list vars fvars))
1152   (if (consp name)
1153       (destructuring-bind (wot fn-name) name
1154         (unless (eq wot 'function)
1155           (compiler-error "The function or variable name ~S is unrecognizable."
1156                           name))
1157         (find fn-name fvars :key #'leaf-source-name :test #'equal))
1158       (find-in-bindings vars name)))
1159
1160 ;;; Process an ignore/ignorable declaration, checking for various losing
1161 ;;; conditions.
1162 (defun process-ignore-decl (spec vars fvars)
1163   (declare (list spec vars fvars))
1164   (dolist (name (rest spec))
1165     (let ((var (find-in-bindings-or-fbindings name vars fvars)))
1166       (cond
1167        ((not var)
1168         ;; ANSI's definition for "Declaration IGNORE, IGNORABLE"
1169         ;; requires that this be a STYLE-WARNING, not a full WARNING.
1170         (compiler-style-warn "declaring unknown variable ~S to be ignored"
1171                              name))
1172        ;; FIXME: This special case looks like non-ANSI weirdness.
1173        ((and (consp var) (eq (car var) 'macro))
1174         ;; Just ignore the IGNORE decl.
1175         )
1176        ((functional-p var)
1177         (setf (leaf-ever-used var) t))
1178        ((and (lambda-var-specvar var) (eq (first spec) 'ignore))
1179         ;; ANSI's definition for "Declaration IGNORE, IGNORABLE"
1180         ;; requires that this be a STYLE-WARNING, not a full WARNING.
1181         (compiler-style-warn "declaring special variable ~S to be ignored"
1182                              name))
1183        ((eq (first spec) 'ignorable)
1184         (setf (leaf-ever-used var) t))
1185        (t
1186         (setf (lambda-var-ignorep var) t)))))
1187   (values))
1188
1189 (defun process-dx-decl (names vars fvars)
1190   (flet ((maybe-notify (control &rest args)
1191            (when (policy *lexenv* (> speed inhibit-warnings))
1192              (apply #'compiler-notify control args))))
1193     (if (policy *lexenv* (= stack-allocate-dynamic-extent 3))
1194         (dolist (name names)
1195           (cond
1196             ((symbolp name)
1197              (let* ((bound-var (find-in-bindings vars name))
1198                     (var (or bound-var
1199                              (lexenv-find name vars)
1200                              (find-free-var name))))
1201                (etypecase var
1202                  (leaf
1203                   (if bound-var
1204                       (setf (leaf-dynamic-extent var) t)
1205                       (maybe-notify
1206                        "ignoring DYNAMIC-EXTENT declaration for free ~S"
1207                        name)))
1208                  (cons
1209                   (compiler-error "DYNAMIC-EXTENT on symbol-macro: ~S" name))
1210                  (heap-alien-info
1211                   (compiler-error "DYNAMIC-EXTENT on heap-alien-info: ~S"
1212                                   name)))))
1213             ((and (consp name)
1214                   (eq (car name) 'function)
1215                   (null (cddr name))
1216                   (valid-function-name-p (cadr name)))
1217              (let* ((fname (cadr name))
1218                     (bound-fun (find fname fvars
1219                                      :key #'leaf-source-name
1220                                      :test #'equal)))
1221                (etypecase bound-fun
1222                  (leaf
1223                   #!+stack-allocatable-closures
1224                   (setf (leaf-dynamic-extent bound-fun) t)
1225                   #!-stack-allocatable-closures
1226                   (maybe-notify
1227                    "ignoring DYNAMIC-EXTENT declaration on a function ~S ~
1228                     (not supported on this platform)." fname))
1229                  (cons
1230                   (compiler-error "DYNAMIC-EXTENT on macro: ~S" fname))
1231                  (null
1232                   (maybe-notify
1233                    "ignoring DYNAMIC-EXTENT declaration for free ~S"
1234                    fname)))))
1235             (t (compiler-error "DYNAMIC-EXTENT on a weird thing: ~S" name))))
1236       (maybe-notify "ignoring DYNAMIC-EXTENT declarations for ~S" names))))
1237
1238 ;;; FIXME: This is non-ANSI, so the default should be T, or it should
1239 ;;; go away, I think.
1240 (defvar *suppress-values-declaration* nil
1241   #!+sb-doc
1242   "If true, processing of the VALUES declaration is inhibited.")
1243
1244 ;;; Process a single declaration spec, augmenting the specified LEXENV
1245 ;;; RES. Return RES and result type. VARS and FVARS are as described
1246 ;;; PROCESS-DECLS.
1247 (defun process-1-decl (raw-spec res vars fvars binding-form-p context)
1248   (declare (type list raw-spec vars fvars))
1249   (declare (type lexenv res))
1250   (let ((spec (canonized-decl-spec raw-spec))
1251         (result-type *wild-type*))
1252     (values
1253      (case (first spec)
1254        (special (process-special-decl spec res vars binding-form-p context))
1255        (ftype
1256         (unless (cdr spec)
1257           (compiler-error "no type specified in FTYPE declaration: ~S" spec))
1258         (process-ftype-decl (second spec) res (cddr spec) fvars context))
1259        ((inline notinline maybe-inline)
1260         (process-inline-decl spec res fvars))
1261        ((ignore ignorable)
1262         (process-ignore-decl spec vars fvars)
1263         res)
1264        (optimize
1265         (make-lexenv
1266          :default res
1267          :policy (process-optimize-decl spec (lexenv-policy res))))
1268        (muffle-conditions
1269         (make-lexenv
1270          :default res
1271          :handled-conditions (process-muffle-conditions-decl
1272                               spec (lexenv-handled-conditions res))))
1273        (unmuffle-conditions
1274         (make-lexenv
1275          :default res
1276          :handled-conditions (process-unmuffle-conditions-decl
1277                               spec (lexenv-handled-conditions res))))
1278        (type
1279         (process-type-decl (cdr spec) res vars context))
1280        (values
1281         (unless *suppress-values-declaration*
1282           (let ((types (cdr spec)))
1283             (setq result-type
1284                   (compiler-values-specifier-type
1285                    (if (singleton-p types)
1286                        (car types)
1287                        `(values ,@types)))))
1288           res))
1289        (dynamic-extent
1290         (process-dx-decl (cdr spec) vars fvars)
1291         res)
1292        ((disable-package-locks enable-package-locks)
1293         (make-lexenv
1294          :default res
1295          :disabled-package-locks (process-package-lock-decl
1296                                   spec (lexenv-disabled-package-locks res))))
1297        (t
1298         (unless (info :declaration :recognized (first spec))
1299           (compiler-warn "unrecognized declaration ~S" raw-spec))
1300         res))
1301      result-type)))
1302
1303 ;;; Use a list of DECLARE forms to annotate the lists of LAMBDA-VAR
1304 ;;; and FUNCTIONAL structures which are being bound. In addition to
1305 ;;; filling in slots in the leaf structures, we return a new LEXENV,
1306 ;;; which reflects pervasive special and function type declarations,
1307 ;;; (NOT)INLINE declarations and OPTIMIZE declarations, and type of
1308 ;;; VALUES declarations. If BINDING-FORM-P is true, the third return
1309 ;;; value is a list of VARs that should not apply to the lexenv of the
1310 ;;; initialization forms for the bindings, but should apply to the body.
1311 ;;;
1312 ;;; This is also called in main.lisp when PROCESS-FORM handles a use
1313 ;;; of LOCALLY.
1314 (defun process-decls (decls vars fvars &key
1315                       (lexenv *lexenv*) (binding-form-p nil) (context :compile))
1316   (declare (list decls vars fvars))
1317   (let ((result-type *wild-type*)
1318         (*post-binding-variable-lexenv* nil))
1319     (dolist (decl decls)
1320       (dolist (spec (rest decl))
1321         (unless (consp spec)
1322           (compiler-error "malformed declaration specifier ~S in ~S" spec decl))
1323         (multiple-value-bind (new-env new-result-type)
1324             (process-1-decl spec lexenv vars fvars binding-form-p context)
1325           (setq lexenv new-env)
1326           (unless (eq new-result-type *wild-type*)
1327             (setq result-type
1328                   (values-type-intersection result-type new-result-type))))))
1329     (values lexenv result-type *post-binding-variable-lexenv*)))
1330
1331 (defun %processing-decls (decls vars fvars ctran lvar binding-form-p fun)
1332   (multiple-value-bind (*lexenv* result-type post-binding-lexenv)
1333       (process-decls decls vars fvars :binding-form-p binding-form-p)
1334     (cond ((eq result-type *wild-type*)
1335            (funcall fun ctran lvar post-binding-lexenv))
1336           (t
1337            (let ((value-ctran (make-ctran))
1338                  (value-lvar (make-lvar)))
1339              (multiple-value-prog1
1340                  (funcall fun value-ctran value-lvar post-binding-lexenv)
1341                (let ((cast (make-cast value-lvar result-type
1342                                       (lexenv-policy *lexenv*))))
1343                  (link-node-to-previous-ctran cast value-ctran)
1344                  (setf (lvar-dest value-lvar) cast)
1345                  (use-continuation cast ctran lvar))))))))
1346 (defmacro processing-decls ((decls vars fvars ctran lvar
1347                                    &optional post-binding-lexenv)
1348                             &body forms)
1349   (check-type ctran symbol)
1350   (check-type lvar symbol)
1351   (let ((post-binding-lexenv-p (not (null post-binding-lexenv)))
1352         (post-binding-lexenv (or post-binding-lexenv (gensym))))
1353     `(%processing-decls ,decls ,vars ,fvars ,ctran ,lvar
1354                         ,post-binding-lexenv-p
1355                         (lambda (,ctran ,lvar ,post-binding-lexenv)
1356                           (declare (ignorable ,post-binding-lexenv))
1357                           ,@forms))))
1358
1359 ;;; Return the SPECVAR for NAME to use when we see a local SPECIAL
1360 ;;; declaration. If there is a global variable of that name, then
1361 ;;; check that it isn't a constant and return it. Otherwise, create an
1362 ;;; anonymous GLOBAL-VAR.
1363 (defun specvar-for-binding (name)
1364   (cond ((not (eq (info :variable :where-from name) :assumed))
1365          (let ((found (find-free-var name)))
1366            (when (heap-alien-info-p found)
1367              (compiler-error
1368               "~S is an alien variable and so can't be declared special."
1369               name))
1370            (unless (global-var-p found)
1371              (compiler-error
1372               "~S is a constant and so can't be declared special."
1373               name))
1374            found))
1375         (t
1376          (make-global-var :kind :special
1377                           :%source-name name
1378                           :where-from :declared))))