summaryrefslogtreecommitdiff
path: root/core/kernel/ubsan.c
blob: 53a920b19d31743660a11905def7b362eb587136 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
/*
 * Copyright (c) 2016, Linaro Limited
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#include <types_ext.h>
#include <kernel/panic.h>
#include <trace.h>
#include <string.h>

struct source_location {
	const char *file_name;
	uint32_t line;
	uint32_t column;
};

struct type_descriptor {
	uint16_t type_kind;
	uint16_t type_info;
	char type_name[1];
};

struct type_mismatch_data {
	struct source_location loc;
	struct type_descriptor *type;
	unsigned long alignment;
	unsigned char type_check_kind;
};

struct overflow_data {
	struct source_location loc;
	struct type_descriptor *type;
};

struct shift_out_of_bounds_data {
	struct source_location loc;
	struct type_descriptor *lhs_type;
	struct type_descriptor *rhs_type;
};

struct out_of_bounds_data {
	struct source_location loc;
	struct type_descriptor *array_type;
	struct type_descriptor *index_type;
};

struct unreachable_data {
	struct source_location loc;
};

struct vla_bound_data {
	struct source_location loc;
	struct type_descriptor *type;
};

struct invalid_value_data {
	struct source_location loc;
	struct type_descriptor *type;
};

struct nonnull_arg_data {
	struct source_location loc;
};

/*
 * When compiling with -fsanitize=undefined the compiler expects functions
 * with the following signatures. The functions are never called directly,
 * only when undefined behavior is detected in instrumented code.
 */
void __ubsan_handle_type_mismatch(struct type_mismatch_data *data,
				  unsigned long ptr);
void __ubsan_handle_add_overflow(struct overflow_data *data,
				  unsigned long lhs, unsigned long rhs);
void __ubsan_handle_sub_overflow(struct overflow_data *data,
				  unsigned long lhs, unsigned long rhs);
void __ubsan_handle_mul_overflow(struct overflow_data *data,
				  unsigned long lhs, unsigned long rhs);
void __ubsan_handle_negate_overflow(struct overflow_data *data,
				    unsigned long old_val);
void __ubsan_handle_divrem_overflow(struct overflow_data *data,
				    unsigned long lhs, unsigned long rhs);
void __ubsan_handle_shift_out_of_bounds(struct shift_out_of_bounds_data *data,
					unsigned long lhs, unsigned long rhs);
void __ubsan_handle_out_of_bounds(struct out_of_bounds_data *data,
				  unsigned long idx);
void __ubsan_handle_unreachable(struct unreachable_data *data);
void __ubsan_handle_missing_return(struct unreachable_data *data);
void __ubsan_handle_vla_bound_not_positive(struct vla_bound_data *data,
					   unsigned long bound);
void __ubsan_handle_load_invalid_value(struct invalid_value_data *data,
				       unsigned long val);
void __ubsan_handle_nonnull_arg(struct nonnull_arg_data *data, size_t arg_no);

static void print_loc(const char *func, struct source_location *loc)
{
	const char *f = func;
	const char func_prefix[] = "__ubsan_handle";

	if (!memcmp(f, func_prefix, sizeof(func_prefix) - 1))
		f += sizeof(func_prefix);

	EMSG_RAW("Undefined behavior %s at %s:%" PRIu32 " col %" PRIu32,
		 f, loc->file_name, loc->line, loc->column);
}


static volatile bool ubsan_panic = true;

void __ubsan_handle_type_mismatch(struct type_mismatch_data *data,
				  unsigned long ptr __unused)
{
	print_loc(__func__, &data->loc);
	if (ubsan_panic)
		panic();
}

void __ubsan_handle_add_overflow(struct overflow_data *data,
				 unsigned long lhs __unused,
				 unsigned long rhs __unused)
{
	print_loc(__func__, &data->loc);
	if (ubsan_panic)
		panic();
}

void __ubsan_handle_sub_overflow(struct overflow_data *data,
				 unsigned long lhs __unused,
				 unsigned long rhs __unused)
{
	print_loc(__func__, &data->loc);
	if (ubsan_panic)
		panic();
}

void __ubsan_handle_mul_overflow(struct overflow_data *data,
				 unsigned long lhs __unused,
				 unsigned long rhs __unused)
{
	print_loc(__func__, &data->loc);
	if (ubsan_panic)
		panic();
}

void __ubsan_handle_negate_overflow(struct overflow_data *data,
				    unsigned long old_val __unused)
{
	print_loc(__func__, &data->loc);
	if (ubsan_panic)
		panic();
}

void __ubsan_handle_divrem_overflow(struct overflow_data *data,
				    unsigned long lhs __unused,
				    unsigned long rhs __unused)
{
	print_loc(__func__, &data->loc);
	if (ubsan_panic)
		panic();
}

void __ubsan_handle_shift_out_of_bounds(struct shift_out_of_bounds_data *data,
					unsigned long lhs __unused,
					unsigned long rhs __unused)
{
	print_loc(__func__, &data->loc);
	if (ubsan_panic)
		panic();
}

void __ubsan_handle_out_of_bounds(struct out_of_bounds_data *data,
				  unsigned long idx __unused)
{
	print_loc(__func__, &data->loc);
	if (ubsan_panic)
		panic();
}

void __ubsan_handle_unreachable(struct unreachable_data *data)
{
	print_loc(__func__, &data->loc);
	if (ubsan_panic)
		panic();
}

void __noreturn __ubsan_handle_missing_return(struct unreachable_data *data)
{
	print_loc(__func__, &data->loc);
	panic();
}

void __ubsan_handle_vla_bound_not_positive(struct vla_bound_data *data,
					   unsigned long bound __unused)
{
	print_loc(__func__, &data->loc);
	if (ubsan_panic)
		panic();
}

void __ubsan_handle_load_invalid_value(struct invalid_value_data *data,
				       unsigned long val __unused)
{
	print_loc(__func__, &data->loc);
	if (ubsan_panic)
		panic();
}

void __ubsan_handle_nonnull_arg(struct nonnull_arg_data *data,
				size_t arg_no __unused)
{
	print_loc(__func__, &data->loc);
	if (ubsan_panic)
		panic();
}