42325f988a1ea1ac16a20b4dee8a1e25e4da861a
[sbcl.git] / src / compiler / locall.lisp
1 ;;;; This file implements local call analysis. A local call is a
2 ;;;; function call between functions being compiled at the same time.
3 ;;;; If we can tell at compile time that such a call is legal, then we
4 ;;;; change the combination to call the correct lambda, mark it as
5 ;;;; local, and add this link to our call graph. Once a call is local,
6 ;;;; it is then eligible for let conversion, which places the body of
7 ;;;; the function inline.
8 ;;;;
9 ;;;; We cannot always do a local call even when we do have the
10 ;;;; function being called. Calls that cannot be shown to have legal
11 ;;;; arg counts are not converted.
12
13 ;;;; This software is part of the SBCL system. See the README file for
14 ;;;; more information.
15 ;;;;
16 ;;;; This software is derived from the CMU CL system, which was
17 ;;;; written at Carnegie Mellon University and released into the
18 ;;;; public domain. The software is in the public domain and is
19 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
20 ;;;; files for more information.
21
22 (in-package "SB!C")
23
24 ;;; This function propagates information from the variables in the function
25 ;;; Fun to the actual arguments in Call. This is also called by the VALUES IR1
26 ;;; optimizer when it sleazily converts MV-BINDs to LETs.
27 ;;;
28 ;;; We flush all arguments to Call that correspond to unreferenced variables
29 ;;; in Fun. We leave NILs in the Combination-Args so that the remaining args
30 ;;; still match up with their vars.
31 ;;;
32 ;;; We also apply the declared variable type assertion to the argument
33 ;;; continuations.
34 (defun propagate-to-args (call fun)
35   (declare (type combination call) (type clambda fun))
36   (do ((args (basic-combination-args call) (cdr args))
37        (vars (lambda-vars fun) (cdr vars)))
38       ((null args))
39     (let ((arg (car args))
40           (var (car vars)))
41       (cond ((leaf-refs var)
42              (assert-continuation-type arg (leaf-type var)))
43             (t
44              (flush-dest arg)
45              (setf (car args) nil)))))
46
47   (values))
48
49 ;;; This function handles merging the tail sets if Call is potentially
50 ;;; tail-recursive, and is a call to a function with a different TAIL-SET than
51 ;;; Call's Fun. This must be called whenever we alter IR1 so as to place a
52 ;;; local call in what might be a TR context. Note that any call which returns
53 ;;; its value to a RETURN is considered potentially TR, since any implicit
54 ;;; MV-PROG1 might be optimized away.
55 ;;;
56 ;;; We destructively modify the set for the calling function to represent both,
57 ;;; and then change all the functions in callee's set to reference the first.
58 ;;; If we do merge, we reoptimize the RETURN-RESULT continuation to cause
59 ;;; IR1-OPTIMIZE-RETURN to recompute the tail set type.
60 (defun merge-tail-sets (call &optional (new-fun (combination-lambda call)))
61   (declare (type basic-combination call) (type clambda new-fun))
62   (let ((return (continuation-dest (node-cont call))))
63     (when (return-p return)
64       (let ((call-set (lambda-tail-set (node-home-lambda call)))
65             (fun-set (lambda-tail-set new-fun)))
66         (unless (eq call-set fun-set)
67           (let ((funs (tail-set-functions fun-set)))
68             (dolist (fun funs)
69               (setf (lambda-tail-set fun) call-set))
70             (setf (tail-set-functions call-set)
71                   (nconc (tail-set-functions call-set) funs)))
72           (reoptimize-continuation (return-result return))
73           t)))))
74
75 ;;; Convert a combination into a local call. We PROPAGATE-TO-ARGS, set
76 ;;; the combination kind to :LOCAL, add FUN to the CALLS of the
77 ;;; function that the call is in, call MERGE-TAIL-SETS, then replace
78 ;;; the function in the REF node with the new function.
79 ;;;
80 ;;; We change the REF last, since changing the reference can trigger
81 ;;; LET conversion of the new function, but will only do so if the
82 ;;; call is local. Note that the replacement may trigger LET
83 ;;; conversion or other changes in IR1. We must call MERGE-TAIL-SETS
84 ;;; with NEW-FUN before the substitution, since after the substitution
85 ;;; (and LET conversion), the call may no longer be recognizable as
86 ;;; tail-recursive.
87 (defun convert-call (ref call fun)
88   (declare (type ref ref) (type combination call) (type clambda fun))
89   (propagate-to-args call fun)
90   (setf (basic-combination-kind call) :local)
91   (pushnew fun (lambda-calls (node-home-lambda call)))
92   (merge-tail-sets call fun)
93   (change-ref-leaf ref fun)
94   (values))
95 \f
96 ;;;; external entry point creation
97
98 ;;; Return a Lambda form that can be used as the definition of the XEP
99 ;;; for FUN.
100 ;;;
101 ;;; If FUN is a lambda, then we check the number of arguments
102 ;;; (conditional on policy) and call FUN with all the arguments.
103 ;;;
104 ;;; If FUN is an OPTIONAL-DISPATCH, then we dispatch off of the number
105 ;;; of supplied arguments by doing do an = test for each entry-point,
106 ;;; calling the entry with the appropriate prefix of the passed
107 ;;; arguments.
108 ;;;
109 ;;; If there is a more arg, then there are a couple of optimizations
110 ;;; that we make (more for space than anything else):
111 ;;; -- If MIN-ARGS is 0, then we make the more entry a T clause, since 
112 ;;;    no argument count error is possible.
113 ;;; -- We can omit the = clause for the last entry-point, allowing the 
114 ;;;    case of 0 more args to fall through to the more entry.
115 ;;;
116 ;;; We don't bother to policy conditionalize wrong arg errors in
117 ;;; optional dispatches, since the additional overhead is negligible
118 ;;; compared to the cost of everything else going on.
119 ;;;
120 ;;; Note that if policy indicates it, argument type declarations in
121 ;;; Fun will be verified. Since nothing is known about the type of the
122 ;;; XEP arg vars, type checks will be emitted when the XEP's arg vars
123 ;;; are passed to the actual function.
124 (defun make-xep-lambda (fun)
125   (declare (type functional fun))
126   (etypecase fun
127     (clambda
128      (let ((nargs (length (lambda-vars fun)))
129            (n-supplied (gensym))
130            (temps (make-gensym-list (length (lambda-vars fun)))))
131        `(lambda (,n-supplied ,@temps)
132           (declare (type index ,n-supplied))
133           ,(if (policy nil (zerop safety))
134                `(declare (ignore ,n-supplied))
135                `(%verify-argument-count ,n-supplied ,nargs))
136           (%funcall ,fun ,@temps))))
137     (optional-dispatch
138      (let* ((min (optional-dispatch-min-args fun))
139             (max (optional-dispatch-max-args fun))
140             (more (optional-dispatch-more-entry fun))
141             (n-supplied (gensym))
142             (temps (make-gensym-list max)))
143        (collect ((entries))
144          (do ((eps (optional-dispatch-entry-points fun) (rest eps))
145               (n min (1+ n)))
146              ((null eps))
147            (entries `((= ,n-supplied ,n)
148                       (%funcall ,(first eps) ,@(subseq temps 0 n)))))
149          `(lambda (,n-supplied ,@temps)
150             ;; FIXME: Make sure that INDEX type distinguishes between
151             ;; target and host. (Probably just make the SB!XC:DEFTYPE
152             ;; different from CL:DEFTYPE.)
153             (declare (type index ,n-supplied))
154             (cond
155              ,@(if more (butlast (entries)) (entries))
156              ,@(when more
157                  `((,(if (zerop min) 't `(>= ,n-supplied ,max))
158                     ,(let ((n-context (gensym))
159                            (n-count (gensym)))
160                        `(multiple-value-bind (,n-context ,n-count)
161                             (%more-arg-context ,n-supplied ,max)
162                           (%funcall ,more ,@temps ,n-context ,n-count))))))
163              (t
164               (%argument-count-error ,n-supplied)))))))))
165
166 ;;; Make an external entry point (XEP) for FUN and return it. We
167 ;;; convert the result of MAKE-XEP-LAMBDA in the correct environment,
168 ;;; then associate this lambda with FUN as its XEP. After the
169 ;;; conversion, we iterate over the function's associated lambdas,
170 ;;; redoing local call analysis so that the XEP calls will get
171 ;;; converted. We also bind *LEXENV* to change the compilation policy
172 ;;; over to the interface policy.
173 ;;;
174 ;;; We set REANALYZE and REOPTIMIZE in the component, just in case we
175 ;;; discover an XEP after the initial local call analyze pass.
176 (defun make-external-entry-point (fun)
177   (declare (type functional fun))
178   (assert (not (functional-entry-function fun)))
179   (with-ir1-environment (lambda-bind (main-entry fun))
180     (let* ((*lexenv* (make-lexenv :policy (make-interface-policy *lexenv*)))
181            (res (ir1-convert-lambda (make-xep-lambda fun))))
182       (setf (functional-kind res) :external)
183       (setf (leaf-ever-used res) t)
184       (setf (functional-entry-function res) fun)
185       (setf (functional-entry-function fun) res)
186       (setf (component-reanalyze *current-component*) t)
187       (setf (component-reoptimize *current-component*) t)
188       (etypecase fun
189         (clambda (local-call-analyze-1 fun))
190         (optional-dispatch
191          (dolist (ep (optional-dispatch-entry-points fun))
192            (local-call-analyze-1 ep))
193          (when (optional-dispatch-more-entry fun)
194            (local-call-analyze-1 (optional-dispatch-more-entry fun)))))
195       res)))
196
197 ;;; Notice a Ref that is not in a local-call context. If the Ref is
198 ;;; already to an XEP, then do nothing, otherwise change it to the
199 ;;; XEP, making an XEP if necessary.
200 ;;;
201 ;;; If Ref is to a special :Cleanup or :Escape function, then we treat
202 ;;; it as though it was not an XEP reference (i.e. leave it alone.)
203 (defun reference-entry-point (ref)
204   (declare (type ref ref))
205   (let ((fun (ref-leaf ref)))
206     (unless (or (external-entry-point-p fun)
207                 (member (functional-kind fun) '(:escape :cleanup)))
208       (change-ref-leaf ref (or (functional-entry-function fun)
209                                (make-external-entry-point fun))))))
210 \f
211 ;;; Attempt to convert all references to Fun to local calls. The
212 ;;; reference must be the function for a call, and the function
213 ;;; continuation must be used only once, since otherwise we cannot be
214 ;;; sure what function is to be called. The call continuation would be
215 ;;; multiply used if there is hairy stuff such as conditionals in the
216 ;;; expression that computes the function.
217 ;;;
218 ;;; If we cannot convert a reference, then we mark the referenced
219 ;;; function as an entry-point, creating a new XEP if necessary. We
220 ;;; don't try to convert calls that are in error (:ERROR kind.)
221 ;;;
222 ;;; This is broken off from Local-Call-Analyze so that people can
223 ;;; force analysis of newly introduced calls. Note that we don't do
224 ;;; LET conversion here.
225 (defun local-call-analyze-1 (fun)
226   (declare (type functional fun))
227   (let ((refs (leaf-refs fun))
228         (first-time t))
229     (dolist (ref refs)
230       (let* ((cont (node-cont ref))
231              (dest (continuation-dest cont)))
232         (cond ((and (basic-combination-p dest)
233                     (eq (basic-combination-fun dest) cont)
234                     (eq (continuation-use cont) ref))
235
236                (convert-call-if-possible ref dest)
237
238                (unless (eq (basic-combination-kind dest) :local)
239                  (reference-entry-point ref)))
240               (t
241                (reference-entry-point ref))))
242       (setq first-time nil)))
243
244   (values))
245
246 ;;; We examine all New-Functions in component, attempting to convert
247 ;;; calls into local calls when it is legal. We also attempt to
248 ;;; convert each lambda to a LET. LET conversion is also triggered by
249 ;;; deletion of a function reference, but functions that start out
250 ;;; eligible for conversion must be noticed sometime.
251 ;;;
252 ;;; Note that there is a lot of action going on behind the scenes
253 ;;; here, triggered by reference deletion. In particular, the
254 ;;; COMPONENT-LAMBDAS are being hacked to remove newly deleted and let
255 ;;; converted lambdas, so it is important that the lambda is added to
256 ;;; the COMPONENT-LAMBDAS when it is. Also, the
257 ;;; COMPONENT-NEW-FUNCTIONS may contain all sorts of drivel, since it
258 ;;; is not updated when we delete functions, etc. Only
259 ;;; COMPONENT-LAMBDAS is updated.
260 ;;;
261 ;;; COMPONENT-REANALYZE-FUNCTIONS is treated similarly to
262 ;;; NEW-FUNCTIONS, but we don't add lambdas to the LAMBDAS.
263 (defun local-call-analyze (component)
264   (declare (type component component))
265   (loop
266     (let* ((new (pop (component-new-functions component)))
267            (fun (or new (pop (component-reanalyze-functions component)))))
268       (unless fun (return))
269       (let ((kind (functional-kind fun)))
270         (cond ((member kind '(:deleted :let :mv-let :assignment)))
271               ((and (null (leaf-refs fun)) (eq kind nil)
272                     (not (functional-entry-function fun)))
273                (delete-functional fun))
274               (t
275                (when (and new (lambda-p fun))
276                  (push fun (component-lambdas component)))
277                (local-call-analyze-1 fun)
278                (when (lambda-p fun)
279                  (maybe-let-convert fun)))))))
280
281   (values))
282
283 ;;; If policy is auspicious, Call is not in an XEP, and we don't seem
284 ;;; to be in an infinite recursive loop, then change the reference to
285 ;;; reference a fresh copy. We return whichever function we decide to
286 ;;; reference.
287 (defun maybe-expand-local-inline (fun ref call)
288   (if (and (policy call
289                    (and (>= speed space) (>= speed cspeed)))
290            (not (eq (functional-kind (node-home-lambda call)) :external))
291            (not *converting-for-interpreter*)
292            (inline-expansion-ok call))
293       (with-ir1-environment call
294         (let* ((*lexenv* (functional-lexenv fun))
295                (won nil)
296                (res (catch 'local-call-lossage
297                       (prog1
298                           (ir1-convert-lambda (functional-inline-expansion fun))
299                         (setq won t)))))
300           (cond (won
301                  (change-ref-leaf ref res)
302                  res)
303                 (t
304                  (let ((*compiler-error-context* call))
305                    (compiler-note "couldn't inline expand because expansion ~
306                                    calls this let-converted local function:~
307                                    ~%  ~S"
308                                   (leaf-name res)))
309                  fun))))
310       fun))
311
312 ;;; Dispatch to the appropriate function to attempt to convert a call. Ref
313 ;;; most be a reference to a FUNCTIONAL. This is called in IR1 optimize as
314 ;;; well as in local call analysis. If the call is is already :Local, we do
315 ;;; nothing. If the call is already scheduled for deletion, also do nothing
316 ;;; (in addition to saving time, this also avoids some problems with optimizing
317 ;;; collections of functions that are partially deleted.)
318 ;;;
319 ;;; This is called both before and after FIND-INITIAL-DFO runs. When called
320 ;;; on a :INITIAL component, we don't care whether the caller and callee are in
321 ;;; the same component. Afterward, we must stick with whatever component
322 ;;; division we have chosen.
323 ;;;
324 ;;; Before attempting to convert a call, we see whether the function is
325 ;;; supposed to be inline expanded. Call conversion proceeds as before
326 ;;; after any expansion.
327 ;;;
328 ;;; We bind *Compiler-Error-Context* to the node for the call so that
329 ;;; warnings will get the right context.
330 (defun convert-call-if-possible (ref call)
331   (declare (type ref ref) (type basic-combination call))
332   (let* ((block (node-block call))
333          (component (block-component block))
334          (original-fun (ref-leaf ref)))
335     (assert (functional-p original-fun))
336     (unless (or (member (basic-combination-kind call) '(:local :error))
337                 (block-delete-p block)
338                 (eq (functional-kind (block-home-lambda block)) :deleted)
339                 (member (functional-kind original-fun)
340                         '(:top-level-xep :deleted))
341                 (not (or (eq (component-kind component) :initial)
342                          (eq (block-component
343                               (node-block
344                                (lambda-bind (main-entry original-fun))))
345                              component))))
346       (let ((fun (if (external-entry-point-p original-fun)
347                      (functional-entry-function original-fun)
348                      original-fun))
349             (*compiler-error-context* call))
350
351         (when (and (eq (functional-inlinep fun) :inline)
352                    (rest (leaf-refs original-fun)))
353           (setq fun (maybe-expand-local-inline fun ref call)))
354
355         (assert (member (functional-kind fun)
356                         '(nil :escape :cleanup :optional)))
357         (cond ((mv-combination-p call)
358                (convert-mv-call ref call fun))
359               ((lambda-p fun)
360                (convert-lambda-call ref call fun))
361               (t
362                (convert-hairy-call ref call fun))))))
363
364   (values))
365
366 ;;; Attempt to convert a multiple-value call. The only interesting
367 ;;; case is a call to a function that Looks-Like-An-MV-Bind, has
368 ;;; exactly one reference and no XEP, and is called with one values
369 ;;; continuation.
370 ;;;
371 ;;; We change the call to be to the last optional entry point and
372 ;;; change the call to be local. Due to our preconditions, the call
373 ;;; should eventually be converted to a let, but we can't do that now,
374 ;;; since there may be stray references to the e-p lambda due to
375 ;;; optional defaulting code.
376 ;;;
377 ;;; We also use variable types for the called function to construct an
378 ;;; assertion for the values continuation.
379 ;;;
380 ;;; See CONVERT-CALL for additional notes on MERGE-TAIL-SETS, etc.
381 (defun convert-mv-call (ref call fun)
382   (declare (type ref ref) (type mv-combination call) (type functional fun))
383   (when (and (looks-like-an-mv-bind fun)
384              (not (functional-entry-function fun))
385              (= (length (leaf-refs fun)) 1)
386              (= (length (basic-combination-args call)) 1))
387     (let ((ep (car (last (optional-dispatch-entry-points fun)))))
388       (setf (basic-combination-kind call) :local)
389       (pushnew ep (lambda-calls (node-home-lambda call)))
390       (merge-tail-sets call ep)
391       (change-ref-leaf ref ep)
392
393       (assert-continuation-type
394        (first (basic-combination-args call))
395        (make-values-type :optional (mapcar #'leaf-type (lambda-vars ep))
396                          :rest *universal-type*))))
397   (values))
398
399 ;;; Attempt to convert a call to a lambda. If the number of args is
400 ;;; wrong, we give a warning and mark the call as :ERROR to remove it
401 ;;; from future consideration. If the argcount is O.K. then we just
402 ;;; convert it.
403 (defun convert-lambda-call (ref call fun)
404   (declare (type ref ref) (type combination call) (type clambda fun))
405   (let ((nargs (length (lambda-vars fun)))
406         (call-args (length (combination-args call))))
407     (cond ((= call-args nargs)
408            (convert-call ref call fun))
409           (t
410            ;; FIXME: ANSI requires in "3.2.5 Exceptional Situations in the
411            ;; Compiler" that calling a function with "the wrong number of
412            ;; arguments" be only a STYLE-ERROR. I think, though, that this
413            ;; should only apply when the number of arguments is inferred
414            ;; from a previous definition. If the number of arguments
415            ;; is DECLAIMed, surely calling with the wrong number is a
416            ;; real WARNING. As long as SBCL continues to use CMU CL's
417            ;; non-ANSI DEFUN-is-a-DECLAIM policy, we're in violation here,
418            ;; but as long as we continue to use that policy, that's the
419            ;; not our biggest problem.:-| When we fix that policy, this
420            ;; should come back into compliance. (So fix that policy!)
421            (compiler-warning
422             "function called with ~R argument~:P, but wants exactly ~R"
423             call-args nargs)
424            (setf (basic-combination-kind call) :error)))))
425 \f
426 ;;;; optional, more and keyword calls
427
428 ;;; Similar to Convert-Lambda-Call, but deals with Optional-Dispatches. If
429 ;;; only fixed args are supplied, then convert a call to the correct entry
430 ;;; point. If keyword args are supplied, then dispatch to a subfunction. We
431 ;;; don't convert calls to functions that have a more (or rest) arg.
432 (defun convert-hairy-call (ref call fun)
433   (declare (type ref ref) (type combination call)
434            (type optional-dispatch fun))
435   (let ((min-args (optional-dispatch-min-args fun))
436         (max-args (optional-dispatch-max-args fun))
437         (call-args (length (combination-args call))))
438     (cond ((< call-args min-args)
439            ;; FIXME: ANSI requires in "3.2.5 Exceptional Situations in the
440            ;; Compiler" that calling a function with "the wrong number of
441            ;; arguments" be only a STYLE-ERROR. I think, though, that this
442            ;; should only apply when the number of arguments is inferred
443            ;; from a previous definition. If the number of arguments
444            ;; is DECLAIMed, surely calling with the wrong number is a
445            ;; real WARNING. As long as SBCL continues to use CMU CL's
446            ;; non-ANSI DEFUN-is-a-DECLAIM policy, we're in violation here,
447            ;; but as long as we continue to use that policy, that's the
448            ;; not our biggest problem.:-| When we fix that policy, this
449            ;; should come back into compliance. (So fix that policy!)
450            (compiler-warning
451             "function called with ~R argument~:P, but wants at least ~R"
452             call-args min-args)
453            (setf (basic-combination-kind call) :error))
454           ((<= call-args max-args)
455            (convert-call ref call
456                          (elt (optional-dispatch-entry-points fun)
457                               (- call-args min-args))))
458           ((optional-dispatch-more-entry fun)
459            (convert-more-call ref call fun))
460           (t
461            ;; FIXME: ANSI requires in "3.2.5 Exceptional Situations in the
462            ;; Compiler" that calling a function with "the wrong number of
463            ;; arguments" be only a STYLE-ERROR. I think, though, that this
464            ;; should only apply when the number of arguments is inferred
465            ;; from a previous definition. If the number of arguments
466            ;; is DECLAIMed, surely calling with the wrong number is a
467            ;; real WARNING. As long as SBCL continues to use CMU CL's
468            ;; non-ANSI DEFUN-is-a-DECLAIM policy, we're in violation here,
469            ;; but as long as we continue to use that policy, that's the
470            ;; not our biggest problem.:-| When we fix that policy, this
471            ;; should come back into compliance. (So fix that policy!)
472            (compiler-warning
473             "function called with ~R argument~:P, but wants at most ~R"
474             call-args max-args)
475            (setf (basic-combination-kind call) :error))))
476   (values))
477
478 ;;; This function is used to convert a call to an entry point when complex
479 ;;; transformations need to be done on the original arguments. Entry is the
480 ;;; entry point function that we are calling. Vars is a list of variable names
481 ;;; which are bound to the original call arguments. Ignores is the subset of
482 ;;; Vars which are ignored. Args is the list of arguments to the entry point
483 ;;; function.
484 ;;;
485 ;;; In order to avoid gruesome graph grovelling, we introduce a new function
486 ;;; that rearranges the arguments and calls the entry point. We analyze the
487 ;;; new function and the entry point immediately so that everything gets
488 ;;; converted during the single pass.
489 (defun convert-hairy-fun-entry (ref call entry vars ignores args)
490   (declare (list vars ignores args) (type ref ref) (type combination call)
491            (type clambda entry))
492   (let ((new-fun
493          (with-ir1-environment call
494            (ir1-convert-lambda
495             `(lambda ,vars
496                (declare (ignorable . ,ignores))
497                (%funcall ,entry . ,args))))))
498     (convert-call ref call new-fun)
499     (dolist (ref (leaf-refs entry))
500       (convert-call-if-possible ref (continuation-dest (node-cont ref))))))
501
502 ;;; Use Convert-Hairy-Fun-Entry to convert a more-arg call to a known
503 ;;; function into a local call to the Main-Entry.
504 ;;;
505 ;;; First we verify that all keywords are constant and legal. If there
506 ;;; aren't, then we warn the user and don't attempt to convert the call.
507 ;;;
508 ;;; We massage the supplied keyword arguments into the order expected by the
509 ;;; main entry. This is done by binding all the arguments to the keyword call
510 ;;; to variables in the introduced lambda, then passing these values variables
511 ;;; in the correct order when calling the main entry. Unused arguments
512 ;;; (such as the keywords themselves) are discarded simply by not passing them
513 ;;; along.
514 ;;;
515 ;;; If there is a rest arg, then we bundle up the args and pass them to LIST.
516 (defun convert-more-call (ref call fun)
517   (declare (type ref ref) (type combination call) (type optional-dispatch fun))
518   (let* ((max (optional-dispatch-max-args fun))
519          (arglist (optional-dispatch-arglist fun))
520          (args (combination-args call))
521          (more (nthcdr max args))
522          (flame (policy call (or (> speed brevity) (> space brevity))))
523          (loser nil)
524          (temps (make-gensym-list max))
525          (more-temps (make-gensym-list (length more))))
526     (collect ((ignores)
527               (supplied)
528               (key-vars))
529
530       (dolist (var arglist)
531         (let ((info (lambda-var-arg-info var)))
532           (when info
533             (ecase (arg-info-kind info)
534               (:keyword
535                (key-vars var))
536               ((:rest :optional))
537               ((:more-context :more-count)
538                (compiler-warning "can't local-call functions with &MORE args")
539                (setf (basic-combination-kind call) :error)
540                (return-from convert-more-call))))))
541
542       (when (optional-dispatch-keyp fun)
543         (when (oddp (length more))
544           (compiler-warning "function called with odd number of ~
545                              arguments in keyword portion")
546
547           (setf (basic-combination-kind call) :error)
548           (return-from convert-more-call))
549
550         (do ((key more (cddr key))
551              (temp more-temps (cddr temp)))
552             ((null key))
553           (let ((cont (first key)))
554             (unless (constant-continuation-p cont)
555               (when flame
556                 (compiler-note "non-constant keyword in keyword call"))
557               (setf (basic-combination-kind call) :error)
558               (return-from convert-more-call))
559
560             (let ((name (continuation-value cont))
561                   (dummy (first temp))
562                   (val (second temp)))
563               (dolist (var (key-vars)
564                            (progn
565                              (ignores dummy val)
566                              (setq loser name)))
567                 (let ((info (lambda-var-arg-info var)))
568                   (when (eq (arg-info-keyword info) name)
569                     (ignores dummy)
570                     (supplied (cons var val))
571                     (return)))))))
572
573         (when (and loser (not (optional-dispatch-allowp fun)))
574           (compiler-warning "function called with unknown argument keyword ~S"
575                             loser)
576           (setf (basic-combination-kind call) :error)
577           (return-from convert-more-call)))
578
579       (collect ((call-args))
580         (do ((var arglist (cdr var))
581              (temp temps (cdr temp)))
582             (())
583           (let ((info (lambda-var-arg-info (car var))))
584             (if info
585                 (ecase (arg-info-kind info)
586                   (:optional
587                    (call-args (car temp))
588                    (when (arg-info-supplied-p info)
589                      (call-args t)))
590                   (:rest
591                    (call-args `(list ,@more-temps))
592                    (return))
593                   (:keyword
594                    (return)))
595                 (call-args (car temp)))))
596
597         (dolist (var (key-vars))
598           (let ((info (lambda-var-arg-info var))
599                 (temp (cdr (assoc var (supplied)))))
600             (if temp
601                 (call-args temp)
602                 (call-args (arg-info-default info)))
603             (when (arg-info-supplied-p info)
604               (call-args (not (null temp))))))
605
606         (convert-hairy-fun-entry ref call (optional-dispatch-main-entry fun)
607                                  (append temps more-temps)
608                                  (ignores) (call-args)))))
609
610   (values))
611 \f
612 ;;;; LET conversion
613 ;;;;
614 ;;;; Converting to a LET has differing significance to various parts of the
615 ;;;; compiler:
616 ;;;; -- The body of a LET is spliced in immediately after the corresponding
617 ;;;;    combination node, making the control transfer explicit and allowing
618 ;;;;    LETs to be mashed together into a single block. The value of the LET is
619 ;;;;    delivered directly to the original continuation for the call,
620 ;;;;    eliminating the need to propagate information from the dummy result
621 ;;;;    continuation.
622 ;;;; -- As far as IR1 optimization is concerned, it is interesting in that
623 ;;;;    there is only one expression that the variable can be bound to, and
624 ;;;;    this is easily substitited for.
625 ;;;; -- LETs are interesting to environment analysis and to the back end
626 ;;;;    because in most ways a LET can be considered to be "the same function"
627 ;;;;    as its home function.
628 ;;;; -- LET conversion has dynamic scope implications, since control transfers
629 ;;;;    within the same environment are local. In a local control transfer,
630 ;;;;    cleanup code must be emitted to remove dynamic bindings that are no
631 ;;;;    longer in effect.
632
633 ;;; Set up the control transfer to the called lambda. We split the call
634 ;;; block immediately after the call, and link the head of FUN to the call
635 ;;; block. The successor block after splitting (where we return to) is
636 ;;; returned.
637 ;;;
638 ;;; If the lambda is is a different component than the call, then we call
639 ;;; JOIN-COMPONENTS. This only happens in block compilation before
640 ;;; FIND-INITIAL-DFO.
641 (defun insert-let-body (fun call)
642   (declare (type clambda fun) (type basic-combination call))
643   (let* ((call-block (node-block call))
644          (bind-block (node-block (lambda-bind fun)))
645          (component (block-component call-block)))
646     (let ((fun-component (block-component bind-block)))
647       (unless (eq fun-component component)
648         (assert (eq (component-kind component) :initial))
649         (join-components component fun-component)))
650
651     (let ((*current-component* component))
652       (node-ends-block call))
653     ;; FIXME: Use PROPER-LIST-OF-LENGTH-P here, and look for other
654     ;; uses of '=.*length' which could also be converted to use
655     ;; PROPER-LIST-OF-LENGTH-P.
656     (assert (= (length (block-succ call-block)) 1))
657     (let ((next-block (first (block-succ call-block))))
658       (unlink-blocks call-block next-block)
659       (link-blocks call-block bind-block)
660       next-block)))
661
662 ;;; Handle the environment semantics of LET conversion. We add the
663 ;;; lambda and its LETs to lets for the CALL's home function. We merge
664 ;;; the calls for FUN with the calls for the home function, removing
665 ;;; FUN in the process. We also merge the Entries.
666 ;;;
667 ;;; We also unlink the function head from the component head and set
668 ;;; COMPONENT-REANALYZE to true to indicate that the DFO should be
669 ;;; recomputed.
670 (defun merge-lets (fun call)
671   (declare (type clambda fun) (type basic-combination call))
672   (let ((component (block-component (node-block call))))
673     (unlink-blocks (component-head component) (node-block (lambda-bind fun)))
674     (setf (component-lambdas component)
675           (delete fun (component-lambdas component)))
676     (setf (component-reanalyze component) t))
677   (setf (lambda-call-lexenv fun) (node-lexenv call))
678   (let ((tails (lambda-tail-set fun)))
679     (setf (tail-set-functions tails)
680           (delete fun (tail-set-functions tails))))
681   (setf (lambda-tail-set fun) nil)
682   (let* ((home (node-home-lambda call))
683          (home-env (lambda-environment home)))
684     (push fun (lambda-lets home))
685     (setf (lambda-home fun) home)
686     (setf (lambda-environment fun) home-env)
687
688     (let ((lets (lambda-lets fun)))
689       (dolist (let lets)
690         (setf (lambda-home let) home)
691         (setf (lambda-environment let) home-env))
692
693       (setf (lambda-lets home) (nconc lets (lambda-lets home)))
694       (setf (lambda-lets fun) ()))
695
696     (setf (lambda-calls home)
697             (delete fun (nunion (lambda-calls fun) (lambda-calls home))))
698     (setf (lambda-calls fun) ())
699
700     (setf (lambda-entries home)
701           (nconc (lambda-entries fun) (lambda-entries home)))
702     (setf (lambda-entries fun) ()))
703   (values))
704
705 ;;; Handle the value semantics of LET conversion. Delete FUN's return
706 ;;; node, and change the control flow to transfer to NEXT-BLOCK
707 ;;; instead. Move all the uses of the result continuation to CALL's
708 ;;; CONT.
709 ;;;
710 ;;; If the actual continuation is only used by the LET call, then we
711 ;;; intersect the type assertion on the dummy continuation with the
712 ;;; assertion for the actual continuation; in all other cases
713 ;;; assertions on the dummy continuation are lost.
714 ;;;
715 ;;; We also intersect the derived type of the CALL with the derived
716 ;;; type of all the dummy continuation's uses. This serves mainly to
717 ;;; propagate TRULY-THE through LETs.
718 (defun move-return-uses (fun call next-block)
719   (declare (type clambda fun) (type basic-combination call)
720            (type cblock next-block))
721   (let* ((return (lambda-return fun))
722          (return-block (node-block return)))
723     (unlink-blocks return-block
724                    (component-tail (block-component return-block)))
725     (link-blocks return-block next-block)
726     (unlink-node return)
727     (delete-return return)
728     (let ((result (return-result return))
729           (cont (node-cont call))
730           (call-type (node-derived-type call)))
731       (when (eq (continuation-use cont) call)
732         (assert-continuation-type cont (continuation-asserted-type result)))
733       (unless (eq call-type *wild-type*)
734         (do-uses (use result)
735           (derive-node-type use call-type)))
736       (substitute-continuation-uses cont result)))
737   (values))
738
739 ;;; Change all CONT for all the calls to FUN to be the start
740 ;;; continuation for the bind node. This allows the blocks to be
741 ;;; joined if the caller count ever goes to one.
742 (defun move-let-call-cont (fun)
743   (declare (type clambda fun))
744   (let ((new-cont (node-prev (lambda-bind fun))))
745     (dolist (ref (leaf-refs fun))
746       (let ((dest (continuation-dest (node-cont ref))))
747         (delete-continuation-use dest)
748         (add-continuation-use dest new-cont))))
749   (values))
750
751 ;;; We are converting FUN to be a LET when the call is in a non-tail
752 ;;; position. Any previously tail calls in FUN are no longer tail
753 ;;; calls, and must be restored to normal calls which transfer to
754 ;;; NEXT-BLOCK (FUN's return point.) We can't do this by DO-USES on
755 ;;; the RETURN-RESULT, because the return might have been deleted (if
756 ;;; all calls were TR.)
757 ;;;
758 ;;; The called function might be an assignment in the case where we
759 ;;; are currently converting that function. In steady-state,
760 ;;; assignments never appear in the lambda-calls.
761 (defun unconvert-tail-calls (fun call next-block)
762   (dolist (called (lambda-calls fun))
763     (dolist (ref (leaf-refs called))
764       (let ((this-call (continuation-dest (node-cont ref))))
765         (when (and (node-tail-p this-call)
766                    (eq (node-home-lambda this-call) fun))
767           (setf (node-tail-p this-call) nil)
768           (ecase (functional-kind called)
769             ((nil :cleanup :optional)
770              (let ((block (node-block this-call))
771                    (cont (node-cont call)))
772                (ensure-block-start cont)
773                (unlink-blocks block (first (block-succ block)))
774                (link-blocks block next-block)
775                (delete-continuation-use this-call)
776                (add-continuation-use this-call cont)))
777             (:deleted)
778             (:assignment
779              (assert (eq called fun))))))))
780   (values))
781
782 ;;; Deal with returning from a LET or assignment that we are
783 ;;; converting. FUN is the function we are calling, CALL is a call to
784 ;;; FUN, and NEXT-BLOCK is the return point for a non-tail call, or
785 ;;; NULL if call is a tail call.
786 ;;;
787 ;;; If the call is not a tail call, then we must do
788 ;;; UNCONVERT-TAIL-CALLS, since a tail call is a call which returns
789 ;;; its value out of the enclosing non-let function. When call is
790 ;;; non-TR, we must convert it back to an ordinary local call, since
791 ;;; the value must be delivered to the receiver of CALL's value.
792 ;;;
793 ;;; We do different things depending on whether the caller and callee
794 ;;; have returns left:
795
796 ;;; -- If the callee has no return we just do MOVE-LET-CALL-CONT. Either 
797 ;;;    the function doesn't return, or all returns are via tail-recursive
798 ;;;    local calls.
799 ;;; -- If CALL is a non-tail call, or if both have returns, then we
800 ;;;    delete the callee's return, move its uses to the call's result
801 ;;;    continuation, and transfer control to the appropriate return point.
802 ;;; -- If the callee has a return, but the caller doesn't, then we move the
803 ;;;    return to the caller.
804 (defun move-return-stuff (fun call next-block)
805   (declare (type clambda fun) (type basic-combination call)
806            (type (or cblock null) next-block))
807   (when next-block
808     (unconvert-tail-calls fun call next-block))
809   (let* ((return (lambda-return fun))
810          (call-fun (node-home-lambda call))
811          (call-return (lambda-return call-fun)))
812     (cond ((not return))
813           ((or next-block call-return)
814            (unless (block-delete-p (node-block return))
815              (move-return-uses fun call
816                                (or next-block (node-block call-return)))))
817           (t
818            (assert (node-tail-p call))
819            (setf (lambda-return call-fun) return)
820            (setf (return-lambda return) call-fun))))
821   (move-let-call-cont fun)
822   (values))
823
824 ;;; Actually do LET conversion. We call subfunctions to do most of the
825 ;;; work. We change the CALL's cont to be the continuation heading the
826 ;;; bind block, and also do REOPTIMIZE-CONTINUATION on the args and
827 ;;; Cont so that let-specific IR1 optimizations get a chance. We blow
828 ;;; away any entry for the function in *FREE-FUNCTIONS* so that nobody
829 ;;; will create new reference to it.
830 (defun let-convert (fun call)
831   (declare (type clambda fun) (type basic-combination call))
832   (let ((next-block (if (node-tail-p call)
833                         nil
834                         (insert-let-body fun call))))
835     (move-return-stuff fun call next-block)
836     (merge-lets fun call)))
837
838 ;;; Reoptimize all of Call's args and its result.
839 (defun reoptimize-call (call)
840   (declare (type basic-combination call))
841   (dolist (arg (basic-combination-args call))
842     (when arg
843       (reoptimize-continuation arg)))
844   (reoptimize-continuation (node-cont call))
845   (values))
846
847 ;;; We also don't convert calls to named functions which appear in the
848 ;;; initial component, delaying this until optimization. This
849 ;;; minimizes the likelyhood that we well let-convert a function which
850 ;;; may have references added due to later local inline expansion
851 (defun ok-initial-convert-p (fun)
852   (not (and (leaf-name fun)
853             (eq (component-kind
854                  (block-component
855                   (node-block (lambda-bind fun))))
856                 :initial))))
857
858 ;;; This function is called when there is some reason to believe that
859 ;;; the lambda Fun might be converted into a let. This is done after
860 ;;; local call analysis, and also when a reference is deleted. We only
861 ;;; convert to a let when the function is a normal local function, has
862 ;;; no XEP, and is referenced in exactly one local call. Conversion is
863 ;;; also inhibited if the only reference is in a block about to be
864 ;;; deleted. We return true if we converted.
865 ;;;
866 ;;; These rules may seem unnecessarily restrictive, since there are
867 ;;; some cases where we could do the return with a jump that don't
868 ;;; satisfy these requirements. The reason for doing things this way
869 ;;; is that it makes the concept of a LET much more useful at the
870 ;;; level of IR1 semantics. The :ASSIGNMENT function kind provides
871 ;;; another way to optimize calls to single-return/multiple call
872 ;;; functions.
873 ;;;
874 ;;; We don't attempt to convert calls to functions that have an XEP,
875 ;;; since we might be embarrassed later when we want to convert a
876 ;;; newly discovered local call. Also, see OK-INITIAL-CONVERT-P.
877 (defun maybe-let-convert (fun)
878   (declare (type clambda fun))
879   (let ((refs (leaf-refs fun)))
880     (when (and refs
881                (null (rest refs))
882                (member (functional-kind fun) '(nil :assignment))
883                (not (functional-entry-function fun)))
884       (let* ((ref-cont (node-cont (first refs)))
885              (dest (continuation-dest ref-cont)))
886         (when (and (basic-combination-p dest)
887                    (eq (basic-combination-fun dest) ref-cont)
888                    (eq (basic-combination-kind dest) :local)
889                    (not (block-delete-p (node-block dest)))
890                    (cond ((ok-initial-convert-p fun) t)
891                          (t
892                           (reoptimize-continuation ref-cont)
893                           nil)))
894           (unless (eq (functional-kind fun) :assignment)
895             (let-convert fun dest))
896           (reoptimize-call dest)
897           (setf (functional-kind fun)
898                 (if (mv-combination-p dest) :mv-let :let))))
899       t)))
900 \f
901 ;;;; tail local calls and assignments
902
903 ;;; Return T if there are no cleanups between BLOCK1 and BLOCK2, or if
904 ;;; they definitely won't generate any cleanup code. Currently we
905 ;;; recognize lexical entry points that are only used locally (if at
906 ;;; all).
907 (defun only-harmless-cleanups (block1 block2)
908   (declare (type cblock block1 block2))
909   (or (eq block1 block2)
910       (let ((cleanup2 (block-start-cleanup block2)))
911         (do ((cleanup (block-end-cleanup block1)
912                       (node-enclosing-cleanup (cleanup-mess-up cleanup))))
913             ((eq cleanup cleanup2) t)
914           (case (cleanup-kind cleanup)
915             ((:block :tagbody)
916              (unless (null (entry-exits (cleanup-mess-up cleanup)))
917                (return nil)))
918             (t (return nil)))))))
919
920 ;;; If a potentially TR local call really is TR, then convert it to
921 ;;; jump directly to the called function. We also call
922 ;;; MAYBE-CONVERT-TO-ASSIGNMENT. The first value is true if we
923 ;;; tail-convert. The second is the value of M-C-T-A. We can switch
924 ;;; the succesor (potentially deleting the RETURN node) unless:
925 ;;; -- The call has already been converted.
926 ;;; -- The call isn't TR (some implicit MV PROG1.)
927 ;;; -- The call is in an XEP (thus we might decide to make it non-tail 
928 ;;;    so that we can use known return inside the component.)
929 ;;; -- There is a change in the cleanup between the call in the return, 
930 ;;;    so we might need to introduce cleanup code.
931 (defun maybe-convert-tail-local-call (call)
932   (declare (type combination call))
933   (let ((return (continuation-dest (node-cont call))))
934     (assert (return-p return))
935     (when (and (not (node-tail-p call))
936                (immediately-used-p (return-result return) call)
937                (not (eq (functional-kind (node-home-lambda call))
938                         :external))
939                (only-harmless-cleanups (node-block call)
940                                        (node-block return)))
941       (node-ends-block call)
942       (let ((block (node-block call))
943             (fun (combination-lambda call)))
944         (setf (node-tail-p call) t)
945         (unlink-blocks block (first (block-succ block)))
946         (link-blocks block (node-block (lambda-bind fun)))
947         (values t (maybe-convert-to-assignment fun))))))
948
949 ;;; This is called when we believe it might make sense to convert Fun
950 ;;; to an assignment. All this function really does is determine when
951 ;;; a function with more than one call can still be combined with the
952 ;;; calling function's environment. We can convert when:
953 ;;; -- The function is a normal, non-entry function, and
954 ;;; -- Except for one call, all calls must be tail recursive calls 
955 ;;;    in the called function (i.e. are self-recursive tail calls)
956 ;;; -- OK-INITIAL-CONVERT-P is true.
957 ;;;
958 ;;; There may be one outside call, and it need not be tail-recursive.
959 ;;; Since all tail local calls have already been converted to direct
960 ;;; transfers, the only control semantics needed are to splice in the
961 ;;; body at the non-tail call. If there is no non-tail call, then we
962 ;;; need only merge the environments. Both cases are handled by
963 ;;; LET-CONVERT.
964 ;;;
965 ;;; ### It would actually be possible to allow any number of outside
966 ;;; calls as long as they all return to the same place (i.e. have the
967 ;;; same conceptual continuation.) A special case of this would be
968 ;;; when all of the outside calls are tail recursive.
969 (defun maybe-convert-to-assignment (fun)
970   (declare (type clambda fun))
971   (when (and (not (functional-kind fun))
972              (not (functional-entry-function fun)))
973     (let ((non-tail nil)
974           (call-fun nil))
975       (when (and (dolist (ref (leaf-refs fun) t)
976                    (let ((dest (continuation-dest (node-cont ref))))
977                      (when (block-delete-p (node-block dest)) (return nil))
978                      (let ((home (node-home-lambda ref)))
979                        (unless (eq home fun)
980                          (when call-fun (return nil))
981                          (setq call-fun home))
982                        (unless (node-tail-p dest)
983                          (when (or non-tail (eq home fun)) (return nil))
984                          (setq non-tail dest)))))
985                  (ok-initial-convert-p fun))
986         (setf (functional-kind fun) :assignment)
987         (let-convert fun (or non-tail
988                              (continuation-dest
989                               (node-cont (first (leaf-refs fun))))))
990         (when non-tail (reoptimize-call non-tail))
991         t))))