776d2790d32d78bda8372294ca54c8eaaf88c975
[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 \f
52 ;;;; namespace management utilities
53
54 ;;; Return a GLOBAL-VAR structure usable for referencing the global
55 ;;; function NAME.
56 (defun find-free-really-fun (name)
57   (unless (info :function :kind name)
58     (setf (info :function :kind name) :function)
59     (setf (info :function :where-from name) :assumed))
60
61   (let ((where (info :function :where-from name)))
62     (when (and (eq where :assumed)
63                ;; In the ordinary target Lisp, it's silly to report
64                ;; undefinedness when the function is defined in the
65                ;; running Lisp. But at cross-compile time, the current
66                ;; definedness of a function is irrelevant to the
67                ;; definedness at runtime, which is what matters.
68                #-sb-xc-host (not (fboundp name)))
69       (note-undefined-reference name :function))
70     (make-global-var :kind :global-function
71                      :%source-name name
72                      :type (if (or *derive-function-types*
73                                    (eq where :declared))
74                                (info :function :type name)
75                                (specifier-type 'function))
76                      :where-from where)))
77
78 ;;; Has the *FREE-FUNS* entry FREE-FUN become invalid?
79 ;;;
80 ;;; In CMU CL, the answer was implicitly always true, so this 
81 ;;; predicate didn't exist.
82 ;;;
83 ;;; This predicate was added to fix bug 138 in SBCL. In some obscure
84 ;;; circumstances, it was possible for a *FREE-FUNS* entry to contain a
85 ;;; DEFINED-FUN whose DEFINED-FUN-FUNCTIONAL object contained IR1
86 ;;; stuff (NODEs, BLOCKs...) referring to an already compiled (aka
87 ;;; "dead") component. When this IR1 stuff was reused in a new
88 ;;; component, under further obscure circumstances it could be used by
89 ;;; WITH-IR1-ENVIRONMENT-FROM-NODE to generate a binding for
90 ;;; *CURRENT-COMPONENT*. At that point things got all confused, since
91 ;;; IR1 conversion was sending code to a component which had already
92 ;;; been compiled and would never be compiled again.
93 (defun invalid-free-fun-p (free-fun)
94   ;; There might be other reasons that *FREE-FUN* entries could
95   ;; become invalid, but the only one we've been bitten by so far
96   ;; (sbcl-0.pre7.118) is this one:
97   (and (defined-fun-p free-fun)
98        (let ((functional (defined-fun-functional free-fun)))
99          (or (and functional
100                   (eql (functional-kind functional) :deleted))
101              (and (lambda-p functional)
102                   (or
103                    ;; (The main reason for this first test is to bail
104                    ;; out early in cases where the LAMBDA-COMPONENT
105                    ;; call in the second test would fail because links
106                    ;; it needs are uninitialized or invalid.)
107                    ;;
108                    ;; If the BIND node for this LAMBDA is null, then
109                    ;; according to the slot comments, the LAMBDA has
110                    ;; been deleted or its call has been deleted. In
111                    ;; that case, it seems rather questionable to reuse
112                    ;; it, and certainly it shouldn't be necessary to
113                    ;; reuse it, so we cheerfully declare it invalid.
114                    (null (lambda-bind functional))
115                    ;; If this IR1 stuff belongs to a dead component,
116                    ;; then we can't reuse it without getting into
117                    ;; bizarre confusion.
118                    (eql (component-info (lambda-component functional))
119                         :dead)))))))
120
121 ;;; If NAME already has a valid entry in *FREE-FUNS*, then return
122 ;;; the value. Otherwise, make a new GLOBAL-VAR using information from
123 ;;; the global environment and enter it in *FREE-FUNS*. If NAME
124 ;;; names a macro or special form, then we error out using the
125 ;;; supplied context which indicates what we were trying to do that
126 ;;; demanded a function.
127 (declaim (ftype (function (t string) global-var) find-free-fun))
128 (defun find-free-fun (name context)
129   (or (let ((old-free-fun (gethash name *free-funs*)))
130         (and (not (invalid-free-fun-p old-free-fun))
131              old-free-fun))
132       (ecase (info :function :kind name)
133         ;; FIXME: The :MACRO and :SPECIAL-FORM cases could be merged.
134         (:macro
135          (compiler-error "The macro name ~S was found ~A." name context))
136         (:special-form
137          (compiler-error "The special form name ~S was found ~A."
138                          name
139                          context))
140         ((:function nil)
141          (check-fun-name name)
142          (note-if-setf-fun-and-macro name)
143          (let ((expansion (fun-name-inline-expansion name))
144                (inlinep (info :function :inlinep name)))
145            (setf (gethash name *free-funs*)
146                  (if (or expansion inlinep)
147                      (make-defined-fun
148                       :%source-name name
149                       :inline-expansion expansion
150                       :inlinep inlinep
151                       :where-from (info :function :where-from name)
152                       :type (info :function :type name))
153                      (find-free-really-fun name))))))))
154
155 ;;; Return the LEAF structure for the lexically apparent function
156 ;;; definition of NAME.
157 (declaim (ftype (function (t string) leaf) find-lexically-apparent-fun))
158 (defun find-lexically-apparent-fun (name context)
159   (let ((var (lexenv-find name funs :test #'equal)))
160     (cond (var
161            (unless (leaf-p var)
162              (aver (and (consp var) (eq (car var) 'macro)))
163              (compiler-error "found macro name ~S ~A" name context))
164            var)
165           (t
166            (find-free-fun name context)))))
167
168 ;;; Return the LEAF node for a global variable reference to NAME. If
169 ;;; NAME is already entered in *FREE-VARS*, then we just return the
170 ;;; corresponding value. Otherwise, we make a new leaf using
171 ;;; information from the global environment and enter it in
172 ;;; *FREE-VARS*. If the variable is unknown, then we emit a warning.
173 (declaim (ftype (function (t) (or leaf cons heap-alien-info)) find-free-var))
174 (defun find-free-var (name)
175   (unless (symbolp name)
176     (compiler-error "Variable name is not a symbol: ~S." name))
177   (or (gethash name *free-vars*)
178       (let ((kind (info :variable :kind name))
179             (type (info :variable :type name))
180             (where-from (info :variable :where-from name)))
181         (when (and (eq where-from :assumed) (eq kind :global))
182           (note-undefined-reference name :variable))
183         (setf (gethash name *free-vars*)
184               (case kind
185                 (:alien
186                  (info :variable :alien-info name))
187                 ;; FIXME: The return value in this case should really be
188                 ;; of type SB!C::LEAF.  I don't feel too badly about it,
189                 ;; because the MACRO idiom is scattered throughout this
190                 ;; file, but it should be cleaned up so we're not
191                 ;; throwing random conses around.  --njf 2002-03-23
192                 (:macro
193                  (let ((expansion (info :variable :macro-expansion name))
194                        (type (type-specifier (info :variable :type name))))
195                    `(MACRO . (the ,type ,expansion))))
196                 (:constant
197                  (let ((value (info :variable :constant-value name)))
198                    (make-constant :value value
199                                   :%source-name name
200                                   :type (ctype-of value)
201                                   :where-from where-from)))
202                 (t
203                  (make-global-var :kind kind
204                                   :%source-name name
205                                   :type type
206                                   :where-from where-from)))))))
207 \f
208 ;;; Grovel over CONSTANT checking for any sub-parts that need to be
209 ;;; processed with MAKE-LOAD-FORM. We have to be careful, because
210 ;;; CONSTANT might be circular. We also check that the constant (and
211 ;;; any subparts) are dumpable at all.
212 (eval-when (:compile-toplevel :load-toplevel :execute)
213   ;; The EVAL-WHEN is necessary for #.(1+ LIST-TO-HASH-TABLE-THRESHOLD) 
214   ;; below. -- AL 20010227
215   (def!constant list-to-hash-table-threshold 32))
216 (defun maybe-emit-make-load-forms (constant)
217   (let ((things-processed nil)
218         (count 0))
219     ;; FIXME: Does this LIST-or-HASH-TABLE messiness give much benefit?
220     (declare (type (or list hash-table) things-processed)
221              (type (integer 0 #.(1+ list-to-hash-table-threshold)) count)
222              (inline member))
223     (labels ((grovel (value)
224                ;; Unless VALUE is an object which which obviously
225                ;; can't contain other objects
226                (unless (typep value
227                               '(or #-sb-xc-host unboxed-array
228                                    symbol
229                                    number
230                                    character
231                                    string))
232                  (etypecase things-processed
233                    (list
234                     (when (member value things-processed :test #'eq)
235                       (return-from grovel nil))
236                     (push value things-processed)
237                     (incf count)
238                     (when (> count list-to-hash-table-threshold)
239                       (let ((things things-processed))
240                         (setf things-processed
241                               (make-hash-table :test 'eq))
242                         (dolist (thing things)
243                           (setf (gethash thing things-processed) t)))))
244                    (hash-table
245                     (when (gethash value things-processed)
246                       (return-from grovel nil))
247                     (setf (gethash value things-processed) t)))
248                  (typecase value
249                    (cons
250                     (grovel (car value))
251                     (grovel (cdr value)))
252                    (simple-vector
253                     (dotimes (i (length value))
254                       (grovel (svref value i))))
255                    ((vector t)
256                     (dotimes (i (length value))
257                       (grovel (aref value i))))
258                    ((simple-array t)
259                     ;; Even though the (ARRAY T) branch does the exact
260                     ;; same thing as this branch we do this separately
261                     ;; so that the compiler can use faster versions of
262                     ;; array-total-size and row-major-aref.
263                     (dotimes (i (array-total-size value))
264                       (grovel (row-major-aref value i))))
265                    ((array t)
266                     (dotimes (i (array-total-size value))
267                       (grovel (row-major-aref value i))))
268                    (;; In the target SBCL, we can dump any instance,
269                     ;; but in the cross-compilation host,
270                     ;; %INSTANCE-FOO functions don't work on general
271                     ;; instances, only on STRUCTURE!OBJECTs.
272                     #+sb-xc-host structure!object
273                     #-sb-xc-host instance
274                     (when (emit-make-load-form value)
275                       (dotimes (i (%instance-length value))
276                         (grovel (%instance-ref value i)))))
277                    (t
278                     (compiler-error
279                      "Objects of type ~S can't be dumped into fasl files."
280                      (type-of value)))))))
281       (grovel constant)))
282   (values))
283 \f
284 ;;;; some flow-graph hacking utilities
285
286 ;;; This function sets up the back link between the node and the
287 ;;; continuation which continues at it.
288 (defun link-node-to-previous-continuation (node cont)
289   (declare (type node node) (type continuation cont))
290   (aver (not (continuation-next cont)))
291   (setf (continuation-next cont) node)
292   (setf (node-prev node) cont))
293
294 ;;; This function is used to set the continuation for a node, and thus
295 ;;; determine what receives the value and what is evaluated next. If
296 ;;; the continuation has no block, then we make it be in the block
297 ;;; that the node is in. If the continuation heads its block, we end
298 ;;; our block and link it to that block. If the continuation is not
299 ;;; currently used, then we set the DERIVED-TYPE for the continuation
300 ;;; to that of the node, so that a little type propagation gets done.
301 ;;;
302 ;;; We also deal with a bit of THE's semantics here: we weaken the
303 ;;; assertion on CONT to be no stronger than the assertion on CONT in
304 ;;; our scope. See the IR1-CONVERT method for THE.
305 #!-sb-fluid (declaim (inline use-continuation))
306 (defun use-continuation (node cont)
307   (declare (type node node) (type continuation cont))
308   (let ((node-block (continuation-block (node-prev node))))
309     (case (continuation-kind cont)
310       (:unused
311        (setf (continuation-block cont) node-block)
312        (setf (continuation-kind cont) :inside-block)
313        (setf (continuation-use cont) node)
314        (setf (node-cont node) cont))
315       (t
316        (%use-continuation node cont)))))
317 (defun %use-continuation (node cont)
318   (declare (type node node) (type continuation cont) (inline member))
319   (let ((block (continuation-block cont))
320         (node-block (continuation-block (node-prev node))))
321     (aver (eq (continuation-kind cont) :block-start))
322     (when (block-last node-block)
323       (error "~S has already ended." node-block))
324     (setf (block-last node-block) node)
325     (when (block-succ node-block)
326       (error "~S already has successors." node-block))
327     (setf (block-succ node-block) (list block))
328     (when (memq node-block (block-pred block))
329       (error "~S is already a predecessor of ~S." node-block block))
330     (push node-block (block-pred block))
331     (add-continuation-use node cont)
332     (unless (eq (continuation-asserted-type cont) *wild-type*)
333       (let* ((restriction (or (lexenv-find cont type-restrictions)
334                               *wild-type*))
335              (wrestriction (or (lexenv-find cont weakend-type-restrictions)
336                                *wild-type*))
337              (newatype (values-type-union (continuation-asserted-type cont)
338                                           restriction))
339              (newctype (values-type-union (continuation-type-to-check cont)
340                                           wrestriction)))
341         (when (or (type/= newatype (continuation-asserted-type cont))
342                   (type/= newctype (continuation-type-to-check cont)))
343           (setf (continuation-asserted-type cont) newatype)
344           (setf (continuation-type-to-check cont) newctype)
345           (reoptimize-continuation cont))))))
346 \f
347 ;;;; exported functions
348
349 ;;; This function takes a form and the top level form number for that
350 ;;; form, and returns a lambda representing the translation of that
351 ;;; form in the current global environment. The returned lambda is a
352 ;;; top level lambda that can be called to cause evaluation of the
353 ;;; forms. This lambda is in the initial component. If FOR-VALUE is T,
354 ;;; then the value of the form is returned from the function,
355 ;;; otherwise NIL is returned.
356 ;;;
357 ;;; This function may have arbitrary effects on the global environment
358 ;;; due to processing of EVAL-WHENs. All syntax error checking is
359 ;;; done, with erroneous forms being replaced by a proxy which signals
360 ;;; an error if it is evaluated. Warnings about possibly inconsistent
361 ;;; or illegal changes to the global environment will also be given.
362 ;;;
363 ;;; We make the initial component and convert the form in a PROGN (and
364 ;;; an optional NIL tacked on the end.) We then return the lambda. We
365 ;;; bind all of our state variables here, rather than relying on the
366 ;;; global value (if any) so that IR1 conversion will be reentrant.
367 ;;; This is necessary for EVAL-WHEN processing, etc.
368 ;;;
369 ;;; The hashtables used to hold global namespace info must be
370 ;;; reallocated elsewhere. Note also that *LEXENV* is not bound, so
371 ;;; that local macro definitions can be introduced by enclosing code.
372 (defun ir1-toplevel (form path for-value)
373   (declare (list path))
374   (let* ((*current-path* path)
375          (component (make-empty-component))
376          (*current-component* component))
377     (setf (component-name component) "initial component")
378     (setf (component-kind component) :initial)
379     (let* ((forms (if for-value `(,form) `(,form nil)))
380            (res (ir1-convert-lambda-body
381                  forms ()
382                  :debug-name (debug-namify "top level form ~S" form))))
383       (setf (functional-entry-fun res) res
384             (functional-arg-documentation res) ()
385             (functional-kind res) :toplevel)
386       res)))
387
388 ;;; *CURRENT-FORM-NUMBER* is used in FIND-SOURCE-PATHS to compute the
389 ;;; form number to associate with a source path. This should be bound
390 ;;; to an initial value of 0 before the processing of each truly
391 ;;; top level form.
392 (declaim (type index *current-form-number*))
393 (defvar *current-form-number*)
394
395 ;;; This function is called on freshly read forms to record the
396 ;;; initial location of each form (and subform.) Form is the form to
397 ;;; find the paths in, and TLF-NUM is the top level form number of the
398 ;;; truly top level form.
399 ;;;
400 ;;; This gets a bit interesting when the source code is circular. This
401 ;;; can (reasonably?) happen in the case of circular list constants.
402 (defun find-source-paths (form tlf-num)
403   (declare (type index tlf-num))
404   (let ((*current-form-number* 0))
405     (sub-find-source-paths form (list tlf-num)))
406   (values))
407 (defun sub-find-source-paths (form path)
408   (unless (gethash form *source-paths*)
409     (setf (gethash form *source-paths*)
410           (list* 'original-source-start *current-form-number* path))
411     (incf *current-form-number*)
412     (let ((pos 0)
413           (subform form)
414           (trail form))
415       (declare (fixnum pos))
416       (macrolet ((frob ()
417                    '(progn
418                       (when (atom subform) (return))
419                       (let ((fm (car subform)))
420                         (when (consp fm)
421                           (sub-find-source-paths fm (cons pos path)))
422                         (incf pos))
423                       (setq subform (cdr subform))
424                       (when (eq subform trail) (return)))))
425         (loop
426           (frob)
427           (frob)
428           (setq trail (cdr trail)))))))
429 \f
430 ;;;; IR1-CONVERT, macroexpansion and special form dispatching
431
432 (macrolet (;; Bind *COMPILER-ERROR-BAILOUT* to a function that throws
433            ;; out of the body and converts a proxy form instead.
434            (ir1-error-bailout ((start
435                                 cont
436                                 form
437                                 &optional
438                                 (proxy ``(error 'simple-program-error
439                                           :format-control "execution of a form compiled with errors:~% ~S"
440                                           :format-arguments (list ',,form))))
441                                &body body)
442                               (let ((skip (gensym "SKIP")))
443                                 `(block ,skip
444                                    (catch 'ir1-error-abort
445                                      (let ((*compiler-error-bailout*
446                                             (lambda ()
447                                               (throw 'ir1-error-abort nil))))
448                                        ,@body
449                                        (return-from ,skip nil)))
450                                    (ir1-convert ,start ,cont ,proxy)))))
451
452   ;; Translate FORM into IR1. The code is inserted as the NEXT of the
453   ;; continuation START. CONT is the continuation which receives the
454   ;; value of the FORM to be translated. The translators call this
455   ;; function recursively to translate their subnodes.
456   ;;
457   ;; As a special hack to make life easier in the compiler, a LEAF
458   ;; IR1-converts into a reference to that LEAF structure. This allows
459   ;; the creation using backquote of forms that contain leaf
460   ;; references, without having to introduce dummy names into the
461   ;; namespace.
462   (declaim (ftype (function (continuation continuation t) (values)) ir1-convert))
463   (defun ir1-convert (start cont form)
464     (ir1-error-bailout (start cont form)
465       (let ((*current-path* (or (gethash form *source-paths*)
466                                 (cons form *current-path*))))
467         (if (atom form)
468             (cond ((and (symbolp form) (not (keywordp form)))
469                    (ir1-convert-var start cont form))
470                   ((leaf-p form)
471                    (reference-leaf start cont form))
472                   (t
473                    (reference-constant start cont form)))
474             (let ((opname (car form)))
475               (cond ((symbolp opname)
476                      (let ((lexical-def (lexenv-find opname funs)))
477                        (typecase lexical-def
478                          (null (ir1-convert-global-functoid start cont form))
479                          (functional
480                           (ir1-convert-local-combination start
481                                                          cont
482                                                          form
483                                                          lexical-def))
484                          (global-var
485                           (ir1-convert-srctran start cont lexical-def form))
486                          (t
487                           (aver (and (consp lexical-def)
488                                      (eq (car lexical-def) 'macro)))
489                           (ir1-convert start cont
490                                        (careful-expand-macro (cdr lexical-def)
491                                                              form))))))
492                     ((or (atom opname) (not (eq (car opname) 'lambda)))
493                      (compiler-error "illegal function call"))
494                     (t
495                      ;; implicitly (LAMBDA ..) because the LAMBDA
496                      ;; expression is the CAR of an executed form
497                      (ir1-convert-combination start
498                                               cont
499                                               form
500                                               (ir1-convert-lambda
501                                                opname
502                                                :debug-name (debug-namify
503                                                             "LAMBDA CAR ~S"
504                                                             opname)))))))))
505     (values))
506
507   ;; Generate a reference to a manifest constant, creating a new leaf
508   ;; if necessary. If we are producing a fasl file, make sure that
509   ;; MAKE-LOAD-FORM gets used on any parts of the constant that it
510   ;; needs to be.
511   (defun reference-constant (start cont value)
512     (declare (type continuation start cont)
513              (inline find-constant))
514     (ir1-error-bailout
515      (start cont value '(error "attempt to reference undumpable constant"))
516      (when (producing-fasl-file)
517        (maybe-emit-make-load-forms value))
518      (let* ((leaf (find-constant value))
519             (res (make-ref (leaf-type leaf) leaf)))
520        (push res (leaf-refs leaf))
521        (link-node-to-previous-continuation res start)
522        (use-continuation res cont)))
523     (values)))
524
525 ;;; Add FUNCTIONAL to the COMPONENT-REANALYZE-FUNCTIONALS, unless it's
526 ;;; some trivial type for which reanalysis is a trivial no-op, or
527 ;;; unless it doesn't belong in this component at all.
528 ;;;
529 ;;; FUNCTIONAL is returned.
530 (defun maybe-reanalyze-functional (functional)
531
532   (aver (not (eql (functional-kind functional) :deleted))) ; bug 148
533   (aver-live-component *current-component*)
534
535   ;; When FUNCTIONAL is of a type for which reanalysis isn't a trivial
536   ;; no-op
537   (when (typep functional '(or optional-dispatch clambda))
538
539     ;; When FUNCTIONAL knows its component
540     (when (lambda-p functional) 
541       (aver (eql (lambda-component functional) *current-component*)))
542
543     (pushnew functional
544              (component-reanalyze-functionals *current-component*)))
545
546   functional)
547
548 ;;; Generate a REF node for LEAF, frobbing the LEAF structure as
549 ;;; needed. If LEAF represents a defined function which has already
550 ;;; been converted, and is not :NOTINLINE, then reference the
551 ;;; functional instead.
552 (defun reference-leaf (start cont leaf)
553   (declare (type continuation start cont) (type leaf leaf))
554   (with-continuation-type-assertion
555       (cont (or (lexenv-find leaf type-restrictions) *wild-type*)
556             "in DECLARE")
557     (let* ((leaf (or (and (defined-fun-p leaf)
558                           (not (eq (defined-fun-inlinep leaf)
559                                    :notinline))
560                           (let ((functional (defined-fun-functional leaf)))
561                             (when (and functional
562                                        (not (functional-kind functional)))
563                               (maybe-reanalyze-functional functional))))
564                      leaf))
565            (res (make-ref (leaf-type leaf)
566                           leaf)))
567       (push res (leaf-refs leaf))
568       (setf (leaf-ever-used leaf) t)
569       (link-node-to-previous-continuation res start)
570       (use-continuation res cont))))
571
572 ;;; Convert a reference to a symbolic constant or variable. If the
573 ;;; symbol is entered in the LEXENV-VARS we use that definition,
574 ;;; otherwise we find the current global definition. This is also
575 ;;; where we pick off symbol macro and alien variable references.
576 (defun ir1-convert-var (start cont name)
577   (declare (type continuation start cont) (symbol name))
578   (let ((var (or (lexenv-find name vars) (find-free-var name))))
579     (etypecase var
580       (leaf
581        (when (lambda-var-p var)
582          (let ((home (continuation-home-lambda-or-null start)))
583            (when home
584              (pushnew var (lambda-calls-or-closes home))))
585          (when (lambda-var-ignorep var)
586            ;; (ANSI's specification for the IGNORE declaration requires
587            ;; that this be a STYLE-WARNING, not a full WARNING.)
588            (compiler-style-warn "reading an ignored variable: ~S" name)))
589        (reference-leaf start cont var))
590       (cons
591        (aver (eq (car var) 'MACRO))
592        (ir1-convert start cont (cdr var)))
593       (heap-alien-info
594        (ir1-convert start cont `(%heap-alien ',var)))))
595   (values))
596
597 ;;; Convert anything that looks like a special form, global function
598 ;;; or compiler-macro call.
599 (defun ir1-convert-global-functoid (start cont form)
600   (declare (type continuation start cont) (list form))
601   (let* ((fun-name (first form))
602          (translator (info :function :ir1-convert fun-name))
603          (cmacro-fun (sb!xc:compiler-macro-function fun-name *lexenv*)))
604     (cond (translator
605            (when cmacro-fun
606              (compiler-warn "ignoring compiler macro for special form"))
607            (funcall translator start cont form))
608           ((and cmacro-fun
609                 ;; gotcha: If you look up the DEFINE-COMPILER-MACRO
610                 ;; macro in the ANSI spec, you might think that
611                 ;; suppressing compiler-macro expansion when NOTINLINE
612                 ;; is some pre-ANSI hack. However, if you look up the
613                 ;; NOTINLINE declaration, you'll find that ANSI
614                 ;; requires this behavior after all.
615                 (not (eq (info :function :inlinep fun-name) :notinline)))
616            (let ((res (careful-expand-macro cmacro-fun form)))
617              (if (eq res form)
618                  (ir1-convert-global-functoid-no-cmacro
619                   start cont form fun-name)
620                  (ir1-convert start cont res))))
621           (t
622            (ir1-convert-global-functoid-no-cmacro start cont form fun-name)))))
623
624 ;;; Handle the case of where the call was not a compiler macro, or was
625 ;;; a compiler macro and passed.
626 (defun ir1-convert-global-functoid-no-cmacro (start cont form fun)
627   (declare (type continuation start cont) (list form))
628   ;; FIXME: Couldn't all the INFO calls here be converted into
629   ;; standard CL functions, like MACRO-FUNCTION or something?
630   ;; And what happens with lexically-defined (MACROLET) macros
631   ;; here, anyway?
632   (ecase (info :function :kind fun)
633     (:macro
634      (ir1-convert start
635                   cont
636                   (careful-expand-macro (info :function :macro-function fun)
637                                         form)))
638     ((nil :function)
639      (ir1-convert-srctran start
640                           cont
641                           (find-free-fun fun "shouldn't happen! (no-cmacro)")
642                           form))))
643
644 (defun muffle-warning-or-die ()
645   (muffle-warning)
646   (bug "no MUFFLE-WARNING restart"))
647
648 ;;; Expand FORM using the macro whose MACRO-FUNCTION is FUN, trapping
649 ;;; errors which occur during the macroexpansion.
650 (defun careful-expand-macro (fun form)
651   (let (;; a hint I (WHN) wish I'd known earlier
652         (hint "(hint: For more precise location, try *BREAK-ON-SIGNALS*.)"))
653     (flet (;; Return a string to use as a prefix in error reporting,
654            ;; telling something about which form caused the problem.
655            (wherestring ()
656              (let ((*print-pretty* nil)
657                    ;; We rely on the printer to abbreviate FORM. 
658                    (*print-length* 3)
659                    (*print-level* 1))
660                (format
661                 nil
662                 #-sb-xc-host "(in macroexpansion of ~S)"
663                 ;; longer message to avoid ambiguity "Was it the xc host
664                 ;; or the cross-compiler which encountered the problem?"
665                 #+sb-xc-host "(in cross-compiler macroexpansion of ~S)"
666                 form))))
667       (handler-bind ((style-warning (lambda (c)
668                                       (compiler-style-warn
669                                        "~@<~A~:@_~A~@:_~A~:>"
670                                        (wherestring) hint c)
671                                       (muffle-warning-or-die)))
672                      ;; KLUDGE: CMU CL in its wisdom (version 2.4.6 for
673                      ;; Debian Linux, anyway) raises a CL:WARNING
674                      ;; condition (not a CL:STYLE-WARNING) for undefined
675                      ;; symbols when converting interpreted functions,
676                      ;; causing COMPILE-FILE to think the file has a real
677                      ;; problem, causing COMPILE-FILE to return FAILURE-P
678                      ;; set (not just WARNINGS-P set). Since undefined
679                      ;; symbol warnings are often harmless forward
680                      ;; references, and since it'd be inordinately painful
681                      ;; to try to eliminate all such forward references,
682                      ;; these warnings are basically unavoidable. Thus, we
683                      ;; need to coerce the system to work through them,
684                      ;; and this code does so, by crudely suppressing all
685                      ;; warnings in cross-compilation macroexpansion. --
686                      ;; WHN 19990412
687                      #+(and cmu sb-xc-host)
688                      (warning (lambda (c)
689                                 (compiler-note
690                                  "~@<~A~:@_~
691                                   ~A~:@_~
692                                   ~@<(KLUDGE: That was a non-STYLE WARNING. ~
693                                   Ordinarily that would cause compilation to ~
694                                   fail. However, since we're running under ~
695                                   CMU CL, and since CMU CL emits non-STYLE ~
696                                   warnings for safe, hard-to-fix things (e.g. ~
697                                   references to not-yet-defined functions) ~
698                                   we're going to have to ignore it and ~
699                                   proceed anyway. Hopefully we're not ~
700                                   ignoring anything  horrible here..)~:@>~:>"
701                                  (wherestring)
702                                  c)
703                                 (muffle-warning-or-die)))
704                      #-(and cmu sb-xc-host)
705                      (warning (lambda (c)
706                                 (compiler-warn "~@<~A~:@_~A~@:_~A~:>"
707                                                (wherestring) hint c)
708                                 (muffle-warning-or-die)))
709                      (error (lambda (c)
710                               (compiler-error "~@<~A~:@_~A~@:_~A~:>"
711                                               (wherestring) hint c))))
712         (funcall sb!xc:*macroexpand-hook* fun form *lexenv*)))))
713 \f
714 ;;;; conversion utilities
715
716 ;;; Convert a bunch of forms, discarding all the values except the
717 ;;; last. If there aren't any forms, then translate a NIL.
718 (declaim (ftype (function (continuation continuation list) (values))
719                 ir1-convert-progn-body))
720 (defun ir1-convert-progn-body (start cont body)
721   (if (endp body)
722       (reference-constant start cont nil)
723       (let ((this-start start)
724             (forms body))
725         (loop
726           (let ((form (car forms)))
727             (when (endp (cdr forms))
728               (ir1-convert this-start cont form)
729               (return))
730             (let ((this-cont (make-continuation)))
731               (ir1-convert this-start this-cont form)
732               (setq this-start this-cont
733                     forms (cdr forms)))))))
734   (values))
735 \f
736 ;;;; converting combinations
737
738 ;;; Convert a function call where the function FUN is a LEAF. FORM is
739 ;;; the source for the call. We return the COMBINATION node so that
740 ;;; the caller can poke at it if it wants to.
741 (declaim (ftype (function (continuation continuation list leaf) combination)
742                 ir1-convert-combination))
743 (defun ir1-convert-combination (start cont form fun)
744   (let ((fun-cont (make-continuation)))
745     (reference-leaf start fun-cont fun)
746     (ir1-convert-combination-args fun-cont cont (cdr form))))
747
748 ;;; Convert the arguments to a call and make the COMBINATION
749 ;;; node. FUN-CONT is the continuation which yields the function to
750 ;;; call. ARGS is the list of arguments for the call, which defaults
751 ;;; to the cdr of source. We return the COMBINATION node.
752 (defun ir1-convert-combination-args (fun-cont cont args)
753   (declare (type continuation fun-cont cont) (list args))
754   (let ((node (make-combination fun-cont)))
755     (setf (continuation-dest fun-cont) node)
756     (assert-continuation-type fun-cont
757                               (specifier-type '(or function symbol))
758                               (lexenv-policy *lexenv*))
759     (setf (continuation-%externally-checkable-type fun-cont) nil)
760     (collect ((arg-conts))
761       (let ((this-start fun-cont))
762         (dolist (arg args)
763           (let ((this-cont (make-continuation node)))
764             (ir1-convert this-start this-cont arg)
765             (setq this-start this-cont)
766             (arg-conts this-cont)))
767         (link-node-to-previous-continuation node this-start)
768         (use-continuation node cont)
769         (setf (combination-args node) (arg-conts))))
770     node))
771
772 ;;; Convert a call to a global function. If not :NOTINLINE, then we do
773 ;;; source transforms and try out any inline expansion. If there is no
774 ;;; expansion, but is :INLINE, then give an efficiency note (unless a
775 ;;; known function which will quite possibly be open-coded.) Next, we
776 ;;; go to ok-combination conversion.
777 (defun ir1-convert-srctran (start cont var form)
778   (declare (type continuation start cont) (type global-var var))
779   (let ((inlinep (when (defined-fun-p var)
780                    (defined-fun-inlinep var))))
781     (if (eq inlinep :notinline)
782         (ir1-convert-combination start cont form var)
783         (let ((transform (info :function
784                                :source-transform
785                                (leaf-source-name var))))
786           (if transform
787               (multiple-value-bind (result pass) (funcall transform form)
788                 (if pass
789                     (ir1-convert-maybe-predicate start cont form var)
790                     (ir1-convert start cont result)))
791               (ir1-convert-maybe-predicate start cont form var))))))
792
793 ;;; If the function has the PREDICATE attribute, and the CONT's DEST
794 ;;; isn't an IF, then we convert (IF <form> T NIL), ensuring that a
795 ;;; predicate always appears in a conditional context.
796 ;;;
797 ;;; If the function isn't a predicate, then we call
798 ;;; IR1-CONVERT-COMBINATION-CHECKING-TYPE.
799 (defun ir1-convert-maybe-predicate (start cont form var)
800   (declare (type continuation start cont) (list form) (type global-var var))
801   (let ((info (info :function :info (leaf-source-name var))))
802     (if (and info
803              (ir1-attributep (fun-info-attributes info) predicate)
804              (not (if-p (continuation-dest cont))))
805         (ir1-convert start cont `(if ,form t nil))
806         (ir1-convert-combination-checking-type start cont form var))))
807
808 ;;; Actually really convert a global function call that we are allowed
809 ;;; to early-bind.
810 ;;;
811 ;;; If we know the function type of the function, then we check the
812 ;;; call for syntactic legality with respect to the declared function
813 ;;; type. If it is impossible to determine whether the call is correct
814 ;;; due to non-constant keywords, then we give up, marking the call as
815 ;;; :FULL to inhibit further error messages. We return true when the
816 ;;; call is legal.
817 ;;;
818 ;;; If the call is legal, we also propagate type assertions from the
819 ;;; function type to the arg and result continuations. We do this now
820 ;;; so that IR1 optimize doesn't have to redundantly do the check
821 ;;; later so that it can do the type propagation.
822 (defun ir1-convert-combination-checking-type (start cont form var)
823   (declare (type continuation start cont) (list form) (type leaf var))
824   (let* ((node (ir1-convert-combination start cont form var))
825          (fun-cont (basic-combination-fun node))
826          (type (leaf-type var)))
827     (when (validate-call-type node type t)
828       (setf (continuation-%derived-type fun-cont) type)
829       (setf (continuation-reoptimize fun-cont) nil)
830       (setf (continuation-%type-check fun-cont) nil)))
831   (values))
832
833 ;;; Convert a call to a local function, or if the function has already
834 ;;; been LET converted, then throw FUNCTIONAL to
835 ;;; LOCALL-ALREADY-LET-CONVERTED. The THROW should only happen when we
836 ;;; are converting inline expansions for local functions during
837 ;;; optimization.
838 (defun ir1-convert-local-combination (start cont form functional)
839
840   ;; The test here is for "when LET converted", as a translation of
841   ;; the old CMU CL comments into code. Unfortunately, the old CMU CL
842   ;; comments aren't specific enough to tell whether the correct
843   ;; translation is FUNCTIONAL-SOMEWHAT-LETLIKE-P or
844   ;; FUNCTIONAL-LETLIKE-P or what. The old CMU CL code assumed that
845   ;; any non-null FUNCTIONAL-KIND meant that the function "had been
846   ;; LET converted", which might even be right, but seems fragile, so
847   ;; we try to be pickier.
848   (when (or
849          ;; looks LET-converted
850          (functional-somewhat-letlike-p functional)
851          ;; It's possible for a LET-converted function to end up
852          ;; deleted later. In that case, for the purposes of this
853          ;; analysis, it is LET-converted: LET-converted functionals
854          ;; are too badly trashed to expand them inline, and deleted
855          ;; LET-converted functionals are even worse.
856          (eql (functional-kind functional) :deleted))
857     (throw 'locall-already-let-converted functional))
858   ;; Any other non-NIL KIND value is a case we haven't found a
859   ;; justification for, and at least some such values (e.g. :EXTERNAL
860   ;; and :TOPLEVEL) seem obviously wrong.
861   (aver (null (functional-kind functional)))
862
863   (ir1-convert-combination start
864                            cont
865                            form
866                            (maybe-reanalyze-functional functional)))
867 \f
868 ;;;; PROCESS-DECLS
869
870 ;;; Given a list of LAMBDA-VARs and a variable name, return the
871 ;;; LAMBDA-VAR for that name, or NIL if it isn't found. We return the
872 ;;; *last* variable with that name, since LET* bindings may be
873 ;;; duplicated, and declarations always apply to the last.
874 (declaim (ftype (function (list symbol) (or lambda-var list))
875                 find-in-bindings))
876 (defun find-in-bindings (vars name)
877   (let ((found nil))
878     (dolist (var vars)
879       (cond ((leaf-p var)
880              (when (eq (leaf-source-name var) name)
881                (setq found var))
882              (let ((info (lambda-var-arg-info var)))
883                (when info
884                  (let ((supplied-p (arg-info-supplied-p info)))
885                    (when (and supplied-p
886                               (eq (leaf-source-name supplied-p) name))
887                      (setq found supplied-p))))))
888             ((and (consp var) (eq (car var) name))
889              (setf found (cdr var)))))
890     found))
891
892 ;;; Called by PROCESS-DECLS to deal with a variable type declaration.
893 ;;; If a LAMBDA-VAR being bound, we intersect the type with the var's
894 ;;; type, otherwise we add a type restriction on the var. If a symbol
895 ;;; macro, we just wrap a THE around the expansion.
896 (defun process-type-decl (decl res vars)
897   (declare (list decl vars) (type lexenv res))
898   (let ((type (compiler-specifier-type (first decl))))
899     (collect ((restr nil cons)
900               (new-vars nil cons))
901       (dolist (var-name (rest decl))
902         (let* ((bound-var (find-in-bindings vars var-name))
903                (var (or bound-var
904                         (lexenv-find var-name vars)
905                         (find-free-var var-name))))
906           (etypecase var
907             (leaf
908              (let* ((old-type (or (lexenv-find var type-restrictions)
909                                   (leaf-type var)))
910                     (int (if (or (fun-type-p type)
911                                  (fun-type-p old-type))
912                              type
913                              (type-approx-intersection2 old-type type))))
914                (cond ((eq int *empty-type*)
915                       (unless (policy *lexenv* (= inhibit-warnings 3))
916                         (compiler-warn
917                          "The type declarations ~S and ~S for ~S conflict."
918                          (type-specifier old-type) (type-specifier type)
919                          var-name)))
920                      (bound-var (setf (leaf-type bound-var) int))
921                      (t
922                       (restr (cons var int))))))
923             (cons
924              ;; FIXME: non-ANSI weirdness
925              (aver (eq (car var) 'MACRO))
926              (new-vars `(,var-name . (MACRO . (the ,(first decl)
927                                                    ,(cdr var))))))
928             (heap-alien-info
929              (compiler-error
930               "~S is an alien variable, so its type can't be declared."
931               var-name)))))
932
933       (if (or (restr) (new-vars))
934           (make-lexenv :default res
935                        :type-restrictions (restr)
936                        :vars (new-vars))
937           res))))
938
939 ;;; This is somewhat similar to PROCESS-TYPE-DECL, but handles
940 ;;; declarations for function variables. In addition to allowing
941 ;;; declarations for functions being bound, we must also deal with
942 ;;; declarations that constrain the type of lexically apparent
943 ;;; functions.
944 (defun process-ftype-decl (spec res names fvars)
945   (declare (type type-specifier spec)
946            (type list names fvars)
947            (type lexenv res))
948   (let ((type (compiler-specifier-type spec)))
949     (collect ((res nil cons))
950       (dolist (name names)
951         (let ((found (find name fvars
952                            :key #'leaf-source-name
953                            :test #'equal)))
954           (cond
955            (found
956             (setf (leaf-type found) type)
957             (assert-definition-type found type
958                                     :unwinnage-fun #'compiler-note
959                                     :where "FTYPE declaration"))
960            (t
961             (res (cons (find-lexically-apparent-fun
962                         name "in a function type declaration")
963                        type))))))
964       (if (res)
965           (make-lexenv :default res :type-restrictions (res))
966           res))))
967
968 ;;; Process a special declaration, returning a new LEXENV. A non-bound
969 ;;; special declaration is instantiated by throwing a special variable
970 ;;; into the variables.
971 (defun process-special-decl (spec res vars)
972   (declare (list spec vars) (type lexenv res))
973   (collect ((new-venv nil cons))
974     (dolist (name (cdr spec))
975       (let ((var (find-in-bindings vars name)))
976         (etypecase var
977           (cons
978            (aver (eq (car var) 'MACRO))
979            (compiler-error
980             "~S is a symbol-macro and thus can't be declared special."
981             name))
982           (lambda-var
983            (when (lambda-var-ignorep var)
984              ;; ANSI's definition for "Declaration IGNORE, IGNORABLE"
985              ;; requires that this be a STYLE-WARNING, not a full WARNING.
986              (compiler-style-warn
987               "The ignored variable ~S is being declared special."
988               name))
989            (setf (lambda-var-specvar var)
990                  (specvar-for-binding name)))
991           (null
992            (unless (assoc name (new-venv) :test #'eq)
993              (new-venv (cons name (specvar-for-binding name))))))))
994     (if (new-venv)
995         (make-lexenv :default res :vars (new-venv))
996         res)))
997
998 ;;; Return a DEFINED-FUN which copies a GLOBAL-VAR but for its INLINEP.
999 (defun make-new-inlinep (var inlinep)
1000   (declare (type global-var var) (type inlinep inlinep))
1001   (let ((res (make-defined-fun
1002               :%source-name (leaf-source-name var)
1003               :where-from (leaf-where-from var)
1004               :type (leaf-type var)
1005               :inlinep inlinep)))
1006     (when (defined-fun-p var)
1007       (setf (defined-fun-inline-expansion res)
1008             (defined-fun-inline-expansion var))
1009       (setf (defined-fun-functional res)
1010             (defined-fun-functional var)))
1011     res))
1012
1013 ;;; Parse an inline/notinline declaration. If it's a local function we're
1014 ;;; defining, set its INLINEP. If a global function, add a new FENV entry.
1015 (defun process-inline-decl (spec res fvars)
1016   (let ((sense (cdr (assoc (first spec) *inlinep-translations* :test #'eq)))
1017         (new-fenv ()))
1018     (dolist (name (rest spec))
1019       (let ((fvar (find name fvars
1020                         :key #'leaf-source-name
1021                         :test #'equal)))
1022         (if fvar
1023             (setf (functional-inlinep fvar) sense)
1024             (let ((found
1025                    (find-lexically-apparent-fun
1026                     name "in an inline or notinline declaration")))
1027               (etypecase found
1028                 (functional
1029                  (when (policy *lexenv* (>= speed inhibit-warnings))
1030                    (compiler-note "ignoring ~A declaration not at ~
1031                                    definition of local function:~%  ~S"
1032                                   sense name)))
1033                 (global-var
1034                  (push (cons name (make-new-inlinep found sense))
1035                        new-fenv)))))))
1036
1037     (if new-fenv
1038         (make-lexenv :default res :funs new-fenv)
1039         res)))
1040
1041 ;;; like FIND-IN-BINDINGS, but looks for #'FOO in the FVARS
1042 (defun find-in-bindings-or-fbindings (name vars fvars)
1043   (declare (list vars fvars))
1044   (if (consp name)
1045       (destructuring-bind (wot fn-name) name
1046         (unless (eq wot 'function)
1047           (compiler-error "The function or variable name ~S is unrecognizable."
1048                           name))
1049         (find fn-name fvars :key #'leaf-source-name :test #'equal))
1050       (find-in-bindings vars name)))
1051
1052 ;;; Process an ignore/ignorable declaration, checking for various losing
1053 ;;; conditions.
1054 (defun process-ignore-decl (spec vars fvars)
1055   (declare (list spec vars fvars))
1056   (dolist (name (rest spec))
1057     (let ((var (find-in-bindings-or-fbindings name vars fvars)))
1058       (cond
1059        ((not var)
1060         ;; ANSI's definition for "Declaration IGNORE, IGNORABLE"
1061         ;; requires that this be a STYLE-WARNING, not a full WARNING.
1062         (compiler-style-warn "declaring unknown variable ~S to be ignored"
1063                              name))
1064        ;; FIXME: This special case looks like non-ANSI weirdness.
1065        ((and (consp var) (consp (cdr var)) (eq (cadr var) 'macro))
1066         ;; Just ignore the IGNORE decl.
1067         )
1068        ((functional-p var)
1069         (setf (leaf-ever-used var) t))
1070        ((and (lambda-var-specvar var) (eq (first spec) 'ignore))
1071         ;; ANSI's definition for "Declaration IGNORE, IGNORABLE"
1072         ;; requires that this be a STYLE-WARNING, not a full WARNING.
1073         (compiler-style-warn "declaring special variable ~S to be ignored"
1074                              name))
1075        ((eq (first spec) 'ignorable)
1076         (setf (leaf-ever-used var) t))
1077        (t
1078         (setf (lambda-var-ignorep var) t)))))
1079   (values))
1080
1081 ;;; FIXME: This is non-ANSI, so the default should be T, or it should
1082 ;;; go away, I think.
1083 (defvar *suppress-values-declaration* nil
1084   #!+sb-doc
1085   "If true, processing of the VALUES declaration is inhibited.")
1086
1087 ;;; Process a single declaration spec, augmenting the specified LEXENV
1088 ;;; RES and returning it as a result. VARS and FVARS are as described in
1089 ;;; PROCESS-DECLS.
1090 (defun process-1-decl (raw-spec res vars fvars cont)
1091   (declare (type list raw-spec vars fvars))
1092   (declare (type lexenv res))
1093   (declare (type continuation cont))
1094   (let ((spec (canonized-decl-spec raw-spec)))
1095     (case (first spec)
1096       (special (process-special-decl spec res vars))
1097       (ftype
1098        (unless (cdr spec)
1099          (compiler-error "no type specified in FTYPE declaration: ~S" spec))
1100        (process-ftype-decl (second spec) res (cddr spec) fvars))
1101       ((inline notinline maybe-inline)
1102        (process-inline-decl spec res fvars))
1103       ((ignore ignorable)
1104        (process-ignore-decl spec vars fvars)
1105        res)
1106       (optimize
1107        (make-lexenv
1108         :default res
1109         :policy (process-optimize-decl spec (lexenv-policy res))))
1110       (type
1111        (process-type-decl (cdr spec) res vars))
1112       (values
1113        (if *suppress-values-declaration*
1114            res
1115            (let ((types (cdr spec)))
1116              (ir1ize-the-or-values (if (eql (length types) 1)
1117                                        (car types)
1118                                        `(values ,@types))
1119                                    cont
1120                                    res
1121                                    "in VALUES declaration"))))
1122       (dynamic-extent
1123        (when (policy *lexenv* (> speed inhibit-warnings))
1124          (compiler-note
1125           "compiler limitation: ~
1126         ~%  There's no special support for DYNAMIC-EXTENT (so it's ignored)."))
1127        res)
1128       (t
1129        (unless (info :declaration :recognized (first spec))
1130          (compiler-warn "unrecognized declaration ~S" raw-spec))
1131        res))))
1132
1133 ;;; Use a list of DECLARE forms to annotate the lists of LAMBDA-VAR
1134 ;;; and FUNCTIONAL structures which are being bound. In addition to
1135 ;;; filling in slots in the leaf structures, we return a new LEXENV
1136 ;;; which reflects pervasive special and function type declarations,
1137 ;;; (NOT)INLINE declarations and OPTIMIZE declarations. CONT is the
1138 ;;; continuation affected by VALUES declarations.
1139 ;;;
1140 ;;; This is also called in main.lisp when PROCESS-FORM handles a use
1141 ;;; of LOCALLY.
1142 (defun process-decls (decls vars fvars cont &optional (env *lexenv*))
1143   (declare (list decls vars fvars) (type continuation cont))
1144   (dolist (decl decls)
1145     (dolist (spec (rest decl))
1146       (unless (consp spec)
1147         (compiler-error "malformed declaration specifier ~S in ~S" spec decl))
1148       (setq env (process-1-decl spec env vars fvars cont))))
1149   env)
1150
1151 ;;; Return the SPECVAR for NAME to use when we see a local SPECIAL
1152 ;;; declaration. If there is a global variable of that name, then
1153 ;;; check that it isn't a constant and return it. Otherwise, create an
1154 ;;; anonymous GLOBAL-VAR.
1155 (defun specvar-for-binding (name)
1156   (cond ((not (eq (info :variable :where-from name) :assumed))
1157          (let ((found (find-free-var name)))
1158            (when (heap-alien-info-p found)
1159              (compiler-error
1160               "~S is an alien variable and so can't be declared special."
1161               name))
1162            (unless (global-var-p found)
1163              (compiler-error
1164               "~S is a constant and so can't be declared special."
1165               name))
1166            found))
1167         (t
1168          (make-global-var :kind :special
1169                           :%source-name name
1170                           :where-from :declared))))
1171 \f
1172 ;;;; LAMBDA hackery
1173
1174 ;;;; Note: Take a look at the compiler-overview.tex section on "Hairy
1175 ;;;; function representation" before you seriously mess with this
1176 ;;;; stuff.
1177
1178 ;;; Verify that the NAME is a legal name for a variable and return a
1179 ;;; VAR structure for it, filling in info if it is globally special.
1180 ;;; If it is losing, we punt with a COMPILER-ERROR. NAMES-SO-FAR is a
1181 ;;; list of names which have previously been bound. If the NAME is in
1182 ;;; this list, then we error out.
1183 (declaim (ftype (function (t list) lambda-var) varify-lambda-arg))
1184 (defun varify-lambda-arg (name names-so-far)
1185   (declare (inline member))
1186   (unless (symbolp name)
1187     (compiler-error "The lambda variable ~S is not a symbol." name))
1188   (when (member name names-so-far :test #'eq)
1189     (compiler-error "The variable ~S occurs more than once in the lambda list."
1190                     name))
1191   (let ((kind (info :variable :kind name)))
1192     (when (or (keywordp name) (eq kind :constant))
1193       (compiler-error "The name of the lambda variable ~S is already in use to name a constant."
1194                       name))
1195     (cond ((eq kind :special)
1196            (let ((specvar (find-free-var name)))
1197              (make-lambda-var :%source-name name
1198                               :type (leaf-type specvar)
1199                               :where-from (leaf-where-from specvar)
1200                               :specvar specvar)))
1201           (t
1202            (make-lambda-var :%source-name name)))))
1203
1204 ;;; Make the default keyword for a &KEY arg, checking that the keyword
1205 ;;; isn't already used by one of the VARS.
1206 (declaim (ftype (function (symbol list t) keyword) make-keyword-for-arg))
1207 (defun make-keyword-for-arg (symbol vars keywordify)
1208   (let ((key (if (and keywordify (not (keywordp symbol)))
1209                  (keywordicate symbol)
1210                  symbol)))
1211     (dolist (var vars)
1212       (let ((info (lambda-var-arg-info var)))
1213         (when (and info
1214                    (eq (arg-info-kind info) :keyword)
1215                    (eq (arg-info-key info) key))
1216           (compiler-error
1217            "The keyword ~S appears more than once in the lambda list."
1218            key))))
1219     key))
1220
1221 ;;; Parse a lambda list into a list of VAR structures, stripping off
1222 ;;; any &AUX bindings. Each arg name is checked for legality, and
1223 ;;; duplicate names are checked for. If an arg is globally special,
1224 ;;; the var is marked as :SPECIAL instead of :LEXICAL. &KEY,
1225 ;;; &OPTIONAL and &REST args are annotated with an ARG-INFO structure
1226 ;;; which contains the extra information. If we hit something losing,
1227 ;;; we bug out with COMPILER-ERROR. These values are returned:
1228 ;;;  1. a list of the var structures for each top level argument;
1229 ;;;  2. a flag indicating whether &KEY was specified;
1230 ;;;  3. a flag indicating whether other &KEY args are allowed;
1231 ;;;  4. a list of the &AUX variables; and
1232 ;;;  5. a list of the &AUX values.
1233 (declaim (ftype (function (list) (values list boolean boolean list list))
1234                 make-lambda-vars))
1235 (defun make-lambda-vars (list)
1236   (multiple-value-bind (required optional restp rest keyp keys allowp auxp aux
1237                         morep more-context more-count)
1238       (parse-lambda-list list)
1239     (declare (ignore auxp)) ; since we just iterate over AUX regardless
1240     (collect ((vars)
1241               (names-so-far)
1242               (aux-vars)
1243               (aux-vals))
1244       (flet (;; PARSE-DEFAULT deals with defaults and supplied-p args
1245              ;; for optionals and keywords args.
1246              (parse-default (spec info)
1247                (when (consp (cdr spec))
1248                  (setf (arg-info-default info) (second spec))
1249                  (when (consp (cddr spec))
1250                    (let* ((supplied-p (third spec))
1251                           (supplied-var (varify-lambda-arg supplied-p
1252                                                            (names-so-far))))
1253                      (setf (arg-info-supplied-p info) supplied-var)
1254                      (names-so-far supplied-p)
1255                      (when (> (length (the list spec)) 3)
1256                        (compiler-error
1257                         "The list ~S is too long to be an arg specifier."
1258                         spec)))))))
1259         
1260         (dolist (name required)
1261           (let ((var (varify-lambda-arg name (names-so-far))))
1262             (vars var)
1263             (names-so-far name)))
1264         
1265         (dolist (spec optional)
1266           (if (atom spec)
1267               (let ((var (varify-lambda-arg spec (names-so-far))))
1268                 (setf (lambda-var-arg-info var)
1269                       (make-arg-info :kind :optional))
1270                 (vars var)
1271                 (names-so-far spec))
1272               (let* ((name (first spec))
1273                      (var (varify-lambda-arg name (names-so-far)))
1274                      (info (make-arg-info :kind :optional)))
1275                 (setf (lambda-var-arg-info var) info)
1276                 (vars var)
1277                 (names-so-far name)
1278                 (parse-default spec info))))
1279         
1280         (when restp
1281           (let ((var (varify-lambda-arg rest (names-so-far))))
1282             (setf (lambda-var-arg-info var) (make-arg-info :kind :rest))
1283             (vars var)
1284             (names-so-far rest)))
1285
1286         (when morep
1287           (let ((var (varify-lambda-arg more-context (names-so-far))))
1288             (setf (lambda-var-arg-info var)
1289                   (make-arg-info :kind :more-context))
1290             (vars var)
1291             (names-so-far more-context))
1292           (let ((var (varify-lambda-arg more-count (names-so-far))))
1293             (setf (lambda-var-arg-info var)
1294                   (make-arg-info :kind :more-count))
1295             (vars var)
1296             (names-so-far more-count)))
1297         
1298         (dolist (spec keys)
1299           (cond
1300            ((atom spec)
1301             (let ((var (varify-lambda-arg spec (names-so-far))))
1302               (setf (lambda-var-arg-info var)
1303                     (make-arg-info :kind :keyword
1304                                    :key (make-keyword-for-arg spec
1305                                                               (vars)
1306                                                               t)))
1307               (vars var)
1308               (names-so-far spec)))
1309            ((atom (first spec))
1310             (let* ((name (first spec))
1311                    (var (varify-lambda-arg name (names-so-far)))
1312                    (info (make-arg-info
1313                           :kind :keyword
1314                           :key (make-keyword-for-arg name (vars) t))))
1315               (setf (lambda-var-arg-info var) info)
1316               (vars var)
1317               (names-so-far name)
1318               (parse-default spec info)))
1319            (t
1320             (let ((head (first spec)))
1321               (unless (proper-list-of-length-p head 2)
1322                 (error "malformed &KEY argument specifier: ~S" spec))
1323               (let* ((name (second head))
1324                      (var (varify-lambda-arg name (names-so-far)))
1325                      (info (make-arg-info
1326                             :kind :keyword
1327                             :key (make-keyword-for-arg (first head)
1328                                                        (vars)
1329                                                        nil))))
1330                 (setf (lambda-var-arg-info var) info)
1331                 (vars var)
1332                 (names-so-far name)
1333                 (parse-default spec info))))))
1334         
1335         (dolist (spec aux)
1336           (cond ((atom spec)
1337                  (let ((var (varify-lambda-arg spec nil)))
1338                    (aux-vars var)
1339                    (aux-vals nil)
1340                    (names-so-far spec)))
1341                 (t
1342                  (unless (proper-list-of-length-p spec 1 2)
1343                    (compiler-error "malformed &AUX binding specifier: ~S"
1344                                    spec))
1345                  (let* ((name (first spec))
1346                         (var (varify-lambda-arg name nil)))
1347                    (aux-vars var)
1348                    (aux-vals (second spec))
1349                    (names-so-far name)))))
1350
1351         (values (vars) keyp allowp (aux-vars) (aux-vals))))))
1352
1353 ;;; This is similar to IR1-CONVERT-PROGN-BODY except that we
1354 ;;; sequentially bind each AUX-VAR to the corresponding AUX-VAL before
1355 ;;; converting the body. If there are no bindings, just convert the
1356 ;;; body, otherwise do one binding and recurse on the rest.
1357 ;;;
1358 ;;; FIXME: This could and probably should be converted to use
1359 ;;; SOURCE-NAME and DEBUG-NAME. But I (WHN) don't use &AUX bindings,
1360 ;;; so I'm not motivated. Patches will be accepted...
1361 (defun ir1-convert-aux-bindings (start cont body aux-vars aux-vals)
1362   (declare (type continuation start cont) (list body aux-vars aux-vals))
1363   (if (null aux-vars)
1364       (ir1-convert-progn-body start cont body)
1365       (let ((fun-cont (make-continuation))
1366             (fun (ir1-convert-lambda-body body
1367                                           (list (first aux-vars))
1368                                           :aux-vars (rest aux-vars)
1369                                           :aux-vals (rest aux-vals)
1370                                           :debug-name (debug-namify
1371                                                        "&AUX bindings ~S"
1372                                                        aux-vars))))
1373         (reference-leaf start fun-cont fun)
1374         (ir1-convert-combination-args fun-cont cont
1375                                       (list (first aux-vals)))))
1376   (values))
1377
1378 ;;; This is similar to IR1-CONVERT-PROGN-BODY except that code to bind
1379 ;;; the SPECVAR for each SVAR to the value of the variable is wrapped
1380 ;;; around the body. If there are no special bindings, we just convert
1381 ;;; the body, otherwise we do one special binding and recurse on the
1382 ;;; rest.
1383 ;;;
1384 ;;; We make a cleanup and introduce it into the lexical environment.
1385 ;;; If there are multiple special bindings, the cleanup for the blocks
1386 ;;; will end up being the innermost one. We force CONT to start a
1387 ;;; block outside of this cleanup, causing cleanup code to be emitted
1388 ;;; when the scope is exited.
1389 (defun ir1-convert-special-bindings (start cont body aux-vars aux-vals svars)
1390   (declare (type continuation start cont)
1391            (list body aux-vars aux-vals svars))
1392   (cond
1393    ((null svars)
1394     (ir1-convert-aux-bindings start cont body aux-vars aux-vals))
1395    (t
1396     (continuation-starts-block cont)
1397     (let ((cleanup (make-cleanup :kind :special-bind))
1398           (var (first svars))
1399           (next-cont (make-continuation))
1400           (nnext-cont (make-continuation)))
1401       (ir1-convert start next-cont
1402                    `(%special-bind ',(lambda-var-specvar var) ,var))
1403       (setf (cleanup-mess-up cleanup) (continuation-use next-cont))
1404       (let ((*lexenv* (make-lexenv :cleanup cleanup)))
1405         (ir1-convert next-cont nnext-cont '(%cleanup-point))
1406         (ir1-convert-special-bindings nnext-cont cont body aux-vars aux-vals
1407                                       (rest svars))))))
1408   (values))
1409
1410 ;;; Create a lambda node out of some code, returning the result. The
1411 ;;; bindings are specified by the list of VAR structures VARS. We deal
1412 ;;; with adding the names to the LEXENV-VARS for the conversion. The
1413 ;;; result is added to the NEW-FUNCTIONALS in the *CURRENT-COMPONENT*
1414 ;;; and linked to the component head and tail.
1415 ;;;
1416 ;;; We detect special bindings here, replacing the original VAR in the
1417 ;;; lambda list with a temporary variable. We then pass a list of the
1418 ;;; special vars to IR1-CONVERT-SPECIAL-BINDINGS, which actually emits
1419 ;;; the special binding code.
1420 ;;;
1421 ;;; We ignore any ARG-INFO in the VARS, trusting that someone else is
1422 ;;; dealing with &nonsense.
1423 ;;;
1424 ;;; AUX-VARS is a list of VAR structures for variables that are to be
1425 ;;; sequentially bound. Each AUX-VAL is a form that is to be evaluated
1426 ;;; to get the initial value for the corresponding AUX-VAR. 
1427 (defun ir1-convert-lambda-body (body
1428                                 vars
1429                                 &key
1430                                 aux-vars
1431                                 aux-vals
1432                                 result
1433                                 (source-name '.anonymous.)
1434                                 debug-name)
1435   (declare (list body vars aux-vars aux-vals)
1436            (type (or continuation null) result))
1437
1438   ;; We're about to try to put new blocks into *CURRENT-COMPONENT*.
1439   (aver-live-component *current-component*)
1440
1441   (let* ((bind (make-bind))
1442          (lambda (make-lambda :vars vars
1443                               :bind bind
1444                               :%source-name source-name
1445                               :%debug-name debug-name))
1446          (result (or result (make-continuation))))
1447
1448     ;; just to check: This function should fail internal assertions if
1449     ;; we didn't set up a valid debug name above.
1450     ;;
1451     ;; (In SBCL we try to make everything have a debug name, since we
1452     ;; lack the omniscient perspective the original implementors used
1453     ;; to decide which things didn't need one.)
1454     (functional-debug-name lambda)
1455
1456     (setf (lambda-home lambda) lambda)
1457     (collect ((svars)
1458               (new-venv nil cons))
1459
1460       (dolist (var vars)
1461         ;; As far as I can see, LAMBDA-VAR-HOME should never have
1462         ;; been set before. Let's make sure. -- WHN 2001-09-29
1463         (aver (null (lambda-var-home var)))
1464         (setf (lambda-var-home var) lambda)
1465         (let ((specvar (lambda-var-specvar var)))
1466           (cond (specvar
1467                  (svars var)
1468                  (new-venv (cons (leaf-source-name specvar) specvar)))
1469                 (t
1470                  (note-lexical-binding (leaf-source-name var))
1471                  (new-venv (cons (leaf-source-name var) var))))))
1472
1473       (let ((*lexenv* (make-lexenv :vars (new-venv)
1474                                    :lambda lambda
1475                                    :cleanup nil)))
1476         (setf (bind-lambda bind) lambda)
1477         (setf (node-lexenv bind) *lexenv*)
1478         
1479         (let ((cont1 (make-continuation))
1480               (cont2 (make-continuation)))
1481           (continuation-starts-block cont1)
1482           (link-node-to-previous-continuation bind cont1)
1483           (use-continuation bind cont2)
1484           (ir1-convert-special-bindings cont2 result body
1485                                         aux-vars aux-vals (svars)))
1486
1487         (let ((block (continuation-block result)))
1488           (when block
1489             (let ((return (make-return :result result :lambda lambda))
1490                   (tail-set (make-tail-set :funs (list lambda)))
1491                   (dummy (make-continuation)))
1492               (setf (lambda-tail-set lambda) tail-set)
1493               (setf (lambda-return lambda) return)
1494               (setf (continuation-dest result) return)
1495               (setf (continuation-%externally-checkable-type result) nil)
1496               (setf (block-last block) return)
1497               (link-node-to-previous-continuation return result)
1498               (use-continuation return dummy))
1499             (link-blocks block (component-tail *current-component*))))))
1500
1501     (link-blocks (component-head *current-component*) (node-block bind))
1502     (push lambda (component-new-functionals *current-component*))
1503
1504     lambda))
1505
1506 ;;; Create the actual entry-point function for an optional entry
1507 ;;; point. The lambda binds copies of each of the VARS, then calls FUN
1508 ;;; with the argument VALS and the DEFAULTS. Presumably the VALS refer
1509 ;;; to the VARS by name. The VALS are passed in in reverse order.
1510 ;;;
1511 ;;; If any of the copies of the vars are referenced more than once,
1512 ;;; then we mark the corresponding var as EVER-USED to inhibit
1513 ;;; "defined but not read" warnings for arguments that are only used
1514 ;;; by default forms.
1515 (defun convert-optional-entry (fun vars vals defaults)
1516   (declare (type clambda fun) (list vars vals defaults))
1517   (let* ((fvars (reverse vars))
1518          (arg-vars (mapcar (lambda (var)
1519                              (unless (lambda-var-specvar var)
1520                                (note-lexical-binding (leaf-source-name var)))
1521                              (make-lambda-var
1522                               :%source-name (leaf-source-name var)
1523                               :type (leaf-type var)
1524                               :where-from (leaf-where-from var)
1525                               :specvar (lambda-var-specvar var)))
1526                            fvars))
1527          (fun (ir1-convert-lambda-body `((%funcall ,fun
1528                                                    ,@(reverse vals)
1529                                                    ,@defaults))
1530                                        arg-vars
1531                                        :debug-name "&OPTIONAL processor")))
1532     (mapc (lambda (var arg-var)
1533             (when (cdr (leaf-refs arg-var))
1534               (setf (leaf-ever-used var) t)))
1535           fvars arg-vars)
1536     fun))
1537
1538 ;;; This function deals with supplied-p vars in optional arguments. If
1539 ;;; the there is no supplied-p arg, then we just call
1540 ;;; IR1-CONVERT-HAIRY-ARGS on the remaining arguments, and generate a
1541 ;;; optional entry that calls the result. If there is a supplied-p
1542 ;;; var, then we add it into the default vars and throw a T into the
1543 ;;; entry values. The resulting entry point function is returned.
1544 (defun generate-optional-default-entry (res default-vars default-vals
1545                                             entry-vars entry-vals
1546                                             vars supplied-p-p body
1547                                             aux-vars aux-vals cont
1548                                             source-name debug-name)
1549   (declare (type optional-dispatch res)
1550            (list default-vars default-vals entry-vars entry-vals vars body
1551                  aux-vars aux-vals)
1552            (type (or continuation null) cont))
1553   (let* ((arg (first vars))
1554          (arg-name (leaf-source-name arg))
1555          (info (lambda-var-arg-info arg))
1556          (supplied-p (arg-info-supplied-p info))
1557          (ep (if supplied-p
1558                  (ir1-convert-hairy-args
1559                   res
1560                   (list* supplied-p arg default-vars)
1561                   (list* (leaf-source-name supplied-p) arg-name default-vals)
1562                   (cons arg entry-vars)
1563                   (list* t arg-name entry-vals)
1564                   (rest vars) t body aux-vars aux-vals cont
1565                   source-name debug-name)
1566                  (ir1-convert-hairy-args
1567                   res
1568                   (cons arg default-vars)
1569                   (cons arg-name default-vals)
1570                   (cons arg entry-vars)
1571                   (cons arg-name entry-vals)
1572                   (rest vars) supplied-p-p body aux-vars aux-vals cont
1573                   source-name debug-name))))
1574
1575     (convert-optional-entry ep default-vars default-vals
1576                             (if supplied-p
1577                                 (list (arg-info-default info) nil)
1578                                 (list (arg-info-default info))))))
1579
1580 ;;; Create the MORE-ENTRY function for the OPTIONAL-DISPATCH RES.
1581 ;;; ENTRY-VARS and ENTRY-VALS describe the fixed arguments. REST is
1582 ;;; the var for any &REST arg. KEYS is a list of the &KEY arg vars.
1583 ;;;
1584 ;;; The most interesting thing that we do is parse keywords. We create
1585 ;;; a bunch of temporary variables to hold the result of the parse,
1586 ;;; and then loop over the supplied arguments, setting the appropriate
1587 ;;; temps for the supplied keyword. Note that it is significant that
1588 ;;; we iterate over the keywords in reverse order --- this implements
1589 ;;; the CL requirement that (when a keyword appears more than once)
1590 ;;; the first value is used.
1591 ;;;
1592 ;;; If there is no supplied-p var, then we initialize the temp to the
1593 ;;; default and just pass the temp into the main entry. Since
1594 ;;; non-constant &KEY args are forcibly given a supplied-p var, we
1595 ;;; know that the default is constant, and thus safe to evaluate out
1596 ;;; of order.
1597 ;;;
1598 ;;; If there is a supplied-p var, then we create temps for both the
1599 ;;; value and the supplied-p, and pass them into the main entry,
1600 ;;; letting it worry about defaulting.
1601 ;;;
1602 ;;; We deal with :ALLOW-OTHER-KEYS by delaying unknown keyword errors
1603 ;;; until we have scanned all the keywords.
1604 (defun convert-more-entry (res entry-vars entry-vals rest morep keys)
1605   (declare (type optional-dispatch res) (list entry-vars entry-vals keys))
1606   (collect ((arg-vars)
1607             (arg-vals (reverse entry-vals))
1608             (temps)
1609             (body))
1610
1611     (dolist (var (reverse entry-vars))
1612       (arg-vars (make-lambda-var :%source-name (leaf-source-name var)
1613                                  :type (leaf-type var)
1614                                  :where-from (leaf-where-from var))))
1615
1616     (let* ((n-context (gensym "N-CONTEXT-"))
1617            (context-temp (make-lambda-var :%source-name n-context))
1618            (n-count (gensym "N-COUNT-"))
1619            (count-temp (make-lambda-var :%source-name n-count
1620                                         :type (specifier-type 'index))))
1621
1622       (arg-vars context-temp count-temp)
1623
1624       (when rest
1625         (arg-vals `(%listify-rest-args ,n-context ,n-count)))
1626       (when morep
1627         (arg-vals n-context)
1628         (arg-vals n-count))
1629
1630       (when (optional-dispatch-keyp res)
1631         (let ((n-index (gensym "N-INDEX-"))
1632               (n-key (gensym "N-KEY-"))
1633               (n-value-temp (gensym "N-VALUE-TEMP-"))
1634               (n-allowp (gensym "N-ALLOWP-"))
1635               (n-losep (gensym "N-LOSEP-"))
1636               (allowp (or (optional-dispatch-allowp res)
1637                           (policy *lexenv* (zerop safety))))
1638               (found-allow-p nil))
1639
1640           (temps `(,n-index (1- ,n-count)) n-key n-value-temp)
1641           (body `(declare (fixnum ,n-index) (ignorable ,n-key ,n-value-temp)))
1642
1643           (collect ((tests))
1644             (dolist (key keys)
1645               (let* ((info (lambda-var-arg-info key))
1646                      (default (arg-info-default info))
1647                      (keyword (arg-info-key info))
1648                      (supplied-p (arg-info-supplied-p info))
1649                      (n-value (gensym "N-VALUE-"))
1650                      (clause (cond (supplied-p
1651                                     (let ((n-supplied (gensym "N-SUPPLIED-")))
1652                                       (temps n-supplied)
1653                                       (arg-vals n-value n-supplied)
1654                                       `((eq ,n-key ',keyword)
1655                                         (setq ,n-supplied t)
1656                                         (setq ,n-value ,n-value-temp))))
1657                                    (t
1658                                     (arg-vals n-value)
1659                                     `((eq ,n-key ',keyword)
1660                                       (setq ,n-value ,n-value-temp))))))
1661                 (when (and (not allowp) (eq keyword :allow-other-keys))
1662                   (setq found-allow-p t)
1663                   (setq clause
1664                         (append clause `((setq ,n-allowp ,n-value-temp)))))
1665
1666                 (temps `(,n-value ,default))
1667                 (tests clause)))
1668
1669             (unless allowp
1670               (temps n-allowp n-losep)
1671               (unless found-allow-p
1672                 (tests `((eq ,n-key :allow-other-keys)
1673                          (setq ,n-allowp ,n-value-temp))))
1674               (tests `(t
1675                        (setq ,n-losep ,n-key))))
1676
1677             (body
1678              `(when (oddp ,n-count)
1679                 (%odd-key-args-error)))
1680
1681             (body
1682              `(locally
1683                 (declare (optimize (safety 0)))
1684                 (loop
1685                   (when (minusp ,n-index) (return))
1686                   (setf ,n-value-temp (%more-arg ,n-context ,n-index))
1687                   (decf ,n-index)
1688                   (setq ,n-key (%more-arg ,n-context ,n-index))
1689                   (decf ,n-index)
1690                   (cond ,@(tests)))))
1691
1692             (unless allowp
1693               (body `(when (and ,n-losep (not ,n-allowp))
1694                        (%unknown-key-arg-error ,n-losep)))))))
1695
1696       (let ((ep (ir1-convert-lambda-body
1697                  `((let ,(temps)
1698                      ,@(body)
1699                      (%funcall ,(optional-dispatch-main-entry res)
1700                                . ,(arg-vals)))) ; FIXME: What is the '.'? ,@?
1701                  (arg-vars)
1702                  :debug-name (debug-namify "~S processing" '&more))))
1703         (setf (optional-dispatch-more-entry res) ep))))
1704
1705   (values))
1706
1707 ;;; This is called by IR1-CONVERT-HAIRY-ARGS when we run into a &REST
1708 ;;; or &KEY arg. The arguments are similar to that function, but we
1709 ;;; split off any &REST arg and pass it in separately. REST is the
1710 ;;; &REST arg var, or NIL if there is no &REST arg. KEYS is a list of
1711 ;;; the &KEY argument vars.
1712 ;;;
1713 ;;; When there are &KEY arguments, we introduce temporary gensym
1714 ;;; variables to hold the values while keyword defaulting is in
1715 ;;; progress to get the required sequential binding semantics.
1716 ;;;
1717 ;;; This gets interesting mainly when there are &KEY arguments with
1718 ;;; supplied-p vars or non-constant defaults. In either case, pass in
1719 ;;; a supplied-p var. If the default is non-constant, we introduce an
1720 ;;; IF in the main entry that tests the supplied-p var and decides
1721 ;;; whether to evaluate the default or not. In this case, the real
1722 ;;; incoming value is NIL, so we must union NULL with the declared
1723 ;;; type when computing the type for the main entry's argument.
1724 (defun ir1-convert-more (res default-vars default-vals entry-vars entry-vals
1725                              rest more-context more-count keys supplied-p-p
1726                              body aux-vars aux-vals cont
1727                              source-name debug-name)
1728   (declare (type optional-dispatch res)
1729            (list default-vars default-vals entry-vars entry-vals keys body
1730                  aux-vars aux-vals)
1731            (type (or continuation null) cont))
1732   (collect ((main-vars (reverse default-vars))
1733             (main-vals default-vals cons)
1734             (bind-vars)
1735             (bind-vals))
1736     (when rest
1737       (main-vars rest)
1738       (main-vals '()))
1739     (when more-context
1740       (main-vars more-context)
1741       (main-vals nil)
1742       (main-vars more-count)
1743       (main-vals 0))
1744
1745     (dolist (key keys)
1746       (let* ((info (lambda-var-arg-info key))
1747              (default (arg-info-default info))
1748              (hairy-default (not (sb!xc:constantp default)))
1749              (supplied-p (arg-info-supplied-p info))
1750              (n-val (make-symbol (format nil
1751                                          "~A-DEFAULTING-TEMP"
1752                                          (leaf-source-name key))))
1753              (key-type (leaf-type key))
1754              (val-temp (make-lambda-var
1755                         :%source-name n-val
1756                         :type (if hairy-default
1757                                   (type-union key-type (specifier-type 'null))
1758                                   key-type))))
1759         (main-vars val-temp)
1760         (bind-vars key)
1761         (cond ((or hairy-default supplied-p)
1762                (let* ((n-supplied (gensym "N-SUPPLIED-"))
1763                       (supplied-temp (make-lambda-var
1764                                       :%source-name n-supplied)))
1765                  (unless supplied-p
1766                    (setf (arg-info-supplied-p info) supplied-temp))
1767                  (when hairy-default
1768                    (setf (arg-info-default info) nil))
1769                  (main-vars supplied-temp)
1770                  (cond (hairy-default
1771                         (main-vals nil nil)
1772                         (bind-vals `(if ,n-supplied ,n-val ,default)))
1773                        (t
1774                         (main-vals default nil)
1775                         (bind-vals n-val)))
1776                  (when supplied-p
1777                    (bind-vars supplied-p)
1778                    (bind-vals n-supplied))))
1779               (t
1780                (main-vals (arg-info-default info))
1781                (bind-vals n-val)))))
1782
1783     (let* ((main-entry (ir1-convert-lambda-body
1784                         body (main-vars)
1785                         :aux-vars (append (bind-vars) aux-vars)
1786                         :aux-vals (append (bind-vals) aux-vals)
1787                         :result cont
1788                         :debug-name (debug-namify "varargs entry for ~A"
1789                                                   (as-debug-name source-name
1790                                                                  debug-name))))
1791            (last-entry (convert-optional-entry main-entry default-vars
1792                                                (main-vals) ())))
1793       (setf (optional-dispatch-main-entry res) main-entry)
1794       (convert-more-entry res entry-vars entry-vals rest more-context keys)
1795
1796       (push (if supplied-p-p
1797                 (convert-optional-entry last-entry entry-vars entry-vals ())
1798                 last-entry)
1799             (optional-dispatch-entry-points res))
1800       last-entry)))
1801
1802 ;;; This function generates the entry point functions for the
1803 ;;; OPTIONAL-DISPATCH RES. We accomplish this by recursion on the list
1804 ;;; of arguments, analyzing the arglist on the way down and generating
1805 ;;; entry points on the way up.
1806 ;;;
1807 ;;; DEFAULT-VARS is a reversed list of all the argument vars processed
1808 ;;; so far, including supplied-p vars. DEFAULT-VALS is a list of the
1809 ;;; names of the DEFAULT-VARS.
1810 ;;;
1811 ;;; ENTRY-VARS is a reversed list of processed argument vars,
1812 ;;; excluding supplied-p vars. ENTRY-VALS is a list things that can be
1813 ;;; evaluated to get the values for all the vars from the ENTRY-VARS.
1814 ;;; It has the var name for each required or optional arg, and has T
1815 ;;; for each supplied-p arg.
1816 ;;;
1817 ;;; VARS is a list of the LAMBDA-VAR structures for arguments that
1818 ;;; haven't been processed yet. SUPPLIED-P-P is true if a supplied-p
1819 ;;; argument has already been processed; only in this case are the
1820 ;;; DEFAULT-XXX and ENTRY-XXX different.
1821 ;;;
1822 ;;; The result at each point is a lambda which should be called by the
1823 ;;; above level to default the remaining arguments and evaluate the
1824 ;;; body. We cause the body to be evaluated by converting it and
1825 ;;; returning it as the result when the recursion bottoms out.
1826 ;;;
1827 ;;; Each level in the recursion also adds its entry point function to
1828 ;;; the result OPTIONAL-DISPATCH. For most arguments, the defaulting
1829 ;;; function and the entry point function will be the same, but when
1830 ;;; SUPPLIED-P args are present they may be different.
1831 ;;;
1832 ;;; When we run into a &REST or &KEY arg, we punt out to
1833 ;;; IR1-CONVERT-MORE, which finishes for us in this case.
1834 (defun ir1-convert-hairy-args (res default-vars default-vals
1835                                    entry-vars entry-vals
1836                                    vars supplied-p-p body aux-vars
1837                                    aux-vals cont
1838                                    source-name debug-name)
1839   (declare (type optional-dispatch res)
1840            (list default-vars default-vals entry-vars entry-vals vars body
1841                  aux-vars aux-vals)
1842            (type (or continuation null) cont))
1843   (cond ((not vars)
1844          (if (optional-dispatch-keyp res)
1845              ;; Handle &KEY with no keys...
1846              (ir1-convert-more res default-vars default-vals
1847                                entry-vars entry-vals
1848                                nil nil nil vars supplied-p-p body aux-vars
1849                                aux-vals cont source-name debug-name)
1850              (let ((fun (ir1-convert-lambda-body
1851                          body (reverse default-vars)
1852                          :aux-vars aux-vars
1853                          :aux-vals aux-vals
1854                          :result cont
1855                          :debug-name (debug-namify
1856                                       "hairy arg processor for ~A"
1857                                       (as-debug-name source-name
1858                                                      debug-name)))))
1859                (setf (optional-dispatch-main-entry res) fun)
1860                (push (if supplied-p-p
1861                          (convert-optional-entry fun entry-vars entry-vals ())
1862                          fun)
1863                      (optional-dispatch-entry-points res))
1864                fun)))
1865         ((not (lambda-var-arg-info (first vars)))
1866          (let* ((arg (first vars))
1867                 (nvars (cons arg default-vars))
1868                 (nvals (cons (leaf-source-name arg) default-vals)))
1869            (ir1-convert-hairy-args res nvars nvals nvars nvals
1870                                    (rest vars) nil body aux-vars aux-vals
1871                                    cont
1872                                    source-name debug-name)))
1873         (t
1874          (let* ((arg (first vars))
1875                 (info (lambda-var-arg-info arg))
1876                 (kind (arg-info-kind info)))
1877            (ecase kind
1878              (:optional
1879               (let ((ep (generate-optional-default-entry
1880                          res default-vars default-vals
1881                          entry-vars entry-vals vars supplied-p-p body
1882                          aux-vars aux-vals cont
1883                          source-name debug-name)))
1884                 (push (if supplied-p-p
1885                           (convert-optional-entry ep entry-vars entry-vals ())
1886                           ep)
1887                       (optional-dispatch-entry-points res))
1888                 ep))
1889              (:rest
1890               (ir1-convert-more res default-vars default-vals
1891                                 entry-vars entry-vals
1892                                 arg nil nil (rest vars) supplied-p-p body
1893                                 aux-vars aux-vals cont
1894                                 source-name debug-name))
1895              (:more-context
1896               (ir1-convert-more res default-vars default-vals
1897                                 entry-vars entry-vals
1898                                 nil arg (second vars) (cddr vars) supplied-p-p
1899                                 body aux-vars aux-vals cont
1900                                 source-name debug-name))
1901              (:keyword
1902               (ir1-convert-more res default-vars default-vals
1903                                 entry-vars entry-vals
1904                                 nil nil nil vars supplied-p-p body aux-vars
1905                                 aux-vals cont source-name debug-name)))))))
1906
1907 ;;; This function deals with the case where we have to make an
1908 ;;; OPTIONAL-DISPATCH to represent a LAMBDA. We cons up the result and
1909 ;;; call IR1-CONVERT-HAIRY-ARGS to do the work. When it is done, we
1910 ;;; figure out the MIN-ARGS and MAX-ARGS.
1911 (defun ir1-convert-hairy-lambda (body vars keyp allowp aux-vars aux-vals cont
1912                                       &key
1913                                       (source-name '.anonymous.)
1914                                       (debug-name (debug-namify
1915                                                    "OPTIONAL-DISPATCH ~S"
1916                                                    vars)))
1917   (declare (list body vars aux-vars aux-vals) (type continuation cont))
1918   (let ((res (make-optional-dispatch :arglist vars
1919                                      :allowp allowp
1920                                      :keyp keyp
1921                                      :%source-name source-name
1922                                      :%debug-name debug-name))
1923         (min (or (position-if #'lambda-var-arg-info vars) (length vars))))
1924     (aver-live-component *current-component*)
1925     (push res (component-new-functionals *current-component*))
1926     (ir1-convert-hairy-args res () () () () vars nil body aux-vars aux-vals
1927                             cont source-name debug-name)
1928     (setf (optional-dispatch-min-args res) min)
1929     (setf (optional-dispatch-max-args res)
1930           (+ (1- (length (optional-dispatch-entry-points res))) min))
1931
1932     (flet ((frob (ep)
1933              (when ep
1934                (setf (functional-kind ep) :optional)
1935                (setf (leaf-ever-used ep) t)
1936                (setf (lambda-optional-dispatch ep) res))))
1937       (dolist (ep (optional-dispatch-entry-points res)) (frob ep))
1938       (frob (optional-dispatch-more-entry res))
1939       (frob (optional-dispatch-main-entry res)))
1940
1941     res))
1942
1943 ;;; Convert a LAMBDA form into a LAMBDA leaf or an OPTIONAL-DISPATCH leaf.
1944 (defun ir1-convert-lambda (form &key (source-name '.anonymous.) debug-name)
1945
1946   (unless (consp form)
1947     (compiler-error "A ~S was found when expecting a lambda expression:~%  ~S"
1948                     (type-of form)
1949                     form))
1950   (unless (eq (car form) 'lambda)
1951     (compiler-error "~S was expected but ~S was found:~%  ~S"
1952                     'lambda
1953                     (car form)
1954                     form))
1955   (unless (and (consp (cdr form)) (listp (cadr form)))
1956     (compiler-error
1957      "The lambda expression has a missing or non-list lambda list:~%  ~S"
1958      form))
1959
1960   (multiple-value-bind (vars keyp allow-other-keys aux-vars aux-vals)
1961       (make-lambda-vars (cadr form))
1962     (multiple-value-bind (forms decls) (parse-body (cddr form))
1963       (let* ((result-cont (make-continuation))
1964              (*lexenv* (process-decls decls
1965                                       (append aux-vars vars)
1966                                       nil result-cont))
1967              (res (if (or (find-if #'lambda-var-arg-info vars) keyp)
1968                       (ir1-convert-hairy-lambda forms vars keyp
1969                                                 allow-other-keys
1970                                                 aux-vars aux-vals result-cont
1971                                                 :source-name source-name
1972                                                 :debug-name debug-name)
1973                       (ir1-convert-lambda-body forms vars
1974                                                :aux-vars aux-vars
1975                                                :aux-vals aux-vals
1976                                                :result result-cont
1977                                                :source-name source-name
1978                                                :debug-name debug-name))))
1979         (setf (functional-inline-expansion res) form)
1980         (setf (functional-arg-documentation res) (cadr form))
1981         res))))
1982 \f
1983 ;;;; defining global functions
1984
1985 ;;; Convert FUN as a lambda in the null environment, but use the
1986 ;;; current compilation policy. Note that FUN may be a
1987 ;;; LAMBDA-WITH-LEXENV, so we may have to augment the environment to
1988 ;;; reflect the state at the definition site.
1989 (defun ir1-convert-inline-lambda (fun &key
1990                                       (source-name '.anonymous.)
1991                                       debug-name)
1992   (destructuring-bind (decls macros symbol-macros &rest body)
1993                       (if (eq (car fun) 'lambda-with-lexenv)
1994                           (cdr fun)
1995                           `(() () () . ,(cdr fun)))
1996     (let ((*lexenv* (make-lexenv
1997                      :default (process-decls decls nil nil
1998                                              (make-continuation)
1999                                              (make-null-lexenv))
2000                      :vars (copy-list symbol-macros)
2001                      :funs (mapcar (lambda (x)
2002                                      `(,(car x) .
2003                                        (macro . ,(coerce (cdr x) 'function))))
2004                                    macros)
2005                      :policy (lexenv-policy *lexenv*))))
2006       (ir1-convert-lambda `(lambda ,@body)
2007                           :source-name source-name
2008                           :debug-name debug-name))))
2009
2010 ;;; Get a DEFINED-FUN object for a function we are about to define. If
2011 ;;; the function has been forward referenced, then substitute for the
2012 ;;; previous references.
2013 (defun get-defined-fun (name)
2014   (proclaim-as-fun-name name)
2015   (let ((found (find-free-fun name "shouldn't happen! (defined-fun)")))
2016     (note-name-defined name :function)
2017     (cond ((not (defined-fun-p found))
2018            (aver (not (info :function :inlinep name)))
2019            (let* ((where-from (leaf-where-from found))
2020                   (res (make-defined-fun
2021                         :%source-name name
2022                         :where-from (if (eq where-from :declared)
2023                                         :declared :defined)
2024                         :type (leaf-type found))))
2025              (substitute-leaf res found)
2026              (setf (gethash name *free-funs*) res)))
2027           ;; If *FREE-FUNS* has a previously converted definition
2028           ;; for this name, then blow it away and try again.
2029           ((defined-fun-functional found)
2030            (remhash name *free-funs*)
2031            (get-defined-fun name))
2032           (t found))))
2033
2034 ;;; Check a new global function definition for consistency with
2035 ;;; previous declaration or definition, and assert argument/result
2036 ;;; types if appropriate. This assertion is suppressed by the
2037 ;;; EXPLICIT-CHECK attribute, which is specified on functions that
2038 ;;; check their argument types as a consequence of type dispatching.
2039 ;;; This avoids redundant checks such as NUMBERP on the args to +, etc.
2040 (defun assert-new-definition (var fun)
2041   (let ((type (leaf-type var))
2042         (for-real (eq (leaf-where-from var) :declared))
2043         (info (info :function :info (leaf-source-name var))))
2044     (assert-definition-type
2045      fun type
2046      ;; KLUDGE: Common Lisp is such a dynamic language that in general
2047      ;; all we can do here in general is issue a STYLE-WARNING. It
2048      ;; would be nice to issue a full WARNING in the special case of
2049      ;; of type mismatches within a compilation unit (as in section
2050      ;; 3.2.2.3 of the spec) but at least as of sbcl-0.6.11, we don't
2051      ;; keep track of whether the mismatched data came from the same
2052      ;; compilation unit, so we can't do that. -- WHN 2001-02-11
2053      :lossage-fun #'compiler-style-warn
2054      :unwinnage-fun (cond (info #'compiler-style-warn)
2055                           (for-real #'compiler-note)
2056                           (t nil))
2057      :really-assert
2058      (and for-real
2059           (not (and info
2060                     (ir1-attributep (fun-info-attributes info)
2061                                     explicit-check))))
2062      :where (if for-real
2063                 "previous declaration"
2064                 "previous definition"))))
2065
2066 ;;; Convert a lambda doing all the basic stuff we would do if we were
2067 ;;; converting a DEFUN. In the old CMU CL system, this was used both
2068 ;;; by the %DEFUN translator and for global inline expansion, but
2069 ;;; since sbcl-0.pre7.something %DEFUN does things differently.
2070 ;;; FIXME: And now it's probably worth rethinking whether this
2071 ;;; function is a good idea.
2072 ;;;
2073 ;;; Unless a :INLINE function, we temporarily clobber the inline
2074 ;;; expansion. This prevents recursive inline expansion of
2075 ;;; opportunistic pseudo-inlines.
2076 (defun ir1-convert-lambda-for-defun (lambda var expansion converter)
2077   (declare (cons lambda) (function converter) (type defined-fun var))
2078   (let ((var-expansion (defined-fun-inline-expansion var)))
2079     (unless (eq (defined-fun-inlinep var) :inline)
2080       (setf (defined-fun-inline-expansion var) nil))
2081     (let* ((name (leaf-source-name var))
2082            (fun (funcall converter lambda
2083                          :source-name name))
2084            (fun-info (info :function :info name)))
2085       (setf (functional-inlinep fun) (defined-fun-inlinep var))
2086       (assert-new-definition var fun)
2087       (setf (defined-fun-inline-expansion var) var-expansion)
2088       ;; If definitely not an interpreter stub, then substitute for
2089       ;; any old references.
2090       (unless (or (eq (defined-fun-inlinep var) :notinline)
2091                   (not *block-compile*)
2092                   (and fun-info
2093                        (or (fun-info-transforms fun-info)
2094                            (fun-info-templates fun-info)
2095                            (fun-info-ir2-convert fun-info))))
2096         (substitute-leaf fun var)
2097         ;; If in a simple environment, then we can allow backward
2098         ;; references to this function from following top level forms.
2099         (when expansion (setf (defined-fun-functional var) fun)))
2100       fun)))
2101
2102 ;;; the even-at-compile-time part of DEFUN
2103 ;;;
2104 ;;; The INLINE-EXPANSION is a LAMBDA-WITH-LEXENV, or NIL if there is
2105 ;;; no inline expansion.
2106 (defun %compiler-defun (name lambda-with-lexenv)
2107
2108   (let ((defined-fun nil)) ; will be set below if we're in the compiler
2109     
2110     (when (boundp '*lexenv*) ; when in the compiler
2111       (when sb!xc:*compile-print*
2112         (compiler-mumble "~&; recognizing DEFUN ~S~%" name))
2113       (remhash name *free-funs*)
2114       (setf defined-fun (get-defined-fun name)))
2115
2116     (become-defined-fun-name name)
2117
2118     (cond (lambda-with-lexenv
2119            (setf (info :function :inline-expansion-designator name)
2120                  lambda-with-lexenv)
2121            (when defined-fun 
2122              (setf (defined-fun-inline-expansion defined-fun)
2123                    lambda-with-lexenv)))
2124           (t
2125            (clear-info :function :inline-expansion-designator name)))
2126
2127     ;; old CMU CL comment:
2128     ;;   If there is a type from a previous definition, blast it,
2129     ;;   since it is obsolete.
2130     (when (and defined-fun
2131                (eq (leaf-where-from defined-fun) :defined))
2132       (setf (leaf-type defined-fun)
2133             ;; FIXME: If this is a block compilation thing, shouldn't
2134             ;; we be setting the type to the full derived type for the
2135             ;; definition, instead of this most general function type?
2136             (specifier-type 'function))))
2137
2138   (values))