kasan.h 17.3 KB
Newer Older
1
/* SPDX-License-Identifier: GPL-2.0 */
2 3 4 5
#ifndef __MM_KASAN_KASAN_H
#define __MM_KASAN_KASAN_H

#include <linux/kasan.h>
6
#include <linux/kasan-tags.h>
7
#include <linux/kfence.h>
8
#include <linux/stackdepot.h>
9

10
#ifdef CONFIG_KASAN_HW_TAGS
11

12
#include <linux/static_key.h>
13
#include "../slab.h"
14

15
DECLARE_STATIC_KEY_TRUE(kasan_flag_vmalloc);
16
DECLARE_STATIC_KEY_TRUE(kasan_flag_stacktrace);
17 18 19 20 21 22 23 24

enum kasan_mode {
	KASAN_MODE_SYNC,
	KASAN_MODE_ASYNC,
	KASAN_MODE_ASYMM,
};

extern enum kasan_mode kasan_mode __ro_after_init;
25

26 27 28 29 30
static inline bool kasan_vmalloc_enabled(void)
{
	return static_branch_likely(&kasan_flag_vmalloc);
}

31 32 33 34
static inline bool kasan_stack_collection_enabled(void)
{
	return static_branch_unlikely(&kasan_flag_stacktrace);
}
35

36 37 38 39 40 41
static inline bool kasan_async_fault_possible(void)
{
	return kasan_mode == KASAN_MODE_ASYNC || kasan_mode == KASAN_MODE_ASYMM;
}

static inline bool kasan_sync_fault_possible(void)
42
{
43
	return kasan_mode == KASAN_MODE_SYNC || kasan_mode == KASAN_MODE_ASYMM;
44
}
45

46
#else
47

48 49 50 51
static inline bool kasan_stack_collection_enabled(void)
{
	return true;
}
52

53
static inline bool kasan_async_fault_possible(void)
54 55 56 57
{
	return false;
}

58 59 60 61 62
static inline bool kasan_sync_fault_possible(void)
{
	return true;
}

63 64
#endif

65
#if defined(CONFIG_KASAN_GENERIC) || defined(CONFIG_KASAN_SW_TAGS)
66
#define KASAN_GRANULE_SIZE	(1UL << KASAN_SHADOW_SCALE_SHIFT)
67 68 69 70 71
#else
#include <asm/mte-kasan.h>
#define KASAN_GRANULE_SIZE	MTE_GRANULE_SIZE
#endif

72
#define KASAN_GRANULE_MASK	(KASAN_GRANULE_SIZE - 1)
73

74 75
#define KASAN_MEMORY_PER_SHADOW_PAGE	(KASAN_GRANULE_SIZE << PAGE_SHIFT)

76
#ifdef CONFIG_KASAN_GENERIC
77
#define KASAN_PAGE_FREE		0xFF  /* freed page */
78
#define KASAN_PAGE_REDZONE	0xFE  /* redzone for kmalloc_large allocation */
79 80
#define KASAN_SLAB_REDZONE	0xFC  /* redzone for slab object */
#define KASAN_SLAB_FREE		0xFB  /* freed slab object */
81
#define KASAN_VMALLOC_INVALID	0xF8  /* inaccessible space in vmap area */
82
#else
83
#define KASAN_PAGE_FREE		KASAN_TAG_INVALID
84
#define KASAN_PAGE_REDZONE	KASAN_TAG_INVALID
85 86
#define KASAN_SLAB_REDZONE	KASAN_TAG_INVALID
#define KASAN_SLAB_FREE		KASAN_TAG_INVALID
87
#define KASAN_VMALLOC_INVALID	KASAN_TAG_INVALID /* only used for SW_TAGS */
88 89
#endif

90 91
#ifdef CONFIG_KASAN_GENERIC

92
#define KASAN_SLAB_FREETRACK	0xFA  /* freed slab object with free track */
93
#define KASAN_GLOBAL_REDZONE	0xF9  /* redzone for global variable */
94

95
/* Stack redzone shadow values. Compiler ABI, do not change. */
96 97 98 99
#define KASAN_STACK_LEFT	0xF1
#define KASAN_STACK_MID		0xF2
#define KASAN_STACK_RIGHT	0xF3
#define KASAN_STACK_PARTIAL	0xF4
100

