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

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

  ViewVC Help
Powered by ViewVC 1.1.5