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

Contents of /slime/swank-cmucl.lisp

Parent Directory Parent Directory | Revision Log Revision Log


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

  ViewVC Help
Powered by ViewVC 1.1.5