[linux.git] / lib / test_ida.c

// SPDX-License-Identifier: GPL-2.0+
/*
 * test_ida.c: Test the IDA API
 * Copyright (c) 2016-2018 Microsoft Corporation
 * Copyright (c) 2018 Oracle Corporation
 * Author: Matthew Wilcox <[email protected]>
 */

#include <linux/idr.h>
#include <linux/module.h>

static unsigned int tests_run;
static unsigned int tests_passed;

#ifdef __KERNEL__
static void ida_dump(struct ida *ida) { }
#endif
#define IDA_BUG_ON(ida, x) do {						\
	tests_run++;							\
	if (x) {							\
		ida_dump(ida);						\
		dump_stack();						\
	} else {							\
		tests_passed++;						\
	}								\
} while (0)

/*
 * Straightforward checks that allocating and freeing IDs work.
 */
static void ida_check_alloc(struct ida *ida)
{
	int i, id;

	for (i = 0; i < 10000; i++)
		IDA_BUG_ON(ida, ida_alloc(ida, GFP_KERNEL) != i);

	ida_free(ida, 20);
	ida_free(ida, 21);
	for (i = 0; i < 3; i++) {
		id = ida_alloc(ida, GFP_KERNEL);
		IDA_BUG_ON(ida, id < 0);
		if (i == 2)
			IDA_BUG_ON(ida, id != 10000);
	}

	for (i = 0; i < 5000; i++)
		ida_free(ida, i);

	IDA_BUG_ON(ida, ida_alloc_min(ida, 5000, GFP_KERNEL) != 10001);
	ida_destroy(ida);

	IDA_BUG_ON(ida, !ida_is_empty(ida));
}

/* Destroy an IDA with a single entry at @base */
static void ida_check_destroy_1(struct ida *ida, unsigned int base)
{
	IDA_BUG_ON(ida, ida_alloc_min(ida, base, GFP_KERNEL) != base);
	IDA_BUG_ON(ida, ida_is_empty(ida));
	ida_destroy(ida);
	IDA_BUG_ON(ida, !ida_is_empty(ida));
}

/* Check that ida_destroy and ida_is_empty work */
static void ida_check_destroy(struct ida *ida)
{
	/* Destroy an already-empty IDA */
	IDA_BUG_ON(ida, !ida_is_empty(ida));
	ida_destroy(ida);
	IDA_BUG_ON(ida, !ida_is_empty(ida));

	ida_check_destroy_1(ida, 0);
	ida_check_destroy_1(ida, 1);
	ida_check_destroy_1(ida, 1023);
	ida_check_destroy_1(ida, 1024);
	ida_check_destroy_1(ida, 12345678);
}

/*
 * Check what happens when we fill a leaf and then delete it.  This may
 * discover mishandling of IDR_FREE.
 */
static void ida_check_leaf(struct ida *ida, unsigned int base)
{
	unsigned long i;

	for (i = 0; i < IDA_BITMAP_BITS; i++) {
		IDA_BUG_ON(ida, ida_alloc_min(ida, base, GFP_KERNEL) !=
				base + i);
	}

	ida_destroy(ida);
	IDA_BUG_ON(ida, !ida_is_empty(ida));

	IDA_BUG_ON(ida, ida_alloc(ida, GFP_KERNEL) != 0);
	IDA_BUG_ON(ida, ida_is_empty(ida));
	ida_free(ida, 0);
	IDA_BUG_ON(ida, !ida_is_empty(ida));
}

/*
 * Check allocations up to and slightly above the maximum allowed (2^31-1) ID.
 * Allocating up to 2^31-1 should succeed, and then allocating the next one
 * should fail.
 */
static void ida_check_max(struct ida *ida)
{
	unsigned long i, j;

	for (j = 1; j < 65537; j *= 2) {
		unsigned long base = (1UL << 31) - j;
		for (i = 0; i < j; i++) {
			IDA_BUG_ON(ida, ida_alloc_min(ida, base, GFP_KERNEL) !=
					base + i);
		}
		IDA_BUG_ON(ida, ida_alloc_min(ida, base, GFP_KERNEL) !=
				-ENOSPC);
		ida_destroy(ida);
		IDA_BUG_ON(ida, !ida_is_empty(ida));
	}
}

/*
 * Check handling of conversions between exceptional entries and full bitmaps.
 */
