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

Contents of /slime/swank-cmucl.lisp

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.129 - (hide annotations)
Fri Nov 19 19:08:24 2004 UTC (9 years, 5 months ago) by heller
Branch: MAIN
Changes since 1.128: +30 -1 lines
(accept-connection): Accept external-format argument.

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