101
/* alloca redzone shadow values. */
102 103 104
#define KASAN_ALLOCA_LEFT	0xCA
#define KASAN_ALLOCA_RIGHT	0xCB

105
/* alloca redzone size. Compiler ABI, do not change. */
106 107
#define KASAN_ALLOCA_REDZONE_SIZE	32

108
/* Stack frame marker. Compiler ABI, do not change. */
109 110
#define KASAN_CURRENT_STACK_FRAME_MAGIC 0x41B58AB3

111
/* Dummy value to avoid breaking randconfig/all*config builds. */
112 113 114
#ifndef KASAN_ABI_VERSION
#define KASAN_ABI_VERSION 1
#endif
115

116 117
#endif /* CONFIG_KASAN_GENERIC */

118 119 120 121 122 123 124
/* Metadata layout customization. */
#define META_BYTES_PER_BLOCK 1
#define META_BLOCKS_PER_ROW 16
#define META_BYTES_PER_ROW (META_BLOCKS_PER_ROW * META_BYTES_PER_BLOCK)
#define META_MEM_BYTES_PER_ROW (META_BYTES_PER_ROW * KASAN_GRANULE_SIZE)
#define META_ROWS_AROUND_ADDR 2

125 126 127
enum kasan_report_type {
	KASAN_REPORT_ACCESS,
	KASAN_REPORT_INVALID_FREE,
128
	KASAN_REPORT_DOUBLE_FREE,
129 130
};

131
struct kasan_report_info {
132
	enum kasan_report_type type;
133 134
	void *access_addr;
	void *first_bad_addr;
135 136 137 138 139
	size_t access_size;
	bool is_write;
	unsigned long ip;
};

140
/* Do not change the struct layout: compiler ABI. */
141 142 143 144 145 146
struct kasan_source_location {
	const char *filename;
	int line_no;
	int column_no;
};

147
/* Do not change the struct layout: compiler ABI. */
148 149 150
struct kasan_global {
	const void *beg;		/* Address of the beginning of the global variable. */
	size_t size;			/* Size of the global variable. */
151
	size_t size_with_redzone;	/* Size of the variable + size of the redzone. 32 bytes aligned. */
152 153
	const void *name;
	const void *module_name;	/* Name of the module where the global variable is declared. */
154
	unsigned long has_dynamic_init;	/* This is needed for C++. */
155 156 157
#if KASAN_ABI_VERSION >= 4
	struct kasan_source_location *location;
#endif
158 159 160
#if KASAN_ABI_VERSION >= 5
	char *odr_indicator;
#endif
161 162
};

163
/* Structures for keeping alloc and free tracks. */
164

165 166
#define KASAN_STACK_DEPTH 64

167
struct kasan_track {
168 169
	u32 pid;
	depot_stack_handle_t stack;
170 171
};

172
#if defined(CONFIG_KASAN_TAGS_IDENTIFY) && defined(CONFIG_KASAN_SW_TAGS)
173 174 175 176 177
#define KASAN_NR_FREE_STACKS 5
#else
#define KASAN_NR_FREE_STACKS 1
#endif

178
struct kasan_alloc_meta {
179
	struct kasan_track alloc_track;
180
	/* Generic mode stores free track in kasan_free_meta. */
181 182
#ifdef CONFIG_KASAN_GENERIC
	depot_stack_handle_t aux_stack[2];
183
#else
184
	struct kasan_track free_track[KASAN_NR_FREE_STACKS];
185
#endif
186
#ifdef CONFIG_KASAN_TAGS_IDENTIFY
187 188 189
	u8 free_pointer_tag[KASAN_NR_FREE_STACKS];
	u8 free_track_idx;
#endif
190 191
};

192 193 194
struct qlist_node {
	struct qlist_node *next;
};
195 196

/*
197 198 199
 * Free meta is stored either in the object itself or in the redzone after the
 * object. In the former case, free meta offset is 0. In the latter case, the
 * offset is between 0 and INT_MAX. INT_MAX marks that free meta is not present.
200 201 202
 */
#define KASAN_NO_FREE_META INT_MAX

