Loading...
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 | /* SPDX-License-Identifier: GPL-2.0 */ /* * Base unit test (KUnit) API. * * Copyright (C) 2019, Google LLC. * Author: Brendan Higgins <brendanhiggins@google.com> */ #ifndef _KUNIT_TEST_H #define _KUNIT_TEST_H #include <kunit/assert.h> #include <kunit/try-catch.h> #include <linux/kernel.h> #include <linux/module.h> #include <linux/slab.h> #include <linux/types.h> #include <linux/kref.h> struct kunit_resource; typedef int (*kunit_resource_init_t)(struct kunit_resource *, void *); typedef void (*kunit_resource_free_t)(struct kunit_resource *); /** * struct kunit_resource - represents a *test managed resource* * @data: for the user to store arbitrary data. * @name: optional name * @free: a user supplied function to free the resource. Populated by * kunit_resource_alloc(). * * Represents a *test managed resource*, a resource which will automatically be * cleaned up at the end of a test case. * * Resources are reference counted so if a resource is retrieved via * kunit_alloc_and_get_resource() or kunit_find_resource(), we need * to call kunit_put_resource() to reduce the resource reference count * when finished with it. Note that kunit_alloc_resource() does not require a * kunit_resource_put() because it does not retrieve the resource itself. * * Example: * * .. code-block:: c * * struct kunit_kmalloc_params { * size_t size; * gfp_t gfp; * }; * * static int kunit_kmalloc_init(struct kunit_resource *res, void *context) * { * struct kunit_kmalloc_params *params = context; * res->data = kmalloc(params->size, params->gfp); * * if (!res->data) * return -ENOMEM; * * return 0; * } * * static void kunit_kmalloc_free(struct kunit_resource *res) * { * kfree(res->data); * } * * void *kunit_kmalloc(struct kunit *test, size_t size, gfp_t gfp) * { * struct kunit_kmalloc_params params; * * params.size = size; * params.gfp = gfp; * * return kunit_alloc_resource(test, kunit_kmalloc_init, * kunit_kmalloc_free, ¶ms); * } * * Resources can also be named, with lookup/removal done on a name * basis also. kunit_add_named_resource(), kunit_find_named_resource() * and kunit_destroy_named_resource(). Resource names must be * unique within the test instance. */ struct kunit_resource { void *data; const char *name; kunit_resource_free_t free; /* private: internal use only. */ struct kref refcount; struct list_head node; }; struct kunit; /* Size of log associated with test. */ #define KUNIT_LOG_SIZE 512 /* * TAP specifies subtest stream indentation of 4 spaces, 8 spaces for a * sub-subtest. See the "Subtests" section in * https://node-tap.org/tap-protocol/ */ #define KUNIT_SUBTEST_INDENT " " #define KUNIT_SUBSUBTEST_INDENT " " /** * struct kunit_case - represents an individual test case. * * @run_case: the function representing the actual test case. * @name: the name of the test case. * * A test case is a function with the signature, * ``void (*)(struct kunit *)`` * that makes expectations and assertions (see KUNIT_EXPECT_TRUE() and * KUNIT_ASSERT_TRUE()) about code under test. Each test case is associated * with a &struct kunit_suite and will be run after the suite's init * function and followed by the suite's exit function. * * A test case should be static and should only be created with the * KUNIT_CASE() macro; additionally, every array of test cases should be * terminated with an empty test case. * * Example: * * .. code-block:: c * * void add_test_basic(struct kunit *test) * { * KUNIT_EXPECT_EQ(test, 1, add(1, 0)); * KUNIT_EXPECT_EQ(test, 2, add(1, 1)); * KUNIT_EXPECT_EQ(test, 0, add(-1, 1)); * KUNIT_EXPECT_EQ(test, INT_MAX, add(0, INT_MAX)); * KUNIT_EXPECT_EQ(test, -1, add(INT_MAX, INT_MIN)); * } * * static struct kunit_case example_test_cases[] = { * KUNIT_CASE(add_test_basic), * {} * }; * */ struct kunit_case { void (*run_case)(struct kunit *test); const char *name; /* private: internal use only. */ bool success; char *log; }; static inline char *kunit_status_to_string(bool status) { return status ? "ok" : "not ok"; } /** * KUNIT_CASE - A helper for creating a &struct kunit_case * * @test_name: a reference to a test case function. * * Takes a symbol for a function representing a test case and creates a * &struct kunit_case object from it. See the documentation for * &struct kunit_case for an example on how to use it. */ #define KUNIT_CASE(test_name) { .run_case = test_name, .name = #test_name } /** * struct kunit_suite - describes a related collection of &struct kunit_case * * @name: the name of the test. Purely informational. * @init: called before every test case. * @exit: called after every test case. * @test_cases: a null terminated array of test cases. * * A kunit_suite is a collection of related &struct kunit_case s, such that * @init is called before every test case and @exit is called after every * test case, similar to the notion of a *test fixture* or a *test class* * in other unit testing frameworks like JUnit or Googletest. * * Every &struct kunit_case must be associated with a kunit_suite for KUnit * to run it. */ struct kunit_suite { const char name[256]; int (*init)(struct kunit *test); void (*exit)(struct kunit *test); struct kunit_case *test_cases; /* private: internal use only */ struct dentry *debugfs; char *log; }; /** * struct kunit - represents a running instance of a test. * * @priv: for user to store arbitrary data. Commonly used to pass data * created in the init function (see &struct kunit_suite). * * Used to store information about the current context under which the test * is running. Most of this data is private and should only be accessed * indirectly via public functions; the one exception is @priv which can be * used by the test writer to store arbitrary data. */ struct kunit { void *priv; /* private: internal use only. */ const char *name; /* Read only after initialization! */ char *log; /* Points at case log after initialization */ struct kunit_try_catch try_catch; /* * success starts as true, and may only be set to false during a * test case; thus, it is safe to update this across multiple * threads using WRITE_ONCE; however, as a consequence, it may only * be read after the test case finishes once all threads associated * with the test case have terminated. */ bool success; /* Read only after test_case finishes! */ spinlock_t lock; /* Guards all mutable test state. */ /* * Because resources is a list that may be updated multiple times (with * new resources) from any thread associated with a test case, we must * protect it with some type of lock. */ struct list_head resources; /* Protected by lock. */ }; static inline void kunit_set_failure(struct kunit *test) { WRITE_ONCE(test->success, false); } void kunit_init_test(struct kunit *test, const char *name, char *log); int kunit_run_tests(struct kunit_suite *suite); size_t kunit_suite_num_test_cases(struct kunit_suite *suite); unsigned int kunit_test_case_num(struct kunit_suite *suite, struct kunit_case *test_case); int __kunit_test_suites_init(struct kunit_suite * const * const suites); void __kunit_test_suites_exit(struct kunit_suite **suites); #if IS_BUILTIN(CONFIG_KUNIT) int kunit_run_all_tests(void); #else static inline int kunit_run_all_tests(void) { return 0; } #endif /* IS_BUILTIN(CONFIG_KUNIT) */ #ifdef MODULE /** * kunit_test_suites_for_module() - used to register one or more * &struct kunit_suite with KUnit. * * @__suites: a statically allocated list of &struct kunit_suite. * * Registers @__suites with the test framework. See &struct kunit_suite for * more information. * * If a test suite is built-in, module_init() gets translated into * an initcall which we don't want as the idea is that for builtins * the executor will manage execution. So ensure we do not define * module_{init|exit} functions for the builtin case when registering * suites via kunit_test_suites() below. */ #define kunit_test_suites_for_module(__suites) \ static int __init kunit_test_suites_init(void) \ { \ return __kunit_test_suites_init(__suites); \ } \ module_init(kunit_test_suites_init); \ \ static void __exit kunit_test_suites_exit(void) \ { \ return __kunit_test_suites_exit(__suites); \ } \ module_exit(kunit_test_suites_exit) #else #define kunit_test_suites_for_module(__suites) #endif /* MODULE */ #define __kunit_test_suites(unique_array, unique_suites, ...) \ static struct kunit_suite *unique_array[] = { __VA_ARGS__, NULL }; \ kunit_test_suites_for_module(unique_array); \ static struct kunit_suite **unique_suites \ __used __section(".kunit_test_suites") = unique_array /** * kunit_test_suites() - used to register one or more &struct kunit_suite * with KUnit. * * @__suites: a statically allocated list of &struct kunit_suite. * * Registers @suites with the test framework. See &struct kunit_suite for * more information. * * When builtin, KUnit tests are all run via executor; this is done * by placing the array of struct kunit_suite * in the .kunit_test_suites * ELF section. * * An alternative is to build the tests as a module. Because modules do not * support multiple initcall()s, we need to initialize an array of suites for a * module. * */ #define kunit_test_suites(__suites...) \ __kunit_test_suites(__UNIQUE_ID(array), \ __UNIQUE_ID(suites), \ ##__suites) #define kunit_test_suite(suite) kunit_test_suites(&suite) #define kunit_suite_for_each_test_case(suite, test_case) \ for (test_case = suite->test_cases; test_case->run_case; test_case++) bool kunit_suite_has_succeeded(struct kunit_suite *suite); /* * Like kunit_alloc_resource() below, but returns the struct kunit_resource * object that contains the allocation. This is mostly for testing purposes. */ struct kunit_resource *kunit_alloc_and_get_resource(struct kunit *test, kunit_resource_init_t init, kunit_resource_free_t free, gfp_t internal_gfp, void *context); /** * kunit_get_resource() - Hold resource for use. Should not need to be used * by most users as we automatically get resources * retrieved by kunit_find_resource*(). * @res: resource */ static inline void kunit_get_resource(struct kunit_resource *res) { kref_get(&res->refcount); } /* * Called when refcount reaches zero via kunit_put_resources(); * should not be called directly. */ static inline void kunit_release_resource(struct kref *kref) { struct kunit_resource *res = container_of(kref, struct kunit_resource, refcount); /* If free function is defined, resource was dynamically allocated. */ if (res->free) { res->free(res); kfree(res); } } /** * kunit_put_resource() - When caller is done with retrieved resource, * kunit_put_resource() should be called to drop * reference count. The resource list maintains * a reference count on resources, so if no users * are utilizing a resource and it is removed from * the resource list, it will be freed via the * associated free function (if any). Only * needs to be used if we alloc_and_get() or * find() resource. * @res: resource */ static inline void kunit_put_resource(struct kunit_resource *res) { kref_put(&res->refcount, kunit_release_resource); } /** * kunit_add_resource() - Add a *test managed resource*. * @test: The test context object. * @init: a user-supplied function to initialize the result (if needed). If * none is supplied, the resource data value is simply set to @data. * If an init function is supplied, @data is passed to it instead. * @free: a user-supplied function to free the resource (if needed). * @res: The resource. * @data: value to pass to init function or set in resource data field. */ int kunit_add_resource(struct kunit *test, kunit_resource_init_t init, kunit_resource_free_t free, struct kunit_resource *res, void *data); /** * kunit_add_named_resource() - Add a named *test managed resource*. * @test: The test context object. * @init: a user-supplied function to initialize the resource data, if needed. * @free: a user-supplied function to free the resource data, if needed. * @res: The resource. * @name: name to be set for resource. * @data: value to pass to init function or set in resource data field. */ int kunit_add_named_resource(struct kunit *test, kunit_resource_init_t init, kunit_resource_free_t free, struct kunit_resource *res, const char *name, void *data); /** * kunit_alloc_resource() - Allocates a *test managed resource*. * @test: The test context object. * @init: a user supplied function to initialize the resource. * @free: a user supplied function to free the resource. * @internal_gfp: gfp to use for internal allocations, if unsure, use GFP_KERNEL * @context: for the user to pass in arbitrary data to the init function. * * Allocates a *test managed resource*, a resource which will automatically be * cleaned up at the end of a test case. See &struct kunit_resource for an * example. * * Note: KUnit needs to allocate memory for a kunit_resource object. You must * specify an @internal_gfp that is compatible with the use context of your * resource. */ static inline void *kunit_alloc_resource(struct kunit *test, kunit_resource_init_t init, kunit_resource_free_t free, gfp_t internal_gfp, void *context) { struct kunit_resource *res; res = kzalloc(sizeof(*res), internal_gfp); if (!res) return NULL; if (!kunit_add_resource(test, init, free, res, context)) return res->data; return NULL; } typedef bool (*kunit_resource_match_t)(struct kunit *test, struct kunit_resource *res, void *match_data); /** * kunit_resource_instance_match() - Match a resource with the same instance. * @test: Test case to which the resource belongs. * @res: The resource. * @match_data: The resource pointer to match against. * * An instance of kunit_resource_match_t that matches a resource whose * allocation matches @match_data. */ static inline bool kunit_resource_instance_match(struct kunit *test, struct kunit_resource *res, void *match_data) { return res->data == match_data; } /** * kunit_resource_name_match() - Match a resource with the same name. * @test: Test case to which the resource belongs. * @res: The resource. * @match_name: The name to match against. */ static inline bool kunit_resource_name_match(struct kunit *test, struct kunit_resource *res, void *match_name) { return res->name && strcmp(res->name, match_name) == 0; } /** * kunit_find_resource() - Find a resource using match function/data. * @test: Test case to which the resource belongs. * @match: match function to be applied to resources/match data. * @match_data: data to be used in matching. */ static inline struct kunit_resource * kunit_find_resource(struct kunit *test, kunit_resource_match_t match, void *match_data) { struct kunit_resource *res, *found = NULL; spin_lock(&test->lock); list_for_each_entry_reverse(res, &test->resources, node) { if (match(test, res, (void *)match_data)) { found = res; kunit_get_resource(found); break; } } spin_unlock(&test->lock); return found; } /** * kunit_find_named_resource() - Find a resource using match name. * @test: Test case to which the resource belongs. * @name: match name. */ static inline struct kunit_resource * kunit_find_named_resource(struct kunit *test, const char *name) { return kunit_find_resource(test, kunit_resource_name_match, (void *)name); } /** * kunit_destroy_resource() - Find a kunit_resource and destroy it. * @test: Test case to which the resource belongs. * @match: Match function. Returns whether a given resource matches @match_data. * @match_data: Data passed into @match. * * RETURNS: * 0 if kunit_resource is found and freed, -ENOENT if not found. */ int kunit_destroy_resource(struct kunit *test, kunit_resource_match_t match, void *match_data); static inline int kunit_destroy_named_resource(struct kunit *test, const char *name) { return kunit_destroy_resource(test, kunit_resource_name_match, (void *)name); } /** * kunit_remove_resource() - remove resource from resource list associated with * test. * @test: The test context object. * @res: The resource to be removed. * * Note that the resource will not be immediately freed since it is likely * the caller has a reference to it via alloc_and_get() or find(); * in this case a final call to kunit_put_resource() is required. */ void kunit_remove_resource(struct kunit *test, struct kunit_resource *res); /** * kunit_kmalloc() - Like kmalloc() except the allocation is *test managed*. * @test: The test context object. * @size: The size in bytes of the desired memory. * @gfp: flags passed to underlying kmalloc(). * * Just like `kmalloc(...)`, except the allocation is managed by the test case * and is automatically cleaned up after the test case concludes. See &struct * kunit_resource for more information. */ void *kunit_kmalloc(struct kunit *test, size_t size, gfp_t gfp); /** * kunit_kfree() - Like kfree except for allocations managed by KUnit. * @test: The test case to which the resource belongs. * @ptr: The memory allocation to free. */ void kunit_kfree(struct kunit *test, const void *ptr); /** * kunit_kzalloc() - Just like kunit_kmalloc(), but zeroes the allocation. * @test: The test context object. * @size: The size in bytes of the desired memory. * @gfp: flags passed to underlying kmalloc(). * * See kzalloc() and kunit_kmalloc() for more information. */ static inline void *kunit_kzalloc(struct kunit *test, size_t size, gfp_t gfp) { return kunit_kmalloc(test, size, gfp | __GFP_ZERO); } void kunit_cleanup(struct kunit *test); void kunit_log_append(char *log, const char *fmt, ...); /* * printk and log to per-test or per-suite log buffer. Logging only done * if CONFIG_KUNIT_DEBUGFS is 'y'; if it is 'n', no log is allocated/used. */ #define kunit_log(lvl, test_or_suite, fmt, ...) \ do { \ printk(lvl fmt, ##__VA_ARGS__); \ kunit_log_append((test_or_suite)->log, fmt "\n", \ ##__VA_ARGS__); \ } while (0) #define kunit_printk(lvl, test, fmt, ...) \ kunit_log(lvl, test, KUNIT_SUBTEST_INDENT "# %s: " fmt, \ (test)->name, ##__VA_ARGS__) /** * kunit_info() - Prints an INFO level message associated with @test. * * @test: The test context object. * @fmt: A printk() style format string. * * Prints an info level message associated with the test suite being run. * Takes a variable number of format parameters just like printk(). */ #define kunit_info(test, fmt, ...) \ kunit_printk(KERN_INFO, test, fmt, ##__VA_ARGS__) /** * kunit_warn() - Prints a WARN level message associated with @test. * * @test: The test context object. * @fmt: A printk() style format string. * * Prints a warning level message. */ #define kunit_warn(test, fmt, ...) \ kunit_printk(KERN_WARNING, test, fmt, ##__VA_ARGS__) /** * kunit_err() - Prints an ERROR level message associated with @test. * * @test: The test context object. * @fmt: A printk() style format string. * * Prints an error level message. */ #define kunit_err(test, fmt, ...) \ kunit_printk(KERN_ERR, test, fmt, ##__VA_ARGS__) /** * KUNIT_SUCCEED() - A no-op expectation. Only exists for code clarity. * @test: The test context object. * * The opposite of KUNIT_FAIL(), it is an expectation that cannot fail. In other * words, it does nothing and only exists for code clarity. See * KUNIT_EXPECT_TRUE() for more information. */ #define KUNIT_SUCCEED(test) do {} while (0) void kunit_do_assertion(struct kunit *test, struct kunit_assert *assert, bool pass, const char *fmt, ...); #define KUNIT_ASSERTION(test, pass, assert_class, INITIALIZER, fmt, ...) do { \ struct assert_class __assertion = INITIALIZER; \ kunit_do_assertion(test, \ &__assertion.assert, \ pass, \ fmt, \ ##__VA_ARGS__); \ } while (0) #define KUNIT_FAIL_ASSERTION(test, assert_type, fmt, ...) \ KUNIT_ASSERTION(test, \ false, \ kunit_fail_assert, \ KUNIT_INIT_FAIL_ASSERT_STRUCT(test, assert_type), \ fmt, \ ##__VA_ARGS__) /** * KUNIT_FAIL() - Always causes a test to fail when evaluated. * @test: The test context object. * @fmt: an informational message to be printed when the assertion is made. * @...: string format arguments. * * The opposite of KUNIT_SUCCEED(), it is an expectation that always fails. In * other words, it always results in a failed expectation, and consequently * always causes the test case to fail when evaluated. See KUNIT_EXPECT_TRUE() * for more information. */ #define KUNIT_FAIL(test, fmt, ...) \ KUNIT_FAIL_ASSERTION(test, \ KUNIT_EXPECTATION, \ fmt, \ ##__VA_ARGS__) #define KUNIT_UNARY_ASSERTION(test, \ assert_type, \ condition, \ expected_true, \ fmt, \ ...) \ KUNIT_ASSERTION(test, \ !!(condition) == !!expected_true, \ kunit_unary_assert, \ KUNIT_INIT_UNARY_ASSERT_STRUCT(test, \ assert_type, \ #condition, \ expected_true), \ fmt, \ ##__VA_ARGS__) #define KUNIT_TRUE_MSG_ASSERTION(test, assert_type, condition, fmt, ...) \ KUNIT_UNARY_ASSERTION(test, \ assert_type, \ condition, \ true, \ fmt, \ ##__VA_ARGS__) #define KUNIT_TRUE_ASSERTION(test, assert_type, condition) \ KUNIT_TRUE_MSG_ASSERTION(test, assert_type, condition, NULL) #define KUNIT_FALSE_MSG_ASSERTION(test, assert_type, condition, fmt, ...) \ KUNIT_UNARY_ASSERTION(test, \ assert_type, \ condition, \ false, \ fmt, \ ##__VA_ARGS__) #define KUNIT_FALSE_ASSERTION(test, assert_type, condition) \ KUNIT_FALSE_MSG_ASSERTION(test, assert_type, condition, NULL) /* * A factory macro for defining the assertions and expectations for the basic * comparisons defined for the built in types. * * Unfortunately, there is no common type that all types can be promoted to for * which all the binary operators behave the same way as for the actual types * (for example, there is no type that long long and unsigned long long can * both be cast to where the comparison result is preserved for all values). So * the best we can do is do the comparison in the original types and then coerce * everything to long long for printing; this way, the comparison behaves * correctly and the printed out value usually makes sense without * interpretation, but can always be interpreted to figure out the actual * value. */ #define KUNIT_BASE_BINARY_ASSERTION(test, \ assert_class, \ ASSERT_CLASS_INIT, \ assert_type, \ left, \ op, \ right, \ fmt, \ ...) \ do { \ typeof(left) __left = (left); \ typeof(right) __right = (right); \ ((void)__typecheck(__left, __right)); \ \ KUNIT_ASSERTION(test, \ __left op __right, \ assert_class, \ ASSERT_CLASS_INIT(test, \ assert_type, \ #op, \ #left, \ __left, \ #right, \ __right), \ fmt, \ ##__VA_ARGS__); \ } while (0) #define KUNIT_BASE_EQ_MSG_ASSERTION(test, \ assert_class, \ ASSERT_CLASS_INIT, \ assert_type, \ left, \ right, \ fmt, \ ...) \ KUNIT_BASE_BINARY_ASSERTION(test, \ assert_class, \ ASSERT_CLASS_INIT, \ assert_type, \ left, ==, right, \ fmt, \ ##__VA_ARGS__) #define KUNIT_BASE_NE_MSG_ASSERTION(test, \ assert_class, \ ASSERT_CLASS_INIT, \ assert_type, \ left, \ right, \ fmt, \ ...) \ KUNIT_BASE_BINARY_ASSERTION(test, \ assert_class, \ ASSERT_CLASS_INIT, \ assert_type, \ left, !=, right, \ fmt, \ ##__VA_ARGS__) #define KUNIT_BASE_LT_MSG_ASSERTION(test, \ assert_class, \ ASSERT_CLASS_INIT, \ assert_type, \ left, \ right, \ fmt, \ ...) \ KUNIT_BASE_BINARY_ASSERTION(test, \ assert_class, \ ASSERT_CLASS_INIT, \ assert_type, \ left, <, right, \ fmt, \ ##__VA_ARGS__) #define KUNIT_BASE_LE_MSG_ASSERTION(test, \ assert_class, \ ASSERT_CLASS_INIT, \ assert_type, \ left, \ right, \ fmt, \ ...) \ KUNIT_BASE_BINARY_ASSERTION(test, \ assert_class, \ ASSERT_CLASS_INIT, \ assert_type, \ left, <=, right, \ fmt, \ ##__VA_ARGS__) #define KUNIT_BASE_GT_MSG_ASSERTION(test, \ assert_class, \ ASSERT_CLASS_INIT, \ assert_type, \ left, \ right, \ fmt, \ ...) \ KUNIT_BASE_BINARY_ASSERTION(test, \ assert_class, \ ASSERT_CLASS_INIT, \ assert_type, \ left, >, right, \ fmt, \ ##__VA_ARGS__) #define KUNIT_BASE_GE_MSG_ASSERTION(test, \ assert_class, \ ASSERT_CLASS_INIT, \ assert_type, \ left, \ right, \ fmt, \ ...) \ KUNIT_BASE_BINARY_ASSERTION(test, \ assert_class, \ ASSERT_CLASS_INIT, \ assert_type, \ left, >=, right, \ fmt, \ ##__VA_ARGS__) #define KUNIT_BINARY_EQ_MSG_ASSERTION(test, assert_type, left, right, fmt, ...)\ KUNIT_BASE_EQ_MSG_ASSERTION(test, \ kunit_binary_assert, \ KUNIT_INIT_BINARY_ASSERT_STRUCT, \ assert_type, \ left, \ right, \ fmt, \ ##__VA_ARGS__) #define KUNIT_BINARY_EQ_ASSERTION(test, assert_type, left, right) \ KUNIT_BINARY_EQ_MSG_ASSERTION(test, \ assert_type, \ left, \ right, \ NULL) #define KUNIT_BINARY_PTR_EQ_MSG_ASSERTION(test, \ assert_type, \ left, \ right, \ fmt, \ ...) \ KUNIT_BASE_EQ_MSG_ASSERTION(test, \ kunit_binary_ptr_assert, \ KUNIT_INIT_BINARY_PTR_ASSERT_STRUCT, \ assert_type, \ left, \ right, \ fmt, \ ##__VA_ARGS__) #define KUNIT_BINARY_PTR_EQ_ASSERTION(test, assert_type, left, right) \ KUNIT_BINARY_PTR_EQ_MSG_ASSERTION(test, \ assert_type, \ left, \ right, \ NULL) #define KUNIT_BINARY_NE_MSG_ASSERTION(test, assert_type, left, right, fmt, ...)\ KUNIT_BASE_NE_MSG_ASSERTION(test, \ kunit_binary_assert, \ KUNIT_INIT_BINARY_ASSERT_STRUCT, \ assert_type, \ left, \ right, \ fmt, \ ##__VA_ARGS__) #define KUNIT_BINARY_NE_ASSERTION(test, assert_type, left, right) \ KUNIT_BINARY_NE_MSG_ASSERTION(test, \ assert_type, \ left, \ right, \ NULL) #define KUNIT_BINARY_PTR_NE_MSG_ASSERTION(test, \ assert_type, \ left, \ right, \ fmt, \ ...) \ KUNIT_BASE_NE_MSG_ASSERTION(test, \ kunit_binary_ptr_assert, \ KUNIT_INIT_BINARY_PTR_ASSERT_STRUCT, \ assert_type, \ left, \ right, \ fmt, \ ##__VA_ARGS__) #define KUNIT_BINARY_PTR_NE_ASSERTION(test, assert_type, left, right) \ KUNIT_BINARY_PTR_NE_MSG_ASSERTION(test, \ assert_type, \ left, \ right, \ NULL) #define KUNIT_BINARY_LT_MSG_ASSERTION(test, assert_type, left, right, fmt, ...)\ KUNIT_BASE_LT_MSG_ASSERTION(test, \ kunit_binary_assert, \ KUNIT_INIT_BINARY_ASSERT_STRUCT, \ assert_type, \ left, \ right, \ fmt, \ ##__VA_ARGS__) #define KUNIT_BINARY_LT_ASSERTION(test, assert_type, left, right) \ KUNIT_BINARY_LT_MSG_ASSERTION(test, \ assert_type, \ left, \ right, \ NULL) #define KUNIT_BINARY_PTR_LT_MSG_ASSERTION(test, \ assert_type, \ left, \ right, \ fmt, \ ...) \ KUNIT_BASE_LT_MSG_ASSERTION(test, \ kunit_binary_ptr_assert, \ KUNIT_INIT_BINARY_PTR_ASSERT_STRUCT, \ assert_type, \ left, \ right, \ fmt, \ ##__VA_ARGS__) #define KUNIT_BINARY_PTR_LT_ASSERTION(test, assert_type, left, right) \ KUNIT_BINARY_PTR_LT_MSG_ASSERTION(test, \ assert_type, \ left, \ right, \ NULL) #define KUNIT_BINARY_LE_MSG_ASSERTION(test, assert_type, left, right, fmt, ...)\ KUNIT_BASE_LE_MSG_ASSERTION(test, \ kunit_binary_assert, \ KUNIT_INIT_BINARY_ASSERT_STRUCT, \ assert_type, \ left, \ right, \ fmt, \ ##__VA_ARGS__) #define KUNIT_BINARY_LE_ASSERTION(test, assert_type, left, right) \ KUNIT_BINARY_LE_MSG_ASSERTION(test, \ assert_type, \ left, \ right, \ NULL) #define KUNIT_BINARY_PTR_LE_MSG_ASSERTION(test, \ assert_type, \ left, \ right, \ fmt, \ ...) \ KUNIT_BASE_LE_MSG_ASSERTION(test, \ kunit_binary_ptr_assert, \ KUNIT_INIT_BINARY_PTR_ASSERT_STRUCT, \ assert_type, \ left, \ right, \ fmt, \ ##__VA_ARGS__) #define KUNIT_BINARY_PTR_LE_ASSERTION(test, assert_type, left, right) \ KUNIT_BINARY_PTR_LE_MSG_ASSERTION(test, \ assert_type, \ left, \ right, \ NULL) #define KUNIT_BINARY_GT_MSG_ASSERTION(test, assert_type, left, right, fmt, ...)\ KUNIT_BASE_GT_MSG_ASSERTION(test, \ kunit_binary_assert, \ KUNIT_INIT_BINARY_ASSERT_STRUCT, \ assert_type, \ left, \ right, \ fmt, \ ##__VA_ARGS__) #define KUNIT_BINARY_GT_ASSERTION(test, assert_type, left, right) \ KUNIT_BINARY_GT_MSG_ASSERTION(test, \ assert_type, \ left, \ right, \ NULL) #define KUNIT_BINARY_PTR_GT_MSG_ASSERTION(test, \ assert_type, \ left, \ right, \ fmt, \ ...) \ KUNIT_BASE_GT_MSG_ASSERTION(test, \ kunit_binary_ptr_assert, \ KUNIT_INIT_BINARY_PTR_ASSERT_STRUCT, \ assert_type, \ left, \ right, \ fmt, \ ##__VA_ARGS__) #define KUNIT_BINARY_PTR_GT_ASSERTION(test, assert_type, left, right) \ KUNIT_BINARY_PTR_GT_MSG_ASSERTION(test, \ assert_type, \ left, \ right, \ NULL) #define KUNIT_BINARY_GE_MSG_ASSERTION(test, assert_type, left, right, fmt, ...)\ KUNIT_BASE_GE_MSG_ASSERTION(test, \ kunit_binary_assert, \ KUNIT_INIT_BINARY_ASSERT_STRUCT, \ assert_type, \ left, \ right, \ fmt, \ ##__VA_ARGS__) #define KUNIT_BINARY_GE_ASSERTION(test, assert_type, left, right) \ KUNIT_BINARY_GE_MSG_ASSERTION(test, \ assert_type, \ left, \ right, \ NULL) #define KUNIT_BINARY_PTR_GE_MSG_ASSERTION(test, \ assert_type, \ left, \ right, \ fmt, \ ...) \ KUNIT_BASE_GE_MSG_ASSERTION(test, \ kunit_binary_ptr_assert, \ KUNIT_INIT_BINARY_PTR_ASSERT_STRUCT, \ assert_type, \ left, \ right, \ fmt, \ ##__VA_ARGS__) #define KUNIT_BINARY_PTR_GE_ASSERTION(test, assert_type, left, right) \ KUNIT_BINARY_PTR_GE_MSG_ASSERTION(test, \ assert_type, \ left, \ right, \ NULL) #define KUNIT_BINARY_STR_ASSERTION(test, \ assert_type, \ left, \ op, \ right, \ fmt, \ ...) \ do { \ typeof(left) __left = (left); \ typeof(right) __right = (right); \ \ KUNIT_ASSERTION(test, \ strcmp(__left, __right) op 0, \ kunit_binary_str_assert, \ KUNIT_INIT_BINARY_STR_ASSERT_STRUCT(test, \ assert_type, \ #op, \ #left, \ __left, \ #right, \ __right), \ fmt, \ ##__VA_ARGS__); \ } while (0) #define KUNIT_BINARY_STR_EQ_MSG_ASSERTION(test, \ assert_type, \ left, \ right, \ fmt, \ ...) \ KUNIT_BINARY_STR_ASSERTION(test, \ assert_type, \ left, ==, right, \ fmt, \ ##__VA_ARGS__) #define KUNIT_BINARY_STR_EQ_ASSERTION(test, assert_type, left, right) \ KUNIT_BINARY_STR_EQ_MSG_ASSERTION(test, \ assert_type, \ left, \ right, \ NULL) #define KUNIT_BINARY_STR_NE_MSG_ASSERTION(test, \ assert_type, \ left, \ right, \ fmt, \ ...) \ KUNIT_BINARY_STR_ASSERTION(test, \ assert_type, \ left, !=, right, \ fmt, \ ##__VA_ARGS__) #define KUNIT_BINARY_STR_NE_ASSERTION(test, assert_type, left, right) \ KUNIT_BINARY_STR_NE_MSG_ASSERTION(test, \ assert_type, \ left, \ right, \ NULL) #define KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION(test, \ assert_type, \ ptr, \ fmt, \ ...) \ do { \ typeof(ptr) __ptr = (ptr); \ \ KUNIT_ASSERTION(test, \ !IS_ERR_OR_NULL(__ptr), \ kunit_ptr_not_err_assert, \ KUNIT_INIT_PTR_NOT_ERR_STRUCT(test, \ assert_type, \ #ptr, \ __ptr), \ fmt, \ ##__VA_ARGS__); \ } while (0) #define KUNIT_PTR_NOT_ERR_OR_NULL_ASSERTION(test, assert_type, ptr) \ KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION(test, \ assert_type, \ ptr, \ NULL) /** * KUNIT_EXPECT_TRUE() - Causes a test failure when the expression is not true. * @test: The test context object. * @condition: an arbitrary boolean expression. The test fails when this does * not evaluate to true. * * This and expectations of the form `KUNIT_EXPECT_*` will cause the test case * to fail when the specified condition is not met; however, it will not prevent * the test case from continuing to run; this is otherwise known as an * *expectation failure*. */ #define KUNIT_EXPECT_TRUE(test, condition) \ KUNIT_TRUE_ASSERTION(test, KUNIT_EXPECTATION, condition) #define KUNIT_EXPECT_TRUE_MSG(test, condition, fmt, ...) \ KUNIT_TRUE_MSG_ASSERTION(test, \ KUNIT_EXPECTATION, \ condition, \ fmt, \ ##__VA_ARGS__) /** * KUNIT_EXPECT_FALSE() - Makes a test failure when the expression is not false. * @test: The test context object. * @condition: an arbitrary boolean expression. The test fails when this does * not evaluate to false. * * Sets an expectation that @condition evaluates to false. See * KUNIT_EXPECT_TRUE() for more information. */ #define KUNIT_EXPECT_FALSE(test, condition) \ KUNIT_FALSE_ASSERTION(test, KUNIT_EXPECTATION, condition) #define KUNIT_EXPECT_FALSE_MSG(test, condition, fmt, ...) \ KUNIT_FALSE_MSG_ASSERTION(test, \ KUNIT_EXPECTATION, \ condition, \ fmt, \ ##__VA_ARGS__) /** * KUNIT_EXPECT_EQ() - Sets an expectation that @left and @right are equal. * @test: The test context object. * @left: an arbitrary expression that evaluates to a primitive C type. * @right: an arbitrary expression that evaluates to a primitive C type. * * Sets an expectation that the values that @left and @right evaluate to are * equal. This is semantically equivalent to * KUNIT_EXPECT_TRUE(@test, (@left) == (@right)). See KUNIT_EXPECT_TRUE() for * more information. */ #define KUNIT_EXPECT_EQ(test, left, right) \ KUNIT_BINARY_EQ_ASSERTION(test, KUNIT_EXPECTATION, left, right) #define KUNIT_EXPECT_EQ_MSG(test, left, right, fmt, ...) \ KUNIT_BINARY_EQ_MSG_ASSERTION(test, \ KUNIT_EXPECTATION, \ left, \ right, \ fmt, \ ##__VA_ARGS__) /** * KUNIT_EXPECT_PTR_EQ() - Expects that pointers @left and @right are equal. * @test: The test context object. * @left: an arbitrary expression that evaluates to a pointer. * @right: an arbitrary expression that evaluates to a pointer. * * Sets an expectation that the values that @left and @right evaluate to are * equal. This is semantically equivalent to * KUNIT_EXPECT_TRUE(@test, (@left) == (@right)). See KUNIT_EXPECT_TRUE() for * more information. */ #define KUNIT_EXPECT_PTR_EQ(test, left, right) \ KUNIT_BINARY_PTR_EQ_ASSERTION(test, \ KUNIT_EXPECTATION, \ left, \ right) #define KUNIT_EXPECT_PTR_EQ_MSG(test, left, right, fmt, ...) \ KUNIT_BINARY_PTR_EQ_MSG_ASSERTION(test, \ KUNIT_EXPECTATION, \ left, \ right, \ fmt, \ ##__VA_ARGS__) /** * KUNIT_EXPECT_NE() - An expectation that @left and @right are not equal. * @test: The test context object. * @left: an arbitrary expression that evaluates to a primitive C type. * @right: an arbitrary expression that evaluates to a primitive C type. * * Sets an expectation that the values that @left and @right evaluate to are not * equal. This is semantically equivalent to * KUNIT_EXPECT_TRUE(@test, (@left) != (@right)). See KUNIT_EXPECT_TRUE() for * more information. */ #define KUNIT_EXPECT_NE(test, left, right) \ KUNIT_BINARY_NE_ASSERTION(test, KUNIT_EXPECTATION, left, right) #define KUNIT_EXPECT_NE_MSG(test, left, right, fmt, ...) \ KUNIT_BINARY_NE_MSG_ASSERTION(test, \ KUNIT_EXPECTATION, \ left, \ right, \ fmt, \ ##__VA_ARGS__) /** * KUNIT_EXPECT_PTR_NE() - Expects that pointers @left and @right are not equal. * @test: The test context object. * @left: an arbitrary expression that evaluates to a pointer. * @right: an arbitrary expression that evaluates to a pointer. * * Sets an expectation that the values that @left and @right evaluate to are not * equal. This is semantically equivalent to * KUNIT_EXPECT_TRUE(@test, (@left) != (@right)). See KUNIT_EXPECT_TRUE() for * more information. */ #define KUNIT_EXPECT_PTR_NE(test, left, right) \ KUNIT_BINARY_PTR_NE_ASSERTION(test, \ KUNIT_EXPECTATION, \ left, \ right) #define KUNIT_EXPECT_PTR_NE_MSG(test, left, right, fmt, ...) \ KUNIT_BINARY_PTR_NE_MSG_ASSERTION(test, \ KUNIT_EXPECTATION, \ left, \ right, \ fmt, \ ##__VA_ARGS__) /** * KUNIT_EXPECT_LT() - An expectation that @left is less than @right. * @test: The test context object. * @left: an arbitrary expression that evaluates to a primitive C type. * @right: an arbitrary expression that evaluates to a primitive C type. * * Sets an expectation that the value that @left evaluates to is less than the * value that @right evaluates to. This is semantically equivalent to * KUNIT_EXPECT_TRUE(@test, (@left) < (@right)). See KUNIT_EXPECT_TRUE() for * more information. */ #define KUNIT_EXPECT_LT(test, left, right) \ KUNIT_BINARY_LT_ASSERTION(test, KUNIT_EXPECTATION, left, right) #define KUNIT_EXPECT_LT_MSG(test, left, right, fmt, ...) \ KUNIT_BINARY_LT_MSG_ASSERTION(test, \ KUNIT_EXPECTATION, \ left, \ right, \ fmt, \ ##__VA_ARGS__) /** * KUNIT_EXPECT_LE() - Expects that @left is less than or equal to @right. * @test: The test context object. * @left: an arbitrary expression that evaluates to a primitive C type. * @right: an arbitrary expression that evaluates to a primitive C type. * * Sets an expectation that the value that @left evaluates to is less than or * equal to the value that @right evaluates to. Semantically this is equivalent * to KUNIT_EXPECT_TRUE(@test, (@left) <= (@right)). See KUNIT_EXPECT_TRUE() for * more information. */ #define KUNIT_EXPECT_LE(test, left, right) \ KUNIT_BINARY_LE_ASSERTION(test, KUNIT_EXPECTATION, left, right) #define KUNIT_EXPECT_LE_MSG(test, left, right, fmt, ...) \ KUNIT_BINARY_LE_MSG_ASSERTION(test, \ KUNIT_EXPECTATION, \ left, \ right, \ fmt, \ ##__VA_ARGS__) /** * KUNIT_EXPECT_GT() - An expectation that @left is greater than @right. * @test: The test context object. * @left: an arbitrary expression that evaluates to a primitive C type. * @right: an arbitrary expression that evaluates to a primitive C type. * * Sets an expectation that the value that @left evaluates to is greater than * the value that @right evaluates to. This is semantically equivalent to * KUNIT_EXPECT_TRUE(@test, (@left) > (@right)). See KUNIT_EXPECT_TRUE() for * more information. */ #define KUNIT_EXPECT_GT(test, left, right) \ KUNIT_BINARY_GT_ASSERTION(test, KUNIT_EXPECTATION, left, right) #define KUNIT_EXPECT_GT_MSG(test, left, right, fmt, ...) \ KUNIT_BINARY_GT_MSG_ASSERTION(test, \ KUNIT_EXPECTATION, \ left, \ right, \ fmt, \ ##__VA_ARGS__) /** * KUNIT_EXPECT_GE() - Expects that @left is greater than or equal to @right. * @test: The test context object. * @left: an arbitrary expression that evaluates to a primitive C type. * @right: an arbitrary expression that evaluates to a primitive C type. * * Sets an expectation that the value that @left evaluates to is greater than * the value that @right evaluates to. This is semantically equivalent to * KUNIT_EXPECT_TRUE(@test, (@left) >= (@right)). See KUNIT_EXPECT_TRUE() for * more information. */ #define KUNIT_EXPECT_GE(test, left, right) \ KUNIT_BINARY_GE_ASSERTION(test, KUNIT_EXPECTATION, left, right) #define KUNIT_EXPECT_GE_MSG(test, left, right, fmt, ...) \ KUNIT_BINARY_GE_MSG_ASSERTION(test, \ KUNIT_EXPECTATION, \ left, \ right, \ fmt, \ ##__VA_ARGS__) /** * KUNIT_EXPECT_STREQ() - Expects that strings @left and @right are equal. * @test: The test context object. * @left: an arbitrary expression that evaluates to a null terminated string. * @right: an arbitrary expression that evaluates to a null terminated string. * * Sets an expectation that the values that @left and @right evaluate to are * equal. This is semantically equivalent to * KUNIT_EXPECT_TRUE(@test, !strcmp((@left), (@right))). See KUNIT_EXPECT_TRUE() * for more information. */ #define KUNIT_EXPECT_STREQ(test, left, right) \ KUNIT_BINARY_STR_EQ_ASSERTION(test, KUNIT_EXPECTATION, left, right) #define KUNIT_EXPECT_STREQ_MSG(test, left, right, fmt, ...) \ KUNIT_BINARY_STR_EQ_MSG_ASSERTION(test, \ KUNIT_EXPECTATION, \ left, \ right, \ fmt, \ ##__VA_ARGS__) /** * KUNIT_EXPECT_STRNEQ() - Expects that strings @left and @right are not equal. * @test: The test context object. * @left: an arbitrary expression that evaluates to a null terminated string. * @right: an arbitrary expression that evaluates to a null terminated string. * * Sets an expectation that the values that @left and @right evaluate to are * not equal. This is semantically equivalent to * KUNIT_EXPECT_TRUE(@test, strcmp((@left), (@right))). See KUNIT_EXPECT_TRUE() * for more information. */ #define KUNIT_EXPECT_STRNEQ(test, left, right) \ KUNIT_BINARY_STR_NE_ASSERTION(test, KUNIT_EXPECTATION, left, right) #define KUNIT_EXPECT_STRNEQ_MSG(test, left, right, fmt, ...) \ KUNIT_BINARY_STR_NE_MSG_ASSERTION(test, \ KUNIT_EXPECTATION, \ left, \ right, \ fmt, \ ##__VA_ARGS__) /** * KUNIT_EXPECT_NOT_ERR_OR_NULL() - Expects that @ptr is not null and not err. * @test: The test context object. * @ptr: an arbitrary pointer. * * Sets an expectation that the value that @ptr evaluates to is not null and not * an errno stored in a pointer. This is semantically equivalent to * KUNIT_EXPECT_TRUE(@test, !IS_ERR_OR_NULL(@ptr)). See KUNIT_EXPECT_TRUE() for * more information. */ #define KUNIT_EXPECT_NOT_ERR_OR_NULL(test, ptr) \ KUNIT_PTR_NOT_ERR_OR_NULL_ASSERTION(test, KUNIT_EXPECTATION, ptr) #define KUNIT_EXPECT_NOT_ERR_OR_NULL_MSG(test, ptr, fmt, ...) \ KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION(test, \ KUNIT_EXPECTATION, \ ptr, \ fmt, \ ##__VA_ARGS__) #define KUNIT_ASSERT_FAILURE(test, fmt, ...) \ KUNIT_FAIL_ASSERTION(test, KUNIT_ASSERTION, fmt, ##__VA_ARGS__) /** * KUNIT_ASSERT_TRUE() - Sets an assertion that @condition is true. * @test: The test context object. * @condition: an arbitrary boolean expression. The test fails and aborts when * this does not evaluate to true. * * This and assertions of the form `KUNIT_ASSERT_*` will cause the test case to * fail *and immediately abort* when the specified condition is not met. Unlike * an expectation failure, it will prevent the test case from continuing to run; * this is otherwise known as an *assertion failure*. */ #define KUNIT_ASSERT_TRUE(test, condition) \ KUNIT_TRUE_ASSERTION(test, KUNIT_ASSERTION, condition) #define KUNIT_ASSERT_TRUE_MSG(test, condition, fmt, ...) \ KUNIT_TRUE_MSG_ASSERTION(test, \ KUNIT_ASSERTION, \ condition, \ fmt, \ ##__VA_ARGS__) /** * KUNIT_ASSERT_FALSE() - Sets an assertion that @condition is false. * @test: The test context object. * @condition: an arbitrary boolean expression. * * Sets an assertion that the value that @condition evaluates to is false. This * is the same as KUNIT_EXPECT_FALSE(), except it causes an assertion failure * (see KUNIT_ASSERT_TRUE()) when the assertion is not met. */ #define KUNIT_ASSERT_FALSE(test, condition) \ KUNIT_FALSE_ASSERTION(test, KUNIT_ASSERTION, condition) #define KUNIT_ASSERT_FALSE_MSG(test, condition, fmt, ...) \ KUNIT_FALSE_MSG_ASSERTION(test, \ KUNIT_ASSERTION, \ condition, \ fmt, \ ##__VA_ARGS__) /** * KUNIT_ASSERT_EQ() - Sets an assertion that @left and @right are equal. * @test: The test context object. * @left: an arbitrary expression that evaluates to a primitive C type. * @right: an arbitrary expression that evaluates to a primitive C type. * * Sets an assertion that the values that @left and @right evaluate to are * equal. This is the same as KUNIT_EXPECT_EQ(), except it causes an assertion * failure (see KUNIT_ASSERT_TRUE()) when the assertion is not met. */ #define KUNIT_ASSERT_EQ(test, left, right) \ KUNIT_BINARY_EQ_ASSERTION(test, KUNIT_ASSERTION, left, right) #define KUNIT_ASSERT_EQ_MSG(test, left, right, fmt, ...) \ KUNIT_BINARY_EQ_MSG_ASSERTION(test, \ KUNIT_ASSERTION, \ left, \ right, \ fmt, \ ##__VA_ARGS__) /** * KUNIT_ASSERT_PTR_EQ() - Asserts that pointers @left and @right are equal. * @test: The test context object. * @left: an arbitrary expression that evaluates to a pointer. * @right: an arbitrary expression that evaluates to a pointer. * * Sets an assertion that the values that @left and @right evaluate to are * equal. This is the same as KUNIT_EXPECT_EQ(), except it causes an assertion * failure (see KUNIT_ASSERT_TRUE()) when the assertion is not met. */ #define KUNIT_ASSERT_PTR_EQ(test, left, right) \ KUNIT_BINARY_PTR_EQ_ASSERTION(test, KUNIT_ASSERTION, left, right) #define KUNIT_ASSERT_PTR_EQ_MSG(test, left, right, fmt, ...) \ KUNIT_BINARY_PTR_EQ_MSG_ASSERTION(test, \ KUNIT_ASSERTION, \ left, \ right, \ fmt, \ ##__VA_ARGS__) /** * KUNIT_ASSERT_NE() - An assertion that @left and @right are not equal. * @test: The test context object. * @left: an arbitrary expression that evaluates to a primitive C type. * @right: an arbitrary expression that evaluates to a primitive C type. * * Sets an assertion that the values that @left and @right evaluate to are not * equal. This is the same as KUNIT_EXPECT_NE(), except it causes an assertion * failure (see KUNIT_ASSERT_TRUE()) when the assertion is not met. */ #define KUNIT_ASSERT_NE(test, left, right) \ KUNIT_BINARY_NE_ASSERTION(test, KUNIT_ASSERTION, left, right) #define KUNIT_ASSERT_NE_MSG(test, left, right, fmt, ...) \ KUNIT_BINARY_NE_MSG_ASSERTION(test, \ KUNIT_ASSERTION, \ left, \ right, \ fmt, \ ##__VA_ARGS__) /** * KUNIT_ASSERT_PTR_NE() - Asserts that pointers @left and @right are not equal. * KUNIT_ASSERT_PTR_EQ() - Asserts that pointers @left and @right are equal. * @test: The test context object. * @left: an arbitrary expression that evaluates to a pointer. * @right: an arbitrary expression that evaluates to a pointer. * * Sets an assertion that the values that @left and @right evaluate to are not * equal. This is the same as KUNIT_EXPECT_NE(), except it causes an assertion * failure (see KUNIT_ASSERT_TRUE()) when the assertion is not met. */ #define KUNIT_ASSERT_PTR_NE(test, left, right) \ KUNIT_BINARY_PTR_NE_ASSERTION(test, KUNIT_ASSERTION, left, right) #define KUNIT_ASSERT_PTR_NE_MSG(test, left, right, fmt, ...) \ KUNIT_BINARY_PTR_NE_MSG_ASSERTION(test, \ KUNIT_ASSERTION, \ left, \ right, \ fmt, \ ##__VA_ARGS__) /** * KUNIT_ASSERT_LT() - An assertion that @left is less than @right. * @test: The test context object. * @left: an arbitrary expression that evaluates to a primitive C type. * @right: an arbitrary expression that evaluates to a primitive C type. * * Sets an assertion that the value that @left evaluates to is less than the * value that @right evaluates to. This is the same as KUNIT_EXPECT_LT(), except * it causes an assertion failure (see KUNIT_ASSERT_TRUE()) when the assertion * is not met. */ #define KUNIT_ASSERT_LT(test, left, right) \ KUNIT_BINARY_LT_ASSERTION(test, KUNIT_ASSERTION, left, right) #define KUNIT_ASSERT_LT_MSG(test, left, right, fmt, ...) \ KUNIT_BINARY_LT_MSG_ASSERTION(test, \ KUNIT_ASSERTION, \ left, \ right, \ fmt, \ ##__VA_ARGS__) /** * KUNIT_ASSERT_LE() - An assertion that @left is less than or equal to @right. * @test: The test context object. * @left: an arbitrary expression that evaluates to a primitive C type. * @right: an arbitrary expression that evaluates to a primitive C type. * * Sets an assertion that the value that @left evaluates to is less than or * equal to the value that @right evaluates to. This is the same as * KUNIT_EXPECT_LE(), except it causes an assertion failure (see * KUNIT_ASSERT_TRUE()) when the assertion is not met. */ #define KUNIT_ASSERT_LE(test, left, right) \ KUNIT_BINARY_LE_ASSERTION(test, KUNIT_ASSERTION, left, right) #define KUNIT_ASSERT_LE_MSG(test, left, right, fmt, ...) \ KUNIT_BINARY_LE_MSG_ASSERTION(test, \ KUNIT_ASSERTION, \ left, \ right, \ fmt, \ ##__VA_ARGS__) /** * KUNIT_ASSERT_GT() - An assertion that @left is greater than @right. * @test: The test context object. * @left: an arbitrary expression that evaluates to a primitive C type. * @right: an arbitrary expression that evaluates to a primitive C type. * * Sets an assertion that the value that @left evaluates to is greater than the * value that @right evaluates to. This is the same as KUNIT_EXPECT_GT(), except * it causes an assertion failure (see KUNIT_ASSERT_TRUE()) when the assertion * is not met. */ #define KUNIT_ASSERT_GT(test, left, right) \ KUNIT_BINARY_GT_ASSERTION(test, KUNIT_ASSERTION, left, right) #define KUNIT_ASSERT_GT_MSG(test, left, right, fmt, ...) \ KUNIT_BINARY_GT_MSG_ASSERTION(test, \ KUNIT_ASSERTION, \ left, \ right, \ fmt, \ ##__VA_ARGS__) /** * KUNIT_ASSERT_GE() - Assertion that @left is greater than or equal to @right. * @test: The test context object. * @left: an arbitrary expression that evaluates to a primitive C type. * @right: an arbitrary expression that evaluates to a primitive C type. * * Sets an assertion that the value that @left evaluates to is greater than the * value that @right evaluates to. This is the same as KUNIT_EXPECT_GE(), except * it causes an assertion failure (see KUNIT_ASSERT_TRUE()) when the assertion * is not met. */ #define KUNIT_ASSERT_GE(test, left, right) \ KUNIT_BINARY_GE_ASSERTION(test, KUNIT_ASSERTION, left, right) #define KUNIT_ASSERT_GE_MSG(test, left, right, fmt, ...) \ KUNIT_BINARY_GE_MSG_ASSERTION(test, \ KUNIT_ASSERTION, \ left, \ right, \ fmt, \ ##__VA_ARGS__) /** * KUNIT_ASSERT_STREQ() - An assertion that strings @left and @right are equal. * @test: The test context object. * @left: an arbitrary expression that evaluates to a null terminated string. * @right: an arbitrary expression that evaluates to a null terminated string. * * Sets an assertion that the values that @left and @right evaluate to are * equal. This is the same as KUNIT_EXPECT_STREQ(), except it causes an * assertion failure (see KUNIT_ASSERT_TRUE()) when the assertion is not met. */ #define KUNIT_ASSERT_STREQ(test, left, right) \ KUNIT_BINARY_STR_EQ_ASSERTION(test, KUNIT_ASSERTION, left, right) #define KUNIT_ASSERT_STREQ_MSG(test, left, right, fmt, ...) \ KUNIT_BINARY_STR_EQ_MSG_ASSERTION(test, \ KUNIT_ASSERTION, \ left, \ right, \ fmt, \ ##__VA_ARGS__) /** * KUNIT_ASSERT_STRNEQ() - Expects that strings @left and @right are not equal. * @test: The test context object. * @left: an arbitrary expression that evaluates to a null terminated string. * @right: an arbitrary expression that evaluates to a null terminated string. * * Sets an expectation that the values that @left and @right evaluate to are * not equal. This is semantically equivalent to * KUNIT_ASSERT_TRUE(@test, strcmp((@left), (@right))). See KUNIT_ASSERT_TRUE() * for more information. */ #define KUNIT_ASSERT_STRNEQ(test, left, right) \ KUNIT_BINARY_STR_NE_ASSERTION(test, KUNIT_ASSERTION, left, right) #define KUNIT_ASSERT_STRNEQ_MSG(test, left, right, fmt, ...) \ KUNIT_BINARY_STR_NE_MSG_ASSERTION(test, \ KUNIT_ASSERTION, \ left, \ right, \ fmt, \ ##__VA_ARGS__) /** * KUNIT_ASSERT_NOT_ERR_OR_NULL() - Assertion that @ptr is not null and not err. * @test: The test context object. * @ptr: an arbitrary pointer. * * Sets an assertion that the value that @ptr evaluates to is not null and not * an errno stored in a pointer. This is the same as * KUNIT_EXPECT_NOT_ERR_OR_NULL(), except it causes an assertion failure (see * KUNIT_ASSERT_TRUE()) when the assertion is not met. */ #define KUNIT_ASSERT_NOT_ERR_OR_NULL(test, ptr) \ KUNIT_PTR_NOT_ERR_OR_NULL_ASSERTION(test, KUNIT_ASSERTION, ptr) #define KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG(test, ptr, fmt, ...) \ KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION(test, \ KUNIT_ASSERTION, \ ptr, \ fmt, \ ##__VA_ARGS__) #endif /* _KUNIT_TEST_H */ |