[deliverable/linux.git] / mm / kasan / kasan.h

#ifndef __MM_KASAN_KASAN_H
#define __MM_KASAN_KASAN_H

#include <linux/kasan.h>
#include <linux/stackdepot.h>

#define KASAN_SHADOW_SCALE_SIZE (1UL << KASAN_SHADOW_SCALE_SHIFT)
#define KASAN_SHADOW_MASK       (KASAN_SHADOW_SCALE_SIZE - 1)

#define KASAN_FREE_PAGE         0xFF  /* page was freed */
#define KASAN_PAGE_REDZONE      0xFE  /* redzone for kmalloc_large allocations */
#define KASAN_KMALLOC_REDZONE   0xFC  /* redzone inside slub object */
#define KASAN_KMALLOC_FREE      0xFB  /* object was freed (kmem_cache_free/kfree) */
#define KASAN_GLOBAL_REDZONE    0xFA  /* redzone for global variable */

/*
 * Stack redzone shadow values
 * (Those are compiler's ABI, don't change them)
 */
#define KASAN_STACK_LEFT        0xF1
#define KASAN_STACK_MID         0xF2
#define KASAN_STACK_RIGHT       0xF3
#define KASAN_STACK_PARTIAL     0xF4

/* Don't break randconfig/all*config builds */
#ifndef KASAN_ABI_VERSION
#define KASAN_ABI_VERSION 1
#endif

struct kasan_access_info {
	const void *access_addr;
	const void *first_bad_addr;
	size_t access_size;
	bool is_write;
	unsigned long ip;
};

/* The layout of struct dictated by compiler */
struct kasan_source_location {
	const char *filename;
	int line_no;
	int column_no;
};

/* The layout of struct dictated by compiler */
struct kasan_global {
	const void *beg;		/* Address of the beginning of the global variable. */
	size_t size;			/* Size of the global variable. */
	size_t size_with_redzone;	/* Size of the variable + size of the red zone. 32 bytes aligned */
	const void *name;
	const void *module_name;	/* Name of the module where the global variable is declared. */
	unsigned long has_dynamic_init;	/* This needed for C++ */
#if KASAN_ABI_VERSION >= 4
	struct kasan_source_location *location;
#endif
};

/**
 * Structures to keep alloc and free tracks *
 */

enum kasan_state {
	KASAN_STATE_INIT,
	KASAN_STATE_ALLOC,
	KASAN_STATE_QUARANTINE,
	KASAN_STATE_FREE
};

#define KASAN_STACK_DEPTH 64

struct kasan_track {
	u32 pid;
	depot_stack_handle_t stack;
};

struct kasan_alloc_meta {
	struct kasan_track track;
	u32 state : 2;	/* enum kasan_state */
	u32 alloc_size : 30;
};

struct qlist_node {
	struct qlist_node *next;
};
struct kasan_free_meta {
	/* This field is used while the object is in the quarantine.
	 * Otherwise it might be used for the allocator freelist.
	 */
	struct qlist_node quarantine_link;
	struct kasan_track track;
};

struct kasan_alloc_meta *get_alloc_info(struct kmem_cache *cache,
					const void *object);
struct kasan_free_meta *get_free_info(struct kmem_cache *cache,
					const void *object);


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);
}

static inline bool kasan_report_enabled(void)
{
	return !current->kasan_depth;
}

void kasan_report(unsigned long addr, size_t size,
		bool is_write, unsigned long ip);

#ifdef CONFIG_SLAB
void quarantine_put(struct kasan_free_meta *info, struct kmem_cache *cache);
void quarantine_reduce(void);
void quarantine_remove_cache(struct kmem_cache *cache);
#else
static inline void quarantine_put(struct kasan_free_meta *info,
				struct kmem_cache *cache) { }
static inline void quarantine_reduce(void) { }
static inline void quarantine_remove_cache(struct kmem_cache *cache) { }
#endif

#endif
Commit	Line	Data
0b24becc AR	1	#ifndef __MM_KASAN_KASAN_H
	2	#define __MM_KASAN_KASAN_H
	3
	4	#include <linux/kasan.h>
cd11016e	5	#include <linux/stackdepot.h>
0b24becc AR	6
	7	#define KASAN_SHADOW_SCALE_SIZE (1UL << KASAN_SHADOW_SCALE_SHIFT)
	8	#define KASAN_SHADOW_MASK (KASAN_SHADOW_SCALE_SIZE - 1)
	9
0316bec2 AR	10	#define KASAN_FREE_PAGE 0xFF /* page was freed */
	11	#define KASAN_PAGE_REDZONE 0xFE /* redzone for kmalloc_large allocations */
	12	#define KASAN_KMALLOC_REDZONE 0xFC /* redzone inside slub object */
	13	#define KASAN_KMALLOC_FREE 0xFB /* object was freed (kmem_cache_free/kfree) */
