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