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

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

  ViewVC Help
Powered by ViewVC 1.1.5