1.0.17.24: refactor handling of constants in the compiler
[sbcl.git] / src / compiler / ir1-translators.lisp
1 ;;;; the usual place for DEF-IR1-TRANSLATOR forms (and their
2 ;;;; close personal friends)
3
4 ;;;; This software is part of the SBCL system. See the README file for
5 ;;;; more information.
6 ;;;;
7 ;;;; This software is derived from the CMU CL system, which was
8 ;;;; written at Carnegie Mellon University and released into the
9 ;;;; public domain. The software is in the public domain and is
10 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
11 ;;;; files for more information.
12
13 (in-package "SB!C")
14 \f
15 ;;;; special forms for control
16
17 (def-ir1-translator progn ((&rest forms) start next result)
18   #!+sb-doc
19   "PROGN form*
20
21 Evaluates each FORM in order, returning the values of the last form. With no
22 forms, returns NIL."
23   (ir1-convert-progn-body start next result forms))
24
25 (def-ir1-translator if ((test then &optional else) start next result)
26   #!+sb-doc
27   "IF predicate then [else]
28
29 If PREDICATE evaluates to false, evaluate THEN and return its values,
30 otherwise evaluate ELSE and return its values. ELSE defaults to NIL."
31   (let* ((pred-ctran (make-ctran))
32          (pred-lvar (make-lvar))
33          (then-ctran (make-ctran))
34          (then-block (ctran-starts-block then-ctran))
35          (else-ctran (make-ctran))
36          (else-block (ctran-starts-block else-ctran))
37          (maybe-instrument *instrument-if-for-code-coverage*)
38          (*instrument-if-for-code-coverage* t)
39          (node (make-if :test pred-lvar
40                         :consequent then-block
41                         :alternative else-block)))
42     ;; IR1-CONVERT-MAYBE-PREDICATE requires DEST to be CIF, so the
43     ;; order of the following two forms is important
44     (setf (lvar-dest pred-lvar) node)
45     (ir1-convert start pred-ctran pred-lvar test)
46     (link-node-to-previous-ctran node pred-ctran)
47
48     (let ((start-block (ctran-block pred-ctran)))
49       (setf (block-last start-block) node)
50       (ctran-starts-block next)
51
52       (link-blocks start-block then-block)
53       (link-blocks start-block else-block))
54
55     (let ((path (best-sub-source-path test)))
56       (ir1-convert (if (and path maybe-instrument)
57                        (let ((*current-path* path))
58                          (instrument-coverage then-ctran :then test))
59                        then-ctran)
60                    next result then)
61       (ir1-convert (if (and path maybe-instrument)
62                        (let ((*current-path* path))
63                          (instrument-coverage else-ctran :else test))
64                        else-ctran)
65                    next result else))))
66
67 ;;; To get even remotely sensible results for branch coverage
68 ;;; tracking, we need good source paths. If the macroexpansions
69 ;;; interfere enough the TEST of the conditional doesn't actually have
70 ;;; an original source location (e.g. (UNLESS FOO ...) -> (IF (NOT
71 ;;; FOO) ...). Look through the form, and try to find some subform
72 ;;; that has one.
73 (defun best-sub-source-path (form)
74   (if (policy *lexenv* (= store-coverage-data 0))
75       nil
76       (labels ((sub (form)
77                  (or (get-source-path form)
78                      (and (consp form)
79                           (some #'sub form)))))
80         (or (sub form)))))
81 \f
82 ;;;; BLOCK and TAGBODY
83
84 ;;;; We make an ENTRY node to mark the start and a :ENTRY cleanup to
85 ;;;; mark its extent. When doing GO or RETURN-FROM, we emit an EXIT
86 ;;;; node.
87
88 ;;; Make a :ENTRY cleanup and emit an ENTRY node, then convert the
89 ;;; body in the modified environment. We make NEXT start a block now,
90 ;;; since if it was done later, the block would be in the wrong
91 ;;; environment.
92 (def-ir1-translator block ((name &rest forms) start next result)
93   #!+sb-doc
94   "BLOCK name form*
95
96 Evaluate the FORMS as a PROGN. Within the lexical scope of the body,
97 RETURN-FROM can be used to exit the form."
98   (unless (symbolp name)
99     (compiler-error "The block name ~S is not a symbol." name))
100   (start-block start)
101   (ctran-starts-block next)
102   (let* ((dummy (make-ctran))
103          (entry (make-entry))
104          (cleanup (make-cleanup :kind :block
105                                 :mess-up entry)))
106     (push entry (lambda-entries (lexenv-lambda *lexenv*)))
107     (setf (entry-cleanup entry) cleanup)
108     (link-node-to-previous-ctran entry start)
109     (use-ctran entry dummy)
110
111     (let* ((env-entry (list entry next result))
112            (*lexenv* (make-lexenv :blocks (list (cons name env-entry))
113                                   :cleanup cleanup)))
114       (ir1-convert-progn-body dummy next result forms))))
115
116 (def-ir1-translator return-from ((name &optional value) start next result)
117   #!+sb-doc
118   "RETURN-FROM block-name value-form
119
120 Evaluate the VALUE-FORM, returning its values from the lexically enclosing
121 block BLOCK-NAME. This is constrained to be used only within the dynamic
122 extent of the block."
123   ;; old comment:
124   ;;   We make NEXT start a block just so that it will have a block
125   ;;   assigned. People assume that when they pass a ctran into
126   ;;   IR1-CONVERT as NEXT, it will have a block when it is done.
127   ;; KLUDGE: Note that this block is basically fictitious. In the code
128   ;;   (BLOCK B (RETURN-FROM B) (SETQ X 3))
129   ;; it's the block which answers the question "which block is
130   ;; the (SETQ X 3) in?" when the right answer is that (SETQ X 3) is
131   ;; dead code and so doesn't really have a block at all. The existence
132   ;; of this block, and that way that it doesn't explicitly say
133   ;; "I'm actually nowhere at all" makes some logic (e.g.
134   ;; BLOCK-HOME-LAMBDA-OR-NULL) more obscure, and it might be better
135   ;; to get rid of it, perhaps using a special placeholder value
136   ;; to indicate the orphanedness of the code.
137   (declare (ignore result))
138   (ctran-starts-block next)
139   (let* ((found (or (lexenv-find name blocks)
140                     (compiler-error "return for unknown block: ~S" name)))
141          (exit-ctran (second found))
142          (value-ctran (make-ctran))
143          (value-lvar (make-lvar))
144          (entry (first found))
145          (exit (make-exit :entry entry
146                           :value value-lvar)))
147     (when (ctran-deleted-p exit-ctran)
148       (throw 'locall-already-let-converted exit-ctran))
149     (push exit (entry-exits entry))
150     (setf (lvar-dest value-lvar) exit)
151     (ir1-convert start value-ctran value-lvar value)
152     (link-node-to-previous-ctran exit value-ctran)
153     (let ((home-lambda (ctran-home-lambda-or-null start)))
154       (when home-lambda
155         (sset-adjoin entry (lambda-calls-or-closes home-lambda))))
156     (use-continuation exit exit-ctran (third found))))
157
158 ;;; Return a list of the segments of a TAGBODY. Each segment looks
159 ;;; like (<tag> <form>* (go <next tag>)). That is, we break up the
160 ;;; tagbody into segments of non-tag statements, and explicitly
161 ;;; represent the drop-through with a GO. The first segment has a
162 ;;; dummy NIL tag, since it represents code before the first tag. Note
163 ;;; however that NIL may appear as the tag of an inner segment. The
164 ;;; last segment (which may also be the first segment) ends in NIL
165 ;;; rather than a GO.
166 (defun parse-tagbody (body)
167   (declare (list body))
168   (collect ((tags)
169             (segments))
170     (let ((current body))
171       (loop
172        (let ((next-segment (member-if #'atom current)))
173          (unless next-segment
174            (segments `(,@current nil))
175            (return))
176          (let ((tag (car next-segment)))
177            (when (member tag (tags))
178              (compiler-error
179               "The tag ~S appears more than once in a tagbody."
180               tag))
181            (unless (or (symbolp tag) (integerp tag))
182              (compiler-error "~S is not a legal go tag." tag))
183            (tags tag)
184            (segments `(,@(ldiff current next-segment) (go ,tag))))
185          (setq current (rest next-segment))))
186       (mapcar #'cons (cons nil (tags)) (segments)))))
187
188 ;;; Set up the cleanup, emitting the entry node. Then make a block for
189 ;;; each tag, building up the tag list for LEXENV-TAGS as we go.
190 ;;; Finally, convert each segment with the precomputed Start and Cont
191 ;;; values.
192 (def-ir1-translator tagbody ((&rest statements) start next result)
193   #!+sb-doc
194   "TAGBODY {tag | statement}*
195
196 Define tags for use with GO. The STATEMENTS are evaluated in order ,skipping
197 TAGS, and NIL is returned. If a statement contains a GO to a defined TAG
198 within the lexical scope of the form, then control is transferred to the next
199 statement following that tag. A TAG must an integer or a symbol. A STATEMENT
200 must be a list. Other objects are illegal within the body."
201   (start-block start)
202   (ctran-starts-block next)
203   (let* ((dummy (make-ctran))
204          (entry (make-entry))
205          (segments (parse-tagbody statements))
206          (cleanup (make-cleanup :kind :tagbody
207                                 :mess-up entry)))
208     (push entry (lambda-entries (lexenv-lambda *lexenv*)))
209     (setf (entry-cleanup entry) cleanup)
210     (link-node-to-previous-ctran entry start)
211     (use-ctran entry dummy)
212
213     (collect ((tags)
214               (starts)
215               (ctrans))
216       (starts dummy)
217       (dolist (segment (rest segments))
218         (let* ((tag-ctran (make-ctran))
219                (tag (list (car segment) entry tag-ctran)))
220           (ctrans tag-ctran)
221           (starts tag-ctran)
222           (ctran-starts-block tag-ctran)
223           (tags tag)))
224       (ctrans next)
225
226       (let ((*lexenv* (make-lexenv :cleanup cleanup :tags (tags))))
227         (mapc (lambda (segment start end)
228                 (ir1-convert-progn-body start end
229                                         (when (eq end next) result)
230                                         (rest segment)))
231               segments (starts) (ctrans))))))
232
233 ;;; Emit an EXIT node without any value.
234 (def-ir1-translator go ((tag) start next result)
235   #!+sb-doc
236   "GO tag
237
238 Transfer control to the named TAG in the lexically enclosing TAGBODY. This is
239 constrained to be used only within the dynamic extent of the TAGBODY."
240   (ctran-starts-block next)
241   (let* ((found (or (lexenv-find tag tags :test #'eql)
242                     (compiler-error "attempt to GO to nonexistent tag: ~S"
243                                     tag)))
244          (entry (first found))
245          (exit (make-exit :entry entry)))
246     (push exit (entry-exits entry))
247     (link-node-to-previous-ctran exit start)
248     (let ((home-lambda (ctran-home-lambda-or-null start)))
249       (when home-lambda
250         (sset-adjoin entry (lambda-calls-or-closes home-lambda))))
251     (use-ctran exit (second found))))
252 \f
253 ;;;; translators for compiler-magic special forms
254
255 ;;; This handles EVAL-WHEN in non-top-level forms. (EVAL-WHENs in top
256 ;;; level forms are picked off and handled by PROCESS-TOPLEVEL-FORM,
257 ;;; so that they're never seen at this level.)
258 ;;;
259 ;;; ANSI "3.2.3.1 Processing of Top Level Forms" says that processing
260 ;;; of non-top-level EVAL-WHENs is very simple:
261 ;;;   EVAL-WHEN forms cause compile-time evaluation only at top level.
262 ;;;   Both :COMPILE-TOPLEVEL and :LOAD-TOPLEVEL situation specifications
263 ;;;   are ignored for non-top-level forms. For non-top-level forms, an
264 ;;;   eval-when specifying the :EXECUTE situation is treated as an
265 ;;;   implicit PROGN including the forms in the body of the EVAL-WHEN
266 ;;;   form; otherwise, the forms in the body are ignored.
267 (def-ir1-translator eval-when ((situations &rest forms) start next result)
268   #!+sb-doc
269   "EVAL-WHEN (situation*) form*
270
271 Evaluate the FORMS in the specified SITUATIONS (any of :COMPILE-TOPLEVEL,
272 :LOAD-TOPLEVEL, or :EXECUTE, or (deprecated) COMPILE, LOAD, or EVAL)."
273   (multiple-value-bind (ct lt e) (parse-eval-when-situations situations)
274     (declare (ignore ct lt))
275     (ir1-convert-progn-body start next result (and e forms)))
276   (values))
277
278 ;;; common logic for MACROLET and SYMBOL-MACROLET
279 ;;;
280 ;;; Call DEFINITIONIZE-FUN on each element of DEFINITIONS to find its
281 ;;; in-lexenv representation, stuff the results into *LEXENV*, and
282 ;;; call FUN (with no arguments).
283 (defun %funcall-in-foomacrolet-lexenv (definitionize-fun
284                                        definitionize-keyword
285                                        definitions
286                                        fun)
287   (declare (type function definitionize-fun fun))
288   (declare (type (member :vars :funs) definitionize-keyword))
289   (declare (type list definitions))
290   (unless (= (length definitions)
291              (length (remove-duplicates definitions :key #'first)))
292     (compiler-style-warn "duplicate definitions in ~S" definitions))
293   (let* ((processed-definitions (mapcar definitionize-fun definitions))
294          (*lexenv* (make-lexenv definitionize-keyword processed-definitions)))
295     ;; I wonder how much of an compiler performance penalty this
296     ;; non-constant keyword is.
297     (funcall fun definitionize-keyword processed-definitions)))
298
299 ;;; Tweak LEXENV to include the DEFINITIONS from a MACROLET, then
300 ;;; call FUN (with no arguments).
301 ;;;
302 ;;; This is split off from the IR1 convert method so that it can be
303 ;;; shared by the special-case top level MACROLET processing code, and
304 ;;; further split so that the special-case MACROLET processing code in
305 ;;; EVAL can likewise make use of it.
306 (defun macrolet-definitionize-fun (context lexenv)
307   (flet ((fail (control &rest args)
308            (ecase context
309              (:compile (apply #'compiler-error control args))
310              (:eval (error 'simple-program-error
311                            :format-control control
312                            :format-arguments args)))))
313     (lambda (definition)
314       (unless (list-of-length-at-least-p definition 2)
315         (fail "The list ~S is too short to be a legal local macro definition."
316               definition))
317       (destructuring-bind (name arglist &body body) definition
318         (unless (symbolp name)
319           (fail "The local macro name ~S is not a symbol." name))
320         (when (fboundp name)
321           (program-assert-symbol-home-package-unlocked
322            context name "binding ~A as a local macro"))
323         (unless (listp arglist)
324           (fail "The local macro argument list ~S is not a list."
325                 arglist))
326         (with-unique-names (whole environment)
327           (multiple-value-bind (body local-decls)
328               (parse-defmacro arglist whole body name 'macrolet
329                               :environment environment)
330             `(,name macro .
331                     ,(compile-in-lexenv
332                       nil
333                       `(lambda (,whole ,environment)
334                          ,@local-decls
335                          ,body)
336                       lexenv))))))))
337
338 (defun funcall-in-macrolet-lexenv (definitions fun context)
339   (%funcall-in-foomacrolet-lexenv
340    (macrolet-definitionize-fun context (make-restricted-lexenv *lexenv*))
341    :funs
342    definitions
343    fun))
344
345 (def-ir1-translator macrolet ((definitions &rest body) start next result)
346   #!+sb-doc
347   "MACROLET ({(name lambda-list form*)}*) body-form*
348
349 Evaluate the BODY-FORMS in an environment with the specified local macros
350 defined. Name is the local macro name, LAMBDA-LIST is a DEFMACRO style
351 destructuring lambda list, and the FORMS evaluate to the expansion."
352   (funcall-in-macrolet-lexenv
353    definitions
354    (lambda (&key funs)
355      (declare (ignore funs))
356      (ir1-translate-locally body start next result))
357    :compile))
358
359 (defun symbol-macrolet-definitionize-fun (context)
360   (flet ((fail (control &rest args)
361            (ecase context
362              (:compile (apply #'compiler-error control args))
363              (:eval (error 'simple-program-error
364                            :format-control control
365                            :format-arguments args)))))
366     (lambda (definition)
367       (unless (proper-list-of-length-p definition 2)
368         (fail "malformed symbol/expansion pair: ~S" definition))
369       (destructuring-bind (name expansion) definition
370         (unless (symbolp name)
371           (fail "The local symbol macro name ~S is not a symbol." name))
372         (when (or (boundp name) (eq (info :variable :kind name) :macro))
373           (program-assert-symbol-home-package-unlocked
374            context name "binding ~A as a local symbol-macro"))
375         (let ((kind (info :variable :kind name)))
376           (when (member kind '(:special :constant))
377             (fail "Attempt to bind a ~(~A~) variable with SYMBOL-MACROLET: ~S"
378                   kind name)))
379         ;; A magical cons that MACROEXPAND-1 understands.
380         `(,name . (macro . ,expansion))))))
381
382 (defun funcall-in-symbol-macrolet-lexenv (definitions fun context)
383   (%funcall-in-foomacrolet-lexenv
384    (symbol-macrolet-definitionize-fun context)
385    :vars
386    definitions
387    fun))
388
389 (def-ir1-translator symbol-macrolet
390     ((macrobindings &body body) start next result)
391   #!+sb-doc
392   "SYMBOL-MACROLET ({(name expansion)}*) decl* form*
393
394 Define the NAMES as symbol macros with the given EXPANSIONS. Within the
395 body, references to a NAME will effectively be replaced with the EXPANSION."
396   (funcall-in-symbol-macrolet-lexenv
397    macrobindings
398    (lambda (&key vars)
399      (ir1-translate-locally body start next result :vars vars))
400    :compile))
401 \f
402 ;;;; %PRIMITIVE
403 ;;;;
404 ;;;; Uses of %PRIMITIVE are either expanded into Lisp code or turned
405 ;;;; into a funny function.
406
407 ;;; Carefully evaluate a list of forms, returning a list of the results.
408 (defun eval-info-args (args)
409   (declare (list args))
410   (handler-case (mapcar #'eval args)
411     (error (condition)
412       (compiler-error "Lisp error during evaluation of info args:~%~A"
413                       condition))))
414
415 ;;; Convert to the %%PRIMITIVE funny function. The first argument is
416 ;;; the template, the second is a list of the results of any
417 ;;; codegen-info args, and the remaining arguments are the runtime
418 ;;; arguments.
419 ;;;
420 ;;; We do various error checking now so that we don't bomb out with
421 ;;; a fatal error during IR2 conversion.
422 ;;;
423 ;;; KLUDGE: It's confusing having multiple names floating around for
424 ;;; nearly the same concept: PRIMITIVE, TEMPLATE, VOP. Now that CMU
425 ;;; CL's *PRIMITIVE-TRANSLATORS* stuff is gone, we could call
426 ;;; primitives VOPs, rename TEMPLATE to VOP-TEMPLATE, rename
427 ;;; BACKEND-TEMPLATE-NAMES to BACKEND-VOPS, and rename %PRIMITIVE to
428 ;;; VOP or %VOP.. -- WHN 2001-06-11
429 ;;; FIXME: Look at doing this ^, it doesn't look too hard actually.
430 (def-ir1-translator %primitive ((name &rest args) start next result)
431   (declare (type symbol name))
432   (let* ((template (or (gethash name *backend-template-names*)
433                        (bug "undefined primitive ~A" name)))
434          (required (length (template-arg-types template)))
435          (info (template-info-arg-count template))
436          (min (+ required info))
437          (nargs (length args)))
438     (if (template-more-args-type template)
439         (when (< nargs min)
440           (bug "Primitive ~A was called with ~R argument~:P, ~
441                 but wants at least ~R."
442                name
443                nargs
444                min))
445         (unless (= nargs min)
446           (bug "Primitive ~A was called with ~R argument~:P, ~
447                 but wants exactly ~R."
448                name
449                nargs
450                min)))
451
452     (when (eq (template-result-types template) :conditional)
453       (bug "%PRIMITIVE was used with a conditional template."))
454
455     (when (template-more-results-type template)
456       (bug "%PRIMITIVE was used with an unknown values template."))
457
458     (ir1-convert start next result
459                  `(%%primitive ',template
460                                ',(eval-info-args
461                                   (subseq args required min))
462                                ,@(subseq args 0 required)
463                                ,@(subseq args min)))))
464 \f
465 ;;;; QUOTE
466
467 (def-ir1-translator quote ((thing) start next result)
468   #!+sb-doc
469   "QUOTE value
470
471 Return VALUE without evaluating it."
472   (reference-constant start next result thing))
473 \f
474 ;;;; FUNCTION and NAMED-LAMBDA
475 (defun name-lambdalike (thing)
476   (ecase (car thing)
477     ((named-lambda)
478      (or (second thing)
479          `(lambda ,(third thing))))
480     ((lambda instance-lambda)
481      `(lambda ,(second thing)))
482     ((lambda-with-lexenv)
483      `(lambda ,(fifth thing)))))
484
485 (defun fun-name-leaf (thing)
486   (if (consp thing)
487       (cond
488         ((member (car thing)
489                  '(lambda named-lambda instance-lambda lambda-with-lexenv))
490          (values (ir1-convert-lambdalike
491                   thing
492                   :debug-name (name-lambdalike thing))
493                  t))
494         ((legal-fun-name-p thing)
495          (values (find-lexically-apparent-fun
496                   thing "as the argument to FUNCTION")
497                  nil))
498         (t
499          (compiler-error "~S is not a legal function name." thing)))
500       (values (find-lexically-apparent-fun
501                thing "as the argument to FUNCTION")
502               nil)))
503
504 (def-ir1-translator %%allocate-closures ((&rest leaves) start next result)
505   (aver (eq result 'nil))
506   (let ((lambdas leaves))
507     (ir1-convert start next result `(%allocate-closures ',lambdas))
508     (let ((allocator (node-dest (ctran-next start))))
509       (dolist (lambda lambdas)
510         (setf (functional-allocator lambda) allocator)))))
511
512 (defmacro with-fun-name-leaf ((leaf thing start &key global) &body body)
513   `(multiple-value-bind (,leaf allocate-p)
514        (if ,global
515            (find-global-fun ,thing t)
516            (fun-name-leaf ,thing))
517      (if allocate-p
518          (let ((.new-start. (make-ctran)))
519            (ir1-convert ,start .new-start. nil `(%%allocate-closures ,leaf))
520            (let ((,start .new-start.))
521              ,@body))
522          (locally
523              ,@body))))
524
525 (def-ir1-translator function ((thing) start next result)
526   #!+sb-doc
527   "FUNCTION name
528
529 Return the lexically apparent definition of the function NAME. NAME may also
530 be a lambda expression."
531   (with-fun-name-leaf (leaf thing start)
532     (reference-leaf start next result leaf)))
533
534 ;;; Like FUNCTION, but ignores local definitions and inline
535 ;;; expansions, and doesn't nag about undefined functions.
536 ;;; Used for optimizing things like (FUNCALL 'FOO).
537 (def-ir1-translator global-function ((thing) start next result)
538   (with-fun-name-leaf (leaf thing start :global t)
539     (reference-leaf start next result leaf)))
540
541 (defun constant-global-fun-name (thing)
542   (let ((constantp (sb!xc:constantp thing)))
543     (and constantp
544          (let ((name (constant-form-value thing)))
545            (and (legal-fun-name-p name) name)))))
546 \f
547 ;;;; FUNCALL
548
549 ;;; FUNCALL is implemented on %FUNCALL, which can only call functions
550 ;;; (not symbols). %FUNCALL is used directly in some places where the
551 ;;; call should always be open-coded even if FUNCALL is :NOTINLINE.
552 (deftransform funcall ((function &rest args) * *)
553   (let ((arg-names (make-gensym-list (length args))))
554     `(lambda (function ,@arg-names)
555        (%funcall ,(if (csubtypep (lvar-type function)
556                                  (specifier-type 'function))
557                       'function
558                       '(%coerce-callable-to-fun function))
559                  ,@arg-names))))
560
561 (def-ir1-translator %funcall ((function &rest args) start next result)
562   (cond ((and (consp function) (eq (car function) 'function))
563          (with-fun-name-leaf (leaf (second function) start)
564            (ir1-convert start next result `(,leaf ,@args))))
565         ((and (consp function) (eq (car function) 'global-function))
566          (with-fun-name-leaf (leaf (second function) start :global t)
567            (ir1-convert start next result `(,leaf ,@args))))
568         (t
569          (let ((ctran (make-ctran))
570                (fun-lvar (make-lvar)))
571            (ir1-convert start ctran fun-lvar `(the function ,function))
572            (ir1-convert-combination-args fun-lvar ctran next result args)))))
573
574 ;;; This source transform exists to reduce the amount of work for the
575 ;;; compiler. If the called function is a FUNCTION form, then convert
576 ;;; directly to %FUNCALL, instead of waiting around for type
577 ;;; inference.
578 (define-source-transform funcall (function &rest args)
579   (if (and (consp function) (member (car function) '(function lambda)))
580       `(%funcall ,function ,@args)
581       (let ((name (constant-global-fun-name function)))
582         (if name
583             `(%funcall (global-function ,name) ,@args)
584             (values nil t)))))
585
586 (deftransform %coerce-callable-to-fun ((thing) (function) *)
587   "optimize away possible call to FDEFINITION at runtime"
588   'thing)
589
590 (define-source-transform %coerce-callable-to-fun (thing)
591   (if (and (consp thing) (member (car thing) '(function lambda)))
592       thing
593       (values nil t)))
594 \f
595 ;;;; LET and LET*
596 ;;;;
597 ;;;; (LET and LET* can't be implemented as macros due to the fact that
598 ;;;; any pervasive declarations also affect the evaluation of the
599 ;;;; arguments.)
600
601 ;;; Given a list of binding specifiers in the style of LET, return:
602 ;;;  1. The list of var structures for the variables bound.
603 ;;;  2. The initial value form for each variable.
604 ;;;
605 ;;; The variable names are checked for legality and globally special
606 ;;; variables are marked as such. Context is the name of the form, for
607 ;;; error reporting purposes.
608 (declaim (ftype (function (list symbol) (values list list))
609                 extract-let-vars))
610 (defun extract-let-vars (bindings context)
611   (collect ((vars)
612             (vals)
613             (names))
614     (flet ((get-var (name)
615              (varify-lambda-arg name
616                                 (if (eq context 'let*)
617                                     nil
618                                     (names)))))
619       (dolist (spec bindings)
620         (cond ((atom spec)
621                (let ((var (get-var spec)))
622                  (vars var)
623                  (names spec)
624                  (vals nil)))
625               (t
626                (unless (proper-list-of-length-p spec 1 2)
627                  (compiler-error "The ~S binding spec ~S is malformed."
628                                  context
629                                  spec))
630                (let* ((name (first spec))
631                       (var (get-var name)))
632                  (vars var)
633                  (names name)
634                  (vals (second spec)))))))
635     (dolist (name (names))
636       (when (eq (info :variable :kind name) :macro)
637         (program-assert-symbol-home-package-unlocked
638          :compile name "lexically binding symbol-macro ~A")))
639     (values (vars) (vals))))
640
641 (def-ir1-translator let ((bindings &body body) start next result)
642   #!+sb-doc
643   "LET ({(var [value]) | var}*) declaration* form*
644
645 During evaluation of the FORMS, bind the VARS to the result of evaluating the
646 VALUE forms. The variables are bound in parallel after all of the VALUES forms
647 have been evaluated."
648   (cond ((null bindings)
649          (ir1-translate-locally body start next result))
650         ((listp bindings)
651          (multiple-value-bind (forms decls)
652              (parse-body body :doc-string-allowed nil)
653            (multiple-value-bind (vars values) (extract-let-vars bindings 'let)
654              (binding* ((ctran (make-ctran))
655                         (fun-lvar (make-lvar))
656                         ((next result)
657                          (processing-decls (decls vars nil next result
658                                                   post-binding-lexenv)
659                            (let ((fun (ir1-convert-lambda-body
660                                        forms
661                                        vars
662                                        :post-binding-lexenv post-binding-lexenv
663                                        :debug-name (debug-name 'let bindings))))
664                              (reference-leaf start ctran fun-lvar fun))
665                            (values next result))))
666                (ir1-convert-combination-args fun-lvar ctran next result values)))))
667         (t
668          (compiler-error "Malformed LET bindings: ~S." bindings))))
669
670 (def-ir1-translator let* ((bindings &body body)
671                           start next result)
672   #!+sb-doc
673   "LET* ({(var [value]) | var}*) declaration* form*
674
675 Similar to LET, but the variables are bound sequentially, allowing each VALUE
676 form to reference any of the previous VARS."
677   (if (listp bindings)
678       (multiple-value-bind (forms decls)
679           (parse-body body :doc-string-allowed nil)
680         (multiple-value-bind (vars values) (extract-let-vars bindings 'let*)
681           (processing-decls (decls vars nil next result post-binding-lexenv)
682             (ir1-convert-aux-bindings start
683                                       next
684                                       result
685                                       forms
686                                       vars
687                                       values
688                                       post-binding-lexenv))))
689       (compiler-error "Malformed LET* bindings: ~S." bindings)))
690
691 ;;; logic shared between IR1 translators for LOCALLY, MACROLET,
692 ;;; and SYMBOL-MACROLET
693 ;;;
694 ;;; Note that all these things need to preserve toplevel-formness,
695 ;;; but we don't need to worry about that within an IR1 translator,
696 ;;; since toplevel-formness is picked off by PROCESS-TOPLEVEL-FOO
697 ;;; forms before we hit the IR1 transform level.
698 (defun ir1-translate-locally (body start next result &key vars funs)
699   (declare (type ctran start next) (type (or lvar null) result)
700            (type list body))
701   (multiple-value-bind (forms decls) (parse-body body :doc-string-allowed nil)
702     (processing-decls (decls vars funs next result)
703       (ir1-convert-progn-body start next result forms))))
704
705 (def-ir1-translator locally ((&body body) start next result)
706   #!+sb-doc
707   "LOCALLY declaration* form*
708
709 Sequentially evaluate the FORMS in a lexical environment where the
710 DECLARATIONS have effect. If LOCALLY is a top level form, then the FORMS are
711 also processed as top level forms."
712   (ir1-translate-locally body start next result))
713 \f
714 ;;;; FLET and LABELS
715
716 ;;; Given a list of local function specifications in the style of
717 ;;; FLET, return lists of the function names and of the lambdas which
718 ;;; are their definitions.
719 ;;;
720 ;;; The function names are checked for legality. CONTEXT is the name
721 ;;; of the form, for error reporting.
722 (declaim (ftype (function (list symbol) (values list list)) extract-flet-vars))
723 (defun extract-flet-vars (definitions context)
724   (collect ((names)
725             (defs))
726     (dolist (def definitions)
727       (when (or (atom def) (< (length def) 2))
728         (compiler-error "The ~S definition spec ~S is malformed." context def))
729
730       (let ((name (first def)))
731         (check-fun-name name)
732         (when (fboundp name)
733           (program-assert-symbol-home-package-unlocked
734            :compile name "binding ~A as a local function"))
735         (names name)
736         (multiple-value-bind (forms decls) (parse-body (cddr def))
737           (defs `(lambda ,(second def)
738                    ,@decls
739                    (block ,(fun-name-block-name name)
740                      . ,forms))))))
741     (values (names) (defs))))
742
743 (defun ir1-convert-fbindings (start next result funs body)
744   (let ((ctran (make-ctran))
745         (dx-p (find-if #'leaf-dynamic-extent funs)))
746     (when dx-p
747       (ctran-starts-block ctran)
748       (ctran-starts-block next))
749     (ir1-convert start ctran nil `(%%allocate-closures ,@funs))
750     (cond (dx-p
751            (let* ((dummy (make-ctran))
752                   (entry (make-entry))
753                   (cleanup (make-cleanup :kind :dynamic-extent
754                                          :mess-up entry
755                                          :info (list (node-dest
756                                                       (ctran-next start))))))
757              (push entry (lambda-entries (lexenv-lambda *lexenv*)))
758              (setf (entry-cleanup entry) cleanup)
759              (link-node-to-previous-ctran entry ctran)
760              (use-ctran entry dummy)
761
762              (let ((*lexenv* (make-lexenv :cleanup cleanup)))
763                (ir1-convert-progn-body dummy next result body))))
764           (t (ir1-convert-progn-body ctran next result body)))))
765
766 (def-ir1-translator flet ((definitions &body body)
767                           start next result)
768   #!+sb-doc
769   "FLET ({(name lambda-list declaration* form*)}*) declaration* body-form*
770
771 Evaluate the BODY-FORMS with local function definitions. The bindings do
772 not enclose the definitions; any use of NAME in the FORMS will refer to the
773 lexically apparent function definition in the enclosing environment."
774   (multiple-value-bind (forms decls)
775       (parse-body body :doc-string-allowed nil)
776     (multiple-value-bind (names defs)
777         (extract-flet-vars definitions 'flet)
778       (let ((fvars (mapcar (lambda (n d)
779                              (ir1-convert-lambda d
780                                                  :source-name n
781                                                  :maybe-add-debug-catch t
782                                                  :debug-name (debug-name 'flet n)))
783                            names defs)))
784         (processing-decls (decls nil fvars next result)
785           (let ((*lexenv* (make-lexenv :funs (pairlis names fvars))))
786             (ir1-convert-fbindings start next result fvars forms)))))))
787
788 (def-ir1-translator labels ((definitions &body body) start next result)
789   #!+sb-doc
790   "LABELS ({(name lambda-list declaration* form*)}*) declaration* body-form*
791
792 Evaluate the BODY-FORMS with local function definitions. The bindings enclose
793 the new definitions, so the defined functions can call themselves or each
794 other."
795   (multiple-value-bind (forms decls) (parse-body body :doc-string-allowed nil)
796     (multiple-value-bind (names defs)
797         (extract-flet-vars definitions 'labels)
798       (let* (;; dummy LABELS functions, to be used as placeholders
799              ;; during construction of real LABELS functions
800              (placeholder-funs (mapcar (lambda (name)
801                                          (make-functional
802                                           :%source-name name
803                                           :%debug-name (debug-name
804                                                         'labels-placeholder
805                                                         name)))
806                                        names))
807              ;; (like PAIRLIS but guaranteed to preserve ordering:)
808              (placeholder-fenv (mapcar #'cons names placeholder-funs))
809              ;; the real LABELS functions, compiled in a LEXENV which
810              ;; includes the dummy LABELS functions
811              (real-funs
812               (let ((*lexenv* (make-lexenv :funs placeholder-fenv)))
813                 (mapcar (lambda (name def)
814                           (ir1-convert-lambda def
815                                               :source-name name
816                                               :maybe-add-debug-catch t
817                                               :debug-name (debug-name 'labels name)))
818                         names defs))))
819
820         ;; Modify all the references to the dummy function leaves so
821         ;; that they point to the real function leaves.
822         (loop for real-fun in real-funs and
823               placeholder-cons in placeholder-fenv do
824               (substitute-leaf real-fun (cdr placeholder-cons))
825               (setf (cdr placeholder-cons) real-fun))
826
827         ;; Voila.
828         (processing-decls (decls nil real-funs next result)
829           (let ((*lexenv* (make-lexenv
830                            ;; Use a proper FENV here (not the
831                            ;; placeholder used earlier) so that if the
832                            ;; lexical environment is used for inline
833                            ;; expansion we'll get the right functions.
834                            :funs (pairlis names real-funs))))
835             (ir1-convert-fbindings start next result real-funs forms)))))))
836
837 \f
838 ;;;; the THE special operator, and friends
839
840 ;;; A logic shared among THE and TRULY-THE.
841 (defun the-in-policy (type value policy start next result)
842   (let ((type (if (ctype-p type) type
843                    (compiler-values-specifier-type type))))
844     (cond ((or (eq type *wild-type*)
845                (eq type *universal-type*)
846                (and (leaf-p value)
847                     (values-subtypep (make-single-value-type (leaf-type value))
848                                      type))
849                (and (sb!xc:constantp value)
850                     (ctypep (constant-form-value value)
851                             (single-value-type type))))
852            (ir1-convert start next result value))
853           (t (let ((value-ctran (make-ctran))
854                    (value-lvar (make-lvar)))
855                (ir1-convert start value-ctran value-lvar value)
856                (let ((cast (make-cast value-lvar type policy)))
857                  (link-node-to-previous-ctran cast value-ctran)
858                  (setf (lvar-dest value-lvar) cast)
859                  (use-continuation cast next result)))))))
860
861 ;;; Assert that FORM evaluates to the specified type (which may be a
862 ;;; VALUES type). TYPE may be a type specifier or (as a hack) a CTYPE.
863 (def-ir1-translator the ((value-type form) start next result)
864   #!+sb-doc
865   "Specifies that the values returned by FORM conform to the VALUE-TYPE.
866
867 CLHS specifies that the consequences are undefined if any result is
868 not of the declared type, but SBCL treats declarations as assertions
869 as long as SAFETY is at least 2, in which case incorrect type
870 information will result in a runtime type-error instead of leading to
871 eg. heap corruption. This is however expressly non-portable: use
872 CHECK-TYPE instead of THE to catch type-errors at runtime. THE is best
873 considered an optimization tool to inform the compiler about types it
874 is unable to derive from other declared types."
875   (the-in-policy value-type form (lexenv-policy *lexenv*) start next result))
876
877 ;;; This is like the THE special form, except that it believes
878 ;;; whatever you tell it. It will never generate a type check, but
879 ;;; will cause a warning if the compiler can prove the assertion is
880 ;;; wrong.
881 (def-ir1-translator truly-the ((value-type form) start next result)
882   #!+sb-doc
883   "Specifies that the values returned by FORM conform to the
884 VALUE-TYPE, and causes the compiler to trust this information
885 unconditionally.
886
887 Consequences are undefined if any result is not of the declared type
888 -- typical symptoms including memory corruptions. Use with great
889 care."
890   (the-in-policy value-type form '((type-check . 0)) start next result))
891 \f
892 ;;;; SETQ
893
894 ;;; If there is a definition in LEXENV-VARS, just set that, otherwise
895 ;;; look at the global information. If the name is for a constant,
896 ;;; then error out.
897 (def-ir1-translator setq ((&whole source &rest things) start next result)
898   (let ((len (length things)))
899     (when (oddp len)
900       (compiler-error "odd number of args to SETQ: ~S" source))
901     (if (= len 2)
902         (let* ((name (first things))
903                (value-form (second things))
904                (leaf (or (lexenv-find name vars) (find-free-var name))))
905           (etypecase leaf
906             (leaf
907              (when (constant-p leaf)
908                (compiler-error "~S is a constant and thus can't be set." name))
909              (when (lambda-var-p leaf)
910                (let ((home-lambda (ctran-home-lambda-or-null start)))
911                  (when home-lambda
912                    (sset-adjoin leaf (lambda-calls-or-closes home-lambda))))
913                (when (lambda-var-ignorep leaf)
914                  ;; ANSI's definition of "Declaration IGNORE, IGNORABLE"
915                  ;; requires that this be a STYLE-WARNING, not a full warning.
916                  (compiler-style-warn
917                   "~S is being set even though it was declared to be ignored."
918                   name)))
919              (if (and (global-var-p leaf) (eq :global (global-var-kind leaf)))
920                  ;; For undefined variables go through SET, so that we can catch
921                  ;; constant modifications.
922                  (ir1-convert start next result `(set ',name ,value-form))
923                  (setq-var start next result leaf value-form)))
924             (cons
925              (aver (eq (car leaf) 'macro))
926              ;; FIXME: [Free] type declaration. -- APD, 2002-01-26
927              (ir1-convert start next result
928                           `(setf ,(cdr leaf) ,(second things))))
929             (heap-alien-info
930              (ir1-convert start next result
931                           `(%set-heap-alien ',leaf ,(second things))))))
932         (collect ((sets))
933           (do ((thing things (cddr thing)))
934               ((endp thing)
935                (ir1-convert-progn-body start next result (sets)))
936             (sets `(setq ,(first thing) ,(second thing))))))))
937
938 ;;; This is kind of like REFERENCE-LEAF, but we generate a SET node.
939 ;;; This should only need to be called in SETQ.
940 (defun setq-var (start next result var value)
941   (declare (type ctran start next) (type (or lvar null) result)
942            (type basic-var var))
943   (let ((dest-ctran (make-ctran))
944         (dest-lvar (make-lvar))
945         (type (or (lexenv-find var type-restrictions)
946                   (leaf-type var))))
947     (ir1-convert start dest-ctran dest-lvar `(the ,type ,value))
948     (let ((res (make-set :var var :value dest-lvar)))
949       (setf (lvar-dest dest-lvar) res)
950       (setf (leaf-ever-used var) t)
951       (push res (basic-var-sets var))
952       (link-node-to-previous-ctran res dest-ctran)
953       (use-continuation res next result))))
954 \f
955 ;;;; CATCH, THROW and UNWIND-PROTECT
956
957 ;;; We turn THROW into a MULTIPLE-VALUE-CALL of a magical function,
958 ;;; since as as far as IR1 is concerned, it has no interesting
959 ;;; properties other than receiving multiple-values.
960 (def-ir1-translator throw ((tag result) start next result-lvar)
961   #!+sb-doc
962   "THROW tag form
963
964 Do a non-local exit, return the values of FORM from the CATCH whose tag is EQ
965 to TAG."
966   (ir1-convert start next result-lvar
967                `(multiple-value-call #'%throw ,tag ,result)))
968
969 ;;; This is a special special form used to instantiate a cleanup as
970 ;;; the current cleanup within the body. KIND is the kind of cleanup
971 ;;; to make, and MESS-UP is a form that does the mess-up action. We
972 ;;; make the MESS-UP be the USE of the MESS-UP form's continuation,
973 ;;; and introduce the cleanup into the lexical environment. We
974 ;;; back-patch the ENTRY-CLEANUP for the current cleanup to be the new
975 ;;; cleanup, since this inner cleanup is the interesting one.
976 (def-ir1-translator %within-cleanup
977     ((kind mess-up &body body) start next result)
978   (let ((dummy (make-ctran))
979         (dummy2 (make-ctran)))
980     (ir1-convert start dummy nil mess-up)
981     (let* ((mess-node (ctran-use dummy))
982            (cleanup (make-cleanup :kind kind
983                                   :mess-up mess-node))
984            (old-cup (lexenv-cleanup *lexenv*))
985            (*lexenv* (make-lexenv :cleanup cleanup)))
986       (setf (entry-cleanup (cleanup-mess-up old-cup)) cleanup)
987       (ir1-convert dummy dummy2 nil '(%cleanup-point))
988       (ir1-convert-progn-body dummy2 next result body))))
989
990 ;;; This is a special special form that makes an "escape function"
991 ;;; which returns unknown values from named block. We convert the
992 ;;; function, set its kind to :ESCAPE, and then reference it. The
993 ;;; :ESCAPE kind indicates that this function's purpose is to
994 ;;; represent a non-local control transfer, and that it might not
995 ;;; actually have to be compiled.
996 ;;;
997 ;;; Note that environment analysis replaces references to escape
998 ;;; functions with references to the corresponding NLX-INFO structure.
999 (def-ir1-translator %escape-fun ((tag) start next result)
1000   (let ((fun (let ((*allow-instrumenting* nil))
1001                (ir1-convert-lambda
1002                 `(lambda ()
1003                    (return-from ,tag (%unknown-values)))
1004                 :debug-name (debug-name 'escape-fun tag))))
1005         (ctran (make-ctran)))
1006     (setf (functional-kind fun) :escape)
1007     (ir1-convert start ctran nil `(%%allocate-closures ,fun))
1008     (reference-leaf ctran next result fun)))
1009
1010 ;;; Yet another special special form. This one looks up a local
1011 ;;; function and smashes it to a :CLEANUP function, as well as
1012 ;;; referencing it.
1013 (def-ir1-translator %cleanup-fun ((name) start next result)
1014   ;; FIXME: Should this not be :TEST #'EQUAL? What happens to
1015   ;; (SETF FOO) here?
1016   (let ((fun (lexenv-find name funs)))
1017     (aver (lambda-p fun))
1018     (setf (functional-kind fun) :cleanup)
1019     (reference-leaf start next result fun)))
1020
1021 (def-ir1-translator catch ((tag &body body) start next result)
1022   #!+sb-doc
1023   "CATCH tag form*
1024
1025 Evaluate TAG and instantiate it as a catcher while the body forms are
1026 evaluated in an implicit PROGN. If a THROW is done to TAG within the dynamic
1027 scope of the body, then control will be transferred to the end of the body and
1028 the thrown values will be returned."
1029   ;; We represent the possibility of the control transfer by making an
1030   ;; "escape function" that does a lexical exit, and instantiate the
1031   ;; cleanup using %WITHIN-CLEANUP.
1032   (ir1-convert
1033    start next result
1034    (with-unique-names (exit-block)
1035      `(block ,exit-block
1036         (%within-cleanup
1037          :catch (%catch (%escape-fun ,exit-block) ,tag)
1038          ,@body)))))
1039
1040 (def-ir1-translator unwind-protect
1041     ((protected &body cleanup) start next result)
1042   #!+sb-doc
1043   "UNWIND-PROTECT protected cleanup*
1044
1045 Evaluate the form PROTECTED, returning its values. The CLEANUP forms are
1046 evaluated whenever the dynamic scope of the PROTECTED form is exited (either
1047 due to normal completion or a non-local exit such as THROW)."
1048   ;; UNWIND-PROTECT is similar to CATCH, but hairier. We make the
1049   ;; cleanup forms into a local function so that they can be referenced
1050   ;; both in the case where we are unwound and in any local exits. We
1051   ;; use %CLEANUP-FUN on this to indicate that reference by
1052   ;; %UNWIND-PROTECT isn't "real", and thus doesn't cause creation of
1053   ;; an XEP.
1054   (ir1-convert
1055    start next result
1056    (with-unique-names (cleanup-fun drop-thru-tag exit-tag next start count)
1057      `(flet ((,cleanup-fun ()
1058                ,@cleanup
1059                nil))
1060         ;; FIXME: If we ever get DYNAMIC-EXTENT working, then
1061         ;; ,CLEANUP-FUN should probably be declared DYNAMIC-EXTENT,
1062         ;; and something can be done to make %ESCAPE-FUN have
1063         ;; dynamic extent too.
1064         (block ,drop-thru-tag
1065           (multiple-value-bind (,next ,start ,count)
1066               (block ,exit-tag
1067                 (%within-cleanup
1068                     :unwind-protect
1069                     (%unwind-protect (%escape-fun ,exit-tag)
1070                                      (%cleanup-fun ,cleanup-fun))
1071                   (return-from ,drop-thru-tag ,protected)))
1072             (declare (optimize (insert-debug-catch 0)))
1073             (,cleanup-fun)
1074             (%continue-unwind ,next ,start ,count)))))))
1075 \f
1076 ;;;; multiple-value stuff
1077
1078 (def-ir1-translator multiple-value-call ((fun &rest args) start next result)
1079   #!+sb-doc
1080   "MULTIPLE-VALUE-CALL function values-form*
1081
1082 Call FUNCTION, passing all the values of each VALUES-FORM as arguments,
1083 values from the first VALUES-FORM making up the first argument, etc."
1084   (let* ((ctran (make-ctran))
1085          (fun-lvar (make-lvar))
1086          (node (if args
1087                    ;; If there are arguments, MULTIPLE-VALUE-CALL
1088                    ;; turns into an MV-COMBINATION.
1089                    (make-mv-combination fun-lvar)
1090                    ;; If there are no arguments, then we convert to a
1091                    ;; normal combination, ensuring that a MV-COMBINATION
1092                    ;; always has at least one argument. This can be
1093                    ;; regarded as an optimization, but it is more
1094                    ;; important for simplifying compilation of
1095                    ;; MV-COMBINATIONS.
1096                    (make-combination fun-lvar))))
1097     (ir1-convert start ctran fun-lvar
1098                  (if (and (consp fun) (eq (car fun) 'function))
1099                      fun
1100                      (let ((name (constant-global-fun-name fun)))
1101                        (if name
1102                            `(global-function ,name)
1103                            `(%coerce-callable-to-fun ,fun)))))
1104     (setf (lvar-dest fun-lvar) node)
1105     (collect ((arg-lvars))
1106       (let ((this-start ctran))
1107         (dolist (arg args)
1108           (let ((this-ctran (make-ctran))
1109                 (this-lvar (make-lvar node)))
1110             (ir1-convert this-start this-ctran this-lvar arg)
1111             (setq this-start this-ctran)
1112             (arg-lvars this-lvar)))
1113         (link-node-to-previous-ctran node this-start)
1114         (use-continuation node next result)
1115         (setf (basic-combination-args node) (arg-lvars))))))
1116
1117 (def-ir1-translator multiple-value-prog1
1118     ((values-form &rest forms) start next result)
1119   #!+sb-doc
1120   "MULTIPLE-VALUE-PROG1 values-form form*
1121
1122 Evaluate VALUES-FORM and then the FORMS, but return all the values of
1123 VALUES-FORM."
1124   (let ((dummy (make-ctran)))
1125     (ctran-starts-block dummy)
1126     (ir1-convert start dummy result values-form)
1127     (ir1-convert-progn-body dummy next nil forms)))
1128 \f
1129 ;;;; interface to defining macros
1130
1131 ;;; Old CMUCL comment:
1132 ;;;
1133 ;;;   Return a new source path with any stuff intervening between the
1134 ;;;   current path and the first form beginning with NAME stripped
1135 ;;;   off.  This is used to hide the guts of DEFmumble macros to
1136 ;;;   prevent annoying error messages.
1137 ;;;
1138 ;;; Now that we have implementations of DEFmumble macros in terms of
1139 ;;; EVAL-WHEN, this function is no longer used.  However, it might be
1140 ;;; worth figuring out why it was used, and maybe doing analogous
1141 ;;; munging to the functions created in the expanders for the macros.
1142 (defun revert-source-path (name)
1143   (do ((path *current-path* (cdr path)))
1144       ((null path) *current-path*)
1145     (let ((first (first path)))
1146       (when (or (eq first name)
1147                 (eq first 'original-source-start))
1148         (return path)))))