bebf56a1	14	#define KASAN_GLOBAL_REDZONE 0xFA /* redzone for global variable */
0316bec2	15
c420f167 AR	16	/*
	17	* Stack redzone shadow values
	18	* (Those are compiler's ABI, don't change them)
	19	*/
	20	#define KASAN_STACK_LEFT 0xF1
	21	#define KASAN_STACK_MID 0xF2
	22	#define KASAN_STACK_RIGHT 0xF3
	23	#define KASAN_STACK_PARTIAL 0xF4
	24
bebf56a1 AR	25	/* Don't break randconfig/allconfig builds /
	26	#ifndef KASAN_ABI_VERSION
	27	#define KASAN_ABI_VERSION 1
	28	#endif
b8c73fc2	29
0b24becc AR	30	struct kasan_access_info {
	31	const void *access_addr;
	32	const void *first_bad_addr;
	33	size_t access_size;
	34	bool is_write;
	35	unsigned long ip;
	36	};
	37
bebf56a1 AR	38	/* The layout of struct dictated by compiler */
	39	struct kasan_source_location {
	40	const char *filename;
	41	int line_no;
	42	int column_no;
	43	};
	44
	45	/* The layout of struct dictated by compiler */
	46	struct kasan_global {
	47	const void beg; / Address of the beginning of the global variable. */
	48	size_t size; /* Size of the global variable. */
	49	size_t size_with_redzone; /* Size of the variable + size of the red zone. 32 bytes aligned */
	50	const void *name;
	51	const void module_name; / Name of the module where the global variable is declared. */
	52	unsigned long has_dynamic_init; /* This needed for C++ */
	53	#if KASAN_ABI_VERSION >= 4
	54	struct kasan_source_location *location;
	55	#endif
	56	};
	57
7ed2f9e6 AP	58	/**
	59	* Structures to keep alloc and free tracks *
	60	*/
	61
	62	enum kasan_state {
	63	KASAN_STATE_INIT,
	64	KASAN_STATE_ALLOC,
55834c59	65	KASAN_STATE_QUARANTINE,
7ed2f9e6 AP	66	KASAN_STATE_FREE
	67	};
	68
cd11016e AP	69	#define KASAN_STACK_DEPTH 64
cd11016e AP	70
7ed2f9e6	71	struct kasan_track {
cd11016e AP	72	u32 pid;
cd11016e AP	73	depot_stack_handle_t stack;
7ed2f9e6 AP	74	};
	75
	76	struct kasan_alloc_meta {
cd11016e	77	struct kasan_track track;
7ed2f9e6 AP	78	u32 state : 2; /* enum kasan_state */
7ed2f9e6 AP	79	u32 alloc_size : 30;
7ed2f9e6 AP	80	};
7ed2f9e6 AP	81
55834c59 AP	82	struct qlist_node {
	83	struct qlist_node *next;
	84	};
7ed2f9e6	85	struct kasan_free_meta {
55834c59 AP	86	/* This field is used while the object is in the quarantine.
	87	* Otherwise it might be used for the allocator freelist.
	88	*/
	89	struct qlist_node quarantine_link;
7ed2f9e6 AP	90	struct kasan_track track;
	91	};
	92
	93	struct kasan_alloc_meta get_alloc_info(struct kmem_cache cache,
	94	const void *object);
	95	struct kasan_free_meta get_free_info(struct kmem_cache cache,
	96	const void *object);
	97
	98
0b24becc AR	99	static inline const void kasan_shadow_to_mem(const void shadow_addr)
	100	{
	101	return (void *)(((unsigned long)shadow_addr - KASAN_SHADOW_OFFSET)
	102	<< KASAN_SHADOW_SCALE_SHIFT);
	103	}
	104
0ba8663c	105	static inline bool kasan_report_enabled(void)
0b24becc AR	106	{
	107	return !current->kasan_depth;
	108	}
	109
	110	void kasan_report(unsigned long addr, size_t size,
	111	bool is_write, unsigned long ip);
	112
55834c59 AP	113	#ifdef CONFIG_SLAB
	114	void quarantine_put(struct kasan_free_meta info, struct kmem_cache cache);
	115	void quarantine_reduce(void);
	116	void quarantine_remove_cache(struct kmem_cache *cache);
	117	#else
	118	static inline void quarantine_put(struct kasan_free_meta *info,
	119	struct kmem_cache *cache) { }
	120	static inline void quarantine_reduce(void) { }
	121	static inline void quarantine_remove_cache(struct kmem_cache *cache) { }
	122	#endif
	123
0b24becc	124	#endif