Commit | Line | Data |
---|---|---|
b2441318 | 1 | /* SPDX-License-Identifier: GPL-2.0 */ |
0b24becc AR |
2 | #ifndef __MM_KASAN_KASAN_H |
3 | #define __MM_KASAN_KASAN_H | |
4 | ||
7bc0584e | 5 | #include <linux/atomic.h> |
0b24becc | 6 | #include <linux/kasan.h> |
82868247 | 7 | #include <linux/kasan-tags.h> |
2b830526 | 8 | #include <linux/kfence.h> |
cd11016e | 9 | #include <linux/stackdepot.h> |
0b24becc | 10 | |
7ebfce33 | 11 | #if defined(CONFIG_KASAN_SW_TAGS) || defined(CONFIG_KASAN_HW_TAGS) |
8f7b5054 | 12 | |
8028caac | 13 | #include <linux/static_key.h> |
7ebfce33 AK |
14 | |
15 | DECLARE_STATIC_KEY_TRUE(kasan_flag_stacktrace); | |
16 | ||
17 | static inline bool kasan_stack_collection_enabled(void) | |
18 | { | |
19 | return static_branch_unlikely(&kasan_flag_stacktrace); | |
20 | } | |
21 | ||
22 | #else /* CONFIG_KASAN_SW_TAGS || CONFIG_KASAN_HW_TAGS */ | |
23 | ||
24 | static inline bool kasan_stack_collection_enabled(void) | |
25 | { | |
26 | return true; | |
27 | } | |
28 | ||
29 | #endif /* CONFIG_KASAN_SW_TAGS || CONFIG_KASAN_HW_TAGS */ | |
30 | ||
31 | #ifdef CONFIG_KASAN_HW_TAGS | |
32 | ||
77a63c69 | 33 | #include "../slab.h" |
8f7b5054 | 34 | |
551b2bcb | 35 | DECLARE_STATIC_KEY_TRUE(kasan_flag_vmalloc); |
2d27e585 VF |
36 | |
37 | enum kasan_mode { | |
38 | KASAN_MODE_SYNC, | |
39 | KASAN_MODE_ASYNC, | |
40 | KASAN_MODE_ASYMM, | |
41 | }; | |
42 | ||
43 | extern enum kasan_mode kasan_mode __ro_after_init; | |
8f7b5054 | 44 | |
44383cef AK |
45 | extern unsigned long kasan_page_alloc_sample; |
46 | extern unsigned int kasan_page_alloc_sample_order; | |
47 | DECLARE_PER_CPU(long, kasan_page_alloc_skip); | |
48 | ||
551b2bcb AK |
49 | static inline bool kasan_vmalloc_enabled(void) |
50 | { | |
51 | return static_branch_likely(&kasan_flag_vmalloc); | |
52 | } | |
53 | ||
2d27e585 VF |
54 | static inline bool kasan_async_fault_possible(void) |
55 | { | |
56 | return kasan_mode == KASAN_MODE_ASYNC || kasan_mode == KASAN_MODE_ASYMM; | |
57 | } | |
58 | ||
59 | static inline bool kasan_sync_fault_possible(void) | |
8f7b5054 | 60 | { |
2d27e585 | 61 | return kasan_mode == KASAN_MODE_SYNC || kasan_mode == KASAN_MODE_ASYMM; |
8f7b5054 | 62 | } |
fc0e5b91 | 63 | |
44383cef AK |
64 | static inline bool kasan_sample_page_alloc(unsigned int order) |
65 | { | |
66 | /* Fast-path for when sampling is disabled. */ | |
67 | if (kasan_page_alloc_sample == 1) | |
68 | return true; | |
69 | ||
70 | if (order < kasan_page_alloc_sample_order) | |
71 | return true; | |
72 | ||
73 | if (this_cpu_dec_return(kasan_page_alloc_skip) < 0) { | |
74 | this_cpu_write(kasan_page_alloc_skip, | |
75 | kasan_page_alloc_sample - 1); | |
76 | return true; | |
77 | } | |
78 | ||
79 | return false; | |
80 | } | |
81 | ||
284f8590 | 82 | #else /* CONFIG_KASAN_HW_TAGS */ |
8f7b5054 | 83 | |
2d27e585 | 84 | static inline bool kasan_async_fault_possible(void) |
8f7b5054 VF |
85 | { |
86 | return false; | |
87 | } | |
88 | ||
2d27e585 VF |
89 | static inline bool kasan_sync_fault_possible(void) |
90 | { | |
91 | return true; | |
92 | } | |
93 | ||
44383cef AK |
94 | static inline bool kasan_sample_page_alloc(unsigned int order) |
95 | { | |
96 | return true; | |
97 | } | |
98 | ||
284f8590 AK |
99 | #endif /* CONFIG_KASAN_HW_TAGS */ |
100 | ||
101 | #ifdef CONFIG_KASAN_GENERIC | |
102 | ||
103 | /* Generic KASAN uses per-object metadata to store stack traces. */ | |
104 | static inline bool kasan_requires_meta(void) | |
105 | { | |
106 | /* | |
107 | * Technically, Generic KASAN always collects stack traces right now. | |
108 | * However, let's use kasan_stack_collection_enabled() in case the | |
109 | * kasan.stacktrace command-line argument is changed to affect | |
110 | * Generic KASAN. | |
111 | */ | |
112 | return kasan_stack_collection_enabled(); | |
113 | } | |
114 | ||
115 | #else /* CONFIG_KASAN_GENERIC */ | |
116 | ||
117 | /* Tag-based KASAN modes do not use per-object metadata. */ | |
118 | static inline bool kasan_requires_meta(void) | |
119 | { | |
120 | return false; | |
121 | } | |
122 | ||
123 | #endif /* CONFIG_KASAN_GENERIC */ | |
8028caac | 124 | |
6c6a04fe | 125 | #if defined(CONFIG_KASAN_GENERIC) || defined(CONFIG_KASAN_SW_TAGS) |
1f600626 | 126 | #define KASAN_GRANULE_SIZE (1UL << KASAN_SHADOW_SCALE_SHIFT) |
6c6a04fe AK |
127 | #else |
128 | #include <asm/mte-kasan.h> | |
129 | #define KASAN_GRANULE_SIZE MTE_GRANULE_SIZE | |
130 | #endif | |
131 | ||
1f600626 | 132 | #define KASAN_GRANULE_MASK (KASAN_GRANULE_SIZE - 1) |
0b24becc | 133 | |
affc3f07 AK |
134 | #define KASAN_MEMORY_PER_SHADOW_PAGE (KASAN_GRANULE_SIZE << PAGE_SHIFT) |
135 | ||
7f94ffbc | 136 | #ifdef CONFIG_KASAN_GENERIC |
06bc4cf6 | 137 | #define KASAN_PAGE_FREE 0xFF /* freed page */ |
83f8e4a8 | 138 | #define KASAN_PAGE_REDZONE 0xFE /* redzone for kmalloc_large allocation */ |
06bc4cf6 AK |
139 | #define KASAN_SLAB_REDZONE 0xFC /* redzone for slab object */ |
140 | #define KASAN_SLAB_FREE 0xFB /* freed slab object */ | |
83f8e4a8 | 141 | #define KASAN_VMALLOC_INVALID 0xF8 /* inaccessible space in vmap area */ |
7f94ffbc | 142 | #else |
06bc4cf6 | 143 | #define KASAN_PAGE_FREE KASAN_TAG_INVALID |
83f8e4a8 | 144 | #define KASAN_PAGE_REDZONE KASAN_TAG_INVALID |
06bc4cf6 AK |
145 | #define KASAN_SLAB_REDZONE KASAN_TAG_INVALID |
146 | #define KASAN_SLAB_FREE KASAN_TAG_INVALID | |
83f8e4a8 | 147 | #define KASAN_VMALLOC_INVALID KASAN_TAG_INVALID /* only used for SW_TAGS */ |
7f94ffbc AK |
148 | #endif |
149 | ||
fe1ac91e AK |
150 | #ifdef CONFIG_KASAN_GENERIC |
151 | ||
06bc4cf6 | 152 | #define KASAN_SLAB_FREETRACK 0xFA /* freed slab object with free track */ |
83f8e4a8 | 153 | #define KASAN_GLOBAL_REDZONE 0xF9 /* redzone for global variable */ |
0316bec2 | 154 | |
fc0e5b91 | 155 | /* Stack redzone shadow values. Compiler ABI, do not change. */ |
83f8e4a8 AK |
156 | #define KASAN_STACK_LEFT 0xF1 |
157 | #define KASAN_STACK_MID 0xF2 | |
158 | #define KASAN_STACK_RIGHT 0xF3 | |
159 | #define KASAN_STACK_PARTIAL 0xF4 | |
c420f167 | 160 | |
fc0e5b91 | 161 | /* alloca redzone shadow values. */ |
342061ee PL |
162 | #define KASAN_ALLOCA_LEFT 0xCA |
163 | #define KASAN_ALLOCA_RIGHT 0xCB | |
164 | ||
fc0e5b91 | 165 | /* alloca redzone size. Compiler ABI, do not change. */ |
342061ee PL |
166 | #define KASAN_ALLOCA_REDZONE_SIZE 32 |
167 | ||
fc0e5b91 | 168 | /* Stack frame marker. Compiler ABI, do not change. */ |
e8969219 ME |
169 | #define KASAN_CURRENT_STACK_FRAME_MAGIC 0x41B58AB3 |
170 | ||
fc0e5b91 | 171 | /* Dummy value to avoid breaking randconfig/all*config builds. */ |
bebf56a1 AR |
172 | #ifndef KASAN_ABI_VERSION |
173 | #define KASAN_ABI_VERSION 1 | |
174 | #endif | |
b8c73fc2 | 175 | |
fe1ac91e AK |
176 | #endif /* CONFIG_KASAN_GENERIC */ |
177 | ||
96e0279d AK |
178 | /* Metadata layout customization. */ |
179 | #define META_BYTES_PER_BLOCK 1 | |
180 | #define META_BLOCKS_PER_ROW 16 | |
181 | #define META_BYTES_PER_ROW (META_BLOCKS_PER_ROW * META_BYTES_PER_BLOCK) | |
182 | #define META_MEM_BYTES_PER_ROW (META_BYTES_PER_ROW * KASAN_GRANULE_SIZE) | |
183 | #define META_ROWS_AROUND_ADDR 2 | |
184 | ||
59e6e098 AK |
185 | #define KASAN_STACK_DEPTH 64 |
186 | ||
187 | struct kasan_track { | |
188 | u32 pid; | |
189 | depot_stack_handle_t stack; | |
190 | }; | |
191 | ||
31c65110 AK |
192 | enum kasan_report_type { |
193 | KASAN_REPORT_ACCESS, | |
194 | KASAN_REPORT_INVALID_FREE, | |
3de0de75 | 195 | KASAN_REPORT_DOUBLE_FREE, |
31c65110 AK |
196 | }; |
197 | ||
c965cdd6 | 198 | struct kasan_report_info { |
015b109f | 199 | /* Filled in by kasan_report_*(). */ |
31c65110 | 200 | enum kasan_report_type type; |
9d7b7dd9 | 201 | void *access_addr; |
0b24becc AR |
202 | size_t access_size; |
203 | bool is_write; | |
204 | unsigned long ip; | |
015b109f AK |
205 | |
206 | /* Filled in by the common reporting code. */ | |
207 | void *first_bad_addr; | |
7fae3dd0 AK |
208 | struct kmem_cache *cache; |
209 | void *object; | |
8f17febb | 210 | size_t alloc_size; |
59e6e098 AK |
211 | |
212 | /* Filled in by the mode-specific reporting code. */ | |
213 | const char *bug_type; | |
214 | struct kasan_track alloc_track; | |
215 | struct kasan_track free_track; | |
0b24becc AR |
216 | }; |
217 | ||
fc0e5b91 | 218 | /* Do not change the struct layout: compiler ABI. */ |
bebf56a1 AR |
219 | struct kasan_source_location { |
220 | const char *filename; | |
221 | int line_no; | |
222 | int column_no; | |
223 | }; | |
224 | ||
fc0e5b91 | 225 | /* Do not change the struct layout: compiler ABI. */ |
bebf56a1 AR |
226 | struct kasan_global { |
227 | const void *beg; /* Address of the beginning of the global variable. */ | |
228 | size_t size; /* Size of the global variable. */ | |
fc0e5b91 | 229 | size_t size_with_redzone; /* Size of the variable + size of the redzone. 32 bytes aligned. */ |
bebf56a1 AR |
230 | const void *name; |
231 | const void *module_name; /* Name of the module where the global variable is declared. */ | |
fc0e5b91 | 232 | unsigned long has_dynamic_init; /* This is needed for C++. */ |
bebf56a1 AR |
233 | #if KASAN_ABI_VERSION >= 4 |
234 | struct kasan_source_location *location; | |
235 | #endif | |
045d599a DV |
236 | #if KASAN_ABI_VERSION >= 5 |
237 | char *odr_indicator; | |
238 | #endif | |
bebf56a1 AR |
239 | }; |
240 | ||
59e6e098 | 241 | /* Structures for keeping alloc and free meta. */ |
7ed2f9e6 | 242 | |
be95e13f AK |
243 | #ifdef CONFIG_KASAN_GENERIC |
244 | ||
7ed2f9e6 | 245 | struct kasan_alloc_meta { |
b3cbd9bf | 246 | struct kasan_track alloc_track; |
be95e13f | 247 | /* Free track is stored in kasan_free_meta. */ |
26e760c9 | 248 | depot_stack_handle_t aux_stack[2]; |
7ed2f9e6 AP |
249 | }; |
250 | ||
55834c59 AP |
251 | struct qlist_node { |
252 | struct qlist_node *next; | |
253 | }; | |
97593cad AK |
254 | |
255 | /* | |
fc0e5b91 AK |
256 | * Free meta is stored either in the object itself or in the redzone after the |
257 | * object. In the former case, free meta offset is 0. In the latter case, the | |
258 | * offset is between 0 and INT_MAX. INT_MAX marks that free meta is not present. | |
97593cad AK |
259 | */ |
260 | #define KASAN_NO_FREE_META INT_MAX | |
261 | ||
fc0e5b91 AK |
262 | /* |
263 | * Free meta is only used by Generic mode while the object is in quarantine. | |
264 | * After that, slab allocator stores the freelist pointer in the object. | |
265 | */ | |
7ed2f9e6 | 266 | struct kasan_free_meta { |
55834c59 | 267 | struct qlist_node quarantine_link; |
e4b7818b | 268 | struct kasan_track free_track; |
7ed2f9e6 AP |
269 | }; |
270 | ||
be95e13f AK |
271 | #endif /* CONFIG_KASAN_GENERIC */ |
272 | ||
7bc0584e AK |
273 | #if defined(CONFIG_KASAN_SW_TAGS) || defined(CONFIG_KASAN_HW_TAGS) |
274 | ||
275 | struct kasan_stack_ring_entry { | |
276 | void *ptr; | |
277 | size_t size; | |
278 | u32 pid; | |
279 | depot_stack_handle_t stack; | |
280 | bool is_free; | |
281 | }; | |
282 | ||
7bc0584e AK |
283 | struct kasan_stack_ring { |
284 | rwlock_t lock; | |
80b92bfe | 285 | size_t size; |
7bc0584e | 286 | atomic64_t pos; |
80b92bfe | 287 | struct kasan_stack_ring_entry *entries; |
7bc0584e AK |
288 | }; |
289 | ||
290 | #endif /* CONFIG_KASAN_SW_TAGS || CONFIG_KASAN_HW_TAGS */ | |
291 | ||
2e903b91 AK |
292 | #if defined(CONFIG_KASAN_GENERIC) || defined(CONFIG_KASAN_SW_TAGS) |
293 | ||
0b24becc AR |
294 | static inline const void *kasan_shadow_to_mem(const void *shadow_addr) |
295 | { | |
296 | return (void *)(((unsigned long)shadow_addr - KASAN_SHADOW_OFFSET) | |
297 | << KASAN_SHADOW_SCALE_SHIFT); | |
298 | } | |
299 | ||
9701c9ff | 300 | static __always_inline bool addr_has_metadata(const void *addr) |
11cd3cd6 | 301 | { |
9d7b7dd9 AK |
302 | return (kasan_reset_tag(addr) >= |
303 | kasan_shadow_to_mem((void *)KASAN_SHADOW_START)); | |
11cd3cd6 AK |
304 | } |
305 | ||
b5f6e0fc | 306 | /** |
f00748bf | 307 | * kasan_check_range - Check memory region, and report if invalid access. |
b5f6e0fc ME |
308 | * @addr: the accessed address |
309 | * @size: the accessed size | |
310 | * @write: true if access is a write access | |
311 | * @ret_ip: return address | |
312 | * @return: true if access was valid, false if invalid | |
313 | */ | |
f00748bf | 314 | bool kasan_check_range(unsigned long addr, size_t size, bool write, |
bffa986c AK |
315 | unsigned long ret_ip); |
316 | ||
2e903b91 AK |
317 | #else /* CONFIG_KASAN_GENERIC || CONFIG_KASAN_SW_TAGS */ |
318 | ||
9701c9ff | 319 | static __always_inline bool addr_has_metadata(const void *addr) |
2e903b91 | 320 | { |
b99acdcb | 321 | return (is_vmalloc_addr(addr) || virt_addr_valid(addr)); |
2e903b91 AK |
322 | } |
323 | ||
324 | #endif /* CONFIG_KASAN_GENERIC || CONFIG_KASAN_SW_TAGS */ | |
325 | ||
59e6e098 | 326 | void *kasan_find_first_bad_addr(void *addr, size_t size); |
8f17febb | 327 | size_t kasan_get_alloc_size(void *object, struct kmem_cache *cache); |
59e6e098 AK |
328 | void kasan_complete_mode_report_info(struct kasan_report_info *info); |
329 | void kasan_metadata_fetch_row(char *buffer, void *row); | |
330 | ||
d8dd3971 | 331 | #if defined(CONFIG_KASAN_SW_TAGS) || defined(CONFIG_KASAN_HW_TAGS) |
f00748bf | 332 | void kasan_print_tags(u8 addr_tag, const void *addr); |
d8dd3971 | 333 | #else |
f00748bf | 334 | static inline void kasan_print_tags(u8 addr_tag, const void *addr) { } |
d8dd3971 AK |
335 | #endif |
336 | ||
1e0f611f | 337 | #if defined(CONFIG_KASAN_STACK) |
f00748bf | 338 | void kasan_print_address_stack_frame(const void *addr); |
97fc7122 | 339 | #else |
f00748bf | 340 | static inline void kasan_print_address_stack_frame(const void *addr) { } |
97fc7122 AK |
341 | #endif |
342 | ||
88f29765 AK |
343 | #ifdef CONFIG_KASAN_GENERIC |
344 | void kasan_print_aux_stacks(struct kmem_cache *cache, const void *object); | |
345 | #else | |
346 | static inline void kasan_print_aux_stacks(struct kmem_cache *cache, const void *object) { } | |
347 | #endif | |
348 | ||
8cceeff4 | 349 | bool kasan_report(unsigned long addr, size_t size, |
0b24becc | 350 | bool is_write, unsigned long ip); |
3de0de75 | 351 | void kasan_report_invalid_free(void *object, unsigned long ip, enum kasan_report_type type); |
0b24becc | 352 | |
6e48a966 | 353 | struct slab *kasan_addr_to_slab(const void *addr); |
ae8f06b3 | 354 | |
2f356801 | 355 | #ifdef CONFIG_KASAN_GENERIC |
5935143d | 356 | void kasan_init_cache_meta(struct kmem_cache *cache, unsigned int *size); |
284f8590 | 357 | void kasan_init_object_meta(struct kmem_cache *cache, const void *object); |
2f356801 AK |
358 | struct kasan_alloc_meta *kasan_get_alloc_meta(struct kmem_cache *cache, |
359 | const void *object); | |
360 | struct kasan_free_meta *kasan_get_free_meta(struct kmem_cache *cache, | |
361 | const void *object); | |
284f8590 | 362 | #else |
5935143d | 363 | static inline void kasan_init_cache_meta(struct kmem_cache *cache, unsigned int *size) { } |
284f8590 | 364 | static inline void kasan_init_object_meta(struct kmem_cache *cache, const void *object) { } |
2f356801 AK |
365 | #endif |
366 | ||
7594b347 | 367 | depot_stack_handle_t kasan_save_stack(gfp_t flags, bool can_alloc); |
e4b7818b | 368 | void kasan_set_track(struct kasan_track *track, gfp_t flags); |
ccf643e6 | 369 | void kasan_save_alloc_info(struct kmem_cache *cache, void *object, gfp_t flags); |
6b074349 | 370 | void kasan_save_free_info(struct kmem_cache *cache, void *object); |
26e760c9 | 371 | |
2bd926b4 AK |
372 | #if defined(CONFIG_KASAN_GENERIC) && \ |
373 | (defined(CONFIG_SLAB) || defined(CONFIG_SLUB)) | |
f00748bf AK |
374 | bool kasan_quarantine_put(struct kmem_cache *cache, void *object); |
375 | void kasan_quarantine_reduce(void); | |
376 | void kasan_quarantine_remove_cache(struct kmem_cache *cache); | |
55834c59 | 377 | #else |
f00748bf AK |
378 | static inline bool kasan_quarantine_put(struct kmem_cache *cache, void *object) { return false; } |
379 | static inline void kasan_quarantine_reduce(void) { } | |
380 | static inline void kasan_quarantine_remove_cache(struct kmem_cache *cache) { } | |
55834c59 AP |
381 | #endif |
382 | ||
3c9e3aa1 | 383 | #ifndef arch_kasan_set_tag |
c412a769 QC |
384 | static inline const void *arch_kasan_set_tag(const void *addr, u8 tag) |
385 | { | |
386 | return addr; | |
387 | } | |
3c9e3aa1 | 388 | #endif |
3c9e3aa1 AK |
389 | #ifndef arch_kasan_get_tag |
390 | #define arch_kasan_get_tag(addr) 0 | |
391 | #endif | |
392 | ||
393 | #define set_tag(addr, tag) ((void *)arch_kasan_set_tag((addr), (tag))) | |
3c9e3aa1 AK |
394 | #define get_tag(addr) arch_kasan_get_tag(addr) |
395 | ||
ccbe2aab AK |
396 | #ifdef CONFIG_KASAN_HW_TAGS |
397 | ||
2603f8a7 VF |
398 | #ifndef arch_enable_tagging_sync |
399 | #define arch_enable_tagging_sync() | |
400 | #endif | |
401 | #ifndef arch_enable_tagging_async | |
402 | #define arch_enable_tagging_async() | |
ccbe2aab | 403 | #endif |
2d27e585 VF |
404 | #ifndef arch_enable_tagging_asymm |
405 | #define arch_enable_tagging_asymm() | |
406 | #endif | |
e80a76aa AK |
407 | #ifndef arch_force_async_tag_fault |
408 | #define arch_force_async_tag_fault() | |
409 | #endif | |
ccbe2aab AK |
410 | #ifndef arch_get_random_tag |
411 | #define arch_get_random_tag() (0xFF) | |
412 | #endif | |
413 | #ifndef arch_get_mem_tag | |
414 | #define arch_get_mem_tag(addr) (0xFF) | |
415 | #endif | |
416 | #ifndef arch_set_mem_tag_range | |
d9b6f907 | 417 | #define arch_set_mem_tag_range(addr, size, tag, init) ((void *)(addr)) |
ccbe2aab AK |
418 | #endif |
419 | ||
2603f8a7 VF |
420 | #define hw_enable_tagging_sync() arch_enable_tagging_sync() |
421 | #define hw_enable_tagging_async() arch_enable_tagging_async() | |
2d27e585 | 422 | #define hw_enable_tagging_asymm() arch_enable_tagging_asymm() |
e80a76aa | 423 | #define hw_force_async_tag_fault() arch_force_async_tag_fault() |
ccbe2aab AK |
424 | #define hw_get_random_tag() arch_get_random_tag() |
425 | #define hw_get_mem_tag(addr) arch_get_mem_tag(addr) | |
d9b6f907 AK |
426 | #define hw_set_mem_tag_range(addr, size, tag, init) \ |
427 | arch_set_mem_tag_range((addr), (size), (tag), (init)) | |
ccbe2aab | 428 | |
b1add418 VF |
429 | void kasan_enable_tagging(void); |
430 | ||
f05842cf AK |
431 | #else /* CONFIG_KASAN_HW_TAGS */ |
432 | ||
2603f8a7 VF |
433 | #define hw_enable_tagging_sync() |
434 | #define hw_enable_tagging_async() | |
2d27e585 | 435 | #define hw_enable_tagging_asymm() |
f05842cf | 436 | |
b1add418 VF |
437 | static inline void kasan_enable_tagging(void) { } |
438 | ||
ccbe2aab AK |
439 | #endif /* CONFIG_KASAN_HW_TAGS */ |
440 | ||
7ebfce33 AK |
441 | #if defined(CONFIG_KASAN_SW_TAGS) || defined(CONFIG_KASAN_HW_TAGS) |
442 | void __init kasan_init_tags(void); | |
443 | #endif /* CONFIG_KASAN_SW_TAGS || CONFIG_KASAN_HW_TAGS */ | |
444 | ||
f05842cf AK |
445 | #if defined(CONFIG_KASAN_HW_TAGS) && IS_ENABLED(CONFIG_KASAN_KUNIT_TEST) |
446 | ||
e80a76aa | 447 | void kasan_force_async_fault(void); |
f05842cf | 448 | |
b1add418 | 449 | #else /* CONFIG_KASAN_HW_TAGS && CONFIG_KASAN_KUNIT_TEST */ |
f05842cf | 450 | |
e80a76aa | 451 | static inline void kasan_force_async_fault(void) { } |
f05842cf | 452 | |
b1add418 | 453 | #endif /* CONFIG_KASAN_HW_TAGS && CONFIG_KASAN_KUNIT_TEST */ |
f05842cf | 454 | |
d8dd3971 | 455 | #ifdef CONFIG_KASAN_SW_TAGS |
f00748bf | 456 | u8 kasan_random_tag(void); |
d8dd3971 | 457 | #elif defined(CONFIG_KASAN_HW_TAGS) |
f00748bf | 458 | static inline u8 kasan_random_tag(void) { return hw_get_random_tag(); } |
d8dd3971 | 459 | #else |
f00748bf | 460 | static inline u8 kasan_random_tag(void) { return 0; } |
d8dd3971 AK |
461 | #endif |
462 | ||
57345fa6 AK |
463 | #ifdef CONFIG_KASAN_HW_TAGS |
464 | ||
aa5c219c | 465 | static inline void kasan_poison(const void *addr, size_t size, u8 value, bool init) |
57345fa6 | 466 | { |
cde8a7eb | 467 | addr = kasan_reset_tag(addr); |
2b830526 AP |
468 | |
469 | /* Skip KFENCE memory if called explicitly outside of sl*b. */ | |
cde8a7eb | 470 | if (is_kfence_address(addr)) |
2b830526 AP |
471 | return; |
472 | ||
cde8a7eb AK |
473 | if (WARN_ON((unsigned long)addr & KASAN_GRANULE_MASK)) |
474 | return; | |
475 | if (WARN_ON(size & KASAN_GRANULE_MASK)) | |
476 | return; | |
477 | ||
aa5c219c | 478 | hw_set_mem_tag_range((void *)addr, size, value, init); |
57345fa6 AK |
479 | } |
480 | ||
aa5c219c | 481 | static inline void kasan_unpoison(const void *addr, size_t size, bool init) |
57345fa6 | 482 | { |
cde8a7eb | 483 | u8 tag = get_tag(addr); |
2b830526 | 484 | |
cde8a7eb | 485 | addr = kasan_reset_tag(addr); |
2b830526 AP |
486 | |
487 | /* Skip KFENCE memory if called explicitly outside of sl*b. */ | |
cde8a7eb AK |
488 | if (is_kfence_address(addr)) |
489 | return; | |
490 | ||
491 | if (WARN_ON((unsigned long)addr & KASAN_GRANULE_MASK)) | |
2b830526 | 492 | return; |
77a63c69 YL |
493 | /* |
494 | * Explicitly initialize the memory with the precise object size to | |
fc0e5b91 AK |
495 | * avoid overwriting the slab redzone. This disables initialization in |
496 | * the arch code and may thus lead to performance penalty. This penalty | |
497 | * does not affect production builds, as slab redzones are not enabled | |
498 | * there. | |
77a63c69 YL |
499 | */ |
500 | if (__slub_debug_enabled() && | |
501 | init && ((unsigned long)size & KASAN_GRANULE_MASK)) { | |
502 | init = false; | |
503 | memzero_explicit((void *)addr, size); | |
504 | } | |
cde8a7eb | 505 | size = round_up(size, KASAN_GRANULE_SIZE); |
2b830526 | 506 | |
aa5c219c | 507 | hw_set_mem_tag_range((void *)addr, size, tag, init); |
57345fa6 AK |
508 | } |
509 | ||
611806b4 | 510 | static inline bool kasan_byte_accessible(const void *addr) |
57345fa6 AK |
511 | { |
512 | u8 ptr_tag = get_tag(addr); | |
611806b4 | 513 | u8 mem_tag = hw_get_mem_tag((void *)addr); |
57345fa6 | 514 | |
bfcfe371 | 515 | return ptr_tag == KASAN_TAG_KERNEL || ptr_tag == mem_tag; |
57345fa6 AK |
516 | } |
517 | ||
518 | #else /* CONFIG_KASAN_HW_TAGS */ | |
519 | ||
e2db1a9a | 520 | /** |
f0953a1b | 521 | * kasan_poison - mark the memory range as inaccessible |
e2db1a9a | 522 | * @addr - range start address, must be aligned to KASAN_GRANULE_SIZE |
cde8a7eb | 523 | * @size - range size, must be aligned to KASAN_GRANULE_SIZE |
e2db1a9a | 524 | * @value - value that's written to metadata for the range |
aa5c219c | 525 | * @init - whether to initialize the memory range (only for hardware tag-based) |
e2db1a9a AK |
526 | * |
527 | * The size gets aligned to KASAN_GRANULE_SIZE before marking the range. | |
528 | */ | |
aa5c219c | 529 | void kasan_poison(const void *addr, size_t size, u8 value, bool init); |
e2db1a9a AK |
530 | |
531 | /** | |
532 | * kasan_unpoison - mark the memory range as accessible | |
533 | * @addr - range start address, must be aligned to KASAN_GRANULE_SIZE | |
cde8a7eb | 534 | * @size - range size, can be unaligned |
aa5c219c | 535 | * @init - whether to initialize the memory range (only for hardware tag-based) |
e2db1a9a AK |
536 | * |
537 | * For the tag-based modes, the @size gets aligned to KASAN_GRANULE_SIZE before | |
538 | * marking the range. | |
539 | * For the generic mode, the last granule of the memory range gets partially | |
540 | * unpoisoned based on the @size. | |
541 | */ | |
aa5c219c | 542 | void kasan_unpoison(const void *addr, size_t size, bool init); |
e2db1a9a | 543 | |
611806b4 | 544 | bool kasan_byte_accessible(const void *addr); |
57345fa6 AK |
545 | |
546 | #endif /* CONFIG_KASAN_HW_TAGS */ | |
547 | ||
e2db1a9a AK |
548 | #ifdef CONFIG_KASAN_GENERIC |
549 | ||
550 | /** | |
551 | * kasan_poison_last_granule - mark the last granule of the memory range as | |
f0953a1b | 552 | * inaccessible |
e2db1a9a AK |
553 | * @addr - range start address, must be aligned to KASAN_GRANULE_SIZE |
554 | * @size - range size | |
555 | * | |
556 | * This function is only available for the generic mode, as it's the only mode | |
557 | * that has partially poisoned memory granules. | |
558 | */ | |
559 | void kasan_poison_last_granule(const void *address, size_t size); | |
560 | ||
561 | #else /* CONFIG_KASAN_GENERIC */ | |
562 | ||
563 | static inline void kasan_poison_last_granule(const void *address, size_t size) { } | |
564 | ||
565 | #endif /* CONFIG_KASAN_GENERIC */ | |
566 | ||
af3751f3 DA |
567 | #ifndef kasan_arch_is_ready |
568 | static inline bool kasan_arch_is_ready(void) { return true; } | |
569 | #elif !defined(CONFIG_KASAN_GENERIC) || !defined(CONFIG_KASAN_OUTLINE) | |
570 | #error kasan_arch_is_ready only works in KASAN generic outline mode! | |
571 | #endif | |
572 | ||
c8c7016f AK |
573 | #if IS_ENABLED(CONFIG_KASAN_KUNIT_TEST) |
574 | ||
575 | void kasan_kunit_test_suite_start(void); | |
576 | void kasan_kunit_test_suite_end(void); | |
577 | ||
578 | #else /* CONFIG_KASAN_KUNIT_TEST */ | |
579 | ||
580 | static inline void kasan_kunit_test_suite_start(void) { } | |
581 | static inline void kasan_kunit_test_suite_end(void) { } | |
582 | ||
583 | #endif /* CONFIG_KASAN_KUNIT_TEST */ | |
584 | ||
80207910 AK |
585 | #if IS_ENABLED(CONFIG_KASAN_KUNIT_TEST) || IS_ENABLED(CONFIG_KASAN_MODULE_TEST) |
586 | ||
587 | bool kasan_save_enable_multi_shot(void); | |
588 | void kasan_restore_multi_shot(bool enabled); | |
589 | ||
590 | #endif | |
591 | ||
d321599c AP |
592 | /* |
593 | * Exported functions for interfaces called from assembly or from generated | |
fc0e5b91 | 594 | * code. Declared here to avoid warnings about missing declarations. |
d321599c | 595 | */ |
fc0e5b91 | 596 | |
d321599c AP |
597 | asmlinkage void kasan_unpoison_task_stack_below(const void *watermark); |
598 | void __asan_register_globals(struct kasan_global *globals, size_t size); | |
599 | void __asan_unregister_globals(struct kasan_global *globals, size_t size); | |
d321599c | 600 | void __asan_handle_no_return(void); |
d321599c AP |
601 | void __asan_alloca_poison(unsigned long addr, size_t size); |
602 | void __asan_allocas_unpoison(const void *stack_top, const void *stack_bottom); | |
603 | ||
604 | void __asan_load1(unsigned long addr); | |
605 | void __asan_store1(unsigned long addr); | |
606 | void __asan_load2(unsigned long addr); | |
607 | void __asan_store2(unsigned long addr); | |
608 | void __asan_load4(unsigned long addr); | |
609 | void __asan_store4(unsigned long addr); | |
610 | void __asan_load8(unsigned long addr); | |
611 | void __asan_store8(unsigned long addr); | |
612 | void __asan_load16(unsigned long addr); | |
613 | void __asan_store16(unsigned long addr); | |
13cf0488 AK |
614 | void __asan_loadN(unsigned long addr, size_t size); |
615 | void __asan_storeN(unsigned long addr, size_t size); | |
d321599c AP |
616 | |
617 | void __asan_load1_noabort(unsigned long addr); | |
618 | void __asan_store1_noabort(unsigned long addr); | |
619 | void __asan_load2_noabort(unsigned long addr); | |
620 | void __asan_store2_noabort(unsigned long addr); | |
621 | void __asan_load4_noabort(unsigned long addr); | |
622 | void __asan_store4_noabort(unsigned long addr); | |
623 | void __asan_load8_noabort(unsigned long addr); | |
624 | void __asan_store8_noabort(unsigned long addr); | |
625 | void __asan_load16_noabort(unsigned long addr); | |
626 | void __asan_store16_noabort(unsigned long addr); | |
13cf0488 AK |
627 | void __asan_loadN_noabort(unsigned long addr, size_t size); |
628 | void __asan_storeN_noabort(unsigned long addr, size_t size); | |
629 | ||
630 | void __asan_report_load1_noabort(unsigned long addr); | |
631 | void __asan_report_store1_noabort(unsigned long addr); | |
632 | void __asan_report_load2_noabort(unsigned long addr); | |
633 | void __asan_report_store2_noabort(unsigned long addr); | |
634 | void __asan_report_load4_noabort(unsigned long addr); | |
635 | void __asan_report_store4_noabort(unsigned long addr); | |
636 | void __asan_report_load8_noabort(unsigned long addr); | |
637 | void __asan_report_store8_noabort(unsigned long addr); | |
638 | void __asan_report_load16_noabort(unsigned long addr); | |
639 | void __asan_report_store16_noabort(unsigned long addr); | |
640 | void __asan_report_load_n_noabort(unsigned long addr, size_t size); | |
641 | void __asan_report_store_n_noabort(unsigned long addr, size_t size); | |
d321599c AP |
642 | |
643 | void __asan_set_shadow_00(const void *addr, size_t size); | |
644 | void __asan_set_shadow_f1(const void *addr, size_t size); | |
645 | void __asan_set_shadow_f2(const void *addr, size_t size); | |
646 | void __asan_set_shadow_f3(const void *addr, size_t size); | |
647 | void __asan_set_shadow_f5(const void *addr, size_t size); | |
648 | void __asan_set_shadow_f8(const void *addr, size_t size); | |
649 | ||
69d4c0d3 PZ |
650 | void *__asan_memset(void *addr, int c, size_t len); |
651 | void *__asan_memmove(void *dest, const void *src, size_t len); | |
652 | void *__asan_memcpy(void *dest, const void *src, size_t len); | |
653 | ||
13cf0488 AK |
654 | void __hwasan_load1_noabort(unsigned long addr); |
655 | void __hwasan_store1_noabort(unsigned long addr); | |
656 | void __hwasan_load2_noabort(unsigned long addr); | |
657 | void __hwasan_store2_noabort(unsigned long addr); | |
658 | void __hwasan_load4_noabort(unsigned long addr); | |
659 | void __hwasan_store4_noabort(unsigned long addr); | |
660 | void __hwasan_load8_noabort(unsigned long addr); | |
661 | void __hwasan_store8_noabort(unsigned long addr); | |
662 | void __hwasan_load16_noabort(unsigned long addr); | |
663 | void __hwasan_store16_noabort(unsigned long addr); | |
664 | void __hwasan_loadN_noabort(unsigned long addr, size_t size); | |
665 | void __hwasan_storeN_noabort(unsigned long addr, size_t size); | |
666 | ||
667 | void __hwasan_tag_memory(unsigned long addr, u8 tag, unsigned long size); | |
668 | ||
51287dcb ME |
669 | void *__hwasan_memset(void *addr, int c, size_t len); |
670 | void *__hwasan_memmove(void *dest, const void *src, size_t len); | |
671 | void *__hwasan_memcpy(void *dest, const void *src, size_t len); | |
672 | ||
fc0e5b91 | 673 | #endif /* __MM_KASAN_KASAN_H */ |