static void ida_check_conv(struct ida *ida)
{
	unsigned long i;

	for (i = 0; i < IDA_BITMAP_BITS * 2; i += IDA_BITMAP_BITS) {
		IDA_BUG_ON(ida, ida_alloc_min(ida, i + 1, GFP_KERNEL) != i + 1);
		IDA_BUG_ON(ida, ida_alloc_min(ida, i + BITS_PER_LONG,
					GFP_KERNEL) != i + BITS_PER_LONG);
		ida_free(ida, i + 1);
		ida_free(ida, i + BITS_PER_LONG);
		IDA_BUG_ON(ida, !ida_is_empty(ida));
	}

	for (i = 0; i < IDA_BITMAP_BITS * 2; i++)
		IDA_BUG_ON(ida, ida_alloc(ida, GFP_KERNEL) != i);
	for (i = IDA_BITMAP_BITS * 2; i > 0; i--)
		ida_free(ida, i - 1);
	IDA_BUG_ON(ida, !ida_is_empty(ida));

	for (i = 0; i < IDA_BITMAP_BITS + BITS_PER_LONG - 4; i++)
		IDA_BUG_ON(ida, ida_alloc(ida, GFP_KERNEL) != i);
	for (i = IDA_BITMAP_BITS + BITS_PER_LONG - 4; i > 0; i--)
		ida_free(ida, i - 1);
	IDA_BUG_ON(ida, !ida_is_empty(ida));
}

/*
 * Check various situations where we attempt to free an ID we don't own.
 */
static void ida_check_bad_free(struct ida *ida)
{
	unsigned long i;

	printk("vvv Ignore \"not allocated\" warnings\n");
	/* IDA is empty; all of these will fail */
	ida_free(ida, 0);
	for (i = 0; i < 31; i++)
		ida_free(ida, 1 << i);

	/* IDA contains a single value entry */
	IDA_BUG_ON(ida, ida_alloc_min(ida, 3, GFP_KERNEL) != 3);
	ida_free(ida, 0);
	for (i = 0; i < 31; i++)
		ida_free(ida, 1 << i);

	/* IDA contains a single bitmap */
	IDA_BUG_ON(ida, ida_alloc_min(ida, 1023, GFP_KERNEL) != 1023);
	ida_free(ida, 0);
	for (i = 0; i < 31; i++)
		ida_free(ida, 1 << i);

	/* IDA contains a tree */
	IDA_BUG_ON(ida, ida_alloc_min(ida, (1 << 20) - 1, GFP_KERNEL) != (1 << 20) - 1);
	ida_free(ida, 0);
	for (i = 0; i < 31; i++)
		ida_free(ida, 1 << i);
	printk("^^^ \"not allocated\" warnings over\n");

	ida_free(ida, 3);
	ida_free(ida, 1023);
	ida_free(ida, (1 << 20) - 1);

	IDA_BUG_ON(ida, !ida_is_empty(ida));
}

static DEFINE_IDA(ida);

static int ida_checks(void)
{
	IDA_BUG_ON(&ida, !ida_is_empty(&ida));
	ida_check_alloc(&ida);
	ida_check_destroy(&ida);
	ida_check_leaf(&ida, 0);
	ida_check_leaf(&ida, 1024);
	ida_check_leaf(&ida, 1024 * 64);
	ida_check_max(&ida);
	ida_check_conv(&ida);
	ida_check_bad_free(&ida);

	printk("IDA: %u of %u tests passed\n", tests_passed, tests_run);
	return (tests_run != tests_passed) ? 0 : -EINVAL;
}

static void ida_exit(void)
{
}

module_init(ida_checks);
module_exit(ida_exit);
MODULE_AUTHOR("Matthew Wilcox <[email protected]>");
MODULE_LICENSE("GPL");
Commit	Line	Data
8ab8ba38 MW	1	// SPDX-License-Identifier: GPL-2.0+
	2	/*
	3	* test_ida.c: Test the IDA API
	4	* Copyright (c) 2016-2018 Microsoft Corporation
	5	* Copyright (c) 2018 Oracle Corporation
	6	* Author: Matthew Wilcox <[email protected]>
	7	*/
	8
	9	#include <linux/idr.h>
	10	#include <linux/module.h>
	11
	12	static unsigned int tests_run;
	13	static unsigned int tests_passed;
	14
	15	#ifdef __KERNEL__
fd6f52e3	16	static void ida_dump(struct ida *ida) { }
8ab8ba38 MW	17	#endif
	18	#define IDA_BUG_ON(ida, x) do { \
	19	tests_run++; \
	20	if (x) { \
	21	ida_dump(ida); \
	22	dump_stack(); \
	23	} else { \
	24	tests_passed++; \
	25	} \
	26	} while (0)
	27
