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 | /* * Copyright (c) 2018 Intel Corporation * * SPDX-License-Identifier: Apache-2.0 */ #include <zephyr/ztest.h> #include <zephyr/irq_offload.h> #include <zephyr/sys/__assert.h> #include <zephyr/sys/util.h> #include <zephyr/logging/log.h> LOG_MODULE_REGISTER(test); /* * @file * @brief Test fifo APIs timeout * * This module tests following fifo timeout scenarios * * First, the thread waits with a timeout and times out. Then it wait with a * timeout, but gets the data in time. * * Then, multiple timeout tests are done for the threads, to test the ordering * of queueing/dequeueing when timeout occurs, first on one fifo, then on * multiple fifos. * * Finally, multiple threads pend on one fifo, and they all get the * data in time, except the last one: this tests that the timeout is * recomputed correctly when timeouts are aborted. */ struct scratch_fifo_packet { void *link_in_fifo; void *data_if_needed; }; struct reply_packet { void *link_in_fifo; int32_t reply; }; struct timeout_order_data { void *link_in_fifo; struct k_fifo *fifo; uint32_t timeout; int32_t timeout_order; int32_t q_order; }; #define NUM_SCRATCH_FIFO_PACKETS 20 struct scratch_fifo_packet scratch_fifo_packets[NUM_SCRATCH_FIFO_PACKETS]; struct k_fifo scratch_fifo_packets_fifo; static struct k_fifo fifo_timeout[2]; struct k_fifo timeout_order_fifo; struct timeout_order_data timeout_order_data[] = { {0, &fifo_timeout[0], 20, 2, 0}, {0, &fifo_timeout[0], 40, 4, 1}, {0, &fifo_timeout[0], 0, 0, 2}, {0, &fifo_timeout[0], 10, 1, 3}, {0, &fifo_timeout[0], 30, 3, 4}, }; struct timeout_order_data timeout_order_data_mult_fifo[] = { {0, &fifo_timeout[1], 0, 0, 0}, {0, &fifo_timeout[0], 30, 3, 1}, {0, &fifo_timeout[0], 50, 5, 2}, {0, &fifo_timeout[1], 80, 8, 3}, {0, &fifo_timeout[1], 70, 7, 4}, {0, &fifo_timeout[0], 10, 1, 5}, {0, &fifo_timeout[0], 60, 6, 6}, {0, &fifo_timeout[0], 20, 2, 7}, {0, &fifo_timeout[1], 40, 4, 8}, }; #define TIMEOUT_ORDER_NUM_THREADS ARRAY_SIZE(timeout_order_data_mult_fifo) #define TSTACK_SIZE (512 + CONFIG_TEST_EXTRA_STACK_SIZE) #define FIFO_THREAD_PRIO -5 static K_THREAD_STACK_ARRAY_DEFINE(ttstack, TIMEOUT_ORDER_NUM_THREADS, TSTACK_SIZE); static struct k_thread ttdata[TIMEOUT_ORDER_NUM_THREADS]; static k_tid_t tid[TIMEOUT_ORDER_NUM_THREADS]; static void *get_scratch_packet(void) { void *packet = k_fifo_get(&scratch_fifo_packets_fifo, K_NO_WAIT); zassert_true(packet != NULL); return packet; } static void put_scratch_packet(void *packet) { k_fifo_put(&scratch_fifo_packets_fifo, packet); } static bool is_timeout_in_range(uint32_t start_time, uint32_t timeout) { uint32_t stop_time, diff; stop_time = k_cycle_get_32(); diff = (uint32_t)k_cyc_to_ns_floor64(stop_time - start_time) / NSEC_PER_USEC; diff = diff / USEC_PER_MSEC; return timeout <= diff; } /* a thread sleeps then puts data on the fifo */ static void test_thread_put_timeout(void *p1, void *p2, void *p3) { uint32_t timeout = *((uint32_t *)p2); k_msleep(timeout); k_fifo_put((struct k_fifo *)p1, get_scratch_packet()); } /* a thread pends on a fifo then times out */ static void test_thread_pend_and_timeout(void *p1, void *p2, void *p3) { struct timeout_order_data *d = (struct timeout_order_data *)p1; uint32_t start_time; void *packet; k_msleep(1); /* Align to ticks */ start_time = k_cycle_get_32(); packet = k_fifo_get(d->fifo, K_MSEC(d->timeout)); zassert_true(packet == NULL); zassert_true(is_timeout_in_range(start_time, d->timeout)); k_fifo_put(&timeout_order_fifo, d); } /* Spins several threads that pend and timeout on fifos */ static int test_multiple_threads_pending(struct timeout_order_data *test_data, int test_data_size) { int ii, j; uint32_t diff_ms; for (ii = 0; ii < test_data_size; ii++) { tid[ii] = k_thread_create(&ttdata[ii], ttstack[ii], TSTACK_SIZE, test_thread_pend_and_timeout, &test_data[ii], NULL, NULL, FIFO_THREAD_PRIO, K_INHERIT_PERMS, K_NO_WAIT); } /* In general, there is no guarantee of wakeup order when multiple * threads are woken up on the same tick. This can especially happen * when the system is loaded. However, in this particular test, we * are controlling the system state and hence we can make a reasonable * estimation of a timeout occurring with the max deviation of an * additional tick. Hence the timeout order may slightly be different * from what we normally expect. */ for (ii = 0; ii < test_data_size; ii++) { struct timeout_order_data *data = k_fifo_get(&timeout_order_fifo, K_FOREVER); zassert_not_null(data, NULL); if (data->timeout_order == ii) { LOG_DBG(" thread (q order: %d, t/o: %d, fifo %p)", data->q_order, data->timeout, data->fifo); } else { /* Get the index of the thread which should have * actually timed out. */ for (j = 0; j < test_data_size; j++) { if (test_data[j].timeout_order == ii) { break; } } if (data->timeout > test_data[j].timeout) { diff_ms = data->timeout - test_data[j].timeout; } else { diff_ms = test_data[j].timeout - data->timeout; } if (k_ms_to_ticks_ceil32(diff_ms) == 1) { LOG_DBG( " thread (q order: %d, t/o: %d, fifo %p)", data->q_order, data->timeout, data->fifo); } else { TC_ERROR( " *** thread %d woke up, expected %d\n", data->q_order, j); return TC_FAIL; } } } return TC_PASS; } /* a thread pends on a fifo with a timeout and gets the data in time */ static void test_thread_pend_and_get_data(void *p1, void *p2, void *p3) { struct timeout_order_data *d = (struct timeout_order_data *)p1; void *packet; packet = k_fifo_get(d->fifo, K_MSEC(d->timeout)); zassert_true(packet != NULL); put_scratch_packet(packet); k_fifo_put(&timeout_order_fifo, d); } /* Spins child threads that get fifo data in time, except the last one */ static int test_multiple_threads_get_data(struct timeout_order_data *test_data, int test_data_size) { struct timeout_order_data *data; int ii; for (ii = 0; ii < test_data_size-1; ii++) { tid[ii] = k_thread_create(&ttdata[ii], ttstack[ii], TSTACK_SIZE, test_thread_pend_and_get_data, &test_data[ii], NULL, NULL, K_PRIO_PREEMPT(0), K_INHERIT_PERMS, K_NO_WAIT); } tid[ii] = k_thread_create(&ttdata[ii], ttstack[ii], TSTACK_SIZE, test_thread_pend_and_timeout, &test_data[ii], NULL, NULL, K_PRIO_PREEMPT(0), K_INHERIT_PERMS, K_NO_WAIT); for (ii = 0; ii < test_data_size-1; ii++) { k_fifo_put(test_data[ii].fifo, get_scratch_packet()); data = k_fifo_get(&timeout_order_fifo, K_FOREVER); if (!data) { TC_ERROR("thread %d got NULL value from fifo\n", ii); return TC_FAIL; } if (data->q_order != ii) { TC_ERROR(" *** thread %d woke up, expected %d\n", data->q_order, ii); return TC_FAIL; } if (data->q_order == ii) { LOG_DBG(" thread (q order: %d, t/o: %d, fifo %p)", data->q_order, data->timeout, data->fifo); } } data = k_fifo_get(&timeout_order_fifo, K_FOREVER); if (!data) { TC_ERROR("thread %d got NULL value from fifo\n", ii); return TC_FAIL; } if (data->q_order != ii) { TC_ERROR(" *** thread %d woke up, expected %d\n", data->q_order, ii); return TC_FAIL; } LOG_DBG(" thread (q order: %d, t/o: %d, fifo %p)", data->q_order, data->timeout, data->fifo); return TC_PASS; } /* try getting data on fifo with special timeout value, return result in fifo */ static void test_thread_timeout_reply_values(void *p1, void *p2, void *p3) { struct reply_packet *reply_packet = (struct reply_packet *)p1; reply_packet->reply = !!k_fifo_get(&fifo_timeout[0], K_NO_WAIT); k_fifo_put(&timeout_order_fifo, reply_packet); } static void test_thread_timeout_reply_values_wfe(void *p1, void *p2, void *p3) { struct reply_packet *reply_packet = (struct reply_packet *)p1; reply_packet->reply = !!k_fifo_get(&fifo_timeout[0], K_FOREVER); k_fifo_put(&timeout_order_fifo, reply_packet); } /** * @addtogroup kernel_fifo_tests * @{ */ /** * @brief Test empty fifo with timeout and K_NO_WAIT * @see k_fifo_get() */ ZTEST(fifo_timeout_1cpu, test_timeout_empty_fifo) { void *packet; uint32_t start_time, timeout; k_msleep(1); /* Align to ticks */ /* Test empty fifo with timeout */ timeout = 10U; start_time = k_cycle_get_32(); packet = k_fifo_get(&fifo_timeout[0], K_MSEC(timeout)); zassert_true(packet == NULL); zassert_true(is_timeout_in_range(start_time, timeout)); /* Test empty fifo with timeout of K_NO_WAIT */ packet = k_fifo_get(&fifo_timeout[0], K_NO_WAIT); zassert_true(packet == NULL); } /** * @brief Test non empty fifo with timeout and K_NO_WAIT * @see k_fifo_get(), k_fifo_put() */ ZTEST(fifo_timeout, test_timeout_non_empty_fifo) { void *packet, *scratch_packet; /* Test k_fifo_get with K_NO_WAIT */ scratch_packet = get_scratch_packet(); k_fifo_put(&fifo_timeout[0], scratch_packet); packet = k_fifo_get(&fifo_timeout[0], K_NO_WAIT); zassert_true(packet != NULL); put_scratch_packet(scratch_packet); /* Test k_fifo_get with K_FOREVER */ scratch_packet = get_scratch_packet(); k_fifo_put(&fifo_timeout[0], scratch_packet); packet = k_fifo_get(&fifo_timeout[0], K_FOREVER); zassert_true(packet != NULL); put_scratch_packet(scratch_packet); } /** * @brief Test fifo with timeout and K_NO_WAIT * @details In first scenario test fifo with some timeout where child thread * puts data on the fifo on time. In second scenario test k_fifo_get with * timeout of K_NO_WAIT and the fifo should be filled by the child thread * based on the data availability on another fifo. In third scenario test * k_fifo_get with timeout of K_FOREVER and the fifo should be filled by * the child thread based on the data availability on another fifo. * @see k_fifo_get(), k_fifo_put() */ ZTEST(fifo_timeout_1cpu, test_timeout_fifo_thread) { void *packet, *scratch_packet; struct reply_packet reply_packet; uint32_t start_time, timeout; k_msleep(1); /* Align to ticks */ /* * Test fifo with some timeout and child thread that puts * data on the fifo on time */ timeout = 10U; start_time = k_cycle_get_32(); tid[0] = k_thread_create(&ttdata[0], ttstack[0], TSTACK_SIZE, test_thread_put_timeout, &fifo_timeout[0], &timeout, NULL, FIFO_THREAD_PRIO, K_INHERIT_PERMS, K_NO_WAIT); packet = k_fifo_get(&fifo_timeout[0], K_MSEC(timeout + 10)); zassert_true(packet != NULL); zassert_true(is_timeout_in_range(start_time, timeout)); put_scratch_packet(packet); /* * Test k_fifo_get with timeout of K_NO_WAIT and the fifo * should be filled be filled by the child thread based on * the data availability on another fifo. In this test child * thread does not find data on fifo. */ tid[0] = k_thread_create(&ttdata[0], ttstack[0], TSTACK_SIZE, test_thread_timeout_reply_values, &reply_packet, NULL, NULL, FIFO_THREAD_PRIO, K_INHERIT_PERMS, K_NO_WAIT); k_yield(); packet = k_fifo_get(&timeout_order_fifo, K_NO_WAIT); zassert_true(packet != NULL); zassert_false(reply_packet.reply); /* * Test k_fifo_get with timeout of K_NO_WAIT and the fifo * should be filled be filled by the child thread based on * the data availability on another fifo. In this test child * thread does find data on fifo. */ scratch_packet = get_scratch_packet(); k_fifo_put(&fifo_timeout[0], scratch_packet); tid[0] = k_thread_create(&ttdata[0], ttstack[0], TSTACK_SIZE, test_thread_timeout_reply_values, &reply_packet, NULL, NULL, FIFO_THREAD_PRIO, K_INHERIT_PERMS, K_NO_WAIT); k_yield(); packet = k_fifo_get(&timeout_order_fifo, K_NO_WAIT); zassert_true(packet != NULL); zassert_true(reply_packet.reply); put_scratch_packet(scratch_packet); /* * Test k_fifo_get with timeout of K_FOREVER and the fifo * should be filled be filled by the child thread based on * the data availability on another fifo. In this test child * thread does find data on fifo. */ scratch_packet = get_scratch_packet(); k_fifo_put(&fifo_timeout[0], scratch_packet); tid[0] = k_thread_create(&ttdata[0], ttstack[0], TSTACK_SIZE, test_thread_timeout_reply_values_wfe, &reply_packet, NULL, NULL, FIFO_THREAD_PRIO, K_INHERIT_PERMS, K_NO_WAIT); packet = k_fifo_get(&timeout_order_fifo, K_FOREVER); zassert_true(packet != NULL); zassert_true(reply_packet.reply); put_scratch_packet(scratch_packet); } /** * @brief Test fifo with different timeouts * @details test multiple threads pending on the same fifo with * different timeouts * @see k_fifo_get(), k_fifo_put() */ ZTEST(fifo_timeout_1cpu, test_timeout_threads_pend_on_fifo) { int32_t rv, test_data_size; /* * Test multiple threads pending on the same * fifo with different timeouts */ test_data_size = ARRAY_SIZE(timeout_order_data); rv = test_multiple_threads_pending(timeout_order_data, test_data_size); zassert_equal(rv, TC_PASS); } /** * @brief Test multiple fifos with different timeouts * @details test multiple threads pending on different fifos * with different timeouts * @see k_fifo_get(), k_fifo_put() */ ZTEST(fifo_timeout_1cpu, test_timeout_threads_pend_on_dual_fifos) { int32_t rv, test_data_size; /* * Test multiple threads pending on different * fifos with different timeouts */ test_data_size = ARRAY_SIZE(timeout_order_data_mult_fifo); rv = test_multiple_threads_pending(timeout_order_data_mult_fifo, test_data_size); zassert_equal(rv, TC_PASS); } /** * @brief Test same fifo with different timeouts * @details test multiple threads pending on the same fifo with * different timeouts but getting the data in time * @see k_fifo_get(), k_fifo_put() */ ZTEST(fifo_timeout_1cpu, test_timeout_threads_pend_fail_on_fifo) { int32_t rv, test_data_size; /* * Test multiple threads pending on same * fifo with different timeouts, but getting * the data in time, except the last one. */ test_data_size = ARRAY_SIZE(timeout_order_data); rv = test_multiple_threads_get_data(timeout_order_data, test_data_size); zassert_equal(rv, TC_PASS); } /** * @brief Test fifo init * @see k_fifo_init(), k_fifo_put() */ static void *test_timeout_setup(void) { intptr_t ii; /* Init kernel objects */ k_fifo_init(&fifo_timeout[0]); k_fifo_init(&fifo_timeout[1]); k_fifo_init(&timeout_order_fifo); k_fifo_init(&scratch_fifo_packets_fifo); /* Fill scratch fifo */ for (ii = 0; ii < NUM_SCRATCH_FIFO_PACKETS; ii++) { scratch_fifo_packets[ii].data_if_needed = (void *)ii; k_fifo_put(&scratch_fifo_packets_fifo, (void *)&scratch_fifo_packets[ii]); } return NULL; } /** * @} */ ZTEST_SUITE(fifo_timeout, NULL, test_timeout_setup, NULL, NULL, NULL); ZTEST_SUITE(fifo_timeout_1cpu, NULL, test_timeout_setup, ztest_simple_1cpu_before, ztest_simple_1cpu_after, NULL); |