06aa22b953ae050f44b04ee45b50596bd9ec8f6c
[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* nil)
44
45 ;;; *CONVERTING-FOR-INTERPRETER* is true when we are creating IR1 to
46 ;;; be interpreted rather than compiled. This inhibits source
47 ;;; tranformations and stuff.
48 (defvar *converting-for-interpreter* nil)
49 ;;; FIXME: Rename to *IR1-FOR-INTERPRETER-NOT-COMPILER-P*.
50
51 ;;; FIXME: This nastiness was one of my original motivations to start
52 ;;; hacking CMU CL. The non-ANSI behavior can be useful, but it should
53 ;;; be made not the default, and perhaps should be controlled by
54 ;;; DECLAIM instead of a variable like this. And whether or not this
55 ;;; kind of checking is on, declarations should be assertions to the
56 ;;; extent practical, and code which can't be compiled efficiently
57 ;;; while adhering to that principle should give warnings.
58 (defvar *derive-function-types* t
59   #!+sb-doc
60   "(Caution: Soon, this might change its semantics somewhat, or even go away.)
61   If true, argument and result type information derived from compilation of
62   DEFUNs is used when compiling calls to that function. If false, only
63   information from FTYPE proclamations will be used.")
64 \f
65 ;;;; namespace management utilities
66
67 ;;; Return a GLOBAL-VAR structure usable for referencing the global
68 ;;; function NAME.
69 (defun find-free-really-function (name)
70   (unless (info :function :kind name)
71     (setf (info :function :kind name) :function)
72     (setf (info :function :where-from name) :assumed))
73
74   (let ((where (info :function :where-from name)))
75     (when (eq where :assumed)
76       (note-undefined-reference name :function))
77     (make-global-var :kind :global-function
78                      :name name
79                      :type (if (or *derive-function-types*
80                                    (eq where :declared))
81                                (info :function :type name)
82                                (specifier-type 'function))
83                      :where-from where)))
84
85 ;;; Return a SLOT-ACCESSOR structure usable for referencing the slot
86 ;;; accessor NAME. CLASS is the structure class.
87 (defun find-structure-slot-accessor (class name)
88   (declare (type sb!xc:class class))
89   (let* ((info (layout-info
90                 (or (info :type :compiler-layout (sb!xc:class-name class))
91                     (class-layout class))))
92          (accessor (if (listp name) (cadr name) name))
93          (slot (find accessor (dd-slots info) :key #'sb!kernel:dsd-accessor))
94          (type (dd-name info))
95          (slot-type (dsd-type slot)))
96     (assert slot () "Can't find slot ~S." type)
97     (make-slot-accessor
98      :name name
99      :type (specifier-type
100             (if (listp name)
101                 `(function (,slot-type ,type) ,slot-type)
102                 `(function (,type) ,slot-type)))
103      :for class
104      :slot slot)))
105
106 ;;; If NAME is already entered in *FREE-FUNCTIONS*, then return the
107 ;;; value. Otherwise, make a new GLOBAL-VAR using information from the
108 ;;; global environment and enter it in *FREE-FUNCTIONS*. If NAME names
109 ;;; a macro or special form, then we error out using the supplied
110 ;;; context which indicates what we were trying to do that demanded a
111 ;;; function.
112 (defun find-free-function (name context)
113   (declare (string context))
114   (declare (values global-var))
115   (or (gethash name *free-functions*)
116       (ecase (info :function :kind name)
117         ;; FIXME: The :MACRO and :SPECIAL-FORM cases could be merged.
118         (:macro
119          (compiler-error "The macro name ~S was found ~A." name context))
120         (:special-form
121          (compiler-error "The special form name ~S was found ~A."
122                          name
123                          context))
124         ((:function nil)
125          (check-function-name name)
126          (note-if-setf-function-and-macro name)
127          (let ((expansion (info :function :inline-expansion name))
128                (inlinep (info :function :inlinep name)))
129            (setf (gethash name *free-functions*)
130                  (if (or expansion inlinep)
131                      (make-defined-function
132                       :name name
133                       :inline-expansion expansion
134                       :inlinep inlinep
135                       :where-from (info :function :where-from name)
136                       :type (info :function :type name))
137                      (let ((info (info :function :accessor-for name)))
138                        (etypecase info
139                          (null
140                           (find-free-really-function name))
141                          (sb!xc:structure-class
142                           (find-structure-slot-accessor info name))
143                          (sb!xc:class
144                           (if (typep (layout-info (info :type :compiler-layout
145                                                         (sb!xc:class-name
146                                                          info)))
147                                      'defstruct-description)
148                               (find-structure-slot-accessor info name)
149                               (find-free-really-function name))))))))))))
150
151 ;;; Return the LEAF structure for the lexically apparent function
152 ;;; definition of NAME.
153 (declaim (ftype (function (t string) leaf) find-lexically-apparent-function))
154 (defun find-lexically-apparent-function (name context)
155   (let ((var (lexenv-find name functions :test #'equal)))
156     (cond (var
157            (unless (leaf-p var)
158              (assert (and (consp var) (eq (car var) 'macro)))
159              (compiler-error "found macro name ~S ~A" name context))
160            var)
161           (t
162            (find-free-function name context)))))
163
164 ;;; Return the LEAF node for a global variable reference to NAME. If
165 ;;; NAME is already entered in *FREE-VARIABLES*, then we just return
166 ;;; the corresponding value. Otherwise, we make a new leaf using
167 ;;; information from the global environment and enter it in
168 ;;; *FREE-VARIABLES*. If the variable is unknown, then we emit a
169 ;;; warning.
170 (defun find-free-variable (name)
171   (declare (values (or leaf heap-alien-info)))
172   (unless (symbolp name)
173     (compiler-error "Variable name is not a symbol: ~S." name))
174   (or (gethash name *free-variables*)
175       (let ((kind (info :variable :kind name))
176             (type (info :variable :type name))
177             (where-from (info :variable :where-from name)))
178         (when (and (eq where-from :assumed) (eq kind :global))
179           (note-undefined-reference name :variable))
180
181         (setf (gethash name *free-variables*)
182               (if (eq kind :alien)
183                   (info :variable :alien-info name)
184                   (multiple-value-bind (val valp)
185                       (info :variable :constant-value name)
186                     (if (and (eq kind :constant) valp)
187                         (make-constant :value val
188                                        :name name
189                                        :type (ctype-of val)
190                                        :where-from where-from)
191                         (make-global-var :kind kind
192                                          :name name
193                                          :type type
194                                          :where-from where-from))))))))
195 \f
196 ;;; Grovel over CONSTANT checking for any sub-parts that need to be
197 ;;; processed with MAKE-LOAD-FORM. We have to be careful, because
198 ;;; CONSTANT might be circular. We also check that the constant (and
199 ;;; any subparts) are dumpable at all.
200 (defconstant list-to-hash-table-threshold 32)
201 (defun maybe-emit-make-load-forms (constant)
202   (let ((things-processed nil)
203         (count 0))
204     ;; FIXME: Does this LIST-or-HASH-TABLE messiness give much benefit?
205     (declare (type (or list hash-table) things-processed)
206              (type (integer 0 #.(1+ list-to-hash-table-threshold)) count)
207              (inline member))
208     (labels ((grovel (value)
209                ;; Unless VALUE is an object which which obviously
210                ;; can't contain other objects
211                (unless (typep value
212                               '(or #-sb-xc-host unboxed-array
213                                    symbol
214                                    number
215                                    character
216                                    string))
217                  (etypecase things-processed
218                    (list
219                     (when (member value things-processed :test #'eq)
220                       (return-from grovel nil))
221                     (push value things-processed)
222                     (incf count)
223                     (when (> count list-to-hash-table-threshold)
224                       (let ((things things-processed))
225                         (setf things-processed
226                               (make-hash-table :test 'eq))
227                         (dolist (thing things)
228                           (setf (gethash thing things-processed) t)))))
229                    (hash-table
230                     (when (gethash value things-processed)
231                       (return-from grovel nil))
232                     (setf (gethash value things-processed) t)))
233                  (typecase value
234                    (cons
235                     (grovel (car value))
236                     (grovel (cdr value)))
237                    (simple-vector
238                     (dotimes (i (length value))
239                       (grovel (svref value i))))
240                    ((vector t)
241                     (dotimes (i (length value))
242                       (grovel (aref value i))))
243                    ((simple-array t)
244                     ;; Even though the (ARRAY T) branch does the exact
245                     ;; same thing as this branch we do this separately
246                     ;; so that the compiler can use faster versions of
247                     ;; array-total-size and row-major-aref.
248                     (dotimes (i (array-total-size value))
249                       (grovel (row-major-aref value i))))
250                    ((array t)
251                     (dotimes (i (array-total-size value))
252                       (grovel (row-major-aref value i))))
253                    (;; In the target SBCL, we can dump any instance,
254                     ;; but in the cross-compilation host,
255                     ;; %INSTANCE-FOO functions don't work on general
256                     ;; instances, only on STRUCTURE!OBJECTs.
257                     #+sb-xc-host structure!object
258                     #-sb-xc-host instance
259                     (when (emit-make-load-form value)
260                       (dotimes (i (%instance-length value))
261                         (grovel (%instance-ref value i)))))
262                    (t
263                     (compiler-error
264                      "Objects of type ~S can't be dumped into fasl files."
265                      (type-of value)))))))
266       (grovel constant)))
267   (values))
268 \f
269 ;;;; some flow-graph hacking utilities
270
271 ;;; This function sets up the back link between the node and the
272 ;;; continuation which continues at it.
273 #!-sb-fluid (declaim (inline prev-link))
274 (defun prev-link (node cont)
275   (declare (type node node) (type continuation cont))
276   (assert (not (continuation-next cont)))
277   (setf (continuation-next cont) node)
278   (setf (node-prev node) cont))
279
280 ;;; This function is used to set the continuation for a node, and thus
281 ;;; determine what receives the value and what is evaluated next. If
282 ;;; the continuation has no block, then we make it be in the block
283 ;;; that the node is in. If the continuation heads its block, we end
284 ;;; our block and link it to that block. If the continuation is not
285 ;;; currently used, then we set the derived-type for the continuation
286 ;;; to that of the node, so that a little type propagation gets done.
287 ;;;
288 ;;; We also deal with a bit of THE's semantics here: we weaken the
289 ;;; assertion on CONT to be no stronger than the assertion on CONT in
290 ;;; our scope. See the IR1-CONVERT method for THE.
291 #!-sb-fluid (declaim (inline use-continuation))
292 (defun use-continuation (node cont)
293   (declare (type node node) (type continuation cont))
294   (let ((node-block (continuation-block (node-prev node))))
295     (case (continuation-kind cont)
296       (:unused
297        (setf (continuation-block cont) node-block)
298        (setf (continuation-kind cont) :inside-block)
299        (setf (continuation-use cont) node)
300        (setf (node-cont node) cont))
301       (t
302        (%use-continuation node cont)))))
303 (defun %use-continuation (node cont)
304   (declare (type node node) (type continuation cont) (inline member))
305   (let ((block (continuation-block cont))
306         (node-block (continuation-block (node-prev node))))
307     (assert (eq (continuation-kind cont) :block-start))
308     (assert (not (block-last node-block)) () "~S has already ended."
309             node-block)
310     (setf (block-last node-block) node)
311     (assert (null (block-succ node-block)) () "~S already has successors."
312             node-block)
313     (setf (block-succ node-block) (list block))
314     (assert (not (member node-block (block-pred block) :test #'eq)) ()
315             "~S is already a predecessor of ~S." node-block block)
316     (push node-block (block-pred block))
317     (add-continuation-use node cont)
318     (unless (eq (continuation-asserted-type cont) *wild-type*)
319       (let ((new (values-type-union (continuation-asserted-type cont)
320                                     (or (lexenv-find cont type-restrictions)
321                                         *wild-type*))))
322         (when (type/= new (continuation-asserted-type cont))
323           (setf (continuation-asserted-type cont) new)
324           (reoptimize-continuation cont))))))
325 \f
326 ;;;; exported functions
327
328 ;;; This function takes a form and the top-level form number for that
329 ;;; form, and returns a lambda representing the translation of that
330 ;;; form in the current global environment. The lambda is top-level
331 ;;; lambda that can be called to cause evaluation of the forms. This
332 ;;; lambda is in the initial component. If FOR-VALUE is T, then the
333 ;;; value of the form is returned from the function, otherwise NIL is
334 ;;; returned.
335 ;;;
336 ;;; This function may have arbitrary effects on the global environment
337 ;;; due to processing of PROCLAIMs and EVAL-WHENs. All syntax error
338 ;;; checking is done, with erroneous forms being replaced by a proxy
339 ;;; which signals an error if it is evaluated. Warnings about possibly
340 ;;; inconsistent or illegal changes to the global environment will
341 ;;; also be given.
342 ;;;
343 ;;; We make the initial component and convert the form in a PROGN (and
344 ;;; an optional NIL tacked on the end.) We then return the lambda. We
345 ;;; bind all of our state variables here, rather than relying on the
346 ;;; global value (if any) so that IR1 conversion will be reentrant.
347 ;;; This is necessary for EVAL-WHEN processing, etc.
348 ;;;
349 ;;; The hashtables used to hold global namespace info must be
350 ;;; reallocated elsewhere. Note also that *LEXENV* is not bound, so
351 ;;; that local macro definitions can be introduced by enclosing code.
352 (defun ir1-top-level (form path for-value)
353   (declare (list path))
354   (let* ((*current-path* path)
355          (component (make-empty-component))
356          (*current-component* component))
357     (setf (component-name component) "initial component")
358     (setf (component-kind component) :initial)
359     (let* ((forms (if for-value `(,form) `(,form nil)))
360            (res (ir1-convert-lambda-body forms ())))
361       (setf (leaf-name res) "top-level form")
362       (setf (functional-entry-function res) res)
363       (setf (functional-arg-documentation res) ())
364       (setf (functional-kind res) :top-level)
365       res)))
366
367 ;;; *CURRENT-FORM-NUMBER* is used in FIND-SOURCE-PATHS to compute the
368 ;;; form number to associate with a source path. This should be bound
369 ;;; to 0 around the processing of each truly top-level form.
370 (declaim (type index *current-form-number*))
371 (defvar *current-form-number*)
372
373 ;;; This function is called on freshly read forms to record the
374 ;;; initial location of each form (and subform.) Form is the form to
375 ;;; find the paths in, and TLF-Num is the top-level form number of the
376 ;;; truly top-level form.
377 ;;;
378 ;;; This gets a bit interesting when the source code is circular. This
379 ;;; can (reasonably?) happen in the case of circular list constants.
380 (defun find-source-paths (form tlf-num)
381   (declare (type index tlf-num))
382   (let ((*current-form-number* 0))
383     (sub-find-source-paths form (list tlf-num)))
384   (values))
385 (defun sub-find-source-paths (form path)
386   (unless (gethash form *source-paths*)
387     (setf (gethash form *source-paths*)
388           (list* 'original-source-start *current-form-number* path))
389     (incf *current-form-number*)
390     (let ((pos 0)
391           (subform form)
392           (trail form))
393       (declare (fixnum pos))
394       (macrolet ((frob ()
395                    '(progn
396                       (when (atom subform) (return))
397                       (let ((fm (car subform)))
398                         (when (consp fm)
399                           (sub-find-source-paths fm (cons pos path)))
400                         (incf pos))
401                       (setq subform (cdr subform))
402                       (when (eq subform trail) (return)))))
403         (loop
404           (frob)
405           (frob)
406           (setq trail (cdr trail)))))))
407 \f
408 ;;;; IR1-CONVERT, macroexpansion and special form dispatching
409
410 (macrolet (;; Bind *COMPILER-ERROR-BAILOUT* to a function that throws
411            ;; out of the body and converts a proxy form instead.
412            (ir1-error-bailout ((start
413                                 cont
414                                 form
415                                 &optional
416                                 (proxy ``(error "execution of a form compiled with errors:~% ~S"
417                                                 ',,form)))
418                                &body body)
419                               (let ((skip (gensym "SKIP")))
420                                 `(block ,skip
421                                    (catch 'ir1-error-abort
422                                      (let ((*compiler-error-bailout*
423                                             #'(lambda ()
424                                                 (throw 'ir1-error-abort nil))))
425                                        ,@body
426                                        (return-from ,skip nil)))
427                                    (ir1-convert ,start ,cont ,proxy)))))
428
429   ;; Translate FORM into IR1. The code is inserted as the NEXT of the
430   ;; continuation START. CONT is the continuation which receives the
431   ;; value of the FORM to be translated. The translators call this
432   ;; function recursively to translate their subnodes.
433   ;;
434   ;; As a special hack to make life easier in the compiler, a LEAF
435   ;; IR1-converts into a reference to that LEAF structure. This allows
436   ;; the creation using backquote of forms that contain leaf
437   ;; references, without having to introduce dummy names into the
438   ;; namespace.
439   (declaim (ftype (function (continuation continuation t) (values)) ir1-convert))
440   (defun ir1-convert (start cont form)
441     (ir1-error-bailout (start cont form)
442       (let ((*current-path* (or (gethash form *source-paths*)
443                                 (cons form *current-path*))))
444         (if (atom form)
445             (cond ((and (symbolp form) (not (keywordp form)))
446                    (ir1-convert-variable start cont form))
447                   ((leaf-p form)
448                    (reference-leaf start cont form))
449                   (t
450                    (reference-constant start cont form)))
451             (let ((fun (car form)))
452               (cond
453                ((symbolp fun)
454                 (let ((lexical-def (lexenv-find fun functions)))
455                   (typecase lexical-def
456                     (null (ir1-convert-global-functoid start cont form))
457                     (functional
458                      (ir1-convert-local-combination start
459                                                     cont
460                                                     form
461                                                     lexical-def))
462                     (global-var
463                      (ir1-convert-srctran start cont lexical-def form))
464                     (t
465                      (assert (and (consp lexical-def)
466                                   (eq (car lexical-def) 'macro)))
467                      (ir1-convert start cont
468                                   (careful-expand-macro (cdr lexical-def)
469                                                         form))))))
470                ((or (atom fun) (not (eq (car fun) 'lambda)))
471                 (compiler-error "illegal function call"))
472                (t
473                 (ir1-convert-combination start
474                                          cont
475                                          form
476                                          (ir1-convert-lambda fun))))))))
477     (values))
478
479   ;; Generate a reference to a manifest constant, creating a new leaf
480   ;; if necessary. If we are producing a fasl-file, make sure that
481   ;; MAKE-LOAD-FORM gets used on any parts of the constant that it
482   ;; needs to be.
483   (defun reference-constant (start cont value)
484     (declare (type continuation start cont)
485              (inline find-constant))
486     (ir1-error-bailout
487      (start cont value
488             '(error "attempt to reference undumpable constant"))
489      (when (producing-fasl-file)
490        (maybe-emit-make-load-forms value))
491      (let* ((leaf (find-constant value))
492             (res (make-ref (leaf-type leaf) leaf)))
493        (push res (leaf-refs leaf))
494        (prev-link res start)
495        (use-continuation res cont)))
496     (values)))
497
498 ;;; Add Fun to the COMPONENT-REANALYZE-FUNCTIONS. Fun is returned.
499  (defun maybe-reanalyze-function (fun)
500   (declare (type functional fun))
501   (when (typep fun '(or optional-dispatch clambda))
502     (pushnew fun (component-reanalyze-functions *current-component*)))
503   fun)
504
505 ;;; Generate a Ref node for LEAF, frobbing the LEAF structure as
506 ;;; needed. If LEAF represents a defined function which has already
507 ;;; been converted, and is not :NOTINLINE, then reference the
508 ;;; functional instead.
509 (defun reference-leaf (start cont leaf)
510   (declare (type continuation start cont) (type leaf leaf))
511   (let* ((leaf (or (and (defined-function-p leaf)
512                         (not (eq (defined-function-inlinep leaf)
513                                  :notinline))
514                         (let ((fun (defined-function-functional leaf)))
515                           (when (and fun (not (functional-kind fun)))
516                             (maybe-reanalyze-function fun))))
517                    leaf))
518          (res (make-ref (or (lexenv-find leaf type-restrictions)
519                             (leaf-type leaf))
520                         leaf)))
521     (push res (leaf-refs leaf))
522     (setf (leaf-ever-used leaf) t)
523     (prev-link res start)
524     (use-continuation res cont)))
525
526 ;;; Convert a reference to a symbolic constant or variable. If the
527 ;;; symbol is entered in the LEXENV-VARIABLES we use that definition,
528 ;;; otherwise we find the current global definition. This is also
529 ;;; where we pick off symbol macro and Alien variable references.
530 (defun ir1-convert-variable (start cont name)
531   (declare (type continuation start cont) (symbol name))
532   (let ((var (or (lexenv-find name variables) (find-free-variable name))))
533     (etypecase var
534       (leaf
535        (when (and (lambda-var-p var) (lambda-var-ignorep var))
536          ;; (ANSI's specification for the IGNORE declaration requires
537          ;; that this be a STYLE-WARNING, not a full WARNING.)
538          (compiler-style-warning "reading an ignored variable: ~S" name))
539        (reference-leaf start cont var))
540       (cons
541        (assert (eq (car var) 'MACRO))
542        (ir1-convert start cont (cdr var)))
543       (heap-alien-info
544        (ir1-convert start cont `(%heap-alien ',var)))))
545   (values))
546
547 ;;; Convert anything that looks like a special form, global function
548 ;;; or macro call.
549 (defun ir1-convert-global-functoid (start cont form)
550   (declare (type continuation start cont) (list form))
551   (let* ((fun (first form))
552          (translator (info :function :ir1-convert fun))
553          (cmacro (info :function :compiler-macro-function fun)))
554     (cond (translator (funcall translator start cont form))
555           ((and cmacro (not *converting-for-interpreter*)
556                 (not (eq (info :function :inlinep fun) :notinline)))
557            (let ((res (careful-expand-macro cmacro form)))
558              (if (eq res form)
559                  (ir1-convert-global-functoid-no-cmacro start cont form fun)
560                  (ir1-convert start cont res))))
561           (t
562            (ir1-convert-global-functoid-no-cmacro start cont form fun)))))
563
564 ;;; Handle the case of where the call was not a compiler macro, or was a
565 ;;; compiler macro and passed.
566 (defun ir1-convert-global-functoid-no-cmacro (start cont form fun)
567   (declare (type continuation start cont) (list form))
568   ;; FIXME: Couldn't all the INFO calls here be converted into
569   ;; standard CL functions, like MACRO-FUNCTION or something?
570   ;; And what happens with lexically-defined (MACROLET) macros
571   ;; here, anyway?
572   (ecase (info :function :kind fun)
573     (:macro
574      (ir1-convert start
575                   cont
576                   (careful-expand-macro (info :function :macro-function fun)
577                                         form)))
578     ((nil :function)
579      (ir1-convert-srctran start cont (find-free-function fun "Eh?") form))))
580
581 (defun muffle-warning-or-die ()
582   (muffle-warning)
583   (error "internal error -- no MUFFLE-WARNING restart"))
584
585 ;;; Trap errors during the macroexpansion.
586 (defun careful-expand-macro (fun form)
587   (handler-bind (;; When cross-compiling, we can get style warnings
588                  ;; about e.g. undefined functions. An unhandled
589                  ;; CL:STYLE-WARNING (as opposed to a
590                  ;; SB!C::COMPILER-NOTE) would cause FAILURE-P to be
591                  ;; set on the return from #'SB!XC:COMPILE-FILE, which
592                  ;; would falsely indicate an error sufficiently
593                  ;; serious that we should stop the build process. To
594                  ;; avoid this, we translate CL:STYLE-WARNING
595                  ;; conditions from the host Common Lisp into
596                  ;; cross-compiler SB!C::COMPILER-NOTE calls. (It
597                  ;; might be cleaner to just make Python use
598                  ;; CL:STYLE-WARNING internally, so that the
599                  ;; significance of any host Common Lisp
600                  ;; CL:STYLE-WARNINGs is understood automatically. But
601                  ;; for now I'm not motivated to do this. -- WHN
602                  ;; 19990412)
603                  (style-warning (lambda (c)
604                                   (compiler-note "(during macroexpansion)~%~A"
605                                                  c)
606                                   (muffle-warning-or-die)))
607                  ;; KLUDGE: CMU CL in its wisdom (version 2.4.6 for
608                  ;; Debian Linux, anyway) raises a CL:WARNING
609                  ;; condition (not a CL:STYLE-WARNING) for undefined
610                  ;; symbols when converting interpreted functions,
611                  ;; causing COMPILE-FILE to think the file has a real
612                  ;; problem, causing COMPILE-FILE to return FAILURE-P
613                  ;; set (not just WARNINGS-P set). Since undefined
614                  ;; symbol warnings are often harmless forward
615                  ;; references, and since it'd be inordinately painful
616                  ;; to try to eliminate all such forward references,
617                  ;; these warnings are basically unavoidable. Thus, we
618                  ;; need to coerce the system to work through them,
619                  ;; and this code does so, by crudely suppressing all
620                  ;; warnings in cross-compilation macroexpansion. --
621                  ;; WHN 19990412
622                  #+cmu
623                  (warning (lambda (c)
624                             (compiler-note
625                              "(during macroexpansion)~%~
626                               ~A~%~
627                               (KLUDGE: That was a non-STYLE WARNING.~%~
628                               Ordinarily that would cause compilation to~%~
629                               fail. However, since we're running under~%~
630                               CMU CL, and since CMU CL emits non-STYLE~%~
631                               warnings for safe, hard-to-fix things (e.g.~%~
632                               references to not-yet-defined functions)~%~
633                               we're going to have to ignore it and proceed~%~
634                               anyway. Hopefully we're not ignoring anything~%~
635                               horrible here..)~%"
636                              c)
637                             (muffle-warning-or-die)))
638                  (error (lambda (c)
639                           (compiler-error "(during macroexpansion)~%~A" c))))
640     (funcall sb!xc:*macroexpand-hook*
641              fun
642              form
643              *lexenv*)))
644 \f
645 ;;;; conversion utilities
646
647 ;;; Convert a bunch of forms, discarding all the values except the
648 ;;; last. If there aren't any forms, then translate a NIL.
649 (declaim (ftype (function (continuation continuation list) (values))
650                 ir1-convert-progn-body))
651 (defun ir1-convert-progn-body (start cont body)
652   (if (endp body)
653       (reference-constant start cont nil)
654       (let ((this-start start)
655             (forms body))
656         (loop
657           (let ((form (car forms)))
658             (when (endp (cdr forms))
659               (ir1-convert this-start cont form)
660               (return))
661             (let ((this-cont (make-continuation)))
662               (ir1-convert this-start this-cont form)
663               (setq this-start this-cont  forms (cdr forms)))))))
664   (values))
665 \f
666 ;;;; converting combinations
667
668 ;;; Convert a function call where the function (Fun) is a Leaf. We
669 ;;; return the Combination node so that we can poke at it if we want to.
670 (declaim (ftype (function (continuation continuation list leaf) combination)
671                 ir1-convert-combination))
672 (defun ir1-convert-combination (start cont form fun)
673   (let ((fun-cont (make-continuation)))
674     (reference-leaf start fun-cont fun)
675     (ir1-convert-combination-args fun-cont cont (cdr form))))
676
677 ;;; Convert the arguments to a call and make the Combination node. Fun-Cont
678 ;;; is the continuation which yields the function to call. Form is the source
679 ;;; for the call. Args is the list of arguments for the call, which defaults
680 ;;; to the cdr of source. We return the Combination node.
681 (defun ir1-convert-combination-args (fun-cont cont args)
682   (declare (type continuation fun-cont cont) (list args))
683   (let ((node (make-combination fun-cont)))
684     (setf (continuation-dest fun-cont) node)
685     (assert-continuation-type fun-cont
686                               (specifier-type '(or function symbol)))
687     (collect ((arg-conts))
688       (let ((this-start fun-cont))
689         (dolist (arg args)
690           (let ((this-cont (make-continuation node)))
691             (ir1-convert this-start this-cont arg)
692             (setq this-start this-cont)
693             (arg-conts this-cont)))
694         (prev-link node this-start)
695         (use-continuation node cont)
696         (setf (combination-args node) (arg-conts))))
697     node))
698
699 ;;; Convert a call to a global function. If not :NOTINLINE, then we do
700 ;;; source transforms and try out any inline expansion. If there is no
701 ;;; expansion, but is :INLINE, then give an efficiency note (unless a known
702 ;;; function which will quite possibly be open-coded.)   Next, we go to
703 ;;; ok-combination conversion.
704 (defun ir1-convert-srctran (start cont var form)
705   (declare (type continuation start cont) (type global-var var))
706   (let ((inlinep (when (defined-function-p var)
707                    (defined-function-inlinep var))))
708     (cond
709      ((eq inlinep :notinline)
710       (ir1-convert-combination start cont form var))
711      (*converting-for-interpreter*
712       (ir1-convert-combination-checking-type start cont form var))
713      (t
714       (let ((transform (info :function :source-transform (leaf-name var))))
715         (cond
716          (transform
717           (multiple-value-bind (result pass) (funcall transform form)
718             (if pass
719                 (ir1-convert-maybe-predicate start cont form var)
720                 (ir1-convert start cont result))))
721          (t
722           (ir1-convert-maybe-predicate start cont form var))))))))
723
724 ;;; If the function has the Predicate attribute, and the CONT's DEST isn't
725 ;;; an IF, then we convert (IF <form> T NIL), ensuring that a predicate always
726 ;;; appears in a conditional context.
727 ;;;
728 ;;; If the function isn't a predicate, then we call
729 ;;; IR1-CONVERT-COMBINATION-CHECKING-TYPE.
730 (defun ir1-convert-maybe-predicate (start cont form var)
731   (declare (type continuation start cont) (list form) (type global-var var))
732   (let ((info (info :function :info (leaf-name var))))
733     (if (and info
734              (ir1-attributep (function-info-attributes info) predicate)
735              (not (if-p (continuation-dest cont))))
736         (ir1-convert start cont `(if ,form t nil))
737         (ir1-convert-combination-checking-type start cont form var))))
738
739 ;;; Actually really convert a global function call that we are allowed
740 ;;; to early-bind.
741 ;;;
742 ;;; If we know the function type of the function, then we check the
743 ;;; call for syntactic legality with respect to the declared function
744 ;;; type. If it is impossible to determine whether the call is correct
745 ;;; due to non-constant keywords, then we give up, marking the call as
746 ;;; :FULL to inhibit further error messages. We return true when the
747 ;;; call is legal.
748 ;;;
749 ;;; If the call is legal, we also propagate type assertions from the
750 ;;; function type to the arg and result continuations. We do this now
751 ;;; so that IR1 optimize doesn't have to redundantly do the check
752 ;;; later so that it can do the type propagation.
753 (defun ir1-convert-combination-checking-type (start cont form var)
754   (declare (type continuation start cont) (list form) (type leaf var))
755   (let* ((node (ir1-convert-combination start cont form var))
756          (fun-cont (basic-combination-fun node))
757          (type (leaf-type var)))
758     (when (validate-call-type node type t)
759       (setf (continuation-%derived-type fun-cont) type)
760       (setf (continuation-reoptimize fun-cont) nil)
761       (setf (continuation-%type-check fun-cont) nil)))
762
763   (values))
764
765 ;;; Convert a call to a local function. If the function has already
766 ;;; been let converted, then throw FUN to LOCAL-CALL-LOSSAGE. This
767 ;;; should only happen when we are converting inline expansions for
768 ;;; local functions during optimization.
769 (defun ir1-convert-local-combination (start cont form fun)
770   (if (functional-kind fun)
771       (throw 'local-call-lossage fun)
772       (ir1-convert-combination start cont form
773                                (maybe-reanalyze-function fun))))
774 \f
775 ;;;; PROCESS-DECLS
776
777 ;;; Given a list of Lambda-Var structures and a variable name, return
778 ;;; the structure for that name, or NIL if it isn't found. We return
779 ;;; the *last* variable with that name, since LET* bindings may be
780 ;;; duplicated, and declarations always apply to the last.
781 (declaim (ftype (function (list symbol) (or lambda-var list))
782                 find-in-bindings))
783 (defun find-in-bindings (vars name)
784   (let ((found nil))
785     (dolist (var vars)
786       (cond ((leaf-p var)
787              (when (eq (leaf-name var) name)
788                (setq found var))
789              (let ((info (lambda-var-arg-info var)))
790                (when info
791                  (let ((supplied-p (arg-info-supplied-p info)))
792                    (when (and supplied-p
793                               (eq (leaf-name supplied-p) name))
794                      (setq found supplied-p))))))
795             ((and (consp var) (eq (car var) name))
796              (setf found (cdr var)))))
797     found))
798
799 ;;; Called by Process-Decls to deal with a variable type declaration.
800 ;;; If a lambda-var being bound, we intersect the type with the vars
801 ;;; type, otherwise we add a type-restriction on the var. If a symbol
802 ;;; macro, we just wrap a THE around the expansion.
803 (defun process-type-declaration (decl res vars)
804   (declare (list decl vars) (type lexenv res))
805   (let ((type (specifier-type (first decl))))
806     (collect ((restr nil cons)
807               (new-vars nil cons))
808       (dolist (var-name (rest decl))
809         (let* ((bound-var (find-in-bindings vars var-name))
810                (var (or bound-var
811                         (lexenv-find var-name variables)
812                         (find-free-variable var-name))))
813           (etypecase var
814             (leaf
815              (let* ((old-type (or (lexenv-find var type-restrictions)
816                                   (leaf-type var)))
817                     (int (if (or (function-type-p type)
818                                  (function-type-p old-type))
819                              type
820                              (type-intersection old-type type))))
821                (cond ((eq int *empty-type*)
822                       (unless (policy nil (= brevity 3))
823                         (compiler-warning
824                          "The type declarations ~S and ~S for ~S conflict."
825                          (type-specifier old-type) (type-specifier type)
826                          var-name)))
827                      (bound-var (setf (leaf-type bound-var) int))
828                      (t
829                       (restr (cons var int))))))
830             (cons
831              ;; FIXME: non-ANSI weirdness
832              (assert (eq (car var) 'MACRO))
833              (new-vars `(,var-name . (MACRO . (the ,(first decl)
834                                                    ,(cdr var))))))
835             (heap-alien-info
836              (compiler-error
837               "~S is an alien variable, so its type can't be declared."
838               var-name)))))
839
840       (if (or (restr) (new-vars))
841           (make-lexenv :default res
842                        :type-restrictions (restr)
843                        :variables (new-vars))
844           res))))
845
846 ;;; Somewhat similar to Process-Type-Declaration, but handles
847 ;;; declarations for function variables. In addition to allowing
848 ;;; declarations for functions being bound, we must also deal with
849 ;;; declarations that constrain the type of lexically apparent
850 ;;; functions.
851 (defun process-ftype-declaration (spec res names fvars)
852   (declare (list spec names fvars) (type lexenv res))
853   (let ((type (specifier-type spec)))
854     (collect ((res nil cons))
855       (dolist (name names)
856         (let ((found (find name fvars :key #'leaf-name :test #'equal)))
857           (cond
858            (found
859             (setf (leaf-type found) type)
860             (assert-definition-type found type
861                                     :warning-function #'compiler-note
862                                     :where "FTYPE declaration"))
863            (t
864             (res (cons (find-lexically-apparent-function
865                         name "in a function type declaration")
866                        type))))))
867       (if (res)
868           (make-lexenv :default res :type-restrictions (res))
869           res))))
870
871 ;;; Process a special declaration, returning a new LEXENV. A non-bound
872 ;;; special declaration is instantiated by throwing a special variable
873 ;;; into the variables.
874 (defun process-special-declaration (spec res vars)
875   (declare (list spec vars) (type lexenv res))
876   (collect ((new-venv nil cons))
877     (dolist (name (cdr spec))
878       (let ((var (find-in-bindings vars name)))
879         (etypecase var
880           (cons
881            (assert (eq (car var) 'MACRO))
882            (compiler-error
883             "~S is a symbol-macro and thus can't be declared special."
884             name))
885           (lambda-var
886            (when (lambda-var-ignorep var)
887              ;; ANSI's definition for "Declaration IGNORE, IGNORABLE"
888              ;; requires that this be a STYLE-WARNING, not a full WARNING.
889              (compiler-style-warning
890               "The ignored variable ~S is being declared special."
891               name))
892            (setf (lambda-var-specvar var)
893                  (specvar-for-binding name)))
894           (null
895            (unless (assoc name (new-venv) :test #'eq)
896              (new-venv (cons name (specvar-for-binding name))))))))
897     (if (new-venv)
898         (make-lexenv :default res :variables (new-venv))
899         res)))
900
901 ;;; Return a DEFINED-FUNCTION which copies a global-var but for its inlinep.
902 (defun make-new-inlinep (var inlinep)
903   (declare (type global-var var) (type inlinep inlinep))
904   (let ((res (make-defined-function
905               :name (leaf-name var)
906               :where-from (leaf-where-from var)
907               :type (leaf-type var)
908               :inlinep inlinep)))
909     (when (defined-function-p var)
910       (setf (defined-function-inline-expansion res)
911             (defined-function-inline-expansion var))
912       (setf (defined-function-functional res)
913             (defined-function-functional var)))
914     res))
915
916 ;;; Parse an inline/notinline declaration. If it's a local function we're
917 ;;; defining, set its INLINEP. If a global function, add a new FENV entry.
918 (defun process-inline-declaration (spec res fvars)
919   (let ((sense (cdr (assoc (first spec) *inlinep-translations* :test #'eq)))
920         (new-fenv ()))
921     (dolist (name (rest spec))
922       (let ((fvar (find name fvars :key #'leaf-name :test #'equal)))
923         (if fvar
924             (setf (functional-inlinep fvar) sense)
925             (let ((found
926                    (find-lexically-apparent-function
927                     name "in an inline or notinline declaration")))
928               (etypecase found
929                 (functional
930                  (when (policy nil (>= speed brevity))
931                    (compiler-note "ignoring ~A declaration not at ~
932                                    definition of local function:~%  ~S"
933                                   sense name)))
934                 (global-var
935                  (push (cons name (make-new-inlinep found sense))
936                        new-fenv)))))))
937
938     (if new-fenv
939         (make-lexenv :default res :functions new-fenv)
940         res)))
941
942 ;;; Like FIND-IN-BINDINGS, but looks for #'foo in the fvars.
943 (defun find-in-bindings-or-fbindings (name vars fvars)
944   (declare (list vars fvars))
945   (if (consp name)
946       (destructuring-bind (wot fn-name) name
947         (unless (eq wot 'function)
948           (compiler-error "The function or variable name ~S is unrecognizable."
949                           name))
950         (find fn-name fvars :key #'leaf-name :test #'equal))
951       (find-in-bindings vars name)))
952
953 ;;; Process an ignore/ignorable declaration, checking for various losing
954 ;;; conditions.
955 (defun process-ignore-declaration (spec vars fvars)
956   (declare (list spec vars fvars))
957   (dolist (name (rest spec))
958     (let ((var (find-in-bindings-or-fbindings name vars fvars)))
959       (cond
960        ((not var)
961         ;; ANSI's definition for "Declaration IGNORE, IGNORABLE"
962         ;; requires that this be a STYLE-WARNING, not a full WARNING.
963         (compiler-style-warning "declaring unknown variable ~S to be ignored"
964                                 name))
965        ;; FIXME: This special case looks like non-ANSI weirdness.
966        ((and (consp var) (consp (cdr var)) (eq (cadr var) 'macro))
967         ;; Just ignore the IGNORE decl.
968         )
969        ((functional-p var)
970         (setf (leaf-ever-used var) t))
971        ((lambda-var-specvar var)
972         ;; ANSI's definition for "Declaration IGNORE, IGNORABLE"
973         ;; requires that this be a STYLE-WARNING, not a full WARNING.
974         (compiler-style-warning "declaring special variable ~S to be ignored"
975                                 name))
976        ((eq (first spec) 'ignorable)
977         (setf (leaf-ever-used var) t))
978        (t
979         (setf (lambda-var-ignorep var) t)))))
980   (values))
981
982 ;;; FIXME: This is non-ANSI, so the default should be T, or it should
983 ;;; go away, I think.
984 (defvar *suppress-values-declaration* nil
985   #!+sb-doc
986   "If true, processing of the VALUES declaration is inhibited.")
987
988 ;;; Process a single declaration spec, agumenting the specified LEXENV
989 ;;; Res and returning it as a result. Vars and Fvars are as described in
990 ;;; PROCESS-DECLS.
991 (defun process-1-declaration (spec res vars fvars cont)
992   (declare (list spec vars fvars) (type lexenv res) (type continuation cont))
993   (case (first spec)
994     (special (process-special-declaration spec res vars))
995     (ftype
996      (unless (cdr spec)
997        (compiler-error "No type specified in FTYPE declaration: ~S." spec))
998      (process-ftype-declaration (second spec) res (cddr spec) fvars))
999     (function
1000      ;; Handle old style FUNCTION declaration, which is an abbreviation for
1001      ;; FTYPE. Args are name, arglist, result type.
1002      (cond ((and (proper-list-of-length-p spec 3 4)
1003                  (listp (third spec)))
1004             (process-ftype-declaration `(function ,@(cddr spec)) res
1005                                        (list (second spec))
1006                                        fvars))
1007            (t
1008             (process-type-declaration spec res vars))))
1009     ((inline notinline maybe-inline)
1010      (process-inline-declaration spec res fvars))
1011     ((ignore ignorable)
1012      (process-ignore-declaration spec vars fvars)
1013      res)
1014     (optimize
1015      (make-lexenv
1016       :default res
1017       :cookie (process-optimize-declaration spec (lexenv-cookie res))))
1018     (optimize-interface
1019      (make-lexenv
1020       :default res
1021       :interface-cookie (process-optimize-declaration
1022                          spec
1023                          (lexenv-interface-cookie res))))
1024     (type
1025      (process-type-declaration (cdr spec) res vars))
1026     (sb!pcl::class
1027      (process-type-declaration (list (third spec) (second spec)) res vars))
1028     (values
1029      (if *suppress-values-declaration*
1030          res
1031          (let ((types (cdr spec)))
1032            (do-the-stuff (if (eql (length types) 1)
1033                              (car types)
1034                              `(values ,@types))
1035                          cont res 'values))))
1036     (dynamic-extent
1037      (when (policy nil (> speed brevity))
1038        (compiler-note
1039         "The DYNAMIC-EXTENT declaration is not implemented (ignored)."))
1040      res)
1041     (t
1042      (let ((what (first spec)))
1043        (cond ((member what *standard-type-names*)
1044               (process-type-declaration spec res vars))
1045              ((and (not (and (symbolp what)
1046                              (string= (symbol-name what) "CLASS"))) ; pcl hack
1047                    (or (info :type :kind what)
1048                        (and (consp what) (info :type :translator (car what)))))
1049 ;;; MNA - abbreviated declaration bug
1050 ;;               (unless (policy nil (= brevity 3))
1051                 ;; FIXME: Is it ANSI to warn about this? I think not.
1052 ;;              (compiler-note "abbreviated type declaration: ~S." spec))
1053               (process-type-declaration spec res vars))
1054              ((info :declaration :recognized what)
1055               res)
1056              (t
1057               (compiler-warning "unrecognized declaration ~S" spec)
1058               res))))))
1059
1060 ;;; Use a list of DECLARE forms to annotate the lists of LAMBDA-VAR and
1061 ;;; Functional structures which are being bound. In addition to filling in
1062 ;;; slots in the leaf structures, we return a new LEXENV which reflects
1063 ;;; pervasive special and function type declarations, (NOT)INLINE declarations
1064 ;;; and OPTIMIZE declarations. CONT is the continuation affected by VALUES
1065 ;;; declarations.
1066 ;;;
1067 ;;; This is also called in main.lisp when PROCESS-FORM handles a use of
1068 ;;; LOCALLY.
1069 (defun process-decls (decls vars fvars cont &optional (env *lexenv*))
1070   (declare (list decls vars fvars) (type continuation cont))
1071   (dolist (decl decls)
1072     (dolist (spec (rest decl))
1073       (unless (consp spec)
1074         (compiler-error "malformed declaration specifier ~S in ~S"
1075                         spec
1076                         decl))
1077       (setq env (process-1-declaration spec env vars fvars cont))))
1078   env)
1079
1080 ;;; Return the Specvar for Name to use when we see a local SPECIAL
1081 ;;; declaration. If there is a global variable of that name, then
1082 ;;; check that it isn't a constant and return it. Otherwise, create an
1083 ;;; anonymous GLOBAL-VAR.
1084 (defun specvar-for-binding (name)
1085   (cond ((not (eq (info :variable :where-from name) :assumed))
1086          (let ((found (find-free-variable name)))
1087            (when (heap-alien-info-p found)
1088              (compiler-error
1089               "~S is an alien variable and so can't be declared special."
1090               name))
1091            (when (or (not (global-var-p found))
1092                      (eq (global-var-kind found) :constant))
1093              (compiler-error
1094               "~S is a constant and so can't be declared special."
1095               name))
1096            found))
1097         (t
1098          (make-global-var :kind :special
1099                           :name name
1100                           :where-from :declared))))
1101 \f
1102 ;;;; LAMBDA hackery
1103
1104 ;;;; Note: Take a look at the compiler-overview.tex section on "Hairy
1105 ;;;; function representation" before you seriously mess with this
1106 ;;;; stuff.
1107
1108 ;;; Verify that a thing is a legal name for a variable and return a
1109 ;;; Var structure for it, filling in info if it is globally special.
1110 ;;; If it is losing, we punt with a Compiler-Error. Names-So-Far is an
1111 ;;; alist of names which have previously been bound. If the name is in
1112 ;;; this list, then we error out.
1113 (declaim (ftype (function (t list) lambda-var) varify-lambda-arg))
1114 (defun varify-lambda-arg (name names-so-far)
1115   (declare (inline member))
1116   (unless (symbolp name)
1117     (compiler-error "The lambda-variable ~S is not a symbol." name))
1118   (when (member name names-so-far :test #'eq)
1119     (compiler-error "The variable ~S occurs more than once in the lambda-list."
1120                     name))
1121   (let ((kind (info :variable :kind name)))
1122     (when (or (keywordp name) (eq kind :constant))
1123       (compiler-error "The name of the lambda-variable ~S is a constant."
1124                       name))
1125     (cond ((eq kind :special)
1126            (let ((specvar (find-free-variable name)))
1127              (make-lambda-var :name name
1128                               :type (leaf-type specvar)
1129                               :where-from (leaf-where-from specvar)
1130                               :specvar specvar)))
1131           (t
1132            (note-lexical-binding name)
1133            (make-lambda-var :name name)))))
1134
1135 ;;; Make the keyword for a keyword arg, checking that the keyword
1136 ;;; isn't already used by one of the Vars. We also check that the
1137 ;;; keyword isn't the magical :allow-other-keys.
1138 (declaim (ftype (function (symbol list t) keyword) make-keyword-for-arg))
1139 (defun make-keyword-for-arg (symbol vars keywordify)
1140   (let ((key (if (and keywordify (not (keywordp symbol)))
1141                  (intern (symbol-name symbol) "KEYWORD")
1142                  symbol)))
1143     (when (eq key :allow-other-keys)
1144       (compiler-error "No keyword arg can be called :ALLOW-OTHER-KEYS."))
1145     (dolist (var vars)
1146       (let ((info (lambda-var-arg-info var)))
1147         (when (and info
1148                    (eq (arg-info-kind info) :keyword)
1149                    (eq (arg-info-keyword info) key))
1150           (compiler-error
1151            "The keyword ~S appears more than once in the lambda-list."
1152            key))))
1153     key))
1154
1155 ;;; Parse a lambda-list into a list of Var structures, stripping off
1156 ;;; any aux bindings. Each arg name is checked for legality, and
1157 ;;; duplicate names are checked for. If an arg is globally special,
1158 ;;; the var is marked as :special instead of :lexical. Keyword,
1159 ;;; optional and rest args are annotated with an arg-info structure
1160 ;;; which contains the extra information. If we hit something losing,
1161 ;;; we bug out with Compiler-Error. These values are returned:
1162 ;;;  1. A list of the var structures for each top-level argument.
1163 ;;;  2. A flag indicating whether &key was specified.
1164 ;;;  3. A flag indicating whether other keyword args are allowed.
1165 ;;;  4. A list of the &aux variables.
1166 ;;;  5. A list of the &aux values.
1167 (declaim (ftype (function (list) (values list boolean boolean list list))
1168                 find-lambda-vars))
1169 (defun find-lambda-vars (list)
1170   (multiple-value-bind (required optional restp rest keyp keys allowp aux
1171                         morep more-context more-count)
1172       (parse-lambda-list list)
1173     (collect ((vars)
1174               (names-so-far)
1175               (aux-vars)
1176               (aux-vals))
1177       ;; Parse-Default deals with defaults and supplied-p args for optionals
1178       ;; and keywords args.
1179       (flet ((parse-default (spec info)
1180                (when (consp (cdr spec))
1181                  (setf (arg-info-default info) (second spec))
1182                  (when (consp (cddr spec))
1183                    (let* ((supplied-p (third spec))
1184                           (supplied-var (varify-lambda-arg supplied-p
1185                                                            (names-so-far))))
1186                      (setf (arg-info-supplied-p info) supplied-var)
1187                      (names-so-far supplied-p)
1188                      (when (> (length (the list spec)) 3)
1189                        (compiler-error
1190                         "The list ~S is too long to be an arg specifier."
1191                         spec)))))))
1192         
1193         (dolist (name required)
1194           (let ((var (varify-lambda-arg name (names-so-far))))
1195             (vars var)
1196             (names-so-far name)))
1197         
1198         (dolist (spec optional)
1199           (if (atom spec)
1200               (let ((var (varify-lambda-arg spec (names-so-far))))
1201                 (setf (lambda-var-arg-info var) (make-arg-info :kind :optional))
1202                 (vars var)
1203                 (names-so-far spec))
1204               (let* ((name (first spec))
1205                      (var (varify-lambda-arg name (names-so-far)))
1206                      (info (make-arg-info :kind :optional)))
1207                 (setf (lambda-var-arg-info var) info)
1208                 (vars var)
1209                 (names-so-far name)
1210                 (parse-default spec info))))
1211         
1212         (when restp
1213           (let ((var (varify-lambda-arg rest (names-so-far))))
1214             (setf (lambda-var-arg-info var) (make-arg-info :kind :rest))
1215             (vars var)
1216             (names-so-far rest)))
1217
1218         (when morep
1219           (let ((var (varify-lambda-arg more-context (names-so-far))))
1220             (setf (lambda-var-arg-info var)
1221                   (make-arg-info :kind :more-context))
1222             (vars var)
1223             (names-so-far more-context))
1224           (let ((var (varify-lambda-arg more-count (names-so-far))))
1225             (setf (lambda-var-arg-info var)
1226                   (make-arg-info :kind :more-count))
1227             (vars var)
1228             (names-so-far more-count)))
1229         
1230         (dolist (spec keys)
1231           (cond
1232            ((atom spec)
1233             (let ((var (varify-lambda-arg spec (names-so-far))))
1234               (setf (lambda-var-arg-info var)
1235                     (make-arg-info :kind :keyword
1236                                    :keyword (make-keyword-for-arg spec
1237                                                                   (vars)
1238                                                                   t)))
1239               (vars var)
1240               (names-so-far spec)))
1241            ((atom (first spec))
1242             (let* ((name (first spec))
1243                    (var (varify-lambda-arg name (names-so-far)))
1244                    (info (make-arg-info
1245                           :kind :keyword
1246                           :keyword (make-keyword-for-arg name (vars) t))))
1247               (setf (lambda-var-arg-info var) info)
1248               (vars var)
1249               (names-so-far name)
1250               (parse-default spec info)))
1251            (t
1252             (let ((head (first spec)))
1253               (unless (proper-list-of-length-p head 2)
1254                 (error "malformed keyword arg specifier: ~S" spec))
1255               (let* ((name (second head))
1256                      (var (varify-lambda-arg name (names-so-far)))
1257                      (info (make-arg-info
1258                             :kind :keyword
1259                             :keyword (make-keyword-for-arg (first head)
1260                                                            (vars)
1261                                                            nil))))
1262                 (setf (lambda-var-arg-info var) info)
1263                 (vars var)
1264                 (names-so-far name)
1265                 (parse-default spec info))))))
1266         
1267         (dolist (spec aux)
1268           (cond ((atom spec)
1269                  (let ((var (varify-lambda-arg spec nil)))
1270                    (aux-vars var)
1271                    (aux-vals nil)
1272                    (names-so-far spec)))
1273                 (t
1274                  (unless (proper-list-of-length-p spec 1 2)
1275                    (compiler-error "malformed &AUX binding specifier: ~S"
1276                                    spec))
1277                  (let* ((name (first spec))
1278                         (var (varify-lambda-arg name nil)))
1279                    (aux-vars var)
1280                    (aux-vals (second spec))
1281                    (names-so-far name)))))
1282
1283         (values (vars) keyp allowp (aux-vars) (aux-vals))))))
1284
1285 ;;; Similar to IR1-Convert-Progn-Body except that we sequentially bind each
1286 ;;; Aux-Var to the corresponding Aux-Val before converting the body. If there
1287 ;;; are no bindings, just convert the body, otherwise do one binding and
1288 ;;; recurse on the rest.
1289 ;;;
1290 ;;;    If Interface is true, then we convert bindings with the interface
1291 ;;; policy. For real &aux bindings, and implicit aux bindings introduced by
1292 ;;; keyword bindings, this is always true. It is only false when LET* directly
1293 ;;; calls this function.
1294 (defun ir1-convert-aux-bindings (start cont body aux-vars aux-vals interface)
1295   (declare (type continuation start cont) (list body aux-vars aux-vals))
1296   (if (null aux-vars)
1297       (ir1-convert-progn-body start cont body)
1298       (let ((fun-cont (make-continuation))
1299             (fun (ir1-convert-lambda-body body (list (first aux-vars))
1300                                           (rest aux-vars) (rest aux-vals)
1301                                           interface)))
1302         (reference-leaf start fun-cont fun)
1303         (let ((*lexenv* (if interface
1304                             (make-lexenv
1305                              :cookie (make-interface-cookie *lexenv*))
1306                             *lexenv*)))
1307           (ir1-convert-combination-args fun-cont cont
1308                                         (list (first aux-vals))))))
1309   (values))
1310
1311 ;;; Similar to IR1-Convert-Progn-Body except that code to bind the Specvar
1312 ;;; for each Svar to the value of the variable is wrapped around the body. If
1313 ;;; there are no special bindings, we just convert the body, otherwise we do
1314 ;;; one special binding and recurse on the rest.
1315 ;;;
1316 ;;; We make a cleanup and introduce it into the lexical environment. If
1317 ;;; there are multiple special bindings, the cleanup for the blocks will end up
1318 ;;; being the innermost one. We force Cont to start a block outside of this
1319 ;;; cleanup, causing cleanup code to be emitted when the scope is exited.
1320 (defun ir1-convert-special-bindings (start cont body aux-vars aux-vals
1321                                            interface svars)
1322   (declare (type continuation start cont)
1323            (list body aux-vars aux-vals svars))
1324   (cond
1325    ((null svars)
1326     (ir1-convert-aux-bindings start cont body aux-vars aux-vals interface))
1327    (t
1328     (continuation-starts-block cont)
1329     (let ((cleanup (make-cleanup :kind :special-bind))
1330           (var (first svars))
1331           (next-cont (make-continuation))
1332           (nnext-cont (make-continuation)))
1333       (ir1-convert start next-cont
1334                    `(%special-bind ',(lambda-var-specvar var) ,var))
1335       (setf (cleanup-mess-up cleanup) (continuation-use next-cont))
1336       (let ((*lexenv* (make-lexenv :cleanup cleanup)))
1337         (ir1-convert next-cont nnext-cont '(%cleanup-point))
1338         (ir1-convert-special-bindings nnext-cont cont body aux-vars aux-vals
1339                                       interface (rest svars))))))
1340   (values))
1341
1342 ;;; Create a lambda node out of some code, returning the result. The
1343 ;;; bindings are specified by the list of VAR structures VARS. We deal
1344 ;;; with adding the names to the LEXENV-VARIABLES for the conversion.
1345 ;;; The result is added to the NEW-FUNCTIONS in the
1346 ;;; *CURRENT-COMPONENT* and linked to the component head and tail.
1347 ;;;
1348 ;;; We detect special bindings here, replacing the original VAR in the
1349 ;;; lambda list with a temporary variable. We then pass a list of the
1350 ;;; special vars to IR1-CONVERT-SPECIAL-BINDINGS, which actually emits
1351 ;;; the special binding code.
1352 ;;;
1353 ;;; We ignore any ARG-INFO in the VARS, trusting that someone else is
1354 ;;; dealing with &nonsense.
1355 ;;;
1356 ;;; AUX-VARS is a list of VAR structures for variables that are to be
1357 ;;; sequentially bound. Each AUX-VAL is a form that is to be evaluated
1358 ;;; to get the initial value for the corresponding AUX-VAR. Interface
1359 ;;; is a flag as T when there are real aux values (see LET* and
1360 ;;; IR1-CONVERT-AUX-BINDINGS.)
1361 (defun ir1-convert-lambda-body (body vars &optional aux-vars aux-vals
1362                                      interface result)
1363   (declare (list body vars aux-vars aux-vals)
1364            (type (or continuation null) result))
1365   (let* ((bind (make-bind))
1366          (lambda (make-lambda :vars vars :bind bind))
1367          (result (or result (make-continuation))))
1368     (setf (lambda-home lambda) lambda)
1369     (collect ((svars)
1370               (new-venv nil cons))
1371
1372       (dolist (var vars)
1373         (setf (lambda-var-home var) lambda)
1374         (let ((specvar (lambda-var-specvar var)))
1375           (cond (specvar
1376                  (svars var)
1377                  (new-venv (cons (leaf-name specvar) specvar)))
1378                 (t
1379                  (note-lexical-binding (leaf-name var))
1380                  (new-venv (cons (leaf-name var) var))))))
1381
1382       (let ((*lexenv* (make-lexenv :variables (new-venv)
1383                                    :lambda lambda
1384                                    :cleanup nil)))
1385         (setf (bind-lambda bind) lambda)
1386         (setf (node-lexenv bind) *lexenv*)
1387         
1388         (let ((cont1 (make-continuation))
1389               (cont2 (make-continuation)))
1390           (continuation-starts-block cont1)
1391           (prev-link bind cont1)
1392           (use-continuation bind cont2)
1393           (ir1-convert-special-bindings cont2 result body aux-vars aux-vals
1394                                         interface (svars)))
1395
1396         (let ((block (continuation-block result)))
1397           (when block
1398             (let ((return (make-return :result result :lambda lambda))
1399                   (tail-set (make-tail-set :functions (list lambda)))
1400                   (dummy (make-continuation)))
1401               (setf (lambda-tail-set lambda) tail-set)
1402               (setf (lambda-return lambda) return)
1403               (setf (continuation-dest result) return)
1404               (setf (block-last block) return)
1405               (prev-link return result)
1406               (use-continuation return dummy))
1407             (link-blocks block (component-tail *current-component*))))))
1408
1409     (link-blocks (component-head *current-component*) (node-block bind))
1410     (push lambda (component-new-functions *current-component*))
1411     lambda))
1412
1413 ;;; Create the actual entry-point function for an optional entry
1414 ;;; point. The lambda binds copies of each of the Vars, then calls Fun
1415 ;;; with the argument Vals and the Defaults. Presumably the Vals refer
1416 ;;; to the Vars by name. The Vals are passed in in reverse order.
1417 ;;;
1418 ;;; If any of the copies of the vars are referenced more than once,
1419 ;;; then we mark the corresponding var as Ever-Used to inhibit
1420 ;;; "defined but not read" warnings for arguments that are only used
1421 ;;; by default forms.
1422 ;;;
1423 ;;; We bind *LEXENV* to change the policy to the interface policy.
1424 (defun convert-optional-entry (fun vars vals defaults)
1425   (declare (type clambda fun) (list vars vals defaults))
1426   (let* ((fvars (reverse vars))
1427          (arg-vars (mapcar (lambda (var)
1428                              (unless (lambda-var-specvar var)
1429                                (note-lexical-binding (leaf-name var)))
1430                              (make-lambda-var
1431                               :name (leaf-name var)
1432                               :type (leaf-type var)
1433                               :where-from (leaf-where-from var)
1434                               :specvar (lambda-var-specvar var)))
1435                            fvars))
1436          (*lexenv* (make-lexenv :cookie (make-interface-cookie *lexenv*)))
1437          (fun
1438           (ir1-convert-lambda-body
1439            `((%funcall ,fun ,@(reverse vals) ,@defaults))
1440            arg-vars)))
1441     (mapc #'(lambda (var arg-var)
1442               (when (cdr (leaf-refs arg-var))
1443                 (setf (leaf-ever-used var) t)))
1444           fvars arg-vars)
1445     fun))
1446
1447 ;;; This function deals with supplied-p vars in optional arguments. If
1448 ;;; the there is no supplied-p arg, then we just call
1449 ;;; IR1-Convert-Hairy-Args on the remaining arguments, and generate a
1450 ;;; optional entry that calls the result. If there is a supplied-p
1451 ;;; var, then we add it into the default vars and throw a T into the
1452 ;;; entry values. The resulting entry point function is returned.
1453 (defun generate-optional-default-entry (res default-vars default-vals
1454                                             entry-vars entry-vals
1455                                             vars supplied-p-p body
1456                                             aux-vars aux-vals cont)
1457   (declare (type optional-dispatch res)
1458            (list default-vars default-vals entry-vars entry-vals vars body
1459                  aux-vars aux-vals)
1460            (type (or continuation null) cont))
1461   (let* ((arg (first vars))
1462          (arg-name (leaf-name arg))
1463          (info (lambda-var-arg-info arg))
1464          (supplied-p (arg-info-supplied-p info))
1465          (ep (if supplied-p
1466                  (ir1-convert-hairy-args
1467                   res
1468                   (list* supplied-p arg default-vars)
1469                   (list* (leaf-name supplied-p) arg-name default-vals)
1470                   (cons arg entry-vars)
1471                   (list* t arg-name entry-vals)
1472                   (rest vars) t body aux-vars aux-vals cont)
1473                  (ir1-convert-hairy-args
1474                   res
1475                   (cons arg default-vars)
1476                   (cons arg-name default-vals)
1477                   (cons arg entry-vars)
1478                   (cons arg-name entry-vals)
1479                   (rest vars) supplied-p-p body aux-vars aux-vals cont))))
1480
1481     (convert-optional-entry ep default-vars default-vals
1482                             (if supplied-p
1483                                 (list (arg-info-default info) nil)
1484                                 (list (arg-info-default info))))))
1485
1486 ;;; Create the More-Entry function for the Optional-Dispatch Res.
1487 ;;; Entry-Vars and Entry-Vals describe the fixed arguments. Rest is the var
1488 ;;; for any Rest arg. Keys is a list of the keyword arg vars.
1489 ;;;
1490 ;;; The most interesting thing that we do is parse keywords. We create a
1491 ;;; bunch of temporary variables to hold the result of the parse, and then loop
1492 ;;; over the supplied arguments, setting the appropriate temps for the supplied
1493 ;;; keyword. Note that it is significant that we iterate over the keywords in
1494 ;;; reverse order --- this implements the CL requirement that (when a keyword
1495 ;;; appears more than once) the first value is used.
1496 ;;;
1497 ;;; If there is no supplied-p var, then we initialize the temp to the
1498 ;;; default and just pass the temp into the main entry. Since non-constant
1499 ;;; keyword args are forcibly given a supplied-p var, we know that the default
1500 ;;; is constant, and thus safe to evaluate out of order.
1501 ;;;
1502 ;;; If there is a supplied-p var, then we create temps for both the value
1503 ;;; and the supplied-p, and pass them into the main entry, letting it worry
1504 ;;; about defaulting.
1505 ;;;
1506 ;;; We deal with :allow-other-keys by delaying unknown keyword errors until
1507 ;;; we have scanned all the keywords.
1508 ;;;
1509 ;;; When converting the function, we bind *LEXENV* to change the
1510 ;;; compilation policy over to the interface policy, so that keyword
1511 ;;; args will be checked even when type checking isn't on in general.
1512 (defun convert-more-entry (res entry-vars entry-vals rest morep keys)
1513   (declare (type optional-dispatch res) (list entry-vars entry-vals keys))
1514   (collect ((arg-vars)
1515             (arg-vals (reverse entry-vals))
1516             (temps)
1517             (body))
1518
1519     (dolist (var (reverse entry-vars))
1520       (arg-vars (make-lambda-var :name (leaf-name var)
1521                                  :type (leaf-type var)
1522                                  :where-from (leaf-where-from var))))
1523
1524     (let* ((n-context (gensym "N-CONTEXT-"))
1525            (context-temp (make-lambda-var :name n-context))
1526            (n-count (gensym "N-COUNT-"))
1527            (count-temp (make-lambda-var :name n-count
1528                                         :type (specifier-type 'index)))
1529            (*lexenv* (make-lexenv :cookie (make-interface-cookie *lexenv*))))
1530
1531       (arg-vars context-temp count-temp)
1532
1533       (when rest
1534         (arg-vals `(%listify-rest-args ,n-context ,n-count)))
1535       (when morep
1536         (arg-vals n-context)
1537         (arg-vals n-count))
1538
1539       (when (optional-dispatch-keyp res)
1540         (let ((n-index (gensym "N-INDEX-"))
1541               (n-key (gensym "N-KEY-"))
1542               (n-value-temp (gensym "N-VALUE-TEMP-"))
1543               (n-allowp (gensym "N-ALLOWP-"))
1544               (n-losep (gensym "N-LOSEP-"))
1545               (allowp (or (optional-dispatch-allowp res)
1546                           (policy nil (zerop safety)))))
1547
1548           (temps `(,n-index (1- ,n-count)) n-key n-value-temp)
1549           (body `(declare (fixnum ,n-index) (ignorable ,n-key ,n-value-temp)))
1550
1551           (collect ((tests))
1552             (dolist (key keys)
1553               (let* ((info (lambda-var-arg-info key))
1554                      (default (arg-info-default info))
1555                      (keyword (arg-info-keyword info))
1556                      (supplied-p (arg-info-supplied-p info))
1557                      (n-value (gensym "N-VALUE-")))
1558                 (temps `(,n-value ,default))
1559                 (cond (supplied-p
1560                        (let ((n-supplied (gensym "N-SUPPLIED-")))
1561                          (temps n-supplied)
1562                          (arg-vals n-value n-supplied)
1563                          ;; MNA: non-self-eval-keyword patch
1564                          (tests `((eq ,n-key ',keyword)
1565                                   (setq ,n-supplied t)
1566                                   (setq ,n-value ,n-value-temp)))))
1567                       (t
1568                        (arg-vals n-value)
1569                         ;; MNA: non-self-eval-keyword patch
1570                        (tests `((eq ,n-key ',keyword)
1571                                 (setq ,n-value ,n-value-temp)))))))
1572
1573             (unless allowp
1574               (temps n-allowp n-losep)
1575               (tests `((eq ,n-key :allow-other-keys)
1576                        (setq ,n-allowp ,n-value-temp)))
1577               (tests `(t
1578                        (setq ,n-losep ,n-key))))
1579
1580             (body
1581              `(when (oddp ,n-count)
1582                 (%odd-keyword-arguments-error)))
1583
1584             (body
1585              `(locally
1586                 (declare (optimize (safety 0)))
1587                 (loop
1588                   (when (minusp ,n-index) (return))
1589                   (setf ,n-value-temp (%more-arg ,n-context ,n-index))
1590                   (decf ,n-index)
1591                   (setq ,n-key (%more-arg ,n-context ,n-index))
1592                   (decf ,n-index)
1593                   (cond ,@(tests)))))
1594
1595             (unless allowp
1596               (body `(when (and ,n-losep (not ,n-allowp))
1597                        (%unknown-keyword-argument-error ,n-losep)))))))
1598
1599       (let ((ep (ir1-convert-lambda-body
1600                  `((let ,(temps)
1601                      ,@(body)
1602                      (%funcall ,(optional-dispatch-main-entry res)
1603                                . ,(arg-vals)))) ; FIXME: What is the '.'? ,@?
1604                  (arg-vars))))
1605         (setf (optional-dispatch-more-entry res) ep))))
1606
1607   (values))
1608
1609 ;;; Called by IR1-Convert-Hairy-Args when we run into a rest or
1610 ;;; keyword arg. The arguments are similar to that function, but we
1611 ;;; split off any rest arg and pass it in separately. Rest is the rest
1612 ;;; arg var, or NIL if there is no rest arg. Keys is a list of the
1613 ;;; keyword argument vars.
1614 ;;;
1615 ;;; When there are keyword arguments, we introduce temporary gensym
1616 ;;; variables to hold the values while keyword defaulting is in
1617 ;;; progress to get the required sequential binding semantics.
1618 ;;;
1619 ;;; This gets interesting mainly when there are keyword arguments with
1620 ;;; supplied-p vars or non-constant defaults. In either case, pass in
1621 ;;; a supplied-p var. If the default is non-constant, we introduce an
1622 ;;; IF in the main entry that tests the supplied-p var and decides
1623 ;;; whether to evaluate the default or not. In this case, the real
1624 ;;; incoming value is NIL, so we must union NULL with the declared
1625 ;;; type when computing the type for the main entry's argument.
1626 (defun ir1-convert-more (res default-vars default-vals entry-vars entry-vals
1627                              rest more-context more-count keys supplied-p-p
1628                              body aux-vars aux-vals cont)
1629   (declare (type optional-dispatch res)
1630            (list default-vars default-vals entry-vars entry-vals keys body
1631                  aux-vars aux-vals)
1632            (type (or continuation null) cont))
1633   (collect ((main-vars (reverse default-vars))
1634             (main-vals default-vals cons)
1635             (bind-vars)
1636             (bind-vals))
1637     (when rest
1638       (main-vars rest)
1639       (main-vals '()))
1640     (when more-context
1641       (main-vars more-context)
1642       (main-vals nil)
1643       (main-vars more-count)
1644       (main-vals 0))
1645
1646     (dolist (key keys)
1647       (let* ((info (lambda-var-arg-info key))
1648              (default (arg-info-default info))
1649              (hairy-default (not (sb!xc:constantp default)))
1650              (supplied-p (arg-info-supplied-p info))
1651              (n-val (make-symbol (format nil
1652                                          "~A-DEFAULTING-TEMP"
1653                                          (leaf-name key))))
1654              (key-type (leaf-type key))
1655              (val-temp (make-lambda-var
1656                         :name n-val
1657                         :type (if hairy-default
1658                                   (type-union key-type (specifier-type 'null))
1659                                   key-type))))
1660         (main-vars val-temp)
1661         (bind-vars key)
1662         (cond ((or hairy-default supplied-p)
1663                (let* ((n-supplied (gensym "N-SUPPLIED-"))
1664                       (supplied-temp (make-lambda-var :name n-supplied)))
1665                  (unless supplied-p
1666                    (setf (arg-info-supplied-p info) supplied-temp))
1667                  (when hairy-default
1668                    (setf (arg-info-default info) nil))
1669                  (main-vars supplied-temp)
1670                  (cond (hairy-default
1671                         (main-vals nil nil)
1672                         (bind-vals `(if ,n-supplied ,n-val ,default)))
1673                        (t
1674                         (main-vals default nil)
1675                         (bind-vals n-val)))
1676                  (when supplied-p
1677                    (bind-vars supplied-p)
1678                    (bind-vals n-supplied))))
1679               (t
1680                (main-vals (arg-info-default info))
1681                (bind-vals n-val)))))
1682
1683     (let* ((main-entry (ir1-convert-lambda-body body (main-vars)
1684                                                 (append (bind-vars) aux-vars)
1685                                                 (append (bind-vals) aux-vals)
1686                                                 t
1687                                                 cont))
1688            (last-entry (convert-optional-entry main-entry default-vars
1689                                                (main-vals) ())))
1690       (setf (optional-dispatch-main-entry res) main-entry)
1691       (convert-more-entry res entry-vars entry-vals rest more-context keys)
1692
1693       (push (if supplied-p-p
1694                 (convert-optional-entry last-entry entry-vars entry-vals ())
1695                 last-entry)
1696             (optional-dispatch-entry-points res))
1697       last-entry)))
1698
1699 ;;; This function generates the entry point functions for the
1700 ;;; optional-dispatch Res. We accomplish this by recursion on the list of
1701 ;;; arguments, analyzing the arglist on the way down and generating entry
1702 ;;; points on the way up.
1703 ;;;
1704 ;;; Default-Vars is a reversed list of all the argument vars processed so
1705 ;;; far, including supplied-p vars. Default-Vals is a list of the names of the
1706 ;;; Default-Vars.
1707 ;;;
1708 ;;; Entry-Vars is a reversed list of processed argument vars, excluding
1709 ;;; supplied-p vars. Entry-Vals is a list things that can be evaluated to get
1710 ;;; the values for all the vars from the Entry-Vars. It has the var name for
1711 ;;; each required or optional arg, and has T for each supplied-p arg.
1712 ;;;
1713 ;;; Vars is a list of the Lambda-Var structures for arguments that haven't
1714 ;;; been processed yet. Supplied-p-p is true if a supplied-p argument has
1715 ;;; already been processed; only in this case are the Default-XXX and Entry-XXX
1716 ;;; different.
1717 ;;;
1718 ;;; The result at each point is a lambda which should be called by the above
1719 ;;; level to default the remaining arguments and evaluate the body. We cause
1720 ;;; the body to be evaluated by converting it and returning it as the result
1721 ;;; when the recursion bottoms out.
1722 ;;;
1723 ;;; Each level in the recursion also adds its entry point function to the
1724 ;;; result Optional-Dispatch. For most arguments, the defaulting function and
1725 ;;; the entry point function will be the same, but when supplied-p args are
1726 ;;; present they may be different.
1727 ;;;
1728 ;;; When we run into a rest or keyword arg, we punt out to
1729 ;;; IR1-Convert-More, which finishes for us in this case.
1730 (defun ir1-convert-hairy-args (res default-vars default-vals
1731                                    entry-vars entry-vals
1732                                    vars supplied-p-p body aux-vars
1733                                    aux-vals cont)
1734   (declare (type optional-dispatch res)
1735            (list default-vars default-vals entry-vars entry-vals vars body
1736                  aux-vars aux-vals)
1737            (type (or continuation null) cont))
1738   (cond ((not vars)
1739          (if (optional-dispatch-keyp res)
1740              ;; Handle &KEY with no keys...
1741              (ir1-convert-more res default-vars default-vals
1742                                entry-vars entry-vals
1743                                nil nil nil vars supplied-p-p body aux-vars
1744                                aux-vals cont)
1745              (let ((fun (ir1-convert-lambda-body body (reverse default-vars)
1746                                                  aux-vars aux-vals t cont)))
1747                (setf (optional-dispatch-main-entry res) fun)
1748                (push (if supplied-p-p
1749                          (convert-optional-entry fun entry-vars entry-vals ())
1750                          fun)
1751                      (optional-dispatch-entry-points res))
1752                fun)))
1753         ((not (lambda-var-arg-info (first vars)))
1754          (let* ((arg (first vars))
1755                 (nvars (cons arg default-vars))
1756                 (nvals (cons (leaf-name arg) default-vals)))
1757            (ir1-convert-hairy-args res nvars nvals nvars nvals
1758                                    (rest vars) nil body aux-vars aux-vals
1759                                    cont)))
1760         (t
1761          (let* ((arg (first vars))
1762                 (info (lambda-var-arg-info arg))
1763                 (kind (arg-info-kind info)))
1764            (ecase kind
1765              (:optional
1766               (let ((ep (generate-optional-default-entry
1767                          res default-vars default-vals
1768                          entry-vars entry-vals vars supplied-p-p body
1769                          aux-vars aux-vals cont)))
1770                 (push (if supplied-p-p
1771                           (convert-optional-entry ep entry-vars entry-vals ())
1772                           ep)
1773                       (optional-dispatch-entry-points res))
1774                 ep))
1775              (:rest
1776               (ir1-convert-more res default-vars default-vals
1777                                 entry-vars entry-vals
1778                                 arg nil nil (rest vars) supplied-p-p body
1779                                 aux-vars aux-vals cont))
1780              (:more-context
1781               (ir1-convert-more res default-vars default-vals
1782                                 entry-vars entry-vals
1783                                 nil arg (second vars) (cddr vars) supplied-p-p
1784                                 body aux-vars aux-vals cont))
1785              (:keyword
1786               (ir1-convert-more res default-vars default-vals
1787                                 entry-vars entry-vals
1788                                 nil nil nil vars supplied-p-p body aux-vars
1789                                 aux-vals cont)))))))
1790
1791 ;;; This function deals with the case where we have to make an
1792 ;;; Optional-Dispatch to represent a lambda. We cons up the result and call
1793 ;;; IR1-Convert-Hairy-Args to do the work. When it is done, we figure out the
1794 ;;; min-args and max-args.
1795 (defun ir1-convert-hairy-lambda (body vars keyp allowp aux-vars aux-vals cont)
1796   (declare (list body vars aux-vars aux-vals) (type continuation cont))
1797   (let ((res (make-optional-dispatch :arglist vars
1798                                      :allowp allowp
1799                                      :keyp keyp))
1800         (min (or (position-if #'lambda-var-arg-info vars) (length vars))))
1801     (push res (component-new-functions *current-component*))
1802     (ir1-convert-hairy-args res () () () () vars nil body aux-vars aux-vals
1803                             cont)
1804     (setf (optional-dispatch-min-args res) min)
1805     (setf (optional-dispatch-max-args res)
1806           (+ (1- (length (optional-dispatch-entry-points res))) min))
1807
1808     (flet ((frob (ep)
1809              (when ep
1810                (setf (functional-kind ep) :optional)
1811                (setf (leaf-ever-used ep) t)
1812                (setf (lambda-optional-dispatch ep) res))))
1813       (dolist (ep (optional-dispatch-entry-points res)) (frob ep))
1814       (frob (optional-dispatch-more-entry res))
1815       (frob (optional-dispatch-main-entry res)))
1816
1817     res))
1818
1819 ;;; Convert a Lambda into a Lambda or Optional-Dispatch leaf.
1820 (defun ir1-convert-lambda (form &optional name)
1821   (unless (consp form)
1822     (compiler-error "A ~S was found when expecting a lambda expression:~%  ~S"
1823                     (type-of form)
1824                     form))
1825   (unless (eq (car form) 'lambda)
1826     (compiler-error "~S was expected but ~S was found:~%  ~S"
1827                     'lambda
1828                     (car form)
1829                     form))
1830   (unless (and (consp (cdr form)) (listp (cadr form)))
1831     (compiler-error
1832      "The lambda expression has a missing or non-list lambda-list:~%  ~S"
1833      form))
1834
1835   (multiple-value-bind (vars keyp allow-other-keys aux-vars aux-vals)
1836       (find-lambda-vars (cadr form))
1837     (multiple-value-bind (forms decls) (sb!sys:parse-body (cddr form))
1838       (let* ((cont (make-continuation))
1839              (*lexenv* (process-decls decls
1840                                       (append aux-vars vars)
1841                                       nil cont))
1842              (res (if (or (find-if #'lambda-var-arg-info vars) keyp)
1843                       (ir1-convert-hairy-lambda forms vars keyp
1844                                                 allow-other-keys
1845                                                 aux-vars aux-vals cont)
1846                       (ir1-convert-lambda-body forms vars aux-vars aux-vals
1847                                                t cont))))
1848         (setf (functional-inline-expansion res) form)
1849         (setf (functional-arg-documentation res) (cadr form))
1850         (setf (leaf-name res) name)
1851         res))))
1852 \f
1853 ;;; FIXME: This file is rather long, and contains two distinct sections,
1854 ;;; transform machinery above this point and transforms themselves below this
1855 ;;; point. Why not split it in two? (ir1translate.lisp and
1856 ;;; ir1translators.lisp?) Then consider byte-compiling the translators, too.
1857 \f
1858 ;;;; control special forms
1859
1860 (def-ir1-translator progn ((&rest forms) start cont)
1861   #!+sb-doc
1862   "Progn Form*
1863   Evaluates each Form in order, returning the values of the last form. With no
1864   forms, returns NIL."
1865   (ir1-convert-progn-body start cont forms))
1866
1867 (def-ir1-translator if ((test then &optional else) start cont)
1868   #!+sb-doc
1869   "If Predicate Then [Else]
1870   If Predicate evaluates to non-null, evaluate Then and returns its values,
1871   otherwise evaluate Else and return its values. Else defaults to NIL."
1872   (let* ((pred (make-continuation))
1873          (then-cont (make-continuation))
1874          (then-block (continuation-starts-block then-cont))
1875          (else-cont (make-continuation))
1876          (else-block (continuation-starts-block else-cont))
1877          (dummy-cont (make-continuation))
1878          (node (make-if :test pred
1879                         :consequent then-block
1880                         :alternative else-block)))
1881     (setf (continuation-dest pred) node)
1882     (ir1-convert start pred test)
1883     (prev-link node pred)
1884     (use-continuation node dummy-cont)
1885
1886     (let ((start-block (continuation-block pred)))
1887       (setf (block-last start-block) node)
1888       (continuation-starts-block cont)
1889
1890       (link-blocks start-block then-block)
1891       (link-blocks start-block else-block)
1892
1893       (ir1-convert then-cont cont then)
1894       (ir1-convert else-cont cont else))))
1895 \f
1896 ;;;; BLOCK and TAGBODY
1897
1898 ;;;; We make an Entry node to mark the start and a :Entry cleanup to
1899 ;;;; mark its extent. When doing GO or RETURN-FROM, we emit an Exit
1900 ;;;; node.
1901
1902 ;;; Make a :entry cleanup and emit an Entry node, then convert the
1903 ;;; body in the modified environment. We make Cont start a block now,
1904 ;;; since if it was done later, the block would be in the wrong
1905 ;;; environment.
1906 (def-ir1-translator block ((name &rest forms) start cont)
1907   #!+sb-doc
1908   "Block Name Form*
1909   Evaluate the Forms as a PROGN. Within the lexical scope of the body,
1910   (RETURN-FROM Name Value-Form) can be used to exit the form, returning the
1911   result of Value-Form."
1912   (unless (symbolp name)
1913     (compiler-error "The block name ~S is not a symbol." name))
1914   (continuation-starts-block cont)
1915   (let* ((dummy (make-continuation))
1916          (entry (make-entry))
1917          (cleanup (make-cleanup :kind :block
1918                                 :mess-up entry)))
1919     (push entry (lambda-entries (lexenv-lambda *lexenv*)))
1920     (setf (entry-cleanup entry) cleanup)
1921     (prev-link entry start)
1922     (use-continuation entry dummy)
1923     
1924     ;; MNA - Re: two obscure bugs in CMU CL
1925     (let* ((env-entry (list entry cont))
1926            (*lexenv*
1927             (make-lexenv :blocks (list (cons name env-entry))
1928                                  :cleanup cleanup)))
1929       (push env-entry (continuation-lexenv-uses cont))
1930       (ir1-convert-progn-body dummy cont forms))))
1931
1932
1933 ;;; We make Cont start a block just so that it will have a block
1934 ;;; assigned. People assume that when they pass a continuation into
1935 ;;; IR1-Convert as Cont, it will have a block when it is done.
1936 (def-ir1-translator return-from ((name &optional value)
1937                                  start cont)
1938   #!+sb-doc
1939   "Return-From Block-Name Value-Form
1940   Evaluate the Value-Form, returning its values from the lexically enclosing
1941   BLOCK Block-Name. This is constrained to be used only within the dynamic
1942   extent of the BLOCK."
1943   (continuation-starts-block cont)
1944   (let* ((found (or (lexenv-find name blocks)
1945                     (compiler-error "return for unknown block: ~S" name)))
1946          (value-cont (make-continuation))
1947          (entry (first found))
1948          (exit (make-exit :entry entry
1949                           :value value-cont)))
1950     (push exit (entry-exits entry))
1951     (setf (continuation-dest value-cont) exit)
1952     (ir1-convert start value-cont value)
1953     (prev-link exit value-cont)
1954     (use-continuation exit (second found))))
1955
1956 ;;; Return a list of the segments of a tagbody. Each segment looks
1957 ;;; like (<tag> <form>* (go <next tag>)). That is, we break up the
1958 ;;; tagbody into segments of non-tag statements, and explicitly
1959 ;;; represent the drop-through with a GO. The first segment has a
1960 ;;; dummy NIL tag, since it represents code before the first tag. The
1961 ;;; last segment (which may also be the first segment) ends in NIL
1962 ;;; rather than a GO.
1963 (defun parse-tagbody (body)
1964   (declare (list body))
1965   (collect ((segments))
1966     (let ((current (cons nil body)))
1967       (loop
1968         (let ((tag-pos (position-if-not #'listp current :start 1)))
1969           (unless tag-pos
1970             (segments `(,@current nil))
1971             (return))
1972           (let ((tag (elt current tag-pos)))
1973             (when (assoc tag (segments))
1974               (compiler-error
1975                "The tag ~S appears more than once in the tagbody."
1976                tag))
1977             (unless (or (symbolp tag) (integerp tag))
1978               (compiler-error "~S is not a legal tagbody statement." tag))
1979             (segments `(,@(subseq current 0 tag-pos) (go ,tag))))
1980           (setq current (nthcdr tag-pos current)))))
1981     (segments)))
1982
1983 ;;; Set up the cleanup, emitting the entry node. Then make a block for
1984 ;;; each tag, building up the tag list for LEXENV-TAGS as we go.
1985 ;;; Finally, convert each segment with the precomputed Start and Cont
1986 ;;; values.
1987 (def-ir1-translator tagbody ((&rest statements) start cont)
1988   #!+sb-doc
1989   "Tagbody {Tag | Statement}*
1990   Define tags for used with GO. The Statements are evaluated in order
1991   (skipping Tags) and NIL is returned. If a statement contains a GO to a
1992   defined Tag within the lexical scope of the form, then control is transferred
1993   to the next statement following that tag. A Tag must an integer or a
1994   symbol. A statement must be a list. Other objects are illegal within the
1995   body."
1996   (continuation-starts-block cont)
1997   (let* ((dummy (make-continuation))
1998          (entry (make-entry))
1999          (segments (parse-tagbody statements))
2000          (cleanup (make-cleanup :kind :tagbody
2001                                 :mess-up entry)))
2002     (push entry (lambda-entries (lexenv-lambda *lexenv*)))
2003     (setf (entry-cleanup entry) cleanup)
2004     (prev-link entry start)
2005     (use-continuation entry dummy)
2006
2007     (collect ((tags)
2008               (starts)
2009               (conts))
2010       (starts dummy)
2011       (dolist (segment (rest segments))
2012         ;; MNA - Re: two obscure bugs
2013         (let* ((tag-cont (make-continuation))
2014                (tag (list (car segment) entry tag-cont)))          
2015           (conts tag-cont)
2016           (starts tag-cont)
2017           (continuation-starts-block tag-cont)
2018           (tags tag)
2019           (push (cdr tag) (continuation-lexenv-uses tag-cont))
2020           ))
2021       (conts cont)
2022
2023       (let ((*lexenv* (make-lexenv :cleanup cleanup :tags (tags))))
2024         (mapc #'(lambda (segment start cont)
2025                   (ir1-convert-progn-body start cont (rest segment)))
2026               segments (starts) (conts))))))
2027
2028 ;;; Emit an Exit node without any value.
2029 (def-ir1-translator go ((tag) start cont)
2030   #!+sb-doc
2031   "Go Tag
2032   Transfer control to the named Tag in the lexically enclosing TAGBODY. This
2033   is constrained to be used only within the dynamic extent of the TAGBODY."
2034   (continuation-starts-block cont)
2035   (let* ((found (or (lexenv-find tag tags :test #'eql)
2036                     (compiler-error "Go to nonexistent tag: ~S." tag)))
2037          (entry (first found))
2038          (exit (make-exit :entry entry)))
2039     (push exit (entry-exits entry))
2040     (prev-link exit start)
2041     (use-continuation exit (second found))))
2042 \f
2043 ;;;; translators for compiler-magic special forms
2044
2045 ;;; Do stuff to do an EVAL-WHEN. This is split off from the IR1
2046 ;;; convert method so that it can be shared by the special-case
2047 ;;; top-level form processing code. We play with the dynamic
2048 ;;; environment and eval stuff, then call Fun with a list of forms to
2049 ;;; be processed at load time.
2050 ;;;
2051 ;;; Note: the EVAL situation is always ignored: this is conceptually a
2052 ;;; compile-only implementation.
2053 ;;;
2054 ;;; We have to interact with the interpreter to ensure that the forms
2055 ;;; get EVAL'ed exactly once. We bind *ALREADY-EVALED-THIS* to true to
2056 ;;; inhibit evaluation of any enclosed EVAL-WHENs, either by IR1
2057 ;;; conversion done by EVAL, or by conversion of the body for
2058 ;;; load-time processing. If *ALREADY-EVALED-THIS* is true then we *do
2059 ;;; not* EVAL since some enclosing EVAL-WHEN already did.
2060 ;;;
2061 ;;; We know we are EVAL'ing for LOAD since we wouldn't get called
2062 ;;; otherwise. If LOAD is a situation we call FUN on body. If we
2063 ;;; aren't evaluating for LOAD, then we call FUN on NIL for the result
2064 ;;; of the EVAL-WHEN.
2065 (defun do-eval-when-stuff (situations body fun)
2066
2067   (when (or (not (listp situations))
2068             (set-difference situations
2069                             '(compile load eval
2070                               :compile-toplevel :load-toplevel :execute)))
2071     (compiler-error "bad EVAL-WHEN situation list: ~S" situations))
2072
2073   (let ((deprecated-names (intersection situations '(compile load eval))))
2074     (when deprecated-names
2075       (style-warn "using deprecated EVAL-WHEN situation names ~S"
2076                   deprecated-names)))
2077
2078   (let* ((do-eval (and (intersection '(compile :compile-toplevel) situations)
2079                        (not sb!eval::*already-evaled-this*)))
2080          (sb!eval::*already-evaled-this* t))
2081     (when do-eval
2082
2083       ;; This is the natural way to do it.
2084       #-(and sb-xc-host (or sbcl cmu))
2085       (eval `(progn ,@body))
2086
2087       ;; This is a disgusting hack to work around bug IR1-3 when using
2088       ;; SBCL (or CMU CL, for that matter) as a cross-compilation
2089       ;; host. When we go from the cross-compiler (where we bound
2090       ;; SB!EVAL::*ALREADY-EVALED-THIS*) to the host compiler (which
2091       ;; has a separate SB-EVAL::*ALREADY-EVALED-THIS* variable), EVAL
2092       ;; would go and executes nested EVAL-WHENs even when they're not
2093       ;; toplevel forms. Using EVAL-WHEN instead of bare EVAL causes
2094       ;; the cross-compilation host to bind its own
2095       ;; *ALREADY-EVALED-THIS* variable, so that the problem is
2096       ;; suppressed.
2097       ;;
2098       ;; FIXME: Once bug IR1-3 is fixed, this hack can go away. (Or if
2099       ;; CMU CL doesn't fix the bug, then this hack can be made
2100       ;; conditional on #+CMU.)
2101       #+(and sb-xc-host (or sbcl cmu))
2102       (let (#+sbcl (sb-eval::*already-evaled-this* t)
2103             #+cmu (stub:probably similar but has not been tested))
2104         (eval `(eval-when (:compile-toplevel :load-toplevel :execute)
2105                  ,@body))))
2106
2107     (if (or (intersection '(:load-toplevel load) situations)
2108             (and *converting-for-interpreter*
2109                  (intersection '(:execute eval) situations)))
2110         (funcall fun body)
2111         (funcall fun '(nil)))))
2112
2113 (def-ir1-translator eval-when ((situations &rest body) start cont)
2114   #!+sb-doc
2115   "EVAL-WHEN (Situation*) Form*
2116   Evaluate the Forms in the specified Situations, any of COMPILE, LOAD, EVAL.
2117   This is conceptually a compile-only implementation, so EVAL is a no-op."
2118
2119   ;; It's difficult to handle EVAL-WHENs completely correctly in the
2120   ;; cross-compiler. (Common Lisp is not a cross-compiler-friendly
2121   ;; language..) Since we, the system implementors, control not only
2122   ;; the cross-compiler but also the code that it processes, we can
2123   ;; handle this either by making the cross-compiler smarter about
2124   ;; handling EVAL-WHENs (hard) or by avoiding the use of difficult
2125   ;; EVAL-WHEN constructs (relatively easy). However, since EVAL-WHENs
2126   ;; can be generated by many macro expansions, it's not always easy
2127   ;; to detect problems by skimming the source code, so we'll try to
2128   ;; add some code here to help out.
2129   ;;
2130   ;; Nested EVAL-WHENs are tricky.
2131   #+sb-xc-host
2132   (labels ((contains-toplevel-eval-when-p (body-part)
2133              (and (consp body-part)
2134                   (or (eq (first body-part) 'eval-when)
2135                       (and (member (first body-part)
2136                                    '(locally macrolet progn symbol-macrolet))
2137                            (some #'contains-toplevel-eval-when-p
2138                                  (rest body-part)))))))
2139     (/show "testing for nested EVAL-WHENs" body)
2140     (when (some #'contains-toplevel-eval-when-p body)
2141       (compiler-style-warning "nested EVAL-WHENs in cross-compilation")))
2142
2143   (do-eval-when-stuff situations
2144                       body
2145                       (lambda (forms)
2146                         (ir1-convert-progn-body start cont forms))))
2147
2148 ;;; Like DO-EVAL-WHEN-STUFF, only do a MACROLET. FUN is not passed any
2149 ;;; arguments.
2150 (defun do-macrolet-stuff (definitions fun)
2151   (declare (list definitions) (type function fun))
2152   (let ((whole (gensym "WHOLE"))
2153         (environment (gensym "ENVIRONMENT")))
2154     (collect ((new-fenv))
2155       (dolist (def definitions)
2156         (let ((name (first def))
2157               (arglist (second def))
2158               (body (cddr def)))
2159           (unless (symbolp name)
2160             (compiler-error "The local macro name ~S is not a symbol." name))
2161           (when (< (length def) 2)
2162             (compiler-error
2163              "The list ~S is too short to be a legal local macro definition."
2164              name))
2165           (multiple-value-bind (body local-decs)
2166               (parse-defmacro arglist whole body name 'macrolet
2167                               :environment environment)
2168             (new-fenv `(,(first def) macro .
2169                         ,(coerce `(lambda (,whole ,environment)
2170                                     ,@local-decs (block ,name ,body))
2171                                  'function))))))
2172
2173       (let ((*lexenv* (make-lexenv :functions (new-fenv))))
2174         (funcall fun))))
2175
2176   (values))
2177
2178 (def-ir1-translator macrolet ((definitions &rest body) start cont)
2179   #!+sb-doc
2180   "MACROLET ({(Name Lambda-List Form*)}*) Body-Form*
2181   Evaluate the Body-Forms in an environment with the specified local macros
2182   defined. Name is the local macro name, Lambda-List is the DEFMACRO style
2183   destructuring lambda list, and the Forms evaluate to the expansion. The
2184   Forms are evaluated in the null environment."
2185   (do-macrolet-stuff definitions
2186                      #'(lambda ()
2187                          (ir1-convert-progn-body start cont body))))
2188
2189 ;;; not really a special form, but..
2190 (def-ir1-translator declare ((&rest stuff) start cont)
2191   (declare (ignore stuff))
2192   ;; We ignore START and CONT too, but we can't use DECLARE IGNORE to
2193   ;; tell the compiler about it here, because the DEF-IR1-TRANSLATOR
2194   ;; macro would put the DECLARE in the wrong place, so..
2195   start cont
2196   (compiler-error "misplaced declaration"))
2197 \f
2198 ;;;; %PRIMITIVE
2199 ;;;;
2200 ;;;; Uses of %PRIMITIVE are either expanded into Lisp code or turned
2201 ;;;; into a funny function.
2202
2203 ;;; Carefully evaluate a list of forms, returning a list of the results.
2204 (defun eval-info-args (args)
2205   (declare (list args))
2206   (handler-case (mapcar #'eval args)
2207     (error (condition)
2208       (compiler-error "Lisp error during evaluation of info args:~%~A"
2209                       condition))))
2210
2211 ;;; a hashtable that translates from primitive names to translation functions
2212 (defvar *primitive-translators* (make-hash-table :test 'eq))
2213
2214 ;;; If there is a primitive translator, then we expand the call.
2215 ;;; Otherwise, we convert to the %%PRIMITIVE funny function. The first
2216 ;;; argument is the template, the second is a list of the results of
2217 ;;; any codegen-info args, and the remaining arguments are the runtime
2218 ;;; arguments.
2219 ;;;
2220 ;;; We do a bunch of error checking now so that we don't bomb out with
2221 ;;; a fatal error during IR2 conversion.
2222 ;;;
2223 ;;; KLUDGE: It's confusing having multiple names floating around for
2224 ;;; nearly the same concept: PRIMITIVE, TEMPLATE, VOP. Might it be
2225 ;;; possible to reimplement BYTE-BLT (the only use of
2226 ;;; *PRIMITIVE-TRANSLATORS*) some other way, then get rid of primitive
2227 ;;; translators altogether, so that there would be no distinction
2228 ;;; between primitives and vops? Then we could call primitives vops,
2229 ;;; rename TEMPLATE to VOP-TEMPLATE, rename BACKEND-TEMPLATE-NAMES to
2230 ;;; BACKEND-VOPS, and rename %PRIMITIVE to VOP.. -- WHN 19990906
2231 ;;; FIXME: Look at doing this ^, it doesn't look too hard actually. I
2232 ;;; think BYTE-BLT could probably just become an inline function.
2233 (def-ir1-translator %primitive ((&whole form name &rest args) start cont)
2234
2235   (unless (symbolp name)
2236     (compiler-error "The primitive name ~S is not a symbol." name))
2237
2238   (let* ((translator (gethash name *primitive-translators*)))
2239     (if translator
2240         (ir1-convert start cont (funcall translator (cdr form)))
2241         (let* ((template (or (gethash name *backend-template-names*)
2242                              (compiler-error
2243                               "The primitive name ~A is not defined."
2244                               name)))
2245                (required (length (template-arg-types template)))
2246                (info (template-info-arg-count template))
2247                (min (+ required info))
2248                (nargs (length args)))
2249           (if (template-more-args-type template)
2250               (when (< nargs min)
2251                 (compiler-error "Primitive ~A was called with ~R argument~:P, ~
2252                                  but wants at least ~R."
2253                                 name
2254                                 nargs
2255                                 min))
2256               (unless (= nargs min)
2257                 (compiler-error "Primitive ~A was called with ~R argument~:P, ~
2258                                  but wants exactly ~R."
2259                                 name
2260                                 nargs
2261                                 min)))
2262
2263           (when (eq (template-result-types template) :conditional)
2264             (compiler-error
2265              "%PRIMITIVE was used with a conditional template."))
2266
2267           (when (template-more-results-type template)
2268             (compiler-error
2269              "%PRIMITIVE was used with an unknown values template."))
2270
2271           (ir1-convert start
2272                        cont
2273                       `(%%primitive ',template
2274                                     ',(eval-info-args
2275                                        (subseq args required min))
2276                                     ,@(subseq args 0 required)
2277                                     ,@(subseq args min)))))))
2278 \f
2279 ;;;; QUOTE and FUNCTION
2280
2281 (def-ir1-translator quote ((thing) start cont)
2282   #!+sb-doc
2283   "QUOTE Value
2284   Return Value without evaluating it."
2285   (reference-constant start cont thing))
2286
2287 (def-ir1-translator function ((thing) start cont)
2288   #!+sb-doc
2289   "FUNCTION Name
2290   Return the lexically apparent definition of the function Name. Name may also
2291   be a lambda."
2292   (if (consp thing)
2293       (case (car thing)
2294         ((lambda)
2295          (reference-leaf start cont (ir1-convert-lambda thing)))
2296         ((setf)
2297          (let ((var (find-lexically-apparent-function
2298                      thing "as the argument to FUNCTION")))
2299            (reference-leaf start cont var)))
2300         ((instance-lambda)
2301          (let ((res (ir1-convert-lambda `(lambda ,@(cdr thing)))))
2302            (setf (getf (functional-plist res) :fin-function) t)
2303            (reference-leaf start cont res)))
2304         (t
2305          (compiler-error "~S is not a legal function name." thing)))
2306       (let ((var (find-lexically-apparent-function
2307                   thing "as the argument to FUNCTION")))
2308         (reference-leaf start cont var))))
2309 \f
2310 ;;;; FUNCALL
2311
2312 ;;; FUNCALL is implemented on %FUNCALL, which can only call functions
2313 ;;; (not symbols). %FUNCALL is used directly in some places where the
2314 ;;; call should always be open-coded even if FUNCALL is :NOTINLINE.
2315 (deftransform funcall ((function &rest args) * * :when :both)
2316   (let ((arg-names (make-gensym-list (length args))))
2317     `(lambda (function ,@arg-names)
2318        (%funcall ,(if (csubtypep (continuation-type function)
2319                                  (specifier-type 'function))
2320                       'function
2321                       '(%coerce-callable-to-function function))
2322                  ,@arg-names))))
2323
2324 (def-ir1-translator %funcall ((function &rest args) start cont)
2325   (let ((fun-cont (make-continuation)))
2326     (ir1-convert start fun-cont function)
2327     (assert-continuation-type fun-cont (specifier-type 'function))
2328     (ir1-convert-combination-args fun-cont cont args)))
2329
2330 ;;; This source transform exists to reduce the amount of work for the
2331 ;;; compiler. If the called function is a FUNCTION form, then convert
2332 ;;; directly to %FUNCALL, instead of waiting around for type
2333 ;;; inference.
2334 (def-source-transform funcall (function &rest args)
2335   (if (and (consp function) (eq (car function) 'function))
2336       `(%funcall ,function ,@args)
2337       (values nil t)))
2338
2339 (deftransform %coerce-callable-to-function ((thing) (function) *
2340                                             :when :both
2341                                             :important t)
2342   "optimize away possible call to FDEFINITION at runtime"
2343   'thing)
2344 \f
2345 ;;;; symbol macros
2346
2347 (def-ir1-translator symbol-macrolet ((specs &body body) start cont)
2348   #!+sb-doc
2349   "SYMBOL-MACROLET ({(Name Expansion)}*) Decl* Form*
2350   Define the Names as symbol macros with the given Expansions. Within the
2351   body, references to a Name will effectively be replaced with the Expansion."
2352   (multiple-value-bind (forms decls) (sb!sys:parse-body body nil)
2353     (collect ((res))
2354       (dolist (spec specs)
2355         (unless (proper-list-of-length-p spec 2)
2356           (compiler-error "The symbol macro binding ~S is malformed." spec))
2357         (let ((name (first spec))
2358               (def (second spec)))
2359           (unless (symbolp name)
2360             (compiler-error "The symbol macro name ~S is not a symbol." name))
2361           (when (assoc name (res) :test #'eq)
2362             (compiler-style-warning
2363              "The name ~S occurs more than once in SYMBOL-MACROLET."
2364              name))
2365           (res `(,name . (MACRO . ,def)))))
2366
2367       (let* ((*lexenv* (make-lexenv :variables (res)))
2368              (*lexenv* (process-decls decls (res) nil cont)))
2369         (ir1-convert-progn-body start cont forms)))))
2370 \f
2371 ;;; This is a frob that DEFSTRUCT expands into to establish the compiler
2372 ;;; semantics. The other code in the expansion and %%COMPILER-DEFSTRUCT do
2373 ;;; most of the work, we just clear all of the functions out of
2374 ;;; *FREE-FUNCTIONS* to keep things in synch. %%COMPILER-DEFSTRUCT is also
2375 ;;; called at load-time.
2376 (def-ir1-translator %compiler-defstruct ((info) start cont :kind :function)
2377   (let* ((info (eval info)))
2378     (%%compiler-defstruct info)
2379     (dolist (slot (dd-slots info))
2380       (let ((fun (dsd-accessor slot)))
2381         (remhash fun *free-functions*)
2382         (unless (dsd-read-only slot)
2383           (remhash `(setf ,fun) *free-functions*))))
2384     (remhash (dd-predicate info) *free-functions*)
2385     (remhash (dd-copier info) *free-functions*)
2386     (ir1-convert start cont `(%%compiler-defstruct ',info))))
2387
2388 ;;; Return the contents of a quoted form.
2389 (defun unquote (x)
2390   (if (and (consp x)
2391            (= 2 (length x))
2392            (eq 'quote (first x)))
2393     (second x)
2394     (error "not a quoted form")))
2395
2396 ;;; Don't actually compile anything, instead call the function now.
2397 (def-ir1-translator %compiler-only-defstruct
2398                     ((info inherits) start cont :kind :function)
2399   (function-%compiler-only-defstruct (unquote info) (unquote inherits))
2400   (reference-constant start cont nil))
2401 \f
2402 ;;;; LET and LET*
2403 ;;;;
2404 ;;;; (LET and LET* can't be implemented as macros due to the fact that
2405 ;;;; any pervasive declarations also affect the evaluation of the
2406 ;;;; arguments.)
2407
2408 ;;; Given a list of binding specifiers in the style of Let, return:
2409 ;;;  1. The list of var structures for the variables bound.
2410 ;;;  2. The initial value form for each variable.
2411 ;;;
2412 ;;; The variable names are checked for legality and globally special
2413 ;;; variables are marked as such. Context is the name of the form, for
2414 ;;; error reporting purposes.
2415 (declaim (ftype (function (list symbol) (values list list list))
2416                 extract-let-variables))
2417 (defun extract-let-variables (bindings context)
2418   (collect ((vars)
2419             (vals)
2420             (names))
2421     (flet ((get-var (name)
2422              (varify-lambda-arg name
2423                                 (if (eq context 'let*)
2424                                     nil
2425                                     (names)))))
2426       (dolist (spec bindings)
2427         (cond ((atom spec)
2428                (let ((var (get-var spec)))
2429                  (vars var)
2430                  (names (cons spec var))
2431                  (vals nil)))
2432               (t
2433                (unless (proper-list-of-length-p spec 1 2)
2434                  (compiler-error "The ~S binding spec ~S is malformed."
2435                                  context
2436                                  spec))
2437                (let* ((name (first spec))
2438                       (var (get-var name)))
2439                  (vars var)
2440                  (names name)
2441                  (vals (second spec)))))))
2442
2443     (values (vars) (vals) (names))))
2444
2445 (def-ir1-translator let ((bindings &body body)
2446                          start cont)
2447   #!+sb-doc
2448   "LET ({(Var [Value]) | Var}*) Declaration* Form*
2449   During evaluation of the Forms, bind the Vars to the result of evaluating the
2450   Value forms. The variables are bound in parallel after all of the Values are
2451   evaluated."
2452   (multiple-value-bind (forms decls) (sb!sys:parse-body body nil)
2453     (multiple-value-bind (vars values) (extract-let-variables bindings 'let)
2454       (let* ((*lexenv* (process-decls decls vars nil cont))
2455              (fun-cont (make-continuation))
2456              (fun (ir1-convert-lambda-body forms vars)))
2457         (reference-leaf start fun-cont fun)
2458         (ir1-convert-combination-args fun-cont cont values)))))
2459
2460 (def-ir1-translator let* ((bindings &body body)
2461                           start cont)
2462   #!+sb-doc
2463   "LET* ({(Var [Value]) | Var}*) Declaration* Form*
2464   Similar to LET, but the variables are bound sequentially, allowing each Value
2465   form to reference any of the previous Vars."
2466   (multiple-value-bind (forms decls) (sb!sys:parse-body body nil)
2467     (multiple-value-bind (vars values) (extract-let-variables bindings 'let*)
2468       (let ((*lexenv* (process-decls decls vars nil cont)))
2469         (ir1-convert-aux-bindings start cont forms vars values nil)))))
2470
2471 ;;; This is a lot like a LET* with no bindings. Unlike LET*, LOCALLY
2472 ;;; has to preserves top-level-formness, but we don't need to worry
2473 ;;; about that here, because special logic in the compiler main loop
2474 ;;; grabs top-level LOCALLYs and takes care of them before this
2475 ;;; transform ever sees them.
2476 (def-ir1-translator locally ((&body body)
2477                              start cont)
2478   #!+sb-doc
2479   "LOCALLY Declaration* Form*
2480   Sequentially evaluate the Forms in a lexical environment where the
2481   the Declarations have effect. If LOCALLY is a top-level form, then
2482   the Forms are also processed as top-level forms."
2483   (multiple-value-bind (forms decls) (sb!sys:parse-body body nil)
2484     (let ((*lexenv* (process-decls decls nil nil cont)))
2485       ;;; MNA: locally patch - #'ir1-convert-progn-body gets called anyway!
2486       (ir1-convert-progn-body start cont forms))))
2487 \f
2488 ;;;; FLET and LABELS
2489
2490 ;;; Given a list of local function specifications in the style of
2491 ;;; Flet, return lists of the function names and of the lambdas which
2492 ;;; are their definitions.
2493 ;;;
2494 ;;; The function names are checked for legality. Context is the name
2495 ;;; of the form, for error reporting.
2496 (declaim (ftype (function (list symbol) (values list list))
2497                 extract-flet-variables))
2498 (defun extract-flet-variables (definitions context)
2499   (collect ((names)
2500             (defs))
2501     (dolist (def definitions)
2502       (when (or (atom def) (< (length def) 2))
2503         (compiler-error "The ~S definition spec ~S is malformed." context def))
2504
2505       (let ((name (check-function-name (first def))))
2506         (names name)
2507         (multiple-value-bind (forms decls) (sb!sys:parse-body (cddr def))
2508           (defs `(lambda ,(second def)
2509                    ,@decls
2510                    (block ,(function-name-block-name name)
2511                      . ,forms))))))
2512     (values (names) (defs))))
2513
2514 (def-ir1-translator flet ((definitions &body body)
2515                           start cont)
2516   #!+sb-doc
2517   "FLET ({(Name Lambda-List Declaration* Form*)}*) Declaration* Body-Form*
2518   Evaluate the Body-Forms with some local function definitions. The bindings
2519   do not enclose the definitions; any use of Name in the Forms will refer to
2520   the lexically apparent function definition in the enclosing environment."
2521   (multiple-value-bind (forms decls) (sb!sys:parse-body body nil)
2522     (multiple-value-bind (names defs)
2523         (extract-flet-variables definitions 'flet)
2524       (let* ((fvars (mapcar (lambda (n d)
2525                               (ir1-convert-lambda d n))
2526                             names defs))
2527              (*lexenv* (make-lexenv
2528                         :default (process-decls decls nil fvars cont)
2529                         :functions (pairlis names fvars))))
2530         (ir1-convert-progn-body start cont forms)))))
2531
2532 ;;; For LABELS, we have to create dummy function vars and add them to
2533 ;;; the function namespace while converting the functions. We then
2534 ;;; modify all the references to these leaves so that they point to
2535 ;;; the real functional leaves. We also backpatch the FENV so that if
2536 ;;; the lexical environment is used for inline expansion we will get
2537 ;;; the right functions.
2538 (def-ir1-translator labels ((definitions &body body) start cont)
2539   #!+sb-doc
2540   "LABELS ({(Name Lambda-List Declaration* Form*)}*) Declaration* Body-Form*
2541   Evaluate the Body-Forms with some local function definitions. The bindings
2542   enclose the new definitions, so the defined functions can call themselves or
2543   each other."
2544   (multiple-value-bind (forms decls) (sb!sys:parse-body body nil)
2545     (multiple-value-bind (names defs)
2546         (extract-flet-variables definitions 'labels)
2547       (let* ((new-fenv (loop for name in names
2548                              collect (cons name (make-functional :name name))))
2549              (real-funs
2550               (let ((*lexenv* (make-lexenv :functions new-fenv)))
2551                 (mapcar (lambda (n d)
2552                           (ir1-convert-lambda d n))
2553                         names defs))))
2554
2555         (loop for real in real-funs and env in new-fenv do
2556               (let ((dum (cdr env)))
2557                 (substitute-leaf real dum)
2558                 (setf (cdr env) real)))
2559
2560         (let ((*lexenv* (make-lexenv
2561                          :default (process-decls decls nil real-funs cont)
2562                          :functions (pairlis names real-funs))))
2563           (ir1-convert-progn-body start cont forms))))))
2564 \f
2565 ;;;; THE
2566
2567 ;;; Do stuff to recognize a THE or VALUES declaration. Cont is the
2568 ;;; continuation that the assertion applies to, Type is the type
2569 ;;; specifier and Lexenv is the current lexical environment. Name is
2570 ;;; the name of the declaration we are doing, for use in error
2571 ;;; messages.
2572 ;;;
2573 ;;; This is somewhat involved, since a type assertion may only be made
2574 ;;; on a continuation, not on a node. We can't just set the
2575 ;;; continuation asserted type and let it go at that, since there may
2576 ;;; be parallel THE's for the same continuation, i.e.:
2577 ;;;     (if ...
2578 ;;;      (the foo ...)
2579 ;;;      (the bar ...))
2580 ;;;
2581 ;;; In this case, our representation can do no better than the union
2582 ;;; of these assertions. And if there is a branch with no assertion,
2583 ;;; we have nothing at all. We really need to recognize scoping, since
2584 ;;; we need to be able to discern between parallel assertions (which
2585 ;;; we union) and nested ones (which we intersect).
2586 ;;;
2587 ;;; We represent the scoping by throwing our innermost (intersected)
2588 ;;; assertion on Cont into the TYPE-RESTRICTIONS. As we go down, we
2589 ;;; intersect our assertions together. If Cont has no uses yet, we
2590 ;;; have not yet bottomed out on the first COND branch; in this case
2591 ;;; we optimistically assume that this type will be the one we end up
2592 ;;; with, and set the ASSERTED-TYPE to it. We can never get better
2593 ;;; than the type that we have the first time we bottom out. Later
2594 ;;; THE's (or the absence thereof) can only weaken this result.
2595 ;;;
2596 ;;; We make this work by getting USE-CONTINUATION to do the unioning
2597 ;;; across COND branches. We can't do it here, since we don't know how
2598 ;;; many branches there are going to be.
2599 (defun do-the-stuff (type cont lexenv name)
2600   (declare (type continuation cont) (type lexenv lexenv))
2601   (let* ((ctype (values-specifier-type type))
2602          (old-type (or (lexenv-find cont type-restrictions)
2603                        *wild-type*))
2604          (intersects (values-types-intersect old-type ctype))
2605          (int (values-type-intersection old-type ctype))
2606          (new (if intersects int old-type)))
2607     (when (null (find-uses cont))
2608       (setf (continuation-asserted-type cont) new))
2609     (when (and (not intersects)
2610                (not (policy nil (= brevity 3)))) ;FIXME: really OK to suppress?
2611       (compiler-warning
2612        "The type ~S in ~S declaration conflicts with an enclosing assertion:~%   ~S"
2613        (type-specifier ctype)
2614        name
2615        (type-specifier old-type)))
2616     (make-lexenv :type-restrictions `((,cont . ,new))
2617                  :default lexenv)))
2618
2619 ;;; FIXME: In a version of CMU CL that I used at Cadabra ca. 20000101,
2620 ;;; this didn't seem to expand into an assertion, at least for ALIEN
2621 ;;; values. Check that SBCL doesn't have this problem.
2622 (def-ir1-translator the ((type value) start cont)
2623   #!+sb-doc
2624   "THE Type Form
2625   Assert that Form evaluates to the specified type (which may be a VALUES
2626   type.)"
2627   (let ((*lexenv* (do-the-stuff type cont *lexenv* 'the)))
2628     (ir1-convert start cont value)))
2629
2630 ;;; Since the CONTINUATION-DERIVED-TYPE is computed as the union of
2631 ;;; its uses's types, setting it won't work. Instead we must intersect
2632 ;;; the type with the uses's DERIVED-TYPE.
2633 (def-ir1-translator truly-the ((type value) start cont)
2634   #!+sb-doc
2635   "Truly-The Type Value
2636   Like the THE special form, except that it believes whatever you tell it. It
2637   will never generate a type check, but will cause a warning if the compiler
2638   can prove the assertion is wrong."
2639   (declare (inline member))
2640   (let ((type (values-specifier-type type))
2641         (old (find-uses cont)))
2642     (ir1-convert start cont value)
2643     (do-uses (use cont)
2644       (unless (member use old :test #'eq)
2645         (derive-node-type use type)))))
2646 \f
2647 ;;;; SETQ
2648
2649 ;;; If there is a definition in LEXENV-VARIABLES, just set that,
2650 ;;; otherwise look at the global information. If the name is for a
2651 ;;; constant, then error out.
2652 (def-ir1-translator setq ((&whole source &rest things) start cont)
2653   #!+sb-doc
2654   "SETQ {Var Value}*
2655   Set the variables to the values. If more than one pair is supplied, the
2656   assignments are done sequentially. If Var names a symbol macro, SETF the
2657   expansion."
2658   (let ((len (length things)))
2659     (when (oddp len)
2660       (compiler-error "odd number of args to SETQ: ~S" source))
2661     (if (= len 2)
2662         (let* ((name (first things))
2663                (leaf (or (lexenv-find name variables)
2664                          (find-free-variable name))))
2665           (etypecase leaf
2666             (leaf
2667              (when (or (constant-p leaf)
2668                        (and (global-var-p leaf)
2669                             (eq (global-var-kind leaf) :constant)))
2670                (compiler-error "~S is a constant and thus can't be set." name))
2671              (when (and (lambda-var-p leaf)
2672                         (lambda-var-ignorep leaf))
2673                ;; ANSI's definition of "Declaration IGNORE, IGNORABLE"
2674                ;; requires that this be a STYLE-WARNING, not a full warning.
2675                (compiler-style-warning
2676                 "~S is being set even though it was declared to be ignored."
2677                 name))
2678              (set-variable start cont leaf (second things)))
2679             (cons
2680              (assert (eq (car leaf) 'MACRO))
2681              (ir1-convert start cont `(setf ,(cdr leaf) ,(second things))))
2682             (heap-alien-info
2683              (ir1-convert start cont
2684                           `(%set-heap-alien ',leaf ,(second things))))))
2685         (collect ((sets))
2686           (do ((thing things (cddr thing)))
2687               ((endp thing)
2688                (ir1-convert-progn-body start cont (sets)))
2689             (sets `(setq ,(first thing) ,(second thing))))))))
2690
2691 ;;; Kind of like Reference-Leaf, but we generate a Set node. This
2692 ;;; should only need to be called in Setq.
2693 (defun set-variable (start cont var value)
2694   (declare (type continuation start cont) (type basic-var var))
2695   (let ((dest (make-continuation)))
2696     (setf (continuation-asserted-type dest) (leaf-type var))
2697     (ir1-convert start dest value)
2698     (let ((res (make-set :var var :value dest)))
2699       (setf (continuation-dest dest) res)
2700       (setf (leaf-ever-used var) t)
2701       (push res (basic-var-sets var))
2702       (prev-link res dest)
2703       (use-continuation res cont))))
2704 \f
2705 ;;;; CATCH, THROW and UNWIND-PROTECT
2706
2707 ;;; We turn THROW into a multiple-value-call of a magical function,
2708 ;;; since as as far as IR1 is concerned, it has no interesting
2709 ;;; properties other than receiving multiple-values.
2710 (def-ir1-translator throw ((tag result) start cont)
2711   #!+sb-doc
2712   "Throw Tag Form
2713   Do a non-local exit, return the values of Form from the CATCH whose tag
2714   evaluates to the same thing as Tag."
2715   (ir1-convert start cont
2716                `(multiple-value-call #'%throw ,tag ,result)))
2717
2718 ;;; This is a special special form used to instantiate a cleanup as
2719 ;;; the current cleanup within the body. KIND is a the kind of cleanup
2720 ;;; to make, and MESS-UP is a form that does the mess-up action. We
2721 ;;; make the MESS-UP be the USE of the MESS-UP form's continuation,
2722 ;;; and introduce the cleanup into the lexical environment. We
2723 ;;; back-patch the ENTRY-CLEANUP for the current cleanup to be the new
2724 ;;; cleanup, since this inner cleanup is the interesting one.
2725 (def-ir1-translator %within-cleanup ((kind mess-up &body body) start cont)
2726   (let ((dummy (make-continuation))
2727         (dummy2 (make-continuation)))
2728     (ir1-convert start dummy mess-up)
2729     (let* ((mess-node (continuation-use dummy))
2730            (cleanup (make-cleanup :kind kind
2731                                   :mess-up mess-node))
2732            (old-cup (lexenv-cleanup *lexenv*))
2733            (*lexenv* (make-lexenv :cleanup cleanup)))
2734       (setf (entry-cleanup (cleanup-mess-up old-cup)) cleanup)
2735       (ir1-convert dummy dummy2 '(%cleanup-point))
2736       (ir1-convert-progn-body dummy2 cont body))))
2737
2738 ;;; This is a special special form that makes an "escape function"
2739 ;;; which returns unknown values from named block. We convert the
2740 ;;; function, set its kind to :ESCAPE, and then reference it. The
2741 ;;; :Escape kind indicates that this function's purpose is to
2742 ;;; represent a non-local control transfer, and that it might not
2743 ;;; actually have to be compiled.
2744 ;;;
2745 ;;; Note that environment analysis replaces references to escape
2746 ;;; functions with references to the corresponding NLX-INFO structure.
2747 (def-ir1-translator %escape-function ((tag) start cont)
2748   (let ((fun (ir1-convert-lambda
2749               `(lambda ()
2750                  (return-from ,tag (%unknown-values))))))
2751     (setf (functional-kind fun) :escape)
2752     (reference-leaf start cont fun)))
2753
2754 ;;; Yet another special special form. This one looks up a local
2755 ;;; function and smashes it to a :CLEANUP function, as well as
2756 ;;; referencing it.
2757 (def-ir1-translator %cleanup-function ((name) start cont)
2758   (let ((fun (lexenv-find name functions)))
2759     (assert (lambda-p fun))
2760     (setf (functional-kind fun) :cleanup)
2761     (reference-leaf start cont fun)))
2762
2763 ;;; We represent the possibility of the control transfer by making an
2764 ;;; "escape function" that does a lexical exit, and instantiate the
2765 ;;; cleanup using %WITHIN-CLEANUP.
2766 (def-ir1-translator catch ((tag &body body) start cont)
2767   #!+sb-doc
2768   "Catch Tag Form*
2769   Evaluates Tag and instantiates it as a catcher while the body forms are
2770   evaluated in an implicit PROGN. If a THROW is done to Tag within the dynamic
2771   scope of the body, then control will be transferred to the end of the body
2772   and the thrown values will be returned."
2773   (ir1-convert
2774    start cont
2775    (let ((exit-block (gensym "EXIT-BLOCK-")))
2776      `(block ,exit-block
2777         (%within-cleanup
2778             :catch
2779             (%catch (%escape-function ,exit-block) ,tag)
2780           ,@body)))))
2781
2782 ;;; UNWIND-PROTECT is similar to CATCH, but more hairy. We make the
2783 ;;; cleanup forms into a local function so that they can be referenced
2784 ;;; both in the case where we are unwound and in any local exits. We
2785 ;;; use %CLEANUP-FUNCTION on this to indicate that reference by
2786 ;;; %UNWIND-PROTECT ISN'T "real", and thus doesn't cause creation of
2787 ;;; an XEP.
2788 (def-ir1-translator unwind-protect ((protected &body cleanup) start cont)
2789   #!+sb-doc
2790   "Unwind-Protect Protected Cleanup*
2791   Evaluate the form Protected, returning its values. The cleanup forms are
2792   evaluated whenever the dynamic scope of the Protected form is exited (either
2793   due to normal completion or a non-local exit such as THROW)."
2794   (ir1-convert
2795    start cont
2796    (let ((cleanup-fun (gensym "CLEANUP-FUN-"))
2797          (drop-thru-tag (gensym "DROP-THRU-TAG-"))
2798          (exit-tag (gensym "EXIT-TAG-"))
2799          (next (gensym "NEXT"))
2800          (start (gensym "START"))
2801          (count (gensym "COUNT")))
2802      `(flet ((,cleanup-fun () ,@cleanup nil))
2803         ;; FIXME: If we ever get DYNAMIC-EXTENT working, then
2804         ;; ,CLEANUP-FUN should probably be declared DYNAMIC-EXTENT,
2805         ;; and something can be done to make %ESCAPE-FUNCTION have
2806         ;; dynamic extent too.
2807         (block ,drop-thru-tag
2808           (multiple-value-bind (,next ,start ,count)
2809               (block ,exit-tag
2810                 (%within-cleanup
2811                     :unwind-protect
2812                     (%unwind-protect (%escape-function ,exit-tag)
2813                                      (%cleanup-function ,cleanup-fun))
2814                   (return-from ,drop-thru-tag ,protected)))
2815             (,cleanup-fun)
2816             (%continue-unwind ,next ,start ,count)))))))
2817 \f
2818 ;;;; multiple-value stuff
2819
2820 ;;; If there are arguments, MULTIPLE-VALUE-CALL turns into an
2821 ;;; MV-COMBINATION.
2822 ;;;
2823 ;;; If there are no arguments, then we convert to a normal
2824 ;;; combination, ensuring that a MV-COMBINATION always has at least
2825 ;;; one argument. This can be regarded as an optimization, but it is
2826 ;;; more important for simplifying compilation of MV-COMBINATIONS.
2827 (def-ir1-translator multiple-value-call ((fun &rest args) start cont)
2828   #!+sb-doc
2829   "MULTIPLE-VALUE-CALL Function Values-Form*
2830   Call Function, passing all the values of each Values-Form as arguments,
2831   values from the first Values-Form making up the first argument, etc."
2832   (let* ((fun-cont (make-continuation))
2833          (node (if args
2834                    (make-mv-combination fun-cont)
2835                    (make-combination fun-cont))))
2836     (ir1-convert start fun-cont
2837                  (if (and (consp fun) (eq (car fun) 'function))
2838                      fun
2839                      `(%coerce-callable-to-function ,fun)))
2840     (setf (continuation-dest fun-cont) node)
2841     (assert-continuation-type fun-cont
2842                               (specifier-type '(or function symbol)))
2843     (collect ((arg-conts))
2844       (let ((this-start fun-cont))
2845         (dolist (arg args)
2846           (let ((this-cont (make-continuation node)))
2847             (ir1-convert this-start this-cont arg)
2848             (setq this-start this-cont)
2849             (arg-conts this-cont)))
2850         (prev-link node this-start)
2851         (use-continuation node cont)
2852         (setf (basic-combination-args node) (arg-conts))))))
2853
2854 ;;; MULTIPLE-VALUE-PROG1 is represented implicitly in IR1 by having a
2855 ;;; the result code use result continuation (CONT), but transfer
2856 ;;; control to the evaluation of the body. In other words, the result
2857 ;;; continuation isn't IMMEDIATELY-USED-P by the nodes that compute
2858 ;;; the result.
2859 ;;;
2860 ;;; In order to get the control flow right, we convert the result with
2861 ;;; a dummy result continuation, then convert all the uses of the
2862 ;;; dummy to be uses of CONT. If a use is an EXIT, then we also
2863 ;;; substitute CONT for the dummy in the corresponding ENTRY node so
2864 ;;; that they are consistent. Note that this doesn't amount to
2865 ;;; changing the exit target, since the control destination of an exit
2866 ;;; is determined by the block successor; we are just indicating the
2867 ;;; continuation that the result is delivered to.
2868 ;;;
2869 ;;; We then convert the body, using another dummy continuation in its
2870 ;;; own block as the result. After we are done converting the body, we
2871 ;;; move all predecessors of the dummy end block to CONT's block.
2872 ;;;
2873 ;;; Note that we both exploit and maintain the invariant that the CONT
2874 ;;; to an IR1 convert method either has no block or starts the block
2875 ;;; that control should transfer to after completion for the form.
2876 ;;; Nested MV-PROG1's work because during conversion of the result
2877 ;;; form, we use dummy continuation whose block is the true control
2878 ;;; destination.
2879 (def-ir1-translator multiple-value-prog1 ((result &rest forms) start cont)
2880   #!+sb-doc
2881   "MULTIPLE-VALUE-PROG1 Values-Form Form*
2882   Evaluate Values-Form and then the Forms, but return all the values of
2883   Values-Form."
2884   (continuation-starts-block cont)
2885   (let* ((dummy-result (make-continuation))
2886          (dummy-start (make-continuation))
2887          (cont-block (continuation-block cont)))
2888     (continuation-starts-block dummy-start)
2889     (ir1-convert start dummy-start result)
2890
2891     (substitute-continuation-uses cont dummy-start)
2892
2893     (continuation-starts-block dummy-result)
2894     (ir1-convert-progn-body dummy-start dummy-result forms)
2895     (let ((end-block (continuation-block dummy-result)))
2896       (dolist (pred (block-pred end-block))
2897         (unlink-blocks pred end-block)
2898         (link-blocks pred cont-block))
2899       (assert (not (continuation-dest dummy-result)))
2900       (delete-continuation dummy-result)
2901       (remove-from-dfo end-block))))
2902 \f
2903 ;;;; interface to defining macros
2904
2905 ;;;; FIXME:
2906 ;;;;   classic CMU CL comment:
2907 ;;;;     DEFMACRO and DEFUN expand into calls to %DEFxxx functions
2908 ;;;;     so that we get a chance to see what is going on. We define
2909 ;;;;     IR1 translators for these functions which look at the
2910 ;;;;     definition and then generate a call to the %%DEFxxx function.
2911 ;;;; Alas, this implementation doesn't do the right thing for
2912 ;;;; non-toplevel uses of these forms, so this should probably
2913 ;;;; be changed to use EVAL-WHEN instead.
2914
2915 ;;; Return a new source path with any stuff intervening between the
2916 ;;; current path and the first form beginning with NAME stripped off.
2917 ;;; This is used to hide the guts of DEFmumble macros to prevent
2918 ;;; annoying error messages.
2919 (defun revert-source-path (name)
2920   (do ((path *current-path* (cdr path)))
2921       ((null path) *current-path*)
2922     (let ((first (first path)))
2923       (when (or (eq first name)
2924                 (eq first 'original-source-start))
2925         (return path)))))
2926
2927 ;;; Warn about incompatible or illegal definitions and add the macro
2928 ;;; to the compiler environment.
2929 ;;;
2930 ;;; Someday we could check for macro arguments being incompatibly
2931 ;;; redefined. Doing this right will involve finding the old macro
2932 ;;; lambda-list and comparing it with the new one.
2933 (def-ir1-translator %defmacro ((qname qdef lambda-list doc) start cont
2934                                :kind :function)
2935   (let (;; QNAME is typically a quoted name. I think the idea is to let
2936         ;; %DEFMACRO work as an ordinary function when interpreting. Whatever
2937         ;; the reason it's there, we don't want it any more. -- WHN 19990603
2938         (name (eval qname))
2939         ;; QDEF should be a sharp-quoted definition. We don't want to make a
2940         ;; function of it just yet, so we just drop the sharp-quote.
2941         (def (progn
2942                (assert (eq 'function (first qdef)))
2943                (assert (proper-list-of-length-p qdef 2))
2944                (second qdef))))
2945
2946     (unless (symbolp name)
2947       (compiler-error "The macro name ~S is not a symbol." name))
2948
2949     (ecase (info :function :kind name)
2950       ((nil))
2951       (:function
2952        (remhash name *free-functions*)
2953        (undefine-function-name name)
2954        (compiler-warning
2955         "~S is being redefined as a macro when it was previously ~(~A~) to be a function."
2956         name
2957         (info :function :where-from name)))
2958       (:macro)
2959       (:special-form
2960        (compiler-error "The special form ~S can't be redefined as a macro."
2961                        name)))
2962
2963     (setf (info :function :kind name) :macro
2964           (info :function :where-from name) :defined
2965           (info :function :macro-function name) (coerce def 'function))
2966
2967     (let* ((*current-path* (revert-source-path 'defmacro))
2968            (fun (ir1-convert-lambda def name)))
2969       (setf (leaf-name fun)
2970             (concatenate 'string "DEFMACRO " (symbol-name name)))
2971       (setf (functional-arg-documentation fun) (eval lambda-list))
2972
2973       (ir1-convert start cont `(%%defmacro ',name ,fun ,doc)))
2974
2975     (when sb!xc:*compile-print*
2976       ;; FIXME: It would be nice to convert this, and the other places
2977       ;; which create compiler diagnostic output prefixed by
2978       ;; semicolons, to use some common utility which automatically
2979       ;; prefixes all its output with semicolons. (The addition of
2980       ;; semicolon prefixes was introduced ca. sbcl-0.6.8.10 as the
2981       ;; "MNA compiler message patch", and implemented by modifying a
2982       ;; bunch of output statements on a case-by-case basis, which
2983       ;; seems unnecessarily error-prone and unclear, scattering
2984       ;; implicit information about output style throughout the
2985       ;; system.) Starting by rewriting COMPILER-MUMBLE to add
2986       ;; semicolon prefixes would be a good start, and perhaps also:
2987       ;;   * Add semicolon prefixes for "FOO assembled" messages emitted 
2988       ;;     when e.g. src/assembly/x86/assem-rtns.lisp is processed.
2989       ;;   * At least some debugger output messages deserve semicolon
2990       ;;     prefixes too:
2991       ;;     ** restarts table
2992       ;;     ** "Within the debugger, you can type HELP for help."
2993       (compiler-mumble "~&; converted ~S~%" name))))
2994
2995 (def-ir1-translator %define-compiler-macro ((name def lambda-list doc)
2996                                             start cont
2997                                             :kind :function)
2998   (let ((name (eval name))
2999         (def (second def))) ; We don't want to make a function just yet...
3000
3001     (when (eq (info :function :kind name) :special-form)
3002       (compiler-error "attempt to define a compiler-macro for special form ~S"
3003                       name))
3004
3005     (setf (info :function :compiler-macro-function name)
3006           (coerce def 'function))
3007
3008     (let* ((*current-path* (revert-source-path 'define-compiler-macro))
3009            (fun (ir1-convert-lambda def name)))
3010       (setf (leaf-name fun)
3011             (let ((*print-case* :upcase))
3012               (format nil "DEFINE-COMPILER-MACRO ~S" name)))
3013       (setf (functional-arg-documentation fun) (eval lambda-list))
3014
3015       (ir1-convert start cont `(%%define-compiler-macro ',name ,fun ,doc)))
3016
3017     (when sb!xc:*compile-print*
3018       ;; MNA compiler message patch
3019       (compiler-mumble "~&; converted ~S~%" name))))
3020 \f
3021 ;;;; defining global functions
3022
3023 ;;; Convert FUN as a lambda in the null environment, but use the
3024 ;;; current compilation policy. Note that FUN may be a
3025 ;;; LAMBDA-WITH-ENVIRONMENT, so we may have to augment the environment
3026 ;;; to reflect the state at the definition site.
3027 (defun ir1-convert-inline-lambda (fun &optional name)
3028   (destructuring-bind (decls macros symbol-macros &rest body)
3029                       (if (eq (car fun) 'lambda-with-environment)
3030                           (cdr fun)
3031                           `(() () () . ,(cdr fun)))
3032     (let ((*lexenv* (make-lexenv
3033                      :default (process-decls decls nil nil
3034                                              (make-continuation)
3035                                              (make-null-lexenv))
3036                      :variables (copy-list symbol-macros)
3037                      :functions
3038                      (mapcar #'(lambda (x)
3039                                  `(,(car x) .
3040                                    (macro . ,(coerce (cdr x) 'function))))
3041                              macros)
3042                      :cookie (lexenv-cookie *lexenv*)
3043                      :interface-cookie (lexenv-interface-cookie *lexenv*))))
3044       (ir1-convert-lambda `(lambda ,@body) name))))
3045
3046 ;;; Return a lambda that has been "closed" with respect to ENV,
3047 ;;; returning a LAMBDA-WITH-ENVIRONMENT if there are interesting
3048 ;;; macros or declarations. If there is something too complex (like a
3049 ;;; lexical variable) in the environment, then we return NIL.
3050 (defun inline-syntactic-closure-lambda (lambda &optional (env *lexenv*))
3051   (let ((variables (lexenv-variables env))
3052         (functions (lexenv-functions env))
3053         (decls ())
3054         (symmacs ())
3055         (macros ()))
3056     (cond ((or (lexenv-blocks env) (lexenv-tags env)) nil)
3057           ((and (null variables) (null functions))
3058            lambda)
3059           ((dolist (x variables nil)
3060              (let ((name (car x))
3061                    (what (cdr x)))
3062                (when (eq x (assoc name variables :test #'eq))
3063                  (typecase what
3064                    (cons
3065                     (assert (eq (car what) 'macro))
3066                     (push x symmacs))
3067                    (global-var
3068                     (assert (eq (global-var-kind what) :special))
3069                     (push `(special ,name) decls))
3070                    (t (return t))))))
3071            nil)
3072           ((dolist (x functions nil)
3073              (let ((name (car x))
3074                    (what (cdr x)))
3075                (when (eq x (assoc name functions :test #'equal))
3076                  (typecase what
3077                    (cons
3078                     (push (cons name
3079                                 (function-lambda-expression (cdr what)))
3080                           macros))
3081                    (global-var
3082                     (when (defined-function-p what)
3083                       (push `(,(car (rassoc (defined-function-inlinep what)
3084                                             *inlinep-translations*))
3085                               ,name)
3086                             decls)))
3087                    (t (return t))))))
3088            nil)
3089           (t
3090            `(lambda-with-environment ,decls
3091                                      ,macros
3092                                      ,symmacs
3093                                      . ,(rest lambda))))))
3094
3095 ;;; Get a DEFINED-FUNCTION object for a function we are about to
3096 ;;; define. If the function has been forward referenced, then
3097 ;;; substitute for the previous references.
3098 (defun get-defined-function (name)
3099   (let* ((name (proclaim-as-function-name name))
3100          (found (find-free-function name "Eh?")))
3101     (note-name-defined name :function)
3102     (cond ((not (defined-function-p found))
3103            (assert (not (info :function :inlinep name)))
3104            (let* ((where-from (leaf-where-from found))
3105                   (res (make-defined-function
3106                         :name name
3107                         :where-from (if (eq where-from :declared)
3108                                         :declared :defined)
3109                         :type (leaf-type found))))
3110              (substitute-leaf res found)
3111              (setf (gethash name *free-functions*) res)))
3112           ;; If *FREE-FUNCTIONS* has a previously converted definition for this
3113           ;; name, then blow it away and try again.
3114           ((defined-function-functional found)
3115            (remhash name *free-functions*)
3116            (get-defined-function name))
3117           (t found))))
3118
3119 ;;; Check a new global function definition for consistency with
3120 ;;; previous declaration or definition, and assert argument/result
3121 ;;; types if appropriate. This this assertion is suppressed by the
3122 ;;; EXPLICIT-CHECK attribute, which is specified on functions that
3123 ;;; check their argument types as a consequence of type dispatching.
3124 ;;; This avoids redundant checks such as NUMBERP on the args to +,
3125 ;;; etc.
3126 (defun assert-new-definition (var fun)
3127   (let ((type (leaf-type var))
3128         (for-real (eq (leaf-where-from var) :declared))
3129         (info (info :function :info (leaf-name var))))
3130     (assert-definition-type
3131      fun type
3132      :error-function #'compiler-warning
3133      :warning-function (cond (info #'compiler-warning)
3134                              (for-real #'compiler-note)
3135                              (t nil))
3136      :really-assert
3137      (and for-real
3138           (not (and info
3139                     (ir1-attributep (function-info-attributes info)
3140                                     explicit-check))))
3141      :where (if for-real
3142                 "previous declaration"
3143                 "previous definition"))))
3144
3145 ;;; Convert a lambda doing all the basic stuff we would do if we were
3146 ;;; converting a DEFUN. This is used both by the %DEFUN translator and
3147 ;;; for global inline expansion.
3148 ;;;
3149 ;;; Unless a :INLINE function, we temporarily clobber the inline
3150 ;;; expansion. This prevents recursive inline expansion of
3151 ;;; opportunistic pseudo-inlines.
3152 (defun ir1-convert-lambda-for-defun (lambda var expansion converter)
3153   (declare (cons lambda) (function converter) (type defined-function var))
3154   (let ((var-expansion (defined-function-inline-expansion var)))
3155     (unless (eq (defined-function-inlinep var) :inline)
3156       (setf (defined-function-inline-expansion var) nil))
3157     (let* ((name (leaf-name var))
3158            (fun (funcall converter lambda name))
3159            (function-info (info :function :info name)))
3160       (setf (functional-inlinep fun) (defined-function-inlinep var))
3161       (assert-new-definition var fun)
3162       (setf (defined-function-inline-expansion var) var-expansion)
3163       ;; If definitely not an interpreter stub, then substitute for any
3164       ;; old references.
3165       (unless (or (eq (defined-function-inlinep var) :notinline)
3166                   (not *block-compile*)
3167                   (and function-info
3168                        (or (function-info-transforms function-info)
3169                            (function-info-templates function-info)
3170                            (function-info-ir2-convert function-info))))
3171         (substitute-leaf fun var)
3172         ;; If in a simple environment, then we can allow backward
3173         ;; references to this function from following top-level forms.
3174         (when expansion (setf (defined-function-functional var) fun)))
3175       fun)))
3176
3177 ;;; Convert the definition and install it in the global environment
3178 ;;; with a LABELS-like effect. If the lexical environment is not null,
3179 ;;; then we only install the definition during the processing of this
3180 ;;; DEFUN, ensuring that the function cannot be called outside of the
3181 ;;; correct environment. If the function is globally NOTINLINE, then
3182 ;;; that inhibits even local substitution. Also, emit top-level code
3183 ;;; to install the definition.
3184 ;;;
3185 ;;; This is one of the major places where the semantics of block
3186 ;;; compilation is handled. Substitution for global names is totally
3187 ;;; inhibited if *BLOCK-COMPILE* is NIL. And if *BLOCK-COMPILE* is
3188 ;;; true and entry points are specified, then we don't install global
3189 ;;; definitions for non-entry functions (effectively turning them into
3190 ;;; local lexical functions.)
3191 (def-ir1-translator %defun ((name def doc source) start cont
3192                             :kind :function)
3193   (declare (ignore source))
3194   (let* ((name (eval name))
3195          (lambda (second def))
3196          (*current-path* (revert-source-path 'defun))
3197          (expansion (unless (eq (info :function :inlinep name) :notinline)
3198                       (inline-syntactic-closure-lambda lambda))))
3199     ;; If not in a simple environment or NOTINLINE, then discard any
3200     ;; forward references to this function.
3201     (unless expansion (remhash name *free-functions*))
3202
3203     (let* ((var (get-defined-function name))
3204            (save-expansion (and (member (defined-function-inlinep var)
3205                                         '(:inline :maybe-inline))
3206                                 expansion)))
3207       (setf (defined-function-inline-expansion var) expansion)
3208       (setf (info :function :inline-expansion name) save-expansion)
3209       ;; If there is a type from a previous definition, blast it,
3210       ;; since it is obsolete.
3211       (when (eq (leaf-where-from var) :defined)
3212         (setf (leaf-type var) (specifier-type 'function)))
3213
3214       (let ((fun (ir1-convert-lambda-for-defun lambda
3215                                                var
3216                                                expansion
3217                                                #'ir1-convert-lambda)))
3218         (ir1-convert
3219          start cont
3220          (if (and *block-compile* *entry-points*
3221                   (not (member name *entry-points* :test #'equal)))
3222              `',name
3223              `(%%defun ',name ,fun ,doc
3224                        ,@(when save-expansion `(',save-expansion)))))
3225
3226         (when sb!xc:*compile-print*
3227           ;; MNA compiler message patch
3228           (compiler-mumble "~&; converted ~S~%" name))))))