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

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

  ViewVC Help
Powered by ViewVC 1.1.5