[thirdparty/kernel/linux.git] / lib / test_sysctl.c

// SPDX-License-Identifier: GPL-2.0-or-later OR copyleft-next-0.3.1
/*
 * proc sysctl test driver
 *
 * Copyright (C) 2017 Luis R. Rodriguez <mcgrof@kernel.org>
 */

/*
 * This module provides an interface to the proc sysctl interfaces.  This
 * driver requires CONFIG_PROC_SYSCTL. It will not normally be loaded by the
 * system unless explicitly requested by name. You can also build this driver
 * into your kernel.
 */

#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt

#include <linux/init.h>
#include <linux/list.h>
#include <linux/module.h>
#include <linux/printk.h>
#include <linux/fs.h>
#include <linux/miscdevice.h>
#include <linux/slab.h>
#include <linux/uaccess.h>
#include <linux/async.h>
#include <linux/delay.h>
#include <linux/vmalloc.h>

static int i_zero;
static int i_one_hundred = 100;
static int match_int_ok = 1;


static struct {
	struct ctl_table_header *test_h_setup_node;
	struct ctl_table_header *test_h_mnt;
	struct ctl_table_header *test_h_mnterror;
	struct ctl_table_header *empty_add;
	struct ctl_table_header *empty;
} sysctl_test_headers;

struct test_sysctl_data {
	int int_0001;
	int int_0002;
	int int_0003[4];

	int boot_int;

	unsigned int uint_0001;

	char string_0001[65];

#define SYSCTL_TEST_BITMAP_SIZE	65536
	unsigned long *bitmap_0001;
};

static struct test_sysctl_data test_data = {
	.int_0001 = 60,
	.int_0002 = 1,

	.int_0003[0] = 0,
	.int_0003[1] = 1,
	.int_0003[2] = 2,
	.int_0003[3] = 3,

	.boot_int = 0,

	.uint_0001 = 314,

	.string_0001 = "(none)",
};

/* These are all under /proc/sys/debug/test_sysctl/ */
static struct ctl_table test_table[] = {
	{
		.procname	= "int_0001",
		.data		= &test_data.int_0001,
		.maxlen		= sizeof(int),
		.mode		= 0644,
		.proc_handler	= proc_dointvec_minmax,
		.extra1		= &i_zero,
		.extra2         = &i_one_hundred,
	},
	{
		.procname	= "int_0002",
		.data		= &test_data.int_0002,
		.maxlen		= sizeof(int),
		.mode		= 0644,
		.proc_handler	= proc_dointvec,
	},
	{
		.procname	= "int_0003",
		.data		= &test_data.int_0003,
		.maxlen		= sizeof(test_data.int_0003),
		.mode		= 0644,
		.proc_handler	= proc_dointvec,
	},
	{
		.procname	= "match_int",
		.data		= &match_int_ok,
		.maxlen		= sizeof(match_int_ok),
		.mode		= 0444,
		.proc_handler	= proc_dointvec,
	},
	{
		.procname	= "boot_int",
		.data		= &test_data.boot_int,
		.maxlen		= sizeof(test_data.boot_int),
		.mode		= 0644,
		.proc_handler	= proc_dointvec,
		.extra1		= SYSCTL_ZERO,
		.extra2         = SYSCTL_ONE,
	},
	{
		.procname	= "uint_0001",
		.data		= &test_data.uint_0001,
		.maxlen		= sizeof(unsigned int),
		.mode		= 0644,
		.proc_handler	= proc_douintvec,
	},
	{
		.procname	= "string_0001",
		.data		= &test_data.string_0001,
		.maxlen		= sizeof(test_data.string_0001),
		.mode		= 0644,
		.proc_handler	= proc_dostring,
	},
	{
		.procname	= "bitmap_0001",
		.data		= &test_data.bitmap_0001,
		.maxlen		= SYSCTL_TEST_BITMAP_SIZE,
		.mode		= 0644,
		.proc_handler	= proc_do_large_bitmap,
	},
};

