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