203 204 205 206
/*
 * Free meta is only used by Generic mode while the object is in quarantine.
 * After that, slab allocator stores the freelist pointer in the object.
 */
207
struct kasan_free_meta {
208
#ifdef CONFIG_KASAN_GENERIC
209
	struct qlist_node quarantine_link;
210 211
	struct kasan_track free_track;
#endif
212 213
};

214 215 216 217 218 219 220 221
#if IS_ENABLED(CONFIG_KASAN_KUNIT_TEST)
/* Used in KUnit-compatible KASAN tests. */
struct kunit_kasan_status {
	bool report_found;
	bool sync_fault;
};
#endif

222 223
struct kasan_alloc_meta *kasan_get_alloc_meta(struct kmem_cache *cache,
						const void *object);
224
#ifdef CONFIG_KASAN_GENERIC
225 226
struct kasan_free_meta *kasan_get_free_meta(struct kmem_cache *cache,
						const void *object);
227
#endif
228

229 230
#if defined(CONFIG_KASAN_GENERIC) || defined(CONFIG_KASAN_SW_TAGS)

231 232 233 234 235 236
static inline const void *kasan_shadow_to_mem(const void *shadow_addr)
{
	return (void *)(((unsigned long)shadow_addr - KASAN_SHADOW_OFFSET)
		<< KASAN_SHADOW_SCALE_SHIFT);
}

237
static inline bool addr_has_metadata(const void *addr)
238
{
239 240
	return (kasan_reset_tag(addr) >=
		kasan_shadow_to_mem((void *)KASAN_SHADOW_START));
241 242
}

243
/**
244
 * kasan_check_range - Check memory region, and report if invalid access.
245 246 247 248 249 250
 * @addr: the accessed address
 * @size: the accessed size
 * @write: true if access is a write access
 * @ret_ip: return address
 * @return: true if access was valid, false if invalid
 */
251
bool kasan_check_range(unsigned long addr, size_t size, bool write,
252 253
				unsigned long ret_ip);

254 255 256 257
#else /* CONFIG_KASAN_GENERIC || CONFIG_KASAN_SW_TAGS */

static inline bool addr_has_metadata(const void *addr)
{
258
	return (is_vmalloc_addr(addr) || virt_addr_valid(addr));
259 260 261 262
}

#endif /* CONFIG_KASAN_GENERIC || CONFIG_KASAN_SW_TAGS */

263
#if defined(CONFIG_KASAN_SW_TAGS) || defined(CONFIG_KASAN_HW_TAGS)
264
void kasan_print_tags(u8 addr_tag, const void *addr);
265
#else
266
static inline void kasan_print_tags(u8 addr_tag, const void *addr) { }
267 268
#endif

269
void *kasan_find_first_bad_addr(void *addr, size_t size);
270
const char *kasan_get_bug_type(struct kasan_report_info *info);
271
void kasan_metadata_fetch_row(char *buffer, void *row);
272

273
#if defined(CONFIG_KASAN_STACK)
274
void kasan_print_address_stack_frame(const void *addr);
275
#else
276
static inline void kasan_print_address_stack_frame(const void *addr) { }
277 278
#endif

279
bool kasan_report(unsigned long addr, size_t size,
280
		bool is_write, unsigned long ip);
281
void kasan_report_invalid_free(void *object, unsigned long ip, enum kasan_report_type type);
282

283
struct page *kasan_addr_to_page(const void *addr);
284
struct slab *kasan_addr_to_slab(const void *addr);
285

286
depot_stack_handle_t kasan_save_stack(gfp_t flags, bool can_alloc);
287 288 289 290
void kasan_set_track(struct kasan_track *track, gfp_t flags);
void kasan_set_free_info(struct kmem_cache *cache, void *object, u8 tag);
struct kasan_track *kasan_get_free_track(struct kmem_cache *cache,
				void *object, u8 tag);
291

292 293
#if defined(CONFIG_KASAN_GENERIC) && \
	(defined(CONFIG_SLAB) || defined(CONFIG_SLUB))
