Newer
Older
;;; -*- Package: C; Log: C.Log -*-
;;;
;;; **********************************************************************
;;; This code was written as part of the CMU Common Lisp project at
;;; Carnegie Mellon University, and has been placed in the public domain.
;;; If you want to use this code or any part of CMU Common Lisp, please contact
;;; Scott Fahlman or slisp-group@cs.cmu.edu.
;;;
(ext:file-comment
"$Header: /Volumes/share2/src/cmucl/cvs2git/cvsroot/src/compiler/ir1util.lisp,v 1.33 1991/03/27 17:37:18 wlott Exp $")
;;; **********************************************************************
;;;
;;; This file contains random utilities used for manipulating the IR1
;;; representation.
;;;
;;; Written by Rob MacLachlan
;;;
(in-package "C")
(export '(*compiler-notification-function*))
(in-package "EXTENSIONS")
(export '(*error-print-level* *error-print-length*
*source-context-take-car-forms* *undefined-warning-limit*
*enclosing-source-cutoff*))
(in-package "C")
;;; Node-Enclosing-Cleanup -- Interface
;;; Return the innermost cleanup enclosing Node, or NIL if there is none in
;;; its function. If Node has no cleanup, but is in a let, then we must still
;;; check the environment that the call is in.
(defun node-enclosing-cleanup (node)
(declare (type node node))
(do ((lexenv (node-lexenv node)
(lambda-call-lexenv (lexenv-lambda lexenv))))
((null lexenv) nil)
(let ((cup (lexenv-cleanup lexenv)))
(when cup (return cup)))))
;;; Insert-Cleanup-Code -- Interface
;;;
;;; Convert the Form in a block inserted between Block1 and Block2 as an
;;; implicit MV-Prog1. The inserted block is returned. Node is used for IR1
;;; context when converting the form. Note that the block is not assigned a
;;; number, and is linked into the DFO at the beginning. We indicate that we
;;; have trashed the DFO by setting Component-Reanalyze. If Cleanup is
;;; supplied, then convert with that cleanup.
(defun insert-cleanup-code (block1 block2 node form &optional cleanup)
(declare (type cblock block1 block2) (type node node)
(type (or cleanup null) cleanup))
(with-ir1-environment node
(let* ((start (make-continuation))
(block (continuation-starts-block start))
(cont (make-continuation))
(*lexical-environment*
(if cleanup
(make-lexenv :cleanup cleanup)
*lexical-environment*)))
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
(change-block-successor block1 block2 block)
(link-blocks block block2)
(ir1-convert start cont form)
(setf (block-last block) (continuation-use cont))
block)))
;;;; Continuation use hacking:
;;; Find-Uses -- Interface
;;;
;;; Return a list of all the nodes which use Cont.
;;;
(proclaim '(function find-uses (continuation) list))
(defun find-uses (cont)
(ecase (continuation-kind cont)
((:block-start :deleted-block-start)
(block-start-uses (continuation-block cont)))
(:inside-block (list (continuation-use cont)))
(:unused nil)))
;;; Delete-Continuation-Use -- Interface
;;;
;;; Update continuation use information so that Node is no longer a use of
;;; its Cont. If the old continuation doesn't start its block, then we don't
;;; update the Block-Start-Uses, since it will be deleted when we are done.
;;;
;;; Note: if you call this function, you may have to do a
;;; REOPTIMIZE-CONTINUATION to inform IR1 optimization that something has
;;; changed.
;;;
(proclaim '(function delete-continuation-use (node) void))
(defun delete-continuation-use (node)
(let* ((cont (node-cont node))
(block (continuation-block cont)))
(ecase (continuation-kind cont)
(:deleted)
((:block-start :deleted-block-start)
(let ((uses (delete node (block-start-uses block))))
(setf (block-start-uses block) uses)
(setf (continuation-use cont)
(if (cdr uses) nil (car uses)))))
(:inside-block
(setf (continuation-kind cont) :unused)
(setf (continuation-block cont) nil)
(setf (continuation-use cont) nil)
(setf (continuation-next cont) nil)))
(setf (node-cont node) nil)))
;;; Add-Continuation-Use -- Interface
;;;
;;; Update continuation use information so that Node uses Cont. If Cont is
;;; :Unused, then we set its block to Node's Node-Block (which must be set.)
;;;
;;; Note: if you call this function, you may have to do a
;;; REOPTIMIZE-CONTINUATION to inform IR1 optimization that something has
;;; changed.
;;;
(proclaim '(function add-continuation-use (node continuation) void))
(defun add-continuation-use (node cont)
(assert (not (node-cont node)))
(let ((block (continuation-block cont)))
(ecase (continuation-kind cont)
(:deleted)
(:unused
(assert (not block))
(let ((block (node-block node)))
(assert block)
(setf (continuation-block cont) block))
(setf (continuation-kind cont) :inside-block)
(setf (continuation-use cont) node))
((:block-start :deleted-block-start)
(let ((uses (cons node (block-start-uses block))))
(setf (block-start-uses block) uses)
(setf (continuation-use cont)
(if (cdr uses) nil (car uses)))))))
(setf (node-cont node) cont))
;;; Immediately-Used-P -- Interface
;;;
;;; Return true if Cont is the Node-Cont for Node and Cont is transferred to
;;; immediately after the evaluation of Node.
;;;
(defun immediately-used-p (cont node)
(declare (type continuation cont) (type node node))
(and (eq (node-cont node) cont)
(not (eq (continuation-kind cont) :deleted))
(let ((cblock (continuation-block cont))
(nblock (node-block node)))
(or (eq cblock nblock)
(let ((succ (block-succ nblock)))
(and (= (length succ) 1)
(eq (first succ) cblock)))))))
;;;; Continuation substitution:
;;; Substitute-Continuation -- Interface
;;;
;;; In Old's Dest, replace Old with New. New's Dest must initially be NIL.
;;; When we are done, we call Flush-Dest on Old to clear its Dest and to note
;;; potential optimization opportunities.
;;;
(defun substitute-continuation (new old)
(declare (type continuation old new))
(assert (not (continuation-dest new)))
(let ((dest (continuation-dest old)))
(etypecase dest
((or ref bind))
(cif (setf (if-test dest) new))
(cset (setf (set-value dest) new))
(creturn (setf (return-result dest) new))
(exit (setf (exit-value dest) new))
(basic-combination
(if (eq old (basic-combination-fun dest))
(setf (basic-combination-fun dest) new)
(setf (basic-combination-args dest)
(nsubst new old (basic-combination-args dest))))))
(flush-dest old)
(setf (continuation-dest new) dest))
(undefined-value))
;;; Ensure-Block-Start -- Interface
;;;
;;; Ensure that Cont is the start of a block (or deleted) so that the use
;;; set can be freely manipulated.
;;; -- If the continuation is :Unused or is :Inside-Block and the Cont of Last
;;; in its block, then we make it the start of a new deleted block.
;;; -- If the continuation is :Inside-Block inside a block, then we split the
;;; block using Node-Ends-Block, which makes the continuation be a
;;; :Block-Start.
;;;
(defun ensure-block-start (cont)
(declare (type continuation cont))
(let ((kind (continuation-kind cont)))
(ecase kind
((:deleted :block-start :deleted-block-start))
((:unused :inside-block)
(let ((block (continuation-block cont)))
(cond ((or (eq kind :unused)
(eq (node-cont (block-last block)) cont))
(setf (continuation-block cont)
(make-block-key :start cont :component nil))
(setf (continuation-kind cont) :deleted-block-start))
(t
(node-ends-block (continuation-use cont))))))))
(undefined-value))
;;; Substitute-Continuation-Uses -- Interface
;;;
;;; Replace all uses of Old with uses of New, where New has an arbitary
;;; number of uses. If New will end up with more than one use, then we must
;;; arrange for it to start a block if it doesn't already.
;;;
(defun substitute-continuation-uses (new old)
(declare (type continuation old new))
(unless (and (eq (continuation-kind new) :unused)
(eq (continuation-kind old) :inside-block))
(ensure-block-start new))
(do-uses (node old)
(delete-continuation-use node)
(add-continuation-use node new))
(reoptimize-continuation new)
(undefined-value))
;;;; Misc shortand functions:
;;; NODE-HOME-LAMBDA -- Interface
;;;
;;; Return the home (i.e. enclosing non-let) lambda for Node. Since the
;;; LEXENV-LAMBDA may be deleted, we must chain up the LAMBDA-CALL-LEXENV
;;; thread until we find a lambda that isn't deleted, and then return its home.
;;;
(declaim (maybe-inline node-home-lambda))
(defun node-home-lambda (node)
(declare (type node node))
(do ((fun (lexenv-lambda (node-lexenv node))
(lexenv-lambda (lambda-call-lexenv fun))))
((not (eq (functional-kind fun) :deleted))
(lambda-home fun))
(when (eq (lambda-home fun) fun)
(return fun))))
;;; NODE-xxx -- Interface
(declaim (inline node-block node-tlf-number))
(declaim (maybe-inline node-environment))
(defun node-block (node)
(declare (type node node))
(the cblock (continuation-block (node-prev node))))
;;;
(defun node-environment (node)
(declare (type node node) (inline node-home-lambda))
(the environment (lambda-environment (node-home-lambda node))))
;;; BLOCK-xxx-CLEANUP -- Interface
;;;
;;; Return the enclosing cleanup for environment of the first or last node
;;; in Block.
;;;
(defun block-start-cleanup (block)
(declare (type cblock block))
(node-enclosing-cleanup (continuation-next (block-start block))))
;;;
(defun block-end-cleanup (block)
(declare (type cblock block))
(node-enclosing-cleanup (block-last block)))
;;; BLOCK-HOME-LAMBDA -- Interface
;;;
;;; Return the non-let lambda that holds Block's code.
;;;
(defun block-home-lambda (block)
(declare (type cblock block) (inline node-home-lambda))
(node-home-lambda (block-last block)))
;;; BLOCK-ENVIRONMENT -- Interface
;;;
;;; Return the IR1 environment for Block.
;;;
(defun block-environment (block)
(declare (type cblock block) (inline node-home-lambda))
(lambda-environment (node-home-lambda (block-last block))))
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
;;; SOURCE-PATH-TLF-NUMBER -- Interface
;;;
;;; Return the Top Level Form number of path, i.e. the ordinal number of
;;; its orignal source's top-level form in its compilation unit.
;;;
(defun source-path-tlf-number (path)
(declare (list path))
(car (last path)))
;;; SOURCE-PATH-ORIGINAL-SOURCE -- Interface
;;;
;;; Return the (reversed) list for the path in the orignal source (with the
;;; TLF number last.)
;;;
(defun source-path-original-source (path)
(declare (list path))
(cddr (member 'original-source-start path)))
;;; SOURCE-PATH-FORM-NUMBER -- Interface
;;;
;;; Return the Form Number of Path's orignal source inside the Top Level
;;; Form that contains it. This is determined by the order that we walk the
;;; subforms of the top level source form.
;;;
(defun source-path-form-number (path)
(declare (list path))
(cadr (member 'original-source-start path)))
;;; SOURCE-PATH-FORMS -- Interface
;;;
;;; Return a list of all the enclosing forms not in the original source that
;;; converted to get to this form, with the immediate source for node at the
;;; start of the list.
;;;
(defun source-path-forms (path)
(subseq path 0 (position 'original-source-start path)))
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
;;; MAKE-LEXENV -- Interface
;;;
;;; Return a new LEXENV just like Default except for the specified slot
;;; values. Values for the alist slots are NCONC'ed to the beginning of the
;;; current value, rather than replacing it entirely.
;;;
(defun make-lexenv (&key (default *lexical-environment*)
functions variables blocks tags type-restrictions
inlines
(lambda (lexenv-lambda default))
(cleanup (lexenv-cleanup default))
(cookie (lexenv-cookie default)))
(macrolet ((frob (var slot)
`(let ((old (,slot default)))
(if ,var
(nconc ,var old)
old))))
(internal-make-lexenv
(frob functions lexenv-functions)
(frob variables lexenv-variables)
(frob blocks lexenv-blocks)
(frob tags lexenv-tags)
(frob type-restrictions lexenv-type-restrictions)
(frob inlines lexenv-inlines)
lambda cleanup cookie)))
#|
functions
variables
blocks
tags
type-restrictions
inlines
|#
;;; Link-Blocks -- Interface
;;; Join Block1 and Block2.
(declare (type cblock block1 block2))
(assert (not (member block2 (block-succ block1))))
(push block2 (block-succ block1))
(push block1 (block-pred block2))
(undefined-value))
;;; UNLINK-BLOCKS -- Interface
;;;
;;; Like LINK-BLOCKS, but we separate BLOCK1 and BLOCK2. If this leaves a
;;; successor with a single predecessor that ends in an IF, then set
;;; BLOCK-TEST-MODIFIED so that any test constraint will now be able to be
;;; propagated to the successor.
(declare (type cblock block1 block2))
(assert (member block2 (block-succ block1)))
(setf (block-succ block1)
(delete block2 (block-succ block1)))
(let ((new-pred (delete block1 (block-pred block2))))
(setf (block-pred block2) new-pred)
(when (and new-pred (null (rest new-pred)))
(let ((pred-block (first new-pred)))
(when (if-p (block-last pred-block))
(setf (block-test-modified pred-block) t)))))
(undefined-value))
;;; Change-Block-Successor -- Internal
;;;
;;; Swing the succ/pred link between Block and Old to be between Block and
;;; New. If Block ends in an IF, then we have to fix up the
;;; consequent/alternative blocks to point to New. We also set
;;; BLOCK-TEST-MODIFIED so that any test constraint will be applied to the new
;;; successor.
;;;
(defun change-block-successor (block old new)
(declare (type cblock new old block))
(unlink-blocks block old)
(unless (member new (block-succ block))
(link-blocks block new))
(let ((last (block-last block)))
(when (if-p last)
(setf (block-test-modified block) t)
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
(macrolet ((frob (slot)
`(when (eq (,slot last) old)
(setf (,slot last) new))))
(frob if-consequent)
(frob if-alternative))))
(undefined-value))
;;; Remove-From-DFO -- Interface
;;;
;;; Unlink a block from the next/prev chain. We also null out the
;;; Component.
;;;
(proclaim '(function remove-from-dfo (cblock) void))
(defun remove-from-dfo (block)
(let ((next (block-next block))
(prev (block-prev block)))
(setf (block-component block) nil)
(setf (block-next prev) next)
(setf (block-prev next) prev)))
;;; Add-To-DFO -- Interface
;;;
;;; Add Block to the next/prev chain following After. We also set the
;;; Component to be the same as for After.
;;;
(defun add-to-dfo (block after)
(declare (type cblock block after))
(let ((next (block-next after)))
(setf (block-component block) (block-component after))
(setf (block-next after) block)
(setf (block-prev block) after)
(setf (block-next block) next)
(setf (block-prev next) block))
(undefined-value))
;;; Clear-Flags -- Interface
;;;
;;; Set the Flag for all the blocks in Component to NIL, except for the head
;;; and tail which are set to T.
;;;
(proclaim '(function clear-flags (component) void))
(defun clear-flags (component)
(let ((head (component-head component))
(tail (component-tail component)))
(setf (block-flag head) t)
(setf (block-flag tail) t)
(do-blocks (block component)
(setf (block-flag block) nil))))
;;; Make-Empty-Component -- Interface
;;;
;;; Make a component with no blocks in it. The Block-Flag is initially true
;;; in the head and tail blocks.
;;;
(proclaim '(function make-empty-component () component))
(defun make-empty-component ()
(let* ((head (make-block-key :start nil :component nil))
(tail (make-block-key :start nil :component nil))
(res (make-component :head head :tail tail)))
(setf (block-flag head) t)
(setf (block-flag tail) t)
(setf (block-component head) res)
(setf (block-component tail) res)
(setf (block-next head) tail)
(setf (block-prev tail) head)
res))
;;; Node-Ends-Block -- Interface
;;;
;;; Makes Node the Last node in its block, splitting the block if necessary.
;;; The new block is added to the DFO immediately following Node's block.
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
;;;
(defun node-ends-block (node)
(declare (type node node))
(let* ((block (node-block node))
(start (node-cont node))
(last (block-last block))
(last-cont (node-cont last)))
(unless (eq last node)
(assert (eq (continuation-kind start) :inside-block))
(let* ((succ (block-succ block))
(new-block
(make-block-key :start start
:component (block-component block)
:start-uses (list (continuation-use start))
:succ succ :last last)))
(setf (continuation-kind start) :block-start)
(dolist (b succ)
(setf (block-pred b)
(cons new-block (remove block (block-pred b)))))
(setf (block-succ block) ())
(setf (block-last block) node)
(link-blocks block new-block)
(add-to-dfo new-block block)
(do ((cont start (node-cont (continuation-next cont))))
((eq cont last-cont)
(when (eq (continuation-kind last-cont) :inside-block)
(setf (continuation-block last-cont) new-block)))
(setf (continuation-block cont) new-block))
(setf (block-type-asserted block) t)
(setf (block-test-modified block) t))))
(undefined-value))
;;;; Deleting stuff:
;;; Delete-Lambda-Var -- Internal
;;;
;;; Deal with deleting the last (read) reference to a lambda-var. We
;;; iterate over all local calls flushing the corresponding argument, allowing
;;; the computation of the argument to be deleted. We also mark the let for
;;; reoptimization, since it may be that we have deleted the last variable.
;;;
;;; The lambda-var may still have some sets, but this doesn't cause too much
;;; difficulty, since we can efficiently implement write-only variables. We
;;; iterate over the sets, marking their blocks for dead code flushing, since
;;; we can delete sets whose value is unused.
;;;
(defun delete-lambda-var (leaf)
(declare (type lambda-var leaf))
(let* ((fun (lambda-var-home leaf))
(n (position leaf (lambda-vars fun))))
(dolist (ref (leaf-refs fun))
(let* ((cont (node-cont ref))
(dest (continuation-dest cont)))
(when (and (combination-p dest)
(eq (basic-combination-fun dest) cont)
(eq (basic-combination-kind dest) :local))
(let* ((args (basic-combination-args dest))
(arg (elt args n)))
(reoptimize-continuation arg)
(flush-dest arg)
(setf (elt args n) nil))))))
(dolist (set (lambda-var-sets leaf))
(setf (block-flush-p (node-block set)) t))
(undefined-value))
;;; REOPTIMIZE-LAMBDA-VAR -- Internal
;;;
;;; Note that something interesting has happened to Var. We only deal with
;;; LET variables, marking the corresponding initial value arg as needing to be
;;; reoptimized.
;;;
(defun reoptimize-lambda-var (var)
(declare (type lambda-var var))
(let ((fun (lambda-var-home var)))
(when (and (eq (functional-kind fun) :let)
(leaf-refs var))
(reoptimize-continuation
(elt (basic-combination-args
(continuation-dest
(node-cont
(first (leaf-refs fun)))))
(position var (lambda-vars fun))))))
(undefined-value))
;;; DELETE-FUNCTIONAL -- Interface
;;;
;;; This function deletes functions that have no references. This need only
;;; be called on functions that never had any references, since otherwise
;;; DELETE-REF will handle the deletion.
;;;
(defun delete-functional (fun)
(assert (and (null (leaf-refs fun)))
(not (functional-entry-function fun)))
(etypecase fun
(optional-dispatch (delete-optional-dispatch fun))
(clambda (delete-lambda fun)))
(undefined-value))
;;; MAYBE-REMOVE-FREE-FUNCTION -- Interface
;;;
;;; This function is called when we let convert a function or blow away an
;;; XEP, or otherwise do something that should prevent any new references to
;;; Fun (or its optional-dispatch) from being created.
;;;
(defun maybe-remove-free-function (fun)
(declare (type functional fun))
(let* ((fun (etypecase fun
(clambda (or (lambda-optional-dispatch fun) fun))
(optional-dispatch fun)))
(entry (gethash (leaf-name fun) *free-functions*)))
(when (eq entry fun)
(remhash (leaf-name fun) *free-functions*)))
(undefined-value))
;;; Delete-Lambda -- Internal
;;;
;;; Deal with deleting the last reference to a lambda. Since there is only
;;; one way into a lambda, deleting the last reference to a lambda ensures that
;;; there is no way to reach any of the code in it. So we just set the
;;; Functional-Kind for Fun and its Lets to :Deleted, causing IR1 optimization
;;; to delete blocks in that lambda.
;;;
;;; If the function isn't a Let, we unlink the function head and tail from
;;; the component head and tail to indicate that the code is unreachable. We
;;; also delete the function from Component-Lambdas (it won't be there before
;;; local call analysis, but no matter.) If the lambda was never referenced,
;;; we give a note.
;;;
;;; If the lambda is an XEP, then we null out the Entry-Function in its
;;; Entry-Function so that people will know that it is not an entry point
;;; anymore.
;;;
(defun delete-lambda (leaf)
(declare (type clambda leaf))
(let ((kind (functional-kind leaf))
(bind (lambda-bind leaf)))
(assert (not (member kind '(:deleted :optional :top-level))))
(setf (functional-kind leaf) :deleted)
(setf (lambda-bind leaf) nil)
(setf (lambda-bind let) nil)
(setf (functional-kind let) :deleted))
(if (or (eq kind :let) (eq kind :mv-let))
(let ((home (lambda-home leaf)))
(setf (lambda-lets home) (delete leaf (lambda-lets home))))
(let* ((bind-block (node-block bind))
(component (block-component bind-block))
(return (lambda-return leaf)))
(assert (null (leaf-refs leaf)))
(unless (leaf-ever-used leaf)
(let ((*compiler-error-context* bind))
(compiler-note "Deleting unused function~:[.~;~:*~% ~S~]"
(leaf-name leaf))))
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
(unlink-blocks (component-head component) bind-block)
(when return
(unlink-blocks (node-block return) (component-tail component)))
(setf (component-lambdas component)
(delete leaf (component-lambdas component)))))
(when (eq kind :external)
(let ((fun (functional-entry-function leaf)))
(setf (functional-entry-function fun) nil)
(when (optional-dispatch-p fun)
(delete-optional-dispatch fun)))))
(undefined-value))
;;; Delete-Optional-Dispatch -- Internal
;;;
;;; Deal with deleting the last reference to an Optional-Dispatch. We have
;;; to be a bit more careful than with lambdas, since Delete-Ref is used both
;;; before and after local call analysis. Afterward, all references to
;;; still-existing optional-dispatches have been moved to the XEP, leaving it
;;; with no references at all. So we look at the XEP to see if an
;;; optional-dispatch is still really being used. But before local call
;;; analysis, there are no XEPs, and all references are direct.
;;;
;;; When we do delete the optional-dispatch, we grovel all of its
;;; entry-points, making them be normal lambdas, and then deleting the ones
;;; with no references. This deletes any e-p lambdas that were either never
;;; referenced, or couldn't be deleted when the last deference was deleted (due
;;; to their :Optional kind.)
;;;
;;; Note that the last optional ep may alias the main entry, so when we process
;;; the main entry, its kind may have been changed to NIL or even converted to
;;; a let.
;;;
(defun delete-optional-dispatch (leaf)
(declare (type optional-dispatch leaf))
(maybe-remove-free-function leaf)
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
(let ((entry (functional-entry-function leaf)))
(unless (and entry (leaf-refs entry))
(assert (or (not entry) (eq (functional-kind entry) :deleted)))
(setf (functional-kind leaf) :deleted)
(flet ((frob (fun)
(unless (eq (functional-kind fun) :deleted)
(assert (eq (functional-kind fun) :optional))
(setf (functional-kind fun) nil)
(let ((refs (leaf-refs fun)))
(cond ((null refs)
(delete-lambda fun))
((null (rest refs))
(maybe-let-convert fun)))))))
(dolist (ep (optional-dispatch-entry-points leaf))
(frob ep))
(when (optional-dispatch-more-entry leaf)
(frob (optional-dispatch-more-entry leaf)))
(let ((main (optional-dispatch-main-entry leaf)))
(when (eq (functional-kind main) :optional)
(frob main))))))
(undefined-value))
;;; Delete-Ref -- Interface
;;;
;;; Do stuff to delete the semantic attachments of a Ref node. When this
;;; leaves zero or one reference, we do a type dispatch off of the leaf to
;;; determine if a special action is appropriate.
;;;
(defun delete-ref (ref)
(declare (type ref ref))
(let* ((leaf (ref-leaf ref))
(refs (delete ref (leaf-refs leaf))))
(setf (leaf-refs leaf) refs)
(cond ((null refs)
(typecase leaf
(lambda-var (delete-lambda-var leaf))
(clambda
(ecase (functional-kind leaf)
((nil :let :mv-let :escape :cleanup)
(asssert (not (functional-entry-function leaf))))
(:external
(delete-lambda leaf))
((:deleted :optional))))
(optional-dispatch
(unless (eq (functional-kind leaf) :deleted)
(delete-optional-dispatch leaf)))))
((null (rest refs))
(typecase leaf
(clambda (maybe-let-convert leaf))
(lambda-var (reoptimize-lambda-var leaf))))))
(undefined-value))
;;; Delete-Return -- Interface
;;;
;;; Do stuff to indicate that the return node Node is being deleted. We set
;;; the RETURN to NIL and remove the function from its tail set.
;;;
;;; As a rather random special case, we leave the function in the tail set
;;; when there are uses of the result continuation marked TAIL-P. This is done
;;; to prevent the tail set from being blown away when the back end deletes the
;;; return because it discovers that all calls are tail-recursive.
;;;
(defun delete-return (node)
(declare (type creturn node))
(let* ((fun (return-lambda node))
(tail-set (lambda-tail-set fun)))
(assert (lambda-return fun))
(unless (do-uses (use (return-result node) nil)
(when (node-tail-p use) (return t)))
(setf (tail-set-functions tail-set)
(delete fun (tail-set-functions tail-set)))
(setf (lambda-tail-set fun) nil))
;;; NOTE-UNREFERENCED-VARS -- Interface
;;;
;;; If any of the Vars in fun were never referenced and was not declared
;;; IGNORE, then complain.
;;;
(defun note-unreferenced-vars (fun)
(declare (type clambda fun))
(dolist (var (lambda-vars fun))
(unless (or (leaf-ever-used var)
(lambda-var-ignorep var))
(let ((*compiler-error-context* (lambda-bind fun)))
(compiler-warning "Variable ~S defined but never used."
(leaf-name var))
(setf (leaf-ever-used var) t))))
(undefined-value))
;;; Flush-Dest -- Interface
;;;
;;; This function is called by people who delete nodes; it provides a way to
;;; indicate that the value of a continuation is no longer used. We null out
;;; the Continuation-Dest, set Flush-P in the blocks containing uses of Cont
;;; and set Component-Reoptimize.
;;;
;;; If the continuation is :Deleted, then we don't do anything, since all
;;; semantics have already been flushed. If the continuation is a
;;; :Deleted-Block-Start, then we delete the continuation, since its control
;;; semantics have already been deleted. Deleting the continuation causes its
;;; uses to be reoptimized. If the Prev of the use is deleted, then we blow
;;; off reoptimization.
;;;
(defun flush-dest (cont)
(declare (type continuation cont))
(ecase (continuation-kind cont)
(:deleted)
(:deleted-block-start
(assert (continuation-dest cont))
(setf (continuation-dest cont) nil)
(delete-continuation cont))
((:inside-block :block-start)
(assert (continuation-dest cont))
(setf (continuation-dest cont) nil)
(setf (component-reoptimize (block-component (continuation-block cont)))
t)
(do-uses (use cont)
(let ((prev (node-prev use)))
(unless (eq (continuation-kind prev) :deleted)
(setf (block-attributep (block-flags (continuation-block prev))
flush-p type-asserted)
t))))))
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
(setf (continuation-%type-check cont) nil)
(undefined-value))
;;; MARK-FOR-DELETION -- Internal
;;;
;;; Do a graph walk backward from Block, marking all predecessor blocks with
;;; the DELETE-P flag.
;;;
(defun mark-for-deletion (block)
(declare (type cblock block))
(unless (block-delete-p block)
(setf (block-delete-p block) t)
(dolist (pred (block-pred block))
(mark-for-deletion pred)))
(undefined-value))
;;; DELETE-CONTINUATION -- Interface
;;;
;;; Delete Cont, eliminating both control and value semantics. We set
;;; FLUSH-P and COMPONENT-REOPTIMIZE similarly to in FLUSH-DEST. Here we must
;;; get the component from the use block, since the continuation may be a
;;; :DELETED-BLOCK-START.
;;;
;;; If Cont has DEST, then it must be the case that the DEST is unreachable,
;;; since we can't compute the value desired. In this case, we call
;;; MARK-FOR-DELETION to cause the DEST block and its predecessors to tell
;;; people to ignore them, and to cause them to be deleted eventually.
;;;
(defun delete-continuation (cont)
(declare (type continuation cont))
(assert (not (eq (continuation-kind cont) :deleted)))
(do-uses (use cont)
(let ((prev (node-prev use)))
(unless (eq (continuation-kind prev) :deleted)
(let ((block (continuation-block prev)))
(setf (block-attributep (block-flags block) flush-p type-asserted) t)
(setf (component-reoptimize (block-component block)) t)))))
(let ((dest (continuation-dest cont)))
(when dest
(let ((block (node-block dest)))
(unless (block-delete-p block)
(mark-for-deletion block)))))
(setf (continuation-kind cont) :deleted)
(setf (continuation-dest cont) nil)
(setf (continuation-next cont) nil)
(setf (continuation-asserted-type cont) *empty-type*)
(setf (continuation-%derived-type cont) *empty-type*)
(setf (continuation-use cont) nil)
(setf (continuation-block cont) nil)
(setf (continuation-reoptimize cont) nil)
(setf (continuation-%type-check cont) nil)
(setf (continuation-info cont) nil)
(undefined-value))
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
(defvar *deletion-ignored-objects* '(t nil))
;;; PRESENT-IN-FORM -- Internal
;;;
;;; Return true if we can find Obj in Form, NIL otherwise. We bound our
;;; recursion so that we don't get lost in circular structures. We ignore the
;;; car of forms if they are a symbol (to prevent confusing function
;;; referencess with variables), and we also ignore anything inside ' or #'.
;;;
(defun present-in-form (obj form depth)
(declare (type (integer 0 20) depth))
(cond ((= depth 20) nil)
((eq obj form) t)
((atom form) nil)
(t
(let ((first (car form))
(depth (1+ depth)))
(if (member first '(quote function))
nil
(or (and (not (symbolp first))
(present-in-form obj first depth))
(do ((l (cdr form) (cdr l))
(n 0 (1+ n)))
((or (atom l) (> n 100))
nil)
(declare (fixnum n))
(when (present-in-form obj (car l) depth)
(return t)))))))))
;;; NOTE-BLOCK-DELETION -- Internal
;;;
;;; This function is called on a block immediately before we delete it. We
;;; check to see if any of the code about to die appeared in the original
;;; source, and emit a note if so.
;;;
;;; If the block was in a lambda is now deleted, then we ignore the whole
;;; block, since this case is picked off in DELETE-LAMBDA. We also ignore the
;;; deletion of CRETURN nodes, since it is somewhat reasonable for a function
;;; to not return, and there is a different note for that case anyway.
;;;
;;; If the actual source is an atom, then we use a bunch of heuristics to
;;; guess whether this reference really appeared in the original source:
;;; -- If a symbol, it must be interned and not a keyword.
;;; -- It must not be an easily introduced constant (T or NIL, a fixnum or a
;;; character.)
;;; -- The atom must be "present" in the original source form, and present in
;;; all intervening actual source forms.
;;;
(defun note-block-deletion (block)
(let ((home (block-home-lambda block)))
(unless (eq (functional-kind home) :deleted)
(do-nodes (node cont block)
(let* ((path (node-source-path node))
(first (first path)))
(when (or (eq first 'original-source-start)
(and (atom first)
(or (not (symbolp first))
(let ((pkg (symbol-package first)))
(and pkg
(not (eq pkg (symbol-package :end))))))
(not (member first *deletion-ignored-objects*))
(not (typep first '(or fixnum character)))
(every #'(lambda (x)
(present-in-form first x 0))
(source-path-forms path))
(present-in-form first (find-original-source path)
0)))
(unless (return-p node)
(let ((*compiler-error-context* node))
(compiler-note "Deleting unreachable code.")))
(return))))))
(undefined-value))
;;; Delete-Block -- Interface
;;;
;;; This function does what is necessary to eliminate the code in it from
;;; the IR1 representation. This involves unlinking it from its predecessors
;;; and successors and deleting various node-specific semantic information.
;;;
;;; We mark the Start as has having no next and remove the last node from
;;; its Cont's uses. We also flush the DEST for all continuations whose values
;;; are received by nodes in the block.
;;;
(defun delete-block (block)
(declare (type cblock block))
(assert (block-component block) () "Block is already deleted.")
(note-block-deletion block)
(setf (block-delete-p block) t)
(let* ((last (block-last block))
(cont (node-cont last)))
(delete-continuation-use last)
(if (eq (continuation-kind cont) :unused)
(delete-continuation cont)
(reoptimize-continuation cont)))
(dolist (b (block-pred block))
(unlink-blocks b block))
(dolist (b (block-succ block))
(unlink-blocks block b))
(do-nodes (node cont block)
(typecase node
(ref (delete-ref node))
(basic-combination
(when (and (eq (basic-combination-kind node) :local)
;; Not already deleted...
(continuation-use (basic-combination-fun node)))
(let ((fun (combination-lambda node)))
(when (member (functional-kind fun) '(:let :mv-let))
(delete-lambda fun))))
(flush-dest (basic-combination-fun node))
(dolist (arg (basic-combination-args node))
(when arg (flush-dest arg))))
(cif
(flush-dest (if-test node)))
(bind
(let ((lambda (bind-lambda node)))
(unless (eq (functional-kind lambda) :deleted)
(assert (member (functional-kind lambda) '(:let :mv-let)))
(delete-lambda lambda))))
(exit
(let ((value (exit-value node))
(entry (exit-entry node)))
(flush-dest value))
(when entry
(setf (entry-exits entry)
(delete node (entry-exits entry))))))
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
(creturn
(flush-dest (return-result node))
(delete-return node))
(cset
(flush-dest (set-value node))
(let ((var (set-var node)))
(setf (basic-var-sets var)
(delete node (basic-var-sets var))))))
(delete-continuation (node-prev node)))
(remove-from-dfo block)
(undefined-value))
;;; Unlink-Node -- Interface
;;;
;;; Delete a node from a block, deleting the block if there are no nodes
;;; left. We remove the node from the uses of its CONT, but we don't deal with
;;; cleaning up any type-specific semantic attachments. If the CONT is :UNUSED
;;; after deleting this use, then we delete CONT. (Note :UNUSED is not the
;;; same as no uses. A continuation will only become :UNUSED if it was
;;; :INSIDE-BLOCK before.)
;;;
;;; If the node is the last node, there must be exactly one successor. We
;;; link all of our precedessors to the successor and unlink the block. In
;;; this case, we return T, otherwise NIL. If no nodes are left, and the block
;;; is a successor of itself, then we replace the only node with a degenerate
;;; exit node. This provides a way to represent the bodyless infinite loop,
;;; given the prohibition on empty blocks in IR1.
;;;
(defun unlink-node (node)
(declare (type node node))
(let* ((cont (node-cont node))
(next (continuation-next cont))
(prev (node-prev node))
(block (continuation-block prev))
(prev-kind (continuation-kind prev))
(last (block-last block)))
(unless (eq (continuation-kind cont) :deleted)
(delete-continuation-use node)
(when (eq (continuation-kind cont) :unused)
(assert (not (continuation-dest cont)))
(delete-continuation cont)))
(setf (block-type-asserted block) t)
(setf (block-test-modified block) t)
(cond ((or (eq prev-kind :inside-block)
(and (eq prev-kind :block-start)
(not (eq node last))))
(cond ((eq node last)
(setf (block-last block) (continuation-use prev))
(setf (continuation-next prev) nil))
(t
(setf (continuation-next prev) next)
(setf (node-prev next) prev)))
(setf (node-prev node) nil)
nil)
(t
(assert (eq prev-kind :block-start))
(assert (eq node last))
(let* ((succ (block-succ block))
(next (first succ)))
(assert (and succ (null (cdr succ))))
(cond
((member block succ)
(with-ir1-environment node
(let ((exit (make-exit))
(dummy (make-continuation)))
(setf (continuation-next prev) nil)
(prev-link exit prev)
(add-continuation-use exit dummy)
(setf (block-last block) exit)))
(setf (node-prev node) nil)
nil)
(t
(assert (eq (block-start-cleanup block)
(block-end-cleanup block)))
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
(unlink-blocks block next)
(dolist (pred (block-pred block))
(change-block-successor pred block next))
(remove-from-dfo block)
(cond ((continuation-dest prev)
(setf (continuation-next prev) nil)
(setf (continuation-kind prev) :deleted-block-start))
(t
(delete-continuation prev)))
(setf (node-prev node) nil)
t)))))))
;;; NODE-DELETED -- Interface
;;;
;;; Return true if NODE has been deleted, false if it is still a valid part
;;; of IR1.
;;;
(defun node-deleted (node)
(declare (type node node))
(let ((prev (node-prev node)))
(not (and prev
(not (eq (continuation-kind prev) :deleted))
(let ((block (continuation-block prev)))
(and (block-component block)
(not (block-delete-p block))))))))
;;;; Leaf hackery:
;;; Change-Ref-Leaf -- Interface
;;;
;;; Change the Leaf that a Ref refers to.
;;;
(defun change-ref-leaf (ref leaf)
(declare (type ref ref) (type leaf leaf))
(unless (eq (ref-leaf ref) leaf)
(push ref (leaf-refs leaf))
(delete-ref ref)
(setf (ref-leaf ref) leaf)
(let ((ltype (leaf-type leaf)))
(if (function-type-p ltype)
(setf (node-derived-type ref) ltype)
(derive-node-type ref ltype)))
(reoptimize-continuation (node-cont ref)))
(undefined-value))
;;; Substitute-Leaf -- Interface
;;;
;;; Change all Refs for Old-Leaf to New-Leaf.
;;;
(defun substitute-leaf (new-leaf old-leaf)
(declare (type leaf new-leaf old-leaf))
(dolist (ref (leaf-refs old-leaf))
(change-ref-leaf ref new-leaf))
(undefined-value))
;;; SUBSTITUTE-LEAF-IF -- Interface
;;;
;;; Like SUBSITIUTE-LEAF, only there is a predicate on the Ref to tell
;;; whether to substitute.
;;;
(defun substitute-leaf-if (test new-leaf old-leaf)
(declare (type leaf new-leaf old-leaf) (type function test))
(dolist (ref (leaf-refs old-leaf))
(when (funcall test ref)
(change-ref-leaf ref new-leaf)))
(undefined-value))
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
;;; Find-Constant -- Interface
;;;
;;; Return a Leaf which represents the specified constant object. If the
;;; object is not in *constants*, then we create a new constant Leaf and
;;; enter it.
;;;
(defun find-constant (object)
(or (gethash object *constants*)
(setf (gethash object *constants*)
(make-constant :value object :name nil
:type (ctype-of object)
:where-from :defined))))
;;;; Find-NLX-Info -- Interface
;;;
;;; If there is a non-local exit noted in Entry's environment that exits to
;;; Cont in that entry, then return it, otherwise return NIL.
;;;
(defun find-nlx-info (entry cont)
(declare (type entry entry) (type continuation cont))
(let ((entry-cleanup (entry-cleanup entry)))
(dolist (nlx (environment-nlx-info (node-environment entry)) nil)
(eq (nlx-info-cleanup nlx) entry-cleanup))
(return nlx)))))
;;;; Functional hackery:
;;; Main-Entry -- Interface
;;;
;;; If Functional is a Lambda, just return it; if it is an
;;; optional-dispatch, return the main-entry.
;;;
(proclaim '(function main-entry (functional) clambda))
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
(defun main-entry (functional)
(if (lambda-p functional)
functional
(optional-dispatch-main-entry functional)))
;;; Looks-Like-An-MV-Bind -- Interface
;;;
;;; Returns true if Functional is a thing that can be treated like MV-Bind
;;; when it appears in an MV-Call. All fixed arguments must be optional with
;;; null default and no supplied-p. There must be a rest arg with no
;;; references.
;;;
(proclaim '(function looks-like-an-mv-bind (functional) boolean))
(defun looks-like-an-mv-bind (functional)
(and (optional-dispatch-p functional)
(do ((arg (optional-dispatch-arglist functional) (cdr arg)))
((null arg) nil)
(let ((info (lambda-var-arg-info (car arg))))
(unless info (return nil))
(case (arg-info-kind info)
(:optional
(when (or (arg-info-supplied-p info) (arg-info-default info))
(return nil)))
(:rest
(return (and (null (cdr arg)) (null (leaf-refs (car arg))))))
(t
(return nil)))))))
;;; External-Entry-Point-P -- Interface
;;;
;;; Return true if function is an XEP. This is true of normal XEPs
;;; (:External kind) and top-level lambdas (:Top-Level kind.)
;;;
(defun external-entry-point-p (fun)
(declare (type functional fun))
(not (null (member (functional-kind fun) '(:external :top-level)))))
;;; Continuation-Function-Name -- Interface
;;;
;;; If Cont's only use is a non-notinline global function reference, then
;;; return the referenced symbol, otherwise NIL.
;;;
(defun continuation-function-name (cont)
(declare (type continuation cont))
(let ((use (continuation-use cont)))
(if (and (ref-p use)
(not (eq (ref-inlinep use) :notinline)))
(let ((leaf (ref-leaf use)))
(if (and (global-var-p leaf)
(eq (global-var-kind leaf) :global-function))
(leaf-name leaf)
nil))
nil)))
;;; LET-COMBINATION -- Interface
;;;
;;; Return the COMBINATION node that is the call to the let Fun.
;;;
(defun let-combination (fun)
(declare (type clambda fun))
(assert (member (functional-kind fun) '(:let :mv-let)))
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
(continuation-dest (node-cont (first (leaf-refs fun)))))
;;; LET-VAR-INITIAL-VALUE -- Interface
;;;
;;; Return the initial value continuation for a let variable or NIL if none.
;;;
(defun let-var-initial-value (var)
(declare (type lambda-var var))
(let ((fun (lambda-var-home var)))
(elt (combination-args (let-combination fun))
(position var (lambda-vars fun)))))
;;; COMBINATION-LAMBDA -- Interface
;;;
;;; Return the LAMBDA that is called by the local Call.
;;;
(defun combination-lambda (call)
(declare (type basic-combination call))
(assert (eq (basic-combination-kind call) :local))
(ref-leaf (continuation-use (basic-combination-fun call))))
;;;; Compiler error context determination:
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
(proclaim '(special *current-path*))
;;; We bind print level and length when printing out messages so that we don't
;;; dump huge amounts of garbage.
;;;
(proclaim '(type (or unsigned-byte null) *error-print-level*
*error-print-length*))
(defvar *error-print-level* 3
"The value for *Print-Level* when printing compiler error messages.")
(defvar *error-print-length* 5
"The value for *Print-Length* when printing compiler error messages.")
(defvar *enclosing-source-cutoff* 1
"The maximum number of enclosing non-original source forms (i.e. from
macroexpansion) that we print in full. For additional enclosing forms, we
print only the CAR.")
(proclaim '(type unsigned-byte *enclosing-source-cutoff*))
(defparameter *source-context-take-car-forms* '(defstruct function)
"A list of form names for which we should we should compute the source
context by taking the CAR of the first arg when it is a list.")
;;; We separate the determination of compiler error contexts from the actual
;;; signalling of those errors by objectifying the error context. This allows
;;; postponement of the determination of how (and if) to signal the error.
;;; We take care not to reference any of the IR1 so that pending potential
;;; error messages won't prevent the IR1 from being GC'd. To this end, we
;;; convert source forms to strings so that source forms that contain IR1
;;; references (e.g. %DEFUN) don't hold onto the IR.
;;;
(defstruct (compiler-error-context
(:print-function
(lambda (s stream d)
(declare (ignore s d))
(format stream "#<Compiler-Error-Context>"))))
;;
;; A list of the stringified CARs of the enclosing non-original source forms
;; exceeding the *enclosing-source-cutoff*.
(enclosing-source nil :type list)
;; A list of stringified enclosing non-original source forms.
(source nil :type list)
;; The stringified form in the original source that expanded into Source.
(original-source (required-argument) :type simple-string)
;; A list of prefixes of "interesting" forms that enclose original-source.
(context nil :type list)
;;
;; The FILE-INFO-NAME for the relevant FILE-INFO.
(file-name (required-argument) :type (or pathname (member :lisp :stream)))
;;
;; The file position at which the top-level form starts, if applicable.
(file-position nil :type (or index null))
;;
;; The original source part of the source path.
(original-source-path nil :type list))
;;; If true, this is the node which is used as context in compiler warning
;;; messages.
;;;
(proclaim '(type (or null compiler-error-context node)
*compiler-error-context*))
(defvar *compiler-error-context* nil)
;;; SOURCE-FORM-CONTEXT -- Internal
;;;
;;; Return the first two elements of Form if Form is a list. Take the car
;;; of the second form if appropriate.
;;;
(defun source-form-context (form)
(cond ((atom form) nil)
((>= (length form) 2)
(let ((head (first form))
(next (second form)))
(list head
(if (and (listp next)
(member head *source-context-take-car-forms*))
(car next)
next))))
(t
form)))
;;; Find-Original-Source -- Internal
;;;
;;; Given a source path, return the original source form and a description
;;; of the interesting aspects of the context in which it appeared. The
;;; context is a list of lists, one sublist per context form. The sublist is a
;;; list of some of the initial subforms of the context form.
;;;
;;; For now, we use the first two subforms of each interesting form. A form is
;;; interesting if the first element is a symbol beginning with "DEF" and it is
;;; not the source form. If there is no DEF-mumble, then we use the outermost
;;; containing form. If the second subform is a list, then in some cases we
;;; return the car of that form rather than the whole form (i.e. don't show
;;; defstruct options, etc.)
;;;
(defun find-original-source (path)
(declare (list path))
(let* ((rpath (reverse (source-path-original-source path)))
(tlf (first rpath))
(root (find-source-root tlf *source-info*)))
(collect ((context))
(let ((form root)
(current (rest rpath)))
(loop
(when (atom form)
(assert (null current))
(return))
(let ((head (first form)))
(when (symbolp head)
(let ((name (symbol-name head)))
(when (and (>= (length name) 3) (string= name "DEF" :end1 3))
(context (source-form-context form))))))
(when (null current) (return))
(setq form (nth (pop current) form)))
(cond ((context)
(values form (context)))
((and path root)
(let ((c (source-form-context root)))
(values form (if c (list c) nil))))
(t
(values '(unable to locate source)
'((some strange place)))))))))
;;; STRINGIFY-FORM -- Internal
;;;
;;; Convert a source form to a string, formatted suitably for use in
;;; compiler warnings.
;;;
(defun stringify-form (form &optional (pretty t))
(let ((*print-level* (or *error-print-level* *print-level*))
(*print-length* (or *error-print-length* *print-length*))
(*print-pretty* pretty))
(if pretty
(format nil " ~S~%" form)
(prin1-to-string form))))
;;; FIND-ERROR-CONTEXT -- Interface
;;;
;;; Return a COMPILER-ERROR-CONTEXT structure describing the current error
;;; context, or NIL if we can't figure anything out. Args is a list of things
;;; that are going to be printed out in the error message, and can thus be
;;; blown off when they appear in the source context.
(defun find-error-context (args)
(let ((context *compiler-error-context*))
(if (compiler-error-context-p context)
context
(let ((path (or *current-path*
(if context
(node-source-path context)
nil))))
(when (and *source-info* path)
(multiple-value-bind (form src-context)
(find-original-source path)
(collect ((full nil cons)
(short nil cons))
(let ((forms (source-path-forms path))
(n 0))
(dolist (src (if (member (first forms) args)
(rest forms)
forms))
(if (>= n *enclosing-source-cutoff*)
(short (stringify-form (if (consp src)
(car src)
src)
nil))
(full (stringify-form src)))
(incf n)))
(let* ((tlf (source-path-tlf-number path))
(file (find-file-info tlf *source-info*)))
(make-compiler-error-context
:enclosing-source (short)
:source (full)
:original-source (stringify-form form)
:context src-context
:file-name (file-info-name file)
:file-position
(multiple-value-bind (ignore pos)
(find-source-root tlf *source-info*)
(declare (ignore ignore))
pos)
:original-source-path
(source-path-original-source path))))))))))
;;;; Printing error messages:
;;; A function that is called to unwind out of Compiler-Error.
;;;
(proclaim '(type (function () nil) *compiler-error-bailout*))
(defvar *compiler-error-bailout*
#'(lambda () (error "Compiler-Error with no bailout.")))
;;; The stream that compiler error output is directed to.
;;;
(defvar *compiler-error-output* (make-synonym-stream '*error-output*))
(proclaim '(type stream *compiler-error-output*))
;;; We save the context information that we printed out most recently so that
;;; we don't print it out redundantly.
;;; The last COMPILER-ERROR-CONTEXT that we printed.
;;;
(defvar *last-error-context* nil)
(proclaim '(type (or compiler-error-context null) *last-error-context*))
;;; The format string and args for the last error we printed.
;;;
(defvar *last-format-string* nil)
(defvar *last-format-args* nil)
(proclaim '(type (or string null) *last-format-string*))
(proclaim '(type list *last-format-args*))
;;; The number of times that the last error message has been emitted, so that
;;; we can compress duplicate error messages.
(defvar *last-message-count* 0)
(proclaim '(type index *last-message-count*))
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
(defvar *compiler-notification-function* nil
"This is the function called by the compiler to specially note a warning,
comment, or error. The function must take four arguments, the severity
a string for context, the file namestring, and the file position. The
severity is one of :note, :warning, or :error. Except for the severity, all
of these can be NIL if unavailable or inapplicable.")
;;; COMPILER-NOTIFICATION -- Internal
;;;
;;; Call any defined notification function.
;;;
(defun compiler-notification (severity context)
(declare (type (member :note :warning :error) severity)
(type (or compiler-error-context null) context))
(when *compiler-notification-function*
(if context
(let ((*print-level* 2)
(*print-pretty* nil)
(name (compiler-error-context-file-name context)))
(funcall *compiler-notification-function* severity
(format nil "~{~{~S~^ ~}~^ => ~}"
(compiler-error-context-context context))
(when (typep name 'pathname)
(namestring name))
(compiler-error-context-file-position context)))
(funcall *compiler-notification-function* severity nil nil nil)))
(undefined-value))
;;; Note-Message-Repeats -- Internal
;;;
;;; If the last message was given more than once, then print out an
;;; indication of how many times it was repeated. We reset the message count
;;; when we are done.
;;;
(defun note-message-repeats (&optional (terpri t))
(cond ((= *last-message-count* 1)
(when terpri (terpri *compiler-error-output*)))
((> *last-message-count* 1)
(format *compiler-error-output* "[Last message occurs ~D times]~2%"
*last-message-count*)))
(setq *last-message-count* 0))
;;; Print-Error-Message -- Internal
;;;
;;; Print out the message, with appropriate context if we can find it. If
;;; If the context is different from the context of the last message we
;;; printed, then we print the context. If the original source is different
;;; from the source we are working on, then we print the current source in
;;; addition to the original source.
;;;
;;; We suppress printing of messages identical to the previous, but record
;;; the number of times that the message is repeated.
;;;
(defun print-error-message (what format-string format-args)
(declare (type (member :error :warning :note) what) (string format-string)
(list format-args))
(let* ((*print-level* (or *error-print-level* *print-level*))
(*print-length* (or *error-print-length* *print-length*))
(context (find-error-context format-args)))
(let ((file (compiler-error-context-file-name context))
(in (compiler-error-context-context context))
(enclosing (compiler-error-context-enclosing-source context))
(source (compiler-error-context-source context))
(last *last-error-context*))
(compiler-notification what context)
(unless (and last
(equal file (compiler-error-context-file-name last)))
(when (typep file 'pathname)
(note-message-repeats)
(setq last nil)
(format stream "~2&File: ~A~%" (namestring file))))
(unless (and last
(equal in (compiler-error-context-context last)))
(setq last nil)
(format stream "~2&In:~{~<~% ~4:;~{ ~S~}~>~^ =>~}~%" in))
(unless (and last
(string= form
(compiler-error-context-original-source last)))
(setq last nil)
(write-string form stream))
(unless (and last
(equal enclosing
(compiler-error-context-enclosing-source last)))
(when enclosing
(setq last nil)
(format stream "--> ~{~<~%--> ~1:;~A~> ~}~%" enclosing)))
(unless (and last
(equal source (compiler-error-context-source last)))
(setq *last-format-string* nil)
(when source
(dolist (src source)
(write-line "==>" stream)
(write-string src stream))))))
(setq *last-format-string* nil)
(setq *last-error-context* context)
(setq *last-format-string* format-string)
(setq *last-format-args* format-args)
(format stream "~&~:(~A~): ~?~&" what format-string format-args)))
(incf *last-message-count*)
(undefined-value))
;;; Keep track of how many times each kind of warning happens.
;;;
(proclaim '(type index *compiler-error-count* *compiler-warning-count*
*compiler-note-count*))
(defvar *compiler-error-count* 0)
(defvar *compiler-warning-count* 0)
(defvar *compiler-note-count* 0)
;;; Compiler-Error, ... -- Interface
;;;
;;; Increment the count and print the message. Compiler-Note never prints
;;; anything when Brevity is 3. Compiler-Error calls the bailout function
;;; so that it never returns. Compiler-Error-Message returns like
;;; Compiler-Warning, but prints a message like Compiler-Error.
;;;
(proclaim '(ftype (function (string &rest t) void)
compiler-error compiler-warning compiler-note))
;;;
(defun compiler-error (format-string &rest format-args)
(incf *compiler-error-count*)
(print-error-message :error format-string format-args)
(funcall *compiler-error-bailout*)
(error "*Compiler-Error-Bailout* returned?"))
;;;
(defun compiler-error-message (format-string &rest format-args)
(incf *compiler-error-count*)
(print-error-message :error format-string format-args))
;;;
(defun compiler-warning (format-string &rest format-args)
(incf *compiler-warning-count*)
(print-error-message :warning format-string format-args))
;;;
(defun compiler-note (format-string &rest format-args)
(unless (if *compiler-error-context*
(policy *compiler-error-context* (= brevity 3))
(policy nil (= brevity 3)))
(incf *compiler-note-count*)
(print-error-message :note format-string format-args)))
;;; Compiler-Mumble -- Interface
;;;
;;; The politically correct way to print out random progress messages and
;;; such like. We clear the current error context so that we know that it
;;; needs to be reprinted, and we also Force-Output so that the message gets
;;; seen right away.
;;;
(proclaim '(function compiler-mumble (string &rest t) void))
(defun compiler-mumble (format-string &rest format-args)
(setq *last-error-context* nil)
(apply #'format *compiler-error-output* format-string format-args)
(force-output *compiler-error-output*))
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
;;; Find-Component-Name -- Interface
;;;
;;; Return a string that somehow names the code in Component. We use the
;;; source path for the bind node for an arbitrary entry point to find the
;;; source context, then return that as a string.
;;;
(proclaim '(function find-component-name (component) simple-string))
(defun find-component-name (component)
(let ((ep (first (block-succ (component-head component)))))
(assert ep () "No entry points?")
(multiple-value-bind
(form context)
(find-original-source
(node-source-path (continuation-next (block-start ep))))
(declare (ignore form))
(let ((*print-level* 2)
(*print-pretty* nil))
(format nil "~{~{~S~^ ~}~^ => ~}" context)))))
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
;;;; Undefined warnings:
(defvar *undefined-warning-limit* 3
"If non-null, then an upper limit on the number of unknown function or type
warnings that the compiler will print for any given name in a single
compilation. This prevents excessive amounts of output when there really is
a missing definition (as opposed to a typo in the use.)")
;;; NOTE-UNDEFINED-REFERENCE -- Interface
;;;
;;; Make an entry in the *UNDEFINED-WARNINGS* describing a reference to Name
;;; of the specified Kind. If we have exceeded the warning limit, then just
;;; increment the count, otherwise note the current error context.
;;;
(defun note-undefined-reference (name kind)
(let* ((found (dolist (warn *undefined-warnings* nil)
(when (and (equal (undefined-warning-name warn) name)
(eq (undefined-warning-kind warn) kind))
(return warn))))
(res (or found
(make-undefined-warning :name name :kind kind))))
(unless found (push res *undefined-warnings*))
(when (or (not *undefined-warning-limit*)
(< (undefined-warning-count res) *undefined-warning-limit*))
(push (find-error-context (list name))
(undefined-warning-warnings res)))
(incf (undefined-warning-count res)))
(undefined-value))
;;;; Careful call:
;;; Careful-Call -- Interface
;;;
;;; Apply a function to some arguments, returning a list of the values
;;; resulting of the evaulation. If an error is signalled during the
;;; application, then we print a warning message and return NIL as our second
;;; value to indicate this. Node is used as the error context for any error
;;; message, and Context is a string that is spliced into the warning.
;;;
(proclaim '(function careful-call ((or symbol function) list node string)
(values list boolean)))
(defun careful-call (function args node context)
(values
(multiple-value-list
(handler-case (apply function args)
(error (condition)
(let ((*compiler-error-context* node))
(compiler-warning "Lisp error during ~A:~%~A" context condition)
(return-from careful-call (values nil nil))))))
t))
;;;; Generic list (?) functions:
(proclaim '(inline find-in position-in map-in))
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
;;; Find-In -- Interface
;;;
(defun find-in (next element list &key (key #'identity)
(test #'eql test-p) (test-not nil not-p))
"Find Element in a null-terminated List linked by the accessor function
Next. Key, Test and Test-Not are the same as for generic sequence
functions."
(when (and test-p not-p)
(error "Silly to supply both :Test and :Test-Not."))
(if not-p
(do ((current list (funcall next current)))
((null current) nil)
(unless (funcall test-not (funcall key current) element)
(return current)))
(do ((current list (funcall next current)))
((null current) nil)
(when (funcall test (funcall key current) element)
(return current)))))
;;; Position-In -- Interface
;;;
(defun position-in (next element list &key (key #'identity)
(test #'eql test-p) (test-not nil not-p))
"Return the position of Element (or NIL if absent) in a null-terminated List
linked by the accessor function Next. Key, Test and Test-Not are the same as
for generic sequence functions."
(when (and test-p not-p)
(error "Silly to supply both :Test and :Test-Not."))
(if not-p
(do ((current list (funcall next current))
(i 0 (1+ i)))
((null current) nil)
(unless (funcall test-not (funcall key current) element)
(return i)))
(do ((current list (funcall next current))
(i 0 (1+ i)))
((null current) nil)
(when (funcall test (funcall key current) element)
(return i)))))
;;; Map-In -- Interface
;;;
(defun map-in (next function list)
"Map Function over the elements in a null-terminated List linked by the
accessor function Next, returning a list of the results."
(collect ((res))
(do ((current list (funcall next current)))
((null current))
(res (funcall function current)))
(res)))
;;; Deletef-In -- Interface
;;;
(defmacro deletef-in (next place item &environment env)
"Deletef-In Next Place Item
Delete Item from a null-terminated list linked by the accessor function Next
that is stored in Place. Item must appear exactly once in the list."
(multiple-value-bind
(temps vals stores store access)
#-new-compiler
(if clc::*in-the-compiler*
(get-setf-method place env)
(lisp::foo-get-setf-method place env))
#+new-compiler
(lisp::foo-get-setf-method place env)
(let ((n-item (gensym))
(n-place (gensym))
(n-current (gensym))
(n-prev (gensym)))
`(let* (,@(mapcar #'list temps vals)
(,n-place ,access)
(,n-item ,item))
(if (eq ,n-place ,n-item)
(let ((,(first stores) (,next ,n-place)))
,store)
(do ((,n-prev ,n-place ,n-current)
(,n-current (,next ,n-place)
(,next ,n-current)))
((eq ,n-current ,n-item)
(setf (,next ,n-prev)
(,next ,n-current)))))
(undefined-value)))))
;;; Push-In -- Interface
;;;
(defmacro push-in (next item place &environment env)
"Push Item onto a list linked by the accessor function Next that is stored in
Place."
(multiple-value-bind
(temps vals stores store access)
#-new-compiler
(if clc::*in-the-compiler*
(get-setf-method place env)
(lisp::foo-get-setf-method place env))
#+new-compiler
(lisp::foo-get-setf-method place env)
`(let (,@(mapcar #'list temps vals)
(,(first stores) ,item))
(setf (,next ,(first stores)) ,access)
,store
(undefined-value))))
;;; Compiler-Constantp -- Interface
;;;
;;; We don't want to assume that a variable is a constant just because it is
;;; in the current lisp environment.
;;;
;;; ### For now, just use CONSTANTP to avoid bootstrapping problems with having
;;; to have the INFO database available at meta-compile time.
;;;
(proclaim '(function compiler-constantp (t) boolean))
(defun compiler-constantp (exp)
"Like constantp, only uses the compilation environment rather than the
current Lisp environment."
#|
(if (symbolp exp)
(eq (info variable kind exp) :constant)
(constantp exp))
|#
(constantp exp))