f272668d MW	28	/*
	29	* Straightforward checks that allocating and freeing IDs work.
	30	*/
	31	static void ida_check_alloc(struct ida *ida)
	32	{
	33	int i, id;
	34
	35	for (i = 0; i < 10000; i++)
	36	IDA_BUG_ON(ida, ida_alloc(ida, GFP_KERNEL) != i);
	37
	38	ida_free(ida, 20);
	39	ida_free(ida, 21);
	40	for (i = 0; i < 3; i++) {
	41	id = ida_alloc(ida, GFP_KERNEL);
	42	IDA_BUG_ON(ida, id < 0);
	43	if (i == 2)
	44	IDA_BUG_ON(ida, id != 10000);
	45	}
	46
	47	for (i = 0; i < 5000; i++)
	48	ida_free(ida, i);
	49
	50	IDA_BUG_ON(ida, ida_alloc_min(ida, 5000, GFP_KERNEL) != 10001);
	51	ida_destroy(ida);
	52
	53	IDA_BUG_ON(ida, !ida_is_empty(ida));
	54	}
	55
	56	/* Destroy an IDA with a single entry at @base */
	57	static void ida_check_destroy_1(struct ida *ida, unsigned int base)
	58	{
	59	IDA_BUG_ON(ida, ida_alloc_min(ida, base, GFP_KERNEL) != base);
	60	IDA_BUG_ON(ida, ida_is_empty(ida));
	61	ida_destroy(ida);
	62	IDA_BUG_ON(ida, !ida_is_empty(ida));
	63	}
	64
	65	/* Check that ida_destroy and ida_is_empty work */
	66	static void ida_check_destroy(struct ida *ida)
	67	{
	68	/* Destroy an already-empty IDA */
	69	IDA_BUG_ON(ida, !ida_is_empty(ida));
	70	ida_destroy(ida);
	71	IDA_BUG_ON(ida, !ida_is_empty(ida));
	72
	73	ida_check_destroy_1(ida, 0);
	74	ida_check_destroy_1(ida, 1);
	75	ida_check_destroy_1(ida, 1023);
	76	ida_check_destroy_1(ida, 1024);
	77	ida_check_destroy_1(ida, 12345678);
	78	}
	79
0a385639 MW	80	/*
	81	* Check what happens when we fill a leaf and then delete it. This may
	82	* discover mishandling of IDR_FREE.
	83	*/
	84	static void ida_check_leaf(struct ida *ida, unsigned int base)
	85	{
	86	unsigned long i;
	87
	88	for (i = 0; i < IDA_BITMAP_BITS; i++) {
	89	IDA_BUG_ON(ida, ida_alloc_min(ida, base, GFP_KERNEL) !=
	90	base + i);
	91	}
	92
	93	ida_destroy(ida);
	94	IDA_BUG_ON(ida, !ida_is_empty(ida));
	95
	96	IDA_BUG_ON(ida, ida_alloc(ida, GFP_KERNEL) != 0);
	97	IDA_BUG_ON(ida, ida_is_empty(ida));
	98	ida_free(ida, 0);
	99	IDA_BUG_ON(ida, !ida_is_empty(ida));
	100	}
	101
161b47e3 MW	102	/*
	103	* Check allocations up to and slightly above the maximum allowed (2^31-1) ID.
	104	* Allocating up to 2^31-1 should succeed, and then allocating the next one
	105	* should fail.
	106	*/
	107	static void ida_check_max(struct ida *ida)
	108	{
	109	unsigned long i, j;
	110
	111	for (j = 1; j < 65537; j *= 2) {
	112	unsigned long base = (1UL << 31) - j;
	113	for (i = 0; i < j; i++) {
	114	IDA_BUG_ON(ida, ida_alloc_min(ida, base, GFP_KERNEL) !=
	115	base + i);
	116	}
	117	IDA_BUG_ON(ida, ida_alloc_min(ida, base, GFP_KERNEL) !=
	118	-ENOSPC);
	119	ida_destroy(ida);
	120	IDA_BUG_ON(ida, !ida_is_empty(ida));
	121	}
	122	}
	123
