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

Diff of /slime/swank-cmucl.lisp

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

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

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

  ViewVC Help
Powered by ViewVC 1.1.5