xref: /OK3568_Linux_fs/kernel/lib/test_ubsan.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0
2*4882a593Smuzhiyun #include <linux/init.h>
3*4882a593Smuzhiyun #include <linux/kernel.h>
4*4882a593Smuzhiyun #include <linux/module.h>
5*4882a593Smuzhiyun 
6*4882a593Smuzhiyun typedef void(*test_ubsan_fp)(void);
7*4882a593Smuzhiyun 
8*4882a593Smuzhiyun #define UBSAN_TEST(config, ...)	do {					\
9*4882a593Smuzhiyun 		pr_info("%s " __VA_ARGS__ "%s(%s=%s)\n", __func__,	\
10*4882a593Smuzhiyun 			sizeof(" " __VA_ARGS__) > 2 ? " " : "",		\
11*4882a593Smuzhiyun 			#config, IS_ENABLED(config) ? "y" : "n");	\
12*4882a593Smuzhiyun 	} while (0)
13*4882a593Smuzhiyun 
test_ubsan_divrem_overflow(void)14*4882a593Smuzhiyun static void test_ubsan_divrem_overflow(void)
15*4882a593Smuzhiyun {
16*4882a593Smuzhiyun 	volatile int val = 16;
17*4882a593Smuzhiyun 	volatile int val2 = 0;
18*4882a593Smuzhiyun 
19*4882a593Smuzhiyun 	UBSAN_TEST(CONFIG_UBSAN_DIV_ZERO);
20*4882a593Smuzhiyun 	val /= val2;
21*4882a593Smuzhiyun }
22*4882a593Smuzhiyun 
test_ubsan_shift_out_of_bounds(void)23*4882a593Smuzhiyun static void test_ubsan_shift_out_of_bounds(void)
24*4882a593Smuzhiyun {
25*4882a593Smuzhiyun 	volatile int neg = -1, wrap = 4;
26*4882a593Smuzhiyun 	int val1 = 10;
27*4882a593Smuzhiyun 	int val2 = INT_MAX;
28*4882a593Smuzhiyun 
29*4882a593Smuzhiyun 	UBSAN_TEST(CONFIG_UBSAN_SHIFT, "negative exponent");
30*4882a593Smuzhiyun 	val1 <<= neg;
31*4882a593Smuzhiyun 
32*4882a593Smuzhiyun 	UBSAN_TEST(CONFIG_UBSAN_SHIFT, "left overflow");
33*4882a593Smuzhiyun 	val2 <<= wrap;
34*4882a593Smuzhiyun }
35*4882a593Smuzhiyun 
test_ubsan_out_of_bounds(void)36*4882a593Smuzhiyun static void test_ubsan_out_of_bounds(void)
37*4882a593Smuzhiyun {
38*4882a593Smuzhiyun 	volatile int i = 4, j = 5, k = -1;
39*4882a593Smuzhiyun 	volatile char above[4] = { }; /* Protect surrounding memory. */
40*4882a593Smuzhiyun 	volatile int arr[4];
41*4882a593Smuzhiyun 	volatile char below[4] = { }; /* Protect surrounding memory. */
42*4882a593Smuzhiyun 
43*4882a593Smuzhiyun 	above[0] = below[0];
44*4882a593Smuzhiyun 
45*4882a593Smuzhiyun 	UBSAN_TEST(CONFIG_UBSAN_BOUNDS, "above");
46*4882a593Smuzhiyun 	arr[j] = i;
47*4882a593Smuzhiyun 
48*4882a593Smuzhiyun 	UBSAN_TEST(CONFIG_UBSAN_BOUNDS, "below");
49*4882a593Smuzhiyun 	arr[k] = i;
50*4882a593Smuzhiyun }
51*4882a593Smuzhiyun 
52*4882a593Smuzhiyun enum ubsan_test_enum {
53*4882a593Smuzhiyun 	UBSAN_TEST_ZERO = 0,
54*4882a593Smuzhiyun 	UBSAN_TEST_ONE,
55*4882a593Smuzhiyun 	UBSAN_TEST_MAX,
56*4882a593Smuzhiyun };
57*4882a593Smuzhiyun 
test_ubsan_load_invalid_value(void)58*4882a593Smuzhiyun static void test_ubsan_load_invalid_value(void)
59*4882a593Smuzhiyun {
60*4882a593Smuzhiyun 	volatile char *dst, *src;
61*4882a593Smuzhiyun 	bool val, val2, *ptr;
62*4882a593Smuzhiyun 	enum ubsan_test_enum eval, eval2, *eptr;
63*4882a593Smuzhiyun 	unsigned char c = 0xff;
64*4882a593Smuzhiyun 
65*4882a593Smuzhiyun 	UBSAN_TEST(CONFIG_UBSAN_BOOL, "bool");
66*4882a593Smuzhiyun 	dst = (char *)&val;
67*4882a593Smuzhiyun 	src = &c;
68*4882a593Smuzhiyun 	*dst = *src;
69*4882a593Smuzhiyun 
70*4882a593Smuzhiyun 	ptr = &val2;
71*4882a593Smuzhiyun 	val2 = val;
72*4882a593Smuzhiyun 
73*4882a593Smuzhiyun 	UBSAN_TEST(CONFIG_UBSAN_ENUM, "enum");
74*4882a593Smuzhiyun 	dst = (char *)&eval;
75*4882a593Smuzhiyun 	src = &c;
76*4882a593Smuzhiyun 	*dst = *src;
77*4882a593Smuzhiyun 
78*4882a593Smuzhiyun 	eptr = &eval2;
79*4882a593Smuzhiyun 	eval2 = eval;
80*4882a593Smuzhiyun }
81*4882a593Smuzhiyun 
test_ubsan_null_ptr_deref(void)82*4882a593Smuzhiyun static void test_ubsan_null_ptr_deref(void)
83*4882a593Smuzhiyun {
84*4882a593Smuzhiyun 	volatile int *ptr = NULL;
85*4882a593Smuzhiyun 	int val;
86*4882a593Smuzhiyun 
87*4882a593Smuzhiyun 	UBSAN_TEST(CONFIG_UBSAN_OBJECT_SIZE);
88*4882a593Smuzhiyun 	val = *ptr;
89*4882a593Smuzhiyun }
90*4882a593Smuzhiyun 
test_ubsan_misaligned_access(void)91*4882a593Smuzhiyun static void test_ubsan_misaligned_access(void)
92*4882a593Smuzhiyun {
93*4882a593Smuzhiyun 	volatile char arr[5] __aligned(4) = {1, 2, 3, 4, 5};
94*4882a593Smuzhiyun 	volatile int *ptr, val = 6;
95*4882a593Smuzhiyun 
96*4882a593Smuzhiyun 	UBSAN_TEST(CONFIG_UBSAN_ALIGNMENT);
97*4882a593Smuzhiyun 	ptr = (int *)(arr + 1);
98*4882a593Smuzhiyun 	*ptr = val;
99*4882a593Smuzhiyun }
100*4882a593Smuzhiyun 
101*4882a593Smuzhiyun static const test_ubsan_fp test_ubsan_array[] = {
102*4882a593Smuzhiyun 	test_ubsan_shift_out_of_bounds,
103*4882a593Smuzhiyun 	test_ubsan_out_of_bounds,
104*4882a593Smuzhiyun 	test_ubsan_load_invalid_value,
105*4882a593Smuzhiyun 	test_ubsan_misaligned_access,
106*4882a593Smuzhiyun };
107*4882a593Smuzhiyun 
108*4882a593Smuzhiyun /* Excluded because they Oops the module. */
109*4882a593Smuzhiyun static const test_ubsan_fp skip_ubsan_array[] = {
110*4882a593Smuzhiyun 	test_ubsan_divrem_overflow,
111*4882a593Smuzhiyun 	test_ubsan_null_ptr_deref,
112*4882a593Smuzhiyun };
113*4882a593Smuzhiyun 
test_ubsan_init(void)114*4882a593Smuzhiyun static int __init test_ubsan_init(void)
115*4882a593Smuzhiyun {
116*4882a593Smuzhiyun 	unsigned int i;
117*4882a593Smuzhiyun 
118*4882a593Smuzhiyun 	for (i = 0; i < ARRAY_SIZE(test_ubsan_array); i++)
119*4882a593Smuzhiyun 		test_ubsan_array[i]();
120*4882a593Smuzhiyun 
121*4882a593Smuzhiyun 	return 0;
122*4882a593Smuzhiyun }
123*4882a593Smuzhiyun module_init(test_ubsan_init);
124*4882a593Smuzhiyun 
test_ubsan_exit(void)125*4882a593Smuzhiyun static void __exit test_ubsan_exit(void)
126*4882a593Smuzhiyun {
127*4882a593Smuzhiyun 	/* do nothing */
128*4882a593Smuzhiyun }
129*4882a593Smuzhiyun module_exit(test_ubsan_exit);
130*4882a593Smuzhiyun 
131*4882a593Smuzhiyun MODULE_AUTHOR("Jinbum Park <jinb.park7@gmail.com>");
132*4882a593Smuzhiyun MODULE_LICENSE("GPL v2");
133