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

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

  ViewVC Help
Powered by ViewVC 1.1.5