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"
46 (in-package :sb-introspect)
48 ;;;; Internal interface for SBCL debug info
50 ;;; Here are some tutorial-style type definitions to help understand
51 ;;; the internal SBCL debugging data structures we're using. The
52 ;;; commentary is based on CMUCL's debug internals manual.
54 (deftype debug-info ()
55 "Structure containing all the debug information related to a function.
56 Function objects reference debug-infos which in turn reference
57 debug-sources and so on."
58 'sb-c::compiled-debug-info)
60 (deftype debug-source ()
61 "Debug sources describe where to find source code.
62 For example, the debug source for a function compiled from a file will
63 include the pathname of the file and the position of the definition."
66 (deftype debug-function ()
67 "Debug function represent static compile-time information about a function."
68 'sb-c::compiled-debug-fun)
70 (declaim (ftype (function (function) debug-info) function-debug-info))
71 (defun function-debug-info (function)
72 (let* ((function-object (sb-kernel::%closure-fun function))
73 (function-header (sb-kernel:fun-code-header function-object)))
74 (sb-kernel:%code-debug-info function-header)))
76 (declaim (ftype (function (function) debug-source) function-debug-source))
77 (defun function-debug-source (function)
78 (debug-info-source (function-debug-info function)))
80 (declaim (ftype (function (debug-info) debug-source) debug-info-source))
81 (defun debug-info-source (debug-info)
82 (sb-c::debug-info-source debug-info))
84 (declaim (ftype (function (debug-info) debug-function) debug-info-debug-function))
85 (defun debug-info-debug-function (debug-info)
86 (elt (sb-c::compiled-debug-info-fun-map debug-info) 0))
88 (defun valid-function-name-p (name)
89 "True if NAME denotes a function name that can be passed to MACRO-FUNCTION or FDEFINITION "
90 (and (sb-int:valid-function-name-p name) t))
92 ;;;; Finding definitions
94 (defstruct definition-source
95 ;; Pathname of the source file that the definition was compiled from.
96 ;; This is null if the definition was not compiled from a file.
97 (pathname nil :type (or null pathname))
98 ;; Source-path of the definition within the file.
99 ;; This may be incomplete depending on the debug level at which the
100 ;; source was compiled.
101 (form-path '() :type list)
102 ;; Character offset of the top-level-form containing the definition.
103 ;; This corresponds to the first element of form-path.
104 (character-offset nil :type (or null integer))
105 ;; File-write-date of the source file when compiled.
106 ;; Null if not compiled from a file.
107 (file-write-date nil :type (or null integer))
108 ;; plist from WITH-COMPILATION-UNIT
110 ;; Any extra metadata that the caller might be interested in. For
111 ;; example the specializers of the method whose definition-source this
113 (description nil :type list))
115 (defun find-definition-sources-by-name (name type)
116 "Returns a list of DEFINITION-SOURCEs for the objects of type TYPE
117 defined with name NAME. NAME may be a symbol or a extended function
118 name. Type can currently be one of the following:
143 If an unsupported TYPE is requested, the function will return NIL.
151 (find-class name nil)))
152 (real-fdefinition (name)
153 ;; for getting the real function object, even if the
154 ;; function is being profiled
155 (let ((profile-info (gethash name sb-profile::*profiled-fun-name->info*)))
157 (sb-profile::profile-info-encapsulated-fun profile-info)
158 (fdefinition name)))))
162 (when (and (symbolp name)
163 (eq (sb-int:info :variable :kind name) :special))
164 (translate-source-location (sb-int:info :source-location type name))))
166 (when (and (symbolp name)
167 (eq (sb-int:info :variable :kind name) :constant))
168 (translate-source-location (sb-int:info :source-location type name))))
170 (when (and (symbolp name)
171 (eq (sb-int:info :variable :kind name) :macro))
172 (translate-source-location (sb-int:info :source-location type name))))
174 (when (and (symbolp name)
175 (macro-function name))
176 (find-definition-source (macro-function name))))
178 (when (compiler-macro-function name)
179 (find-definition-source (compiler-macro-function name))))
180 ((:function :generic-function)
181 (when (and (fboundp name)
182 (or (not (symbolp name))
183 (not (macro-function name))))
184 (let ((fun (real-fdefinition name)))
185 (when (eq (not (typep fun 'generic-function))
186 (not (eq type :generic-function)))
187 (find-definition-source fun)))))
189 (let ((expander-fun (sb-int:info :type :expander name)))
191 (find-definition-source expander-fun))))
194 (let ((fun (real-fdefinition name)))
195 (when (typep fun 'generic-function)
196 (loop for method in (sb-mop::generic-function-methods
198 for source = (find-definition-source method)
199 when source collect source)))))
201 (when (and (consp name)
202 (eq (car name) 'setf))
203 (setf name (cadr name)))
204 (let ((expander (or (sb-int:info :setf :inverse name)
205 (sb-int:info :setf :expander name))))
207 (sb-introspect:find-definition-source (if (symbolp expander)
208 (symbol-function expander)
211 (let ((class (get-class name)))
213 (when (typep class 'sb-pcl::structure-class)
214 (find-definition-source class))
215 (when (sb-int:info :typed-structure :info name)
216 (translate-source-location
217 (sb-int:info :source-location :typed-structure name))))))
219 (let ((class (get-class name)))
221 (not (typep class 'sb-pcl::structure-class)))
222 (when (eq (not (typep class 'sb-pcl::condition-class))
223 (not (eq type :condition)))
224 (find-definition-source class)))))
225 ((:method-combination)
226 (let ((combination-fun
227 (ignore-errors (find-method #'sb-mop:find-method-combination
229 (list (find-class 'generic-function)
232 (when combination-fun
233 (find-definition-source combination-fun))))
236 (let ((package (find-package name)))
238 (find-definition-source package)))))
239 ;; TRANSFORM and OPTIMIZER handling from swank-sbcl
242 (let ((fun-info (sb-int:info :function :info name)))
244 (loop for xform in (sb-c::fun-info-transforms fun-info)
245 for source = (find-definition-source
246 (sb-c::transform-function xform))
247 for typespec = (sb-kernel:type-specifier
248 (sb-c::transform-type xform))
249 for note = (sb-c::transform-note xform)
250 do (setf (definition-source-description source)
252 (list (second typespec) note)
257 (let ((fun-info (sb-int:info :function :info name)))
259 (let ((otypes '((sb-c::fun-info-derive-type . sb-c:derive-type)
260 (sb-c::fun-info-ltn-annotate . sb-c:ltn-annotate)
261 (sb-c::fun-info-ltn-annotate . sb-c:ltn-annotate)
262 (sb-c::fun-info-optimizer . sb-c:optimizer))))
263 (loop for (reader . name) in otypes
264 for fn = (funcall reader fun-info)
266 (let ((source (find-definition-source fn)))
267 (setf (definition-source-description source)
272 (let ((fun-info (sb-int:info :function :info name)))
274 (loop for vop in (sb-c::fun-info-templates fun-info)
275 for source = (find-definition-source
276 (sb-c::vop-info-generator-function vop))
277 do (setf (definition-source-description source)
278 (list (sb-c::template-name vop)
279 (sb-c::template-note vop)))
283 (let ((transform-fun (sb-int:info :function :source-transform name)))
285 (sb-introspect:find-definition-source transform-fun)))))
289 (defun find-definition-source (object)
291 ((or sb-pcl::condition-class sb-pcl::structure-class)
292 (let ((classoid (sb-impl::find-classoid (class-name object))))
294 (let ((layout (sb-impl::classoid-layout classoid)))
296 (translate-source-location
297 (sb-kernel::layout-source-location layout)))))))
300 (find-definition-sources-by-name
301 (sb-pcl::method-combination-type-name object) :method-combination)))
303 (translate-source-location (sb-impl::package-source-location object)))
305 (translate-source-location (sb-pcl::definition-source object)))
306 ;; Use the PCL definition location information instead of the function
307 ;; debug-info for methods and generic functions. Sometimes the
308 ;; debug-info would point into PCL internals instead of the proper
311 (let ((source (translate-source-location
312 (sb-pcl::definition-source object))))
314 (setf (definition-source-description source)
315 (list (sb-mop:generic-function-lambda-list object))))
318 (let ((source (translate-source-location
319 (sb-pcl::definition-source object))))
321 (setf (definition-source-description source)
322 (append (method-qualifiers object)
323 (if (sb-mop:method-generic-function object)
324 (sb-pcl::unparse-specializers
325 (sb-mop:method-generic-function object)
326 (sb-mop:method-specializers object))
327 (sb-mop:method-specializers object)))))
330 (sb-eval:interpreted-function
331 (let ((source (translate-source-location
332 (sb-eval:interpreted-function-source-location object))))
335 (cond ((struct-accessor-p object)
336 (find-definition-source
337 (struct-accessor-structure-class object)))
338 ((struct-predicate-p object)
339 (find-definition-source
340 (struct-predicate-structure-class object)))
342 (find-function-definition-source object))))
343 ((or condition standard-object structure-object)
344 (find-definition-source (class-of object)))
346 (error "Don't know how to retrieve source location for a ~S~%"
349 (defun find-function-definition-source (function)
350 (let* ((debug-info (function-debug-info function))
351 (debug-source (debug-info-source debug-info))
352 (debug-fun (debug-info-debug-function debug-info))
353 (tlf (if debug-fun (sb-c::compiled-debug-fun-tlf-number debug-fun))))
354 (make-definition-source
356 ;; KLUDGE: at the moment, we don't record the correct toplevel
357 ;; form number for forms processed by EVAL (including EVAL-WHEN
358 ;; :COMPILE-TOPLEVEL). Until that's fixed, don't return a
359 ;; DEFINITION-SOURCE with a pathname. (When that's fixed, take
360 ;; out the (not (debug-source-form ...)) test.
361 (if (and (sb-c::debug-source-namestring debug-source)
362 (not (sb-c::debug-source-form debug-source)))
363 (parse-namestring (sb-c::debug-source-namestring debug-source)))
366 (elt (sb-c::debug-source-start-positions debug-source) tlf))
367 ;; Unfortunately there is no proper source path available in the
368 ;; debug-source. FIXME: We could use sb-di:code-locations to get
369 ;; a full source path. -luke (12/Mar/2005)
370 :form-path (if tlf (list tlf))
371 :file-write-date (sb-c::debug-source-created debug-source)
372 :plist (sb-c::debug-source-plist debug-source))))
374 (defun translate-source-location (location)
376 (make-definition-source
377 :pathname (let ((n (sb-c:definition-source-location-namestring location)))
379 (parse-namestring n)))
381 (let ((number (sb-c:definition-source-location-toplevel-form-number
385 :plist (sb-c:definition-source-location-plist location))
386 (make-definition-source)))
388 ;;; This is kludgey. We expect these functions (the underlying functions,
389 ;;; not the closures) to be in static space and so not move ever.
390 ;;; FIXME It's also possibly wrong: not all structures use these vanilla
391 ;;; accessors, e.g. when the :type option is used
392 (defvar *struct-slotplace-reader*
393 (sb-vm::%simple-fun-self #'definition-source-pathname))
394 (defvar *struct-slotplace-writer*
395 (sb-vm::%simple-fun-self #'(setf definition-source-pathname)))
396 (defvar *struct-predicate*
397 (sb-vm::%simple-fun-self #'definition-source-p))
399 (defun struct-accessor-p (function)
400 (let ((self (sb-vm::%simple-fun-self function)))
401 ;; FIXME there are other kinds of struct accessor. Fill out this list
402 (member self (list *struct-slotplace-reader*
403 *struct-slotplace-writer*))))
405 (defun struct-predicate-p (function)
406 (let ((self (sb-vm::%simple-fun-self function)))
407 ;; FIXME there may be other structure predicate functions
408 (member self (list *struct-predicate*))))
410 ;;; FIXME: maybe this should be renamed as FUNCTION-LAMBDA-LIST?
411 (defun function-arglist (function)
412 "Describe the lambda list for the extended function designator FUNCTION.
413 Works for special-operators, macros, simple functions,
414 interpreted functions, and generic functions. Signals error if
416 (cond ((valid-function-name-p function)
417 (function-arglist (or (and (symbolp function)
418 (macro-function function))
419 (fdefinition function))))
420 ((typep function 'generic-function)
421 (sb-pcl::generic-function-pretty-arglist function))
423 ((typep function 'sb-eval:interpreted-function)
424 (sb-eval:interpreted-function-lambda-list function))
425 (t (sb-kernel:%simple-fun-arglist (sb-kernel:%fun-fun function)))))
427 (defun struct-accessor-structure-class (function)
428 (let ((self (sb-vm::%simple-fun-self function)))
430 ((member self (list *struct-slotplace-reader* *struct-slotplace-writer*))
432 (sb-kernel::classoid-name
433 (sb-kernel::layout-classoid
434 (sb-kernel:%closure-index-ref function 1)))))
437 (defun struct-predicate-structure-class (function)
438 (let ((self (sb-vm::%simple-fun-self function)))
440 ((member self (list *struct-predicate*))
442 (sb-kernel::classoid-name
443 (sb-kernel::layout-classoid
444 (sb-kernel:%closure-index-ref function 0)))))
447 ;;;; find callers/callees, liberated from Helmut Eller's code in SLIME
449 ;;; This interface is trmendously experimental.
451 ;;; For the moment I'm taking the view that FDEFN is an internal
452 ;;; object (one out of one CMUCL developer surveyed didn't know what
453 ;;; they were for), so these routines deal in FUNCTIONs
455 ;;; Find callers and callees by looking at the constant pool of
456 ;;; compiled code objects. We assume every fdefn object in the
457 ;;; constant pool corresponds to a call to that function. A better
458 ;;; strategy would be to use the disassembler to find actual
461 (defun find-function-callees (function)
462 "Return functions called by FUNCTION."
465 (sb-kernel:fun-code-header function)
467 (when (sb-kernel:fdefn-p obj)
468 (push (sb-kernel:fdefn-fun obj)
473 (defun find-function-callers (function &optional (spaces '(:read-only :static
475 "Return functions which call FUNCTION, by searching SPACES for code objects"
476 (let ((referrers '()))
477 (map-caller-code-components
481 (let ((entry (sb-kernel:%code-entry-points code)))
483 (push (princ-to-string code) referrers))
485 (loop for e = entry then (sb-kernel::%simple-fun-next e)
487 do (pushnew e referrers)))))))
490 (declaim (inline map-code-constants))
491 (defun map-code-constants (code fn)
492 "Call FN for each constant in CODE's constant pool."
493 (check-type code sb-kernel:code-component)
494 (loop for i from sb-vm:code-constants-offset below
495 (sb-kernel:get-header-data code)
496 do (funcall fn (sb-kernel:code-header-ref code i))))
498 (declaim (inline map-allocated-code-components))
499 (defun map-allocated-code-components (spaces fn)
500 "Call FN for each allocated code component in one of SPACES. FN
501 receives the object and its size as arguments. SPACES should be a
502 list of the symbols :dynamic, :static, or :read-only."
503 (dolist (space spaces)
504 (sb-vm::map-allocated-objects
505 (lambda (obj header size)
506 (when (= sb-vm:code-header-widetag header)
507 (funcall fn obj size)))
511 (declaim (inline map-caller-code-components))
512 (defun map-caller-code-components (function spaces fn)
513 "Call FN for each code component with a fdefn for FUNCTION in its
515 (let ((function (coerce function 'function)))
516 (map-allocated-code-components
519 (declare (ignore size))
523 (when (and (sb-kernel:fdefn-p constant)
524 (eq (sb-kernel:fdefn-fun constant)
526 (funcall fn obj))))))))
530 (defun get-simple-fun (functoid)
533 (get-simple-fun (sb-vm::fdefn-fun functoid)))
534 ((or null sb-impl::funcallable-instance)
537 (sb-kernel::%closure-fun functoid))))
539 (defun collect-xref (kind-index wanted-name)
541 (dolist (env sb-c::*info-environment* ret)
542 ;; Loop through the infodb ...
543 (sb-c::do-info (env :class class :type type :name info-name
545 ;; ... looking for function or macro definitions
546 (when (and (eql class :function)
547 (or (eql type :macro-function)
548 (eql type :definition)))
549 ;; Get a simple-fun for the definition, and an xref array
550 ;; from the table if available.
551 (let* ((simple-fun (get-simple-fun value))
552 (xrefs (when simple-fun
553 (sb-vm::%simple-fun-xrefs simple-fun)))
555 (aref xrefs kind-index))))
556 ;; Loop through the name/path xref entries in the table
557 (loop for i from 0 below (length array) by 2
558 for xref-name = (aref array i)
559 for xref-path = (aref array (1+ i))
560 do (when (eql xref-name wanted-name)
561 (let ((source-location
562 (find-function-definition-source simple-fun)))
563 ;; Use the more accurate source path from
565 (setf (definition-source-form-path source-location)
567 (push (cons info-name source-location)
570 (defun who-calls (function-name)
571 "Use the xref facility to search for source locations where the
572 global function named FUNCTION-NAME is called. Returns a list of
573 function name, definition-source pairs."
574 (collect-xref #.(position :calls sb-c::*xref-kinds*) function-name))
576 (defun who-binds (symbol)
577 "Use the xref facility to search for source locations where the
578 special variable SYMBOL is rebound. Returns a list of function name,
579 definition-source pairs."
580 (collect-xref #.(position :binds sb-c::*xref-kinds*) symbol))
582 (defun who-references (symbol)
583 "Use the xref facility to search for source locations where the
584 special variable or constant SYMBOL is read. Returns a list of function
585 name, definition-source pairs."
586 (collect-xref #.(position :references sb-c::*xref-kinds*) symbol))
588 (defun who-sets (symbol)
589 "Use the xref facility to search for source locations where the
590 special variable SYMBOL is written to. Returns a list of function name,
591 definition-source pairs."
592 (collect-xref #.(position :sets sb-c::*xref-kinds*) symbol))
594 (defun who-macroexpands (macro-name)
595 "Use the xref facility to search for source locations where the
596 macro MACRO-NAME is expanded. Returns a list of function name,
597 definition-source pairs."
598 (collect-xref #.(position :macroexpands sb-c::*xref-kinds*) macro-name))
600 (provide 'sb-introspect)