1 ;;; introspection library
3 ;;; This is here as a discussion point, not yet a supported interface. If
4 ;;; you would like to use the functions here, or you would like other
5 ;;; functions to be here, join the debate on navel@metacircles.com.
6 ;;; List info at http://lists.metacircles.com/cgi-bin/mailman/listinfo/navel
8 ;;; For the avoidance of doubt, the exported interface is the proposed
9 ;;; supported interface. Anything else is internal, though you're
10 ;;; welcome to argue a case for exporting it.
12 ;;; If you steal the code from this file to cut and paste into your
13 ;;; own project, there will be much wailing and gnashing of teeth.
14 ;;; Your teeth. If need be, we'll kick them for you. This is a
15 ;;; contrib, we're allowed to look in internals. You're an
16 ;;; application programmer, and are not.
19 ;;; 1) structs don't have within-file location info. problem for the
20 ;;; structure itself, accessors and the predicate
21 ;;; 3) error handling. Signal random errors, or handle and resignal 'our'
22 ;;; error, or return NIL?
25 (defpackage :sb-introspect
27 (:export "FUNCTION-ARGLIST"
28 "VALID-FUNCTION-NAME-P"
29 "FIND-DEFINITION-SOURCE"
30 "FIND-DEFINITION-SOURCES-BY-NAME"
32 "DEFINITION-SOURCE-PATHNAME"
33 "DEFINITION-SOURCE-FORM-PATH"
34 "DEFINITION-SOURCE-CHARACTER-OFFSET"
35 "DEFINITION-SOURCE-FILE-WRITE-DATE"
36 "DEFINITION-SOURCE-PLIST"
37 "DEFINITION-NOT-FOUND" "DEFINITION-NAME"
38 "FIND-FUNCTION-CALLEES"
39 "FIND-FUNCTION-CALLERS"))
41 (in-package :sb-introspect)
43 ;;;; Internal interface for SBCL debug info
45 ;;; Here are some tutorial-style type definitions to help understand
46 ;;; the internal SBCL debugging data structures we're using. The
47 ;;; commentary is based on CMUCL's debug internals manual.
49 (deftype debug-info ()
50 "Structure containing all the debug information related to a function.
51 Function objects reference debug-infos which in turn reference
52 debug-sources and so on."
53 'sb-c::compiled-debug-info)
55 (deftype debug-source ()
56 "Debug sources describe where to find source code.
57 For example, the debug source for a function compiled from a file will
58 include the pathname of the file and the position of the definition."
61 (deftype debug-function ()
62 "Debug function represent static compile-time information about a function."
63 'sb-c::compiled-debug-fun)
65 (declaim (ftype (function (function) debug-info) function-debug-info))
66 (defun function-debug-info (function)
67 (let* ((function-object (sb-kernel::%closure-fun function))
68 (function-header (sb-kernel:fun-code-header function-object)))
69 (sb-kernel:%code-debug-info function-header)))
71 (declaim (ftype (function (function) debug-source) function-debug-source))
72 (defun function-debug-source (function)
73 (debug-info-source (function-debug-info function)))
75 (declaim (ftype (function (debug-info) debug-source) debug-info-source))
76 (defun debug-info-source (debug-info)
77 (sb-c::debug-info-source debug-info))
79 (declaim (ftype (function (debug-info) debug-function) debug-info-debug-function))
80 (defun debug-info-debug-function (debug-info)
81 (elt (sb-c::compiled-debug-info-fun-map debug-info) 0))
83 (defun valid-function-name-p (name)
84 "True if NAME denotes a function name that can be passed to MACRO-FUNCTION or FDEFINITION "
85 (and (sb-int:valid-function-name-p name) t))
87 ;;;; Finding definitions
89 (defstruct definition-source
90 ;; Pathname of the source file that the definition was compiled from.
91 ;; This is null if the definition was not compiled from a file.
92 (pathname nil :type (or null pathname))
93 ;; Source-path of the definition within the file.
94 ;; This may be incomplete depending on the debug level at which the
95 ;; source was compiled.
96 (form-path '() :type list)
97 ;; Character offset of the top-level-form containing the definition.
98 ;; This corresponds to the first element of form-path.
99 (character-offset nil :type (or null integer))
100 ;; File-write-date of the source file when compiled.
101 ;; Null if not compiled from a file.
102 (file-write-date nil :type (or null integer))
103 ;; plist from WITH-COMPILATION-UNIT
105 ;; Any extra metadata that the caller might be interested in. For
106 ;; example the specializers of the method whose definition-source this
108 (description nil :type list))
110 (defun find-definition-sources-by-name (name type)
111 "Returns a list of DEFINITION-SOURCEs for the objects of type TYPE
112 defined with name NAME. NAME may be a symbol or a extended function
113 name. Type can currently be one of the following:
138 If an unsupported TYPE is requested, the function will return NIL.
146 (find-class name nil)))
147 (real-fdefinition (name)
148 ;; for getting the real function object, even if the
149 ;; function is being profiled
150 (let ((profile-info (gethash name sb-profile::*profiled-fun-name->info*)))
152 (sb-profile::profile-info-encapsulated-fun profile-info)
153 (fdefinition name)))))
157 (when (and (symbolp name)
158 (eq (sb-int:info :variable :kind name) :special))
159 (translate-source-location (sb-int:info :source-location type name))))
161 (when (and (symbolp name)
162 (eq (sb-int:info :variable :kind name) :constant))
163 (translate-source-location (sb-int:info :source-location type name))))
165 (when (and (symbolp name)
166 (eq (sb-int:info :variable :kind name) :macro))
167 (translate-source-location (sb-int:info :source-location type name))))
169 (when (and (symbolp name)
170 (macro-function name))
171 (find-definition-source (macro-function name))))
173 (when (compiler-macro-function name)
174 (find-definition-source (compiler-macro-function name))))
175 ((:function :generic-function)
176 (when (and (fboundp name)
177 (or (not (symbolp name))
178 (not (macro-function name))))
179 (let ((fun (real-fdefinition name)))
180 (when (eq (not (typep fun 'generic-function))
181 (not (eq type :generic-function)))
182 (find-definition-source fun)))))
184 (let ((expander-fun (sb-int:info :type :expander name)))
186 (find-definition-source expander-fun))))
189 (let ((fun (real-fdefinition name)))
190 (when (typep fun 'generic-function)
191 (loop for method in (sb-mop::generic-function-methods
193 for source = (find-definition-source method)
194 when source collect source)))))
196 (when (and (consp name)
197 (eq (car name) 'setf))
198 (setf name (cadr name)))
199 (let ((expander (or (sb-int:info :setf :inverse name)
200 (sb-int:info :setf :expander name))))
202 (sb-introspect:find-definition-source (if (symbolp expander)
203 (symbol-function expander)
206 (let ((class (get-class name)))
208 (when (typep class 'sb-pcl::structure-class)
209 (find-definition-source class))
210 (when (sb-int:info :typed-structure :info name)
211 (translate-source-location
212 (sb-int:info :source-location :typed-structure name))))))
214 (let ((class (get-class name)))
216 (not (typep class 'sb-pcl::structure-class)))
217 (when (eq (not (typep class 'sb-pcl::condition-class))
218 (not (eq type :condition)))
219 (find-definition-source class)))))
220 ((:method-combination)
221 (let ((combination-fun
222 (ignore-errors (find-method #'sb-mop:find-method-combination
224 (list (find-class 'generic-function)
227 (when combination-fun
228 (find-definition-source combination-fun))))
231 (let ((package (find-package name)))
233 (find-definition-source package)))))
234 ;; TRANSFORM and OPTIMIZER handling from swank-sbcl
237 (let ((fun-info (sb-int:info :function :info name)))
239 (loop for xform in (sb-c::fun-info-transforms fun-info)
240 for source = (find-definition-source
241 (sb-c::transform-function xform))
242 for typespec = (sb-kernel:type-specifier
243 (sb-c::transform-type xform))
244 for note = (sb-c::transform-note xform)
245 do (setf (definition-source-description source)
247 (list (second typespec) note)
252 (let ((fun-info (sb-int:info :function :info name)))
254 (let ((otypes '((sb-c::fun-info-derive-type . sb-c:derive-type)
255 (sb-c::fun-info-ltn-annotate . sb-c:ltn-annotate)
256 (sb-c::fun-info-ltn-annotate . sb-c:ltn-annotate)
257 (sb-c::fun-info-optimizer . sb-c:optimizer))))
258 (loop for (reader . name) in otypes
259 for fn = (funcall reader fun-info)
261 (let ((source (find-definition-source fn)))
262 (setf (definition-source-description source)
267 (let ((fun-info (sb-int:info :function :info name)))
269 (loop for vop in (sb-c::fun-info-templates fun-info)
270 for source = (find-definition-source
271 (sb-c::vop-info-generator-function vop))
272 do (setf (definition-source-description source)
273 (list (sb-c::template-name vop)
274 (sb-c::template-note vop)))
278 (let ((transform-fun (sb-int:info :function :source-transform name)))
280 (sb-introspect:find-definition-source transform-fun)))))
284 (defun find-definition-source (object)
286 ((or sb-pcl::condition-class sb-pcl::structure-class)
287 (let ((classoid (sb-impl::find-classoid (class-name object))))
289 (let ((layout (sb-impl::classoid-layout classoid)))
291 (translate-source-location
292 (sb-kernel::layout-source-location layout)))))))
295 (find-definition-sources-by-name
296 (sb-pcl::method-combination-type-name object) :method-combination)))
298 (translate-source-location (sb-impl::package-source-location object)))
300 (translate-source-location (sb-pcl::definition-source object)))
301 ;; Use the PCL definition location information instead of the function
302 ;; debug-info for methods and generic functions. Sometimes the
303 ;; debug-info would point into PCL internals instead of the proper
306 (let ((source (translate-source-location
307 (sb-pcl::definition-source object))))
309 (setf (definition-source-description source)
310 (list (sb-mop:generic-function-lambda-list object))))
313 (let ((source (translate-source-location
314 (sb-pcl::definition-source object))))
316 (setf (definition-source-description source)
317 (append (method-qualifiers object)
318 (sb-pcl::unparse-specializers
319 (sb-mop:method-specializers object)))))
322 (sb-eval:interpreted-function
323 (let ((source (translate-source-location
324 (sb-eval:interpreted-function-source-location object))))
327 (cond ((struct-accessor-p object)
328 (find-definition-source
329 (struct-accessor-structure-class object)))
330 ((struct-predicate-p object)
331 (find-definition-source
332 (struct-predicate-structure-class object)))
334 (find-function-definition-source object))))
336 (error "Don't know how to retrive source location for a ~S~%"
339 (defun find-function-definition-source (function)
340 (let* ((debug-info (function-debug-info function))
341 (debug-source (debug-info-source debug-info))
342 (debug-fun (debug-info-debug-function debug-info))
343 (tlf (if debug-fun (sb-c::compiled-debug-fun-tlf-number debug-fun))))
344 (make-definition-source
346 (if (eql (sb-c::debug-source-from debug-source) :file)
347 (parse-namestring (sb-c::debug-source-name debug-source)))
350 (elt (sb-c::debug-source-start-positions debug-source) tlf))
351 ;; Unfortunately there is no proper source path available in the
352 ;; debug-source. FIXME: We could use sb-di:code-locations to get
353 ;; a full source path. -luke (12/Mar/2005)
354 :form-path (if tlf (list tlf))
355 :file-write-date (sb-c::debug-source-created debug-source)
356 :plist (sb-c::debug-source-plist debug-source))))
358 (defun translate-source-location (location)
360 (make-definition-source
361 :pathname (let ((n (sb-c:definition-source-location-namestring location)))
363 (parse-namestring n)))
365 (let ((number (sb-c:definition-source-location-toplevel-form-number
369 :plist (sb-c:definition-source-location-plist location))
370 (make-definition-source)))
372 ;;; This is kludgey. We expect these functions (the underlying functions,
373 ;;; not the closures) to be in static space and so not move ever.
374 ;;; FIXME It's also possibly wrong: not all structures use these vanilla
375 ;;; accessors, e.g. when the :type option is used
376 (defvar *struct-slotplace-reader*
377 (sb-vm::%simple-fun-self #'definition-source-pathname))
378 (defvar *struct-slotplace-writer*
379 (sb-vm::%simple-fun-self #'(setf definition-source-pathname)))
380 (defvar *struct-predicate*
381 (sb-vm::%simple-fun-self #'definition-source-p))
383 (defun struct-accessor-p (function)
384 (let ((self (sb-vm::%simple-fun-self function)))
385 ;; FIXME there are other kinds of struct accessor. Fill out this list
386 (member self (list *struct-slotplace-reader*
387 *struct-slotplace-writer*))))
389 (defun struct-predicate-p (function)
390 (let ((self (sb-vm::%simple-fun-self function)))
391 ;; FIXME there may be other structure predicate functions
392 (member self (list *struct-predicate*))))
394 ;;; FIXME: maybe this should be renamed as FUNCTION-LAMBDA-LIST?
395 (defun function-arglist (function)
396 "Describe the lambda list for the extended function designator FUNCTION.
397 Works for special-operators, macros, simple functions,
398 interpreted functions, and generic functions. Signals error if
400 (cond ((valid-function-name-p function)
401 (function-arglist (or (and (symbolp function)
402 (macro-function function))
403 (fdefinition function))))
404 ((typep function 'generic-function)
405 (sb-pcl::generic-function-pretty-arglist function))
407 ((typep function 'sb-eval:interpreted-function)
408 (sb-eval:interpreted-function-lambda-list function))
409 (t (sb-impl::%simple-fun-arglist
410 (sb-impl::%closure-fun function)))))
412 (defun struct-accessor-structure-class (function)
413 (let ((self (sb-vm::%simple-fun-self function)))
415 ((member self (list *struct-slotplace-reader* *struct-slotplace-writer*))
417 (sb-kernel::classoid-name
418 (sb-kernel::layout-classoid
419 (sb-kernel:%closure-index-ref function 1)))))
422 (defun struct-predicate-structure-class (function)
423 (let ((self (sb-vm::%simple-fun-self function)))
425 ((member self (list *struct-predicate*))
427 (sb-kernel::classoid-name
428 (sb-kernel::layout-classoid
429 (sb-kernel:%closure-index-ref function 0)))))
432 ;;;; find callers/callees, liberated from Helmut Eller's code in SLIME
434 ;;; This interface is trmendously experimental.
436 ;;; For the moment I'm taking the view that FDEFN is an internal
437 ;;; object (one out of one CMUCL developer surveyed didn't know what
438 ;;; they were for), so these routines deal in FUNCTIONs
440 ;;; Find callers and callees by looking at the constant pool of
441 ;;; compiled code objects. We assume every fdefn object in the
442 ;;; constant pool corresponds to a call to that function. A better
443 ;;; strategy would be to use the disassembler to find actual
446 (defun find-function-callees (function)
447 "Return functions called by FUNCTION."
450 (sb-kernel:fun-code-header function)
452 (when (sb-kernel:fdefn-p obj)
453 (push (sb-kernel:fdefn-fun obj)
458 (defun find-function-callers (function &optional (spaces '(:read-only :static
460 "Return functions which call FUNCTION, by searching SPACES for code objects"
461 (let ((referrers '()))
462 (map-caller-code-components
466 (let ((entry (sb-kernel:%code-entry-points code)))
468 (push (princ-to-string code) referrers))
470 (loop for e = entry then (sb-kernel::%simple-fun-next e)
472 do (pushnew e referrers)))))))
475 (declaim (inline map-code-constants))
476 (defun map-code-constants (code fn)
477 "Call FN for each constant in CODE's constant pool."
478 (check-type code sb-kernel:code-component)
479 (loop for i from sb-vm:code-constants-offset below
480 (sb-kernel:get-header-data code)
481 do (funcall fn (sb-kernel:code-header-ref code i))))
483 (declaim (inline map-allocated-code-components))
484 (defun map-allocated-code-components (spaces fn)
485 "Call FN for each allocated code component in one of SPACES. FN
486 receives the object and its size as arguments. SPACES should be a
487 list of the symbols :dynamic, :static, or :read-only."
488 (dolist (space spaces)
489 (sb-vm::map-allocated-objects
490 (lambda (obj header size)
491 (when (= sb-vm:code-header-widetag header)
492 (funcall fn obj size)))
495 (declaim (inline map-caller-code-components))
496 (defun map-caller-code-components (function spaces fn)
497 "Call FN for each code component with a fdefn for FUNCTION in its
499 (let ((function (coerce function 'function)))
500 (map-allocated-code-components
503 (declare (ignore size))
507 (when (and (sb-kernel:fdefn-p constant)
508 (eq (sb-kernel:fdefn-fun constant)
510 (funcall fn obj))))))))
512 (provide 'sb-introspect)