294 295 296
bool kasan_quarantine_put(struct kmem_cache *cache, void *object);
void kasan_quarantine_reduce(void);
void kasan_quarantine_remove_cache(struct kmem_cache *cache);
297
#else
298 299 300
static inline bool kasan_quarantine_put(struct kmem_cache *cache, void *object) { return false; }
static inline void kasan_quarantine_reduce(void) { }
static inline void kasan_quarantine_remove_cache(struct kmem_cache *cache) { }
301 302
#endif

303
#ifndef arch_kasan_set_tag
304 305 306 307
static inline const void *arch_kasan_set_tag(const void *addr, u8 tag)
{
	return addr;
}
308 309 310 311 312 313 314 315
#endif
#ifndef arch_kasan_get_tag
#define arch_kasan_get_tag(addr)	0
#endif

#define set_tag(addr, tag)	((void *)arch_kasan_set_tag((addr), (tag)))
#define get_tag(addr)		arch_kasan_get_tag(addr)

316 317
#ifdef CONFIG_KASAN_HW_TAGS

318 319 320 321 322
#ifndef arch_enable_tagging_sync
#define arch_enable_tagging_sync()
#endif
#ifndef arch_enable_tagging_async
#define arch_enable_tagging_async()
323
#endif
324 325 326
#ifndef arch_enable_tagging_asymm
#define arch_enable_tagging_asymm()
#endif
327 328 329
#ifndef arch_force_async_tag_fault
#define arch_force_async_tag_fault()
#endif
330 331 332 333 334 335 336
#ifndef arch_get_random_tag
#define arch_get_random_tag()	(0xFF)
#endif
#ifndef arch_get_mem_tag
#define arch_get_mem_tag(addr)	(0xFF)
#endif
#ifndef arch_set_mem_tag_range
337
#define arch_set_mem_tag_range(addr, size, tag, init) ((void *)(addr))
338 339
#endif

340 341
#define hw_enable_tagging_sync()		arch_enable_tagging_sync()
#define hw_enable_tagging_async()		arch_enable_tagging_async()
342
#define hw_enable_tagging_asymm()		arch_enable_tagging_asymm()
343
#define hw_force_async_tag_fault()		arch_force_async_tag_fault()
344 345
#define hw_get_random_tag()			arch_get_random_tag()
#define hw_get_mem_tag(addr)			arch_get_mem_tag(addr)
346 347
#define hw_set_mem_tag_range(addr, size, tag, init) \
			arch_set_mem_tag_range((addr), (size), (tag), (init))
348

349 350
void kasan_enable_tagging(void);

351 352
#else /* CONFIG_KASAN_HW_TAGS */

353 354
#define hw_enable_tagging_sync()
#define hw_enable_tagging_async()
355
#define hw_enable_tagging_asymm()
356

357 358
static inline void kasan_enable_tagging(void) { }

359 360
#endif /* CONFIG_KASAN_HW_TAGS */

361 362
#if defined(CONFIG_KASAN_HW_TAGS) && IS_ENABLED(CONFIG_KASAN_KUNIT_TEST)

363
void kasan_force_async_fault(void);
364

365
#else /* CONFIG_KASAN_HW_TAGS && CONFIG_KASAN_KUNIT_TEST */
366

367
static inline void kasan_force_async_fault(void) { }
368

369
#endif /* CONFIG_KASAN_HW_TAGS && CONFIG_KASAN_KUNIT_TEST */
370

371
#ifdef CONFIG_KASAN_SW_TAGS
372
u8 kasan_random_tag(void);
373
#elif defined(CONFIG_KASAN_HW_TAGS)
374
static inline u8 kasan_random_tag(void) { return hw_get_random_tag(); }
375
#else
376
static inline u8 kasan_random_tag(void) { return 0; }
377 378
#endif

379 380
#ifdef CONFIG_KASAN_HW_TAGS

381
static inline void kasan_poison(const void *addr, size_t size, u8 value, bool init)
382
{
383
	addr = kasan_reset_tag(addr);
384 385

	/* Skip KFENCE memory if called explicitly outside of sl*b. */
386
	if (is_kfence_address(addr))
387 388
		return;

389 390 391 392 393
	if (WARN_ON((unsigned long)addr & KASAN_GRANULE_MASK))
		return;
	if (WARN_ON(size & KASAN_GRANULE_MASK))
		return;

394
	hw_set_mem_tag_range((void *)addr, size, value, init);
395 396
}

