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.143 by heller, Sun Apr 3 23:27:41 2005 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.
9    (in-package :swank-backend)
11    (import-swank-mop-symbols :pcl '(:slot-definition-documentation))
13    (defun swank-mop:slot-definition-documentation (slot)
14      (documentation slot t))
16    ;;;; "Hot fixes"
17    ;;;
18    ;;; Here are necessary bugfixes to the latest released version of
19    ;;; CMUCL (currently 18e). Any fixes placed here should also be
20    ;;; submitted to the `cmucl-imp' mailing list and confirmed as
21    ;;; good. When a new release is made that includes the fixes we should
22    ;;; promptly delete them from here. It is enough to be compatible with
23    ;;; the latest release.
25  (declaim (optimize debug))  (in-package :lisp)
27  (in-package :swank)  ;;; `READ-SEQUENCE' with large sequences has problems in 18e. This new
28    ;;; definition works better.
30  ;; Turn on xref. [should we?]  #-cmu19
31  (setf c:*record-xref-info* t)  (progn
32      (let ((s (find-symbol (string :*enable-package-locked-errors*) :lisp)))
33        (when s
34          (setf (symbol-value s) nil)))
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))
59      (let ((s (find-symbol (string :*enable-package-locked-errors*) :lisp)))
60        (when s
61          (setf (symbol-value s) t)))
63  (defun without-interrupts* (body)    )
   (sys:without-interrupts (funcall body)))  
65  (defun set-fd-non-blocking (fd)  (in-package :swank-backend)
   (flet ((fcntl (fd cmd arg)  
            (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)))))  
