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

Contents of /slime/swank-cmucl.lisp

Parent Directory Parent Directory | Revision Log Revision Log


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

  ViewVC Help
Powered by ViewVC 1.1.5