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

Contents of /slime/swank-cmucl.lisp

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.154 - (hide annotations)
Wed Sep 21 11:40:08 2005 UTC (8 years, 6 months ago) by heller
Branch: MAIN
Changes since 1.153: +30 -8 lines
Improve stream efficiency by buffering more
output. stream-force-output simply does nothing, if the output buffer
was flushed less than 200 millisecons before.  stream-finish-output
can still be used to really flush the buffer.

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