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 | /* * Copyright (c) 2016 Intel Corporation * * SPDX-License-Identifier: Apache-2.0 */ #include <stdio.h> #include <zephyr/ztest.h> #include <zephyr/app_memory/app_memdomain.h> #ifdef CONFIG_USERSPACE #include <zephyr/sys/libc-hooks.h> #endif #include <zephyr/sys/reboot.h> #include <zephyr/logging/log_ctrl.h> #ifdef KERNEL static struct k_thread ztest_thread; #endif #ifdef CONFIG_ARCH_POSIX #include <unistd.h> #endif /* ZTEST_DMEM and ZTEST_BMEM are used for the application shared memory test */ ZTEST_DMEM enum { TEST_PHASE_SETUP, TEST_PHASE_TEST, TEST_PHASE_TEARDOWN, TEST_PHASE_FRAMEWORK } phase = TEST_PHASE_FRAMEWORK; static ZTEST_BMEM int test_status; /** * @brief Try to shorten a filename by removing the current directory * * This helps to reduce the very long filenames in assertion failures. It * removes the current directory from the filename and returns the rest. * This makes assertions a lot more readable, and sometimes they fit on one * line. * * @param file Filename to check * @returns Shortened filename, or @file if it could not be shortened */ const char *__weak ztest_relative_filename(const char *file) { return file; } static int cleanup_test(struct unit_test *test) { int ret = TC_PASS; int mock_status; mock_status = z_cleanup_mock(); #ifdef KERNEL /* we need to remove the ztest_thread information from the timeout_q. * Because we reuse the same k_thread structure this would * causes some problems. */ if (IS_ENABLED(CONFIG_MULTITHREADING)) { k_thread_abort(&ztest_thread); } #endif if (!ret && mock_status == 1) { PRINT("Test %s failed: Unused mock parameter values\n", test->name); ret = TC_FAIL; } else if (!ret && mock_status == 2) { PRINT("Test %s failed: Unused mock return values\n", test->name); ret = TC_FAIL; } else { ; } return ret; } #ifdef KERNEL #if defined(CONFIG_SMP) && (CONFIG_MP_MAX_NUM_CPUS > 1) #define MAX_NUM_CPUHOLD (CONFIG_MP_MAX_NUM_CPUS - 1) #define CPUHOLD_STACK_SZ (512 + CONFIG_TEST_EXTRA_STACK_SIZE) static struct k_thread cpuhold_threads[MAX_NUM_CPUHOLD]; K_KERNEL_STACK_ARRAY_DEFINE(cpuhold_stacks, MAX_NUM_CPUHOLD, CPUHOLD_STACK_SZ); static struct k_sem cpuhold_sem; volatile int cpuhold_active; /* "Holds" a CPU for use with the "1cpu" test cases. Note that we * can't use tools like the cpumask feature because we have tests that * may need to control that configuration themselves. We do this at * the lowest level, but locking interrupts directly and spinning. */ static void cpu_hold(void *arg1, void *arg2, void *arg3) { ARG_UNUSED(arg1); ARG_UNUSED(arg2); ARG_UNUSED(arg3); unsigned int key = arch_irq_lock(); uint32_t dt, start_ms = k_uptime_get_32(); k_sem_give(&cpuhold_sem); #if (defined(CONFIG_ARM64) || defined(CONFIG_RISCV)) && defined(CONFIG_FPU_SHARING) /* * We'll be spinning with IRQs disabled. The flush-your-FPU request * IPI will never be serviced during that time. Therefore we flush * the FPU preemptively here to prevent any other CPU waiting after * this CPU forever and deadlock the system. */ k_float_disable(_current_cpu->arch.fpu_owner); #endif while (cpuhold_active) { k_busy_wait(1000); } /* Holding the CPU via spinning is expensive, and abusing this * for long-running test cases tends to overload the CI system * (qemu runs separate CPUs in different threads, but the CI * logic views it as one "job") and cause other test failures. */ dt = k_uptime_get_32() - start_ms; zassert_true(dt < CONFIG_ZTEST_CPU_HOLD_TIME_MS, "1cpu test took too long (%d ms)", dt); arch_irq_unlock(key); } #endif /* CONFIG_SMP && (CONFIG_MP_MAX_NUM_CPUS > 1) */ void z_impl_z_test_1cpu_start(void) { #if defined(CONFIG_SMP) && (CONFIG_MP_MAX_NUM_CPUS > 1) unsigned int num_cpus = arch_num_cpus(); cpuhold_active = 1; #ifdef CONFIG_THREAD_NAME char tname[CONFIG_THREAD_MAX_NAME_LEN]; #endif k_sem_init(&cpuhold_sem, 0, 999); /* Spawn N-1 threads to "hold" the other CPUs, waiting for * each to signal us that it's locked and spinning. */ for (int i = 0; i < num_cpus - 1; i++) { k_thread_create(&cpuhold_threads[i], cpuhold_stacks[i], CPUHOLD_STACK_SZ, (k_thread_entry_t) cpu_hold, NULL, NULL, NULL, K_HIGHEST_THREAD_PRIO, 0, K_NO_WAIT); #ifdef CONFIG_THREAD_NAME snprintk(tname, CONFIG_THREAD_MAX_NAME_LEN, "cpuhold%02d", i); k_thread_name_set(&cpuhold_threads[i], tname); #endif k_sem_take(&cpuhold_sem, K_FOREVER); } #endif } void z_impl_z_test_1cpu_stop(void) { #if defined(CONFIG_SMP) && (CONFIG_MP_MAX_NUM_CPUS > 1) unsigned int num_cpus = arch_num_cpus(); cpuhold_active = 0; /* Note that NUM_CPUHOLD can be a value that causes coverity * to flag the following loop as DEADCODE so suppress the warning. */ for (int i = 0; i < num_cpus - 1; i++) { k_thread_abort(&cpuhold_threads[i]); } #endif } #ifdef CONFIG_USERSPACE void z_vrfy_z_test_1cpu_start(void) { z_impl_z_test_1cpu_start(); } #include <syscalls/z_test_1cpu_start_mrsh.c> void z_vrfy_z_test_1cpu_stop(void) { z_impl_z_test_1cpu_stop(); } #include <syscalls/z_test_1cpu_stop_mrsh.c> #endif /* CONFIG_USERSPACE */ #endif static void run_test_functions(struct unit_test *test) { phase = TEST_PHASE_SETUP; test->setup(); phase = TEST_PHASE_TEST; test->test(); } #ifndef KERNEL /* Static code analysis tool can raise a violation that the standard header * <setjmp.h> shall not be used. * * setjmp is using in a test code, not in a runtime code, it is acceptable. * It is a deliberate deviation. */ #include <setjmp.h> /* parasoft-suppress MISRAC2012-RULE_21_4-a MISRAC2012-RULE_21_4-b*/ #include <signal.h> #include <string.h> #include <stdlib.h> #define FAIL_FAST 0 static jmp_buf test_fail; static jmp_buf test_skip; static jmp_buf test_pass; static jmp_buf stack_fail; void ztest_test_fail(void) { raise(SIGABRT); } void ztest_test_skip(void) { longjmp(test_skip, 1); } void ztest_test_pass(void) { longjmp(test_pass, 1); } static void handle_signal(int sig) { static const char *const phase_str[] = { "setup", "unit test", "teardown", }; PRINT(" %s", strsignal(sig)); switch (phase) { case TEST_PHASE_SETUP: case TEST_PHASE_TEST: case TEST_PHASE_TEARDOWN: PRINT(" at %s function\n", phase_str[phase]); longjmp(test_fail, 1); case TEST_PHASE_FRAMEWORK: PRINT("\n"); longjmp(stack_fail, 1); } } static void init_testing(void) { signal(SIGABRT, handle_signal); signal(SIGSEGV, handle_signal); if (setjmp(stack_fail)) { PRINT("TESTSUITE crashed."); exit(1); } } static int run_test(struct unit_test *test) { int ret = TC_PASS; int skip = 0; TC_START(test->name); get_start_time_cyc(); if (setjmp(test_fail)) { ret = TC_FAIL; goto out; } if (setjmp(test_skip)) { skip = 1; goto out; } if (setjmp(test_pass)) { ret = TC_PASS; goto out; } run_test_functions(test); out: ret |= cleanup_test(test); get_test_duration_ms(); if (skip) { Z_TC_END_RESULT(TC_SKIP, test->name); } else { Z_TC_END_RESULT(ret, test->name); } return ret; } #else /* KERNEL */ /* Zephyr's probably going to cause all tests to fail if one test fails, so * skip the rest of tests if one of them fails */ #ifdef CONFIG_ZTEST_FAIL_FAST #define FAIL_FAST 1 #else #define FAIL_FAST 0 #endif K_THREAD_STACK_DEFINE(ztest_thread_stack, CONFIG_ZTEST_STACK_SIZE + CONFIG_TEST_EXTRA_STACK_SIZE); static ZTEST_BMEM int test_result; static void test_finalize(void) { if (IS_ENABLED(CONFIG_MULTITHREADING)) { k_thread_abort(&ztest_thread); k_thread_abort(k_current_get()); } } void ztest_test_fail(void) { test_result = -1; test_finalize(); } void ztest_test_pass(void) { test_result = 0; test_finalize(); } void ztest_test_skip(void) { test_result = -2; test_finalize(); } static void init_testing(void) { k_object_access_all_grant(&ztest_thread); } static void test_cb(void *a, void *dummy2, void *dummy) { struct unit_test *test = (struct unit_test *)a; ARG_UNUSED(dummy2); ARG_UNUSED(dummy); test_result = 1; run_test_functions(test); test_result = 0; } static int run_test(struct unit_test *test) { int ret = TC_PASS; TC_START(test->name); get_start_time_cyc(); if (IS_ENABLED(CONFIG_MULTITHREADING)) { k_thread_create(&ztest_thread, ztest_thread_stack, K_THREAD_STACK_SIZEOF(ztest_thread_stack), (k_thread_entry_t) test_cb, (struct unit_test *)test, NULL, NULL, CONFIG_ZTEST_THREAD_PRIORITY, test->thread_options | K_INHERIT_PERMS, K_FOREVER); k_thread_access_grant(&ztest_thread, test); if (test->name != NULL) { k_thread_name_set(&ztest_thread, test->name); } k_thread_start(&ztest_thread); k_thread_join(&ztest_thread, K_FOREVER); } else { test_result = 1; run_test_functions(test); } phase = TEST_PHASE_TEARDOWN; test->teardown(); phase = TEST_PHASE_FRAMEWORK; /* Flush all logs in case deferred mode and default logging thread are used. */ while (IS_ENABLED(CONFIG_TEST_LOGGING_FLUSH_AFTER_TEST) && IS_ENABLED(CONFIG_LOG_PROCESS_THREAD) && log_data_pending()) { k_msleep(100); } if (test_result == -1) { ret = TC_FAIL; } if (!test_result || !FAIL_FAST) { ret |= cleanup_test(test); } get_test_duration_ms(); if (test_result == -2) { Z_TC_END_RESULT(TC_SKIP, test->name); } else { Z_TC_END_RESULT(ret, test->name); } return ret; } #endif /* !KERNEL */ int z_ztest_run_test_suite(const char *name, struct unit_test *suite) { int fail = 0; if (test_status < 0) { return test_status; } init_testing(); TC_SUITE_START(name); while (suite->test) { fail += run_test(suite); suite++; if (fail && FAIL_FAST) { break; } } TC_SUITE_END(name, (fail > 0 ? TC_FAIL : TC_PASS)); test_status = (test_status || fail) ? 1 : 0; return fail; } void end_report(void) { if (test_status) { TC_END_REPORT(TC_FAIL); } else { TC_END_REPORT(TC_PASS); } } #ifdef CONFIG_USERSPACE K_APPMEM_PARTITION_DEFINE(ztest_mem_partition); #endif int ztest_run_registered_test_suites(const void *state) { struct ztest_suite_node *ptr; int count = 0; for (ptr = _ztest_suite_node_list_start; ptr < _ztest_suite_node_list_end; ++ptr) { struct ztest_suite_stats *stats = ptr->stats; bool should_run = true; if (ptr->predicate != NULL) { should_run = ptr->predicate(state); } else { /* If pragma is NULL, only run this test once. */ should_run = stats->run_count == 0; } if (should_run) { int fail = z_ztest_run_test_suite(ptr->name, ptr->suite); count++; stats->run_count++; stats->fail_count += (fail != 0) ? 1 : 0; } else { stats->skip_count++; } } return count; } void ztest_verify_all_registered_test_suites_ran(void) { bool all_tests_run = true; struct ztest_suite_node *ptr; for (ptr = _ztest_suite_node_list_start; ptr < _ztest_suite_node_list_end; ++ptr) { if (ptr->stats->run_count < 1) { PRINT("ERROR: Test '%s' did not run.\n", ptr->name); all_tests_run = false; } } if (!all_tests_run) { test_status = 1; } } void __weak test_main(void) { ztest_run_registered_test_suites(NULL); ztest_verify_all_registered_test_suites_ran(); } #ifndef KERNEL int main(void) { z_init_mock(); test_main(); end_report(); return test_status; } #else int main(void) { #ifdef CONFIG_USERSPACE int ret; /* Partition containing globals tagged with ZTEST_DMEM and ZTEST_BMEM * macros. Any variables that user code may reference need to be * placed in this partition if no other memory domain configuration * is made. */ ret = k_mem_domain_add_partition(&k_mem_domain_default, &ztest_mem_partition); if (ret != 0) { PRINT("ERROR: failed to add ztest_mem_partition to mem domain (%d)\n", ret); k_oops(); } #ifdef Z_MALLOC_PARTITION_EXISTS /* Allow access to malloc() memory */ if (z_malloc_partition.size != 0) { ret = k_mem_domain_add_partition(&k_mem_domain_default, &z_malloc_partition); if (ret != 0) { PRINT("ERROR: failed to add z_malloc_partition" " to mem domain (%d)\n", ret); k_oops(); } } #endif #endif /* CONFIG_USERSPACE */ z_init_mock(); test_main(); end_report(); if (IS_ENABLED(CONFIG_ZTEST_RETEST_IF_PASSED)) { static __noinit struct { uint32_t magic; uint32_t boots; } state; const uint32_t magic = 0x152ac523; if (state.magic != magic) { state.magic = magic; state.boots = 0; } state.boots += 1; if (test_status == 0) { PRINT("Reset board #%u to test again\n", state.boots); k_msleep(10); sys_reboot(SYS_REBOOT_COLD); } else { PRINT("Failed after %u attempts\n", state.boots); state.boots = 0; } } #ifdef CONFIG_ZTEST_NO_YIELD /* * Rather than yielding to idle thread, keep the part awake so debugger can * still access it, since some SOCs cannot be debugged in low power states. */ uint32_t key = irq_lock(); while (1) { ; /* Spin */ } irq_unlock(key); #endif return 0; } #endif |