5c78b0b1 MW	124	/*
	125	* Check handling of conversions between exceptional entries and full bitmaps.
	126	*/
	127	static void ida_check_conv(struct ida *ida)
	128	{
	129	unsigned long i;
	130
	131	for (i = 0; i < IDA_BITMAP_BITS * 2; i += IDA_BITMAP_BITS) {
	132	IDA_BUG_ON(ida, ida_alloc_min(ida, i + 1, GFP_KERNEL) != i + 1);
	133	IDA_BUG_ON(ida, ida_alloc_min(ida, i + BITS_PER_LONG,
	134	GFP_KERNEL) != i + BITS_PER_LONG);
	135	ida_free(ida, i + 1);
	136	ida_free(ida, i + BITS_PER_LONG);
	137	IDA_BUG_ON(ida, !ida_is_empty(ida));
	138	}
	139
	140	for (i = 0; i < IDA_BITMAP_BITS * 2; i++)
	141	IDA_BUG_ON(ida, ida_alloc(ida, GFP_KERNEL) != i);
	142	for (i = IDA_BITMAP_BITS * 2; i > 0; i--)
	143	ida_free(ida, i - 1);
	144	IDA_BUG_ON(ida, !ida_is_empty(ida));
	145
	146	for (i = 0; i < IDA_BITMAP_BITS + BITS_PER_LONG - 4; i++)
	147	IDA_BUG_ON(ida, ida_alloc(ida, GFP_KERNEL) != i);
	148	for (i = IDA_BITMAP_BITS + BITS_PER_LONG - 4; i > 0; i--)
	149	ida_free(ida, i - 1);
	150	IDA_BUG_ON(ida, !ida_is_empty(ida));
	151	}
	152
af73483f MWO	153	/*
	154	* Check various situations where we attempt to free an ID we don't own.
	155	*/
	156	static void ida_check_bad_free(struct ida *ida)
	157	{
	158	unsigned long i;
	159
	160	printk("vvv Ignore \"not allocated\" warnings\n");
	161	/* IDA is empty; all of these will fail */
	162	ida_free(ida, 0);
	163	for (i = 0; i < 31; i++)
	164	ida_free(ida, 1 << i);
	165
	166	/* IDA contains a single value entry */
	167	IDA_BUG_ON(ida, ida_alloc_min(ida, 3, GFP_KERNEL) != 3);
	168	ida_free(ida, 0);
	169	for (i = 0; i < 31; i++)
	170	ida_free(ida, 1 << i);
	171
	172	/* IDA contains a single bitmap */
	173	IDA_BUG_ON(ida, ida_alloc_min(ida, 1023, GFP_KERNEL) != 1023);
	174	ida_free(ida, 0);
	175	for (i = 0; i < 31; i++)
	176	ida_free(ida, 1 << i);
	177
	178	/* IDA contains a tree */
	179	IDA_BUG_ON(ida, ida_alloc_min(ida, (1 << 20) - 1, GFP_KERNEL) != (1 << 20) - 1);
	180	ida_free(ida, 0);
	181	for (i = 0; i < 31; i++)
	182	ida_free(ida, 1 << i);
	183	printk("^^^ \"not allocated\" warnings over\n");
	184
	185	ida_free(ida, 3);
	186	ida_free(ida, 1023);
	187	ida_free(ida, (1 << 20) - 1);
	188
	189	IDA_BUG_ON(ida, !ida_is_empty(ida));
	190	}
	191
c994b129 MW	192	static DEFINE_IDA(ida);
c994b129 MW	193
8ab8ba38 MW	194	static int ida_checks(void)
8ab8ba38 MW	195	{
8ab8ba38	196	IDA_BUG_ON(&ida, !ida_is_empty(&ida));
f272668d MW	197	ida_check_alloc(&ida);
f272668d MW	198	ida_check_destroy(&ida);
0a385639 MW	199	ida_check_leaf(&ida, 0);
	200	ida_check_leaf(&ida, 1024);
	201	ida_check_leaf(&ida, 1024 * 64);
161b47e3	202	ida_check_max(&ida);
5c78b0b1	203	ida_check_conv(&ida);
af73483f	204	ida_check_bad_free(&ida);
8ab8ba38 MW	205
	206	printk("IDA: %u of %u tests passed\n", tests_passed, tests_run);
	207	return (tests_run != tests_passed) ? 0 : -EINVAL;
	208	}
	209
	210	static void ida_exit(void)
	211	{
	212	}
	213
	214	module_init(ida_checks);
	215	module_exit(ida_exit);
	216	MODULE_AUTHOR("Matthew Wilcox <[email protected]>");
	217	MODULE_LICENSE("GPL");