esp-idf/components/freertos/test/integration/stream_buffer/test_stream_buffers.c
Darian Leung 3623dc0fce freertos: Fix stream buffer send-receive test
The stream buffer send-receive test preivously contained the following bugs:

- "sender" task would send 101 bytes instead of 100
- The main task would return before "sender" task sends its 101st item. Thus
  the sender task would cause memory corruption when accessing "tc" structure
  allocated on the main task's stack

This commit fixes and simplifies the stream buffer test.
2023-02-24 16:24:25 +08:00

75 lines
2.4 KiB
C

/*
* SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD
*
* SPDX-License-Identifier: Apache-2.0
*/
#include <stdint.h>
#include <stdio.h>
#include "freertos/FreeRTOS.h"
#include "freertos/task.h"
#include "freertos/semphr.h"
#include "freertos/stream_buffer.h"
#include "unity.h"
#include "test_utils.h"
#define TEST_NUM_BYTES 100
#define TEST_RECEIVER_TIMEOUT_TICKS pdMS_TO_TICKS(1000) // 1ms timeout for receiver task
typedef struct {
StreamBufferHandle_t stream_buffer;
SemaphoreHandle_t done_sem;
} test_args_t;
static void sender_task(void *arg)
{
test_args_t *test_args = (test_args_t *)arg;
printf("Starting sender task... \n");
for (int i = 0; i < TEST_NUM_BYTES; i++) {
// Send a single byte, with the byte's value being the number of bytes sent thus far
uint8_t data = (uint8_t)i;
TEST_ASSERT_EQUAL(1, xStreamBufferSend(test_args->stream_buffer, &data, 1, 0));
// Short delay to give a chance for receiver task to receive
vTaskDelay(1);
}
xSemaphoreGive(test_args->done_sem);
vTaskDelete(NULL);
}
static void receiver_task(void *arg)
{
test_args_t *test_args = (test_args_t *)arg;
printf("Starting receiver task... \n");
for (int i = 0; i < TEST_NUM_BYTES; i++) {
// Receive a single byte. The received byte's value being the number of bytes sent/received thus far
uint8_t data;
TEST_ASSERT_EQUAL(1, xStreamBufferReceive(test_args->stream_buffer, &data, 1, TEST_RECEIVER_TIMEOUT_TICKS));
TEST_ASSERT_EQUAL(i, data);
}
xSemaphoreGive(test_args->done_sem);
vTaskDelete(NULL);
}
TEST_CASE("Stream Buffer: Send-receive tasks", "[freertos]")
{
test_args_t test_args;
test_args.stream_buffer = xStreamBufferCreate(TEST_NUM_BYTES, 1);
test_args.done_sem = xSemaphoreCreateCounting(2, 0);
TEST_ASSERT_NOT_NULL(test_args.stream_buffer);
TEST_ASSERT_NOT_NULL(test_args.done_sem);
TEST_ASSERT_EQUAL(pdTRUE, xTaskCreatePinnedToCore(sender_task, "sender", 4096, &test_args, UNITY_FREERTOS_PRIORITY + 2, NULL, 0));
TEST_ASSERT_EQUAL(pdTRUE, xTaskCreatePinnedToCore(receiver_task, "receiver", 4096, &test_args, UNITY_FREERTOS_PRIORITY + 1, NULL, 1));
// Wait for both tasks to complete
for (int i = 0; i < 2; i++) {
xSemaphoreTake(test_args.done_sem, portMAX_DELAY);
}
vStreamBufferDelete(test_args.stream_buffer);
vSemaphoreDelete(test_args.done_sem);
}