1 ;;;; This software is part of the SBCL system. See the README file for
4 ;;;; This software is derived from the CMU CL system, which was
5 ;;;; written at Carnegie Mellon University and released into the
6 ;;;; public domain. The software is in the public domain and is
7 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
8 ;;;; files for more information.
10 (defpackage :sb-introspect-test
11 (:use "SB-INTROSPECT" "CL" "SB-RT"))
13 (in-package :sb-introspect-test)
15 (defmacro deftest* ((name &key fails-on) form &rest results)
17 (when (sb-impl::featurep ',fails-on)
18 (pushnew ',name sb-rt::*expected-failures*))
19 (deftest ,name ,form ,@results)))
21 (deftest function-lambda-list.1
22 (function-lambda-list 'cl-user::one)
23 (cl-user::a cl-user::b cl-user::c))
25 (deftest function-lambda-list.2
26 (function-lambda-list 'the)
27 (sb-c::value-type sb-c::form))
29 (deftest function-lambda-list.3
30 (function-lambda-list #'(sb-pcl::slow-method cl-user::j (t)))
31 (sb-pcl::method-args sb-pcl::next-methods))
33 (deftest definition-source-plist.1
34 (let* ((source (find-definition-source #'cl-user::one))
35 (plist (definition-source-plist source)))
36 (values (= (definition-source-file-write-date source)
37 (file-write-date "test.lisp"))
38 (or (equal (getf plist :test-outer)
43 (deftest definition-source-plist.2
44 (let ((plist (definition-source-plist
45 (find-definition-source #'cl-user::four))))
46 (values (or (equal (getf plist :test-outer) "OUT")
48 (or (equal (getf plist :test-inner) "IN")
52 (defun matchp (object form-number)
53 (let ((ds (sb-introspect:find-definition-source object)))
54 (and (pathnamep (sb-introspect:definition-source-pathname ds))
56 (first (sb-introspect:definition-source-form-path ds))))))
58 (defun matchp-name (type object form-number)
59 (let ((ds (car (sb-introspect:find-definition-sources-by-name object type))))
60 (and (pathnamep (sb-introspect:definition-source-pathname ds))
62 (first (sb-introspect:definition-source-form-path ds))))))
64 (defun matchp-length (type object form-numbers)
65 (let ((ds (sb-introspect:find-definition-sources-by-name object type)))
66 (= (length ds) form-numbers)))
68 (deftest find-source-stuff.1
69 (matchp-name :function 'cl-user::one 2)
72 (deftest find-source-stuff.2
73 (matchp #'cl-user::one 2)
76 (deftest find-source-stuff.3
77 (matchp-name :generic-function 'cl-user::two 3)
80 (deftest find-source-stuff.4
81 (matchp (car (sb-pcl:generic-function-methods #'cl-user::two)) 4)
84 (deftest find-source-stuff.5
85 (matchp-name :variable 'cl-user::*a* 8)
88 (deftest find-source-stuff.6
89 (matchp-name :variable 'cl-user::*b* 9)
92 (deftest find-source-stuff.7
93 (matchp-name :class 'cl-user::a 10)
96 (deftest find-source-stuff.8
97 (matchp-name :condition 'cl-user::b 11)
100 (deftest find-source-stuff.9
101 (matchp-name :structure 'cl-user::c 12)
104 (deftest find-source-stuff.10
105 (matchp-name :function 'cl-user::make-c 12)
108 (deftest find-source-stuff.11
109 (matchp-name :function 'cl-user::c-e 12)
112 (deftest find-source-stuff.12
113 (matchp-name :structure 'cl-user::d 13)
116 (deftest find-source-stuff.13
117 (matchp-name :function 'cl-user::make-d 13)
120 (deftest find-source-stuff.14
121 (matchp-name :function 'cl-user::d-e 13)
124 (deftest find-source-stuff.15
125 (matchp-name :package 'cl-user::e 14)
128 (deftest find-source-stuff.16
129 (matchp-name :symbol-macro 'cl-user::f 15)
132 (deftest find-source-stuff.17
133 (matchp-name :type 'cl-user::g 16)
136 (deftest find-source-stuff.18
137 (matchp-name :constant 'cl-user::+h+ 17)
140 (deftest find-source-stuff.19
141 (matchp-length :method 'cl-user::j 2)
144 (deftest find-source-stuff.20
145 (matchp-name :macro 'cl-user::l 20)
148 (deftest find-source-stuff.21
149 (matchp-name :compiler-macro 'cl-user::m 21)
152 (deftest find-source-stuff.22
153 (matchp-name :setf-expander 'cl-user::n 22)
156 (deftest find-source-stuff.23
157 (matchp-name :function '(setf cl-user::o) 23)
160 (deftest find-source-stuff.24
161 (matchp-name :method '(setf cl-user::p) 24)
164 (deftest find-source-stuff.25
165 (matchp-name :macro 'cl-user::q 25)
169 (deftest find-source-stuff.26
170 (matchp-name :method-combination 'cl-user::r 26)
174 (deftest find-source-stuff.27
175 (matchp-name :setf-expander 'cl-user::s 27)
178 (deftest find-source-stuff.28
179 (let ((fin (make-instance 'sb-mop:funcallable-standard-object)))
180 (sb-mop:set-funcallable-instance-function fin #'cl-user::one)
184 (deftest find-source-stuff.29
187 (sb-profile:profile cl-user::one)
188 (matchp-name :function 'cl-user::one 2))
189 (sb-profile:unprofile cl-user::one))
192 (deftest find-source-stuff.30
193 ;; Test finding a type that isn't one
194 (not (find-definition-sources-by-name 'fboundp :type))
197 (deftest find-source-stuff.31
198 (matchp-name :function 'cl-user::compile-time-too-fun 28)
201 (deftest find-source-stuff.32
202 (matchp-name :function 'cl-user::loaded-as-source-fun 3)
205 ;;; Check wrt. interplay of generic functions and their methods.
207 (defgeneric xuuq (gf.a gf.b &rest gf.rest &key gf.k-X))
208 (defmethod xuuq ((m1.a number) m1.b &rest m1.rest &key gf.k-X m1.k-Y m1.k-Z)
209 (declare (ignore m1.a m1.b m1.rest gf.k-X m1.k-Y m1.k-Z))
211 (defmethod xuuq ((m2.a string) m2.b &rest m2.rest &key gf.k-X m1.k-Y m2.k-Q)
212 (declare (ignore m2.a m2.b m2.rest gf.k-X m1.k-Y m2.k-Q))
215 ;; XUUQ's lambda list should look similiar to
217 ;; (GF.A GF.B &REST GF.REST &KEY GF.K-X M1.K-Z M1.K-Y M2.K-Q)
219 (deftest gf-interplay.1
220 (multiple-value-bind (required optional restp rest keyp keys allowp
221 auxp aux morep more-context more-count)
222 (sb-int:parse-lambda-list (function-lambda-list #'xuuq))
223 (and (equal required '(gf.a gf.b))
225 (and restp (eql rest 'gf.rest))
227 (member 'gf.k-X keys)
228 (member 'm1.k-Y keys)
229 (member 'm1.k-Z keys)
230 (member 'm2.k-Q keys))
232 (and (not auxp) (null aux))
233 (and (not morep) (null more-context) (not more-count))))
236 ;;; Check what happens when there's no explicit DEFGENERIC.
238 (defmethod kroolz (r1 r2 &optional opt &aux aux)
239 (declare (ignore r1 r2 opt aux))
242 (deftest gf-interplay.2
243 (equal (function-lambda-list #'kroolz) '(r1 r2 &optional opt))
246 ;;;; Check correctness of DEFTYPE-LAMBDA-LIST.
248 (&whole w &environment e r1 r2 &optional o &rest rest &key k1 k2 k3)
249 (declare (ignore w e r1 r2 o rest k1 k2 k3))
252 (deftest deftype-lambda-list.1
253 (deftype-lambda-list 'foobar-type)
254 (&whole w &environment e r1 r2 &optional o &rest rest &key k1 k2 k3)
257 (deftest deftype-lambda-list.2
258 (deftype-lambda-list (gensym))
262 ;; ARRAY is a primitive type with associated translator function.
263 (deftest deftype-lambda-list.3
264 (deftype-lambda-list 'array)
265 (&optional (sb-kernel::element-type '*) (sb-kernel::dimensions '*))
268 ;; VECTOR is a primitive type that is defined by means of DEFTYPE.
269 (deftest deftype-lambda-list.4
270 (deftype-lambda-list 'vector)
271 (&optional sb-kernel::element-type sb-kernel::size)
274 ;;; Test allocation-information
276 (defun tai (x kind info &key ignore)
277 (multiple-value-bind (kind2 info2) (sb-introspect:allocation-information x)
278 (unless (eq kind kind2)
279 (error "wanted ~S, got ~S" kind kind2))
280 (when (not (null ignore))
281 (setf info2 (copy-list info2))
284 (setf info (copy-list info))
289 (deftest allocation-infromation.1
290 (tai nil :heap '(:space :static))
293 (deftest allocation-information.2
294 (tai t :heap '(:space :static))
297 (deftest allocation-information.3
298 (tai 42 :immediate nil)
301 ;;; Skip the whole damn test on GENCGC PPC -- the combination is just
302 ;;; to flaky for this to make too much sense. GENCGC SPARC almost
303 ;;; certainly exhibits the same behavior patterns (or antipatterns) as
306 ;;; -- It appears that this test can also fail due to systematic issues
307 ;;; (possibly with the C compiler used) which we cannot detect based on
308 ;;; *features*. Until this issue has been fixed, I am marking this test
309 ;;; as failing on Windows to allow installation of the contrib on
310 ;;; affected builds, even if the underlying issue is (possibly?) not even
311 ;;; strictly related to windows. C.f. lp1057631. --DFL
313 (deftest* (allocation-information.4
314 ;; Ignored as per the comment above, even though it seems
315 ;; unlikely that this is the right condition.
316 :fails-on (or :win32 (and (or :ppc :sparc) :gencgc)))
319 ;; FIXME: This is the canonical GENCGC result. On PPC we sometimes get
320 ;; :LARGE T, which doesn't seem right -- but ignore that for now.
321 '(:space :dynamic :generation 6 :write-protected t :boxed t :pinned nil :large nil)
322 :ignore (list :page #+ppc :large))
325 ;; FIXME: Figure out what's the right cheney-result. SPARC at least
326 ;; has exhibited both :READ-ONLY and :DYNAMIC, which seems wrong.
332 (deftest allocation-information.thread.1
333 (let ((x (list 1 2 3)))
334 (declare (dynamic-extent x))
335 (tai x :stack sb-thread:*current-thread*))
341 (let ((x (list 1 2 3)))
342 (declare (dynamic-extent x))
343 (let ((child (sb-thread:make-thread
345 (sb-introspect:allocation-information x)))))
346 (equal (list :stack sb-thread:*current-thread*)
347 (multiple-value-list (sb-thread:join-thread child))))))
349 (deftest allocation-information.thread.2
353 (defun thread-tai2 ()
354 (let* ((sem (sb-thread:make-semaphore))
356 (child (sb-thread:make-thread
358 (let ((x (list 1 2 3)))
359 (declare (dynamic-extent x))
361 (sb-thread:wait-on-semaphore sem)))
365 (equal (list :stack child)
367 (sb-introspect:allocation-information obj)))
368 (sb-thread:signal-semaphore sem)
369 (sb-thread:join-thread child))))
371 (deftest allocation-information.thread.3
375 ;;;; Test FUNCTION-TYPE
377 (defun type-equal (typespec1 typespec2)
378 (or (equal typespec1 typespec2) ; TYPE= punts on &keywords in FTYPEs.
379 (sb-kernel:type= (sb-kernel:values-specifier-type typespec1)
380 (sb-kernel:values-specifier-type typespec2))))
382 (defmacro interpret (form)
383 `(let ((sb-ext:*evaluator-mode* :interpret))
388 (declaim (ftype (function (integer &optional string) string) moon))
389 (defun moon (int &optional suffix)
390 (concatenate 'string (princ-to-string int) suffix))
392 (deftest function-type.1
393 (values (type-equal (function-type 'moon) (function-type #'moon))
394 (type-equal (function-type #'moon)
395 '(function (integer &optional string)
396 (values string &rest t))))
399 (defun sun (x y &key k1)
400 (declare (fixnum x y))
401 (declare (boolean k1))
402 (declare (ignore x y k1))
405 (deftest function-type.2
406 (values (type-equal (function-type 'sun) (function-type #'sun))
407 (type-equal (function-type #'sun)
408 '(function (fixnum fixnum &key (:k1 (member nil t)))
409 (values (member t) &optional))))
414 (deftest function-type.5
417 (values (symbol-name s))))
418 (type-equal (function-type #'f)
419 '(function (symbol) (values simple-string &optional))))
424 (deftest function-type.6
430 (type-equal (function-type #'closure)
431 '(function (fixnum) (values fixnum &optional)))))
434 ;; Anonymous functions
436 (deftest function-type.7
437 (type-equal (function-type #'(lambda (x) (declare (fixnum x)) x))
438 '(function (fixnum) (values fixnum &optional)))
441 ;; Interpreted functions
444 (deftest function-type.8
445 (type-equal (function-type (interpret (lambda (x) (declare (fixnum x)) x)))
446 '(function (&rest t) *))
451 (defgeneric earth (x y))
453 (deftest function-type+gfs.1
454 (values (type-equal (function-type 'earth) (function-type #'earth))
455 (type-equal (function-type 'earth) '(function (t t) *)))
458 ;; Implicitly created generic functions.
460 ;; (FUNCTION-TYPE 'MARS) => FUNCTION at the moment. (1.0.31.26)
464 (defmethod mars (x y) (+ x y))
467 (deftest function-type+gfs.2
468 (values (type-equal (function-type 'mars) (function-type #'mars))
469 (type-equal (function-type 'mars) '(function (t t) *)))
472 ;; DEFSTRUCT created functions
474 ;; These do not yet work because SB-KERNEL:%FUN-NAME does not work on
475 ;; functions defined by DEFSTRUCT. (1.0.35.x)
482 (defstruct (struct (:predicate our-struct-p)
483 (:copier copy-our-struct))
486 (deftest function-type+defstruct.1
487 (values (type-equal (function-type 'struct-a)
488 (function-type #'struct-a))
489 (type-equal (function-type 'struct-a)
490 '(function (struct) (values fixnum &optional))))
493 (deftest function-type+defstruct.2
494 (values (type-equal (function-type 'our-struct-p)
495 (function-type #'our-struct-p))
496 (type-equal (function-type 'our-struct-p)
497 '(function (t) (values (member t nil) &optional))))
500 (deftest function-type+defstruct.3
501 (values (type-equal (function-type 'copy-our-struct)
502 (function-type #'copy-our-struct))
503 (type-equal (function-type 'copy-our-struct)
504 '(function (struct) (values struct &optional))))
507 (defstruct (typed-struct :named (:type list)
508 (:predicate typed-struct-p))
511 (deftest function-type+defstruct.4
512 (values (type-equal (function-type 'typed-struct-a)
513 (function-type #'typed-struct-a))
514 (type-equal (function-type 'typed-struct-a)
515 '(function (list) (values fixnum &optional))))
518 (deftest function-type+defstruct.5
519 (values (type-equal (function-type 'typed-struct-p)
520 (function-type #'typed-struct-p))
521 (type-equal (function-type 'typed-struct-p)
522 '(function (t) (values (member t nil) &optional))))
529 (defun (setf sun) (value x y &key k1)
530 (declare (boolean value))
531 (declare (fixnum x y))
532 (declare (boolean k1))
533 (declare (ignore x y k1))
536 (deftest function-type+setf.1
537 (values (type-equal (function-type '(setf sun))
538 (function-type #'(setf sun)))
539 (type-equal (function-type '(setf sun))
540 '(function ((member nil t)
542 &key (:k1 (member nil t)))
543 (values (member nil t) &optional))))
548 (deftest function-type+misc.1
550 (type-equal (function-type #'nullary)
551 '(function () (values null &optional))))
554 ;;; Defstruct accessor, copier, and predicate
556 (deftest defstruct-fun-sources
557 (let ((copier (find-definition-source #'cl-user::copy-three))
558 (accessor (find-definition-source #'cl-user::three-four))
559 (predicate (find-definition-source #'cl-user::three-p)))
560 (values (and (equalp copier accessor)
561 (equalp copier predicate))
563 (file-namestring (definition-source-pathname copier)))
565 (definition-source-form-path copier))))
570 (deftest defstruct-fun-sources-by-name
571 (let ((copier (car (find-definition-sources-by-name 'cl-user::copy-three :function)))
572 (accessor (car (find-definition-sources-by-name 'cl-user::three-four :function)))
573 (predicate (car (find-definition-sources-by-name 'cl-user::three-p :function))))
574 (values (and (equalp copier accessor)
575 (equalp copier predicate))
577 (file-namestring (definition-source-pathname copier)))
579 (definition-source-form-path copier))))