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