static void test_sysctl_calc_match_int_ok(void)
{
	int i;

	struct {
		int defined;
		int wanted;
	} match_int[] = {
		{.defined = *(int *)SYSCTL_ZERO,	.wanted = 0},
		{.defined = *(int *)SYSCTL_ONE,		.wanted = 1},
		{.defined = *(int *)SYSCTL_TWO,		.wanted = 2},
		{.defined = *(int *)SYSCTL_THREE,	.wanted = 3},
		{.defined = *(int *)SYSCTL_FOUR,	.wanted = 4},
		{.defined = *(int *)SYSCTL_ONE_HUNDRED, .wanted = 100},
		{.defined = *(int *)SYSCTL_TWO_HUNDRED,	.wanted = 200},
		{.defined = *(int *)SYSCTL_ONE_THOUSAND, .wanted = 1000},
		{.defined = *(int *)SYSCTL_THREE_THOUSAND, .wanted = 3000},
		{.defined = *(int *)SYSCTL_INT_MAX,	.wanted = INT_MAX},
		{.defined = *(int *)SYSCTL_MAXOLDUID,	.wanted = 65535},
		{.defined = *(int *)SYSCTL_NEG_ONE,	.wanted = -1},
	};

	for (i = 0; i < ARRAY_SIZE(match_int); i++)
		if (match_int[i].defined != match_int[i].wanted)
			match_int_ok = 0;
}

static int test_sysctl_setup_node_tests(void)
{
	test_sysctl_calc_match_int_ok();
	test_data.bitmap_0001 = kzalloc(SYSCTL_TEST_BITMAP_SIZE/8, GFP_KERNEL);
	if (!test_data.bitmap_0001)
		return -ENOMEM;
	sysctl_test_headers.test_h_setup_node = register_sysctl("debug/test_sysctl", test_table);
	if (!sysctl_test_headers.test_h_setup_node) {
		kfree(test_data.bitmap_0001);
		return -ENOMEM;
	}

	return 0;
}

/* Used to test that unregister actually removes the directory */
static struct ctl_table test_table_unregister[] = {
	{
		.procname	= "unregister_error",
		.data		= &test_data.int_0001,
		.maxlen		= sizeof(int),
		.mode		= 0644,
		.proc_handler	= proc_dointvec_minmax,
	},
};

static int test_sysctl_run_unregister_nested(void)
{
	struct ctl_table_header *unregister;

	unregister = register_sysctl("debug/test_sysctl/unregister_error",
				   test_table_unregister);
	if (!unregister)
		return -ENOMEM;

	unregister_sysctl_table(unregister);
	return 0;
}

static int test_sysctl_run_register_mount_point(void)
{
	sysctl_test_headers.test_h_mnt
		= register_sysctl_mount_point("debug/test_sysctl/mnt");
	if (!sysctl_test_headers.test_h_mnt)
		return -ENOMEM;

	sysctl_test_headers.test_h_mnterror
		= register_sysctl("debug/test_sysctl/mnt/mnt_error",
				  test_table_unregister);
	/*
	 * Don't check the result.:
	 * If it fails (expected behavior), return 0.
	 * If successful (missbehavior of register mount point), we want to see
	 * mnt_error when we run the sysctl test script
	 */

	return 0;
}

static struct ctl_table test_table_empty[] = { };

static int test_sysctl_run_register_empty(void)
{
	/* Tets that an empty dir can be created */
	sysctl_test_headers.empty_add
		= register_sysctl("debug/test_sysctl/empty_add", test_table_empty);
	if (!sysctl_test_headers.empty_add)
		return -ENOMEM;

	/* Test that register on top of an empty dir works */
	sysctl_test_headers.empty
		= register_sysctl("debug/test_sysctl/empty_add/empty", test_table_empty);
	if (!sysctl_test_headers.empty)
		return -ENOMEM;

	return 0;
}

static int __init test_sysctl_init(void)
{
	int err;

	err = test_sysctl_setup_node_tests();
	if (err)
		goto out;

	err = test_sysctl_run_unregister_nested();
	if (err)
		goto out;

	err = test_sysctl_run_register_mount_point();
	if (err)
		goto out;

	err = test_sysctl_run_register_empty();

out:
	return err;
}
module_init(test_sysctl_init);

