blob: 8036aa91a1cbd5cedeec9cdd73fb42702072a1d6 [file] [log] [blame]
Luis Chamberlain6cad1ec2022-10-03 09:58:49 -07001// SPDX-License-Identifier: GPL-2.0-or-later OR copyleft-next-0.3.1
Luis R. Rodriguez9308f2f2017-07-12 14:33:43 -07002/*
3 * proc sysctl test driver
4 *
5 * Copyright (C) 2017 Luis R. Rodriguez <mcgrof@kernel.org>
Luis R. Rodriguez9308f2f2017-07-12 14:33:43 -07006 */
7
8/*
Randy Dunlap2d046982020-10-15 20:11:10 -07009 * This module provides an interface to the proc sysctl interfaces. This
Luis R. Rodriguez9308f2f2017-07-12 14:33:43 -070010 * 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
29static int i_zero;
30static int i_one_hundred = 100;
Tonghao Zhang57b19462022-05-01 11:55:24 +080031static int match_int_ok = 1;
Luis R. Rodriguez9308f2f2017-07-12 14:33:43 -070032
Joel Granadosf2e7a622023-06-16 10:59:20 +020033
34static 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;
38} sysctl_test_headers;
39
Luis R. Rodriguez9308f2f2017-07-12 14:33:43 -070040struct test_sysctl_data {
41 int int_0001;
Luis R. Rodriguezeb965ed2017-07-12 14:33:52 -070042 int int_0002;
Luis R. Rodriguez7c43a652017-07-12 14:33:58 -070043 int int_0003[4];
Luis R. Rodriguezeb965ed2017-07-12 14:33:52 -070044
Vlastimil Babka4f2f6822020-06-07 21:40:38 -070045 int boot_int;
46
Luis R. Rodriguez2920fad2017-07-12 14:33:55 -070047 unsigned int uint_0001;
48
Luis R. Rodriguez9308f2f2017-07-12 14:33:43 -070049 char string_0001[65];
Eric Sandeen2ea622b2019-05-14 15:45:10 -070050
51#define SYSCTL_TEST_BITMAP_SIZE 65536
52 unsigned long *bitmap_0001;
Luis R. Rodriguez9308f2f2017-07-12 14:33:43 -070053};
54
55static struct test_sysctl_data test_data = {
56 .int_0001 = 60,
Luis R. Rodriguezeb965ed2017-07-12 14:33:52 -070057 .int_0002 = 1,
58
Luis R. Rodriguez7c43a652017-07-12 14:33:58 -070059 .int_0003[0] = 0,
60 .int_0003[1] = 1,
61 .int_0003[2] = 2,
62 .int_0003[3] = 3,
63
Vlastimil Babka4f2f6822020-06-07 21:40:38 -070064 .boot_int = 0,
65
Luis R. Rodriguez2920fad2017-07-12 14:33:55 -070066 .uint_0001 = 314,
67
Luis R. Rodriguez9308f2f2017-07-12 14:33:43 -070068 .string_0001 = "(none)",
69};
70
71/* These are all under /proc/sys/debug/test_sysctl/ */
72static struct ctl_table test_table[] = {
73 {
74 .procname = "int_0001",
75 .data = &test_data.int_0001,
76 .maxlen = sizeof(int),
77 .mode = 0644,
78 .proc_handler = proc_dointvec_minmax,
79 .extra1 = &i_zero,
80 .extra2 = &i_one_hundred,
81 },
82 {
Luis R. Rodriguezeb965ed2017-07-12 14:33:52 -070083 .procname = "int_0002",
84 .data = &test_data.int_0002,
85 .maxlen = sizeof(int),
86 .mode = 0644,
87 .proc_handler = proc_dointvec,
88 },
89 {
Luis R. Rodriguez7c43a652017-07-12 14:33:58 -070090 .procname = "int_0003",
91 .data = &test_data.int_0003,
92 .maxlen = sizeof(test_data.int_0003),
93 .mode = 0644,
94 .proc_handler = proc_dointvec,
95 },
96 {
Tonghao Zhang57b19462022-05-01 11:55:24 +080097 .procname = "match_int",
98 .data = &match_int_ok,
99 .maxlen = sizeof(match_int_ok),
100 .mode = 0444,
101 .proc_handler = proc_dointvec,
102 },
103 {
Vlastimil Babka4f2f6822020-06-07 21:40:38 -0700104 .procname = "boot_int",
105 .data = &test_data.boot_int,
106 .maxlen = sizeof(test_data.boot_int),
107 .mode = 0644,
108 .proc_handler = proc_dointvec,
109 .extra1 = SYSCTL_ZERO,
110 .extra2 = SYSCTL_ONE,
111 },
112 {
Luis R. Rodriguez2920fad2017-07-12 14:33:55 -0700113 .procname = "uint_0001",
114 .data = &test_data.uint_0001,
115 .maxlen = sizeof(unsigned int),
116 .mode = 0644,
117 .proc_handler = proc_douintvec,
118 },
119 {
Luis R. Rodriguez9308f2f2017-07-12 14:33:43 -0700120 .procname = "string_0001",
121 .data = &test_data.string_0001,
122 .maxlen = sizeof(test_data.string_0001),
123 .mode = 0644,
124 .proc_handler = proc_dostring,
125 },
Eric Sandeen2ea622b2019-05-14 15:45:10 -0700126 {
127 .procname = "bitmap_0001",
128 .data = &test_data.bitmap_0001,
129 .maxlen = SYSCTL_TEST_BITMAP_SIZE,
130 .mode = 0644,
131 .proc_handler = proc_do_large_bitmap,
132 },
Luis R. Rodriguez9308f2f2017-07-12 14:33:43 -0700133 { }
134};
135
Joel Granadose009bd52023-06-16 10:59:17 +0200136static void test_sysctl_calc_match_int_ok(void)
Luis R. Rodriguez9308f2f2017-07-12 14:33:43 -0700137{
Tonghao Zhang57b19462022-05-01 11:55:24 +0800138 int i;
139
140 struct {
141 int defined;
142 int wanted;
143 } match_int[] = {
144 {.defined = *(int *)SYSCTL_ZERO, .wanted = 0},
145 {.defined = *(int *)SYSCTL_ONE, .wanted = 1},
146 {.defined = *(int *)SYSCTL_TWO, .wanted = 2},
147 {.defined = *(int *)SYSCTL_THREE, .wanted = 3},
148 {.defined = *(int *)SYSCTL_FOUR, .wanted = 4},
149 {.defined = *(int *)SYSCTL_ONE_HUNDRED, .wanted = 100},
150 {.defined = *(int *)SYSCTL_TWO_HUNDRED, .wanted = 200},
151 {.defined = *(int *)SYSCTL_ONE_THOUSAND, .wanted = 1000},
152 {.defined = *(int *)SYSCTL_THREE_THOUSAND, .wanted = 3000},
153 {.defined = *(int *)SYSCTL_INT_MAX, .wanted = INT_MAX},
154 {.defined = *(int *)SYSCTL_MAXOLDUID, .wanted = 65535},
155 {.defined = *(int *)SYSCTL_NEG_ONE, .wanted = -1},
156 };
157
158 for (i = 0; i < ARRAY_SIZE(match_int); i++)
159 if (match_int[i].defined != match_int[i].wanted)
160 match_int_ok = 0;
Joel Granadose009bd52023-06-16 10:59:17 +0200161}
Tonghao Zhang57b19462022-05-01 11:55:24 +0800162
Joel Granadose009bd52023-06-16 10:59:17 +0200163static int test_sysctl_setup_node_tests(void)
164{
165 test_sysctl_calc_match_int_ok();
Eric Sandeen2ea622b2019-05-14 15:45:10 -0700166 test_data.bitmap_0001 = kzalloc(SYSCTL_TEST_BITMAP_SIZE/8, GFP_KERNEL);
167 if (!test_data.bitmap_0001)
Luis R. Rodriguez9308f2f2017-07-12 14:33:43 -0700168 return -ENOMEM;
Joel Granadosf2e7a622023-06-16 10:59:20 +0200169 sysctl_test_headers.test_h_setup_node = register_sysctl("debug/test_sysctl", test_table);
170 if (!sysctl_test_headers.test_h_setup_node) {
Eric Sandeen2ea622b2019-05-14 15:45:10 -0700171 kfree(test_data.bitmap_0001);
172 return -ENOMEM;
173 }
Joel Granadose009bd52023-06-16 10:59:17 +0200174
Luis R. Rodriguez9308f2f2017-07-12 14:33:43 -0700175 return 0;
176}
Joel Granadose009bd52023-06-16 10:59:17 +0200177
Joel Granados35576432023-06-16 10:59:18 +0200178/* Used to test that unregister actually removes the directory */
179static struct ctl_table test_table_unregister[] = {
180 {
181 .procname = "unregister_error",
182 .data = &test_data.int_0001,
183 .maxlen = sizeof(int),
184 .mode = 0644,
185 .proc_handler = proc_dointvec_minmax,
186 },
187 {}
188};
189
190static 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
Joel Granadosf2e7a622023-06-16 10:59:20 +0200203static 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
Joel Granadose009bd52023-06-16 10:59:17 +0200223static int __init test_sysctl_init(void)
224{
225 int err;
226
227 err = test_sysctl_setup_node_tests();
Joel Granados35576432023-06-16 10:59:18 +0200228 if (err)
229 goto out;
Joel Granadose009bd52023-06-16 10:59:17 +0200230
Joel Granados35576432023-06-16 10:59:18 +0200231 err = test_sysctl_run_unregister_nested();
Joel Granadosf2e7a622023-06-16 10:59:20 +0200232 if (err)
233 goto out;
234
235 err = test_sysctl_run_register_mount_point();
Joel Granados35576432023-06-16 10:59:18 +0200236
237out:
Joel Granadose009bd52023-06-16 10:59:17 +0200238 return err;
239}
Masami Hiramatsu2f56f842020-05-28 23:52:16 +0900240module_init(test_sysctl_init);
Luis R. Rodriguez9308f2f2017-07-12 14:33:43 -0700241
242static void __exit test_sysctl_exit(void)
243{
Eric Sandeen2ea622b2019-05-14 15:45:10 -0700244 kfree(test_data.bitmap_0001);
Joel Granadosf2e7a622023-06-16 10:59:20 +0200245 if (sysctl_test_headers.test_h_setup_node)
246 unregister_sysctl_table(sysctl_test_headers.test_h_setup_node);
247 if (sysctl_test_headers.test_h_mnt)
248 unregister_sysctl_table(sysctl_test_headers.test_h_mnt);
249 if (sysctl_test_headers.test_h_mnterror)
250 unregister_sysctl_table(sysctl_test_headers.test_h_mnterror);
Luis R. Rodriguez9308f2f2017-07-12 14:33:43 -0700251}
252
253module_exit(test_sysctl_exit);
254
255MODULE_AUTHOR("Luis R. Rodriguez <mcgrof@kernel.org>");
256MODULE_LICENSE("GPL");