397
static inline void kasan_unpoison(const void *addr, size_t size, bool init)
398
{
399
	u8 tag = get_tag(addr);
400

401
	addr = kasan_reset_tag(addr);
402 403

	/* Skip KFENCE memory if called explicitly outside of sl*b. */
404 405 406 407
	if (is_kfence_address(addr))
		return;

	if (WARN_ON((unsigned long)addr & KASAN_GRANULE_MASK))
408
		return;
409 410
	/*
	 * Explicitly initialize the memory with the precise object size to
411 412 413 414
	 * avoid overwriting the slab redzone. This disables initialization in
	 * the arch code and may thus lead to performance penalty. This penalty
	 * does not affect production builds, as slab redzones are not enabled
	 * there.
415 416 417 418 419 420
	 */
	if (__slub_debug_enabled() &&
	    init && ((unsigned long)size & KASAN_GRANULE_MASK)) {
		init = false;
		memzero_explicit((void *)addr, size);
	}
421
	size = round_up(size, KASAN_GRANULE_SIZE);
422

423
	hw_set_mem_tag_range((void *)addr, size, tag, init);
424 425
}

426
static inline bool kasan_byte_accessible(const void *addr)
427 428
{
	u8 ptr_tag = get_tag(addr);
429
	u8 mem_tag = hw_get_mem_tag((void *)addr);
430

431
	return ptr_tag == KASAN_TAG_KERNEL || ptr_tag == mem_tag;
432 433 434 435
}

#else /* CONFIG_KASAN_HW_TAGS */

436
/**
Ingo Molnar's avatar
Ingo Molnar committed
437
 * kasan_poison - mark the memory range as inaccessible
438
 * @addr - range start address, must be aligned to KASAN_GRANULE_SIZE
439
 * @size - range size, must be aligned to KASAN_GRANULE_SIZE
440
 * @value - value that's written to metadata for the range
441
 * @init - whether to initialize the memory range (only for hardware tag-based)
442 443 444
 *
 * The size gets aligned to KASAN_GRANULE_SIZE before marking the range.
 */
445
void kasan_poison(const void *addr, size_t size, u8 value, bool init);
446 447 448 449

/**
 * kasan_unpoison - mark the memory range as accessible
 * @addr - range start address, must be aligned to KASAN_GRANULE_SIZE
450
 * @size - range size, can be unaligned
451
 * @init - whether to initialize the memory range (only for hardware tag-based)
452 453 454 455 456 457
 *
 * For the tag-based modes, the @size gets aligned to KASAN_GRANULE_SIZE before
 * marking the range.
 * For the generic mode, the last granule of the memory range gets partially
 * unpoisoned based on the @size.
 */
458
void kasan_unpoison(const void *addr, size_t size, bool init);
459

460
bool kasan_byte_accessible(const void *addr);
461 462 463

#endif /* CONFIG_KASAN_HW_TAGS */

464 465 466 467
#ifdef CONFIG_KASAN_GENERIC

/**
 * kasan_poison_last_granule - mark the last granule of the memory range as
Ingo Molnar's avatar
Ingo Molnar committed
468
 * inaccessible
469 470 471 472 473 474 475 476 477 478 479 480 481 482
 * @addr - range start address, must be aligned to KASAN_GRANULE_SIZE
 * @size - range size
 *
 * This function is only available for the generic mode, as it's the only mode
 * that has partially poisoned memory granules.
 */
void kasan_poison_last_granule(const void *address, size_t size);

#else /* CONFIG_KASAN_GENERIC */

static inline void kasan_poison_last_granule(const void *address, size_t size) { }

#endif /* CONFIG_KASAN_GENERIC */

483 484 485 486 487 488
#ifndef kasan_arch_is_ready
static inline bool kasan_arch_is_ready(void)	{ return true; }
#elif !defined(CONFIG_KASAN_GENERIC) || !defined(CONFIG_KASAN_OUTLINE)
#error kasan_arch_is_ready only works in KASAN generic outline mode!
#endif

489 490 491 492 493 494 495
#if IS_ENABLED(CONFIG_KASAN_KUNIT_TEST) || IS_ENABLED(CONFIG_KASAN_MODULE_TEST)