static void __exit test_sysctl_exit(void)
{
	kfree(test_data.bitmap_0001);
	if (sysctl_test_headers.test_h_setup_node)
		unregister_sysctl_table(sysctl_test_headers.test_h_setup_node);
	if (sysctl_test_headers.test_h_mnt)
		unregister_sysctl_table(sysctl_test_headers.test_h_mnt);
	if (sysctl_test_headers.test_h_mnterror)
		unregister_sysctl_table(sysctl_test_headers.test_h_mnterror);
	if (sysctl_test_headers.empty)
		unregister_sysctl_table(sysctl_test_headers.empty);
	if (sysctl_test_headers.empty_add)
		unregister_sysctl_table(sysctl_test_headers.empty_add);
}

module_exit(test_sysctl_exit);

MODULE_AUTHOR("Luis R. Rodriguez <mcgrof@kernel.org>");
MODULE_LICENSE("GPL");
Commit	Line	Data
6cad1ecd	1	// SPDX-License-Identifier: GPL-2.0-or-later OR copyleft-next-0.3.1
9308f2f9 LR	2	/*
	3	* proc sysctl test driver
	4	*
	5	* Copyright (C) 2017 Luis R. Rodriguez <mcgrof@kernel.org>
9308f2f9 LR	6	*/
	7
	8	/*
2d046981	9	* This module provides an interface to the proc sysctl interfaces. This
9308f2f9 LR	10	* driver requires CONFIG_PROC_SYSCTL. It will not normally be loaded by the
	11	* system unless explicitly requested by name. You can also build this driver
	12	* into your kernel.
	13	*/
	14
	15	#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
	16
	17	#include <linux/init.h>
	18	#include <linux/list.h>
	19	#include <linux/module.h>
	20	#include <linux/printk.h>
	21	#include <linux/fs.h>
	22	#include <linux/miscdevice.h>
	23	#include <linux/slab.h>
	24	#include <linux/uaccess.h>
	25	#include <linux/async.h>
	26	#include <linux/delay.h>
	27	#include <linux/vmalloc.h>
	28
	29	static int i_zero;
	30	static int i_one_hundred = 100;
