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

Contents of /slime/swank-cmucl.lisp

Parent Directory Parent Directory | Revision Log Revision Log


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