[thirdparty/linux.git] / lib / test_list_sort.c

// SPDX-License-Identifier: GPL-2.0-only
#include <kunit/test.h>

#include <linux/kernel.h>
#include <linux/list_sort.h>
#include <linux/list.h>
#include <linux/module.h>
#include <linux/printk.h>
#include <linux/slab.h>
#include <linux/random.h>

/*
 * The pattern of set bits in the list length determines which cases
 * are hit in list_sort().
 */
#define TEST_LIST_LEN (512+128+2) /* not including head */

#define TEST_POISON1 0xDEADBEEF
#define TEST_POISON2 0xA324354C

struct debug_el {
	unsigned int poison1;
	struct list_head list;
	unsigned int poison2;
	int value;
	unsigned int serial;
};

static void check(struct kunit *test, struct debug_el *ela, struct debug_el *elb)
{
	struct debug_el **elts = test->priv;

	KUNIT_EXPECT_LT_MSG(test, ela->serial, (unsigned int)TEST_LIST_LEN, "incorrect serial");
	KUNIT_EXPECT_LT_MSG(test, elb->serial, (unsigned int)TEST_LIST_LEN, "incorrect serial");

	KUNIT_EXPECT_PTR_EQ_MSG(test, elts[ela->serial], ela, "phantom element");
	KUNIT_EXPECT_PTR_EQ_MSG(test, elts[elb->serial], elb, "phantom element");

	KUNIT_EXPECT_EQ_MSG(test, ela->poison1, TEST_POISON1, "bad poison");
	KUNIT_EXPECT_EQ_MSG(test, ela->poison2, TEST_POISON2, "bad poison");

	KUNIT_EXPECT_EQ_MSG(test, elb->poison1, TEST_POISON1, "bad poison");
	KUNIT_EXPECT_EQ_MSG(test, elb->poison2, TEST_POISON2, "bad poison");
}

/* `priv` is the test pointer so check() can fail the test if the list is invalid. */
static int cmp(void *priv, const struct list_head *a, const struct list_head *b)
{
	struct debug_el *ela, *elb;

	ela = container_of(a, struct debug_el, list);
	elb = container_of(b, struct debug_el, list);

	check(priv, ela, elb);
	return ela->value - elb->value;
}

static void list_sort_test(struct kunit *test)
{
	int i, count = 1;
	struct debug_el *el, **elts;
	struct list_head *cur;
	LIST_HEAD(head);

	elts = kunit_kcalloc(test, TEST_LIST_LEN, sizeof(*elts), GFP_KERNEL);
	KUNIT_ASSERT_NOT_ERR_OR_NULL(test, elts);
	test->priv = elts;

	for (i = 0; i < TEST_LIST_LEN; i++) {
		el = kunit_kmalloc(test, sizeof(*el), GFP_KERNEL);
		KUNIT_ASSERT_NOT_ERR_OR_NULL(test, el);

		 /* force some equivalencies */
		el->value = get_random_u32_below(TEST_LIST_LEN / 3);
		el->serial = i;
		el->poison1 = TEST_POISON1;
		el->poison2 = TEST_POISON2;
		elts[i] = el;
		list_add_tail(&el->list, &head);
	}

	list_sort(test, &head, cmp);

	for (cur = head.next; cur->next != &head; cur = cur->next) {
		struct debug_el *el1;
		int cmp_result;

		KUNIT_ASSERT_PTR_EQ_MSG(test, cur->next->prev, cur,
					"list is corrupted");

		cmp_result = cmp(test, cur, cur->next);
		KUNIT_ASSERT_LE_MSG(test, cmp_result, 0, "list is not sorted");

		el = container_of(cur, struct debug_el, list);
		el1 = container_of(cur->next, struct debug_el, list);
		if (cmp_result == 0) {
			KUNIT_ASSERT_LE_MSG(test, el->serial, el1->serial,
					    "order of equivalent elements not preserved");
		}

		check(test, el, el1);
		count++;
	}
	KUNIT_EXPECT_PTR_EQ_MSG(test, head.prev, cur, "list is corrupted");

	KUNIT_EXPECT_EQ_MSG(test, count, TEST_LIST_LEN,
			    "list length changed after sorting!");
}

static struct kunit_case list_sort_cases[] = {
	KUNIT_CASE(list_sort_test),
	{}
};

static struct kunit_suite list_sort_suite = {
	.name = "list_sort",
	.test_cases = list_sort_cases,
};

kunit_test_suites(&list_sort_suite);

