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

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

  ViewVC Help
Powered by ViewVC 1.1.5