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

Diff of /slime/swank-cmucl.lisp

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

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

Legend:
Removed from v.1.32  
changed lines
  Added in v.1.207

  ViewVC Help
Powered by ViewVC 1.1.5