57b19468	31	static int match_int_ok = 1;
9308f2f9	32
f2e7a626 JG	33
	34	static struct {
	35	struct ctl_table_header *test_h_setup_node;
	36	struct ctl_table_header *test_h_mnt;
	37	struct ctl_table_header *test_h_mnterror;
77774077 JG	38	struct ctl_table_header *empty_add;
77774077 JG	39	struct ctl_table_header *empty;
f2e7a626 JG	40	} sysctl_test_headers;
f2e7a626 JG	41
9308f2f9 LR	42	struct test_sysctl_data {
9308f2f9 LR	43	int int_0001;
eb965eda	44	int int_0002;
7c43a657	45	int int_0003[4];
eb965eda	46
4f2f682d VB	47	int boot_int;
4f2f682d VB	48
2920fad3 LR	49	unsigned int uint_0001;
2920fad3 LR	50
9308f2f9	51	char string_0001[65];
2ea622b8 ES	52
	53	#define SYSCTL_TEST_BITMAP_SIZE 65536
	54	unsigned long *bitmap_0001;
9308f2f9 LR	55	};
	56
	57	static struct test_sysctl_data test_data = {
	58	.int_0001 = 60,
eb965eda LR	59	.int_0002 = 1,
eb965eda LR	60
7c43a657 LR	61	.int_0003[0] = 0,
	62	.int_0003[1] = 1,
	63	.int_0003[2] = 2,
	64	.int_0003[3] = 3,
	65
4f2f682d VB	66	.boot_int = 0,
4f2f682d VB	67
2920fad3 LR	68	.uint_0001 = 314,
2920fad3 LR	69
9308f2f9 LR	70	.string_0001 = "(none)",
	71	};
	72
	73	/* These are all under /proc/sys/debug/test_sysctl/ */
	74	static struct ctl_table test_table[] = {
	75	{
	76	.procname = "int_0001",
	77	.data = &test_data.int_0001,
	78	.maxlen = sizeof(int),
	79	.mode = 0644,
	80	.proc_handler = proc_dointvec_minmax,
	81	.extra1 = &i_zero,
	82	.extra2 = &i_one_hundred,
	83	},
eb965eda LR	84	{
	85	.procname = "int_0002",
	86	.data = &test_data.int_0002,
	87	.maxlen = sizeof(int),
	88	.mode = 0644,
	89	.proc_handler = proc_dointvec,
	90	},
7c43a657 LR	91	{
	92	.procname = "int_0003",
	93	.data = &test_data.int_0003,
	94	.maxlen = sizeof(test_data.int_0003),
	95	.mode = 0644,
	96	.proc_handler = proc_dointvec,
	97	},
57b19468 TZ	98	{
	99	.procname = "match_int",
	100	.data = &match_int_ok,
	101	.maxlen = sizeof(match_int_ok),
	102	.mode = 0444,
	103	.proc_handler = proc_dointvec,
	104	},
4f2f682d VB	105	{
	106	.procname = "boot_int",
	107	.data = &test_data.boot_int,
	108	.maxlen = sizeof(test_data.boot_int),
	109	.mode = 0644,
	110	.proc_handler = proc_dointvec,
	111	.extra1 = SYSCTL_ZERO,
	112	.extra2 = SYSCTL_ONE,
	113	},
2920fad3 LR	114	{
	115	.procname = "uint_0001",
	116	.data = &test_data.uint_0001,
	117	.maxlen = sizeof(unsigned int),
	118	.mode = 0644,
	119	.proc_handler = proc_douintvec,
	120	},
9308f2f9 LR	121	{
	122	.procname = "string_0001",
	123	.data = &test_data.string_0001,
	124	.maxlen = sizeof(test_data.string_0001),
	125	.mode = 0644,
	126	.proc_handler = proc_dostring,
	127	},
2ea622b8 ES	128	{
	129	.procname = "bitmap_0001",
	130	.data = &test_data.bitmap_0001,
	131	.maxlen = SYSCTL_TEST_BITMAP_SIZE,
	132	.mode = 0644,
	133	.proc_handler = proc_do_large_bitmap,
	134	},
9308f2f9 LR	135	};
9308f2f9 LR	136
e009bd5e	137	static void test_sysctl_calc_match_int_ok(void)
9308f2f9	138	{
57b19468 TZ	139	int i;
	140
	141	struct {
	142	int defined;
	143	int wanted;
	144	} match_int[] = {
	145	{.defined = (int )SYSCTL_ZERO, .wanted = 0},
	146	{.defined = (int )SYSCTL_ONE, .wanted = 1},
	147	{.defined = (int )SYSCTL_TWO, .wanted = 2},
	148	{.defined = (int )SYSCTL_THREE, .wanted = 3},
	149	{.defined = (int )SYSCTL_FOUR, .wanted = 4},
	150	{.defined = (int )SYSCTL_ONE_HUNDRED, .wanted = 100},
	151	{.defined = (int )SYSCTL_TWO_HUNDRED, .wanted = 200},
	152	{.defined = (int )SYSCTL_ONE_THOUSAND, .wanted = 1000},
	153	{.defined = (int )SYSCTL_THREE_THOUSAND, .wanted = 3000},
	154	{.defined = (int )SYSCTL_INT_MAX, .wanted = INT_MAX},
	155	{.defined = (int )SYSCTL_MAXOLDUID, .wanted = 65535},
	156	{.defined = (int )SYSCTL_NEG_ONE, .wanted = -1},
	157	};
	158
	159	for (i = 0; i < ARRAY_SIZE(match_int); i++)
	160	if (match_int[i].defined != match_int[i].wanted)
	161	match_int_ok = 0;
e009bd5e	162	}
57b19468	163
e009bd5e JG	164	static int test_sysctl_setup_node_tests(void)
	165	{
	166	test_sysctl_calc_match_int_ok();
2ea622b8 ES	167	test_data.bitmap_0001 = kzalloc(SYSCTL_TEST_BITMAP_SIZE/8, GFP_KERNEL);
	168	if (!test_data.bitmap_0001)
	169	return -ENOMEM;
f2e7a626 JG	170	sysctl_test_headers.test_h_setup_node = register_sysctl("debug/test_sysctl", test_table);
f2e7a626 JG	171	if (!sysctl_test_headers.test_h_setup_node) {
2ea622b8	172	kfree(test_data.bitmap_0001);
9308f2f9	173	return -ENOMEM;
2ea622b8	174	}
e009bd5e	175
9308f2f9 LR	176	return 0;
9308f2f9 LR	177	}
e009bd5e	178
35576438 JG	179	/* Used to test that unregister actually removes the directory */
	180	static struct ctl_table test_table_unregister[] = {
	181	{
	182	.procname = "unregister_error",
	183	.data = &test_data.int_0001,
	184	.maxlen = sizeof(int),
	185	.mode = 0644,
	186	.proc_handler = proc_dointvec_minmax,
	187	},
35576438 JG	188	};
	189
	190	static int test_sysctl_run_unregister_nested(void)
	191	{
	192	struct ctl_table_header *unregister;
	193
	194	unregister = register_sysctl("debug/test_sysctl/unregister_error",
	195	test_table_unregister);
	196	if (!unregister)
	197	return -ENOMEM;
	198
	199	unregister_sysctl_table(unregister);
	200	return 0;
	201	}
	202