bool kasan_save_enable_multi_shot(void);
void kasan_restore_multi_shot(bool enabled);

#endif

496 497
/*
 * Exported functions for interfaces called from assembly or from generated
498
 * code. Declared here to avoid warnings about missing declarations.
499
 */
500

501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517
asmlinkage void kasan_unpoison_task_stack_below(const void *watermark);
void __asan_register_globals(struct kasan_global *globals, size_t size);
void __asan_unregister_globals(struct kasan_global *globals, size_t size);
void __asan_handle_no_return(void);
void __asan_alloca_poison(unsigned long addr, size_t size);
void __asan_allocas_unpoison(const void *stack_top, const void *stack_bottom);

void __asan_load1(unsigned long addr);
void __asan_store1(unsigned long addr);
void __asan_load2(unsigned long addr);
void __asan_store2(unsigned long addr);
void __asan_load4(unsigned long addr);
void __asan_store4(unsigned long addr);
void __asan_load8(unsigned long addr);
void __asan_store8(unsigned long addr);
void __asan_load16(unsigned long addr);
void __asan_store16(unsigned long addr);
518 519
void __asan_loadN(unsigned long addr, size_t size);
void __asan_storeN(unsigned long addr, size_t size);
520 521 522 523 524 525 526 527 528 529 530

void __asan_load1_noabort(unsigned long addr);
void __asan_store1_noabort(unsigned long addr);
void __asan_load2_noabort(unsigned long addr);
void __asan_store2_noabort(unsigned long addr);
void __asan_load4_noabort(unsigned long addr);
void __asan_store4_noabort(unsigned long addr);
void __asan_load8_noabort(unsigned long addr);
void __asan_store8_noabort(unsigned long addr);
void __asan_load16_noabort(unsigned long addr);
void __asan_store16_noabort(unsigned long addr);
531 532 533 534 535 536 537 538 539 540 541 542 543 544 545
void __asan_loadN_noabort(unsigned long addr, size_t size);
void __asan_storeN_noabort(unsigned long addr, size_t size);

void __asan_report_load1_noabort(unsigned long addr);
void __asan_report_store1_noabort(unsigned long addr);
void __asan_report_load2_noabort(unsigned long addr);
void __asan_report_store2_noabort(unsigned long addr);
void __asan_report_load4_noabort(unsigned long addr);
void __asan_report_store4_noabort(unsigned long addr);
void __asan_report_load8_noabort(unsigned long addr);
void __asan_report_store8_noabort(unsigned long addr);
void __asan_report_load16_noabort(unsigned long addr);
void __asan_report_store16_noabort(unsigned long addr);
void __asan_report_load_n_noabort(unsigned long addr, size_t size);
void __asan_report_store_n_noabort(unsigned long addr, size_t size);
546 547 548 549 550 551 552 553

void __asan_set_shadow_00(const void *addr, size_t size);
void __asan_set_shadow_f1(const void *addr, size_t size);
void __asan_set_shadow_f2(const void *addr, size_t size);
void __asan_set_shadow_f3(const void *addr, size_t size);
void __asan_set_shadow_f5(const void *addr, size_t size);
void __asan_set_shadow_f8(const void *addr, size_t size);

554 555 556 557 558 559 560 561 562 563 564 565 566 567 568
void __hwasan_load1_noabort(unsigned long addr);
void __hwasan_store1_noabort(unsigned long addr);
void __hwasan_load2_noabort(unsigned long addr);
void __hwasan_store2_noabort(unsigned long addr);
void __hwasan_load4_noabort(unsigned long addr);
void __hwasan_store4_noabort(unsigned long addr);
void __hwasan_load8_noabort(unsigned long addr);
void __hwasan_store8_noabort(unsigned long addr);
void __hwasan_load16_noabort(unsigned long addr);
void __hwasan_store16_noabort(unsigned long addr);
void __hwasan_loadN_noabort(unsigned long addr, size_t size);
void __hwasan_storeN_noabort(unsigned long addr, size_t size);

void __hwasan_tag_memory(unsigned long addr, u8 tag, unsigned long size);

569
#endif /* __MM_KASAN_KASAN_H */