lib/tests/kfifo_kunit.c

Source file repositories/reference/linux-study-clean/lib/tests/kfifo_kunit.c

File Facts

System
Linux kernel
Corpus path
lib/tests/kfifo_kunit.c
Extension
.c
Size
6400 bytes
Lines
225
Domain
Kernel Services
Bucket
lib
Inferred role
Kernel Services: implementation source
Status
source implementation candidate

Why This File Exists

Shared kernel service surface used by multiple subsystems, including helpers, cryptography, virtualization support, and async I/O infrastructure.

Dependency Surface

Detected Declarations

Annotated Snippet

// SPDX-License-Identifier: GPL-2.0
/*
 * KUnit test for the generic kernel FIFO implementation.
 *
 * Copyright (C) 2024 Diego Vieira <diego.daniel.professional@gmail.com>
 */
#include <kunit/test.h>

#include <linux/kfifo.h>

#define KFIFO_SIZE 32
#define N_ELEMENTS 5

static void kfifo_test_reset_should_clear_the_fifo(struct kunit *test)
{
	DEFINE_KFIFO(my_fifo, u8, KFIFO_SIZE);

	kfifo_put(&my_fifo, 1);
	kfifo_put(&my_fifo, 2);
	kfifo_put(&my_fifo, 3);
	KUNIT_EXPECT_EQ(test, kfifo_len(&my_fifo), 3);

	kfifo_reset(&my_fifo);

	KUNIT_EXPECT_EQ(test, kfifo_len(&my_fifo), 0);
	KUNIT_EXPECT_TRUE(test, kfifo_is_empty(&my_fifo));
}

static void kfifo_test_define_should_define_an_empty_fifo(struct kunit *test)
{
	DEFINE_KFIFO(my_fifo, u8, KFIFO_SIZE);

	KUNIT_EXPECT_TRUE(test, kfifo_initialized(&my_fifo));
	KUNIT_EXPECT_TRUE(test, kfifo_is_empty(&my_fifo));
	KUNIT_EXPECT_EQ(test, kfifo_len(&my_fifo), 0);
}

static void kfifo_test_len_should_ret_n_of_stored_elements(struct kunit *test)
{
	u8 buffer1[N_ELEMENTS];

	for (int i = 0; i < N_ELEMENTS; i++)
		buffer1[i] = i + 1;

	DEFINE_KFIFO(my_fifo, u8, KFIFO_SIZE);

	KUNIT_EXPECT_EQ(test, kfifo_len(&my_fifo), 0);

	kfifo_in(&my_fifo, buffer1, N_ELEMENTS);
	KUNIT_EXPECT_EQ(test, kfifo_len(&my_fifo), N_ELEMENTS);

	kfifo_in(&my_fifo, buffer1, N_ELEMENTS);
	KUNIT_EXPECT_EQ(test, kfifo_len(&my_fifo), N_ELEMENTS * 2);

	kfifo_reset(&my_fifo);
	KUNIT_EXPECT_EQ(test, kfifo_len(&my_fifo), 0);
}

static void kfifo_test_put_should_insert_and_get_should_pop(struct kunit *test)
{
	u8 out_data = 0;
	int processed_elements;
	u8 elements[] = { 3, 5, 11 };

	DEFINE_KFIFO(my_fifo, u8, KFIFO_SIZE);

	// If the fifo is empty, get returns 0
	processed_elements = kfifo_get(&my_fifo, &out_data);
	KUNIT_EXPECT_EQ(test, processed_elements, 0);
	KUNIT_EXPECT_EQ(test, out_data, 0);

	for (int i = 0; i < 3; i++)
		kfifo_put(&my_fifo, elements[i]);

	for (int i = 0; i < 3; i++) {
		processed_elements = kfifo_get(&my_fifo, &out_data);
		KUNIT_EXPECT_EQ(test, processed_elements, 1);
		KUNIT_EXPECT_EQ(test, out_data, elements[i]);
	}
}

static void kfifo_test_in_should_insert_multiple_elements(struct kunit *test)
{
	u8 in_buffer[] = { 11, 25, 65 };
	u8 out_data;
	int processed_elements;

	DEFINE_KFIFO(my_fifo, u8, KFIFO_SIZE);

	kfifo_in(&my_fifo, in_buffer, 3);

Annotation

Implementation Notes