68  ;;;; TCP server.  ;;;; TCP server
69    ;;;
70    ;;; In CMUCL we support all communication styles. By default we use
71    ;;; `:SIGIO' because it is the most responsive, but it's somewhat
72    ;;; dangerous: CMUCL is not in general "signal safe", and you don't
73    ;;; know for sure what you'll be interrupting. Both `:FD-HANDLER' and
74    ;;; `:SPAWN' are reasonable alternatives.
76    (defimplementation preferred-communication-style ()
77      :sigio)
79    #-(or ppc mips)
80    (defimplementation create-socket (host port)
81      (let* ((addr (resolve-hostname host))
82             (addr (if (not (find-symbol "SOCKET-ERROR" :ext))
83                       (ext:htonl addr)
84                       addr)))
85        (ext:create-inet-listener port :stream :reuse-address t :host addr)))
87    ;; There seems to be a bug in create-inet-listener on Mac/OSX and Irix.
88    #+(or ppc mips)
89    (defimplementation create-socket (host port)
90      (declare (ignore host))
91      (ext:create-inet-listener port :stream :reuse-address t))
93    (defimplementation local-port (socket)
94      (nth-value 1 (ext::get-socket-host-and-port (socket-fd socket))))
96  (defun resolve-hostname (name)  (defimplementation close-socket (socket)
   (let* ((hostent (ext:lookup-host-entry name))  
          (address (car (ext:host-entry-addr-list hostent))))  
     (ext:htonl address)))  
 (defun create-swank-server (port &key (reuse-address t)  
                             (address "localhost"))  
   "Create a SWANK TCP server."  
   (let* ((ip (resolve-hostname address))  
          (fd (ext:create-inet-listener port :stream  
                                        :reuse-address reuse-address  
                                        :host ip)))  
     (system:add-fd-handler fd :input #'accept-connection)  
     (nth-value 1 (ext::get-socket-host-and-port fd))))  
 (defun accept-connection (socket)  
   "Accept one Swank TCP connection on SOCKET and then close it."  
   (setup-request-handler (ext:accept-tcp-connection socket))  
97    (sys:invalidate-descriptor socket)    (sys:invalidate-descriptor socket)
98    (unix:unix-close socket))    (ext:close-socket (socket-fd socket)))
100  (defun open-stream-to-emacs ()  (defimplementation accept-connection (socket &key external-format)
101    "Return an output-stream to Emacs' output buffer."    (let ((ef (or external-format :iso-latin-1-unix)))
102    (let* ((ip (resolve-hostname "localhost"))      (assert (eq ef ':iso-latin-1-unix))
103           (listener (ext:create-inet-listener 0 :stream :host ip))      (make-socket-io-stream (ext:accept-tcp-connection socket))))
104           (port (nth-value 1 (ext::get-socket-host-and-port listener))))  
105      (unwind-protect  ;;;;; Sockets
106           (progn  
107             (eval-in-emacs `(slime-open-stream-to-lisp ,port))  (defun socket-fd (socket)
108             (let ((fd (ext:accept-tcp-connection listener)))    "Return the filedescriptor for the socket represented by SOCKET."
109               (sys:make-fd-stream fd :output t)))    (etypecase socket
110        (ext:close-socket listener))))      (fixnum socket)
111        (sys:fd-stream (sys:fd-stream-fd socket))))
112  (defvar *use-dedicated-output-stream* t)  
113    (defun resolve-hostname (hostname)
114  (defun setup-request-handler (socket)    "Return the IP address of HOSTNAME as an integer (in host byte-order)."
115    "Setup request handling for SOCKET."    (let ((hostent (ext:lookup-host-entry hostname)))
116    (let* ((stream (sys:make-fd-stream socket      (car (ext:host-entry-addr-list hostent))))
117                                       :input t :output t  
118                                       :element-type 'base-char))  (defun make-socket-io-stream (fd)
119           (input (make-slime-input-stream))    "Create a new input/output fd-stream for FD."
120           (output (if *use-dedicated-output-stream*    (sys:make-fd-stream fd :input t :output t :element-type 'base-char))
121                       (let ((*emacs-io* stream)) (open-stream-to-emacs))  
122                       (make-slime-output-stream)))  ;;;;; Signal-driven I/O
123           (io (make-two-way-stream input output)))  
124      (system:add-fd-handler socket  (defvar *sigio-handlers* '()
125                             :input (lambda (fd)    "List of (key . function) pairs.
126                                      (declare (ignore fd))  All functions are called on SIGIO, and the key is used for removing
127                                      (serve-request stream output input io)))))  specific functions.")
129  (defun serve-request (*emacs-io* *slime-output* *slime-input* *slime-io*)  (defun set-sigio-handler ()
130    "Read and process a request from a SWANK client.    (sys:enable-interrupt :sigio (lambda (signal code scp)
131  The request is read from the socket as a sexp and then evaluated."                                   (sigio-handler signal code scp))))
132    (catch 'slime-toplevel  
133      (with-simple-restart (abort "Return to Slime toplevel.")  (defun sigio-handler (signal code scp)
134        (handler-case (read-from-emacs)    (declare (ignore signal code scp))
135          (slime-read-error (e)    (mapc #'funcall (mapcar #'cdr *sigio-handlers*)))
136            (when *swank-debug-p*  
137              (format *debug-io* "~&;; Connection to Emacs lost.~%;; [~A]~%" e))  (defun fcntl (fd command arg)
138            (sys:invalidate-descriptor (sys:fd-stream-fd *emacs-io*))    "fcntl(2) - manipulate a file descriptor."
139            (close *emacs-io*)))))    (multiple-value-bind (ok error) (unix:unix-fcntl fd command arg)
140    (sys:scrub-control-stack))      (unless ok (error "fcntl: ~A" (unix:get-unix-error-msg error)))))
142    (defimplementation add-sigio-handler (socket fn)
143      (set-sigio-handler)
144      (let ((fd (socket-fd socket)))
145        (fcntl fd unix:f-setown (unix:unix-getpid))
146        (fcntl fd unix:f-setfl unix:fasync)
147        (push (cons fd fn) *sigio-handlers*)))
149    (defimplementation remove-sigio-handlers (socket)
150      (let ((fd (socket-fd socket)))
151        (setf *sigio-handlers* (remove fd *sigio-handlers* :key #'car))
152        (sys:invalidate-descriptor fd))
153      (close socket))
155    ;;;;; SERVE-EVENT
157    (defimplementation add-fd-handler (socket fn)
158      (let ((fd (socket-fd socket)))
159        (sys:add-fd-handler fd :input (lambda (_)
160                                        _
161                                        (funcall fn)))))
163    (defimplementation remove-fd-handlers (socket)
164      (sys:invalidate-descriptor (socket-fd socket)))
167  ;;;; Stream handling  ;;;; Stream handling
168    ;;; XXX: How come we don't use Gray streams in CMUCL too? -luke (15/May/2004)
170    (defimplementation make-fn-streams (input-fn output-fn)
171      (let* ((output (make-slime-output-stream output-fn))
172             (input  (make-slime-input-stream input-fn output)))
173        (values input output)))
175  (defstruct (slime-output-stream  (defstruct (slime-output-stream
176               (:include lisp::lisp-stream               (:include lisp::lisp-stream
177                         (lisp::misc #'sos/misc)                         (lisp::misc #'sos/misc)
178                         (lisp::out #'sos/out)                         (lisp::out #'sos/out)
179                         (lisp::sout #'sos/sout))                         (lisp::sout #'sos/sout))
180               (:conc-name sos.)               (:conc-name sos.)
181               (:print-function %print-slime-output-stream))               (:print-function %print-slime-output-stream)
182                 (:constructor make-slime-output-stream (output-fn)))
183      (output-fn nil :type function)
184    (buffer (make-string 512) :type string)    (buffer (make-string 512) :type string)
185    (index 0 :type kernel:index)    (index 0 :type kernel:index)
186    (column 0 :type kernel:index))    (column 0 :type kernel:index))
# Line 109  The request is read from the socket as a Line 196  The request is read from the socket as a
196      (setf (sos.index stream) (1+ index))      (setf (sos.index stream) (1+ index))
197      (incf (sos.column stream))      (incf (sos.column stream))
198      (when (char= #\newline char)      (when (char= #\newline char)
199        (setf (sos.column stream) 0))        (setf (sos.column stream) 0)
200          (force-output stream))
201      (when (= index (1- (length buffer)))      (when (= index (1- (length buffer)))
202        (force-output stream)))        (force-output stream)))
203    char)    char)
# Line 117  The request is read from the socket as a Line 205  The request is read from the socket as a
205  (defun sos/sout (stream string start end)  (defun sos/sout (stream string start end)
206    (loop for i from start below end    (loop for i from start below end
207          do (sos/out stream (aref string i))))          do (sos/out stream (aref string i))))
209  (defun sos/misc (stream operation &optional arg1 arg2)  (defun sos/misc (stream operation &optional arg1 arg2)
210    (declare (ignore arg1 arg2))    (declare (ignore arg1 arg2))
211    (case operation    (case operation
212      ((:force-output :finish-output)      ((:force-output :finish-output)
213       (let ((end (sos.index stream)))       (let ((end (sos.index stream)))
214         (unless (zerop end)         (unless (zerop end)
215           (send-to-emacs `(:read-output ,(subseq (sos.buffer stream) 0 end)))           (let ((s (subseq (sos.buffer stream) 0 end)))
216           (setf (sos.index stream) 0))))             (setf (sos.index stream) 0)
217               (funcall (sos.output-fn stream) s)))))
218      (:charpos (sos.column stream))      (:charpos (sos.column stream))
219      (:line-length 75)      (:line-length 75)
220      (:file-position nil)      (:file-position nil)
# Line 135  The request is read from the socket as a Line 224  The request is read from the socket as a
224      (t (format *terminal-io* "~&~Astream: ~S~%" stream operation))))      (t (format *terminal-io* "~&~Astream: ~S~%" stream operation))))
226  (defstruct (slime-input-stream  (defstruct (slime-input-stream
227               (:include string-stream               (:include string-stream
228                         (lisp::in #'sis/in)                         (lisp::in #'sis/in)
229                         (lisp::misc #'sis/misc))                         (lisp::misc #'sis/misc))
230               (:conc-name sis.)               (:conc-name sis.)
231               (:print-function %print-slime-output-stream))               (:print-function %print-slime-output-stream)
232    (buffer "" :type string)               (:constructor make-slime-input-stream (input-fn sos)))
233    (index 0 :type kernel:index))    (input-fn nil :type function)
234      ;; We know our sibling output stream, so that we can force it before
235      ;; requesting input.
236      (sos      nil :type slime-output-stream)
237      (buffer   ""  :type string)
238      (index    0   :type kernel:index))
240  (defun sis/in (stream eof-errorp eof-value)  (defun sis/in (stream eof-errorp eof-value)
   (declare (ignore eof-errorp eof-value))  
241    (let ((index (sis.index stream))    (let ((index (sis.index stream))
242          (buffer (sis.buffer stream)))          (buffer (sis.buffer stream)))
243      (when (= index (length buffer))      (when (= index (length buffer))
244        (setf buffer (slime-read-string))        (force-output (sis.sos stream))
245        (setf (sis.buffer stream) buffer)        (let ((string (funcall (sis.input-fn stream))))
246        (setf index 0))          (cond ((zerop (length string))
247                   (return-from sis/in
248                     (if eof-errorp
249                         (error (make-condition 'end-of-file :stream stream))
250                         eof-value)))
251                  (t
252                   (setf buffer string)
253                   (setf (sis.buffer stream) buffer)
254                   (setf index 0)))))
255      (prog1 (aref buffer index)      (prog1 (aref buffer index)
256        (setf (sis.index stream) (1+ index)))))        (setf (sis.index stream) (1+ index)))))
# Line 162  The request is read from the socket as a Line 263  The request is read from the socket as a
263      (:unread (setf (aref (sis.buffer stream)      (:unread (setf (aref (sis.buffer stream)
264                           (decf (sis.index stream)))                           (decf (sis.index stream)))
265                     arg1))                     arg1))
266      (:clear-input (setf (sis.index stream) 0      (:clear-input
267         (setf (sis.index stream) 0
268                          (sis.buffer stream) ""))                          (sis.buffer stream) ""))
269      (:listen (< (sis.index stream) (length (sis.buffer stream))))      (:listen (< (sis.index stream) (length (sis.buffer stream))))
270      (:charpos nil)      (:charpos nil)
# Line 174  The request is read from the socket as a Line 276  The request is read from the socket as a
277  ;;;; Compilation Commands  ;;;; Compilation Commands
 (defvar *swank-source-info* nil  
   "Bound to a SOURCE-INFO object during compilation.")  
279  (defvar *previous-compiler-condition* nil  (defvar *previous-compiler-condition* nil
280    "Used to detect duplicates.")    "Used to detect duplicates.")
282  (defvar *previous-context* nil  (defvar *previous-context* nil
283    "Previous compiler error context.")    "Previous compiler error context.")
285  (defvar *compiler-notes* '()  (defvar *buffer-name* nil
286    "List of compiler notes for the last compilation unit.")    "The name of the Emacs buffer we are compiling from.
287    NIL if we aren't compiling from a buffer.")
 (defvar *buffer-name* nil)  
289  (defvar *buffer-start-position* nil)  (defvar *buffer-start-position* nil)
290  (defvar *buffer-substring* nil)  (defvar *buffer-substring* nil)
291  (defvar *compile-filename* nil)  
292    (defimplementation call-with-compilation-hooks (function)
293      (let ((*previous-compiler-condition* nil)
294            (*previous-context* nil)
295            (*print-readably* nil))
296        (handler-bind ((c::compiler-error #'handle-notification-condition)
297                       (c::style-warning  #'handle-notification-condition)
298                       (c::warning        #'handle-notification-condition))
299          (funcall function))))
301    (defimplementation swank-compile-file (filename load-p)
302      (clear-xref-info filename)
303      (with-compilation-hooks ()
304        (let ((*buffer-name* nil)
305              (ext:*ignore-extra-close-parentheses* nil))
306          (multiple-value-bind (output-file warnings-p failure-p)
307              (compile-file filename)
308            (unless failure-p
309              ;; Cache the latest source file for definition-finding.
310              (source-cache-get filename (file-write-date filename))
311              (when load-p (load output-file)))
312            (values output-file warnings-p failure-p)))))
314    (defimplementation swank-compile-string (string &key buffer position directory)
315      (declare (ignore directory))
316      (with-compilation-hooks ()
317        (let ((*buffer-name* buffer)
318              (*buffer-start-position* position)
319              (*buffer-substring* string))
320          (with-input-from-string (stream string)
321            (ext:compile-from-stream
322             stream
323             :source-info `(:emacs-buffer ,buffer
324                            :emacs-buffer-offset ,position
325                            :emacs-buffer-string ,string))))))
328  ;;;;; Trapping notes  ;;;;; Trapping notes
329    ;;;
330    ;;; We intercept conditions from the compiler and resignal them as
333  (defun handle-notification-condition (condition)  (defun handle-notification-condition (condition)
334    "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  
335    (unless (eq condition *previous-compiler-condition*)    (unless (eq condition *previous-compiler-condition*)
336      (let ((context (or (c::find-error-context nil) *previous-context*)))      (let ((context (c::find-error-context nil)))
337        (setq *previous-compiler-condition* condition)        (setq *previous-compiler-condition* condition)
338        (setq *previous-context* context)        (setq *previous-context* context)
339        (signal-compiler-condition condition context))))        (signal-compiler-condition condition context))))
# Line 211  information." Line 343  information."
343             'compiler-condition             'compiler-condition
344             :original-condition condition             :original-condition condition
345             :severity (severity-for-emacs condition)             :severity (severity-for-emacs condition)
346             :message (brief-compiler-message-for-emacs condition context)             :short-message (brief-compiler-message-for-emacs condition)
347             :location (compiler-note-location context))))             :message (long-compiler-message-for-emacs condition context)
348               :location (if (read-error-p condition)
349                             (read-error-location condition)
350                             (compiler-note-location context)))))
352  (defun severity-for-emacs (condition)  (defun severity-for-emacs (condition)
353    "Return the severity of CONDITION."    "Return the severity of CONDITION."
354    (etypecase condition    (etypecase condition
355        ((satisfies read-error-p) :read-error)
356      (c::compiler-error :error)      (c::compiler-error :error)
357      (c::style-warning :note)      (c::style-warning :note)
358      (c::warning :warning)))      (c::warning :warning)))
360  (defun brief-compiler-message-for-emacs (condition error-context)  (defun read-error-p (condition)
361      (eq (type-of condition) 'c::compiler-read-error))
363    (defun brief-compiler-message-for-emacs (condition)
364    "Briefly describe a compiler error for Emacs.    "Briefly describe a compiler error for Emacs.
365  When Emacs presents the message it already has the source popped up  When Emacs presents the message it already has the source popped up
366  and the source form highlighted. This makes much of the information in  and the source form highlighted. This makes much of the information in
367  the error-context redundant."  the error-context redundant."
368      (princ-to-string condition))
370    (defun long-compiler-message-for-emacs (condition error-context)
371      "Describe a compiler error for Emacs including context information."
372    (declare (type (or c::compiler-error-context null) error-context))    (declare (type (or c::compiler-error-context null) error-context))
373    (multiple-value-bind (enclosing source)    (multiple-value-bind (enclosing source)
374        (if error-context        (if error-context
# Line 234  the error-context redundant." Line 377  the error-context redundant."
377      (format nil "~@[--> ~{~<~%--> ~1:;~A~> ~}~%~]~@[~{==>~%~A~^~%~}~]~A"      (format nil "~@[--> ~{~<~%--> ~1:;~A~> ~}~%~]~@[~{==>~%~A~^~%~}~]~A"
378              enclosing source condition)))              enclosing source condition)))
380    (defun read-error-location (condition)
381      (let* ((finfo (car (c::source-info-current-file c::*source-info*)))
382             (file (c::file-info-name finfo))
383             (pos (c::compiler-read-error-position condition)))
384        (cond ((and (eq file :stream) *buffer-name*)
385               (make-location (list :buffer *buffer-name*)
386                              (list :position (+ *buffer-start-position* pos))))
387              ((and (pathnamep file) (not *buffer-name*))
388               (make-location (list :file (unix-truename file))
389                              (list :position (1+ pos))))
390              (t (break)))))
392  (defun compiler-note-location (context)  (defun compiler-note-location (context)
393    (cond (context    "Derive the location of a complier message from its context.
394           (resolve-note-location  Return a `location' record, or (:error REASON) on failure."
395            *buffer-name*    (if (null context)
396            (c::compiler-error-context-file-name context)        (note-error-location)
397            (c::compiler-error-context-file-position context)        (let ((file (c::compiler-error-context-file-name context))
398            (reverse (c::compiler-error-context-original-source-path context))              (source (c::compiler-error-context-original-source context))
399            (c::compiler-error-context-original-source context)))              (path
400          (t               (reverse (c::compiler-error-context-original-source-path context))))
401           (resolve-note-location *buffer-name* nil nil nil nil))))          (or (locate-compiler-note file source path)
402                (note-error-location)))))
404    (defun note-error-location ()
405      "Pseudo-location for notes that can't be located."
406      (list :error "No error location available."))
408    (defun locate-compiler-note (file source source-path)
409      (cond ((and (eq file :stream) *buffer-name*)
410             ;; Compiling from a buffer
411             (let ((position (+ *buffer-start-position*
412                                (source-path-string-position
413                                 source-path *buffer-substring*))))
414               (make-location (list :buffer *buffer-name*)
415                              (list :position position))))
416            ((and (pathnamep file) (null *buffer-name*))
417             ;; Compiling from a file
418             (make-location (list :file (unix-truename file))
419                            (list :position
420                                  (1+ (source-path-file-position
421                                       source-path file)))))
422            ((and (eq file :lisp) (stringp source))
423             ;; No location known, but we have the source form.
424             ;; XXX How is this case triggered?  -luke (16/May/2004)
425             ;; This can happen if the compiler needs to expand a macro
426             ;; but the macro-expander is not yet compiled.  Calling the
427             ;; (interpreted) macro-expander triggers IR1 conversion of
428             ;; the lambda expression for the expander and invokes the
429             ;; compiler recursively.
430             (make-location (list :source-form source)
431                            (list :position 1)))))
433  (defgeneric resolve-note-location (buffer file-name file-position  (defun unix-truename (pathname)
434                                            source-path source))    (ext:unix-namestring (truename pathname)))
 (defmethod resolve-note-location ((b (eql nil)) (f pathname) pos path source)  
    `(:file ,(unix-truename f))  
    `(:position ,(1+ (source-path-file-position path f)))))  
 (defmethod resolve-note-location ((b string) (f (eql :stream)) pos path source)  
    `(:buffer ,b)  
    `(:position ,(+ *buffer-start-position*  
                    (source-path-string-position path *buffer-substring*)))))  
 (defmethod resolve-note-location (b (f (eql :lisp)) pos path (source string))  
    `(:source-form ,source)  
    `(:position 1)))  
 (defmethod resolve-note-location (buffer  
                                   (file (eql nil))  
                                   (pos (eql nil))  
                                   (path (eql nil))  
                                   (source (eql nil)))  
   (cond (buffer  
          (make-location (list :buffer buffer)  
                         (list :position *buffer-start-position*)))  
          (make-location (list :file (namestring *compile-file-truename*))  
                         (list :position 0)))  
          (make-location (list :file *compile-filename*) (list :position 0)))  
          (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))  
 (defmethod compile-file-for-emacs (filename load-p)  
   (clear-xref-info filename)  
   (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)  
          :source-info `(:emacs-buffer ,buffer  
                         :emacs-buffer-offset ,position  
                         :emacs-buffer-string ,string))))))  
437  ;;;; XREF  ;;;; XREF
438    ;;;
439    ;;; Cross-reference support is based on the standard CMUCL `XREF'
440    ;;; package. This package has some caveats: XREF information is
441    ;;; recorded during compilation and not preserved in fasl files, and
442    ;;; XREF recording is disabled by default. Redefining functions can
443    ;;; also cause duplicate references to accumulate, but
444    ;;; `swank-compile-file' will automatically clear out any old records
445    ;;; from the same filename.
446    ;;;
447    ;;; To enable XREF recording, set `c:*record-xref-info*' to true. To
448    ;;; clear out the XREF database call `xref:init-xref-database'.
450  (defun lookup-xrefs (finder name)  (defmacro defxref (name function)
451    (xref-results-for-emacs (funcall finder (from-string name))))    `(defimplementation ,name (name)
452        (xref-results (,function name))))
453  (defslimefun who-calls (function-name)  
454    "Return the places where FUNCTION-NAME is called."  (defxref who-calls      xref:who-calls)
455    (lookup-xrefs #'xref:who-calls function-name))  (defxref who-references xref:who-references)
456    (defxref who-binds      xref:who-binds)
457  (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))  
459    ;;; More types of XREF information were added since 18e:
460    ;;;
461  #+cmu19  #+cmu19
462  (progn  (progn
463    (defslimefun who-macroexpands (macro)    (defxref who-macroexpands xref:who-macroexpands)
464      "Return the places where MACRO is expanded."    ;; XXX
465      (lookup-xrefs #'xref:who-macroexpands macro))    (defimplementation who-specializes (symbol)
466        (let* ((methods (xref::who-specializes (find-class symbol)))
467    (defslimefun who-specializes (class)             (locations (mapcar #'method-location methods)))
468      "Return the methods with specializers for CLASS."        (mapcar #'list methods locations))))
469      (let* ((methods (xref::who-specializes (find-class (from-string class))))  
470             (locations (mapcar #'method-source-location methods)))  (defun xref-results (contexts)
471        (group-xrefs (mapcar (lambda (m l)    (mapcar (lambda (xref)
472                               (cons (let ((*print-pretty* nil))              (list (xref:xref-context-name xref)
473                                       (to-string m))                    (resolve-xref-location xref)))
474                                     l))            contexts))
                            methods locations))))  
476  (defun resolve-xref-location (xref)  (defun resolve-xref-location (xref)
477    (let ((name (xref:xref-context-name xref))    (let ((name (xref:xref-context-name xref))
# Line 363  the error-context redundant." Line 485  the error-context redundant."
485             (make-location (list :file (unix-truename file))             (make-location (list :file (unix-truename file))
486                            (list :function-name (string name))))                            (list :function-name (string name))))
487            (t            (t
488             `(:error ,(format nil "Unkown source location: ~S ~S ~S "             `(:error ,(format nil "Unknown source location: ~S ~S ~S "
489                               name file source-path))))))                               name file source-path))))))
 (defun xref-results-for-emacs (contexts)  
   "Prepare a list of xref contexts for Emacs.  
 The result is a list of xrefs:  
 group       ::= (FILENAME . ({reference}+))  
   (let ((xrefs '()))  
     (dolist (cxt contexts)  
       (let ((name (xref:xref-context-name cxt)))  
         (push (cons (to-string name)  
                     (resolve-xref-location cxt))  
     (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))))  
491  (defun clear-xref-info (namestring)  (defun clear-xref-info (namestring)
492    "Clear XREF notes pertaining to FILENAME.    "Clear XREF notes pertaining to NAMESTRING.
493  This is a workaround for a CMUCL bug: XREF records are cumulative."  This is a workaround for a CMUCL bug: XREF records are cumulative."
494    (let ((filename (parse-namestring namestring)))    (when c:*record-xref-info*
495      (when c:*record-xref-info*      (let ((filename (truename namestring)))
496        (dolist (db (list xref::*who-calls*        (dolist (db (list xref::*who-calls*
497                          #+cmu19 xref::*who-is-called*                          #+cmu19 xref::*who-is-called*
498                          #+cmu19 xref::*who-macroexpands*                          #+cmu19 xref::*who-macroexpands*
# Line 415  This is a workaround for a CMUCL bug: XR Line 500  This is a workaround for a CMUCL bug: XR
500                          xref::*who-binds*                          xref::*who-binds*
501                          xref::*who-sets*))                          xref::*who-sets*))
502          (maphash (lambda (target contexts)          (maphash (lambda (target contexts)
503                       ;; XXX update during traversal?
504                     (setf (gethash target db)                     (setf (gethash target db)
505                           (delete-if                           (delete filename contexts
506                            (lambda (ctx)                                   :key #'xref:xref-context-file
507                              (xref-context-derived-from-p ctx filename))                                   :test #'equalp)))
508                   db)))))                   db)))))
 (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)))  
511  ;;;; Find callers and callees  ;;;; Find callers and callees
512    ;;;
513  ;;; Find callers and callees by looking at the constant pool of  ;;; Find callers and callees by looking at the constant pool of
514  ;;; compiled code objects.  We assume every fdefn object in the  ;;; compiled code objects.  We assume every fdefn object in the
515  ;;; constant pool corresponds to a call to that function.  A better  ;;; constant pool corresponds to a call to that function.  A better
# Line 465  This is a workaround for a CMUCL bug: XR Line 539  This is a workaround for a CMUCL bug: XR
539  receives the object as argument.  SPACES should be a list of the  receives the object as argument.  SPACES should be a list of the
540  symbols :dynamic, :static, or :read-only."  symbols :dynamic, :static, or :read-only."
541    (dolist (space spaces)    (dolist (space spaces)
542      (declare (inline vm::map-allocated-objects))      (declare (inline vm::map-allocated-objects)
543                 (optimize (ext:inhibit-warnings 3)))
544      (vm::map-allocated-objects      (vm::map-allocated-objects
545       (lambda (obj header size)       (lambda (obj header size)
546         (declare (type fixnum size) (ignore size))         (declare (type fixnum size) (ignore size))
# Line 495  constant pool." Line 570  constant pool."
570    "Return FUNCTION's callers.  The result is a list of code-objects."    "Return FUNCTION's callers.  The result is a list of code-objects."
571    (let ((referrers '()))    (let ((referrers '()))
572      (declare (inline map-caller-code-components))      (declare (inline map-caller-code-components))
573      (ext:gc :full t)      ;;(ext:gc :full t)
574      (map-caller-code-components function spaces      (map-caller-code-components function spaces
575                                  (lambda (code) (push code referrers)))                                  (lambda (code) (push code referrers)))
576      referrers))      referrers))
578  (defun debug-info-definitions (debug-info)  (defun debug-info-definitions (debug-info)
579    "Return the defintions for a debug-info.  This should only be used    "Return the defintions for a debug-info.  This should only be used
580  for code-object without entry points, i.e., byte compiled  for code-object without entry points, i.e., byte compiled
# Line 512  code (are theree others?)" Line 587  code (are theree others?)"
587      (destructuring-bind (first) source      (destructuring-bind (first) source
588        (ecase (c::debug-source-from first)        (ecase (c::debug-source-from first)
589          (:file          (:file
590           (list           (list (list name
591            (cons name                       (make-location
592                  (make-location                        (list :file (unix-truename (c::debug-source-name first)))
593                   (list :file (unix-truename (c::debug-source-name first)))                        (list :function-name (string name))))))))))
                  (list :function-name name)))))))))  
595  (defun code-component-entry-points (code)  (defun code-component-entry-points (code)
596    "Return a list ((NAME . LOCATION) ...) of function definitons for    "Return a list ((NAME LOCATION) ...) of function definitons for
597  the code omponent CODE."  the code omponent CODE."
598    (delete-duplicates    (let ((names '()))
599     (loop for e = (kernel:%code-entry-points code)      (do ((f (kernel:%code-entry-points code) (kernel::%function-next f)))
600           then (kernel::%function-next e)          ((not f))
601           while e        (let ((name (kernel:%function-name f)))
602           collect (cons (to-string (kernel:%function-name e))          (when (ext:valid-function-name-p name)
603                         (function-source-location e)))            (push (list name (function-location f)) names))))
604     :test #'equal))      names))
606  (defslimefun list-callers (symbol-name)  (defimplementation list-callers (symbol)
607    "Return a list ((FILE . ((NAME . LOCATION) ...)) ...) of callers."    "Return a list ((NAME LOCATION) ...) of callers."
608    (let ((components (function-callers (from-string symbol-name)))    (let ((components (function-callers symbol))
609          (xrefs '()))          (xrefs '()))
610      (dolist (code components)      (dolist (code components)
611        (let* ((entry (kernel:%code-entry-points code))        (let* ((entry (kernel:%code-entry-points code))
# Line 541  the code omponent CODE." Line 615  the code omponent CODE."
615                         (debug-info-definitions                         (debug-info-definitions
616                          (kernel:%code-debug-info code)))))                          (kernel:%code-debug-info code)))))
617          (setq xrefs (nconc defs xrefs))))          (setq xrefs (nconc defs xrefs))))
618      (group-xrefs xrefs)))      xrefs))
620    (defimplementation list-callees (symbol)
621      (let ((fns (function-callees symbol)))
622        (mapcar (lambda (fn)
623                  (list (kernel:%function-name fn)
624                        (function-location fn)))
625                fns)))
627  (defslimefun list-callees (symbol-name)  
628    (let ((fns (function-callees (from-string symbol-name))))  ;;;; Resolving source locations
629      (group-xrefs (mapcar (lambda (fn)  ;;;
630                             (cons (to-string (kernel:%function-name fn))  ;;; Our mission here is to "resolve" references to code locations into
631                                   (function-source-location fn)))  ;;; actual file/buffer names and character positions. The references
632                           fns))))  ;;; we work from come out of the compiler's statically-generated debug
633    ;;; information, such as `code-location''s and `debug-source''s. For
634  ;;;; Definitions  ;;; more details, see the "Debugger Programmer's Interface" section of
635    ;;; the CMUCL manual.
636    ;;;
637    ;;; The first step is usually to find the corresponding "source-path"
638    ;;; for the location. Once we have the source-path we can pull up the
639    ;;; source file and `READ' our way through to the right position. The
640    ;;; main source-code groveling work is done in
641    ;;; `swank-source-path-parser.lisp'.
643  (defvar *debug-definition-finding* t  (defvar *debug-definition-finding* nil
644    "When true don't handle errors while looking for definitions.    "When true don't handle errors while looking for definitions.
645  This is useful when debugging the definition-finding code.")  This is useful when debugging the definition-finding code.")
647    (defvar *source-snippet-size* 256
648      "Maximum number of characters in a snippet of source code.
649    Snippets at the beginning of definitions are used to tell Emacs what
650    the definitions looks like, so that it can accurately find them by
651    text search.")
653  (defmacro safe-definition-finding (&body body)  (defmacro safe-definition-finding (&body body)
654    "Execute BODY ignoring errors.  Return a the source location    "Execute BODY and return the source-location it returns.
655  returned by BODY or if an error occurs a description of the error.  If an error occurs and `*debug-definition-finding*' is false, then
656  The second return value is the condition or nil."  return an error pseudo-location.
658    The second return value is NIL if no error occurs, otherwise it is the
659    condition object."
660    `(flet ((body () ,@body))    `(flet ((body () ,@body))
661      (if *debug-definition-finding*      (if *debug-definition-finding*
662          (body)          (body)
663          (handler-case (values (progn ,@body) nil)          (handler-case (values (progn ,@body) nil)
664            (error (c) (values (list :error (princ-to-string c)) c))))))            (error (c) (values (list :error (princ-to-string c)) c))))))
666    (defun code-location-source-location (code-location)
667      "Safe wrapper around `code-location-from-source-location'."
668      (safe-definition-finding
669       (source-location-from-code-location code-location)))
671    (defun source-location-from-code-location (code-location)
672      "Return the source location for CODE-LOCATION."
673      (let ((debug-fun (di:code-location-debug-function code-location)))
674        (when (di::bogus-debug-function-p debug-fun)
675          ;; Those lousy cheapskates! They've put in a bogus debug source
676          ;; because the code was compiled at a low debug setting.
677          (error "Bogus debug function: ~A" debug-fun)))
678      (let* ((debug-source (di:code-location-debug-source code-location))
679             (from (di:debug-source-from debug-source))
680             (name (di:debug-source-name debug-source)))
681        (ecase from
682          (:file
683           (location-in-file name code-location debug-source))
684          (:stream
685           (location-in-stream code-location debug-source))
686          (:lisp
687           ;; The location comes from a form passed to `compile'.
688           ;; The best we can do is return the form itself for printing.
689           (make-location
690            (list :source-form (with-output-to-string (*standard-output*)
691                                 (debug::print-code-location-source-form
692                                  code-location 100 t)))
693            (list :position 1))))))
695    (defun location-in-file (filename code-location debug-source)
696      "Resolve the source location for CODE-LOCATION in FILENAME."
697      (let* ((code-date (di:debug-source-created debug-source))
698             (source-code (get-source-code filename code-date)))
699        (with-input-from-string (s source-code)
700          (make-location (list :file (unix-truename filename))
701                         (list :position (1+ (code-location-stream-position
702                                              code-location s)))
703                         `(:snippet ,(read-snippet s))))))
705    (defun location-in-stream (code-location debug-source)
706      "Resolve the source location for a CODE-LOCATION from a stream.
707    This only succeeds if the code was compiled from an Emacs buffer."
708      (unless (debug-source-info-from-emacs-buffer-p debug-source)
709        (error "The code is compiled from a non-SLIME stream."))
710      (let* ((info (c::debug-source-info debug-source))
711             (string (getf info :emacs-buffer-string))
712             (position (code-location-string-offset
713                        code-location
714                        string)))
715        (make-location
716         (list :buffer (getf info :emacs-buffer))
717         (list :position (+ (getf info :emacs-buffer-offset) position))
718         (list :snippet (with-input-from-string (s string)
719                          (file-position s position)
720                          (read-snippet s))))))
722    ;;;;; Function-name locations
723    ;;;
724    (defun debug-info-function-name-location (debug-info)
725      "Return a function-name source-location for DEBUG-INFO.
726    Function-name source-locations are a fallback for when precise
727    positions aren't available."
728      (with-struct (c::debug-info- (fname name) source) debug-info
729        (with-struct (c::debug-source- info from name) (car source)
730          (ecase from
731            (:file
732             (make-location (list :file (namestring (truename name)))
733                            (list :function-name (string fname))))
734            (:stream
735             (assert (debug-source-info-from-emacs-buffer-p (car source)))
736             (make-location (list :buffer (getf info :emacs-buffer))
737                            (list :function-name (string fname))))
738            (:lisp
739             (make-location (list :source-form (princ-to-string (aref name 0)))
740                            (list :position 1)))))))
742    (defun debug-source-info-from-emacs-buffer-p (debug-source)
743      "Does the `info' slot of DEBUG-SOURCE contain an Emacs buffer location?
744    This is true for functions that were compiled directly from buffers."
745      (info-from-emacs-buffer-p (c::debug-source-info debug-source)))
747    (defun info-from-emacs-buffer-p (info)
748      (and info
749           (consp info)
750           (eq :emacs-buffer (car info))))
753    ;;;;; Groveling source-code for positions
755    (defun code-location-stream-position (code-location stream)
756      "Return the byte offset of CODE-LOCATION in STREAM.  Extract the
757    toplevel-form-number and form-number from CODE-LOCATION and use that
758    to find the position of the corresponding form.
760    Finish with STREAM positioned at the start of the code location."
761      (let* ((location (debug::maybe-block-start-location code-location))
762             (tlf-offset (di:code-location-top-level-form-offset location))
763             (form-number (di:code-location-form-number location)))
764        (let ((pos (form-number-stream-position tlf-offset form-number stream)))
765          (file-position stream pos)
766          pos)))
768    (defun form-number-stream-position (tlf-number form-number stream)
769      "Return the starting character position of a form in STREAM.
770    TLF-NUMBER is the top-level-form number.
771    FORM-NUMBER is an index into a source-path table for the TLF."
772      (multiple-value-bind (tlf position-map) (read-source-form tlf-number stream)
773        (let* ((path-table (di:form-number-translations tlf 0))
774               (source-path
775                (if (<= (length path-table) form-number) ; source out of sync?
776                    (list 0)                ; should probably signal a condition
777                    (reverse (cdr (aref path-table form-number))))))
778          (source-path-source-position source-path tlf position-map))))
780    (defun code-location-string-offset (code-location string)
781      "Return the byte offset of CODE-LOCATION in STRING.
783      (with-input-from-string (s string)
784        (code-location-stream-position code-location s)))
787    ;;;; Finding definitions
789    ;;; There are a great many different types of definition for us to
790    ;;; find. We search for definitions of every kind and return them in a
791    ;;; list.
793    (defimplementation find-definitions (name)
794      (append (function-definitions name)
795              (setf-definitions name)
796              (variable-definitions name)
797              (class-definitions name)
798              (type-definitions name)
799              (compiler-macro-definitions name)
800              (source-transform-definitions name)
801              (function-info-definitions name)
802              (ir1-translator-definitions name)))
804    ;;;;; Functions, macros, generic functions, methods
805    ;;;
806    ;;; We make extensive use of the compile-time debug information that
807    ;;; CMUCL records, in particular "debug functions" and "code
808    ;;; locations." Refer to the "Debugger Programmer's Interface" section
809    ;;; of the CMUCL manual for more details.
811    (defun function-definitions (name)
812      "Return definitions for NAME in the \"function namespace\", i.e.,
813    regular functions, generic functions, methods and macros.
814    NAME can any valid function name (e.g, (setf car))."
815      (let ((macro?    (and (symbolp name) (macro-function name)))
816            (special?  (and (symbolp name) (special-operator-p name)))
817            (function? (and (ext:valid-function-name-p name)
818                            (ext:info :function :definition name)
819                            (if (symbolp name) (fboundp name) t))))
820        (cond (macro?
821               (list `((defmacro ,name)
822                       ,(function-location (macro-function name)))))
823              (special?
824               (list `((:special-operator ,name)
825                       (:error ,(format nil "Special operator: ~S" name)))))
826              (function?
827               (let ((function (fdefinition name)))
828                 (if (genericp function)
829                     (generic-function-definitions name function)
830                     (list (list `(function ,name)
831                                 (function-location function)))))))))
833    ;;;;;; Ordinary (non-generic/macro/special) functions
834    ;;;
835    ;;; First we test if FUNCTION is a closure created by defstruct, and
836    ;;; if so extract the defstruct-description (`dd') from the closure
837    ;;; and find the constructor for the struct.  Defstruct creates a
838    ;;; defun for the default constructor and we use that as an
839    ;;; approximation to the source location of the defstruct.
840    ;;;
841    ;;; For an ordinary function we return the source location of the
842    ;;; first code-location we find.
843    ;;;
844    (defun function-location (function)
845      "Return the source location for FUNCTION."
846      (cond ((struct-closure-p function)
847             (struct-closure-location function))
848            ((c::byte-function-or-closure-p function)
849             (byte-function-location function))
850            (t
851             (compiled-function-location function))))
853    (defun compiled-function-location (function)
854      "Return the location of a regular compiled function."
855      (multiple-value-bind (code-location error)
856          (safe-definition-finding (function-first-code-location function))
857        (cond (error (list :error (princ-to-string error)))
858              (t (code-location-source-location code-location)))))
860  (defun function-first-code-location (function)  (defun function-first-code-location (function)
861      "Return the first code-location we can find for FUNCTION."
862    (and (function-has-debug-function-p function)    (and (function-has-debug-function-p function)
863         (di:debug-function-start-location         (di:debug-function-start-location
864          (di:function-debug-function function))))          (di:function-debug-function function))))
# Line 580  The second return value is the condition Line 871  The second return value is the condition
871             (vm::find-code-object function))             (vm::find-code-object function))
872         (not (eq closure function))))         (not (eq closure function))))
875    (defun byte-function-location (fn)
876      "Return the location of the byte-compiled function FN."
877      (etypecase fn
878        ((or c::hairy-byte-function c::simple-byte-function)
879         (let* ((component (c::byte-function-component fn))
880                (debug-info (kernel:%code-debug-info component)))
881           (debug-info-function-name-location debug-info)))
882        (c::byte-closure
883         (byte-function-location (c::byte-closure-function fn)))))
885    ;;; Here we deal with structure accessors. Note that `dd' is a
886    ;;; "defstruct descriptor" structure in CMUCL. A `dd' describes a
887    ;;; `defstruct''d structure.
889  (defun struct-closure-p (function)  (defun struct-closure-p (function)
890      "Is FUNCTION a closure created by defstruct?"
891    (or (function-code-object= function #'kernel::structure-slot-accessor)    (or (function-code-object= function #'kernel::structure-slot-accessor)
892        (function-code-object= function #'kernel::structure-slot-setter)        (function-code-object= function #'kernel::structure-slot-setter)
893        (function-code-object= function #'kernel::%defstruct)))        (function-code-object= function #'kernel::%defstruct)))
895    (defun struct-closure-location (function)
896      "Return the location of the structure that FUNCTION belongs to."
897      (assert (struct-closure-p function))
898      (safe-definition-finding
899        (dd-location (struct-closure-dd function))))
901  (defun struct-closure-dd (function)  (defun struct-closure-dd (function)
902      "Return the defstruct-definition (dd) of FUNCTION."
903    (assert (= (kernel:get-type function) vm:closure-header-type))    (assert (= (kernel:get-type function) vm:closure-header-type))
904    (flet ((find-layout (function)    (flet ((find-layout (function)
905             (sys:find-if-in-closure             (sys:find-if-in-closure
# Line 597  The second return value is the condition Line 911  The second return value is the condition
911                    (return-from find-layout value))))                    (return-from find-layout value))))
912              function)))              function)))
913      (kernel:layout-info (find-layout function))))      (kernel:layout-info (find-layout function))))
915  (defun dd-source-location (dd)  (defun dd-location (dd)
916      "Return the location of a `defstruct'."
917      ;; Find the location in a constructor.
918      (function-location (struct-constructor dd)))
920    (defun struct-constructor (dd)
921      "Return a constructor function from a defstruct definition.
922    Signal an error if no constructor can be found."
923    (let ((constructor (or (kernel:dd-default-constructor dd)    (let ((constructor (or (kernel:dd-default-constructor dd)
924                           (car (kernel::dd-constructors dd)))))                           (car (kernel::dd-constructors dd)))))
925      (when (or (not constructor) (and (consp constructor)      (when (or (null constructor)
926                                       (not (car constructor))))                (and (consp constructor) (null (car constructor))))
927        (error "Cannot locate struct without constructor: ~S"        (error "Cannot find structure's constructor: ~S"
928               (kernel::dd-name dd)))               (kernel::dd-name dd)))
929      (function-source-location      (coerce (if (consp constructor) (first constructor) constructor)
930       (coerce (if (consp constructor) (car constructor) constructor)              'function)))
931               'function))))  
932    ;;;;;; Generic functions and methods
934    (defun generic-function-definitions (name function)
935      "Return the definitions of a generic function and its methods."
936      (cons (list `(defgeneric ,name) (gf-location function))
937            (gf-method-definitions function)))
939    (defun gf-location (gf)
940      "Return the location of the generic function GF."
941      (definition-source-location gf (pcl::generic-function-name gf)))
943    (defun gf-method-definitions (gf)
944      "Return the locations of all methods of the generic function GF."
945      (mapcar #'method-definition (pcl::generic-function-methods gf)))
947    (defun method-definition (method)
948      (list (method-dspec method)
949            (method-location method)))
951    (defun method-dspec (method)
952      "Return a human-readable \"definition specifier\" for METHOD."
953      (let* ((gf (pcl:method-generic-function method))
954             (name (pcl:generic-function-name gf))
955             (specializers (pcl:method-specializers method))
956             (qualifiers (pcl:method-qualifiers method)))
957        `(method ,name ,@qualifiers ,(pcl::unparse-specializers specializers))))
959    ;; XXX maybe special case setters/getters
960    (defun method-location (method)
961      (function-location (or (pcl::method-fast-function method)
962                             (pcl:method-function method))))
964  (defun genericp (fn)  (defun genericp (fn)
965    (typep fn 'generic-function))    (typep fn 'generic-function))
967  (defun gf-definition-location (gf)  ;;;;;; Types and classes
968    (flet ((guess-source-file (faslfile)  
969             (unix-truename  (defun type-definitions (name)
970              (merge-pathnames (make-pathname :type "lisp")    "Return `deftype' locations for type NAME."
971                               faslfile))))    (maybe-make-definition (ext:info :type :expander name) 'deftype name))
972      (let ((def-source (pcl::definition-source gf))  
973            (name (string (pcl:generic-function-name gf))))  (defun maybe-make-definition (function kind name)
974        (etypecase def-source    "If FUNCTION is non-nil then return its definition location."
975          (pathname (make-location    (if function
976                     `(:file ,(guess-source-file def-source))        (list (list `(,kind ,name) (function-location function)))))
977                     `(:function-name ,name)))  
978          (cons  (defun class-definitions (name)
979           (destructuring-bind ((dg name) pathname) def-source    "Return the definition locations for the class called NAME."
980             (declare (ignore dg))    (if (symbolp name)
981             (etypecase pathname        (let ((class (kernel::find-class name nil)))
982               (pathname          (etypecase class
983                (make-location `(:file ,(guess-source-file pathname))            (null '())
984                               `(:function-name ,(string name)))))))))))            (kernel::structure-class
985               (list (list `(defstruct ,name) (dd-location (find-dd name)))))
986  (defun method-source-location (method)            #+(or)
987    (function-source-location (or (pcl::method-fast-function method)            (conditions::condition-class
988                                  (pcl:method-function method))))             (list (list `(define-condition ,name)
989                           (condition-class-location class))))
990  (defun gf-method-locations (gf)            (kernel::standard-class
991    (let ((ms (pcl::generic-function-methods gf)))             (list (list `(defclass ,name)
992      (mapcar #'method-source-location ms)))                         (class-location (find-class name)))))
993              ((or kernel::built-in-class
994  (defun gf-source-locations (gf)                 conditions::condition-class
995    (list* (gf-definition-location gf)                 kernel:funcallable-structure-class)
996           (gf-method-locations gf)))             (list (list `(kernel::define-type-class ,name)
997                           `(:error
998  (defun function-source-locations (function)                           ,(format nil "No source info for ~A" name)))))))))
999    "Return a list of source locations for FUNCTION."  
1000    ;; First test if FUNCTION is a closure created by defstruct; if so  (defun class-location (class)
1001    ;; extract the defstruct-description (dd) from the closure and find    "Return the `defclass' location for CLASS."
1002    ;; the constructor for the struct.  Defstruct creates a defun for    (definition-source-location class (pcl:class-name class)))
1003    ;; the default constructor and we use that as an approximation to  
1004    ;; the source location of the defstruct.  (defun find-dd (name)
1005    ;;    "Find the defstruct-definition by the name of its structure-class."
1006    ;; For an ordinary function we return the source location of the    (let ((layout (ext:info :type :compiler-layout name)))
1007    ;; first code-location we find.      (if layout
1008    (cond ((struct-closure-p function)          (kernel:layout-info layout))))
1009           (list  
1010            (safe-definition-finding  (defun condition-class-location (class)
1011             (dd-source-location (struct-closure-dd function)))))    (let ((slots (conditions::condition-class-slots class))
1012          ((genericp function)          (name (conditions::condition-class-name class)))
1013           (gf-source-locations function))      (cond ((null slots)
1014          (t             `(:error ,(format nil "No location info for condition: ~A" name)))
1015           (list            (t
1016            (multiple-value-bind (code-location error)             ;; Find the class via one of its slot-reader methods.
1017                (safe-definition-finding (function-first-code-location function))             (let* ((slot (first slots))
1018              (cond (error (list :error (princ-to-string error)))                    (gf (fdefinition
1019                    (t (code-location-source-location code-location))))))))                         (first (conditions::condition-slot-readers slot)))))
1020                 (method-location
1021  (defun function-source-location (function)                (first
1022    (destructuring-bind (first) (function-source-locations function)                 (pcl:compute-applicable-methods-using-classes
1023      first))                  gf (list (find-class name))))))))))
1025  (defslimefun find-function-locations (symbol-name)  (defun make-name-in-file-location (file string)
1026    "Return a list of source-locations for SYMBOL-NAME's functions."    (multiple-value-bind (filename c)
1027    (multiple-value-bind (symbol foundp) (find-symbol-designator symbol-name)        (ignore-errors
1028      (cond ((not foundp)          (unix-truename (merge-pathnames (make-pathname :type "lisp")
1029             (list (list :error (format nil "Unkown symbol: ~A" symbol-name))))                                          file)))
1030            ((macro-function symbol)      (cond (filename (make-location `(:file ,filename)
1031             (function-source-locations (macro-function symbol)))                                     `(:function-name ,(string string))))
1032            ((special-operator-p symbol)            (t (list :error (princ-to-string c))))))
1033             (list (list :error (format nil "~A is a special-operator" symbol))))  
1034            ((fboundp symbol)  (defun source-location-form-numbers (location)
1035             (function-source-locations (coerce symbol 'function)))    (c::decode-form-numbers (c::form-numbers-form-numbers location)))
1036            (t (list (list :error  
1037                           (format nil "Symbol not fbound: ~A" symbol-name))))  (defun source-location-tlf-number (location)
1038            )))    (nth-value 0 (source-location-form-numbers location)))
1040    (defun source-location-form-number (location)
1041      (nth-value 1 (source-location-form-numbers location)))
1043    (defun resolve-file-source-location (location)
1044      (let ((filename (c::file-source-location-pathname location))
1045            (tlf-number (source-location-tlf-number location))
1046            (form-number (source-location-form-number location)))
1047        (with-open-file (s filename)
1048          (let ((pos (form-number-stream-position tlf-number form-number s)))
1049            (make-location `(:file ,(unix-truename filename))
1050                           `(:position ,(1+ pos)))))))
1052    (defun resolve-stream-source-location (location)
1053      (let ((info (c::stream-source-location-user-info location))
1054            (tlf-number (source-location-tlf-number location))
1055            (form-number (source-location-form-number location)))
1056        ;; XXX duplication in frame-source-location
1057        (assert (info-from-emacs-buffer-p info))
1058        (destructuring-bind (&key emacs-buffer emacs-buffer-string
1059                                  emacs-buffer-offset) info
1060          (with-input-from-string (s emacs-buffer-string)
1061            (let ((pos (form-number-stream-position tlf-number form-number s)))
1062              (make-location `(:buffer ,emacs-buffer)
1063                             `(:position ,(+ emacs-buffer-offset pos))))))))
1065    ;; XXX predicates for 18e backward compatibilty.  Remove them when
1066    ;; we're 19a only.
1067    (defun file-source-location-p (object)
1068      (when (fboundp 'c::file-source-location-p)
1069        (c::file-source-location-p object)))
1071    (defun stream-source-location-p (object)
1072      (when (fboundp 'c::stream-source-location-p)
1073        (c::stream-source-location-p object)))
1075    (defun source-location-p (object)
1076      (or (file-source-location-p object)
1077          (stream-source-location-p object)))
1079    (defun resolve-source-location (location)
1080      (etypecase location
1081        ((satisfies file-source-location-p)
1082         (resolve-file-source-location location))
1083        ((satisfies stream-source-location-p)
1084         (resolve-stream-source-location location))))
1086    (defun definition-source-location (object name)
1087      (let ((source (pcl::definition-source object)))
1088        (etypecase source
1089          (null
1090           `(:error ,(format nil "No source info for: ~A" object)))
1091          ((satisfies source-location-p)
1092           (resolve-source-location source))
1093          (pathname
1094           (make-name-in-file-location source name))
1095          (cons
1096           (destructuring-bind ((dg name) pathname) source
1097             (declare (ignore dg))
1098             (etypecase pathname
1099               (pathname (make-name-in-file-location pathname (string name)))
1100               (null `(:error ,(format nil "Cannot resolve: ~S" source)))))))))
1102    (defun setf-definitions (name)
1103      (let ((function (or (ext:info :setf :inverse name)
1104                          (ext:info :setf :expander name))))
1105        (if function
1106            (list (list `(setf ,name)
1107                        (function-location (coerce function 'function)))))))
1110    (defun variable-location (symbol)
1111      (multiple-value-bind (location foundp)
1112          ;; XXX for 18e compatibilty. rewrite this when we drop 18e
1113          ;; support.
1114          (ignore-errors (eval `(ext:info :source-location :defvar ',symbol)))
1115        (if (and foundp location)
1116            (resolve-source-location location)
1117            `(:error ,(format nil "No source info for variable ~S" symbol)))))
1119    (defun variable-definitions (name)
1120      (if (symbolp name)
1121          (multiple-value-bind (kind recorded-p) (ext:info :variable :kind name)
1122            (if recorded-p
1123                (list (list `(variable ,kind ,name)
1124                            (variable-location name)))))))
1126    (defun compiler-macro-definitions (symbol)
1127      (maybe-make-definition (compiler-macro-function symbol)
1128                             'define-compiler-macro
1129                             symbol))
1131    (defun source-transform-definitions (name)
1132      (maybe-make-definition (ext:info :function :source-transform name)
1133                             'c:def-source-transform
1134                             name))
1136    (defun function-info-definitions (name)
1137      (let ((info (ext:info :function :info name)))
1138        (if info
1139            (append (loop for transform in (c::function-info-transforms info)
1140                          collect (list `(c:deftransform ,name
1141                                          ,(c::type-specifier
1142                                            (c::transform-type transform)))
1143                                        (function-location (c::transform-function
1144                                                            transform))))
1145                    (maybe-make-definition (c::function-info-derive-type info)
1146                                           'c::derive-type name)
1147                    (maybe-make-definition (c::function-info-optimizer info)
1148                                           'c::optimizer name)
1149                    (maybe-make-definition (c::function-info-ltn-annotate info)
1150                                           'c::ltn-annotate name)
1151                    (maybe-make-definition (c::function-info-ir2-convert info)
1152                                           'c::ir2-convert name)
1153                    (loop for template in (c::function-info-templates info)
1154                          collect (list `(c::vop ,(c::template-name template))
1155                                        (function-location
1156                                         (c::vop-info-generator-function
1157                                          template))))))))
1159    (defun ir1-translator-definitions (name)
1160      (maybe-make-definition (ext:info :function :ir1-convert name)
1161                             'c:def-ir1-translator name))
1164  ;;;; Documentation.  ;;;; Documentation.
1166  (defmethod describe-symbol-for-emacs (symbol)  (defimplementation describe-symbol-for-emacs (symbol)
1167    (let ((result '()))    (let ((result '()))
1168      (flet ((doc (kind)      (flet ((doc (kind)
1169               (or (documentation symbol kind) :not-documented))               (or (documentation symbol kind) :not-documented))
# Line 734  The second return value is the condition Line 1209  The second return value is the condition
1209                         (doc nil)))                         (doc nil)))
1210        result)))        result)))
1212  (defslimefun describe-setf-function (symbol-name)  (defimplementation describe-definition (symbol namespace)
1213    (print-description-to-string    (describe (ecase namespace
1214     (or (ext:info setf inverse (from-string symbol-name))                (:variable
1215         (ext:info setf expander (from-string symbol-name)))))                 symbol)
1216                  ((:function :generic-function)
1217  (defslimefun describe-type (symbol-name)                 (symbol-function symbol))
1218    (print-description-to-string                (:setf
1219     (kernel:values-specifier-type (from-string symbol-name))))                 (or (ext:info setf inverse symbol)
1220                       (ext:info setf expander symbol)))
1221  (defslimefun describe-class (symbol-name)                (:type
1222    (print-description-to-string (find-class (from-string symbol-name) nil)))                 (kernel:values-specifier-type symbol))
1223                  (:class
1224  (defslimefun describe-alien-type (symbol-name)                 (find-class symbol))
1225    (let ((name (from-string symbol-name)))                (:alien-struct
1226      (ecase (ext:info :alien-type :kind name)                 (ext:info :alien-type :struct symbol))
1227        (:primitive                (:alien-union
1228         (print-description-to-string                 (ext:info :alien-type :union symbol))
1229          (let ((alien::*values-type-okay* t))                (:alien-enum
1230            (funcall (ext:info :alien-type :translator name) (list name)))))                 (ext:info :alien-type :enum symbol))
1231        ((:defined)                (:alien-type
1232         (print-description-to-string (ext:info :alien-type :definition name)))                 (ecase (ext:info :alien-type :kind symbol)
1233        (:unknown                   (:primitive
1234         (format nil "Unkown alien type: ~A" symbol-name)))))                    (let ((alien::*values-type-okay* t))
1235                        (funcall (ext:info :alien-type :translator symbol)
1236  (defmacro %describe-alien (symbol-name namespace)                               (list symbol))))
1237    `(print-description-to-string                   ((:defined)
1238      (ext:info :alien-type ,namespace (from-string ,symbol-name))))                    (ext:info :alien-type :definition symbol))
1239                     (:unknown
1240  (defslimefun describe-alien-struct (symbol-name)                    (return-from describe-definition
1241    (%describe-alien symbol-name :struct))                      (format nil "Unknown alien type: ~S" symbol))))))))
1243  (defslimefun describe-alien-union (symbol-name)  ;;;;; Argument lists
1244    (%describe-alien symbol-name :union))  
1245    (defimplementation arglist ((name symbol))
1246  (defslimefun describe-alien-enum (symbol-name)    (arglist (or (macro-function name)
1247    (%describe-alien symbol-name :enum))                 (symbol-function name))))
1249  (defmethod arglist-string (fname)  (defimplementation arglist ((fun function))
1250    "Return a string describing the argument list for FNAME.    (function-arglist fun))
1251  The result has the format \"(...)\"."  
1252    (declare (type string fname))  (defun function-arglist (fun)
1253    (multiple-value-bind (function condition)    (let ((arglist
1254        (ignore-errors (values (find-symbol-designator fname *buffer-package*)))           (cond ((eval:interpreted-function-p fun)
1255      (when condition                  (eval:interpreted-function-arglist fun))
1256        (return-from arglist-string (format nil "(-- ~A)" condition)))                 ((pcl::generic-function-p fun)
1257      (let ((arglist                  (pcl:generic-function-lambda-list fun))
1258             (if (not (or (fboundp function)                 ((c::byte-function-or-closure-p fun)
1259                          (functionp function)))                  (byte-code-function-arglist fun))
1260                 "(-- <Unknown-Function>)"                 ((kernel:%function-arglist (kernel:%function-self fun))
1261                 (let* ((fun (or (macro-function function)                  (handler-case (read-arglist fun)
1262                                 (symbol-function function)))                    (error () :not-available)))
1263                        (df (di::function-debug-function fun))                 ;; this should work both for compiled-debug-function
1264                        (arglist (kernel:%function-arglist fun)))                 ;; and for interpreted-debug-function
1265                   (cond ((eval:interpreted-function-p fun)                 (t
1266                          (eval:interpreted-function-arglist fun))                  (handler-case (debug-function-arglist
1267                         ((pcl::generic-function-p fun)                                 (di::function-debug-function fun))
1268                          (pcl::gf-pretty-arglist fun))                    (di:unhandled-condition () :not-available))))))
1269                         (arglist arglist)      (check-type arglist (or list (member :not-available)))
1270                         ;; this should work both for      arglist))
1271                         ;; compiled-debug-function and for  
1272                         ;; interpreted-debug-function  (defimplementation function-name (function)
1273                         (df (di::debug-function-lambda-list df))    (cond ((eval:interpreted-function-p function)
1274                         (t "(<arglist-unavailable>)"))))))           (eval:interpreted-function-name function))
1275        (if (stringp arglist)          ((pcl::generic-function-p function)
1276            arglist           (pcl::generic-function-name function))
1277            (to-string arglist)))))          ((c::byte-function-or-closure-p function)
1278             (c::byte-function-name function))
1279            (t (kernel:%function-name (kernel:%function-self function)))))
1281    ;;; A simple case: the arglist is available as a string that we can
1282    ;;; `read'.
1284    (defun read-arglist (fn)
1285      "Parse the arglist-string of the function object FN."
1286      (let ((string (kernel:%function-arglist
1287                     (kernel:%function-self fn)))
1288            (package (find-package
1289                      (c::compiled-debug-info-package
1290                       (kernel:%code-debug-info
1291                        (vm::find-code-object fn))))))
1292        (with-standard-io-syntax
1293          (let ((*package* (or package *package*)))
1294            (read-from-string string)))))
1296    ;;; A harder case: an approximate arglist is derived from available
1297    ;;; debugging information.
1299    (defun debug-function-arglist (debug-function)
1300      "Derive the argument list of DEBUG-FUNCTION from debug info."
1301      (let ((args (di::debug-function-lambda-list debug-function))
1302            (required '())
1303            (optional '())
1304            (rest '())
1305            (key '()))
1306        ;; collect the names of debug-vars
1307        (dolist (arg args)
1308          (etypecase arg
1309            (di::debug-variable
1310             (push (di::debug-variable-symbol arg) required))
1311            ((member :deleted)
1312             (push ':deleted required))
1313            (cons
1314             (ecase (car arg)
1315               (:keyword
1316                (push (second arg) key))
1317               (:optional
1318                (push (debug-variable-symbol-or-deleted (second arg)) optional))
1319               (:rest
1320                (push (debug-variable-symbol-or-deleted (second arg)) rest))))))
1321        ;; intersperse lambda keywords as needed
1322        (append (nreverse required)
1323                (if optional (cons '&optional (nreverse optional)))
1324                (if rest (cons '&rest (nreverse rest)))
1325                (if key (cons '&key (nreverse key))))))
1327    (defun debug-variable-symbol-or-deleted (var)
1328      (etypecase var
1329        (di:debug-variable
1330         (di::debug-variable-symbol var))
1331        ((member :deleted)
1332         '#:deleted)))
1334    (defun symbol-debug-function-arglist (fname)
1335      "Return FNAME's debug-function-arglist and %function-arglist.
1336    A utility for debugging DEBUG-FUNCTION-ARGLIST."
1337      (let ((fn (fdefinition fname)))
1338        (values (debug-function-arglist (di::function-debug-function fn))
1339                (kernel:%function-arglist (kernel:%function-self fn)))))
1341    ;;; Deriving arglists for byte-compiled functions:
1342    ;;;
1343    (defun byte-code-function-arglist (fn)
1344      ;; There doesn't seem to be much arglist information around for
1345      ;; byte-code functions.  Use the arg-count and return something like
1346      ;; (arg0 arg1 ...)
1347      (etypecase fn
1348        (c::simple-byte-function
1349         (loop for i from 0 below (c::simple-byte-function-num-args fn)
1350               collect (make-arg-symbol i)))
1351        (c::hairy-byte-function
1352         (hairy-byte-function-arglist fn))
1353        (c::byte-closure
1354         (byte-code-function-arglist (c::byte-closure-function fn)))))
1356    (defun make-arg-symbol (i)
1357      (make-symbol (format nil "~A~D" (string 'arg) i)))
1359    ;;; A "hairy" byte-function is one that takes a variable number of
1360    ;;; arguments. `hairy-byte-function' is a type from the bytecode
1361    ;;; interpreter.
1362    ;;;
1363    (defun hairy-byte-function-arglist (fn)
1364      (let ((counter -1))
1365        (flet ((next-arg () (make-arg-symbol (incf counter))))
1366          (with-struct (c::hairy-byte-function- min-args max-args rest-arg-p
1367                                                keywords-p keywords) fn
1368            (let ((arglist '())
1369                  (optional (- max-args min-args)))
1370              ;; XXX isn't there a better way to write this?
1371              ;; (Looks fine to me. -luke)
1372              (dotimes (i min-args)
1373                (push (next-arg) arglist))
1374              (when (plusp optional)
1375                (push '&optional arglist)
1376                (dotimes (i optional)
1377                  (push (next-arg) arglist)))
1378              (when rest-arg-p
1379                (push '&rest arglist)
1380                (push (next-arg) arglist))
1381              (when keywords-p
1382                (push '&key arglist)
1383                (loop for (key _ __) in keywords
1384                      do (push key arglist))
1385                (when (eq keywords-p :allow-others)
1386                  (push '&allow-other-keys arglist)))
1387              (nreverse arglist))))))
1390  ;;;; Miscellaneous.  ;;;; Miscellaneous.
1392  (defmethod macroexpand-all (form)  (defimplementation macroexpand-all (form)
1393    (walker:macroexpand-all form))    (walker:macroexpand-all form))
1395  (defun tracedp (fname)  (defimplementation set-default-directory (directory)
   (gethash (debug::trace-fdefinition fname)  
 (defslimefun toggle-trace-fdefinition (fname-string)  
   (let ((fname (from-string fname-string)))  
     (cond ((tracedp fname)  
            (debug::untrace-1 fname)  
            (format nil "~S is now untraced." fname))  
            (debug::trace-1 fname (debug::make-trace-info))  
            (format nil "~S is now traced." fname)))))  
 (defslimefun set-default-directory (directory)  
1396    (setf (ext:default-directory) (namestring directory))    (setf (ext:default-directory) (namestring directory))
1397    ;; Setting *default-pathname-defaults* to an absolute directory    ;; Setting *default-pathname-defaults* to an absolute directory
1398    ;; makes the behavior of MERGE-PATHNAMES a bit more intuitive.    ;; makes the behavior of MERGE-PATHNAMES a bit more intuitive.
1399    (setf *default-pathname-defaults* (pathname (ext:default-directory)))    (setf *default-pathname-defaults* (pathname (ext:default-directory)))
1400    (namestring (ext:default-directory)))    (default-directory))
1402    (defimplementation default-directory ()
1403  ;;;; Source-paths    (namestring (ext:default-directory)))
1405  ;;; CMUCL uses a data structure called "source-path" to locate  (defimplementation call-without-interrupts (fn)
1406  ;;; subforms.  The compiler assigns a source-path to each form in a    (sys:without-interrupts (funcall fn)))
 ;;; 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)))))  
 (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*)  
 (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)))))  
1408  (defun source-path-string-position (path string)  (defimplementation getpid ()
1409    (with-input-from-string (s string)    (unix:unix-getpid))
     (source-path-stream-position path s)))  
1411  (defun source-path-file-position (path filename)  (defimplementation lisp-implementation-type-name ()
1412    (with-open-file (file filename)    "cmucl")
     (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))))))  
1414  (defun code-location-stream-position (code-location stream)  (defimplementation quit-lisp ()
1415    "Return the byte offset of CODE-LOCATION in STREAM.  Extract the    (ext::quit))
 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))  
               (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)))  
1417  (defun code-location-file-position (code-location filename)  ;;; source-path-{stream,file,string,etc}-position moved into
1418    (with-open-file (s filename :direction :input)  ;;; swank-source-path-parser
     (code-location-stream-position code-location s)))  
 (defun debug-source-info-from-emacs-buffer-p (debug-source)  
   (let ((info (c::debug-source-info debug-source)))  
     (and info  
          (consp info)  
          (eq :emacs-buffer (car info)))))  
 (defun source-location-from-code-location (code-location)  
   "Return the source location for CODE-LOCATION."  
   (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  
        (make-location (list :file (unix-truename name))  
                       (list :position (1+ (code-location-file-position  
                                            code-location name)))))  
        (assert (debug-source-info-from-emacs-buffer-p debug-source))  
        (let ((info (c::debug-source-info debug-source)))  
           (list :buffer (getf info :emacs-buffer))  
           (list :position (+ (getf info :emacs-buffer-offset)  
                               (getf info :emacs-buffer-string)))))))  
         (list :source-form (with-output-to-string (*standard-output*)  
                               code-location 100 t)))  
         (list :position 1))))))  
 (defun code-location-source-location (code-location)  
   "Safe wrapper around `code-location-from-source-location'."  
    (source-location-from-code-location code-location)))  
 (defslimefun getpid ()  
1421  ;;;; Debugging  ;;;; Debugging
1423  (defvar *sldb-stack-top*)  (defvar *sldb-stack-top*)
 (defvar *sldb-restarts*)  
1425  (defmethod call-with-debugging-environment (debugger-loop-fn)  (defimplementation call-with-debugging-environment (debugger-loop-fn)
1426    (unix:unix-sigsetmask 0)    (unix:unix-sigsetmask 0)
1427    (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*))  
1428           (debug:*stack-top-hint* nil)           (debug:*stack-top-hint* nil)
1429           (*debugger-hook* nil)           (kernel:*current-level* 0))
1430           (*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  
1431                      (lambda (condition)                      (lambda (condition)
1432                        (signal (make-condition                        (error (make-condition
1433                                 'sldb-condition                                'sldb-condition
1434                                 :original-condition condition)))))                                :original-condition condition)))))
1435        (funcall debugger-loop-fn))))        (funcall debugger-loop-fn))))
1437  (defun format-restarts-for-emacs ()  (defun frame-down (frame)
1438    "Return a list of restarts for *swank-debugger-condition* in a    (handler-case (di:frame-down frame)
1439  format suitable for Emacs."      (di:no-debug-info () nil)))
   (loop for restart in *sldb-restarts*  
         collect (list (princ-to-string (restart-name restart))  
                       (princ-to-string restart))))  
 (defun format-condition-for-emacs ()  
   (format nil "~A~%   [Condition of type ~S]"  
           (debug::safe-condition-message *swank-debugger-condition*)  
           (type-of *swank-debugger-condition*)))  
1441  (defun nth-frame (index)  (defun nth-frame (index)
1442    (do ((frame *sldb-stack-top* (di:frame-down frame))    (do ((frame *sldb-stack-top* (frame-down frame))
1443         (i index (1- i)))         (i index (1- i)))
1444        ((zerop i) frame)))        ((zerop i) frame)))
1446  (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  
1447    (let ((end (or end most-positive-fixnum)))    (let ((end (or end most-positive-fixnum)))
1448      (loop for f = (nth-frame start) then (di:frame-down f)      (loop for f = (nth-frame start) then (frame-down f)
1449            for i from start below end            for i from start below end
1450            while f            while f
1451            collect f)))            collect f)))
1453  (defmethod backtrace (start end)  (defimplementation print-frame (frame stream)
1454    (mapcar #'format-frame-for-emacs (compute-backtrace start end)))    (let ((*standard-output* stream))
1455        (handler-case
1456  (defmethod debugger-info-for-emacs (start end)          (debug::print-frame-call frame :verbosity 1 :number nil)
1457    (list (format-condition-for-emacs)        (error (e)
1458          (format-restarts-for-emacs)          (ignore-errors (princ e stream))))))
         (backtrace start end)))  
1460  (defmethod frame-source-location-for-emacs (index)  (defimplementation frame-source-location-for-emacs (index)
1461    (code-location-source-location (di:frame-code-location (nth-frame index))))    (code-location-source-location (di:frame-code-location (nth-frame index))))
1463  (defmethod eval-in-frame (form index)  (defimplementation eval-in-frame (form index)
1464    (di:eval-in-frame (nth-frame index) form))    (di:eval-in-frame (nth-frame index) form))
1466  (defslimefun pprint-eval-string-in-frame (string index)  (defun frame-debug-vars (frame)
1467    (swank-pprint    "Return a vector of debug-variables in frame."
1468     (multiple-value-list    (di::debug-function-debug-variables (di:frame-debug-function frame)))
1469      (di:eval-in-frame (nth-frame index) (from-string string)))))  
1470    (defun debug-var-value (var frame location)
1471  (defslimefun inspect-in-frame (string index)    (let ((validity (di:debug-variable-validity var location)))
1472    (reset-inspector)      (ecase validity
1473    (inspect-object (di:eval-in-frame (nth-frame index) (from-string string))))        (:valid (di:debug-variable-value var frame))
1474          ((:invalid :unknown) (make-symbol (string validity))))))
1476  (defmethod frame-locals (index)  (defimplementation frame-locals (index)
1477    (let* ((frame (nth-frame index))    (let* ((frame (nth-frame index))
1478           (location (di:frame-code-location frame))           (loc (di:frame-code-location frame))
1479           (debug-function (di:frame-debug-function frame))           (vars (frame-debug-vars frame)))
1480           (debug-variables (di::debug-function-debug-variables debug-function)))      (loop for v across vars collect
1481      (loop for v across debug-variables            (list :name (di:debug-variable-symbol v)
1482            collect (list                  :id (di:debug-variable-id v)
1483                     :symbol (di:debug-variable-symbol v)                  :value (debug-var-value v frame loc)))))
1484                     :id (di:debug-variable-id v)  
1485                     :value-string  (defimplementation frame-var-value (frame var)
1486                     (if (eq (di:debug-variable-validity v location)    (let* ((frame (nth-frame frame))
1487                             :valid)           (dvar (aref (frame-debug-vars frame) var)))
1488                         (to-string (di:debug-variable-value v frame))      (debug-var-value dvar frame (di:frame-code-location frame))))
1489                         "<not-available>")))))  
1490    (defimplementation frame-catch-tags (index)
1491  (defmethod frame-catch-tags (index)    (mapcar #'car (di:frame-catches (nth-frame index))))
1492    (loop for (tag . code-location) in (di:frame-catches (nth-frame index))  
1493          collect `(,tag . ,(code-location-source-location code-location))))  (defimplementation return-from-frame (index form)
1494      (let ((sym (find-symbol (string 'find-debug-tag-for-frame)
1495                              :debug-internals)))
1496        (if sym
1497            (let* ((frame (nth-frame index))
1498                   (probe (funcall sym frame)))
1499              (cond (probe (throw (car probe) (eval-in-frame form index)))
1500                    (t (format nil "Cannot return from frame: ~S" frame))))
1501            "return-from-frame is not implemented in this version of CMUCL.")))
1503  (defslimefun invoke-nth-restart (index)  (defimplementation activate-stepping (frame)
1504    (invoke-restart-interactively (nth-restart index)))    (set-step-breakpoints (nth-frame frame)))
1506  (defslimefun sldb-abort ()  (defimplementation sldb-break-on-return (frame)
1507    (invoke-restart (find 'abort *sldb-restarts* :key #'restart-name)))    (break-on-return (nth-frame frame)))
1509    ;;; We set the breakpoint in the caller which might be a bit confusing.
1510    ;;;
1511    (defun break-on-return (frame)
1512      (let* ((caller (di:frame-down frame))
1513             (cl (di:frame-code-location caller)))
1514        (flet ((hook (frame bp)
1515                 (when (frame-pointer= frame caller)
1516                   (di:delete-breakpoint bp)
1517                   (signal-breakpoint bp frame))))
1518          (let* ((info (ecase (di:code-location-kind cl)
1519                         ((:single-value-return :unknown-return) nil)
1520                         (:known-return (debug-function-returns
1521                                         (di:frame-debug-function frame)))))
1522                 (bp (di:make-breakpoint #'hook cl :kind :code-location
1523                                         :info info)))
1524            (di:activate-breakpoint bp)
1525            `(:ok ,(format nil "Set breakpoint in ~A" caller))))))
1527    (defun frame-pointer= (frame1 frame2)
1528      "Return true if the frame pointers of FRAME1 and FRAME2 are the same."
1529      (sys:sap= (di::frame-pointer frame1) (di::frame-pointer frame2)))
1531    ;;; The PC in escaped frames at a single-return-value point is
1532    ;;; actually vm:single-value-return-byte-offset bytes after the
1533    ;;; position given in the debug info.  Here we try to recognize such
1534    ;;; cases.
1535    ;;;
1536    (defun next-code-locations (frame code-location)
1537      "Like `debug::next-code-locations' but be careful in escaped frames."
1538      (let ((next (debug::next-code-locations code-location)))
1539        (flet ((adjust-pc ()
1540                 (let ((cl (di::copy-compiled-code-location code-location)))
1541                   (incf (di::compiled-code-location-pc cl)
1542                         vm:single-value-return-byte-offset)
1543                   cl)))
1544          (cond ((and (di::compiled-frame-escaped frame)
1545                      (eq (di:code-location-kind code-location)
1546                          :single-value-return)
1547                      (= (length next) 1)
1548                      (di:code-location= (car next) (adjust-pc)))
1549                 (debug::next-code-locations (car next)))
1550                (t
1551                 next)))))
1553    (defun set-step-breakpoints (frame)
1554      (let ((cl (di:frame-code-location frame)))
1555        (when (di:debug-block-elsewhere-p (di:code-location-debug-block cl))
1556          (error "Cannot step in elsewhere code"))
1557        (let* ((debug::*bad-code-location-types*
1558                (remove :call-site debug::*bad-code-location-types*))
1559               (next (next-code-locations frame cl)))
1560          (cond (next
1561                 (let ((steppoints '()))
1562                   (flet ((hook (bp-frame bp)
1563                            (signal-breakpoint bp bp-frame)
1564                            (mapc #'di:delete-breakpoint steppoints)))
1565                     (dolist (code-location next)
1566                       (let ((bp (di:make-breakpoint #'hook code-location
1567                                                     :kind :code-location)))
1568                         (di:activate-breakpoint bp)
1569                         (push bp steppoints))))))
1570                (t
1571                 (break-on-return frame))))))
1574    ;; XXX the return values at return breakpoints should be passed to the
1575    ;; user hooks. debug-int.lisp should be changed to do this cleanly.
1577    ;;; The sigcontext and the PC for a breakpoint invocation are not
1578    ;;; passed to user hook functions, but we need them to extract return
1579    ;;; values. So we advice di::handle-breakpoint and bind the values to
1580    ;;; special variables.
1581    ;;;
1582    (defvar *breakpoint-sigcontext*)
1583    (defvar *breakpoint-pc*)
1585    ;; XXX don't break old versions without fwrappers.  Remove this one day.
1586    #+#.(cl:if (cl:find-package :fwrappers) '(and) '(or))
1587    (progn
1588      (fwrappers:define-fwrapper bind-breakpoint-sigcontext (offset c sigcontext)
1589        (let ((*breakpoint-sigcontext* sigcontext)
1590              (*breakpoint-pc* offset))
1591          (fwrappers:call-next-function)))
1592      (fwrappers:set-fwrappers 'di::handle-breakpoint '())
1593      (fwrappers:fwrap 'di::handle-breakpoint #'bind-breakpoint-sigcontext))
1595    (defun sigcontext-object (sc index)
1596      "Extract the lisp object in sigcontext SC at offset INDEX."
1597      (kernel:make-lisp-obj (vm:sigcontext-register sc index)))
1599    (defun known-return-point-values (sigcontext sc-offsets)
1600      (let ((fp (system:int-sap (vm:sigcontext-register sigcontext
1601                                                        vm::cfp-offset))))
1602        (system:without-gcing
1603         (loop for sc-offset across sc-offsets
1604               collect (di::sub-access-debug-var-slot fp sc-offset sigcontext)))))
1606    ;;; CMUCL returns the first few values in registers and the rest on
1607    ;;; the stack. In the multiple value case, the number of values is
1608    ;;; stored in a dedicated register. The values of the registers can be
1609    ;;; accessed in the sigcontext for the breakpoint.  There are 3 kinds
1610    ;;; of return conventions: :single-value-return, :unknown-return, and
1611    ;;; :known-return.
1612    ;;;
1613    ;;; The :single-value-return convention returns the value in a
1614    ;;; register without setting the nargs registers.
1615    ;;;
1616    ;;; The :unknown-return variant is used for multiple values. A
1617    ;;; :unknown-return point consists actually of 2 breakpoints: one for
1618    ;;; the single value case and one for the general case.  The single
1619    ;;; value breakpoint comes vm:single-value-return-byte-offset after
1620    ;;; the multiple value breakpoint.
1621    ;;;
1622    ;;; The :known-return convention is used by local functions.
1623    ;;; :known-return is currently not supported because we don't know
1624    ;;; where the values are passed.
1625    ;;;
1626    (defun breakpoint-values (breakpoint)
1627      "Return the list of return values for a return point."
1628      (flet ((1st (sc) (sigcontext-object sc (car vm::register-arg-offsets))))
1629        (let ((sc (locally (declare (optimize (ext:inhibit-warnings 3)))
1630                    (alien:sap-alien *breakpoint-sigcontext* (* unix:sigcontext))))
1631              (cl (di:breakpoint-what breakpoint)))
1632          (ecase (di:code-location-kind cl)
1633            (:single-value-return
1634             (list (1st sc)))
1635            (:known-return
1636             (let ((info (di:breakpoint-info breakpoint)))
1637               (if (vectorp info)
1638                   (known-return-point-values sc info)
1639                   (progn
1640                     ;;(break)
1641                     (list "<<known-return convention not supported>>" info)))))
1642            (:unknown-return
1643             (let ((mv-return-pc (di::compiled-code-location-pc cl)))
1644               (if (= mv-return-pc *breakpoint-pc*)
1645                   (mv-function-end-breakpoint-values sc)
1646                   (list (1st sc)))))))))
1648    ;; XXX: di::get-function-end-breakpoint-values takes 2 arguments in
1649    ;; newer versions of CMUCL (after ~March 2005).
1650    (defun mv-function-end-breakpoint-values (sigcontext)
1651      (let ((sym (find-symbol "FUNCTION-END-BREAKPOINT-VALUES/STANDARD" :di)))
1652        (cond (sym (funcall sym sigcontext))
1653              (t (di::get-function-end-breakpoint-values sigcontext)))))
1655    (defun debug-function-returns (debug-fun)
1656      "Return the return style of DEBUG-FUN."
1657      (let* ((cdfun (di::compiled-debug-function-compiler-debug-fun debug-fun)))
1658        (c::compiled-debug-function-returns cdfun)))
1660    (define-condition breakpoint (simple-condition)
1661      ((message :initarg :message :reader breakpoint.message)
1662       (values  :initarg :values  :reader breakpoint.values))
1663      (:report (lambda (c stream) (princ (breakpoint.message c) stream))))
1665    (defimplementation condition-extras ((c breakpoint))
1666      ;; simply pop up the source buffer
1667      `((:short-frame-source 0)))
1669    (defun signal-breakpoint (breakpoint frame)
1670      "Signal a breakpoint condition for BREAKPOINT in FRAME.
1671    Try to create a informative message."
1672      (flet ((brk (values fstring &rest args)
1673               (let ((msg (apply #'format nil fstring args))
1674                     (debug:*stack-top-hint* frame))
1675                 (break 'breakpoint :message msg :values values))))
1676        (with-struct (di::breakpoint- kind what) breakpoint
1677          (case kind
1678            (:code-location
1679             (case (di:code-location-kind what)
1680               ((:single-value-return :known-return :unknown-return)
1681                (let ((values (breakpoint-values breakpoint)))
1682                  (brk values "Return value: ~{~S ~}" values)))
1683               (t
1684                #+(or)
1685                (when (eq (di:code-location-kind what) :call-site)
1686                  (call-site-function breakpoint frame))
1687                (brk nil "Breakpoint: ~S ~S"
1688                     (di:code-location-kind what)
1689                     (di::compiled-code-location-pc what)))))
1690            (:function-start
1691             (brk nil "Function start breakpoint"))
1692            (t (brk nil "Breakpoint: ~A in ~A" breakpoint frame))))))
1694    (defimplementation sldb-break-at-start (fname)
1695      (let ((debug-fun (di:function-debug-function (coerce fname 'function))))
1696        (cond ((not debug-fun)
1697               `(:error ,(format nil "~S has no debug-function" fname)))
1698              (t
1699               (flet ((hook (frame bp &optional args cookie)
1700                        (declare (ignore args cookie))
1701                        (signal-breakpoint bp frame)))
1702                 (let ((bp (di:make-breakpoint #'hook debug-fun
1703                                               :kind :function-start)))
1704                   (di:activate-breakpoint bp)
1705                   `(:ok ,(format nil "Set breakpoint in ~S" fname))))))))
1707    (defun frame-cfp (frame)
1708      "Return the Control-Stack-Frame-Pointer for FRAME."
1709      (etypecase frame
1710        (di::compiled-frame (di::frame-pointer frame))
1711        ((or di::interpreted-frame null) -1)))
1713    (defun frame-ip (frame)
1714      "Return the (absolute) instruction pointer and the relative pc of FRAME."
1715      (if (not frame)
1716          -1
1717          (let ((debug-fun (di::frame-debug-function frame)))
1718            (etypecase debug-fun
1719              (di::compiled-debug-function
1720               (let* ((code-loc (di:frame-code-location frame))
1721                      (component (di::compiled-debug-function-component debug-fun))
1722                      (pc (di::compiled-code-location-pc code-loc))
1723                      (ip (sys:without-gcing
1724                           (sys:sap-int
1725                            (sys:sap+ (kernel:code-instructions component) pc)))))
1726                 (values ip pc)))
1727              ((or di::bogus-debug-function di::interpreted-debug-function)
1728               -1)))))
1730    (defun frame-registers (frame)
1731      "Return the lisp registers CSP, CFP, IP, OCFP, LRA for FRAME-NUMBER."
1732      (let* ((cfp (frame-cfp frame))
1733             (csp (frame-cfp (di::frame-up frame)))
1734             (ip (frame-ip frame))
1735             (ocfp (frame-cfp (di::frame-down frame)))
1736             (lra (frame-ip (di::frame-down frame))))
1737        (values csp cfp ip ocfp lra)))
1739    (defun print-frame-registers (frame-number)
1740      (let ((frame (di::frame-real-frame (nth-frame frame-number))))
1741        (flet ((fixnum (p) (etypecase p
1742                             (integer p)
1743                             (sys:system-area-pointer (sys:sap-int p)))))
1744          (apply #'format t "~
1745    CSP  =  ~X
1746    CFP  =  ~X
1747    IP   =  ~X
1748    OCFP =  ~X
1749    LRA  =  ~X~%" (mapcar #'fixnum
1750                          (multiple-value-list (frame-registers frame)))))))
1753    (defimplementation disassemble-frame (frame-number)
1754      "Return a string with the disassembly of frames code."
1755      (print-frame-registers frame-number)
1756      (terpri)
1757      (let* ((frame (di::frame-real-frame (nth-frame frame-number)))
1758             (debug-fun (di::frame-debug-function frame)))
1759        (etypecase debug-fun
1760          (di::compiled-debug-function
1761           (let* ((component (di::compiled-debug-function-component debug-fun))
1762                  (fun (di:debug-function-function debug-fun)))
1763             (if fun
1764                 (disassemble fun)
1765                 (disassem:disassemble-code-component component))))
1766          (di::bogus-debug-function
1767           (format t "~%[Disassembling bogus frames not implemented]")))))
1770  ;;;; Inspecting  ;;;; Inspecting
1772  (defvar *inspectee*)  (defclass cmucl-inspector (inspector)
1773  (defvar *inspectee-parts*)    ())
1774  (defvar *inspector-stack* '())  
1775  (defvar *inspector-history* (make-array 10 :adjustable t :fill-pointer 0))  (defimplementation make-default-inspector ()
1776  (defvar *inspect-length* 30)    (make-instance 'cmucl-inspector))
 (defun reset-inspector ()  
   (setq *inspectee* nil)  
   (setq *inspectee-parts* nil)  
   (setq *inspector-stack* nil)  
   (setf (fill-pointer *inspector-history*) 0))  
 (defslimefun init-inspector (string)  
   (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)  
 (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))))))  
1778  (defconstant +lowtag-symbols+  (defconstant +lowtag-symbols+
1779    '(vm:even-fixnum-type    '(vm:even-fixnum-type
1780      vm:function-pointer-type      vm:function-pointer-type
# Line 1152  stack." Line 1783  stack."
1783      vm:odd-fixnum-type      vm:odd-fixnum-type
1784      vm:instance-pointer-type      vm:instance-pointer-type
1785      vm:other-immediate-1-type      vm:other-immediate-1-type
1786      vm:other-pointer-type))      vm:other-pointer-type)
1787      "Names of the constants that specify type tags.
1788    The `symbol-value' of each element is a type tag.")
1790  (defconstant +header-type-symbols+  (defconstant +header-type-symbols+
1791    ;; Is there a convinient place for all those constants?    (flet ((suffixp (suffix string)
1792    (flet ((tail-comp (string tail)             (and (>= (length string) (length suffix))
1793             (and (>= (length string) (length tail))                  (string= string suffix :start1 (- (length string)
1794                  (string= string tail :start1 (- (length string)                                                    (length suffix))))))
1795                                                  (length tail))))))      ;; Is there a convinient place for all those constants?
1796      (remove-if-not      (remove-if-not
1797       (lambda (x) (and (tail-comp (symbol-name x) "-TYPE")       (lambda (x) (and (suffixp "-TYPE" (symbol-name x))
1798                        (not (member x +lowtag-symbols+))                        (not (member x +lowtag-symbols+))
1799                        (boundp x)                        (boundp x)
1800                        (typep (symbol-value x) 'fixnum)))                        (typep (symbol-value x) 'fixnum)))
1801       (append (apropos-list "-TYPE" "VM" t)       (append (apropos-list "-TYPE" "VM" t)
1802               (apropos-list "-TYPE" "BIGNUM" t)))))               (apropos-list "-TYPE" "BIGNUM" t))))
1803      "A list of names of the type codes in boxed objects.")
1805  (defun describe-primitive-type (object)  (defimplementation describe-primitive-type (object)
1806    (with-output-to-string (*standard-output*)    (with-output-to-string (*standard-output*)
1807      (let* ((lowtag (kernel:get-lowtag object))      (let* ((lowtag (kernel:get-lowtag object))
1808             (lowtag-symbol (find lowtag +lowtag-symbols+ :key #'symbol-value)))             (lowtag-symbol (find lowtag +lowtag-symbols+ :key #'symbol-value)))
1809        (format t "[lowtag: ~A" lowtag-symbol)        (format t "lowtag: ~A" lowtag-symbol)
1810        (cond ((member lowtag (list vm:other-pointer-type        (when (member lowtag (list vm:other-pointer-type
1811                                    vm:function-pointer-type                                   vm:function-pointer-type
1812                                    vm:other-immediate-0-type                                   vm:other-immediate-0-type
1813                                    vm:other-immediate-1-type                                   vm:other-immediate-1-type
1814                                    ))                                   ))
1815               (let* ((type (kernel:get-type object))          (let* ((type (kernel:get-type object))
1816                      (type-symbol (find type +header-type-symbols+                 (type-symbol (find type +header-type-symbols+
1817                                         :key #'symbol-value)))                                    :key #'symbol-value)))
1818                 (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*))  
           (t (inspect-object (aref *inspector-history* (1+ position)))))))  
 (defslimefun quit-inspector ()  
 (defslimefun describe-inspectee ()  
   "Describe the currently inspected object."  
   (print-description-to-string *inspectee*))  
 (defgeneric inspected-parts (object)  
    "Return a short description and a list of (label . value) pairs."))  
1820  (defmethod inspected-parts (o)  (defimplementation inspect-for-emacs ((o t) (inspector cmucl-inspector))
1821    (cond ((di::indirect-value-cell-p o)    (cond ((di::indirect-value-cell-p o)
1822           (inspected-parts-of-value-cell o))           (values (format nil "~A is a value cell." o)
1823                     `("Value: " (:value ,(c:value-cell-ref o)))))
1824            ((alien::alien-value-p o)
1825             (inspect-alien-value o))
1826          (t          (t
1827           (destructuring-bind (text labeledp . parts)           (cmucl-inspect o))))
1828               (inspect::describe-parts o)  
1829             (let ((parts (if labeledp  (defun cmucl-inspect (o)
1830                              (loop for (label . value) in parts    (destructuring-bind (text labeledp . parts) (inspect::describe-parts o)
1831                                    collect (cons (string label) value))      (values (format nil "~A~%" text)
1832                              (loop for value in parts              (if labeledp
1833                                    for i from 0                  (loop for (label . value) in parts
1834                                    collect (cons (format nil "~D" i) value)))))                        append (label-value-line label value))
1835               (values text parts))))))                  (loop for value in parts  for i from 0
1836                          append (label-value-line i value))))))
 (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)))))  
        (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))  
               (incf length))  
               (push (cons (string 'rest) in-list) reversed-elements)  
               (done "The object is an improper list of length ~S.~%")))))))  
1838  (defmethod inspected-parts ((o function))  (defmethod inspect-for-emacs :around ((o function) (inspector cmucl-inspector))
1839      (declare (ignore inspector))
1840    (let ((header (kernel:get-type o)))    (let ((header (kernel:get-type o)))
1841      (cond ((= header vm:function-header-type)      (cond ((= header vm:function-header-type)
1842             (values             (values (format nil "~A is a function." o)
1843              (format nil "~A~% is a function." o)                     (append (label-value-line*
1844              (list (cons "Self" (kernel:%function-self o))                              ("Self" (kernel:%function-self o))
1845                    (cons "Next" (kernel:%function-next o))                              ("Next" (kernel:%function-next o))
1846                    (cons "Name" (kernel:%function-name o))                              ("Name" (kernel:%function-name o))
1847                    (cons "Arglist" (kernel:%function-arglist o))                              ("Arglist" (kernel:%function-arglist o))
1848                    (cons "Type" (kernel:%function-type o))                              ("Type" (kernel:%function-type o))
1849                    (cons "Code Object" (kernel:function-code-header o)))))                              ("Code" (kernel:function-code-header o)))
1850            ((= header vm:closure-header-type)                             (list
1851             (values (format nil "~A~% is a closure." o)                              (with-output-to-string (s)
1852                     (list*                                (disassem:disassemble-function o :stream s))))))
1853                      (cons "Function" (kernel:%closure-function o))            ((= header vm:closure-header-type)
1854                      (loop for i from 0 below (- (kernel:get-closure-length o)             (values (format nil "~A is a closure" o)
1855                                                  (1- vm:closure-info-offset))                     (append
1856                            collect (cons (format nil "~D" i)                      (label-value-line "Function" (kernel:%closure-function o))
1857                                          (kernel:%closure-index-ref o i))))))                      `("Environment:" (:newline))
1858            (t (call-next-method o)))))                      (loop for i from 0 below (1- (kernel:get-closure-length o))
1859                              append (label-value-line
1860  (defmethod inspected-parts ((o kernel:code-component))                                    i (kernel:%closure-index-ref o i))))))
1861    (values (format nil "~A~% is a code data-block." o)            ((eval::interpreted-function-p o)
1862            `(("First entry point" . ,(kernel:%code-entry-points o))             (cmucl-inspect o))
1863              ,@(loop for i from vm:code-constants-offset            (t
1864                      below (kernel:get-header-data o)             (call-next-method)))))
1865                      collect (cons (format nil "Constant#~D" i)  
1866                                    (kernel:code-header-ref o i)))  
1867              ("Debug info" . ,(kernel:%code-debug-info o))  (defmethod inspect-for-emacs ((o kernel:code-component) (_ cmucl-inspector))
1868              ("Instructions"  . ,(kernel:code-instructions o)))))    (declare (ignore _))
1869      (values (format nil "~A is a code data-block." o)
1870  (defmethod inspected-parts ((o kernel:fdefn))            (append
1871    (values (format nil "~A~% is a fdefn object." o)             (label-value-line*
1872            `(("Name" . ,(kernel:fdefn-name o))              ("code-size" (kernel:%code-code-size o))
1873              ("Function" . ,(kernel:fdefn-function o)))))              ("entry-points" (kernel:%code-entry-points o))
1874                ("debug-info" (kernel:%code-debug-info o))
1875  ;;; Local Variables:              ("trace-table-offset" (kernel:code-header-ref
1876  ;;; eval: (font-lock-add-keywords 'lisp-mode '(("(\\(defslimefun\\)\\s +\\(\\(\\w\\|\\s_\\)+\\)"  (1 font-lock-keyword-face) (2 font-lock-function-name-face))))                                     o vm:code-trace-table-offset-slot)))
1877  ;;; End:             `("Constants:" (:newline))
1878               (loop for i from vm:code-constants-offset
1879                     below (kernel:get-header-data o)
1880                     append (label-value-line i (kernel:code-header-ref o i)))
1881               `("Code:" (:newline)
1882                 , (with-output-to-string (s)
1883                     (cond ((kernel:%code-debug-info o)
1884                            (disassem:disassemble-code-component o :stream s))
1885                           (t
1886                            (disassem:disassemble-memory
1887                             (disassem::align
1888                              (+ (logandc2 (kernel:get-lisp-obj-address o)
1889                                           vm:lowtag-mask)
1890                                 (* vm:code-constants-offset vm:word-bytes))
1891                              (ash 1 vm:lowtag-bits))
1892                             (ash (kernel:%code-code-size o) vm:word-shift)
1893                             :stream s))))))))
1895    (defmethod inspect-for-emacs ((o kernel:fdefn) (inspector cmucl-inspector))
1896      (declare (ignore inspector))
1897      (values (format nil "~A is a fdenf object." o)
1898              (label-value-line*
1899               ("name" (kernel:fdefn-name o))
1900               ("function" (kernel:fdefn-function o))
1901               ("raw-addr" (sys:sap-ref-32
1902                            (sys:int-sap (kernel:get-lisp-obj-address o))
1903                            (* vm:fdefn-raw-addr-slot vm:word-bytes))))))
1905    (defmethod inspect-for-emacs ((o array) (inspector cmucl-inspector))
1906      inspector
1907      (values (format nil "~A is an array." o)
1908              (label-value-line*
1909               (:header (describe-primitive-type o))
1910               (:rank (array-rank o))
1911               (:fill-pointer (kernel:%array-fill-pointer o))
1912               (:fill-pointer-p (kernel:%array-fill-pointer-p o))
1913               (:elements (kernel:%array-available-elements o))
1914               (:data (kernel:%array-data-vector o))
1915               (:displacement (kernel:%array-displacement o))
1916               (:displaced-p (kernel:%array-displaced-p o))
1917               (:dimensions (array-dimensions o)))))
1919    (defmethod inspect-for-emacs ((o vector) (inspector cmucl-inspector))
1920      inspector
1921      (values (format nil "~A is a vector." o)
1922              (append
1923               (label-value-line*
1924                (:header (describe-primitive-type o))
1925                (:length (c::vector-length o)))
1926               (loop for i below (length o)
1927                     append (label-value-line i (aref o i))))))
1929    (defun inspect-alien-record (alien)
1930      (values
1931       (format nil "~A is an alien value." alien)
1932       (with-struct (alien::alien-value- sap type) alien
1933         (with-struct (alien::alien-record-type- kind name fields) type
1934           (append
1935            (label-value-line*
1936             (:sap sap)
1937             (:kind kind)
1938             (:name name))
1939            (loop for field in fields
1940                  append (let ((slot (alien::alien-record-field-name field)))
1941                           (label-value-line slot (alien:slot alien slot)))))))))
1943    (defun inspect-alien-pointer (alien)
1944      (values
1945       (format nil "~A is an alien value." alien)
1946       (with-struct (alien::alien-value- sap type) alien
1947         (label-value-line*
1948          (:sap sap)
1949          (:type type)
1950          (:to (alien::deref alien))))))
1952    (defun inspect-alien-value (alien)
1953      (typecase (alien::alien-value-type alien)
1954        (alien::alien-record-type (inspect-alien-record alien))
1955        (alien::alien-pointer-type (inspect-alien-pointer alien))
1956        (t (cmucl-inspect alien))))
1958    ;;;; Profiling
1959    (defimplementation profile (fname)
1960      (eval `(profile:profile ,fname)))
1962    (defimplementation unprofile (fname)
1963      (eval `(profile:unprofile ,fname)))
1965    (defimplementation unprofile-all ()
1966      (eval `(profile:unprofile))
1967      "All functions unprofiled.")
1969    (defimplementation profile-report ()
1970      (eval `(profile:report-time)))
1972    (defimplementation profile-reset ()
1973      (eval `(profile:reset-time))
1974      "Reset profiling counters.")
1976    (defimplementation profiled-functions ()
1977      profile:*timed-functions*)
1979    (defimplementation profile-package (package callers methods)
1980      (profile:profile-all :package package
1981                           :callers-p callers
1982                           #-cmu18e :methods #-cmu18e methods))
1985    ;;;; Multiprocessing
1987    #+mp
1988    (progn
1989      (defimplementation startup-multiprocessing ()
1990        ;; Threads magic: this never returns! But top-level becomes
1991        ;; available again.
1992        (mp::startup-idle-and-top-level-loops))
1994      (defimplementation spawn (fn &key (name "Anonymous"))
1995        (mp:make-process fn :name name))
1997      (defvar *thread-id-counter* 0)
1999      (defimplementation thread-id (thread)
2000        (or (getf (mp:process-property-list thread) 'id)
2001            (setf (getf (mp:process-property-list thread) 'id)
2002                  (incf *thread-id-counter*))))
2004      (defimplementation find-thread (id)
2005        (find id (all-threads)
2006              :key (lambda (p) (getf (mp:process-property-list p) 'id))))
2008      (defimplementation thread-name (thread)
2009        (mp:process-name thread))
2011      (defimplementation thread-status (thread)
2012        (mp:process-whostate thread))
2014      (defimplementation current-thread ()
2015        mp:*current-process*)
2017      (defimplementation all-threads ()
2018        (copy-list mp:*all-processes*))
2020      (defimplementation interrupt-thread (thread fn)
2021        (mp:process-interrupt thread fn))
2023      (defimplementation kill-thread (thread)
2024        (mp:destroy-process thread))
2026      (defvar *mailbox-lock* (mp:make-lock "mailbox lock"))
2028      (defstruct (mailbox (:conc-name mailbox.))
2029        (mutex (mp:make-lock "process mailbox"))
2030        (queue '() :type list))
2032      (defun mailbox (thread)
2033        "Return THREAD's mailbox."
2034        (mp:with-lock-held (*mailbox-lock*)
2035          (or (getf (mp:process-property-list thread) 'mailbox)
2036              (setf (getf (mp:process-property-list thread) 'mailbox)
2037                    (make-mailbox)))))
2039      (defimplementation send (thread message)
2040        (let* ((mbox (mailbox thread))
2041               (mutex (mailbox.mutex mbox)))
2042          (mp:with-lock-held (mutex)
2043            (setf (mailbox.queue mbox)
2044                  (nconc (mailbox.queue mbox) (list message))))))
2046      (defimplementation receive ()
2047        (let* ((mbox (mailbox mp:*current-process*))
2048               (mutex (mailbox.mutex mbox)))
2049          (mp:process-wait "receive" #'mailbox.queue mbox)
2050          (mp:with-lock-held (mutex)
2051            (pop (mailbox.queue mbox)))))
2053      ) ;; #+mp
2057    ;;;; GC hooks
2058    ;;;
2059    ;;; Display GC messages in the echo area to avoid cluttering the
2060    ;;; normal output.
2061    ;;;
2063    (defun swank-sym (name) (find-symbol (string name) :swank))
2064    (defun sending-safe-p () (symbol-value (swank-sym :*emacs-connection*)))
2066    ;; this should probably not be here, but where else?
2067    (defun eval-in-emacs (form)
2068      (funcall (swank-sym :eval-in-emacs) form))
2070    (defun print-bytes (nbytes &optional stream)
2071      "Print the number NBYTES to STREAM in KB, MB, or GB units."
2072      (let ((names '((0 bytes) (10 kb) (20 mb) (30 gb) (40 tb) (50 eb))))
2073        (multiple-value-bind (power name)
2074            (loop for ((p1 n1) (p2 n2)) on names
2075                  while n2 do
2076                  (when (<= (expt 2 p1) nbytes (1- (expt 2 p2)))
2077                    (return (values p1 n1))))
2078          (cond (name
2079                 (format stream "~,1F ~A" (/ nbytes (expt 2 power)) name))
2080                (t
2081                 (format stream "~:D bytes" nbytes))))))
2083    (defun pre-gc-hook (bytes-in-use)
2084      (let ((msg (format nil "[Commencing GC with ~A in use.]"
2085                         (print-bytes bytes-in-use))))
2086        (when (sending-safe-p)
2087          (eval-in-emacs `(slime-background-message "%s" ,msg)))))
2089    (defun post-gc-hook (bytes-retained bytes-freed trigger)
2090      (let ((msg (format nil "[GC completed. ~A freed  ~A retained  ~A trigger]"
2091                         (print-bytes bytes-freed)
2092                         (print-bytes bytes-retained)
2093                         (print-bytes trigger))))
2094        (when (sending-safe-p)
2095          (eval-in-emacs `(slime-background-message "%s" ,msg)))))
2097    (defun install-gc-hooks ()
2098      (setq ext:*gc-notify-before* #'pre-gc-hook)
2099      (setq ext:*gc-notify-after* #'post-gc-hook))
2101    (defun remove-gc-hooks ()
2102      (setq ext:*gc-notify-before* nil)
2103      (setq ext:*gc-notify-after* nil))
2105    (defvar *install-gc-hooks* t
2106      "If non-nil install GC hooks")
2108    (defimplementation emacs-connected ()
2109      (when *install-gc-hooks*
2110        (install-gc-hooks)))
2112    ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2113    ;;Trace implementations
2114    ;;In CMUCL, we have:
2115    ;; (trace <name>)
2116    ;; (trace (method <name> <qualifier>? (<specializer>+)))
2117    ;; (trace :methods t '<name>) ;;to trace all methods of the gf <name>
2118    ;; <name> can be a normal name or a (setf name)
2120    (defun tracedp (spec)
2121      (member spec (eval '(trace)) :test #'equal))
2123    (defun toggle-trace-aux (spec &rest options)
2124      (cond ((tracedp spec)
2125             (eval `(untrace ,spec))
2126             (format nil "~S is now untraced." spec))
2127            (t
2128             (eval `(trace ,spec ,@options))
2129             (format nil "~S is now traced." spec))))
2131    (defimplementation toggle-trace (spec)
2132      (ecase (car spec)
2133        ((setf)
2134         (toggle-trace-aux spec))
2135        ((:defgeneric)
2136         (let ((name (second spec)))
2137           (toggle-trace-aux name :methods name)))
2138        ((:defmethod)
2139         (toggle-trace-aux `(method ,(cdr spec)))
2140         ;; Man, is this ugly
2141         (toggle-trace-aux `(pcl::fast-method ,(cdr spec))))
2142        ((:call)
2143         (destructuring-bind (caller callee) (cdr spec)
2144           (toggle-trace-aux (process-fspec callee)
2145                             :wherein (list (process-fspec caller)))))))
2147    (defun process-fspec (fspec)
2148      (cond ((consp fspec)
2149             (ecase (first fspec)
2150               ((:defun :defgeneric) (second fspec))
2151               ((:defmethod)
2152                `(method ,(second fspec) ,@(third fspec) ,(fourth fspec)))
2153               ;; this isn't actually supported
2154               ((:labels) `(labels ,(process-fspec (second fspec)) ,(third fspec)))
2155               ((:flet) `(flet ,(process-fspec (second fspec)) ,(third fspec)))))
2156            (t
2157             fspec)))
2159    ;; Local Variables:
2160    ;; pbook-heading-regexp:    "^;;;\\(;+\\)"
2161    ;; pbook-commentary-regexp: "^;;;\\($\\|[^;]\\)"
2162    ;; End:

Removed from v.1.32  
changed lines
  Added in v.1.143

  ViewVC Help
Powered by ViewVC 1.1.5