/[slime]/slime/swank-cmucl.lisp
ViewVC logotype

Contents of /slime/swank-cmucl.lisp

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.175 - (hide annotations)
Fri Nov 30 13:10:40 2007 UTC (6 years, 4 months ago) by heller
Branch: MAIN
Changes since 1.174: +9 -8 lines
Handle byte-functions without debug-info.

* swank-cmucl.lisp (byte-function-location): Return an error
if the component has no debug-info.
1 lgorrie 1.103 ;;; -*- indent-tabs-mode: nil; outline-regexp: ";;;;+" -*-
2     ;;;
3 heller 1.108 ;;; License: Public Domain
4     ;;;
5 lgorrie 1.103 ;;;; Introduction
6     ;;;
7     ;;; This is the CMUCL implementation of the `swank-backend' package.
8 dbarlow 1.1
9 heller 1.80 (in-package :swank-backend)
10 dbarlow 1.1
11 heller 1.119 (import-swank-mop-symbols :pcl '(:slot-definition-documentation))
12    
13     (defun swank-mop:slot-definition-documentation (slot)
14     (documentation slot t))
15    
16 lgorrie 1.103 ;;;; "Hot fixes"
17     ;;;
18 heller 1.147 ;;; Here are necessary bugfixes to the oldest supported version of
19 lgorrie 1.103 ;;; CMUCL (currently 18e). Any fixes placed here should also be
20     ;;; submitted to the `cmucl-imp' mailing list and confirmed as
21     ;;; good. When a new release is made that includes the fixes we should
22     ;;; promptly delete them from here. It is enough to be compatible with
23     ;;; the latest release.
24    
25 heller 1.67 (in-package :lisp)
26    
27 lgorrie 1.103 ;;; `READ-SEQUENCE' with large sequences has problems in 18e. This new
28     ;;; definition works better.
29    
30 heller 1.131 #-cmu19
31 heller 1.67 (progn
32     (let ((s (find-symbol (string :*enable-package-locked-errors*) :lisp)))
33     (when s
34     (setf (symbol-value s) nil)))
35    
36     (defun read-into-simple-string (s stream start end)
37     (declare (type simple-string s))
38     (declare (type stream stream))
39     (declare (type index start end))
40     (unless (subtypep (stream-element-type stream) 'character)
41     (error 'type-error
42     :datum (read-char stream nil #\Null)
43     :expected-type (stream-element-type stream)
44     :format-control "Trying to read characters from a binary stream."))
45     ;; Let's go as low level as it seems reasonable.
46     (let* ((numbytes (- end start))
47 heller 1.79 (total-bytes 0))
48     ;; read-n-bytes may return fewer bytes than requested, so we need
49     ;; to keep trying.
50     (loop while (plusp numbytes) do
51     (let ((bytes-read (system:read-n-bytes stream s start numbytes nil)))
52     (when (zerop bytes-read)
53     (return-from read-into-simple-string total-bytes))
54     (incf total-bytes bytes-read)
55     (incf start bytes-read)
56     (decf numbytes bytes-read)))
57     total-bytes))
58 heller 1.67
59     (let ((s (find-symbol (string :*enable-package-locked-errors*) :lisp)))
60     (when s
61     (setf (symbol-value s) t)))
62    
63     )
64    
65 heller 1.80 (in-package :swank-backend)
66 heller 1.67
67 lgorrie 1.25
68 lgorrie 1.103 ;;;; TCP server
69     ;;;
70     ;;; In CMUCL we support all communication styles. By default we use
71     ;;; `:SIGIO' because it is the most responsive, but it's somewhat
72     ;;; dangerous: CMUCL is not in general "signal safe", and you don't
73     ;;; know for sure what you'll be interrupting. Both `:FD-HANDLER' and
74     ;;; `:SPAWN' are reasonable alternatives.
75 lgorrie 1.25
76 heller 1.80 (defimplementation preferred-communication-style ()
77     :sigio)
78 heller 1.48
79 trittweiler 1.173 #-(or darwin mips)
80 heller 1.63 (defimplementation create-socket (host port)
81 heller 1.136 (let* ((addr (resolve-hostname host))
82     (addr (if (not (find-symbol "SOCKET-ERROR" :ext))
83     (ext:htonl addr)
84     addr)))
85     (ext:create-inet-listener port :stream :reuse-address t :host addr)))
86 heller 1.133
87     ;; There seems to be a bug in create-inet-listener on Mac/OSX and Irix.
88 trittweiler 1.173 #+(or darwin mips)
89 heller 1.133 (defimplementation create-socket (host port)
90     (declare (ignore host))
91     (ext:create-inet-listener port :stream :reuse-address t))
92 heller 1.47
93 lgorrie 1.56 (defimplementation local-port (socket)
94 heller 1.47 (nth-value 1 (ext::get-socket-host-and-port (socket-fd socket))))
95    
96 lgorrie 1.56 (defimplementation close-socket (socket)
97 heller 1.157 (let ((fd (socket-fd socket)))
98     (sys:invalidate-descriptor fd)
99     (ext:close-socket fd)))
100 heller 1.47
101 heller 1.162 (defimplementation accept-connection (socket &key
102     external-format buffering timeout)
103 heller 1.167 (declare (ignore timeout external-format))
104     (let ((buffering (or buffering :full)))
105 heller 1.162 (make-socket-io-stream (ext:accept-tcp-connection socket) buffering)))
106 heller 1.47
107 lgorrie 1.103 ;;;;; Sockets
108    
109     (defun socket-fd (socket)
110     "Return the filedescriptor for the socket represented by SOCKET."
111     (etypecase socket
112     (fixnum socket)
113     (sys:fd-stream (sys:fd-stream-fd socket))))
114    
115     (defun resolve-hostname (hostname)
116 heller 1.136 "Return the IP address of HOSTNAME as an integer (in host byte-order)."
117     (let ((hostent (ext:lookup-host-entry hostname)))
118     (car (ext:host-entry-addr-list hostent))))
119 lgorrie 1.103
120 heller 1.157 (defun make-socket-io-stream (fd buffering)
121 lgorrie 1.103 "Create a new input/output fd-stream for FD."
122 heller 1.157 (sys:make-fd-stream fd :input t :output t :element-type 'base-char
123     :buffering buffering))
124 lgorrie 1.103
125     ;;;;; Signal-driven I/O
126    
127 heller 1.59 (defvar *sigio-handlers* '()
128 lgorrie 1.103 "List of (key . function) pairs.
129     All functions are called on SIGIO, and the key is used for removing
130     specific functions.")
131 heller 1.59
132     (defun set-sigio-handler ()
133 heller 1.101 (sys:enable-interrupt :sigio (lambda (signal code scp)
134     (sigio-handler signal code scp))))
135 heller 1.59
136 lgorrie 1.103 (defun sigio-handler (signal code scp)
137     (declare (ignore signal code scp))
138     (mapc #'funcall (mapcar #'cdr *sigio-handlers*)))
139    
140 heller 1.68 (defun fcntl (fd command arg)
141 lgorrie 1.103 "fcntl(2) - manipulate a file descriptor."
142 heller 1.68 (multiple-value-bind (ok error) (unix:unix-fcntl fd command arg)
143 lgorrie 1.103 (unless ok (error "fcntl: ~A" (unix:get-unix-error-msg error)))))
144 heller 1.68
145     (defimplementation add-sigio-handler (socket fn)
146     (set-sigio-handler)
147 heller 1.59 (let ((fd (socket-fd socket)))
148 heller 1.68 (fcntl fd unix:f-setown (unix:unix-getpid))
149 heller 1.92 (fcntl fd unix:f-setfl unix:fasync)
150 heller 1.68 (push (cons fd fn) *sigio-handlers*)))
151 lgorrie 1.45
152 heller 1.68 (defimplementation remove-sigio-handlers (socket)
153 heller 1.59 (let ((fd (socket-fd socket)))
154 lgorrie 1.103 (setf *sigio-handlers* (remove fd *sigio-handlers* :key #'car))
155 heller 1.159 (sys:invalidate-descriptor fd)))
156 heller 1.50
157 lgorrie 1.103 ;;;;; SERVE-EVENT
158    
159 heller 1.68 (defimplementation add-fd-handler (socket fn)
160     (let ((fd (socket-fd socket)))
161 heller 1.154 (sys:add-fd-handler fd :input (lambda (_) _ (funcall fn)))))
162 heller 1.68
163     (defimplementation remove-fd-handlers (socket)
164     (sys:invalidate-descriptor (socket-fd socket)))
165    
166 lgorrie 1.103
167     ;;;; Stream handling
168     ;;; XXX: How come we don't use Gray streams in CMUCL too? -luke (15/May/2004)
169    
170 lgorrie 1.56 (defimplementation make-fn-streams (input-fn output-fn)
171 lgorrie 1.45 (let* ((output (make-slime-output-stream output-fn))
172     (input (make-slime-input-stream input-fn output)))
173     (values input output)))
174 lgorrie 1.25
175 dbarlow 1.1 (defstruct (slime-output-stream
176 lgorrie 1.45 (:include lisp::lisp-stream
177     (lisp::misc #'sos/misc)
178     (lisp::out #'sos/out)
179     (lisp::sout #'sos/sout))
180     (:conc-name sos.)
181     (:print-function %print-slime-output-stream)
182     (:constructor make-slime-output-stream (output-fn)))
183     (output-fn nil :type function)
184 heller 1.154 (buffer (make-string 8000) :type string)
185 heller 1.16 (index 0 :type kernel:index)
186 heller 1.154 (column 0 :type kernel:index)
187 heller 1.155 (last-flush-time (get-internal-real-time) :type unsigned-byte))
188 heller 1.16
189 heller 1.17 (defun %print-slime-output-stream (s stream d)
190     (declare (ignore d))
191     (print-unreadable-object (s stream :type t :identity t)))
192    
193 heller 1.16 (defun sos/out (stream char)
194 heller 1.157 (system:without-interrupts
195     (let ((buffer (sos.buffer stream))
196     (index (sos.index stream)))
197     (setf (schar buffer index) char)
198     (setf (sos.index stream) (1+ index))
199     (incf (sos.column stream))
200     (when (char= #\newline char)
201     (setf (sos.column stream) 0)
202     (force-output stream))
203     (when (= index (1- (length buffer)))
204     (finish-output stream)))
205     char))
206 heller 1.16
207     (defun sos/sout (stream string start end)
208 heller 1.157 (system:without-interrupts
209     (loop for i from start below end
210     do (sos/out stream (aref string i)))))
211 lgorrie 1.45
212 heller 1.154 (defun log-stream-op (stream operation)
213     stream operation
214     #+(or)
215     (progn
216     (format sys:*tty* "~S @ ~D ~A~%" operation
217     (sos.index stream)
218     (/ (- (get-internal-real-time) (sos.last-flush-time stream))
219     (coerce internal-time-units-per-second 'double-float)))
220     (finish-output sys:*tty*)))
221    
222 heller 1.16 (defun sos/misc (stream operation &optional arg1 arg2)
223     (declare (ignore arg1 arg2))
224 dbarlow 1.1 (case operation
225 heller 1.154 (:finish-output
226     (log-stream-op stream operation)
227 heller 1.157 (system:without-interrupts
228     (let ((end (sos.index stream)))
229     (unless (zerop end)
230     (let ((s (subseq (sos.buffer stream) 0 end)))
231     (setf (sos.index stream) 0)
232     (funcall (sos.output-fn stream) s))
233     (setf (sos.last-flush-time stream) (get-internal-real-time)))))
234 heller 1.154 nil)
235     (:force-output
236     (log-stream-op stream operation)
237 heller 1.156 (sos/misc-force-output stream)
238 heller 1.154 nil)
239 heller 1.16 (:charpos (sos.column stream))
240     (:line-length 75)
241 dbarlow 1.1 (:file-position nil)
242 heller 1.16 (:element-type 'base-char)
243     (:get-command nil)
244 heller 1.22 (:close nil)
245 heller 1.16 (t (format *terminal-io* "~&~Astream: ~S~%" stream operation))))
246 dbarlow 1.1
247 heller 1.156 (defun sos/misc-force-output (stream)
248 heller 1.157 (system:without-interrupts
249     (unless (or (zerop (sos.index stream))
250     (loop with buffer = (sos.buffer stream)
251     for i from 0 below (sos.index stream)
252     always (char= (aref buffer i) #\newline)))
253     (let ((last (sos.last-flush-time stream))
254     (now (get-internal-real-time)))
255     (when (> (/ (- now last)
256     (coerce internal-time-units-per-second 'double-float))
257     0.1)
258     (finish-output stream))))))
259 heller 1.156
260 heller 1.9 (defstruct (slime-input-stream
261 lgorrie 1.45 (:include string-stream
262     (lisp::in #'sis/in)
263     (lisp::misc #'sis/misc))
264     (:conc-name sis.)
265     (:print-function %print-slime-output-stream)
266     (:constructor make-slime-input-stream (input-fn sos)))
267     (input-fn nil :type function)
268     ;; We know our sibling output stream, so that we can force it before
269     ;; requesting input.
270     (sos nil :type slime-output-stream)
271     (buffer "" :type string)
272     (index 0 :type kernel:index))
273 heller 1.16
274     (defun sis/in (stream eof-errorp eof-value)
275 heller 1.156 (finish-output (sis.sos stream))
276 heller 1.16 (let ((index (sis.index stream))
277     (buffer (sis.buffer stream)))
278     (when (= index (length buffer))
279 heller 1.119 (let ((string (funcall (sis.input-fn stream))))
280     (cond ((zerop (length string))
281     (return-from sis/in
282     (if eof-errorp
283     (error (make-condition 'end-of-file :stream stream))
284     eof-value)))
285     (t
286     (setf buffer string)
287     (setf (sis.buffer stream) buffer)
288     (setf index 0)))))
289 heller 1.16 (prog1 (aref buffer index)
290     (setf (sis.index stream) (1+ index)))))
291 heller 1.9
292 heller 1.16 (defun sis/misc (stream operation &optional arg1 arg2)
293 heller 1.14 (declare (ignore arg2))
294 heller 1.15 (ecase operation
295     (:file-position nil)
296 heller 1.16 (:file-length nil)
297     (:unread (setf (aref (sis.buffer stream)
298     (decf (sis.index stream)))
299     arg1))
300 heller 1.57 (:clear-input
301     (setf (sis.index stream) 0
302 heller 1.16 (sis.buffer stream) ""))
303     (:listen (< (sis.index stream) (length (sis.buffer stream))))
304     (:charpos nil)
305     (:line-length nil)
306     (:get-command nil)
307 heller 1.22 (:element-type 'base-char)
308 heller 1.149 (:close nil)
309     (:interactive-p t)))
310 heller 1.16
311 lgorrie 1.25
312 dbarlow 1.1 ;;;; Compilation Commands
313    
314 lgorrie 1.24 (defvar *previous-compiler-condition* nil
315     "Used to detect duplicates.")
316    
317     (defvar *previous-context* nil
318     "Previous compiler error context.")
319    
320 lgorrie 1.103 (defvar *buffer-name* nil
321     "The name of the Emacs buffer we are compiling from.
322     NIL if we aren't compiling from a buffer.")
323    
324 heller 1.30 (defvar *buffer-start-position* nil)
325     (defvar *buffer-substring* nil)
326    
327 lgorrie 1.103 (defimplementation call-with-compilation-hooks (function)
328     (let ((*previous-compiler-condition* nil)
329     (*previous-context* nil)
330     (*print-readably* nil))
331     (handler-bind ((c::compiler-error #'handle-notification-condition)
332     (c::style-warning #'handle-notification-condition)
333     (c::warning #'handle-notification-condition))
334     (funcall function))))
335    
336 heller 1.167 (defimplementation swank-compile-file (filename load-p external-format)
337 heller 1.150 (declare (ignore external-format))
338 lgorrie 1.103 (clear-xref-info filename)
339     (with-compilation-hooks ()
340 heller 1.127 (let ((*buffer-name* nil)
341     (ext:*ignore-extra-close-parentheses* nil))
342 lgorrie 1.103 (multiple-value-bind (output-file warnings-p failure-p)
343 heller 1.125 (compile-file filename)
344 lgorrie 1.103 (unless failure-p
345     ;; Cache the latest source file for definition-finding.
346 heller 1.125 (source-cache-get filename (file-write-date filename))
347 heller 1.130 (when load-p (load output-file)))
348 lgorrie 1.103 (values output-file warnings-p failure-p)))))
349    
350 pseibel 1.113 (defimplementation swank-compile-string (string &key buffer position directory)
351     (declare (ignore directory))
352 lgorrie 1.103 (with-compilation-hooks ()
353     (let ((*buffer-name* buffer)
354     (*buffer-start-position* position)
355     (*buffer-substring* string))
356     (with-input-from-string (stream string)
357     (ext:compile-from-stream
358     stream
359     :source-info `(:emacs-buffer ,buffer
360     :emacs-buffer-offset ,position
361     :emacs-buffer-string ,string))))))
362    
363 lgorrie 1.25
364 lgorrie 1.24 ;;;;; Trapping notes
365 lgorrie 1.103 ;;;
366     ;;; We intercept conditions from the compiler and resignal them as
367     ;;; `SWANK:COMPILER-CONDITION's.
368 lgorrie 1.24
369     (defun handle-notification-condition (condition)
370 lgorrie 1.103 "Handle a condition caused by a compiler warning."
371 dbarlow 1.1 (unless (eq condition *previous-compiler-condition*)
372 heller 1.65 (let ((context (c::find-error-context nil)))
373 dbarlow 1.1 (setq *previous-compiler-condition* condition)
374     (setq *previous-context* context)
375 lgorrie 1.24 (signal-compiler-condition condition context))))
376    
377     (defun signal-compiler-condition (condition context)
378     (signal (make-condition
379     'compiler-condition
380     :original-condition condition
381     :severity (severity-for-emacs condition)
382 heller 1.65 :short-message (brief-compiler-message-for-emacs condition)
383     :message (long-compiler-message-for-emacs condition context)
384 heller 1.127 :location (if (read-error-p condition)
385 heller 1.125 (read-error-location condition)
386     (compiler-note-location context)))))
387 lgorrie 1.24
388     (defun severity-for-emacs (condition)
389     "Return the severity of CONDITION."
390     (etypecase condition
391 heller 1.127 ((satisfies read-error-p) :read-error)
392 lgorrie 1.24 (c::compiler-error :error)
393     (c::style-warning :note)
394     (c::warning :warning)))
395    
396 heller 1.127 (defun read-error-p (condition)
397     (eq (type-of condition) 'c::compiler-read-error))
398    
399 heller 1.65 (defun brief-compiler-message-for-emacs (condition)
400 lgorrie 1.24 "Briefly describe a compiler error for Emacs.
401     When Emacs presents the message it already has the source popped up
402     and the source form highlighted. This makes much of the information in
403     the error-context redundant."
404 heller 1.65 (princ-to-string condition))
405    
406     (defun long-compiler-message-for-emacs (condition error-context)
407     "Describe a compiler error for Emacs including context information."
408 lgorrie 1.24 (declare (type (or c::compiler-error-context null) error-context))
409 heller 1.30 (multiple-value-bind (enclosing source)
410     (if error-context
411     (values (c::compiler-error-context-enclosing-source error-context)
412     (c::compiler-error-context-source error-context)))
413     (format nil "~@[--> ~{~<~%--> ~1:;~A~> ~}~%~]~@[~{==>~%~A~^~%~}~]~A"
414     enclosing source condition)))
415 heller 1.125
416     (defun read-error-location (condition)
417     (let* ((finfo (car (c::source-info-current-file c::*source-info*)))
418     (file (c::file-info-name finfo))
419     (pos (c::compiler-read-error-position condition)))
420     (cond ((and (eq file :stream) *buffer-name*)
421     (make-location (list :buffer *buffer-name*)
422 heller 1.127 (list :position (+ *buffer-start-position* pos))))
423 heller 1.125 ((and (pathnamep file) (not *buffer-name*))
424     (make-location (list :file (unix-truename file))
425 heller 1.127 (list :position (1+ pos))))
426 heller 1.125 (t (break)))))
427 heller 1.30
428     (defun compiler-note-location (context)
429 lgorrie 1.103 "Derive the location of a complier message from its context.
430     Return a `location' record, or (:error REASON) on failure."
431     (if (null context)
432     (note-error-location)
433     (let ((file (c::compiler-error-context-file-name context))
434     (source (c::compiler-error-context-original-source context))
435     (path
436     (reverse (c::compiler-error-context-original-source-path context))))
437     (or (locate-compiler-note file source path)
438     (note-error-location)))))
439    
440     (defun note-error-location ()
441     "Pseudo-location for notes that can't be located."
442     (list :error "No error location available."))
443    
444     (defun locate-compiler-note (file source source-path)
445     (cond ((and (eq file :stream) *buffer-name*)
446     ;; Compiling from a buffer
447     (let ((position (+ *buffer-start-position*
448     (source-path-string-position
449     source-path *buffer-substring*))))
450     (make-location (list :buffer *buffer-name*)
451     (list :position position))))
452     ((and (pathnamep file) (null *buffer-name*))
453     ;; Compiling from a file
454     (make-location (list :file (unix-truename file))
455     (list :position
456     (1+ (source-path-file-position
457     source-path file)))))
458     ((and (eq file :lisp) (stringp source))
459     ;; No location known, but we have the source form.
460 heller 1.112 ;; XXX How is this case triggered? -luke (16/May/2004)
461     ;; This can happen if the compiler needs to expand a macro
462     ;; but the macro-expander is not yet compiled. Calling the
463     ;; (interpreted) macro-expander triggers IR1 conversion of
464     ;; the lambda expression for the expander and invokes the
465     ;; compiler recursively.
466 lgorrie 1.103 (make-location (list :source-form source)
467     (list :position 1)))))
468 heller 1.30
469 lgorrie 1.103 (defun unix-truename (pathname)
470     (ext:unix-namestring (truename pathname)))
471 dbarlow 1.1
472 lgorrie 1.25
473     ;;;; XREF
474 lgorrie 1.103 ;;;
475     ;;; Cross-reference support is based on the standard CMUCL `XREF'
476     ;;; package. This package has some caveats: XREF information is
477     ;;; recorded during compilation and not preserved in fasl files, and
478     ;;; XREF recording is disabled by default. Redefining functions can
479     ;;; also cause duplicate references to accumulate, but
480     ;;; `swank-compile-file' will automatically clear out any old records
481     ;;; from the same filename.
482     ;;;
483     ;;; To enable XREF recording, set `c:*record-xref-info*' to true. To
484     ;;; clear out the XREF database call `xref:init-xref-database'.
485 dbarlow 1.1
486 heller 1.81 (defmacro defxref (name function)
487     `(defimplementation ,name (name)
488 heller 1.82 (xref-results (,function name))))
489 heller 1.81
490     (defxref who-calls xref:who-calls)
491     (defxref who-references xref:who-references)
492     (defxref who-binds xref:who-binds)
493     (defxref who-sets xref:who-sets)
494 dbarlow 1.1
495 lgorrie 1.103 ;;; More types of XREF information were added since 18e:
496     ;;;
497 lgorrie 1.10 #+cmu19
498 heller 1.32 (progn
499 heller 1.81 (defxref who-macroexpands xref:who-macroexpands)
500     ;; XXX
501     (defimplementation who-specializes (symbol)
502     (let* ((methods (xref::who-specializes (find-class symbol)))
503 heller 1.86 (locations (mapcar #'method-location methods)))
504 heller 1.81 (mapcar #'list methods locations))))
505    
506     (defun xref-results (contexts)
507     (mapcar (lambda (xref)
508     (list (xref:xref-context-name xref)
509     (resolve-xref-location xref)))
510     contexts))
511 heller 1.30
512     (defun resolve-xref-location (xref)
513     (let ((name (xref:xref-context-name xref))
514     (file (xref:xref-context-file xref))
515     (source-path (xref:xref-context-source-path xref)))
516     (cond ((and file source-path)
517     (let ((position (source-path-file-position source-path file)))
518     (make-location (list :file (unix-truename file))
519     (list :position (1+ position)))))
520     (file
521     (make-location (list :file (unix-truename file))
522     (list :function-name (string name))))
523     (t
524 lgorrie 1.99 `(:error ,(format nil "Unknown source location: ~S ~S ~S "
525 heller 1.30 name file source-path))))))
526    
527 lgorrie 1.25 (defun clear-xref-info (namestring)
528 heller 1.66 "Clear XREF notes pertaining to NAMESTRING.
529 lgorrie 1.25 This is a workaround for a CMUCL bug: XREF records are cumulative."
530 heller 1.65 (when c:*record-xref-info*
531 heller 1.66 (let ((filename (truename namestring)))
532 lgorrie 1.25 (dolist (db (list xref::*who-calls*
533     #+cmu19 xref::*who-is-called*
534     #+cmu19 xref::*who-macroexpands*
535     xref::*who-references*
536     xref::*who-binds*
537     xref::*who-sets*))
538     (maphash (lambda (target contexts)
539 heller 1.66 ;; XXX update during traversal?
540 lgorrie 1.25 (setf (gethash target db)
541 heller 1.66 (delete filename contexts
542     :key #'xref:xref-context-file
543     :test #'equalp)))
544 lgorrie 1.25 db)))))
545    
546    
547     ;;;; Find callers and callees
548 lgorrie 1.103 ;;;
549 dbarlow 1.1 ;;; Find callers and callees by looking at the constant pool of
550     ;;; compiled code objects. We assume every fdefn object in the
551     ;;; constant pool corresponds to a call to that function. A better
552     ;;; strategy would be to use the disassembler to find actual
553     ;;; call-sites.
554    
555     (declaim (inline map-code-constants))
556     (defun map-code-constants (code fn)
557     "Call FN for each constant in CODE's constant pool."
558     (check-type code kernel:code-component)
559     (loop for i from vm:code-constants-offset below (kernel:get-header-data code)
560     do (funcall fn (kernel:code-header-ref code i))))
561    
562     (defun function-callees (function)
563 heller 1.30 "Return FUNCTION's callees as a list of functions."
564 dbarlow 1.1 (let ((callees '()))
565     (map-code-constants
566     (vm::find-code-object function)
567     (lambda (obj)
568     (when (kernel:fdefn-p obj)
569 heller 1.30 (push (kernel:fdefn-function obj) callees))))
570 dbarlow 1.1 callees))
571    
572 heller 1.19 (declaim (ext:maybe-inline map-allocated-code-components))
573 dbarlow 1.1 (defun map-allocated-code-components (spaces fn)
574     "Call FN for each allocated code component in one of SPACES. FN
575 heller 1.19 receives the object as argument. SPACES should be a list of the
576     symbols :dynamic, :static, or :read-only."
577 dbarlow 1.1 (dolist (space spaces)
578 heller 1.119 (declare (inline vm::map-allocated-objects)
579     (optimize (ext:inhibit-warnings 3)))
580 dbarlow 1.1 (vm::map-allocated-objects
581     (lambda (obj header size)
582 heller 1.19 (declare (type fixnum size) (ignore size))
583 dbarlow 1.1 (when (= vm:code-header-type header)
584 heller 1.19 (funcall fn obj)))
585 dbarlow 1.1 space)))
586    
587 heller 1.19 (declaim (ext:maybe-inline map-caller-code-components))
588 dbarlow 1.1 (defun map-caller-code-components (function spaces fn)
589     "Call FN for each code component with a fdefn for FUNCTION in its
590     constant pool."
591     (let ((function (coerce function 'function)))
592 heller 1.19 (declare (inline map-allocated-code-components))
593 dbarlow 1.1 (map-allocated-code-components
594     spaces
595 heller 1.19 (lambda (obj)
596 dbarlow 1.1 (map-code-constants
597     obj
598     (lambda (constant)
599     (when (and (kernel:fdefn-p constant)
600     (eq (kernel:fdefn-function constant)
601     function))
602     (funcall fn obj))))))))
603    
604     (defun function-callers (function &optional (spaces '(:read-only :static
605     :dynamic)))
606 heller 1.30 "Return FUNCTION's callers. The result is a list of code-objects."
607 dbarlow 1.1 (let ((referrers '()))
608 heller 1.19 (declare (inline map-caller-code-components))
609 heller 1.108 ;;(ext:gc :full t)
610 heller 1.30 (map-caller-code-components function spaces
611     (lambda (code) (push code referrers)))
612 dbarlow 1.1 referrers))
613 heller 1.80
614 heller 1.30 (defun debug-info-definitions (debug-info)
615     "Return the defintions for a debug-info. This should only be used
616     for code-object without entry points, i.e., byte compiled
617     code (are theree others?)"
618     ;; This mess has only been tested with #'ext::skip-whitespace, a
619     ;; byte-compiled caller of #'read-char .
620     (check-type debug-info (and (not c::compiled-debug-info) c::debug-info))
621     (let ((name (c::debug-info-name debug-info))
622     (source (c::debug-info-source debug-info)))
623     (destructuring-bind (first) source
624     (ecase (c::debug-source-from first)
625     (:file
626 heller 1.80 (list (list name
627     (make-location
628     (list :file (unix-truename (c::debug-source-name first)))
629 heller 1.119 (list :function-name (string name))))))))))
630 heller 1.30
631     (defun code-component-entry-points (code)
632 heller 1.80 "Return a list ((NAME LOCATION) ...) of function definitons for
633 heller 1.30 the code omponent CODE."
634 heller 1.122 (let ((names '()))
635     (do ((f (kernel:%code-entry-points code) (kernel::%function-next f)))
636     ((not f))
637     (let ((name (kernel:%function-name f)))
638     (when (ext:valid-function-name-p name)
639     (push (list name (function-location f)) names))))
640     names))
641 dbarlow 1.1
642 heller 1.80 (defimplementation list-callers (symbol)
643     "Return a list ((NAME LOCATION) ...) of callers."
644     (let ((components (function-callers symbol))
645 heller 1.30 (xrefs '()))
646     (dolist (code components)
647     (let* ((entry (kernel:%code-entry-points code))
648     (defs (if entry
649     (code-component-entry-points code)
650     ;; byte compiled stuff
651     (debug-info-definitions
652     (kernel:%code-debug-info code)))))
653     (setq xrefs (nconc defs xrefs))))
654 heller 1.80 xrefs))
655 dbarlow 1.1
656 heller 1.80 (defimplementation list-callees (symbol)
657     (let ((fns (function-callees symbol)))
658     (mapcar (lambda (fn)
659     (list (kernel:%function-name fn)
660 heller 1.86 (function-location fn)))
661 heller 1.80 fns)))
662 dbarlow 1.1
663 lgorrie 1.42
664 lgorrie 1.103 ;;;; Resolving source locations
665     ;;;
666     ;;; Our mission here is to "resolve" references to code locations into
667     ;;; actual file/buffer names and character positions. The references
668     ;;; we work from come out of the compiler's statically-generated debug
669     ;;; information, such as `code-location''s and `debug-source''s. For
670     ;;; more details, see the "Debugger Programmer's Interface" section of
671     ;;; the CMUCL manual.
672     ;;;
673     ;;; The first step is usually to find the corresponding "source-path"
674     ;;; for the location. Once we have the source-path we can pull up the
675     ;;; source file and `READ' our way through to the right position. The
676     ;;; main source-code groveling work is done in
677     ;;; `swank-source-path-parser.lisp'.
678 dbarlow 1.1
679 lgorrie 1.35 (defvar *debug-definition-finding* nil
680 dbarlow 1.1 "When true don't handle errors while looking for definitions.
681     This is useful when debugging the definition-finding code.")
682    
683 lgorrie 1.99 (defvar *source-snippet-size* 256
684     "Maximum number of characters in a snippet of source code.
685     Snippets at the beginning of definitions are used to tell Emacs what
686     the definitions looks like, so that it can accurately find them by
687     text search.")
688    
689 lgorrie 1.103 (defmacro safe-definition-finding (&body body)
690     "Execute BODY and return the source-location it returns.
691     If an error occurs and `*debug-definition-finding*' is false, then
692     return an error pseudo-location.
693    
694     The second return value is NIL if no error occurs, otherwise it is the
695     condition object."
696     `(flet ((body () ,@body))
697     (if *debug-definition-finding*
698     (body)
699     (handler-case (values (progn ,@body) nil)
700 heller 1.172 (error (c) (values `(:error ,(trim-whitespace (princ-to-string c)))
701     c))))))
702    
703     (defun trim-whitespace (string)
704     (string-trim #(#\newline #\space #\tab) string))
705 lgorrie 1.103
706     (defun code-location-source-location (code-location)
707     "Safe wrapper around `code-location-from-source-location'."
708     (safe-definition-finding
709     (source-location-from-code-location code-location)))
710    
711     (defun source-location-from-code-location (code-location)
712     "Return the source location for CODE-LOCATION."
713     (let ((debug-fun (di:code-location-debug-function code-location)))
714     (when (di::bogus-debug-function-p debug-fun)
715     ;; Those lousy cheapskates! They've put in a bogus debug source
716     ;; because the code was compiled at a low debug setting.
717     (error "Bogus debug function: ~A" debug-fun)))
718     (let* ((debug-source (di:code-location-debug-source code-location))
719     (from (di:debug-source-from debug-source))
720     (name (di:debug-source-name debug-source)))
721     (ecase from
722     (:file
723     (location-in-file name code-location debug-source))
724     (:stream
725     (location-in-stream code-location debug-source))
726     (:lisp
727     ;; The location comes from a form passed to `compile'.
728     ;; The best we can do is return the form itself for printing.
729     (make-location
730     (list :source-form (with-output-to-string (*standard-output*)
731     (debug::print-code-location-source-form
732     code-location 100 t)))
733     (list :position 1))))))
734    
735     (defun location-in-file (filename code-location debug-source)
736     "Resolve the source location for CODE-LOCATION in FILENAME."
737     (let* ((code-date (di:debug-source-created debug-source))
738 lgorrie 1.141 (source-code (get-source-code filename code-date)))
739 lgorrie 1.103 (with-input-from-string (s source-code)
740     (make-location (list :file (unix-truename filename))
741 heller 1.142 (list :position (1+ (code-location-stream-position
742     code-location s)))
743 lgorrie 1.103 `(:snippet ,(read-snippet s))))))
744    
745     (defun location-in-stream (code-location debug-source)
746     "Resolve the source location for a CODE-LOCATION from a stream.
747     This only succeeds if the code was compiled from an Emacs buffer."
748     (unless (debug-source-info-from-emacs-buffer-p debug-source)
749     (error "The code is compiled from a non-SLIME stream."))
750     (let* ((info (c::debug-source-info debug-source))
751     (string (getf info :emacs-buffer-string))
752     (position (code-location-string-offset
753     code-location
754     string)))
755     (make-location
756     (list :buffer (getf info :emacs-buffer))
757     (list :position (+ (getf info :emacs-buffer-offset) position))
758     (list :snippet (with-input-from-string (s string)
759     (file-position s position)
760     (read-snippet s))))))
761    
762     ;;;;; Function-name locations
763     ;;;
764     (defun debug-info-function-name-location (debug-info)
765     "Return a function-name source-location for DEBUG-INFO.
766     Function-name source-locations are a fallback for when precise
767     positions aren't available."
768     (with-struct (c::debug-info- (fname name) source) debug-info
769     (with-struct (c::debug-source- info from name) (car source)
770     (ecase from
771     (:file
772     (make-location (list :file (namestring (truename name)))
773 heller 1.119 (list :function-name (string fname))))
774 lgorrie 1.103 (:stream
775     (assert (debug-source-info-from-emacs-buffer-p (car source)))
776     (make-location (list :buffer (getf info :emacs-buffer))
777 heller 1.119 (list :function-name (string fname))))
778 lgorrie 1.103 (:lisp
779     (make-location (list :source-form (princ-to-string (aref name 0)))
780     (list :position 1)))))))
781    
782     (defun debug-source-info-from-emacs-buffer-p (debug-source)
783     "Does the `info' slot of DEBUG-SOURCE contain an Emacs buffer location?
784     This is true for functions that were compiled directly from buffers."
785     (info-from-emacs-buffer-p (c::debug-source-info debug-source)))
786    
787     (defun info-from-emacs-buffer-p (info)
788     (and info
789     (consp info)
790     (eq :emacs-buffer (car info))))
791    
792    
793     ;;;;; Groveling source-code for positions
794    
795     (defun code-location-stream-position (code-location stream)
796     "Return the byte offset of CODE-LOCATION in STREAM. Extract the
797     toplevel-form-number and form-number from CODE-LOCATION and use that
798     to find the position of the corresponding form.
799    
800     Finish with STREAM positioned at the start of the code location."
801     (let* ((location (debug::maybe-block-start-location code-location))
802     (tlf-offset (di:code-location-top-level-form-offset location))
803     (form-number (di:code-location-form-number location)))
804     (let ((pos (form-number-stream-position tlf-offset form-number stream)))
805     (file-position stream pos)
806     pos)))
807    
808     (defun form-number-stream-position (tlf-number form-number stream)
809     "Return the starting character position of a form in STREAM.
810     TLF-NUMBER is the top-level-form number.
811     FORM-NUMBER is an index into a source-path table for the TLF."
812 heller 1.135 (multiple-value-bind (tlf position-map) (read-source-form tlf-number stream)
813     (let* ((path-table (di:form-number-translations tlf 0))
814     (source-path
815     (if (<= (length path-table) form-number) ; source out of sync?
816     (list 0) ; should probably signal a condition
817     (reverse (cdr (aref path-table form-number))))))
818     (source-path-source-position source-path tlf position-map))))
819 lgorrie 1.103
820     (defun code-location-string-offset (code-location string)
821     "Return the byte offset of CODE-LOCATION in STRING.
822     See CODE-LOCATION-STREAM-POSITION."
823     (with-input-from-string (s string)
824     (code-location-stream-position code-location s)))
825 lgorrie 1.110
826 lgorrie 1.103
827     ;;;; Finding definitions
828    
829     ;;; There are a great many different types of definition for us to
830     ;;; find. We search for definitions of every kind and return them in a
831     ;;; list.
832    
833     (defimplementation find-definitions (name)
834     (append (function-definitions name)
835     (setf-definitions name)
836     (variable-definitions name)
837     (class-definitions name)
838     (type-definitions name)
839     (compiler-macro-definitions name)
840     (source-transform-definitions name)
841     (function-info-definitions name)
842     (ir1-translator-definitions name)))
843    
844     ;;;;; Functions, macros, generic functions, methods
845     ;;;
846     ;;; We make extensive use of the compile-time debug information that
847     ;;; CMUCL records, in particular "debug functions" and "code
848     ;;; locations." Refer to the "Debugger Programmer's Interface" section
849     ;;; of the CMUCL manual for more details.
850    
851     (defun function-definitions (name)
852     "Return definitions for NAME in the \"function namespace\", i.e.,
853     regular functions, generic functions, methods and macros.
854     NAME can any valid function name (e.g, (setf car))."
855     (let ((macro? (and (symbolp name) (macro-function name)))
856     (special? (and (symbolp name) (special-operator-p name)))
857     (function? (and (ext:valid-function-name-p name)
858 heller 1.140 (ext:info :function :definition name)
859     (if (symbolp name) (fboundp name) t))))
860 lgorrie 1.103 (cond (macro?
861     (list `((defmacro ,name)
862     ,(function-location (macro-function name)))))
863     (special?
864     (list `((:special-operator ,name)
865     (:error ,(format nil "Special operator: ~S" name)))))
866     (function?
867     (let ((function (fdefinition name)))
868     (if (genericp function)
869     (generic-function-definitions name function)
870     (list (list `(function ,name)
871     (function-location function)))))))))
872    
873     ;;;;;; Ordinary (non-generic/macro/special) functions
874     ;;;
875     ;;; First we test if FUNCTION is a closure created by defstruct, and
876     ;;; if so extract the defstruct-description (`dd') from the closure
877     ;;; and find the constructor for the struct. Defstruct creates a
878     ;;; defun for the default constructor and we use that as an
879     ;;; approximation to the source location of the defstruct.
880     ;;;
881     ;;; For an ordinary function we return the source location of the
882     ;;; first code-location we find.
883     ;;;
884     (defun function-location (function)
885     "Return the source location for FUNCTION."
886     (cond ((struct-closure-p function)
887     (struct-closure-location function))
888     ((c::byte-function-or-closure-p function)
889     (byte-function-location function))
890     (t
891     (compiled-function-location function))))
892 lgorrie 1.100
893 lgorrie 1.103 (defun compiled-function-location (function)
894     "Return the location of a regular compiled function."
895     (multiple-value-bind (code-location error)
896     (safe-definition-finding (function-first-code-location function))
897     (cond (error (list :error (princ-to-string error)))
898     (t (code-location-source-location code-location)))))
899 heller 1.88
900 dbarlow 1.1 (defun function-first-code-location (function)
901 lgorrie 1.103 "Return the first code-location we can find for FUNCTION."
902 dbarlow 1.1 (and (function-has-debug-function-p function)
903     (di:debug-function-start-location
904     (di:function-debug-function function))))
905    
906     (defun function-has-debug-function-p (function)
907     (di:function-debug-function function))
908    
909     (defun function-code-object= (closure function)
910     (and (eq (vm::find-code-object closure)
911     (vm::find-code-object function))
912     (not (eq closure function))))
913    
914 heller 1.175 (defun byte-function-location (fun)
915     "Return the location of the byte-compiled function FUN."
916     (etypecase fun
917 lgorrie 1.103 ((or c::hairy-byte-function c::simple-byte-function)
918 heller 1.175 (let* ((di (kernel:%code-debug-info (c::byte-function-component fun))))
919     (if di
920     (debug-info-function-name-location di)
921     `(:error
922     ,(format nil "Byte-function without debug-info: ~a" fun)))))
923 lgorrie 1.103 (c::byte-closure
924 heller 1.175 (byte-function-location (c::byte-closure-function fun)))))
925 lgorrie 1.103
926     ;;; Here we deal with structure accessors. Note that `dd' is a
927     ;;; "defstruct descriptor" structure in CMUCL. A `dd' describes a
928     ;;; `defstruct''d structure.
929 heller 1.83
930 heller 1.4 (defun struct-closure-p (function)
931 lgorrie 1.103 "Is FUNCTION a closure created by defstruct?"
932 heller 1.4 (or (function-code-object= function #'kernel::structure-slot-accessor)
933     (function-code-object= function #'kernel::structure-slot-setter)
934     (function-code-object= function #'kernel::%defstruct)))
935 dbarlow 1.1
936 lgorrie 1.103 (defun struct-closure-location (function)
937     "Return the location of the structure that FUNCTION belongs to."
938     (assert (struct-closure-p function))
939     (safe-definition-finding
940     (dd-location (struct-closure-dd function))))
941    
942 heller 1.4 (defun struct-closure-dd (function)
943 lgorrie 1.103 "Return the defstruct-definition (dd) of FUNCTION."
944 dbarlow 1.1 (assert (= (kernel:get-type function) vm:closure-header-type))
945 heller 1.4 (flet ((find-layout (function)
946     (sys:find-if-in-closure
947     (lambda (x)
948 heller 1.18 (let ((value (if (di::indirect-value-cell-p x)
949     (c:value-cell-ref x)
950     x)))
951     (when (kernel::layout-p value)
952     (return-from find-layout value))))
953 heller 1.4 function)))
954     (kernel:layout-info (find-layout function))))
955 lgorrie 1.103
956 heller 1.86 (defun dd-location (dd)
957 lgorrie 1.103 "Return the location of a `defstruct'."
958     ;; Find the location in a constructor.
959     (function-location (struct-constructor dd)))
960    
961     (defun struct-constructor (dd)
962     "Return a constructor function from a defstruct definition.
963     Signal an error if no constructor can be found."
964 dbarlow 1.1 (let ((constructor (or (kernel:dd-default-constructor dd)
965 heller 1.32 (car (kernel::dd-constructors dd)))))
966 lgorrie 1.103 (when (or (null constructor)
967     (and (consp constructor) (null (car constructor))))
968     (error "Cannot find structure's constructor: ~S"
969 heller 1.32 (kernel::dd-name dd)))
970 lgorrie 1.103 (coerce (if (consp constructor) (first constructor) constructor)
971     'function)))
972    
973     ;;;;;; Generic functions and methods
974 dbarlow 1.1
975 lgorrie 1.103 (defun generic-function-definitions (name function)
976     "Return the definitions of a generic function and its methods."
977     (cons (list `(defgeneric ,name) (gf-location function))
978     (gf-method-definitions function)))
979    
980     (defun gf-location (gf)
981     "Return the location of the generic function GF."
982     (definition-source-location gf (pcl::generic-function-name gf)))
983 heller 1.101
984 lgorrie 1.103 (defun gf-method-definitions (gf)
985     "Return the locations of all methods of the generic function GF."
986     (mapcar #'method-definition (pcl::generic-function-methods gf)))
987 heller 1.83
988 lgorrie 1.103 (defun method-definition (method)
989     (list (method-dspec method)
990     (method-location method)))
991 heller 1.83
992     (defun method-dspec (method)
993 lgorrie 1.103 "Return a human-readable \"definition specifier\" for METHOD."
994 heller 1.83 (let* ((gf (pcl:method-generic-function method))
995     (name (pcl:generic-function-name gf))
996 heller 1.92 (specializers (pcl:method-specializers method))
997     (qualifiers (pcl:method-qualifiers method)))
998     `(method ,name ,@qualifiers ,(pcl::unparse-specializers specializers))))
999 heller 1.83
1000 lgorrie 1.103 ;; XXX maybe special case setters/getters
1001     (defun method-location (method)
1002     (function-location (or (pcl::method-fast-function method)
1003     (pcl:method-function method))))
1004 heller 1.83
1005 lgorrie 1.103 (defun genericp (fn)
1006     (typep fn 'generic-function))
1007 dbarlow 1.1
1008 lgorrie 1.105 ;;;;;; Types and classes
1009    
1010     (defun type-definitions (name)
1011     "Return `deftype' locations for type NAME."
1012     (maybe-make-definition (ext:info :type :expander name) 'deftype name))
1013    
1014 heller 1.88 (defun maybe-make-definition (function kind name)
1015 lgorrie 1.105 "If FUNCTION is non-nil then return its definition location."
1016 heller 1.87 (if function
1017 heller 1.88 (list (list `(,kind ,name) (function-location function)))))
1018 heller 1.87
1019 lgorrie 1.105 (defun class-definitions (name)
1020     "Return the definition locations for the class called NAME."
1021     (if (symbolp name)
1022     (let ((class (kernel::find-class name nil)))
1023     (etypecase class
1024     (null '())
1025     (kernel::structure-class
1026     (list (list `(defstruct ,name) (dd-location (find-dd name)))))
1027     #+(or)
1028     (conditions::condition-class
1029     (list (list `(define-condition ,name)
1030     (condition-class-location class))))
1031     (kernel::standard-class
1032     (list (list `(defclass ,name)
1033     (class-location (find-class name)))))
1034     ((or kernel::built-in-class
1035     conditions::condition-class
1036     kernel:funcallable-structure-class)
1037     (list (list `(kernel::define-type-class ,name)
1038     `(:error
1039     ,(format nil "No source info for ~A" name)))))))))
1040    
1041     (defun class-location (class)
1042     "Return the `defclass' location for CLASS."
1043     (definition-source-location class (pcl:class-name class)))
1044 heller 1.86
1045     (defun find-dd (name)
1046 lgorrie 1.105 "Find the defstruct-definition by the name of its structure-class."
1047 heller 1.86 (let ((layout (ext:info :type :compiler-layout name)))
1048     (if layout
1049     (kernel:layout-info layout))))
1050    
1051 heller 1.92 (defun condition-class-location (class)
1052     (let ((slots (conditions::condition-class-slots class))
1053     (name (conditions::condition-class-name class)))
1054     (cond ((null slots)
1055     `(:error ,(format nil "No location info for condition: ~A" name)))
1056     (t
1057 lgorrie 1.105 ;; Find the class via one of its slot-reader methods.
1058 heller 1.92 (let* ((slot (first slots))
1059     (gf (fdefinition
1060     (first (conditions::condition-slot-readers slot)))))
1061     (method-location
1062     (first
1063     (pcl:compute-applicable-methods-using-classes
1064     gf (list (find-class name))))))))))
1065    
1066 heller 1.93 (defun make-name-in-file-location (file string)
1067     (multiple-value-bind (filename c)
1068     (ignore-errors
1069     (unix-truename (merge-pathnames (make-pathname :type "lisp")
1070     file)))
1071     (cond (filename (make-location `(:file ,filename)
1072 heller 1.119 `(:function-name ,(string string))))
1073 heller 1.93 (t (list :error (princ-to-string c))))))
1074 heller 1.92
1075 heller 1.95 (defun source-location-form-numbers (location)
1076     (c::decode-form-numbers (c::form-numbers-form-numbers location)))
1077    
1078     (defun source-location-tlf-number (location)
1079     (nth-value 0 (source-location-form-numbers location)))
1080    
1081     (defun source-location-form-number (location)
1082     (nth-value 1 (source-location-form-numbers location)))
1083    
1084 heller 1.93 (defun resolve-file-source-location (location)
1085     (let ((filename (c::file-source-location-pathname location))
1086 heller 1.95 (tlf-number (source-location-tlf-number location))
1087     (form-number (source-location-form-number location)))
1088 heller 1.93 (with-open-file (s filename)
1089     (let ((pos (form-number-stream-position tlf-number form-number s)))
1090     (make-location `(:file ,(unix-truename filename))
1091     `(:position ,(1+ pos)))))))
1092    
1093 heller 1.95 (defun resolve-stream-source-location (location)
1094     (let ((info (c::stream-source-location-user-info location))
1095     (tlf-number (source-location-tlf-number location))
1096     (form-number (source-location-form-number location)))
1097 heller 1.93 ;; XXX duplication in frame-source-location
1098     (assert (info-from-emacs-buffer-p info))
1099     (destructuring-bind (&key emacs-buffer emacs-buffer-string
1100     emacs-buffer-offset) info
1101     (with-input-from-string (s emacs-buffer-string)
1102     (let ((pos (form-number-stream-position tlf-number form-number s)))
1103     (make-location `(:buffer ,emacs-buffer)
1104     `(:position ,(+ emacs-buffer-offset pos))))))))
1105    
1106 heller 1.102 ;; XXX predicates for 18e backward compatibilty. Remove them when
1107     ;; we're 19a only.
1108 heller 1.96 (defun file-source-location-p (object)
1109     (when (fboundp 'c::file-source-location-p)
1110     (c::file-source-location-p object)))
1111    
1112     (defun stream-source-location-p (object)
1113     (when (fboundp 'c::stream-source-location-p)
1114     (c::stream-source-location-p object)))
1115    
1116 heller 1.102 (defun source-location-p (object)
1117     (or (file-source-location-p object)
1118     (stream-source-location-p object)))
1119    
1120     (defun resolve-source-location (location)
1121     (etypecase location
1122     ((satisfies file-source-location-p)
1123     (resolve-file-source-location location))
1124     ((satisfies stream-source-location-p)
1125     (resolve-stream-source-location location))))
1126    
1127 heller 1.93 (defun definition-source-location (object name)
1128     (let ((source (pcl::definition-source object)))
1129     (etypecase source
1130     (null
1131     `(:error ,(format nil "No source info for: ~A" object)))
1132 heller 1.102 ((satisfies source-location-p)
1133     (resolve-source-location source))
1134 heller 1.93 (pathname
1135     (make-name-in-file-location source name))
1136     (cons
1137     (destructuring-bind ((dg name) pathname) source
1138     (declare (ignore dg))
1139     (etypecase pathname
1140     (pathname (make-name-in-file-location pathname (string name)))
1141     (null `(:error ,(format nil "Cannot resolve: ~S" source)))))))))
1142 heller 1.86
1143 heller 1.88 (defun setf-definitions (name)
1144     (let ((function (or (ext:info :setf :inverse name)
1145 heller 1.168 (ext:info :setf :expander name)
1146     (and (symbolp name)
1147     (fboundp `(setf ,name))
1148     (fdefinition `(setf ,name))))))
1149 heller 1.87 (if function
1150 heller 1.88 (list (list `(setf ,name)
1151 heller 1.87 (function-location (coerce function 'function)))))))
1152    
1153 heller 1.102
1154     (defun variable-location (symbol)
1155     (multiple-value-bind (location foundp)
1156     ;; XXX for 18e compatibilty. rewrite this when we drop 18e
1157     ;; support.
1158     (ignore-errors (eval `(ext:info :source-location :defvar ',symbol)))
1159     (if (and foundp location)
1160     (resolve-source-location location)
1161     `(:error ,(format nil "No source info for variable ~S" symbol)))))
1162    
1163     (defun variable-definitions (name)
1164     (if (symbolp name)
1165     (multiple-value-bind (kind recorded-p) (ext:info :variable :kind name)
1166     (if recorded-p
1167     (list (list `(variable ,kind ,name)
1168     (variable-location name)))))))
1169    
1170 heller 1.87 (defun compiler-macro-definitions (symbol)
1171     (maybe-make-definition (compiler-macro-function symbol)
1172     'define-compiler-macro
1173     symbol))
1174    
1175 heller 1.88 (defun source-transform-definitions (name)
1176     (maybe-make-definition (ext:info :function :source-transform name)
1177 heller 1.87 'c:def-source-transform
1178 heller 1.88 name))
1179 heller 1.87
1180 heller 1.88 (defun function-info-definitions (name)
1181     (let ((info (ext:info :function :info name)))
1182 heller 1.87 (if info
1183     (append (loop for transform in (c::function-info-transforms info)
1184 heller 1.88 collect (list `(c:deftransform ,name
1185 heller 1.87 ,(c::type-specifier
1186     (c::transform-type transform)))
1187     (function-location (c::transform-function
1188     transform))))
1189     (maybe-make-definition (c::function-info-derive-type info)
1190 heller 1.88 'c::derive-type name)
1191 heller 1.87 (maybe-make-definition (c::function-info-optimizer info)
1192 heller 1.88 'c::optimizer name)
1193 heller 1.87 (maybe-make-definition (c::function-info-ltn-annotate info)
1194 heller 1.88 'c::ltn-annotate name)
1195 heller 1.87 (maybe-make-definition (c::function-info-ir2-convert info)
1196 heller 1.88 'c::ir2-convert name)
1197 heller 1.87 (loop for template in (c::function-info-templates info)
1198     collect (list `(c::vop ,(c::template-name template))
1199     (function-location
1200     (c::vop-info-generator-function
1201     template))))))))
1202    
1203 heller 1.88 (defun ir1-translator-definitions (name)
1204     (maybe-make-definition (ext:info :function :ir1-convert name)
1205     'c:def-ir1-translator name))
1206    
1207 lgorrie 1.25
1208     ;;;; Documentation.
1209 dbarlow 1.1
1210 lgorrie 1.56 (defimplementation describe-symbol-for-emacs (symbol)
1211 dbarlow 1.1 (let ((result '()))
1212 lgorrie 1.24 (flet ((doc (kind)
1213     (or (documentation symbol kind) :not-documented))
1214     (maybe-push (property value)
1215     (when value
1216     (setf result (list* property value result)))))
1217 dbarlow 1.1 (maybe-push
1218     :variable (multiple-value-bind (kind recorded-p)
1219     (ext:info variable kind symbol)
1220     (declare (ignore kind))
1221     (if (or (boundp symbol) recorded-p)
1222     (doc 'variable))))
1223 heller 1.148 (when (fboundp symbol)
1224     (maybe-push
1225     (cond ((macro-function symbol) :macro)
1226     ((special-operator-p symbol) :special-operator)
1227     ((genericp (fdefinition symbol)) :generic-function)
1228     (t :function))
1229     (doc 'function)))
1230 dbarlow 1.1 (maybe-push
1231     :setf (if (or (ext:info setf inverse symbol)
1232     (ext:info setf expander symbol))
1233     (doc 'setf)))
1234     (maybe-push
1235     :type (if (ext:info type kind symbol)
1236     (doc 'type)))
1237     (maybe-push
1238     :class (if (find-class symbol nil)
1239     (doc 'class)))
1240 heller 1.18 (maybe-push
1241     :alien-type (if (not (eq (ext:info alien-type kind symbol) :unknown))
1242     (doc 'alien-type)))
1243     (maybe-push
1244     :alien-struct (if (ext:info alien-type struct symbol)
1245     (doc nil)))
1246     (maybe-push
1247     :alien-union (if (ext:info alien-type union symbol)
1248     (doc nil)))
1249     (maybe-push
1250     :alien-enum (if (ext:info alien-type enum symbol)
1251     (doc nil)))
1252 lgorrie 1.24 result)))
1253 dbarlow 1.1
1254 heller 1.80 (defimplementation describe-definition (symbol namespace)
1255 lgorrie 1.103 (describe (ecase namespace
1256     (:variable
1257     symbol)
1258     ((:function :generic-function)
1259     (symbol-function symbol))
1260     (:setf
1261     (or (ext:info setf inverse symbol)
1262     (ext:info setf expander symbol)))
1263     (:type
1264     (kernel:values-specifier-type symbol))
1265     (:class
1266     (find-class symbol))
1267     (:alien-struct
1268     (ext:info :alien-type :struct symbol))
1269     (:alien-union
1270     (ext:info :alien-type :union symbol))
1271     (:alien-enum
1272     (ext:info :alien-type :enum symbol))
1273     (:alien-type
1274     (ecase (ext:info :alien-type :kind symbol)
1275     (:primitive
1276     (let ((alien::*values-type-okay* t))
1277 heller 1.80 (funcall (ext:info :alien-type :translator symbol)
1278 lgorrie 1.103 (list symbol))))
1279     ((:defined)
1280     (ext:info :alien-type :definition symbol))
1281 heller 1.162 (:unknown :unkown))))))
1282 lgorrie 1.103
1283     ;;;;; Argument lists
1284    
1285 heller 1.162 (defimplementation arglist (fun)
1286     (etypecase fun
1287     (function (function-arglist fun))
1288     (symbol (function-arglist (or (macro-function fun)
1289     (symbol-function fun))))))
1290 heller 1.140
1291     (defun function-arglist (fun)
1292 mbaringer 1.115 (let ((arglist
1293     (cond ((eval:interpreted-function-p fun)
1294     (eval:interpreted-function-arglist fun))
1295     ((pcl::generic-function-p fun)
1296     (pcl:generic-function-lambda-list fun))
1297     ((c::byte-function-or-closure-p fun)
1298     (byte-code-function-arglist fun))
1299     ((kernel:%function-arglist (kernel:%function-self fun))
1300     (handler-case (read-arglist fun)
1301     (error () :not-available)))
1302     ;; this should work both for compiled-debug-function
1303     ;; and for interpreted-debug-function
1304     (t
1305     (handler-case (debug-function-arglist
1306     (di::function-debug-function fun))
1307     (di:unhandled-condition () :not-available))))))
1308 lgorrie 1.103 (check-type arglist (or list (member :not-available)))
1309     arglist))
1310 mbaringer 1.115
1311     (defimplementation function-name (function)
1312     (cond ((eval:interpreted-function-p function)
1313     (eval:interpreted-function-name function))
1314     ((pcl::generic-function-p function)
1315     (pcl::generic-function-name function))
1316     ((c::byte-function-or-closure-p function)
1317     (c::byte-function-name function))
1318     (t (kernel:%function-name (kernel:%function-self function)))))
1319 heller 1.18
1320 lgorrie 1.103 ;;; A simple case: the arglist is available as a string that we can
1321     ;;; `read'.
1322    
1323     (defun read-arglist (fn)
1324     "Parse the arglist-string of the function object FN."
1325     (let ((string (kernel:%function-arglist
1326     (kernel:%function-self fn)))
1327     (package (find-package
1328     (c::compiled-debug-info-package
1329     (kernel:%code-debug-info
1330     (vm::find-code-object fn))))))
1331     (with-standard-io-syntax
1332     (let ((*package* (or package *package*)))
1333     (read-from-string string)))))
1334    
1335     ;;; A harder case: an approximate arglist is derived from available
1336     ;;; debugging information.
1337 heller 1.93
1338 heller 1.92 (defun debug-function-arglist (debug-function)
1339 lgorrie 1.103 "Derive the argument list of DEBUG-FUNCTION from debug info."
1340 heller 1.92 (let ((args (di::debug-function-lambda-list debug-function))
1341     (required '())
1342     (optional '())
1343     (rest '())
1344     (key '()))
1345     ;; collect the names of debug-vars
1346 heller 1.91 (dolist (arg args)
1347     (etypecase arg
1348     (di::debug-variable
1349 heller 1.93 (push (di::debug-variable-symbol arg) required))
1350 lgorrie 1.103 ((member :deleted)
1351 heller 1.93 (push ':deleted required))
1352 heller 1.91 (cons
1353     (ecase (car arg)
1354 heller 1.92 (:keyword
1355     (push (second arg) key))
1356     (:optional
1357 heller 1.93 (push (debug-variable-symbol-or-deleted (second arg)) optional))
1358 heller 1.92 (:rest
1359 heller 1.93 (push (debug-variable-symbol-or-deleted (second arg)) rest))))))
1360 heller 1.92 ;; intersperse lambda keywords as needed
1361     (append (nreverse required)
1362     (if optional (cons '&optional (nreverse optional)))
1363     (if rest (cons '&rest (nreverse rest)))
1364     (if key (cons '&key (nreverse key))))))
1365    
1366 lgorrie 1.103 (defun debug-variable-symbol-or-deleted (var)
1367     (etypecase var
1368     (di:debug-variable
1369     (di::debug-variable-symbol var))
1370     ((member :deleted)
1371     '#:deleted)))
1372    
1373 heller 1.92 (defun symbol-debug-function-arglist (fname)
1374     "Return FNAME's debug-function-arglist and %function-arglist.
1375     A utility for debugging DEBUG-FUNCTION-ARGLIST."
1376     (let ((fn (fdefinition fname)))
1377     (values (debug-function-arglist (di::function-debug-function fn))
1378     (kernel:%function-arglist (kernel:%function-self fn)))))
1379 heller 1.91
1380 lgorrie 1.103 ;;; Deriving arglists for byte-compiled functions:
1381     ;;;
1382     (defun byte-code-function-arglist (fn)
1383     ;; There doesn't seem to be much arglist information around for
1384     ;; byte-code functions. Use the arg-count and return something like
1385     ;; (arg0 arg1 ...)
1386     (etypecase fn
1387     (c::simple-byte-function
1388     (loop for i from 0 below (c::simple-byte-function-num-args fn)
1389     collect (make-arg-symbol i)))
1390     (c::hairy-byte-function
1391     (hairy-byte-function-arglist fn))
1392     (c::byte-closure
1393     (byte-code-function-arglist (c::byte-closure-function fn)))))
1394 heller 1.97
1395 heller 1.101 (defun make-arg-symbol (i)
1396     (make-symbol (format nil "~A~D" (string 'arg) i)))
1397    
1398 lgorrie 1.103 ;;; A "hairy" byte-function is one that takes a variable number of
1399     ;;; arguments. `hairy-byte-function' is a type from the bytecode
1400     ;;; interpreter.
1401     ;;;
1402 heller 1.101 (defun hairy-byte-function-arglist (fn)
1403     (let ((counter -1))
1404     (flet ((next-arg () (make-arg-symbol (incf counter))))
1405     (with-struct (c::hairy-byte-function- min-args max-args rest-arg-p
1406     keywords-p keywords) fn
1407     (let ((arglist '())
1408     (optional (- max-args min-args)))
1409     ;; XXX isn't there a better way to write this?
1410 lgorrie 1.103 ;; (Looks fine to me. -luke)
1411 heller 1.101 (dotimes (i min-args)
1412     (push (next-arg) arglist))
1413     (when (plusp optional)
1414     (push '&optional arglist)
1415     (dotimes (i optional)
1416     (push (next-arg) arglist)))
1417     (when rest-arg-p
1418     (push '&rest arglist)
1419     (push (next-arg) arglist))
1420     (when keywords-p
1421     (push '&key arglist)
1422     (loop for (key _ __) in keywords
1423     do (push key arglist))
1424     (when (eq keywords-p :allow-others)
1425     (push '&allow-other-keys arglist)))
1426     (nreverse arglist))))))
1427 lgorrie 1.25
1428    
1429     ;;;; Miscellaneous.
1430 dbarlow 1.1
1431 lgorrie 1.56 (defimplementation macroexpand-all (form)
1432 lgorrie 1.24 (walker:macroexpand-all form))
1433 dbarlow 1.1
1434 heller 1.158 (defimplementation compiler-macroexpand-1 (form &optional env)
1435     (ext:compiler-macroexpand-1 form env))
1436    
1437     (defimplementation compiler-macroexpand (form &optional env)
1438     (ext:compiler-macroexpand form env))
1439    
1440 mbaringer 1.90 (defimplementation set-default-directory (directory)
1441 lgorrie 1.25 (setf (ext:default-directory) (namestring directory))
1442     ;; Setting *default-pathname-defaults* to an absolute directory
1443     ;; makes the behavior of MERGE-PATHNAMES a bit more intuitive.
1444     (setf *default-pathname-defaults* (pathname (ext:default-directory)))
1445 heller 1.107 (default-directory))
1446    
1447     (defimplementation default-directory ()
1448 lgorrie 1.25 (namestring (ext:default-directory)))
1449    
1450 lgorrie 1.103 (defimplementation call-without-interrupts (fn)
1451     (sys:without-interrupts (funcall fn)))
1452 heller 1.19
1453 lgorrie 1.103 (defimplementation getpid ()
1454     (unix:unix-getpid))
1455 lgorrie 1.99
1456 lgorrie 1.103 (defimplementation lisp-implementation-type-name ()
1457     "cmucl")
1458 heller 1.92
1459 lgorrie 1.103 (defimplementation quit-lisp ()
1460     (ext::quit))
1461 heller 1.19
1462 lgorrie 1.103 ;;; source-path-{stream,file,string,etc}-position moved into
1463     ;;; swank-source-path-parser
1464 dbarlow 1.1
1465    
1466 lgorrie 1.25 ;;;; Debugging
1467 dbarlow 1.1
1468     (defvar *sldb-stack-top*)
1469    
1470 lgorrie 1.56 (defimplementation call-with-debugging-environment (debugger-loop-fn)
1471 dbarlow 1.1 (unix:unix-sigsetmask 0)
1472 lgorrie 1.25 (let* ((*sldb-stack-top* (or debug:*stack-top-hint* (di:top-frame)))
1473 heller 1.142 (debug:*stack-top-hint* nil)
1474     (kernel:*current-level* 0))
1475 heller 1.112 (handler-bind ((di::unhandled-condition
1476 dbarlow 1.1 (lambda (condition)
1477 heller 1.112 (error (make-condition
1478     'sldb-condition
1479     :original-condition condition)))))
1480 heller 1.166 (unwind-protect
1481     (progn
1482     #+(or)(sys:scrub-control-stack)
1483     (funcall debugger-loop-fn))
1484     #+(or)(sys:scrub-control-stack)
1485     ))))
1486 dbarlow 1.1
1487 heller 1.112 (defun frame-down (frame)
1488     (handler-case (di:frame-down frame)
1489     (di:no-debug-info () nil)))
1490    
1491 dbarlow 1.1 (defun nth-frame (index)
1492 heller 1.112 (do ((frame *sldb-stack-top* (frame-down frame))
1493 dbarlow 1.1 (i index (1- i)))
1494     ((zerop i) frame)))
1495    
1496 heller 1.80 (defimplementation compute-backtrace (start end)
1497 dbarlow 1.1 (let ((end (or end most-positive-fixnum)))
1498 heller 1.112 (loop for f = (nth-frame start) then (frame-down f)
1499 dbarlow 1.1 for i from start below end
1500     while f
1501 heller 1.80 collect f)))
1502 dbarlow 1.1
1503 heller 1.80 (defimplementation print-frame (frame stream)
1504     (let ((*standard-output* stream))
1505 heller 1.114 (handler-case
1506     (debug::print-frame-call frame :verbosity 1 :number nil)
1507     (error (e)
1508     (ignore-errors (princ e stream))))))
1509 dbarlow 1.1
1510 lgorrie 1.56 (defimplementation frame-source-location-for-emacs (index)
1511 heller 1.29 (code-location-source-location (di:frame-code-location (nth-frame index))))
1512 dbarlow 1.1
1513 lgorrie 1.56 (defimplementation eval-in-frame (form index)
1514 lgorrie 1.26 (di:eval-in-frame (nth-frame index) form))
1515 heller 1.19
1516 heller 1.108 (defun frame-debug-vars (frame)
1517     "Return a vector of debug-variables in frame."
1518     (di::debug-function-debug-variables (di:frame-debug-function frame)))
1519    
1520     (defun debug-var-value (var frame location)
1521 heller 1.130 (let ((validity (di:debug-variable-validity var location)))
1522     (ecase validity
1523     (:valid (di:debug-variable-value var frame))
1524     ((:invalid :unknown) (make-symbol (string validity))))))
1525 heller 1.108
1526 lgorrie 1.56 (defimplementation frame-locals (index)
1527 dbarlow 1.1 (let* ((frame (nth-frame index))
1528 heller 1.108 (loc (di:frame-code-location frame))
1529     (vars (frame-debug-vars frame)))
1530     (loop for v across vars collect
1531 heller 1.80 (list :name (di:debug-variable-symbol v)
1532 heller 1.43 :id (di:debug-variable-id v)
1533 heller 1.108 :value (debug-var-value v frame loc)))))
1534    
1535     (defimplementation frame-var-value (frame var)
1536     (let* ((frame (nth-frame frame))
1537     (dvar (aref (frame-debug-vars frame) var)))
1538     (debug-var-value dvar frame (di:frame-code-location frame))))
1539 dbarlow 1.1
1540 lgorrie 1.56 (defimplementation frame-catch-tags (index)
1541 heller 1.80 (mapcar #'car (di:frame-catches (nth-frame index))))
1542 heller 1.33
1543 heller 1.123 (defimplementation return-from-frame (index form)
1544     (let ((sym (find-symbol (string 'find-debug-tag-for-frame)
1545     :debug-internals)))
1546     (if sym
1547     (let* ((frame (nth-frame index))
1548     (probe (funcall sym frame)))
1549     (cond (probe (throw (car probe) (eval-in-frame form index)))
1550     (t (format nil "Cannot return from frame: ~S" frame))))
1551     "return-from-frame is not implemented in this version of CMUCL.")))
1552    
1553 heller 1.126 (defimplementation activate-stepping (frame)
1554     (set-step-breakpoints (nth-frame frame)))
1555 heller 1.119
1556     (defimplementation sldb-break-on-return (frame)
1557     (break-on-return (nth-frame frame)))
1558    
1559 heller 1.133 ;;; We set the breakpoint in the caller which might be a bit confusing.
1560 heller 1.119 ;;;
1561     (defun break-on-return (frame)
1562     (let* ((caller (di:frame-down frame))
1563     (cl (di:frame-code-location caller)))
1564     (flet ((hook (frame bp)
1565     (when (frame-pointer= frame caller)
1566     (di:delete-breakpoint bp)
1567     (signal-breakpoint bp frame))))
1568     (let* ((info (ecase (di:code-location-kind cl)
1569     ((:single-value-return :unknown-return) nil)
1570     (:known-return (debug-function-returns
1571     (di:frame-debug-function frame)))))
1572     (bp (di:make-breakpoint #'hook cl :kind :code-location
1573     :info info)))
1574     (di:activate-breakpoint bp)
1575     `(:ok ,(format nil "Set breakpoint in ~A" caller))))))
1576    
1577     (defun frame-pointer= (frame1 frame2)
1578     "Return true if the frame pointers of FRAME1 and FRAME2 are the same."
1579     (sys:sap= (di::frame-pointer frame1) (di::frame-pointer frame2)))
1580    
1581 heller 1.126 ;;; The PC in escaped frames at a single-return-value point is
1582     ;;; actually vm:single-value-return-byte-offset bytes after the
1583     ;;; position given in the debug info. Here we try to recognize such
1584     ;;; cases.
1585     ;;;
1586     (defun next-code-locations (frame code-location)
1587     "Like `debug::next-code-locations' but be careful in escaped frames."
1588     (let ((next (debug::next-code-locations code-location)))
1589     (flet ((adjust-pc ()
1590     (let ((cl (di::copy-compiled-code-location code-location)))
1591     (incf (di::compiled-code-location-pc cl)
1592     vm:single-value-return-byte-offset)
1593     cl)))
1594     (cond ((and (di::compiled-frame-escaped frame)
1595     (eq (di:code-location-kind code-location)
1596     :single-value-return)
1597     (= (length next) 1)
1598     (di:code-location= (car next) (adjust-pc)))
1599     (debug::next-code-locations (car next)))
1600     (t
1601     next)))))
1602    
1603 heller 1.119 (defun set-step-breakpoints (frame)
1604     (let ((cl (di:frame-code-location frame)))
1605     (when (di:debug-block-elsewhere-p (di:code-location-debug-block cl))
1606     (error "Cannot step in elsewhere code"))
1607 heller 1.126 (let* ((debug::*bad-code-location-types*
1608 heller 1.119 (remove :call-site debug::*bad-code-location-types*))
1609 heller 1.126 (next (next-code-locations frame cl)))
1610 heller 1.119 (cond (next
1611     (let ((steppoints '()))
1612     (flet ((hook (bp-frame bp)
1613 heller 1.126 (signal-breakpoint bp bp-frame)
1614     (mapc #'di:delete-breakpoint steppoints)))
1615 heller 1.119 (dolist (code-location next)
1616     (let ((bp (di:make-breakpoint #'hook code-location
1617     :kind :code-location)))
1618     (di:activate-breakpoint bp)
1619     (push bp steppoints))))))
1620     (t
1621     (break-on-return frame))))))
1622    
1623    
1624     ;; XXX the return values at return breakpoints should be passed to the
1625     ;; user hooks. debug-int.lisp should be changed to do this cleanly.
1626    
1627     ;;; The sigcontext and the PC for a breakpoint invocation are not
1628     ;;; passed to user hook functions, but we need them to extract return
1629     ;;; values. So we advice di::handle-breakpoint and bind the values to
1630     ;;; special variables.
1631     ;;;
1632     (defvar *breakpoint-sigcontext*)
1633     (defvar *breakpoint-pc*)
1634    
1635     ;; XXX don't break old versions without fwrappers. Remove this one day.
1636     #+#.(cl:if (cl:find-package :fwrappers) '(and) '(or))
1637     (progn
1638     (fwrappers:define-fwrapper bind-breakpoint-sigcontext (offset c sigcontext)
1639     (let ((*breakpoint-sigcontext* sigcontext)
1640     (*breakpoint-pc* offset))
1641     (fwrappers:call-next-function)))
1642     (fwrappers:set-fwrappers 'di::handle-breakpoint '())
1643     (fwrappers:fwrap 'di::handle-breakpoint #'bind-breakpoint-sigcontext))
1644    
1645     (defun sigcontext-object (sc index)
1646     "Extract the lisp object in sigcontext SC at offset INDEX."
1647     (kernel:make-lisp-obj (vm:sigcontext-register sc index)))
1648    
1649     (defun known-return-point-values (sigcontext sc-offsets)
1650     (let ((fp (system:int-sap (vm:sigcontext-register sigcontext
1651     vm::cfp-offset))))
1652     (system:without-gcing
1653     (loop for sc-offset across sc-offsets
1654     collect (di::sub-access-debug-var-slot fp sc-offset sigcontext)))))
1655    
1656     ;;; CMUCL returns the first few values in registers and the rest on
1657     ;;; the stack. In the multiple value case, the number of values is
1658     ;;; stored in a dedicated register. The values of the registers can be
1659     ;;; accessed in the sigcontext for the breakpoint. There are 3 kinds
1660     ;;; of return conventions: :single-value-return, :unknown-return, and
1661     ;;; :known-return.
1662     ;;;
1663     ;;; The :single-value-return convention returns the value in a
1664     ;;; register without setting the nargs registers.
1665     ;;;
1666     ;;; The :unknown-return variant is used for multiple values. A
1667     ;;; :unknown-return point consists actually of 2 breakpoints: one for
1668     ;;; the single value case and one for the general case. The single
1669     ;;; value breakpoint comes vm:single-value-return-byte-offset after
1670     ;;; the multiple value breakpoint.
1671     ;;;
1672     ;;; The :known-return convention is used by local functions.
1673     ;;; :known-return is currently not supported because we don't know
1674     ;;; where the values are passed.
1675     ;;;
1676     (defun breakpoint-values (breakpoint)
1677     "Return the list of return values for a return point."
1678     (flet ((1st (sc) (sigcontext-object sc (car vm::register-arg-offsets))))
1679     (let ((sc (locally (declare (optimize (ext:inhibit-warnings 3)))
1680     (alien:sap-alien *breakpoint-sigcontext* (* unix:sigcontext))))
1681     (cl (di:breakpoint-what breakpoint)))
1682     (ecase (di:code-location-kind cl)
1683     (:single-value-return
1684     (list (1st sc)))
1685     (:known-return
1686     (let ((info (di:breakpoint-info breakpoint)))
1687     (if (vectorp info)
1688     (known-return-point-values sc info)
1689 heller 1.142 (progn
1690     ;;(break)
1691     (list "<<known-return convention not supported>>" info)))))
1692 heller 1.119 (:unknown-return
1693     (let ((mv-return-pc (di::compiled-code-location-pc cl)))
1694     (if (= mv-return-pc *breakpoint-pc*)
1695 heller 1.143 (mv-function-end-breakpoint-values sc)
1696 heller 1.119 (list (1st sc)))))))))
1697 heller 1.143
1698     ;; XXX: di::get-function-end-breakpoint-values takes 2 arguments in
1699     ;; newer versions of CMUCL (after ~March 2005).
1700     (defun mv-function-end-breakpoint-values (sigcontext)
1701     (let ((sym (find-symbol "FUNCTION-END-BREAKPOINT-VALUES/STANDARD" :di)))
1702     (cond (sym (funcall sym sigcontext))
1703     (t (di::get-function-end-breakpoint-values sigcontext)))))
1704 heller 1.119
1705     (defun debug-function-returns (debug-fun)
1706     "Return the return style of DEBUG-FUN."
1707     (let* ((cdfun (di::compiled-debug-function-compiler-debug-fun debug-fun)))
1708     (c::compiled-debug-function-returns cdfun)))
1709    
1710     (define-condition breakpoint (simple-condition)
1711 heller 1.137 ((message :initarg :message :reader breakpoint.message)
1712     (values :initarg :values :reader breakpoint.values))
1713 heller 1.119 (:report (lambda (c stream) (princ (breakpoint.message c) stream))))
1714    
1715 heller 1.162 (defimplementation condition-extras (condition)
1716     (typecase condition
1717     (breakpoint
1718     ;; pop up the source buffer
1719 heller 1.170 `((:show-frame-source 0)))
1720 heller 1.162 (t '())))
1721 heller 1.119
1722     (defun signal-breakpoint (breakpoint frame)
1723     "Signal a breakpoint condition for BREAKPOINT in FRAME.
1724     Try to create a informative message."
1725 heller 1.137 (flet ((brk (values fstring &rest args)
1726 heller 1.119 (let ((msg (apply #'format nil fstring args))
1727     (debug:*stack-top-hint* frame))
1728 heller 1.137 (break 'breakpoint :message msg :values values))))
1729     (with-struct (di::breakpoint- kind what) breakpoint
1730     (case kind
1731     (:code-location
1732     (case (di:code-location-kind what)
1733     ((:single-value-return :known-return :unknown-return)
1734     (let ((values (breakpoint-values breakpoint)))
1735     (brk values "Return value: ~{~S ~}" values)))
1736     (t
1737 heller 1.140 #+(or)
1738     (when (eq (di:code-location-kind what) :call-site)
1739     (call-site-function breakpoint frame))
1740 heller 1.137 (brk nil "Breakpoint: ~S ~S"
1741     (di:code-location-kind what)
1742     (di::compiled-code-location-pc what)))))
1743     (:function-start
1744     (brk nil "Function start breakpoint"))
1745     (t (brk nil "Breakpoint: ~A in ~A" breakpoint frame))))))
1746 heller 1.119
1747     (defimplementation sldb-break-at-start (fname)
1748     (let ((debug-fun (di:function-debug-function (coerce fname 'function))))
1749     (cond ((not debug-fun)
1750     `(:error ,(format nil "~S has no debug-function" fname)))
1751     (t
1752     (flet ((hook (frame bp &optional args cookie)
1753     (declare (ignore args cookie))
1754     (signal-breakpoint bp frame)))
1755     (let ((bp (di:make-breakpoint #'hook debug-fun
1756     :kind :function-start)))
1757     (di:activate-breakpoint bp)
1758     `(:ok ,(format nil "Set breakpoint in ~S" fname))))))))
1759 dbarlow 1.1
1760 heller 1.58 (defun frame-cfp (frame)
1761     "Return the Control-Stack-Frame-Pointer for FRAME."
1762     (etypecase frame
1763     (di::compiled-frame (di::frame-pointer frame))
1764     ((or di::interpreted-frame null) -1)))
1765    
1766     (defun frame-ip (frame)
1767     "Return the (absolute) instruction pointer and the relative pc of FRAME."
1768     (if (not frame)
1769     -1
1770     (let ((debug-fun (di::frame-debug-function frame)))
1771     (etypecase debug-fun
1772     (di::compiled-debug-function
1773     (let* ((code-loc (di:frame-code-location frame))
1774     (component (di::compiled-debug-function-component debug-fun))
1775     (pc (di::compiled-code-location-pc code-loc))
1776     (ip (sys:without-gcing
1777     (sys:sap-int
1778     (sys:sap+ (kernel:code-instructions component) pc)))))
1779     (values ip pc)))
1780     ((or di::bogus-debug-function di::interpreted-debug-function)
1781     -1)))))
1782    
1783     (defun frame-registers (frame)
1784     "Return the lisp registers CSP, CFP, IP, OCFP, LRA for FRAME-NUMBER."
1785     (let* ((cfp (frame-cfp frame))
1786     (csp (frame-cfp (di::frame-up frame)))
1787     (ip (frame-ip frame))
1788     (ocfp (frame-cfp (di::frame-down frame)))
1789     (lra (frame-ip (di::frame-down frame))))
1790     (values csp cfp ip ocfp lra)))
1791    
1792     (defun print-frame-registers (frame-number)
1793     (let ((frame (di::frame-real-frame (nth-frame frame-number))))
1794     (flet ((fixnum (p) (etypecase p
1795     (integer p)
1796     (sys:system-area-pointer (sys:sap-int p)))))
1797     (apply #'format t "~
1798     CSP = ~X
1799     CFP = ~X
1800     IP = ~X
1801     OCFP = ~X
1802     LRA = ~X~%" (mapcar #'fixnum
1803     (multiple-value-list (frame-registers frame)))))))
1804    
1805 heller 1.82
1806 heller 1.81 (defimplementation disassemble-frame (frame-number)
1807     "Return a string with the disassembly of frames code."
1808     (print-frame-registers frame-number)
1809     (terpri)
1810     (let* ((frame (di::frame-real-frame (nth-frame frame-number)))
1811     (debug-fun (di::frame-debug-function frame)))
1812     (etypecase debug-fun
1813     (di::compiled-debug-function
1814     (let* ((component (di::compiled-debug-function-component debug-fun))
1815     (fun (di:debug-function-function debug-fun)))
1816     (if fun
1817     (disassemble fun)
1818     (disassem:disassemble-code-component component))))
1819     (di::bogus-debug-function
1820     (format t "~%[Disassembling bogus frames not implemented]")))))
1821 heller 1.58
1822 dbarlow 1.1
1823 lgorrie 1.25 ;;;; Inspecting
1824 dbarlow 1.1
1825 heller 1.171 (defclass cmucl-inspector (backend-inspector) ())
1826 mbaringer 1.116
1827     (defimplementation make-default-inspector ()
1828     (make-instance 'cmucl-inspector))
1829    
1830 dbarlow 1.1 (defconstant +lowtag-symbols+
1831     '(vm:even-fixnum-type
1832     vm:function-pointer-type
1833     vm:other-immediate-0-type
1834     vm:list-pointer-type
1835     vm:odd-fixnum-type
1836     vm:instance-pointer-type
1837     vm:other-immediate-1-type
1838 lgorrie 1.103 vm:other-pointer-type)
1839     "Names of the constants that specify type tags.
1840     The `symbol-value' of each element is a type tag.")
1841 dbarlow 1.1
1842     (defconstant +header-type-symbols+
1843 heller 1.144 (labels ((suffixp (suffix string)
1844     (and (>= (length string) (length suffix))
1845     (string= string suffix :start1 (- (length string)
1846     (length suffix)))))
1847     (header-type-symbol-p (x)
1848     (and (suffixp "-TYPE" (symbol-name x))
1849     (not (member x +lowtag-symbols+))
1850     (boundp x)
1851     (typep (symbol-value x) 'fixnum))))
1852     (remove-if-not #'header-type-symbol-p
1853     (append (apropos-list "-TYPE" "VM")
1854     (apropos-list "-TYPE" "BIGNUM"))))
1855 heller 1.102 "A list of names of the type codes in boxed objects.")
1856 heller 1.62
1857     (defimplementation describe-primitive-type (object)
1858 dbarlow 1.1 (with-output-to-string (*standard-output*)
1859     (let* ((lowtag (kernel:get-lowtag object))
1860     (lowtag-symbol (find lowtag +lowtag-symbols+ :key #'symbol-value)))
1861 heller 1.76 (format t "lowtag: ~A" lowtag-symbol)
1862     (when (member lowtag (list vm:other-pointer-type
1863     vm:function-pointer-type
1864     vm:other-immediate-0-type
1865     vm:other-immediate-1-type
1866     ))
1867     (let* ((type (kernel:get-type object))
1868     (type-symbol (find type +header-type-symbols+
1869     :key #'symbol-value)))
1870     (format t ", type: ~A" type-symbol))))))
1871 dbarlow 1.1
1872 heller 1.171 (defmethod inspect-for-emacs ((o t) (inspector backend-inspector))
1873 dbarlow 1.1 (cond ((di::indirect-value-cell-p o)
1874 heller 1.121 (values (format nil "~A is a value cell." o)
1875 mbaringer 1.116 `("Value: " (:value ,(c:value-cell-ref o)))))
1876 heller 1.130 ((alien::alien-value-p o)
1877     (inspect-alien-value o))
1878 dbarlow 1.1 (t
1879 heller 1.130 (cmucl-inspect o))))
1880    
1881     (defun cmucl-inspect (o)
1882     (destructuring-bind (text labeledp . parts) (inspect::describe-parts o)
1883     (values (format nil "~A~%" text)
1884     (if labeledp
1885     (loop for (label . value) in parts
1886     append (label-value-line label value))
1887     (loop for value in parts for i from 0
1888     append (label-value-line i value))))))
1889 heller 1.55
1890 heller 1.171 (defmethod inspect-for-emacs ((o function) (inspector backend-inspector))
1891 mbaringer 1.116 (declare (ignore inspector))
1892 heller 1.126 (let ((header (kernel:get-type o)))
1893     (cond ((= header vm:function-header-type)
1894     (values (format nil "~A is a function." o)
1895     (append (label-value-line*
1896     ("Self" (kernel:%function-self o))
1897     ("Next" (kernel:%function-next o))
1898     ("Name" (kernel:%function-name o))
1899     ("Arglist" (kernel:%function-arglist o))
1900     ("Type" (kernel:%function-type o))
1901     ("Code" (kernel:function-code-header o)))
1902     (list
1903     (with-output-to-string (s)
1904     (disassem:disassemble-function o :stream s))))))
1905     ((= header vm:closure-header-type)
1906     (values (format nil "~A is a closure" o)
1907     (append
1908     (label-value-line "Function" (kernel:%closure-function o))
1909     `("Environment:" (:newline))
1910     (loop for i from 0 below (1- (kernel:get-closure-length o))
1911     append (label-value-line
1912     i (kernel:%closure-index-ref o i))))))
1913 heller 1.142 ((eval::interpreted-function-p o)
1914     (cmucl-inspect o))
1915     (t
1916 heller 1.126 (call-next-method)))))
1917    
1918 heller 1.158 (defmethod inspect-for-emacs ((o kernel:funcallable-instance)
1919 heller 1.171 (i backend-inspector))
1920 heller 1.158 (declare (ignore i))
1921     (values
1922     (format nil "~A is a funcallable-instance." o)
1923     (append (label-value-line*
1924     (:function (kernel:%funcallable-instance-function o))
1925     (:lexenv (kernel:%funcallable-instance-lexenv o))
1926     (:layout (kernel:%funcallable-instance-layout o)))
1927     (nth-value 1 (cmucl-inspect o)))))
1928 dbarlow 1.1
1929 heller 1.171 (defmethod inspect-for-emacs ((o kernel:code-component) (_ backend-inspector))
1930 heller 1.121 (declare (ignore _))
1931     (values (format nil "~A is a code data-block." o)
1932     (append
1933     (label-value-line*
1934     ("code-size" (kernel:%code-code-size o))
1935     ("entry-points" (kernel:%code-entry-points o))
1936     ("debug-info" (kernel:%code-debug-info o))
1937     ("trace-table-offset" (kernel:code-header-ref
1938     o vm:code-trace-table-offset-slot)))
1939     `("Constants:" (:newline))
1940     (loop for i from vm:code-constants-offset
1941     below (kernel:get-header-data o)
1942     append (label-value-line i (kernel:code-header-ref o i)))
1943     `("Code:" (:newline)
1944     , (with-output-to-string (s)
1945 heller 1.123 (cond ((kernel:%code-debug-info o)
1946     (disassem:disassemble-code-component o :stream s))
1947     (t
1948     (disassem:disassemble-memory
1949     (disassem::align
1950     (+ (logandc2 (kernel:get-lisp-obj-address o)
1951     vm:lowtag-mask)
1952     (* vm:code-constants-offset vm:word-bytes))
1953     (ash 1 vm:lowtag-bits))
1954     (ash (kernel:%code-code-size o) vm:word-shift)
1955     :stream s))))))))
1956 mbaringer 1.116
1957 heller 1.171 (defmethod inspect-for-emacs ((o kernel:fdefn) (inspector backend-inspector))
1958 mbaringer 1.116 (declare (ignore inspector))
1959 heller 1.121 (values (format nil "~A is a fdenf object." o)
1960     (label-value-line*
1961     ("name" (kernel:fdefn-name o))
1962     ("function" (kernel:fdefn-function o))
1963     ("raw-addr" (sys:sap-ref-32
1964     (sys:int-sap (kernel:get-lisp-obj-address o))
1965     (* vm:fdefn-raw-addr-slot vm:word-bytes))))))
1966 heller 1.58
1967 heller 1.171 (defmethod inspect-for-emacs ((o array) (inspector backend-inspector))
1968 heller 1.129 inspector
1969 heller 1.164 (if (typep o 'simple-array)
1970     (call-next-method)
1971     (values (format nil "~A is an array." o)
1972     (label-value-line*
1973     (:header (describe-primitive-type o))
1974     (:rank (array-rank o))
1975     (:fill-pointer (kernel:%array-fill-pointer o))
1976     (:fill-pointer-p (kernel:%array-fill-pointer-p o))
1977     (:elements (kernel:%array-available-elements o))
1978     (:data (kernel:%array-data-vector o))
1979     (:displacement (kernel:%array-displacement o))
1980     (:displaced-p (kernel:%array-displaced-p o))
1981     (:dimensions (array-dimensions o))))))
1982 heller 1.129
1983 heller 1.171 (defmethod inspect-for-emacs ((o simple-vector) (inspector backend-inspector))
1984 heller 1.129 inspector
1985 heller 1.164 (values (format nil "~A is a simple-vector." o)
1986 heller 1.129 (append
1987     (label-value-line*
1988     (:header (describe-primitive-type o))
1989     (:length (c::vector-length o)))
1990     (loop for i below (length o)
1991     append (label-value-line i (aref o i))))))
1992    
1993 heller 1.130 (defun inspect-alien-record (alien)
1994     (values
1995     (format nil "~A is an alien value." alien)
1996     (with-struct (alien::alien-value- sap type) alien
1997     (with-struct (alien::alien-record-type- kind name fields) type
1998     (append
1999     (label-value-line*
2000     (:sap sap)
2001     (:kind kind)
2002     (:name name))
2003     (loop for field in fields
2004     append (let ((slot (alien::alien-record-field-name field)))
2005     (label-value-line slot (alien:slot alien slot)))))))))
2006    
2007     (defun inspect-alien-pointer (alien)
2008     (values
2009     (format nil "~A is an alien value." alien)
2010     (with-struct (alien::alien-value- sap type) alien
2011     (label-value-line*
2012     (:sap sap)
2013     (:type type)
2014     (:to (alien::deref alien))))))
2015    
2016     (defun inspect-alien-value (alien)
2017     (typecase (alien::alien-value-type alien)
2018     (alien::alien-record-type (inspect-alien-record alien))
2019     (alien::alien-pointer-type (inspect-alien-pointer alien))
2020     (t (cmucl-inspect alien))))
2021 heller 1.58
2022     ;;;; Profiling
2023     (defimplementation profile (fname)
2024     (eval `(profile:profile ,fname)))
2025    
2026     (defimplementation unprofile (fname)
2027     (eval `(profile:unprofile ,fname)))
2028    
2029     (defimplementation unprofile-all ()
2030 heller 1.126 (eval `(profile:unprofile))
2031 heller 1.58 "All functions unprofiled.")
2032    
2033     (defimplementation profile-report ()
2034 heller 1.126 (eval `(profile:report-time)))
2035 heller 1.58
2036     (defimplementation profile-reset ()
2037 heller 1.126 (eval `(profile:reset-time))
2038 heller 1.58 "Reset profiling counters.")
2039    
2040     (defimplementation profiled-functions ()
2041     profile:*timed-functions*)
2042    
2043     (defimplementation profile-package (package callers methods)
2044 heller 1.80 (profile:profile-all :package package
2045 heller 1.58 :callers-p callers
2046 lgorrie 1.105 #-cmu18e :methods #-cmu18e methods))
2047 dbarlow 1.1
2048 lgorrie 1.42
2049     ;;;; Multiprocessing
2050    
2051 heller 1.91 #+mp
2052 lgorrie 1.42 (progn
2053 mbaringer 1.165 (defimplementation initialize-multiprocessing (continuation)
2054     (mp::init-multi-processing)
2055 heller 1.166 (mp:make-process continuation :name "swank")
2056 lgorrie 1.49 ;; Threads magic: this never returns! But top-level becomes
2057     ;; available again.
2058 heller 1.166 (unless mp::*idle-process*
2059 heller 1.163 (mp::startup-idle-and-top-level-loops)))
2060 heller 1.166
2061 heller 1.162 (defimplementation spawn (fn &key name)
2062     (mp:make-process fn :name (or name "Anonymous")))
2063 lgorrie 1.42
2064 heller 1.109 (defvar *thread-id-counter* 0)
2065    
2066     (defimplementation thread-id (thread)
2067     (or (getf (mp:process-property-list thread) 'id)
2068     (setf (getf (mp:process-property-list thread) 'id)
2069     (incf *thread-id-counter*))))
2070