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 | /* * Copyright (c) 2016, 2020 Intel Corporation * * SPDX-License-Identifier: Apache-2.0 */ /** * @brief Workqueue Tests * @defgroup kernel_workqueue_tests Workqueue * @ingroup all_tests * @{ * @} */ #include <ztest.h> #include <irq_offload.h> #define TIMEOUT_MS 100 #define TIMEOUT K_MSEC(TIMEOUT_MS) #define STACK_SIZE (512 + CONFIG_TEST_EXTRA_STACKSIZE) #define NUM_OF_WORK 2 #define SYNC_SEM_INIT_VAL (0U) #define COM_SEM_MAX_VAL (1U) #define COM_SEM_INIT_VAL (0U) #define MAX_WORK_Q_NUMBER 10 #define MY_PRIORITY 5 struct k_delayed_work work_item_delayed; struct k_sem common_sema, sema_fifo_one, sema_fifo_two; struct k_work work_item, work_item_1, work_item_2; struct k_work_q work_q_max_number[MAX_WORK_Q_NUMBER]; K_THREAD_STACK_DEFINE(my_stack_area, STACK_SIZE); K_THREAD_STACK_DEFINE(new_stack_area[MAX_WORK_Q_NUMBER], STACK_SIZE); static K_THREAD_STACK_DEFINE(tstack, STACK_SIZE); static K_THREAD_STACK_DEFINE(user_tstack, STACK_SIZE); static struct k_work_q workq; struct k_work_q work_q_1; static struct k_work_q user_workq; static ZTEST_BMEM struct k_work work[NUM_OF_WORK]; static struct k_delayed_work new_work; static struct k_delayed_work delayed_work[NUM_OF_WORK], delayed_work_sleepy; static struct k_work_poll triggered_work[NUM_OF_WORK]; static struct k_poll_event triggered_work_event[NUM_OF_WORK]; static struct k_poll_signal triggered_work_signal[NUM_OF_WORK]; static struct k_work_poll triggered_work_sleepy; static struct k_poll_event triggered_work_sleepy_event; static struct k_poll_signal triggered_work_sleepy_signal; static struct k_sem sync_sema; static struct k_sem dummy_sema; static struct k_thread *main_thread; /** * @brief Common function using like a handler for workqueue tests * API call in it means successful execution of that function * * @param unused of type k_work to make handler function accepted * by k_work_init * * @return N/A */ void common_work_handler(struct k_work *unused) { k_sem_give(&sync_sema); } /** * @brief Test work item can take call back function defined by user * @details * - Creating a work item, then add handler function to that work item. * - Then process that work item. * - To check that handler function executed successfully, we use semaphore * sync_sema with initial count 0. * - Handler function gives semaphore, then we wait for that semaphore * from the test function body. * - If semaphore was obtained successfully, test passed. * @ingroup kernel_workqueue_tests */ void test_work_item_supplied_with_func(void) { uint32_t sem_count = 0; k_sem_reset(&sync_sema); /**TESTPOINT: init work item with a user-defined function*/ k_work_init(&work_item, common_work_handler); k_work_submit_to_queue(&workq, &work_item); k_sem_take(&sync_sema, K_FOREVER); sem_count = k_sem_count_get(&sync_sema); zassert_equal(sem_count, COM_SEM_INIT_VAL, NULL); } /* Two handler functions fifo_work_first() and fifo_work_second * are made for two work items to test first in, first out. * It tests workqueue thread process work items * in first in, first out manner */ void fifo_work_first(struct k_work *unused) { k_sem_take(&sema_fifo_one, K_FOREVER); k_sem_give(&sema_fifo_two); } void fifo_work_second(struct k_work *unused) { k_sem_take(&sema_fifo_two, K_FOREVER); } /** * @brief Test kernel process work items in fifo way * @details To test it we use 2 functions-handlers. * - fifo_work_first() added to the work_item_1 and fifo_work_second() * added to the work_item_2. * - We expect that firstly should run work_item_1, and only then * will run work_item_2. * - To test it, we initialize semaphore sema_fifo_one * with count 1(available) and fifo_work_first() takes that semaphore. * fifo_work_second() is waiting for the semaphore sema_fifo_two, * which will be given from function fifo_work_first(). * - If work_item_2() will try to be executed before work_item_1(), * will happen a timeout error. * - Because sema_fifo_two will be never obtained by fifo_work_second() * due to K_FOREVER macro in it while waiting for the semaphore. * @ingroup kernel_workqueue_tests */ void test_process_work_items_fifo(void) { k_work_init(&work_item_1, fifo_work_first); k_work_init(&work_item_2, fifo_work_second); /**TESTPOINT: submit work items to the queue in fifo manner*/ k_work_submit_to_queue(&workq, &work_item_1); k_work_submit_to_queue(&workq, &work_item_2); } /** * @brief Test kernel support scheduling work item that is to be processed * after user defined period of time * @details * - For that test is using semaphore sync_sema, with initial count 0. * - In that test we measure actual spent time and compare it with time * which was measured by function k_delayed_work_remaining_get(). * - Using system clocks we measure actual spent time * in the period between delayed work submitted and delayed work * executed. * - To know that delayed work was executed, we use semaphore. * - Right after semaphore was given from handler function, we stop * measuring actual time. * - Then compare results. * @ingroup kernel_workqueue_tests */ void test_sched_delayed_work_item(void) { int32_t ms_remain, ms_spent, start_time, stop_time, cycles_spent; int32_t ms_delta = 15; k_sem_reset(&sync_sema); /* TESTPOINT: init delayed work to be processed * only after specific period of time */ k_delayed_work_init(&work_item_delayed, common_work_handler); start_time = k_cycle_get_32(); k_delayed_work_submit_to_queue(&workq, &work_item_delayed, TIMEOUT); ms_remain = k_delayed_work_remaining_get(&work_item_delayed); k_sem_take(&sync_sema, K_FOREVER); stop_time = k_cycle_get_32(); cycles_spent = stop_time - start_time; ms_spent = (uint32_t)k_cyc_to_ms_floor32(cycles_spent); zassert_within(ms_spent, ms_remain, ms_delta, NULL); } /** * @brief Test application can define workqueues without any limit * @details * - We can define any number of workqueus using a var of type struct k_work_q. * - Define and initialize maximum possible real number of the workqueues * available according to the stack size. * - Test defines and initializes max number of the workqueues and starts them. * @ingroup kernel_workqueue_tests */ void test_workqueue_max_number(void) { uint32_t work_q_num = 0; for (uint32_t i = 0; i < MAX_WORK_Q_NUMBER; i++) { work_q_num++; k_work_q_start(&work_q_max_number[i], new_stack_area[i], K_THREAD_STACK_SIZEOF(new_stack_area[i]), MY_PRIORITY); } zassert_true(work_q_num == MAX_WORK_Q_NUMBER, "Max number of the defined work queues not reached, " "real number of the created work queues is " "%d, expected %d", work_q_num, MAX_WORK_Q_NUMBER); } static void work_sleepy(struct k_work *w) { k_sleep(TIMEOUT); k_sem_give(&sync_sema); } static void work_handler(struct k_work *w) { /* Just to show an API call on this will succeed */ k_sem_init(&dummy_sema, 0, 1); k_sem_give(&sync_sema); } static void new_work_handler(struct k_work *w) { k_sem_give(&sync_sema); } static void twork_submit_1(struct k_work_q *work_q, struct k_work *w, k_work_handler_t handler) { /**TESTPOINT: init via k_work_init*/ k_work_init(w, handler); /**TESTPOINT: check pending after work init*/ zassert_false(k_work_pending(w), NULL); if (work_q) { /**TESTPOINT: work submit to queue*/ zassert_false(k_work_submit_to_user_queue(work_q, w), "failed to submit to queue"); } else { /**TESTPOINT: work submit to system queue*/ k_work_submit(w); } } static void twork_submit(const void *data) { struct k_work_q *work_q = (struct k_work_q *)data; for (int i = 0; i < NUM_OF_WORK; i++) { twork_submit_1(work_q, &work[i], work_handler); } } static void twork_submit_multipleq(void *data) { struct k_work_q *work_q = (struct k_work_q *)data; /**TESTPOINT: init via k_work_init*/ k_delayed_work_init(&new_work, new_work_handler); k_delayed_work_submit_to_queue(work_q, &new_work, TIMEOUT); zassert_equal(k_delayed_work_submit(&new_work, TIMEOUT), -EADDRINUSE, NULL); k_sem_give(&sync_sema); } static void twork_resubmit(void *data) { struct k_work_q *work_q = (struct k_work_q *)data; /**TESTPOINT: init via k_work_init*/ k_delayed_work_init(&new_work, new_work_handler); k_delayed_work_submit_to_queue(work_q, &new_work, K_NO_WAIT); /* This is done to test a neagtive case when k_delayed_work_cancel() * fails in k_delayed_work_submit_to_queue API. Removing work from it * queue make sure that k_delayed_work_cancel() fails when the Work is * resubmitted. */ k_queue_remove(&(new_work.work_q->queue), &(new_work.work)); zassert_equal(k_delayed_work_submit_to_queue(work_q, &new_work, K_NO_WAIT), -EINVAL, NULL); k_sem_give(&sync_sema); } static void tdelayed_work_submit_1(struct k_work_q *work_q, struct k_delayed_work *w, k_work_handler_t handler) { int32_t time_remaining; int32_t timeout_ticks; uint64_t tick_to_ms; /**TESTPOINT: init via k_delayed_work_init*/ k_delayed_work_init(w, handler); /**TESTPOINT: check pending after delayed work init*/ zassert_false(k_work_pending((struct k_work *)w), NULL); /**TESTPOINT: check remaining timeout before submit*/ zassert_equal(k_delayed_work_remaining_get(w), 0, NULL); if (work_q) { /**TESTPOINT: delayed work submit to queue*/ zassert_true(k_delayed_work_submit_to_queue(work_q, w, TIMEOUT) == 0, NULL); } else { /**TESTPOINT: delayed work submit to system queue*/ zassert_true(k_delayed_work_submit(w, TIMEOUT) == 0, NULL); } time_remaining = k_delayed_work_remaining_get(w); timeout_ticks = z_ms_to_ticks(TIMEOUT_MS); tick_to_ms = k_ticks_to_ms_floor64(timeout_ticks + _TICK_ALIGN); /**TESTPOINT: check remaining timeout after submit */ zassert_true(time_remaining <= tick_to_ms, NULL); timeout_ticks -= z_ms_to_ticks(15); tick_to_ms = k_ticks_to_ms_floor64(timeout_ticks); zassert_true(time_remaining >= tick_to_ms, NULL); /**TESTPOINT: check pending after delayed work submit*/ zassert_true(k_work_pending((struct k_work *)w) == 0, NULL); } static void tdelayed_work_submit(const void *data) { struct k_work_q *work_q = (struct k_work_q *)data; for (int i = 0; i < NUM_OF_WORK; i++) { tdelayed_work_submit_1(work_q, &delayed_work[i], work_handler); } } static void tdelayed_work_cancel(const void *data) { struct k_work_q *work_q = (struct k_work_q *)data; int ret; k_delayed_work_init(&delayed_work_sleepy, work_sleepy); k_delayed_work_init(&delayed_work[0], work_handler); k_delayed_work_init(&delayed_work[1], work_handler); if (work_q) { ret = k_delayed_work_submit_to_queue(work_q, &delayed_work_sleepy, TIMEOUT); ret |= k_delayed_work_submit_to_queue(work_q, &delayed_work[0], TIMEOUT); ret |= k_delayed_work_submit_to_queue(work_q, &delayed_work[1], TIMEOUT); } else { ret = k_delayed_work_submit(&delayed_work_sleepy, TIMEOUT); ret |= k_delayed_work_submit(&delayed_work[0], TIMEOUT); ret |= k_delayed_work_submit(&delayed_work[1], TIMEOUT); } /* * t0: delayed submit three work items, all with delay=TIMEOUT * >t0: cancel delayed_work[0], expected cancellation success * >t0+TIMEOUT: handling delayed_work_sleepy, which do k_sleep TIMEOUT * pending delayed_work[1], check pending flag, expected 1 * cancel delayed_work[1], expected 0 * >t0+2*TIMEOUT: delayed_work_sleepy completed * delayed_work[1] completed * cancel delayed_work_sleepy, expected 0 */ zassert_true(ret == 0, NULL); /**TESTPOINT: delayed work cancel when countdown*/ ret = k_delayed_work_cancel(&delayed_work[0]); zassert_true(ret == 0, NULL); /**TESTPOINT: check pending after delayed work cancel*/ zassert_false(k_work_pending((struct k_work *)&delayed_work[0]), NULL); if (!k_is_in_isr()) { /*wait for handling work_sleepy*/ k_sleep(TIMEOUT); /**TESTPOINT: check pending when work pending*/ zassert_true(k_work_pending((struct k_work *)&delayed_work[1]), NULL); /**TESTPOINT: delayed work cancel when pending*/ ret = k_delayed_work_cancel(&delayed_work[1]); zassert_equal(ret, 0, NULL); k_sem_give(&sync_sema); /*wait for completed work_sleepy and delayed_work[1]*/ k_sleep(TIMEOUT); /**TESTPOINT: check pending when work completed*/ zassert_false(k_work_pending( (struct k_work *)&delayed_work_sleepy), NULL); /**TESTPOINT: delayed work cancel when completed*/ ret = k_delayed_work_cancel(&delayed_work_sleepy); zassert_not_equal(ret, 0, NULL); } /*work items not cancelled: delayed_work[1], delayed_work_sleepy*/ } static void ttriggered_work_submit(const void *data) { struct k_work_q *work_q = (struct k_work_q *)data; for (int i = 0; i < NUM_OF_WORK; i++) { k_poll_signal_init(&triggered_work_signal[i]); k_poll_event_init(&triggered_work_event[i], K_POLL_TYPE_SIGNAL, K_POLL_MODE_NOTIFY_ONLY, &triggered_work_signal[i]); /**TESTPOINT: init via k_work_poll_init*/ k_work_poll_init(&triggered_work[i], work_handler); /**TESTPOINT: check pending after triggered work init*/ zassert_false(k_work_pending( (struct k_work *)&triggered_work[i]), NULL); if (work_q) { /**TESTPOINT: triggered work submit to queue*/ zassert_true(k_work_poll_submit_to_queue( work_q, &triggered_work[i], &triggered_work_event[i], 1, K_FOREVER) == 0, NULL); } else { /**TESTPOINT: triggered work submit to system queue*/ zassert_true(k_work_poll_submit( &triggered_work[i], &triggered_work_event[i], 1, K_FOREVER) == 0, NULL); } /**TESTPOINT: check pending after triggered work submit*/ zassert_true(k_work_pending( (struct k_work *)&triggered_work[i]) == 0, NULL); } for (int i = 0; i < NUM_OF_WORK; i++) { /**TESTPOINT: trigger work execution*/ zassert_true(k_poll_signal_raise( &triggered_work_signal[i], 1) == 0, NULL); /**TESTPOINT: check pending after sending signal */ zassert_true(k_work_pending( (struct k_work *)&triggered_work[i]) != 0, NULL); } } static void ttriggered_work_cancel(const void *data) { struct k_work_q *work_q = (struct k_work_q *)data; int ret; for (int i = 0; i < NUM_OF_WORK; i++) { k_poll_signal_init(&triggered_work_signal[i]); k_poll_event_init(&triggered_work_event[i], K_POLL_TYPE_SIGNAL, K_POLL_MODE_NOTIFY_ONLY, &triggered_work_signal[i]); k_work_poll_init(&triggered_work[i], work_handler); } k_poll_signal_init(&triggered_work_sleepy_signal); k_poll_event_init(&triggered_work_sleepy_event, K_POLL_TYPE_SIGNAL, K_POLL_MODE_NOTIFY_ONLY, &triggered_work_sleepy_signal); k_work_poll_init(&triggered_work_sleepy, work_sleepy); if (work_q) { ret = k_work_poll_submit_to_queue(work_q, &triggered_work_sleepy, &triggered_work_sleepy_event, 1, K_FOREVER); ret |= k_work_poll_submit_to_queue(work_q, &triggered_work[0], &triggered_work_event[0], 1, K_FOREVER); ret |= k_work_poll_submit_to_queue(work_q, &triggered_work[1], &triggered_work_event[1], 1, K_FOREVER); } else { ret = k_work_poll_submit(&triggered_work_sleepy, &triggered_work_sleepy_event, 1, K_FOREVER); ret |= k_work_poll_submit(&triggered_work[0], &triggered_work_event[0], 1, K_FOREVER); ret |= k_work_poll_submit(&triggered_work[1], &triggered_work_event[1], 1, K_FOREVER); } /* Check if all submission succeeded */ zassert_true(ret == 0, NULL); /**TESTPOINT: triggered work cancel when waiting for event*/ ret = k_work_poll_cancel(&triggered_work[0]); zassert_true(ret == 0, NULL); /**TESTPOINT: check pending after triggerd work cancel*/ ret = k_work_pending((struct k_work *)&triggered_work[0]); zassert_true(ret == 0, NULL); /* Trigger work #1 */ ret = k_poll_signal_raise(&triggered_work_signal[1], 1); zassert_true(ret == 0, NULL); /**TESTPOINT: check pending after sending signal */ ret = k_work_pending((struct k_work *)&triggered_work[1]); zassert_true(ret != 0, NULL); /**TESTPOINT: triggered work cancel when pending for event*/ ret = k_work_poll_cancel(&triggered_work[1]); zassert_true(ret == -EINVAL, NULL); /* Trigger sleepy work */ ret = k_poll_signal_raise(&triggered_work_sleepy_signal, 1); zassert_true(ret == 0, NULL); if (!k_is_in_isr()) { /*wait for completed work_sleepy and triggered_work[1]*/ k_msleep(2 * TIMEOUT_MS); /**TESTPOINT: check pending when work completed*/ ret = k_work_pending((struct k_work *)&triggered_work_sleepy); zassert_true(ret == 0, NULL); /**TESTPOINT: delayed work cancel when completed*/ ret = k_work_poll_cancel(&triggered_work_sleepy); zassert_true(ret == -EINVAL, NULL); } /*work items not cancelled: triggered_work[1], triggered_work_sleepy*/ } /*test cases*/ /** * @brief Test work queue start before submit * * @ingroup kernel_workqueue_tests * * @see k_work_q_start() */ void test_workq_start_before_submit(void) { k_work_q_start(&workq, tstack, STACK_SIZE, CONFIG_MAIN_THREAD_PRIORITY); } /** * @brief Test user mode work queue start before submit * * @ingroup kernel_workqueue_tests * * @see k_work_q_user_start() */ void test_user_workq_start_before_submit(void) { k_work_q_user_start(&user_workq, user_tstack, STACK_SIZE, CONFIG_MAIN_THREAD_PRIORITY); } /** * @brief Setup object permissions before test_user_workq_granted_access() * * @ingroup kernel_workqueue_tests */ void test_user_workq_granted_access_setup(void) { /* Subsequent test cases will have access to the dummy_sema, * but not the user workqueue since it already started. */ k_object_access_grant(&dummy_sema, main_thread); } /** * @brief Test user mode grant workqueue permissions * * @ingroup kernel_workqueue_tests * * @see k_work_q_object_access_grant() */ void test_user_workq_granted_access(void) { k_object_access_grant(&dummy_sema, &user_workq.thread); } /** * @brief Test work submission to work queue * @ingroup kernel_workqueue_tests * @see k_work_init(), k_work_pending(), k_work_submit_to_queue(), * k_work_submit() */ void test_work_submit_to_queue_thread(void) { k_sem_reset(&sync_sema); twork_submit(&workq); for (int i = 0; i < NUM_OF_WORK; i++) { k_sem_take(&sync_sema, K_FOREVER); } } /** * @brief Test work submission to work queue (user mode) * * @ingroup kernel_workqueue_tests * * @see k_work_init(), k_work_pending(), k_work_submit_to_queue(), * k_work_submit() */ void test_user_work_submit_to_queue_thread(void) { k_sem_reset(&sync_sema); twork_submit(&user_workq); for (int i = 0; i < NUM_OF_WORK; i++) { k_sem_take(&sync_sema, K_FOREVER); } } /** * @brief Test submission of work to multiple queues * * @ingroup kernel_workqueue_tests * * @see k_delayed_work_init(), k_delayed_work_submit_to_queue(), * k_delayed_work_submit() */ void test_work_submit_to_multipleq(void) { k_sem_reset(&sync_sema); twork_submit_multipleq(&workq); for (int i = 0; i < NUM_OF_WORK; i++) { k_sem_take(&sync_sema, K_FOREVER); } } /** * @brief Test work queue resubmission * * @ingroup kernel_workqueue_tests * * @see k_queue_remove(), k_delayed_work_init(), * k_delayed_work_submit_to_queue() */ void test_work_resubmit_to_queue(void) { k_sem_reset(&sync_sema); twork_resubmit(&workq); k_sem_take(&sync_sema, K_FOREVER); } /** * @brief Test work submission to queue from ISR context * * @ingroup kernel_workqueue_tests * * @see k_work_init(), k_work_pending(), k_work_submit_to_queue(), * k_work_submit() */ void test_work_submit_to_queue_isr(void) { k_sem_reset(&sync_sema); irq_offload(twork_submit, (const void *)&workq); for (int i = 0; i < NUM_OF_WORK; i++) { k_sem_take(&sync_sema, K_FOREVER); } } /** * @brief Test work submission to queue * * @ingroup kernel_workqueue_tests * * @see k_work_init(), k_work_pending(), k_work_submit_to_queue(), * k_work_submit() */ void test_work_submit_thread(void) { k_sem_reset(&sync_sema); twork_submit(NULL); for (int i = 0; i < NUM_OF_WORK; i++) { k_sem_take(&sync_sema, K_FOREVER); } } /** * @brief Test work submission from ISR context * * @ingroup kernel_workqueue_tests * * @see k_work_init(), k_work_pending(), k_work_submit_to_queue(), * k_work_submit() */ void test_work_submit_isr(void) { k_sem_reset(&sync_sema); irq_offload(twork_submit, NULL); for (int i = 0; i < NUM_OF_WORK; i++) { k_sem_take(&sync_sema, K_FOREVER); } } static void work_handler_resubmit(struct k_work *w) { k_sem_give(&sync_sema); if (k_sem_count_get(&sync_sema) < NUM_OF_WORK) { k_work_submit(w); } } /** * @brief Test work submission to queue from handler context, resubmitting * a work item during execution of its callback * @details * - That test uses sync_sema semaphore with initial count 0. * - That test verifies that it is possible during execution of the handler * function, resubmit a work item from that handler function. * - twork_submit_1() initializes a work item with handler function. * - Then handler function gives a semaphore sync_sema. * - Then in test main body using for() loop, we are waiting for that semaphore. * - When semaphore obtained, handler function checks count of the semaphore * (now it is again 0) and submits work one more time. * @ingroup kernel_workqueue_tests * @see k_work_init(), k_work_pending(), k_work_submit_to_queue(), * k_work_submit() */ void test_work_submit_handler(void) { k_sem_reset(&sync_sema); twork_submit_1(NULL, &work[0], work_handler_resubmit); for (int i = 0; i < NUM_OF_WORK; i++) { k_sem_take(&sync_sema, K_FOREVER); } } /** * @brief Test delayed work submission to queue * * @ingroup kernel_workqueue_tests * * @see k_delayed_work_init(), k_work_pending(), * k_delayed_work_remaining_get(), k_delayed_work_submit_to_queue(), * k_delayed_work_submit() */ void test_delayed_work_submit_to_queue_thread(void) { k_sem_reset(&sync_sema); tdelayed_work_submit(&workq); for (int i = 0; i < NUM_OF_WORK; i++) { k_sem_take(&sync_sema, K_FOREVER); } } /** * @brief Test delayed work submission to queue in ISR context * * @ingroup kernel_workqueue_tests * * @see k_delayed_work_init(), k_work_pending(), * k_delayed_work_remaining_get(), k_delayed_work_submit_to_queue(), * k_delayed_work_submit() */ void test_delayed_work_submit_to_queue_isr(void) { k_sem_reset(&sync_sema); irq_offload(tdelayed_work_submit, (const void *)&workq); for (int i = 0; i < NUM_OF_WORK; i++) { k_sem_take(&sync_sema, K_FOREVER); } } /** * @brief Test delayed work submission * * @ingroup kernel_workqueue_tests * * @see k_delayed_work_init(), k_work_pending(), * k_delayed_work_remaining_get(), k_delayed_work_submit_to_queue(), * k_delayed_work_submit() */ void test_delayed_work_submit_thread(void) { k_sem_reset(&sync_sema); tdelayed_work_submit(NULL); for (int i = 0; i < NUM_OF_WORK; i++) { k_sem_take(&sync_sema, K_FOREVER); } } /** * @brief Test delayed work submission from ISR context * * @ingroup kernel_workqueue_tests * * @see k_delayed_work_init(), k_work_pending(), * k_delayed_work_remaining_get(), k_delayed_work_submit_to_queue(), * k_delayed_work_submit() */ void test_delayed_work_submit_isr(void) { k_sem_reset(&sync_sema); irq_offload(tdelayed_work_submit, NULL); for (int i = 0; i < NUM_OF_WORK; i++) { k_sem_take(&sync_sema, K_FOREVER); } } static void delayed_work_handler_resubmit(struct k_work *w) { struct k_delayed_work *delayed_w = (struct k_delayed_work *)w; k_sem_give(&sync_sema); if (k_sem_count_get(&sync_sema) < NUM_OF_WORK) { /**TESTPOINT: check if work can be resubmit from handler */ zassert_false(k_delayed_work_submit(delayed_w, TIMEOUT), NULL); } } /** * @brief Test delayed work submission to queue from handler context * * @ingroup kernel_workqueue_tests * * @see k_delayed_work_init(), k_work_pending(), * k_delayed_work_remaining_get(), k_delayed_work_submit_to_queue(), * k_delayed_work_submit() */ void test_delayed_work_submit_handler(void) { k_sem_reset(&sync_sema); tdelayed_work_submit_1(NULL, &delayed_work[0], delayed_work_handler_resubmit); for (int i = 0; i < NUM_OF_WORK; i++) { k_sem_take(&sync_sema, K_FOREVER); } k_delayed_work_cancel(&delayed_work[0]); } /** * @brief Test delayed work cancel from work queue * * @ingroup kernel_workqueue_tests * * @see k_delayed_work_cancel(), k_work_pending() */ void test_delayed_work_cancel_from_queue_thread(void) { k_sem_reset(&sync_sema); tdelayed_work_cancel(&workq); /*wait for work items that could not be cancelled*/ for (int i = 0; i < NUM_OF_WORK; i++) { k_sem_take(&sync_sema, K_FOREVER); } } /** * @brief Test delayed work cancel from work queue from ISR context * * @ingroup kernel_workqueue_tests * * @see k_delayed_work_cancel(), k_work_pending() */ void test_delayed_work_cancel_from_queue_isr(void) { k_sem_reset(&sync_sema); irq_offload(tdelayed_work_cancel, (const void *)&workq); /*wait for work items that could not be cancelled*/ for (int i = 0; i < NUM_OF_WORK; i++) { k_sem_take(&sync_sema, K_FOREVER); } } /** * @brief Test delayed work cancel * * @ingroup kernel_workqueue_tests * * @see k_delayed_work_cancel(), k_work_pending() */ void test_delayed_work_cancel_thread(void) { k_sem_reset(&sync_sema); tdelayed_work_cancel(NULL); /*wait for work items that could not be cancelled*/ for (int i = 0; i < NUM_OF_WORK; i++) { k_sem_take(&sync_sema, K_FOREVER); } } /** * @brief Test delayed work cancel from ISR context * * @ingroup kernel_workqueue_tests * * @see k_delayed_work_cancel(), k_work_pending() */ void test_delayed_work_cancel_isr(void) { k_sem_reset(&sync_sema); irq_offload(tdelayed_work_cancel, NULL); /*wait for work items that could not be cancelled*/ for (int i = 0; i < NUM_OF_WORK; i++) { k_sem_take(&sync_sema, K_FOREVER); } } /** * @brief Test triggered work submission to queue * * @ingroup kernel_workqueue_tests * * @see k_work_poll_init(), k_work_pending(), * k_work_poll_submit_to_queue(), * k_work_poll_submit() */ void test_triggered_work_submit_to_queue_thread(void) { k_sem_reset(&sync_sema); ttriggered_work_submit(&workq); for (int i = 0; i < NUM_OF_WORK; i++) { k_sem_take(&sync_sema, K_FOREVER); } } /** * @brief Test triggered work submission to queue in ISR context * * @ingroup kernel_workqueue_tests * * @see k_work_poll_init(), k_work_pending(), * k_work_poll_submit_to_queue(), * k_work_poll_submit() */ void test_triggered_work_submit_to_queue_isr(void) { k_sem_reset(&sync_sema); irq_offload(ttriggered_work_submit, (const void *)&workq); for (int i = 0; i < NUM_OF_WORK; i++) { k_sem_take(&sync_sema, K_FOREVER); } } /** * @brief Test triggered work submission * * @ingroup kernel_workqueue_tests * * @see k_work_poll_init(), k_work_pending(), * k_work_poll_submit_to_queue(), * k_work_poll_submit() */ void test_triggered_work_submit_thread(void) { k_sem_reset(&sync_sema); ttriggered_work_submit(NULL); for (int i = 0; i < NUM_OF_WORK; i++) { k_sem_take(&sync_sema, K_FOREVER); } } /** * @brief Test triggered work submission from ISR context * * @ingroup kernel_workqueue_tests * * @see k_work_poll_init(), k_work_pending(), * k_work_poll_submit_to_queue(), * k_work_poll_submit() */ void test_triggered_work_submit_isr(void) { k_sem_reset(&sync_sema); irq_offload(ttriggered_work_submit, NULL); for (int i = 0; i < NUM_OF_WORK; i++) { k_sem_take(&sync_sema, K_FOREVER); } } /** * @brief Test triggered work cancel from work queue * * @ingroup kernel_workqueue_tests * * @see k_work_poll_cancel(), k_work_pending() */ void test_triggered_work_cancel_from_queue_thread(void) { k_sem_reset(&sync_sema); ttriggered_work_cancel(&workq); /*wait for work items that could not be cancelled*/ for (int i = 0; i < NUM_OF_WORK; i++) { k_sem_take(&sync_sema, K_FOREVER); } } /** * @brief Test triggered work cancel from work queue from ISR context * * @ingroup kernel_workqueue_tests * * @see k_work_poll_cancel(), k_work_pending() */ void test_triggered_work_cancel_from_queue_isr(void) { k_sem_reset(&sync_sema); irq_offload(ttriggered_work_cancel, (const void *)&workq); /*wait for work items that could not be cancelled*/ for (int i = 0; i < NUM_OF_WORK; i++) { k_sem_take(&sync_sema, K_FOREVER); } } /** * @brief Test triggered work cancel * * @ingroup kernel_workqueue_tests * * @see k_work_poll_cancel(), k_work_pending() */ void test_triggered_work_cancel_thread(void) { k_sem_reset(&sync_sema); ttriggered_work_cancel(NULL); /*wait for work items that could not be cancelled*/ for (int i = 0; i < NUM_OF_WORK; i++) { k_sem_take(&sync_sema, K_FOREVER); } } /** * @brief Test triggered work cancel from ISR context * * @ingroup kernel_workqueue_tests * * @see k_work_poll_cancel(), k_work_pending() */ void test_triggered_work_cancel_isr(void) { k_sem_reset(&sync_sema); irq_offload(ttriggered_work_cancel, NULL); /*wait for work items that could not be cancelled*/ for (int i = 0; i < NUM_OF_WORK; i++) { k_sem_take(&sync_sema, K_FOREVER); } } void new_common_work_handler(struct k_work *unused) { k_sem_give(&sync_sema); k_sem_take(&sema_fifo_two, K_FOREVER); } /** * @brief Test cancel already processed work item * @details That test is created to increase coverage and to check that we can * cancel already processed delayed work item. * @ingroup kernel_workqueue_tests * @see k_delayed_work_cancel() */ void test_cancel_processed_work_item(void) { int ret; k_sem_reset(&sync_sema); k_sem_reset(&sema_fifo_two); k_delayed_work_init(&work_item_delayed, common_work_handler); ret = k_delayed_work_cancel(&work_item_delayed); zassert_true(ret == -EINVAL, NULL); k_delayed_work_submit_to_queue(&workq, &work_item_delayed, TIMEOUT); k_sem_take(&sync_sema, K_FOREVER); k_sem_give(&sema_fifo_two); /**TESTPOINT: try to delay already processed work item*/ ret = k_delayed_work_cancel(&work_item_delayed); zassert_true(ret == -EALREADY, NULL); k_sleep(TIMEOUT); } void test_main(void) { main_thread = k_current_get(); k_thread_access_grant(main_thread, &sync_sema, &user_workq.thread, &user_workq.queue, &user_tstack); k_sem_init(&sync_sema, SYNC_SEM_INIT_VAL, NUM_OF_WORK); k_sem_init(&sema_fifo_one, COM_SEM_MAX_VAL, COM_SEM_MAX_VAL); k_sem_init(&sema_fifo_two, COM_SEM_INIT_VAL, COM_SEM_MAX_VAL); k_thread_system_pool_assign(k_current_get()); ztest_test_suite(workqueue_api, /* Do not disturb the ordering of these test cases */ ztest_unit_test(test_workq_start_before_submit), ztest_user_unit_test(test_user_workq_start_before_submit), ztest_unit_test(test_user_workq_granted_access_setup), ztest_user_unit_test(test_user_workq_granted_access), /* End order-important tests */ ztest_1cpu_unit_test(test_work_submit_to_multipleq), ztest_unit_test(test_work_resubmit_to_queue), ztest_1cpu_unit_test(test_work_submit_to_queue_thread), ztest_1cpu_unit_test(test_work_submit_to_queue_isr), ztest_1cpu_unit_test(test_work_submit_thread), ztest_1cpu_unit_test(test_work_submit_isr), ztest_1cpu_unit_test(test_work_submit_handler), ztest_1cpu_user_unit_test(test_user_work_submit_to_queue_thread), ztest_1cpu_unit_test(test_delayed_work_submit_to_queue_thread), ztest_1cpu_unit_test(test_delayed_work_submit_to_queue_isr), ztest_1cpu_unit_test(test_delayed_work_submit_thread), ztest_1cpu_unit_test(test_delayed_work_submit_isr), ztest_1cpu_unit_test(test_delayed_work_submit_handler), ztest_1cpu_unit_test(test_delayed_work_cancel_from_queue_thread), ztest_1cpu_unit_test(test_delayed_work_cancel_from_queue_isr), ztest_1cpu_unit_test(test_delayed_work_cancel_thread), ztest_1cpu_unit_test(test_delayed_work_cancel_isr), ztest_1cpu_unit_test(test_triggered_work_submit_to_queue_thread), ztest_1cpu_unit_test(test_triggered_work_submit_to_queue_isr), ztest_1cpu_unit_test(test_triggered_work_submit_thread), ztest_1cpu_unit_test(test_triggered_work_submit_isr), ztest_1cpu_unit_test(test_triggered_work_cancel_from_queue_thread), ztest_1cpu_unit_test(test_triggered_work_cancel_from_queue_isr), ztest_1cpu_unit_test(test_triggered_work_cancel_thread), ztest_1cpu_unit_test(test_triggered_work_cancel_isr), ztest_unit_test(test_work_item_supplied_with_func), ztest_unit_test(test_process_work_items_fifo), ztest_unit_test(test_sched_delayed_work_item), ztest_unit_test(test_workqueue_max_number), ztest_unit_test(test_cancel_processed_work_item)); ztest_run_test_suite(workqueue_api); } |