0.7.8.7:
[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
25 ;;; function FUN to the actual arguments in CALL. This is also called
26 ;;; by the VALUES IR1 optimizer when it sleazily converts MV-BINDs to
27 ;;; LETs.
28 ;;;
29 ;;; We flush all arguments to CALL that correspond to unreferenced
30 ;;; variables in FUN. We leave NILs in the COMBINATION-ARGS so that
31 ;;; the remaining args still match up with their vars.
32 ;;;
33 ;;; We also apply the declared variable type assertion to the argument
34 ;;; continuations.
35 (defun propagate-to-args (call fun)
36   (declare (type combination call) (type clambda fun))
37   (do ((args (basic-combination-args call) (cdr args))
38        (vars (lambda-vars fun) (cdr vars)))
39       ((null args))
40     (let ((arg (car args))
41           (var (car vars)))
42       (cond ((leaf-refs var)
43              (assert-continuation-type arg (leaf-type var)))
44             (t
45              (flush-dest arg)
46              (setf (car args) nil)))))
47
48   (values))
49
50 ;;; This function handles merging the tail sets if CALL is potentially
51 ;;; tail-recursive, and is a call to a function with a different
52 ;;; TAIL-SET than CALL's FUN. This must be called whenever we alter
53 ;;; IR1 so as to place a local call in what might be a tail-recursive
54 ;;; context. Note that any call which returns its value to a RETURN is
55 ;;; considered potentially tail-recursive, since any implicit MV-PROG1
56 ;;; might be optimized away.
57 ;;;
58 ;;; We destructively modify the set for the calling function to
59 ;;; represent both, and then change all the functions in callee's set
60 ;;; to reference the first. If we do merge, we reoptimize the
61 ;;; RETURN-RESULT continuation to cause IR1-OPTIMIZE-RETURN to
62 ;;; recompute the tail set type.
63 (defun merge-tail-sets (call &optional (new-fun (combination-lambda call)))
64   (declare (type basic-combination call) (type clambda new-fun))
65   (let ((return (continuation-dest (node-cont call))))
66     (when (return-p return)
67       (let ((call-set (lambda-tail-set (node-home-lambda call)))
68             (fun-set (lambda-tail-set new-fun)))
69         (unless (eq call-set fun-set)
70           (let ((funs (tail-set-funs fun-set)))
71             (dolist (fun funs)
72               (setf (lambda-tail-set fun) call-set))
73             (setf (tail-set-funs call-set)
74                   (nconc (tail-set-funs call-set) funs)))
75           (reoptimize-continuation (return-result return))
76           t)))))
77
78 ;;; Convert a combination into a local call. We PROPAGATE-TO-ARGS, set
79 ;;; the combination kind to :LOCAL, add FUN to the CALLS of the
80 ;;; function that the call is in, call MERGE-TAIL-SETS, then replace
81 ;;; the function in the REF node with the new function.
82 ;;;
83 ;;; We change the REF last, since changing the reference can trigger
84 ;;; LET conversion of the new function, but will only do so if the
85 ;;; call is local. Note that the replacement may trigger LET
86 ;;; conversion or other changes in IR1. We must call MERGE-TAIL-SETS
87 ;;; with NEW-FUN before the substitution, since after the substitution
88 ;;; (and LET conversion), the call may no longer be recognizable as
89 ;;; tail-recursive.
90 (defun convert-call (ref call fun)
91   (declare (type ref ref) (type combination call) (type clambda fun))
92   (propagate-to-args call fun)
93   (setf (basic-combination-kind call) :local)
94   (pushnew fun (lambda-calls-or-closes (node-home-lambda call)))
95   (merge-tail-sets call fun)
96   (change-ref-leaf ref fun)
97   (values))
98 \f
99 ;;;; external entry point creation
100
101 ;;; Return a LAMBDA form that can be used as the definition of the XEP
102 ;;; for FUN.
103 ;;;
104 ;;; If FUN is a LAMBDA, then we check the number of arguments
105 ;;; (conditional on policy) and call FUN with all the arguments.
106 ;;;
107 ;;; If FUN is an OPTIONAL-DISPATCH, then we dispatch off of the number
108 ;;; of supplied arguments by doing do an = test for each entry-point,
109 ;;; calling the entry with the appropriate prefix of the passed
110 ;;; arguments.
111 ;;;
112 ;;; If there is a &MORE arg, then there are a couple of optimizations
113 ;;; that we make (more for space than anything else):
114 ;;; -- If MIN-ARGS is 0, then we make the more entry a T clause, since 
115 ;;;    no argument count error is possible.
116 ;;; -- We can omit the = clause for the last entry-point, allowing the 
117 ;;;    case of 0 more args to fall through to the more entry.
118 ;;;
119 ;;; We don't bother to policy conditionalize wrong arg errors in
120 ;;; optional dispatches, since the additional overhead is negligible
121 ;;; compared to the cost of everything else going on.
122 ;;;
123 ;;; Note that if policy indicates it, argument type declarations in
124 ;;; FUN will be verified. Since nothing is known about the type of the
125 ;;; XEP arg vars, type checks will be emitted when the XEP's arg vars
126 ;;; are passed to the actual function.
127 (defun make-xep-lambda-expression (fun)
128   (declare (type functional fun))
129   (etypecase fun
130     (clambda
131      (let ((nargs (length (lambda-vars fun)))
132            (n-supplied (gensym))
133            (temps (make-gensym-list (length (lambda-vars fun)))))
134        `(lambda (,n-supplied ,@temps)
135           (declare (type index ,n-supplied))
136           ,(if (policy *lexenv* (zerop safety))
137                `(declare (ignore ,n-supplied))
138                `(%verify-arg-count ,n-supplied ,nargs))
139           (locally
140             ;; KLUDGE: The intent here is to enable tail recursion
141             ;; optimization, since leaving frames for wrapper
142             ;; functions like this on the stack is actually more
143             ;; annoying than helpful for debugging. Unfortunately
144             ;; trying to express this by messing with the
145             ;; ANSI-standard declarations is a little awkward, since
146             ;; no matter how we do it we'll tend to have side-effects
147             ;; on things like SPEED-vs.-SAFETY comparisons. Perhaps
148             ;; it'd be better to define a new SB-EXT:TAIL-RECURSIVELY
149             ;; declaration and use that? -- WHN 2002-07-08
150             (declare (optimize (speed 2) (debug 1)))
151             (%funcall ,fun ,@temps)))))
152     (optional-dispatch
153      (let* ((min (optional-dispatch-min-args fun))
154             (max (optional-dispatch-max-args fun))
155             (more (optional-dispatch-more-entry fun))
156             (n-supplied (gensym))
157             (temps (make-gensym-list max)))
158        (collect ((entries))
159          (do ((eps (optional-dispatch-entry-points fun) (rest eps))
160               (n min (1+ n)))
161              ((null eps))
162            (entries `((= ,n-supplied ,n)
163                       (%funcall ,(first eps) ,@(subseq temps 0 n)))))
164          `(lambda (,n-supplied ,@temps)
165             ;; FIXME: Make sure that INDEX type distinguishes between
166             ;; target and host. (Probably just make the SB!XC:DEFTYPE
167             ;; different from CL:DEFTYPE.)
168             (declare (type index ,n-supplied))
169             (cond
170              ,@(if more (butlast (entries)) (entries))
171              ,@(when more
172                  `((,(if (zerop min) t `(>= ,n-supplied ,max))
173                     ,(let ((n-context (gensym))
174                            (n-count (gensym)))
175                        `(multiple-value-bind (,n-context ,n-count)
176                             (%more-arg-context ,n-supplied ,max)
177                           (locally
178                             ;; KLUDGE: As above, we're trying to
179                             ;; enable tail recursion optimization and
180                             ;; any other effects of this declaration
181                             ;; are accidental. -- WHN 2002-07-08
182                             (declare (optimize (speed 2) (debug 1)))
183                             (%funcall ,more ,@temps ,n-context ,n-count)))))))
184              (t
185               (%arg-count-error ,n-supplied)))))))))
186
187 ;;; Make an external entry point (XEP) for FUN and return it. We
188 ;;; convert the result of MAKE-XEP-LAMBDA in the correct environment,
189 ;;; then associate this lambda with FUN as its XEP. After the
190 ;;; conversion, we iterate over the function's associated lambdas,
191 ;;; redoing local call analysis so that the XEP calls will get
192 ;;; converted. 
193 ;;;
194 ;;; We set REANALYZE and REOPTIMIZE in the component, just in case we
195 ;;; discover an XEP after the initial local call analyze pass.
196 (defun make-xep (fun)
197   (declare (type functional fun))
198   (aver (null (functional-entry-fun fun)))
199   (with-ir1-environment-from-node (lambda-bind (main-entry fun))
200     (let ((res (ir1-convert-lambda (make-xep-lambda-expression fun)
201                                    :debug-name (debug-namify
202                                                 "XEP for ~A"
203                                                 (leaf-debug-name fun)))))
204       (setf (functional-kind res) :external
205             (leaf-ever-used res) t
206             (functional-entry-fun res) fun
207             (functional-entry-fun fun) res
208             (component-reanalyze *current-component*) t
209             (component-reoptimize *current-component*) t)
210       (etypecase fun
211         (clambda
212          (locall-analyze-fun-1 fun))
213         (optional-dispatch
214          (dolist (ep (optional-dispatch-entry-points fun))
215            (locall-analyze-fun-1 ep))
216          (when (optional-dispatch-more-entry fun)
217            (locall-analyze-fun-1 (optional-dispatch-more-entry fun)))))
218       res)))
219
220 ;;; Notice a REF that is not in a local-call context. If the REF is
221 ;;; already to an XEP, then do nothing, otherwise change it to the
222 ;;; XEP, making an XEP if necessary.
223 ;;;
224 ;;; If REF is to a special :CLEANUP or :ESCAPE function, then we treat
225 ;;; it as though it was not an XEP reference (i.e. leave it alone).
226 (defun reference-entry-point (ref)
227   (declare (type ref ref))
228   (let ((fun (ref-leaf ref)))
229     (unless (or (xep-p fun)
230                 (member (functional-kind fun) '(:escape :cleanup)))
231       (change-ref-leaf ref (or (functional-entry-fun fun)
232                                (make-xep fun))))))
233 \f
234 ;;; Attempt to convert all references to FUN to local calls. The
235 ;;; reference must be the function for a call, and the function
236 ;;; continuation must be used only once, since otherwise we cannot be
237 ;;; sure what function is to be called. The call continuation would be
238 ;;; multiply used if there is hairy stuff such as conditionals in the
239 ;;; expression that computes the function.
240 ;;;
241 ;;; If we cannot convert a reference, then we mark the referenced
242 ;;; function as an entry-point, creating a new XEP if necessary. We
243 ;;; don't try to convert calls that are in error (:ERROR kind.)
244 ;;;
245 ;;; This is broken off from LOCALL-ANALYZE-COMPONENT so that people
246 ;;; can force analysis of newly introduced calls. Note that we don't
247 ;;; do LET conversion here.
248 (defun locall-analyze-fun-1 (fun)
249   (declare (type functional fun))
250   (let ((refs (leaf-refs fun))
251         (first-time t))
252     (dolist (ref refs)
253       (let* ((cont (node-cont ref))
254              (dest (continuation-dest cont)))
255         (cond ((and (basic-combination-p dest)
256                     (eq (basic-combination-fun dest) cont)
257                     (eq (continuation-use cont) ref))
258
259                (convert-call-if-possible ref dest)
260
261                (unless (eq (basic-combination-kind dest) :local)
262                  (reference-entry-point ref)))
263               (t
264                (reference-entry-point ref))))
265       (setq first-time nil)))
266
267   (values))
268
269 ;;; We examine all NEW-FUNCTIONALS in COMPONENT, attempting to convert
270 ;;; calls into local calls when it is legal. We also attempt to
271 ;;; convert each LAMBDA to a LET. LET conversion is also triggered by
272 ;;; deletion of a function reference, but functions that start out
273 ;;; eligible for conversion must be noticed sometime.
274 ;;;
275 ;;; Note that there is a lot of action going on behind the scenes
276 ;;; here, triggered by reference deletion. In particular, the
277 ;;; COMPONENT-LAMBDAS are being hacked to remove newly deleted and LET
278 ;;; converted LAMBDAs, so it is important that the LAMBDA is added to
279 ;;; the COMPONENT-LAMBDAS when it is. Also, the
280 ;;; COMPONENT-NEW-FUNCTIONALS may contain all sorts of drivel, since
281 ;;; it is not updated when we delete functions, etc. Only
282 ;;; COMPONENT-LAMBDAS is updated.
283 ;;;
284 ;;; COMPONENT-REANALYZE-FUNCTIONALS is treated similarly to
285 ;;; COMPONENT-NEW-FUNCTIONALS, but we don't add lambdas to the
286 ;;; LAMBDAS.
287 (defun locall-analyze-component (component)
288   (declare (type component component))
289   (aver-live-component component)
290   (loop
291     (let* ((new-functional (pop (component-new-functionals component)))
292            (functional (or new-functional
293                            (pop (component-reanalyze-functionals component)))))
294       (unless functional
295         (return))
296       (let ((kind (functional-kind functional)))
297         (cond ((or (functional-somewhat-letlike-p functional)
298                    (eql kind :deleted))
299                (values)) ; nothing to do
300               ((and (null (leaf-refs functional)) (eq kind nil)
301                     (not (functional-entry-fun functional)))
302                (delete-functional functional))
303               (t
304                ;; Fix/check FUNCTIONAL's relationship to COMPONENT-LAMDBAS.
305                (cond ((not (lambda-p functional))
306                       ;; Since FUNCTIONAL isn't a LAMBDA, this doesn't
307                       ;; apply: no-op.
308                       (values))
309                      (new-functional ; FUNCTIONAL came from
310                                      ; NEW-FUNCTIONALS, hence is new.
311                       ;; FUNCTIONAL becomes part of COMPONENT-LAMBDAS now.
312                       (aver (not (member functional
313                                          (component-lambdas component))))
314                       (push functional (component-lambdas component)))
315                      (t ; FUNCTIONAL is old.
316                       ;; FUNCTIONAL should be in COMPONENT-LAMBDAS already.
317                       (aver (member functional (component-lambdas
318                                                 component)))))
319                (locall-analyze-fun-1 functional)
320                (when (lambda-p functional)
321                  (maybe-let-convert functional)))))))
322   (values))
323
324 (defun locall-analyze-clambdas-until-done (clambdas)
325   (loop
326    (let ((did-something nil))
327      (dolist (clambda clambdas)
328        (let* ((component (lambda-component clambda))
329               (*all-components* (list component)))
330          ;; The original CMU CL code seemed to implicitly assume that
331          ;; COMPONENT is the only one here. Let's make that explicit.
332          (aver (= 1 (length (functional-components clambda))))
333          (aver (eql component (first (functional-components clambda))))
334          (when (component-new-functionals component)
335            (setf did-something t)
336            (locall-analyze-component component))))
337      (unless did-something
338        (return))))
339   (values))
340
341 ;;; If policy is auspicious and CALL is not in an XEP and we don't seem
342 ;;; to be in an infinite recursive loop, then change the reference to
343 ;;; reference a fresh copy. We return whichever function we decide to
344 ;;; reference.
345 (defun maybe-expand-local-inline (original-functional ref call)
346   (if (and (policy call
347                    (and (>= speed space)
348                         (>= speed compilation-speed)))
349            (not (eq (functional-kind (node-home-lambda call)) :external))
350            (inline-expansion-ok call))
351       (multiple-value-bind (losing-local-functional converted-lambda)
352           (catch 'locall-already-let-converted
353             (with-ir1-environment-from-node call
354               (let ((*lexenv* (functional-lexenv original-functional)))
355                 (values nil
356                         (ir1-convert-lambda
357                          (functional-inline-expansion original-functional)
358                          :debug-name (debug-namify
359                                       "local inline ~A"
360                                       (leaf-debug-name
361                                        original-functional)))))))
362         (cond (losing-local-functional
363                (let ((*compiler-error-context* call))
364                  (compiler-note "couldn't inline expand because expansion ~
365                                  calls this LET-converted local function:~
366                                  ~%  ~S"
367                                 (leaf-debug-name losing-local-functional)))
368                original-functional)
369               (t
370                (change-ref-leaf ref converted-lambda)
371                converted-lambda)))
372       original-functional))
373
374 ;;; Dispatch to the appropriate function to attempt to convert a call.
375 ;;; REF must be a reference to a FUNCTIONAL. This is called in IR1
376 ;;; optimization as well as in local call analysis. If the call is is
377 ;;; already :LOCAL, we do nothing. If the call is already scheduled
378 ;;; for deletion, also do nothing (in addition to saving time, this
379 ;;; also avoids some problems with optimizing collections of functions
380 ;;; that are partially deleted.)
381 ;;;
382 ;;; This is called both before and after FIND-INITIAL-DFO runs. When
383 ;;; called on a :INITIAL component, we don't care whether the caller
384 ;;; and callee are in the same component. Afterward, we must stick
385 ;;; with whatever component division we have chosen.
386 ;;;
387 ;;; Before attempting to convert a call, we see whether the function
388 ;;; is supposed to be inline expanded. Call conversion proceeds as
389 ;;; before after any expansion.
390 ;;;
391 ;;; We bind *COMPILER-ERROR-CONTEXT* to the node for the call so that
392 ;;; warnings will get the right context.
393 (defun convert-call-if-possible (ref call)
394   (declare (type ref ref) (type basic-combination call))
395   (let* ((block (node-block call))
396          (component (block-component block))
397          (original-fun (ref-leaf ref)))
398     (aver (functional-p original-fun))
399     (unless (or (member (basic-combination-kind call) '(:local :error))
400                 (block-delete-p block)
401                 (eq (functional-kind (block-home-lambda block)) :deleted)
402                 (member (functional-kind original-fun)
403                         '(:toplevel-xep :deleted))
404                 (not (or (eq (component-kind component) :initial)
405                          (eq (block-component
406                               (node-block
407                                (lambda-bind (main-entry original-fun))))
408                              component))))
409       (let ((fun (if (xep-p original-fun)
410                      (functional-entry-fun original-fun)
411                      original-fun))
412             (*compiler-error-context* call))
413
414         (when (and (eq (functional-inlinep fun) :inline)
415                    (rest (leaf-refs original-fun)))
416           (setq fun (maybe-expand-local-inline fun ref call)))
417
418         (aver (member (functional-kind fun)
419                       '(nil :escape :cleanup :optional)))
420         (cond ((mv-combination-p call)
421                (convert-mv-call ref call fun))
422               ((lambda-p fun)
423                (convert-lambda-call ref call fun))
424               (t
425                (convert-hairy-call ref call fun))))))
426
427   (values))
428
429 ;;; Attempt to convert a multiple-value call. The only interesting
430 ;;; case is a call to a function that LOOKS-LIKE-AN-MV-BIND, has
431 ;;; exactly one reference and no XEP, and is called with one values
432 ;;; continuation.
433 ;;;
434 ;;; We change the call to be to the last optional entry point and
435 ;;; change the call to be local. Due to our preconditions, the call
436 ;;; should eventually be converted to a let, but we can't do that now,
437 ;;; since there may be stray references to the e-p lambda due to
438 ;;; optional defaulting code.
439 ;;;
440 ;;; We also use variable types for the called function to construct an
441 ;;; assertion for the values continuation.
442 ;;;
443 ;;; See CONVERT-CALL for additional notes on MERGE-TAIL-SETS, etc.
444 (defun convert-mv-call (ref call fun)
445   (declare (type ref ref) (type mv-combination call) (type functional fun))
446   (when (and (looks-like-an-mv-bind fun)
447              (not (functional-entry-fun fun))
448              (= (length (leaf-refs fun)) 1)
449              (= (length (basic-combination-args call)) 1))
450     (let ((ep (car (last (optional-dispatch-entry-points fun)))))
451       (setf (basic-combination-kind call) :local)
452       (pushnew ep (lambda-calls-or-closes (node-home-lambda call)))
453       (merge-tail-sets call ep)
454       (change-ref-leaf ref ep)
455
456       (assert-continuation-type
457        (first (basic-combination-args call))
458        (make-values-type :optional (mapcar #'leaf-type (lambda-vars ep))
459                          :rest *universal-type*))))
460   (values))
461
462 ;;; Attempt to convert a call to a lambda. If the number of args is
463 ;;; wrong, we give a warning and mark the call as :ERROR to remove it
464 ;;; from future consideration. If the argcount is O.K. then we just
465 ;;; convert it.
466 (defun convert-lambda-call (ref call fun)
467   (declare (type ref ref) (type combination call) (type clambda fun))
468   (let ((nargs (length (lambda-vars fun)))
469         (call-args (length (combination-args call))))
470     (cond ((= call-args nargs)
471            (convert-call ref call fun))
472           (t
473            ;; FIXME: ANSI requires in "3.2.5 Exceptional Situations in the
474            ;; Compiler" that calling a function with "the wrong number of
475            ;; arguments" be only a STYLE-ERROR. I think, though, that this
476            ;; should only apply when the number of arguments is inferred
477            ;; from a previous definition. If the number of arguments
478            ;; is DECLAIMed, surely calling with the wrong number is a
479            ;; real WARNING. As long as SBCL continues to use CMU CL's
480            ;; non-ANSI DEFUN-is-a-DECLAIM policy, we're in violation here,
481            ;; but as long as we continue to use that policy, that's the
482            ;; not our biggest problem.:-| When we fix that policy, this
483            ;; should come back into compliance. (So fix that policy!)
484            ;;   ..but..
485            ;; FIXME, continued: Except that section "3.2.2.3 Semantic
486            ;; Constraints" says that if it's within the same file, it's
487            ;; wrong. And we're in locall.lisp here, so it's probably
488            ;; (haven't checked this..) a call to something in the same
489            ;; file. So maybe it deserves a full warning anyway.
490            (compiler-warn
491             "function called with ~R argument~:P, but wants exactly ~R"
492             call-args nargs)
493            (setf (basic-combination-kind call) :error)))))
494 \f
495 ;;;; &OPTIONAL, &MORE and &KEYWORD calls
496
497 ;;; This is similar to CONVERT-LAMBDA-CALL, but deals with
498 ;;; OPTIONAL-DISPATCHes. If only fixed args are supplied, then convert
499 ;;; a call to the correct entry point. If &KEY args are supplied, then
500 ;;; dispatch to a subfunction. We don't convert calls to functions
501 ;;; that have a &MORE (or &REST) arg.
502 (defun convert-hairy-call (ref call fun)
503   (declare (type ref ref) (type combination call)
504            (type optional-dispatch fun))
505   (let ((min-args (optional-dispatch-min-args fun))
506         (max-args (optional-dispatch-max-args fun))
507         (call-args (length (combination-args call))))
508     (cond ((< call-args min-args)
509            ;; FIXME: See FIXME note at the previous
510            ;; wrong-number-of-arguments warnings in this file.
511            (compiler-warn
512             "function called with ~R argument~:P, but wants at least ~R"
513             call-args min-args)
514            (setf (basic-combination-kind call) :error))
515           ((<= call-args max-args)
516            (convert-call ref call
517                          (elt (optional-dispatch-entry-points fun)
518                               (- call-args min-args))))
519           ((optional-dispatch-more-entry fun)
520            (convert-more-call ref call fun))
521           (t
522            ;; FIXME: See FIXME note at the previous
523            ;; wrong-number-of-arguments warnings in this file.
524            (compiler-warn
525             "function called with ~R argument~:P, but wants at most ~R"
526             call-args max-args)
527            (setf (basic-combination-kind call) :error))))
528   (values))
529
530 ;;; This function is used to convert a call to an entry point when
531 ;;; complex transformations need to be done on the original arguments.
532 ;;; ENTRY is the entry point function that we are calling. VARS is a
533 ;;; list of variable names which are bound to the original call
534 ;;; arguments. IGNORES is the subset of VARS which are ignored. ARGS
535 ;;; is the list of arguments to the entry point function.
536 ;;;
537 ;;; In order to avoid gruesome graph grovelling, we introduce a new
538 ;;; function that rearranges the arguments and calls the entry point.
539 ;;; We analyze the new function and the entry point immediately so
540 ;;; that everything gets converted during the single pass.
541 (defun convert-hairy-fun-entry (ref call entry vars ignores args)
542   (declare (list vars ignores args) (type ref ref) (type combination call)
543            (type clambda entry))
544   (let ((new-fun
545          (with-ir1-environment-from-node call
546            (ir1-convert-lambda
547             `(lambda ,vars
548                (declare (ignorable . ,ignores))
549                (%funcall ,entry . ,args))
550             :debug-name (debug-namify "hairy function entry ~S"
551                                       (continuation-fun-name
552                                        (basic-combination-fun call)))))))
553     (convert-call ref call new-fun)
554     (dolist (ref (leaf-refs entry))
555       (convert-call-if-possible ref (continuation-dest (node-cont ref))))))
556
557 ;;; Use CONVERT-HAIRY-FUN-ENTRY to convert a &MORE-arg call to a known
558 ;;; function into a local call to the MAIN-ENTRY.
559 ;;;
560 ;;; First we verify that all keywords are constant and legal. If there
561 ;;; aren't, then we warn the user and don't attempt to convert the call.
562 ;;;
563 ;;; We massage the supplied &KEY arguments into the order expected
564 ;;; by the main entry. This is done by binding all the arguments to
565 ;;; the keyword call to variables in the introduced lambda, then
566 ;;; passing these values variables in the correct order when calling
567 ;;; the main entry. Unused arguments (such as the keywords themselves)
568 ;;; are discarded simply by not passing them along.
569 ;;;
570 ;;; If there is a &REST arg, then we bundle up the args and pass them
571 ;;; to LIST.
572 (defun convert-more-call (ref call fun)
573   (declare (type ref ref) (type combination call) (type optional-dispatch fun))
574   (let* ((max (optional-dispatch-max-args fun))
575          (arglist (optional-dispatch-arglist fun))
576          (args (combination-args call))
577          (more (nthcdr max args))
578          (flame (policy call (or (> speed inhibit-warnings)
579                                  (> space inhibit-warnings))))
580          (loser nil)
581          (temps (make-gensym-list max))
582          (more-temps (make-gensym-list (length more))))
583     (collect ((ignores)
584               (supplied)
585               (key-vars))
586
587       (dolist (var arglist)
588         (let ((info (lambda-var-arg-info var)))
589           (when info
590             (ecase (arg-info-kind info)
591               (:keyword
592                (key-vars var))
593               ((:rest :optional))
594               ((:more-context :more-count)
595                (compiler-warn "can't local-call functions with &MORE args")
596                (setf (basic-combination-kind call) :error)
597                (return-from convert-more-call))))))
598
599       (when (optional-dispatch-keyp fun)
600         (when (oddp (length more))
601           (compiler-warn "function called with odd number of ~
602                           arguments in keyword portion")
603
604           (setf (basic-combination-kind call) :error)
605           (return-from convert-more-call))
606
607         (do ((key more (cddr key))
608              (temp more-temps (cddr temp)))
609             ((null key))
610           (let ((cont (first key)))
611             (unless (constant-continuation-p cont)
612               (when flame
613                 (compiler-note "non-constant keyword in keyword call"))
614               (setf (basic-combination-kind call) :error)
615               (return-from convert-more-call))
616
617             (let ((name (continuation-value cont))
618                   (dummy (first temp))
619                   (val (second temp)))
620               (dolist (var (key-vars)
621                            (progn
622                              (ignores dummy val)
623                              (setq loser name)))
624                 (let ((info (lambda-var-arg-info var)))
625                   (when (eq (arg-info-key info) name)
626                     (ignores dummy)
627                     (supplied (cons var val))
628                     (return)))))))
629
630         (when (and loser (not (optional-dispatch-allowp fun)))
631           (compiler-warn "function called with unknown argument keyword ~S"
632                          loser)
633           (setf (basic-combination-kind call) :error)
634           (return-from convert-more-call)))
635
636       (collect ((call-args))
637         (do ((var arglist (cdr var))
638              (temp temps (cdr temp)))
639             (())
640           (let ((info (lambda-var-arg-info (car var))))
641             (if info
642                 (ecase (arg-info-kind info)
643                   (:optional
644                    (call-args (car temp))
645                    (when (arg-info-supplied-p info)
646                      (call-args t)))
647                   (:rest
648                    (call-args `(list ,@more-temps))
649                    (return))
650                   (:keyword
651                    (return)))
652                 (call-args (car temp)))))
653
654         (dolist (var (key-vars))
655           (let ((info (lambda-var-arg-info var))
656                 (temp (cdr (assoc var (supplied)))))
657             (if temp
658                 (call-args temp)
659                 (call-args (arg-info-default info)))
660             (when (arg-info-supplied-p info)
661               (call-args (not (null temp))))))
662
663         (convert-hairy-fun-entry ref call (optional-dispatch-main-entry fun)
664                                  (append temps more-temps)
665                                  (ignores) (call-args)))))
666
667   (values))
668 \f
669 ;;;; LET conversion
670 ;;;;
671 ;;;; Converting to a LET has differing significance to various parts
672 ;;;; of the compiler:
673 ;;;; -- The body of a LET is spliced in immediately after the
674 ;;;;    corresponding combination node, making the control transfer
675 ;;;;    explicit and allowing LETs to be mashed together into a single
676 ;;;;    block. The value of the LET is delivered directly to the
677 ;;;;    original continuation for the call, eliminating the need to
678 ;;;;    propagate information from the dummy result continuation.
679 ;;;; -- As far as IR1 optimization is concerned, it is interesting in
680 ;;;;    that there is only one expression that the variable can be bound
681 ;;;;    to, and this is easily substituted for.
682 ;;;; -- LETs are interesting to environment analysis and to the back
683 ;;;;    end because in most ways a LET can be considered to be "the
684 ;;;;    same function" as its home function.
685 ;;;; -- LET conversion has dynamic scope implications, since control
686 ;;;;    transfers within the same environment are local. In a local
687 ;;;;    control transfer, cleanup code must be emitted to remove
688 ;;;;    dynamic bindings that are no longer in effect.
689
690 ;;; Set up the control transfer to the called CLAMBDA. We split the
691 ;;; call block immediately after the call, and link the head of
692 ;;; CLAMBDA to the call block. The successor block after splitting
693 ;;; (where we return to) is returned.
694 ;;;
695 ;;; If the lambda is is a different component than the call, then we
696 ;;; call JOIN-COMPONENTS. This only happens in block compilation
697 ;;; before FIND-INITIAL-DFO.
698 (defun insert-let-body (clambda call)
699   (declare (type clambda clambda) (type basic-combination call))
700   (let* ((call-block (node-block call))
701          (bind-block (node-block (lambda-bind clambda)))
702          (component (block-component call-block)))
703     (aver-live-component component)
704     (let ((clambda-component (block-component bind-block)))
705       (unless (eq clambda-component component)
706         (aver (eq (component-kind component) :initial))
707         (join-components component clambda-component)))
708     (let ((*current-component* component))
709       (node-ends-block call))
710     ;; FIXME: Use DESTRUCTURING-BIND here, and grep for other 
711     ;; uses of '=.*length' which could also be converted to use
712     ;; DESTRUCTURING-BIND or PROPER-LIST-OF-LENGTH-P.
713     (aver (= (length (block-succ call-block)) 1))
714     (let ((next-block (first (block-succ call-block))))
715       (unlink-blocks call-block next-block)
716       (link-blocks call-block bind-block)
717       next-block)))
718
719 ;;; Remove CLAMBDA from the tail set of anything it used to be in the
720 ;;; same set as; but leave CLAMBDA with a valid tail set value of
721 ;;; its own, for the benefit of code which might try to pull
722 ;;; something out of it (e.g. return type).
723 (defun depart-from-tail-set (clambda)
724   ;; Until sbcl-0.pre7.37.flaky5.2, we did
725   ;;   (LET ((TAILS (LAMBDA-TAIL-SET CLAMBDA)))
726   ;;     (SETF (TAIL-SET-FUNS TAILS)
727   ;;           (DELETE CLAMBDA (TAIL-SET-FUNS TAILS))))
728   ;;   (SETF (LAMBDA-TAIL-SET CLAMBDA) NIL)
729   ;; here. Apparently the idea behind the (SETF .. NIL) was that since
730   ;; TAIL-SET-FUNS no longer thinks we're in the tail set, it's
731   ;; inconsistent, and perhaps unsafe, for us to think we're in the
732   ;; tail set. Unfortunately..
733   ;;
734   ;; The (SETF .. NIL) caused problems in sbcl-0.pre7.37.flaky5.2 when
735   ;; I was trying to get Python to emit :EXTERNAL LAMBDAs directly
736   ;; (instead of only being able to emit funny little :TOPLEVEL stubs
737   ;; which you called in order to get the address of an external LAMBDA):
738   ;; the external function was defined in terms of internal function,
739   ;; which was LET-converted, and then things blew up downstream when
740   ;; FINALIZE-XEP-DEFINITION tried to find out its DEFINED-TYPE from
741   ;; the now-NILed-out TAIL-SET. So..
742   ;;
743   ;; To deal with this problem, we no longer NIL out 
744   ;; (LAMBDA-TAIL-SET CLAMBDA) here. Instead:
745   ;;   * If we're the only function in TAIL-SET-FUNS, it should
746   ;;     be safe to leave ourself linked to it, and it to you.
747   ;;   * If there are other functions in TAIL-SET-FUNS, then we're
748   ;;     afraid of future optimizations on those functions causing
749   ;;     the TAIL-SET object no longer to be valid to describe our
750   ;;     return value. Thus, we delete ourselves from that object;
751   ;;     but we save a newly-allocated tail-set, derived from the old
752   ;;     one, for ourselves, for the use of later code (e.g.
753   ;;     FINALIZE-XEP-DEFINITION) which might want to
754   ;;     know about our return type.
755   (let* ((old-tail-set (lambda-tail-set clambda))
756          (old-tail-set-funs (tail-set-funs old-tail-set)))
757     (unless (= 1 (length old-tail-set-funs))
758       (setf (tail-set-funs old-tail-set)
759             (delete clambda old-tail-set-funs))
760       (let ((new-tail-set (copy-tail-set old-tail-set)))
761         (setf (lambda-tail-set clambda) new-tail-set
762               (tail-set-funs new-tail-set) (list clambda)))))
763   ;; The documentation on TAIL-SET-INFO doesn't tell whether it could
764   ;; remain valid in this case, so we nuke it on the theory that
765   ;; missing information tends to be less dangerous than incorrect
766   ;; information.
767   (setf (tail-set-info (lambda-tail-set clambda)) nil))
768
769 ;;; Handle the environment semantics of LET conversion. We add CLAMBDA
770 ;;; and its LETs to LETs for the CALL's home function. We merge the
771 ;;; calls for CLAMBDA with the calls for the home function, removing
772 ;;; CLAMBDA in the process. We also merge the ENTRIES.
773 ;;;
774 ;;; We also unlink the function head from the component head and set
775 ;;; COMPONENT-REANALYZE to true to indicate that the DFO should be
776 ;;; recomputed.
777 (defun merge-lets (clambda call)
778
779   (declare (type clambda clambda) (type basic-combination call))
780
781   (let ((component (node-component call)))
782     (unlink-blocks (component-head component) (lambda-block clambda))
783     (setf (component-lambdas component)
784           (delete clambda (component-lambdas component)))
785     (setf (component-reanalyze component) t))
786   (setf (lambda-call-lexenv clambda) (node-lexenv call))
787
788   (depart-from-tail-set clambda)
789
790   (let* ((home (node-home-lambda call))
791          (home-env (lambda-physenv home)))
792
793     (aver (not (eq home clambda)))
794
795     ;; CLAMBDA belongs to HOME now.
796     (push clambda (lambda-lets home))
797     (setf (lambda-home clambda) home)
798     (setf (lambda-physenv clambda) home-env)
799
800     ;; All of CLAMBDA's LETs belong to HOME now.
801     (let ((lets (lambda-lets clambda)))
802       (dolist (let lets)
803         (setf (lambda-home let) home)
804         (setf (lambda-physenv let) home-env))
805       (setf (lambda-lets home) (nconc lets (lambda-lets home))))
806     ;; CLAMBDA no longer has an independent existence as an entity
807     ;; which has LETs.
808     (setf (lambda-lets clambda) nil)
809
810     ;; HOME no longer calls CLAMBDA, and owns all of CLAMBDA's old
811     ;; DFO dependencies.
812     (setf (lambda-calls-or-closes home)
813           (delete clambda
814                   (nunion (lambda-calls-or-closes clambda)
815                           (lambda-calls-or-closes home))))
816     ;; CLAMBDA no longer has an independent existence as an entity
817     ;; which calls things or has DFO dependencies.
818     (setf (lambda-calls-or-closes clambda) nil)
819
820     ;; All of CLAMBDA's ENTRIES belong to HOME now.
821     (setf (lambda-entries home)
822           (nconc (lambda-entries clambda)
823                  (lambda-entries home)))
824     ;; CLAMBDA no longer has an independent existence as an entity
825     ;; with ENTRIES.
826     (setf (lambda-entries clambda) nil))
827
828   (values))
829
830 ;;; Handle the value semantics of LET conversion. Delete FUN's return
831 ;;; node, and change the control flow to transfer to NEXT-BLOCK
832 ;;; instead. Move all the uses of the result continuation to CALL's
833 ;;; CONT.
834 ;;;
835 ;;; If the actual continuation is only used by the LET call, then we
836 ;;; intersect the type assertion on the dummy continuation with the
837 ;;; assertion for the actual continuation; in all other cases
838 ;;; assertions on the dummy continuation are lost.
839 ;;;
840 ;;; We also intersect the derived type of the CALL with the derived
841 ;;; type of all the dummy continuation's uses. This serves mainly to
842 ;;; propagate TRULY-THE through LETs.
843 (defun move-return-uses (fun call next-block)
844   (declare (type clambda fun) (type basic-combination call)
845            (type cblock next-block))
846   (let* ((return (lambda-return fun))
847          (return-block (node-block return)))
848     (unlink-blocks return-block
849                    (component-tail (block-component return-block)))
850     (link-blocks return-block next-block)
851     (unlink-node return)
852     (delete-return return)
853     (let ((result (return-result return))
854           (cont (node-cont call))
855           (call-type (node-derived-type call)))
856       (when (eq (continuation-use cont) call)
857         (assert-continuation-type cont (continuation-asserted-type result)))
858       (unless (eq call-type *wild-type*)
859         (do-uses (use result)
860           (derive-node-type use call-type)))
861       (substitute-continuation-uses cont result)))
862   (values))
863
864 ;;; Change all CONT for all the calls to FUN to be the start
865 ;;; continuation for the bind node. This allows the blocks to be
866 ;;; joined if the caller count ever goes to one.
867 (defun move-let-call-cont (fun)
868   (declare (type clambda fun))
869   (let ((new-cont (node-prev (lambda-bind fun))))
870     (dolist (ref (leaf-refs fun))
871       (let ((dest (continuation-dest (node-cont ref))))
872         (delete-continuation-use dest)
873         (add-continuation-use dest new-cont))))
874   (values))
875
876 ;;; We are converting FUN to be a LET when the call is in a non-tail
877 ;;; position. Any previously tail calls in FUN are no longer tail
878 ;;; calls, and must be restored to normal calls which transfer to
879 ;;; NEXT-BLOCK (FUN's return point.) We can't do this by DO-USES on
880 ;;; the RETURN-RESULT, because the return might have been deleted (if
881 ;;; all calls were TR.)
882 (defun unconvert-tail-calls (fun call next-block)
883   (dolist (called (lambda-calls-or-closes fun))
884     (when (lambda-p called)
885       (dolist (ref (leaf-refs called))
886         (let ((this-call (continuation-dest (node-cont ref))))
887           (when (and this-call
888                      (node-tail-p this-call)
889                      (eq (node-home-lambda this-call) fun))
890             (setf (node-tail-p this-call) nil)
891             (ecase (functional-kind called)
892               ((nil :cleanup :optional)
893                (let ((block (node-block this-call))
894                      (cont (node-cont call)))
895                  (ensure-block-start cont)
896                  (unlink-blocks block (first (block-succ block)))
897                  (link-blocks block next-block)
898                  (delete-continuation-use this-call)
899                  (add-continuation-use this-call cont)))
900               (:deleted)
901               ;; The called function might be an assignment in the
902               ;; case where we are currently converting that function.
903               ;; In steady-state, assignments never appear as a called
904               ;; function.
905               (:assignment
906                (aver (eq called fun)))))))))
907   (values))
908
909 ;;; Deal with returning from a LET or assignment that we are
910 ;;; converting. FUN is the function we are calling, CALL is a call to
911 ;;; FUN, and NEXT-BLOCK is the return point for a non-tail call, or
912 ;;; NULL if call is a tail call.
913 ;;;
914 ;;; If the call is not a tail call, then we must do
915 ;;; UNCONVERT-TAIL-CALLS, since a tail call is a call which returns
916 ;;; its value out of the enclosing non-let function. When call is
917 ;;; non-TR, we must convert it back to an ordinary local call, since
918 ;;; the value must be delivered to the receiver of CALL's value.
919 ;;;
920 ;;; We do different things depending on whether the caller and callee
921 ;;; have returns left:
922
923 ;;; -- If the callee has no return we just do MOVE-LET-CALL-CONT.
924 ;;;    Either the function doesn't return, or all returns are via
925 ;;;    tail-recursive local calls.
926 ;;; -- If CALL is a non-tail call, or if both have returns, then
927 ;;;    we delete the callee's return, move its uses to the call's
928 ;;;    result continuation, and transfer control to the appropriate
929 ;;;    return point.
930 ;;; -- If the callee has a return, but the caller doesn't, then we
931 ;;;    move the return to the caller.
932 (defun move-return-stuff (fun call next-block)
933   (declare (type clambda fun) (type basic-combination call)
934            (type (or cblock null) next-block))
935   (when next-block
936     (unconvert-tail-calls fun call next-block))
937   (let* ((return (lambda-return fun))
938          (call-fun (node-home-lambda call))
939          (call-return (lambda-return call-fun)))
940     (cond ((not return))
941           ((or next-block call-return)
942            (unless (block-delete-p (node-block return))
943              (move-return-uses fun call
944                                (or next-block (node-block call-return)))))
945           (t
946            (aver (node-tail-p call))
947            (setf (lambda-return call-fun) return)
948            (setf (return-lambda return) call-fun))))
949   (move-let-call-cont fun)
950   (values))
951
952 ;;; Actually do LET conversion. We call subfunctions to do most of the
953 ;;; work. We change the CALL's CONT to be the continuation heading the
954 ;;; BIND block, and also do REOPTIMIZE-CONTINUATION on the args and
955 ;;; CONT so that LET-specific IR1 optimizations get a chance. We blow
956 ;;; away any entry for the function in *FREE-FUNS* so that nobody
957 ;;; will create new references to it.
958 (defun let-convert (fun call)
959   (declare (type clambda fun) (type basic-combination call))
960   (let ((next-block (if (node-tail-p call)
961                         nil
962                         (insert-let-body fun call))))
963     (move-return-stuff fun call next-block)
964     (merge-lets fun call)))
965
966 ;;; Reoptimize all of CALL's args and its result.
967 (defun reoptimize-call (call)
968   (declare (type basic-combination call))
969   (dolist (arg (basic-combination-args call))
970     (when arg
971       (reoptimize-continuation arg)))
972   (reoptimize-continuation (node-cont call))
973   (values))
974
975 ;;; Are there any declarations in force to say CLAMBDA shouldn't be
976 ;;; LET converted?
977 (defun declarations-suppress-let-conversion-p (clambda)
978   ;; From the user's point of view, LET-converting something that
979   ;; has a name is inlining it. (The user can't see what we're doing
980   ;; with anonymous things, and suppressing inlining
981   ;; for such things can easily give Python acute indigestion, so 
982   ;; we don't.)
983   (when (leaf-has-source-name-p clambda)
984     ;; ANSI requires that explicit NOTINLINE be respected.
985     (or (eq (lambda-inlinep clambda) :notinline)
986         ;; If (> DEBUG SPEED) we can guess that inlining generally
987         ;; won't be appreciated, but if the user specifically requests
988         ;; inlining, that takes precedence over our general guess.
989         (and (policy clambda (> debug speed))
990              (not (eq (lambda-inlinep clambda) :inline))))))
991
992 ;;; We also don't convert calls to named functions which appear in the
993 ;;; initial component, delaying this until optimization. This
994 ;;; minimizes the likelihood that we will LET-convert a function which
995 ;;; may have references added due to later local inline expansion.
996 (defun ok-initial-convert-p (fun)
997   (not (and (leaf-has-source-name-p fun)
998             (or (declarations-suppress-let-conversion-p fun)
999                 (eq (component-kind (lambda-component fun))
1000                     :initial)))))
1001
1002 ;;; This function is called when there is some reason to believe that
1003 ;;; CLAMBDA might be converted into a LET. This is done after local
1004 ;;; call analysis, and also when a reference is deleted. We return
1005 ;;; true if we converted.
1006 (defun maybe-let-convert (clambda)
1007   (declare (type clambda clambda))
1008   (unless (declarations-suppress-let-conversion-p clambda)
1009     ;; We only convert to a LET when the function is a normal local
1010     ;; function, has no XEP, and is referenced in exactly one local
1011     ;; call. Conversion is also inhibited if the only reference is in
1012     ;; a block about to be deleted.
1013     ;;
1014     ;; These rules limiting LET conversion may seem unnecessarily
1015     ;; restrictive, since there are some cases where we could do the
1016     ;; return with a jump that don't satisfy these requirements. The
1017     ;; reason for doing things this way is that it makes the concept
1018     ;; of a LET much more useful at the level of IR1 semantics. The
1019     ;; :ASSIGNMENT function kind provides another way to optimize
1020     ;; calls to single-return/multiple call functions.
1021     ;;
1022     ;; We don't attempt to convert calls to functions that have an
1023     ;; XEP, since we might be embarrassed later when we want to
1024     ;; convert a newly discovered local call. Also, see
1025     ;; OK-INITIAL-CONVERT-P.
1026     (let ((refs (leaf-refs clambda)))
1027       (when (and refs
1028                  (null (rest refs))
1029                  (member (functional-kind clambda) '(nil :assignment))
1030                  (not (functional-entry-fun clambda)))
1031         (let* ((ref (first refs))
1032                (ref-cont (node-cont ref))
1033                (dest (continuation-dest ref-cont)))
1034           (when (and dest
1035                      (basic-combination-p dest)
1036                      (eq (basic-combination-fun dest) ref-cont)
1037                      (eq (basic-combination-kind dest) :local)
1038                      (not (block-delete-p (node-block dest)))
1039                      (cond ((ok-initial-convert-p clambda) t)
1040                            (t
1041                             (reoptimize-continuation ref-cont)
1042                             nil)))
1043             (when (eq clambda (node-home-lambda dest))
1044               (delete-lambda clambda)
1045               (return-from maybe-let-convert nil))
1046             (unless (eq (functional-kind clambda) :assignment)
1047               (let-convert clambda dest))
1048             (reoptimize-call dest)
1049             (setf (functional-kind clambda)
1050                   (if (mv-combination-p dest) :mv-let :let))))
1051         t))))
1052 \f
1053 ;;;; tail local calls and assignments
1054
1055 ;;; Return T if there are no cleanups between BLOCK1 and BLOCK2, or if
1056 ;;; they definitely won't generate any cleanup code. Currently we
1057 ;;; recognize lexical entry points that are only used locally (if at
1058 ;;; all).
1059 (defun only-harmless-cleanups (block1 block2)
1060   (declare (type cblock block1 block2))
1061   (or (eq block1 block2)
1062       (let ((cleanup2 (block-start-cleanup block2)))
1063         (do ((cleanup (block-end-cleanup block1)
1064                       (node-enclosing-cleanup (cleanup-mess-up cleanup))))
1065             ((eq cleanup cleanup2) t)
1066           (case (cleanup-kind cleanup)
1067             ((:block :tagbody)
1068              (unless (null (entry-exits (cleanup-mess-up cleanup)))
1069                (return nil)))
1070             (t (return nil)))))))
1071
1072 ;;; If a potentially TR local call really is TR, then convert it to
1073 ;;; jump directly to the called function. We also call
1074 ;;; MAYBE-CONVERT-TO-ASSIGNMENT. The first value is true if we
1075 ;;; tail-convert. The second is the value of M-C-T-A. We can switch
1076 ;;; the succesor (potentially deleting the RETURN node) unless:
1077 ;;; -- The call has already been converted.
1078 ;;; -- The call isn't TR (some implicit MV PROG1.)
1079 ;;; -- The call is in an XEP (thus we might decide to make it non-tail 
1080 ;;;    so that we can use known return inside the component.)
1081 ;;; -- There is a change in the cleanup between the call in the return, 
1082 ;;;    so we might need to introduce cleanup code.
1083 (defun maybe-convert-tail-local-call (call)
1084   (declare (type combination call))
1085   (let ((return (continuation-dest (node-cont call))))
1086     (aver (return-p return))
1087     (when (and (not (node-tail-p call))
1088                (immediately-used-p (return-result return) call)
1089                (not (eq (functional-kind (node-home-lambda call))
1090                         :external))
1091                (only-harmless-cleanups (node-block call)
1092                                        (node-block return)))
1093       (node-ends-block call)
1094       (let ((block (node-block call))
1095             (fun (combination-lambda call)))
1096         (setf (node-tail-p call) t)
1097         (unlink-blocks block (first (block-succ block)))
1098         (link-blocks block (lambda-block fun))
1099         (values t (maybe-convert-to-assignment fun))))))
1100
1101 ;;; This is called when we believe it might make sense to convert
1102 ;;; CLAMBDA to an assignment. All this function really does is
1103 ;;; determine when a function with more than one call can still be
1104 ;;; combined with the calling function's environment. We can convert
1105 ;;; when:
1106 ;;; -- The function is a normal, non-entry function, and
1107 ;;; -- Except for one call, all calls must be tail recursive calls 
1108 ;;;    in the called function (i.e. are self-recursive tail calls)
1109 ;;; -- OK-INITIAL-CONVERT-P is true.
1110 ;;;
1111 ;;; There may be one outside call, and it need not be tail-recursive.
1112 ;;; Since all tail local calls have already been converted to direct
1113 ;;; transfers, the only control semantics needed are to splice in the
1114 ;;; body at the non-tail call. If there is no non-tail call, then we
1115 ;;; need only merge the environments. Both cases are handled by
1116 ;;; LET-CONVERT.
1117 ;;;
1118 ;;; ### It would actually be possible to allow any number of outside
1119 ;;; calls as long as they all return to the same place (i.e. have the
1120 ;;; same conceptual continuation.) A special case of this would be
1121 ;;; when all of the outside calls are tail recursive.
1122 (defun maybe-convert-to-assignment (clambda)
1123   (declare (type clambda clambda))
1124   (when (and (not (functional-kind clambda))
1125              (not (functional-entry-fun clambda)))
1126     (let ((outside-non-tail-call nil)
1127           (outside-call nil))
1128       (when (and (dolist (ref (leaf-refs clambda) t)
1129                    (let ((dest (continuation-dest (node-cont ref))))
1130                      (when (or (not dest)
1131                                (block-delete-p (node-block dest)))
1132                        (return nil))
1133                      (let ((home (node-home-lambda ref)))
1134                        (unless (eq home clambda)
1135                          (when outside-call
1136                            (return nil))
1137                          (setq outside-call dest))
1138                        (unless (node-tail-p dest)
1139                          (when (or outside-non-tail-call (eq home clambda))
1140                            (return nil))
1141                          (setq outside-non-tail-call dest)))))
1142                  (ok-initial-convert-p clambda))
1143         (cond (outside-call (setf (functional-kind clambda) :assignment)
1144                             (let-convert clambda outside-call)
1145                             (when outside-non-tail-call
1146                               (reoptimize-call outside-non-tail-call))
1147                             t)
1148               (t (delete-lambda clambda)
1149                  nil))))))