f2e7a626 JG	203	static int test_sysctl_run_register_mount_point(void)
	204	{
	205	sysctl_test_headers.test_h_mnt
	206	= register_sysctl_mount_point("debug/test_sysctl/mnt");
	207	if (!sysctl_test_headers.test_h_mnt)
	208	return -ENOMEM;
	209
	210	sysctl_test_headers.test_h_mnterror
	211	= register_sysctl("debug/test_sysctl/mnt/mnt_error",
	212	test_table_unregister);
	213	/*
	214	* Don't check the result.:
	215	* If it fails (expected behavior), return 0.
	216	* If successful (missbehavior of register mount point), we want to see
	217	* mnt_error when we run the sysctl test script
	218	*/
	219
	220	return 0;
	221	}
	222
77774077 JG	223	static struct ctl_table test_table_empty[] = { };
	224
	225	static int test_sysctl_run_register_empty(void)
	226	{
	227	/* Tets that an empty dir can be created */
	228	sysctl_test_headers.empty_add
	229	= register_sysctl("debug/test_sysctl/empty_add", test_table_empty);
	230	if (!sysctl_test_headers.empty_add)
	231	return -ENOMEM;
	232
	233	/* Test that register on top of an empty dir works */
	234	sysctl_test_headers.empty
	235	= register_sysctl("debug/test_sysctl/empty_add/empty", test_table_empty);
	236	if (!sysctl_test_headers.empty)
	237	return -ENOMEM;
	238
	239	return 0;
	240	}
	241
e009bd5e JG	242	static int __init test_sysctl_init(void)
	243	{
	244	int err;
	245
	246	err = test_sysctl_setup_node_tests();
35576438 JG	247	if (err)
	248	goto out;
	249
	250	err = test_sysctl_run_unregister_nested();
f2e7a626 JG	251	if (err)
	252	goto out;
	253
	254	err = test_sysctl_run_register_mount_point();
77774077 JG	255	if (err)
	256	goto out;
	257
	258	err = test_sysctl_run_register_empty();
e009bd5e	259
35576438	260	out:
e009bd5e JG	261	return err;
e009bd5e JG	262	}
2f56f845	263	module_init(test_sysctl_init);
9308f2f9 LR	264
	265	static void __exit test_sysctl_exit(void)
	266	{
2ea622b8	267	kfree(test_data.bitmap_0001);
f2e7a626 JG	268	if (sysctl_test_headers.test_h_setup_node)
	269	unregister_sysctl_table(sysctl_test_headers.test_h_setup_node);
	270	if (sysctl_test_headers.test_h_mnt)
	271	unregister_sysctl_table(sysctl_test_headers.test_h_mnt);
	272	if (sysctl_test_headers.test_h_mnterror)
	273	unregister_sysctl_table(sysctl_test_headers.test_h_mnterror);
77774077 JG	274	if (sysctl_test_headers.empty)
	275	unregister_sysctl_table(sysctl_test_headers.empty);
	276	if (sysctl_test_headers.empty_add)
	277	unregister_sysctl_table(sysctl_test_headers.empty_add);
9308f2f9 LR	278	}
	279
	280	module_exit(test_sysctl_exit);
	281
	282	MODULE_AUTHOR("Luis R. Rodriguez <mcgrof@kernel.org>");
	283	MODULE_LICENSE("GPL");