MODULE_LICENSE("GPL");
Commit	Line	Data
09c434b8	1	// SPDX-License-Identifier: GPL-2.0-only
ebd09577	2	#include <kunit/test.h>
e327fd7c GU	3
	4	#include <linux/kernel.h>
	5	#include <linux/list_sort.h>
	6	#include <linux/list.h>
	7	#include <linux/module.h>
	8	#include <linux/printk.h>
	9	#include <linux/slab.h>
	10	#include <linux/random.h>
	11
	12	/*
	13	* The pattern of set bits in the list length determines which cases
	14	* are hit in list_sort().
	15	*/
	16	#define TEST_LIST_LEN (512+128+2) /* not including head */
	17
	18	#define TEST_POISON1 0xDEADBEEF
	19	#define TEST_POISON2 0xA324354C
	20
	21	struct debug_el {
	22	unsigned int poison1;
	23	struct list_head list;
	24	unsigned int poison2;
	25	int value;
ebd09577	26	unsigned int serial;
e327fd7c GU	27	};
e327fd7c GU	28
ebd09577	29	static void check(struct kunit test, struct debug_el ela, struct debug_el *elb)
e327fd7c	30	{
ebd09577 DL	31	struct debug_el **elts = test->priv;
	32
	33	KUNIT_EXPECT_LT_MSG(test, ela->serial, (unsigned int)TEST_LIST_LEN, "incorrect serial");
	34	KUNIT_EXPECT_LT_MSG(test, elb->serial, (unsigned int)TEST_LIST_LEN, "incorrect serial");
	35
	36	KUNIT_EXPECT_PTR_EQ_MSG(test, elts[ela->serial], ela, "phantom element");
	37	KUNIT_EXPECT_PTR_EQ_MSG(test, elts[elb->serial], elb, "phantom element");
	38
	39	KUNIT_EXPECT_EQ_MSG(test, ela->poison1, TEST_POISON1, "bad poison");
	40	KUNIT_EXPECT_EQ_MSG(test, ela->poison2, TEST_POISON2, "bad poison");
	41
	42	KUNIT_EXPECT_EQ_MSG(test, elb->poison1, TEST_POISON1, "bad poison");
	43	KUNIT_EXPECT_EQ_MSG(test, elb->poison2, TEST_POISON2, "bad poison");
e327fd7c GU	44	}
e327fd7c GU	45
ebd09577 DL	46	/* `priv` is the test pointer so check() can fail the test if the list is invalid. */
ebd09577 DL	47	static int cmp(void priv, const struct list_head a, const struct list_head *b)
e327fd7c GU	48	{
	49	struct debug_el ela, elb;
	50
	51	ela = container_of(a, struct debug_el, list);
	52	elb = container_of(b, struct debug_el, list);
	53
ebd09577	54	check(priv, ela, elb);
e327fd7c GU	55	return ela->value - elb->value;
	56	}
	57
ebd09577	58	static void list_sort_test(struct kunit *test)
e327fd7c	59	{
ebd09577 DL	60	int i, count = 1;
ebd09577 DL	61	struct debug_el el, *elts;
e327fd7c GU	62	struct list_head *cur;
	63	LIST_HEAD(head);
	64
ebd09577 DL	65	elts = kunit_kcalloc(test, TEST_LIST_LEN, sizeof(*elts), GFP_KERNEL);
	66	KUNIT_ASSERT_NOT_ERR_OR_NULL(test, elts);
	67	test->priv = elts;
e327fd7c GU	68
e327fd7c GU	69	for (i = 0; i < TEST_LIST_LEN; i++) {
ebd09577 DL	70	el = kunit_kmalloc(test, sizeof(*el), GFP_KERNEL);
ebd09577 DL	71	KUNIT_ASSERT_NOT_ERR_OR_NULL(test, el);
dc2bf000	72
e327fd7c	73	/* force some equivalencies */
8032bf12	74	el->value = get_random_u32_below(TEST_LIST_LEN / 3);
e327fd7c GU	75	el->serial = i;
	76	el->poison1 = TEST_POISON1;
	77	el->poison2 = TEST_POISON2;
	78	elts[i] = el;
	79	list_add_tail(&el->list, &head);
	80	}
	81
ebd09577	82	list_sort(test, &head, cmp);
e327fd7c	83
e327fd7c GU	84	for (cur = head.next; cur->next != &head; cur = cur->next) {
	85	struct debug_el *el1;
	86	int cmp_result;
	87
ebd09577 DL	88	KUNIT_ASSERT_PTR_EQ_MSG(test, cur->next->prev, cur,
ebd09577 DL	89	"list is corrupted");
e327fd7c	90
ebd09577 DL	91	cmp_result = cmp(test, cur, cur->next);
ebd09577 DL	92	KUNIT_ASSERT_LE_MSG(test, cmp_result, 0, "list is not sorted");
e327fd7c GU	93
	94	el = container_of(cur, struct debug_el, list);
	95	el1 = container_of(cur->next, struct debug_el, list);
ebd09577 DL	96	if (cmp_result == 0) {
	97	KUNIT_ASSERT_LE_MSG(test, el->serial, el1->serial,
	98	"order of equivalent elements not preserved");
e327fd7c GU	99	}
e327fd7c GU	100
ebd09577	101	check(test, el, el1);
e327fd7c GU	102	count++;
e327fd7c GU	103	}
ebd09577	104	KUNIT_EXPECT_PTR_EQ_MSG(test, head.prev, cur, "list is corrupted");
e327fd7c	105
ebd09577 DL	106	KUNIT_EXPECT_EQ_MSG(test, count, TEST_LIST_LEN,
	107	"list length changed after sorting!");
	108	}
e327fd7c	109
ebd09577 DL	110	static struct kunit_case list_sort_cases[] = {
	111	KUNIT_CASE(list_sort_test),
	112	{}
	113	};
	114
	115	static struct kunit_suite list_sort_suite = {
	116	.name = "list_sort",
	117	.test_cases = list_sort_cases,
	118	};
	119
	120	kunit_test_suites(&list_sort_suite);
e327fd7c	121
e327fd7c	122	MODULE_LICENSE("GPL");