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

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

  ViewVC Help
Powered by ViewVC 1.1.5