contrib/sb-introspect/test-driver.lisp

   1 ;;;; This software is part of the SBCL system. See the README file for
   2 ;;;; more information.
   3 ;;;;
   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.
   9
  10 (defpackage :sb-introspect-test
  11   (:use "SB-INTROSPECT" "CL" "SB-RT"))
  12
  13 (in-package :sb-introspect-test)
  14
  15 (defmacro deftest* ((name &key fails-on) form &rest results)
  16   `(progn
  17      (when (sb-impl::featurep ',fails-on)
  18        (pushnew ',name sb-rt::*expected-failures*))
  19      (deftest ,name ,form ,@results)))
  20
  21 ;; When running the tests which query for a function type, sb-interpreter
  22 ;; can return an answer if there were type declarations for the arguments,
  23 ;; except that return type is always unknown. The compiler returns a
  24 ;; definitive answer, and sb-eval always answers with just FUNCTION.
  25 (defun expect-wild-return-type-p (f)
  26   (declare (ignorable f))
  27   (or #+sb-fasteval (typep f 'sb-interpreter:interpreted-function)))
  28
  29 (deftest function-lambda-list.1
  30     (function-lambda-list 'cl-user::one)
  31   (cl-user::a cl-user::b cl-user::c))
  32
  33 (deftest function-lambda-list.2
  34     (function-lambda-list 'the)
  35   (sb-c::value-type sb-c::form))
  36
  37 (deftest function-lambda-list.3
  38     (function-lambda-list #'(sb-pcl::slow-method cl-user::j (t)))
  39   (sb-pcl::method-args sb-pcl::next-methods))
  40
  41 (deftest macro-lambda-list.1
  42     (equal (function-lambda-list (defmacro macro-lambda-list.1-m (x b)
  43                                    `(x b)))
  44            '(x b))
  45   t)
  46
  47 #+sb-eval
  48 (deftest macro-lambda-list.2
  49     (equal (function-lambda-list (interpret (defmacro macro-lambda-list.2-m (x)
  50                                               x)))
  51            '(x))
  52   t)
  53
  54 (deftest definition-source.1
  55     (values (consp (find-definition-sources-by-name 'vectorp :vop))
  56             (consp (find-definition-sources-by-name 'check-type :macro)))
  57   t t)
  58
  59 (deftest definition-source-plist.1
  60     (let* ((source (find-definition-source #'cl-user::one))
  61            (plist (definition-source-plist source))
  62            (pathname (definition-source-pathname source)))
  63       (values (equalp pathname #p"SYS:CONTRIB;SB-INTROSPECT;TEST.LISP.NEWEST")
  64               (= (definition-source-file-write-date source)
  65                  (file-write-date pathname))
  66               (or (equal (getf plist :test-outer)
  67                          "OUT")
  68                   plist)))
  69   t t t)
  70
  71 ;; Not sure why this fails when interpreted, and don't really care too much.
  72 ;; The behavior seems right to me anyway.
  73 #.(if (eq sb-ext:*evaluator-mode* :compile)
  74 '(deftest definition-source-plist.2
  75     (let ((plist (definition-source-plist
  76                      (find-definition-source #'cl-user::four))))
  77       (values (or (equal (getf plist :test-outer) "OUT")
  78                   plist)
  79               (or (equal (getf plist :test-inner) "IN")
  80                   plist)))
  81   t t)
  82 (values))
  83
  84 (defun matchp (object form-number)
  85   (let ((ds (sb-introspect:find-definition-source object)))
  86     (and (pathnamep (sb-introspect:definition-source-pathname ds))
  87          (= form-number
  88             (first (sb-introspect:definition-source-form-path ds))))))
  89
  90 (defun matchp-name (type object form-number)
  91   (let ((ds (car (sb-introspect:find-definition-sources-by-name object type))))
  92     (and (pathnamep (sb-introspect:definition-source-pathname ds))
  93          (= form-number
  94             (first (sb-introspect:definition-source-form-path ds))))))
  95
  96 (defun matchp-length (type object form-numbers)
  97   (let ((ds (sb-introspect:find-definition-sources-by-name object type)))
  98     (= (length ds) form-numbers)))
  99
 100 (deftest find-source-stuff.1
 101     (matchp-name :function 'cl-user::one 2)
 102   t)
 103
 104 (deftest find-source-stuff.2
 105     (matchp #'cl-user::one 2)
 106   t)
 107
 108 (deftest find-source-stuff.3
 109     (matchp-name :generic-function 'cl-user::two 3)
 110   t)
 111
 112 (deftest find-source-stuff.4
 113     (matchp (car (sb-pcl:generic-function-methods #'cl-user::two)) 4)
 114   t)
 115
 116 (deftest find-source-stuff.5
 117     (matchp-name :variable 'cl-user::*a* 8)
 118   t)
 119
 120 (deftest find-source-stuff.6
 121     (matchp-name :variable 'cl-user::*b* 9)
 122   t)
 123
 124 (deftest find-source-stuff.7
 125     (matchp-name :class 'cl-user::a 10)
 126   t)
 127
 128 (deftest find-source-stuff.8
 129     (matchp-name :condition 'cl-user::b 11)
 130   t)
 131
 132 (deftest find-source-stuff.9
 133     (matchp-name :structure 'cl-user::c 12)
 134   t)
 135
 136 (deftest find-source-stuff.10
 137     (matchp-name :function 'cl-user::make-c 12)
 138   t)
 139
 140 (deftest find-source-stuff.11
 141     (matchp-name :function 'cl-user::c-e 12)
 142   t)
 143
 144 (deftest find-source-stuff.12
 145     (matchp-name :structure 'cl-user::d 13)
 146   t)
 147
 148 (deftest find-source-stuff.13
 149     (matchp-name :function 'cl-user::make-d 13)
 150   t)
 151
 152 (deftest find-source-stuff.14
 153     (matchp-name :function 'cl-user::d-e 13)
 154   t)
 155
 156 (deftest find-source-stuff.15
 157     (matchp-name :package 'cl-user::e 14)
 158   t)
 159
 160 (deftest find-source-stuff.16
 161     (matchp-name :symbol-macro 'cl-user::f 15)
 162   t)
 163
 164 (deftest find-source-stuff.17
 165     (matchp-name :type 'cl-user::g 16)
 166   t)
 167
 168 (deftest find-source-stuff.18
 169     (matchp-name :constant 'cl-user::+h+ 17)
 170   t)
 171
 172 (deftest find-source-stuff.19
 173     (matchp-length :method 'cl-user::j 2)
 174   t)
 175
 176 (deftest find-source-stuff.20
 177     (matchp-name :macro 'cl-user::l 20)
 178   t)
 179
 180 (deftest find-source-stuff.21
 181     (matchp-name :compiler-macro 'cl-user::m 21)
 182   t)
 183
 184 (deftest find-source-stuff.22
 185     (matchp-name :setf-expander 'cl-user::n 22)
 186   t)
 187
 188 (deftest find-source-stuff.23
 189     (matchp-name :function  '(setf cl-user::o) 23)
 190   t)
 191
 192 (deftest find-source-stuff.24
 193     (matchp-name :method  '(setf cl-user::p) 24)
 194   t)
 195
 196 (deftest find-source-stuff.25
 197     (matchp-name :macro  'cl-user::q 25)
 198   t)
 199
 200
 201 (deftest find-source-stuff.26
 202     (matchp-name :method-combination 'cl-user::r 26)
 203   t)
 204
 205
 206 (deftest find-source-stuff.27
 207     (matchp-name :setf-expander 'cl-user::s 27)
 208   t)
 209
 210 (deftest find-source-stuff.28
 211     (let ((fin (make-instance 'sb-mop:funcallable-standard-object)))
 212       (sb-mop:set-funcallable-instance-function fin #'cl-user::one)
 213       (matchp fin 2))
 214   t)
 215
 216 (deftest find-source-stuff.29
 217     (unwind-protect
 218          (progn
 219            (sb-profile:profile cl-user::one)
 220            (matchp-name :function 'cl-user::one 2))
 221       (sb-profile:unprofile cl-user::one))
 222   t)
 223
 224 (deftest find-source-stuff.30
 225     ;; Test finding a type that isn't one
 226     (not (find-definition-sources-by-name 'fboundp :type))
 227   t)
 228
 229 (deftest find-source-stuff.31
 230     (matchp-name :function 'cl-user::compile-time-too-fun 28)
 231   t)
 232
 233 (deftest find-source-stuff.32
 234     (matchp-name :function 'cl-user::loaded-as-source-fun 3)
 235   t)
 236
 237 (deftest find-source-stuff.33
 238     (matchp-name :variable 'cl-user::**global** 29)
 239   t)
 240
 241 ;;; Check wrt. interplay of generic functions and their methods.
 242
 243 (defgeneric xuuq (gf.a gf.b          &rest gf.rest &key gf.k-X))
 244 (defmethod  xuuq ((m1.a number) m1.b &rest m1.rest &key gf.k-X m1.k-Y m1.k-Z)
 245   (declare (ignore m1.a m1.b m1.rest gf.k-X m1.k-Y m1.k-Z))
 246   'm1)
 247 (defmethod  xuuq ((m2.a string) m2.b &rest m2.rest &key gf.k-X m1.k-Y m2.k-Q)
 248   (declare (ignore m2.a m2.b m2.rest gf.k-X m1.k-Y m2.k-Q))
 249   'm2)
 250
 251 ;; XUUQ's lambda list should look similiar to
 252 ;;
 253 ;;    (GF.A GF.B &REST GF.REST &KEY GF.K-X M1.K-Z M1.K-Y M2.K-Q)
 254 ;;
 255 (deftest gf-interplay.1
 256     (multiple-value-bind (llks required optional rest keys aux more)
 257         (sb-int:parse-lambda-list (function-lambda-list #'xuuq))
 258       (and (equal required '(gf.a gf.b))
 259            (null optional)
 260            (eq (car rest) 'gf.rest)
 261            (and (sb-int:ll-kwds-keyp llks)
 262                 (member 'gf.k-X keys)
 263                 (member 'm1.k-Y keys)
 264                 (member 'm1.k-Z keys)
 265                 (member 'm2.k-Q keys))
 266            (not (sb-int:ll-kwds-allowp llks))
 267            (null aux)
 268            (null more)))
 269   t)
 270
 271 ;;; Check what happens when there's no explicit DEFGENERIC.
 272
 273 (defmethod kroolz (r1 r2 &optional opt &aux aux)
 274   (declare (ignore r1 r2 opt aux))
 275   'kroolz)
 276
 277 (deftest gf-interplay.2
 278     (equal (function-lambda-list #'kroolz) '(r1 r2 &optional opt))
 279   t)
 280
 281 ;;;; Check correctness of DEFTYPE-LAMBDA-LIST.
 282 (deftype foobar-type
 283     (&whole w &environment e r1 r2 &optional o &rest rest &key k1 k2 k3)
 284   (declare (ignore w e r1 r2 o rest k1 k2 k3))
 285   nil)
 286
 287 (deftest deftype-lambda-list.1
 288     (deftype-lambda-list 'foobar-type)
 289   (r1 r2 &optional o &rest rest &key k1 k2 k3)
 290   t)
 291
 292 (deftest deftype-lambda-list.2
 293     (deftype-lambda-list (gensym))
 294   nil
 295   nil)
 296
 297 ;; ARRAY is a primitive type with associated translator function.
 298 (deftest deftype-lambda-list.3
 299     (deftype-lambda-list 'array)
 300   (&optional (sb-kernel::element-type '*) (sb-kernel::dimensions '*))
 301   t)
 302
 303 ;; VECTOR is a primitive type that is defined by means of DEFTYPE.
 304 (deftest deftype-lambda-list.4
 305     (deftype-lambda-list 'vector)
 306   (&optional sb-kernel::element-type sb-kernel::size)
 307   t)
 308
 309 ;;; Test allocation-information
 310
 311 (defun tai (x kind info &key ignore)
 312   (multiple-value-bind (kind2 info2) (sb-introspect:allocation-information x)
 313     (unless (eq kind kind2)
 314       (error "wanted ~S, got ~S" kind kind2))
 315     (when (not (null ignore))
 316       (setf info2 (copy-list info2))
 317       (dolist (key ignore)
 318         (remf info2 key))
 319       (setf info (copy-list info))
 320       (dolist (key ignore)
 321         (remf info key)))
 322     (equal info info2)))
 323
 324 (deftest allocation-infromation.1
 325     (tai nil :heap '(:space :static))
 326   t)
 327
 328 (deftest allocation-information.2
 329     (tai t :heap '(:space :static))
 330   t)
 331
 332 (deftest allocation-information.3
 333     (tai 42 :immediate nil)
 334   t)
 335 #+x86-64
 336 (deftest allocation-information.3b
 337     (tai 42s0 :immediate nil)
 338   t)
 339
 340 #.(if (and (eq sb-ext:*evaluator-mode* :compile) (member :sb-thread *features*))
 341 '(deftest allocation-information.thread.1
 342     (let ((x (list 1 2 3)))
 343       (declare (dynamic-extent x))
 344       (tai x :stack sb-thread:*current-thread*))
 345   t)
 346 (values))
 347
 348 #+sb-thread
 349 (progn
 350    (defun thread-tai ()
 351      (let ((x (list 1 2 3)))
 352        (declare (dynamic-extent x))
 353        (let ((child (sb-thread:make-thread
 354                      (lambda ()
 355                        (sb-introspect:allocation-information x)))))
 356          (equal (list :stack sb-thread:*current-thread*)
 357                 (multiple-value-list (sb-thread:join-thread child))))))
 358
 359    (deftest allocation-information.thread.2
 360        (thread-tai)
 361      t)
 362
 363    (defun thread-tai2 ()
 364      (let* ((sem (sb-thread:make-semaphore))
 365             (obj nil)
 366             (child (sb-thread:make-thread
 367                     (lambda ()
 368                       (let ((x (list 1 2 3)))
 369                         (declare (dynamic-extent x))
 370                         (setf obj x)
 371                         (sb-thread:wait-on-semaphore sem)))
 372                     :name "child")))
 373        (loop until obj)
 374        (unwind-protect
 375             (equal (list :stack child)
 376                    (multiple-value-list
 377                     (sb-introspect:allocation-information obj)))
 378          (sb-thread:signal-semaphore sem)
 379          (sb-thread:join-thread child))))
 380
 381    (deftest allocation-information.thread.3
 382        (thread-tai2)
 383      t))
 384
 385 ;;;; Test FUNCTION-TYPE
 386
 387 (defun type-equal (typespec1 typespec2)
 388   (or (equal typespec1 typespec2)   ; TYPE= punts on &keywords in FTYPEs.
 389       (sb-kernel:type= (sb-kernel:values-specifier-type typespec1)
 390                        (sb-kernel:values-specifier-type typespec2))))
 391
 392 (defmacro interpret (form)
 393   `(let ((sb-ext:*evaluator-mode* :interpret))
 394      (eval ',form)))
 395
 396 ;; Functions
 397
 398 (declaim (ftype (function (integer &optional string) string) moon))
 399 (defun moon (int &optional suffix)
 400   (concatenate 'string (princ-to-string int) suffix))
 401
 402 (deftest function-type.1
 403     (values (type-equal (function-type 'moon) (function-type #'moon))
 404             (type-equal (function-type #'moon)
 405                         '(function (integer &optional string)
 406                           (values string &rest t))))
 407   t t)
 408
 409 (defun sun (x y &key k1)
 410   (declare (fixnum x y))
 411   (declare (boolean k1))
 412   (declare (ignore x y k1))
 413   t)
 414
 415 (deftest function-type.2
 416     (values (type-equal (function-type 'sun) (function-type #'sun))
 417             (type-equal (function-type #'sun)
 418                         '(function (fixnum fixnum &key (:k1 (member nil t)))
 419                           (values (member t) &optional))))
 420   t t)
 421
 422 ;; Local functions
 423
 424 (deftest function-type.5
 425     (flet ((f (s)
 426              (declare (symbol s))
 427              (values (symbol-name s))))
 428       (type-equal (function-type #'f)
 429                   (if (expect-wild-return-type-p #'f)
 430                       '(function (symbol) *)
 431                       '(function (symbol) (values simple-string &optional)))))
 432   t)
 433
 434 ;; Closures
 435
 436 (deftest function-type.6
 437     (let ((x 10))
 438       (declare (fixnum x))
 439       (flet ((closure (y)
 440                (declare (fixnum y))
 441                (setq x (+ x y))))
 442         (type-equal (function-type #'closure)
 443                     (if (expect-wild-return-type-p #'closure)
 444                         '(function (fixnum) *)
 445                         '(function (fixnum) (values fixnum &optional))))))
 446   t)
 447
 448 ;; Anonymous functions
 449
 450 (deftest function-type.7
 451   (let ((f #'(lambda (x) (declare (fixnum x)) x)))
 452     (type-equal (function-type f)
 453                 (if (expect-wild-return-type-p f)
 454                     '(function (fixnum) *)
 455                     '(function (fixnum) (values fixnum &optional)))))
 456   t)
 457
 458 ;; Interpreted functions
 459
 460 #+sb-eval
 461 (deftest function-type.8
 462     (type-equal (function-type (interpret (lambda (x) (declare (fixnum x)) x)))
 463                 '(function (&rest t) *))
 464   t)
 465
 466 #+sb-eval
 467 (progn
 468   (interpret (defun some-interpreted-fun-to-trace (x) (car x)))
 469   (trace some-interpreted-fun-to-trace)
 470   (deftest get-simple-fun
 471       (sb-introspect::get-simple-fun #'some-interpreted-fun-to-trace)
 472     nil))
 473
 474 ;; Generic functions
 475
 476 (defgeneric earth (x y))
 477
 478 (deftest function-type+gfs.1
 479     (values (type-equal (function-type 'earth) (function-type #'earth))
 480             (type-equal (function-type 'earth) '(function (t t) *)))
 481   t t)
 482
 483 ;; Implicitly created generic functions.
 484
 485 ;; (FUNCTION-TYPE 'MARS) => FUNCTION at the moment. (1.0.31.26)
 486
 487 ;; See LP #520695.
 488
 489 (defmethod mars (x y) (+ x y))
 490
 491 #+ nil
 492 (deftest function-type+gfs.2
 493     (values (type-equal (function-type 'mars) (function-type #'mars))
 494             (type-equal (function-type 'mars) '(function (t t) *)))
 495   t t)
 496
 497 (progn
 498
 499   (defstruct (struct (:predicate our-struct-p)
 500                      (:copier copy-our-struct))
 501     (a 42 :type fixnum))
 502
 503   ;; This test doesn't work because the XEP for the out-of-line accessor
 504   ;; does not include the type test, and the function gets a signature
 505   ;; of (FUNCTION (T) (VALUES FIXNUM &OPTIONAL)). This can easily be fixed
 506   ;; by deleting (THE <struct> INSTANCE) from the access form
 507   ;; and correspondingly adding a declaration on the type of INSTANCE.
 508   ;;
 509   ;; Yes, it can be fixed, but it is done this way because it produces
 510   ;; smaller code.
 511   #+nil
 512   (deftest function-type+defstruct.1
 513       (values (type-equal (function-type 'struct-a)
 514                           (function-type #'struct-a))
 515               (type-equal (function-type 'struct-a)
 516                           '(function (struct) (values fixnum &optional))))
 517     t t)
 518
 519   (deftest function-type+defstruct.2
 520       (values (type-equal (function-type 'our-struct-p)
 521                           (function-type #'our-struct-p))
 522               (type-equal (function-type 'our-struct-p)
 523                           '(function (t) (values (member t nil) &optional))))
 524     t t)
 525
 526   (deftest function-type+defstruct.3
 527       (values (type-equal (function-type 'copy-our-struct)
 528                           (function-type #'copy-our-struct))
 529               (type-equal (function-type 'copy-our-struct)
 530                           '(function (struct) (values struct &optional))))
 531     t t)
 532
 533   (defstruct (typed-struct :named (:type list)
 534                            (:predicate typed-struct-p))
 535     (a 42 :type fixnum))
 536
 537   (deftest function-type+defstruct.4
 538       (values (type-equal (function-type 'typed-struct-a)
 539                           (function-type #'typed-struct-a))
 540               (type-equal (function-type 'typed-struct-a)
 541                           '(function (list) (values fixnum &optional))))
 542     t t)
 543
 544   (deftest function-type+defstruct.5
 545       (values (type-equal (function-type 'typed-struct-p)
 546                           (function-type #'typed-struct-p))
 547               (type-equal (function-type 'typed-struct-p)
 548                           '(function (t) (values (member t nil) &optional))))
 549     t t)
 550
 551   )
 552
 553 ;; SETF functions
 554
 555 (defun (setf sun) (value x y &key k1)
 556   (declare (boolean value))
 557   (declare (fixnum x y))
 558   (declare (boolean k1))
 559   (declare (ignore x y k1))
 560   value)
 561
 562 (deftest function-type+setf.1
 563     (values (type-equal (function-type '(setf sun))
 564                         (function-type #'(setf sun)))
 565             (type-equal (function-type '(setf sun))
 566                         '(function ((member nil t)
 567                                     fixnum fixnum
 568                                     &key (:k1 (member nil t)))
 569                           (values (member nil t) &optional))))
 570   t t)
 571
 572 ;; Misc
 573
 574 (deftest function-type+misc.1
 575     (flet ((nullary ()))
 576       (type-equal (function-type #'nullary)
 577                   (if (expect-wild-return-type-p #'nullary)
 578                       '(function () *)
 579                       '(function () (values null &optional)))))
 580   t)
 581
 582 ;;; Defstruct accessor, copier, and predicate
 583
 584 (deftest defstruct-fun-sources
 585   (let ((copier (find-definition-source #'cl-user::copy-three))
 586         (accessor (find-definition-source #'cl-user::three-four))
 587         (predicate (find-definition-source #'cl-user::three-p)))
 588     (values (and (equalp copier accessor)
 589                  (equalp copier predicate))
 590             (equal "TEST.LISP.NEWEST"
 591                    (file-namestring (definition-source-pathname copier)))
 592             (equal '(5)
 593                    (definition-source-form-path copier))))
 594   t
 595   t
 596   t)
 597
 598 (deftest defstruct-fun-sources-by-name
 599   (let ((copier (car (find-definition-sources-by-name 'cl-user::copy-three :function)))
 600         (accessor (car (find-definition-sources-by-name 'cl-user::three-four :function)))
 601         (predicate (car (find-definition-sources-by-name 'cl-user::three-p :function))))
 602     (values (and (equalp copier accessor)
 603                  (equalp copier predicate))
 604             (equal "TEST.LISP.NEWEST"
 605                    (file-namestring (definition-source-pathname copier)))
 606             (equal '(5)
 607                    (definition-source-form-path copier))))
 608   t
 609   t
 610   t)
 611
 612 (deftest alien-type.1
 613   (matchp-name :alien-type 'cl-user::test-alien-type 30)
 614   t)
 615
 616 (deftest alien-type.2
 617   (matchp-name :alien-type 'cl-user::test-alien-struct 31)
 618   t)
 619
 620 (deftest alien-variable
 621   (matchp-name :variable 'cl-user::test-alien-var 32)
 622   t)
 623
 624 (deftest condition-slot-reader
 625   (matchp-name :method 'cl-user::condition-slot-reader 33)
 626   t)
 627
 628 (deftest condition-slot-writer
 629   (matchp-name :method 'cl-user::condition-slot-writer 33)
 630   t)