mm/kasan/kasan.h

   1 #ifndef __MM_KASAN_KASAN_H
   2 #define __MM_KASAN_KASAN_H
   3
   4 #include <linux/kasan.h>
   5 #include <linux/stackdepot.h>
   6
   7 #define KASAN_SHADOW_SCALE_SIZE (1UL << KASAN_SHADOW_SCALE_SHIFT)
   8 #define KASAN_SHADOW_MASK       (KASAN_SHADOW_SCALE_SIZE - 1)
   9
  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) */
  14 #define KASAN_GLOBAL_REDZONE    0xFA  /* redzone for global variable */
  15
  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 #define KASAN_USE_AFTER_SCOPE   0xF8
  25
  26 /* Don't break randconfig/all*config builds */
  27 #ifndef KASAN_ABI_VERSION
  28 #define KASAN_ABI_VERSION 1
  29 #endif
  30
  31 struct kasan_access_info {
  32         const void *access_addr;
  33         const void *first_bad_addr;
  34         size_t access_size;
  35         bool is_write;
  36         unsigned long ip;
  37 };
  38
  39 /* The layout of struct dictated by compiler */
  40 struct kasan_source_location {
  41         const char *filename;
  42         int line_no;
  43         int column_no;
  44 };
  45
  46 /* The layout of struct dictated by compiler */
  47 struct kasan_global {
  48         const void *beg;                /* Address of the beginning of the global variable. */
  49         size_t size;                    /* Size of the global variable. */
  50         size_t size_with_redzone;       /* Size of the variable + size of the red zone. 32 bytes aligned */
  51         const void *name;
  52         const void *module_name;        /* Name of the module where the global variable is declared. */
  53         unsigned long has_dynamic_init; /* This needed for C++ */
  54 #if KASAN_ABI_VERSION >= 4
  55         struct kasan_source_location *location;
  56 #endif
  57 #if KASAN_ABI_VERSION >= 5
  58         char *odr_indicator;
  59 #endif
  60 };
  61
  62 /**
  63  * Structures to keep alloc and free tracks *
  64  */
  65
  66 #define KASAN_STACK_DEPTH 64
  67
  68 struct kasan_track {
  69         u32 pid;
  70         depot_stack_handle_t stack;
  71 };
  72
  73 struct kasan_alloc_meta {
  74         struct kasan_track alloc_track;
  75         struct kasan_track free_track;
  76 };
  77
  78 struct qlist_node {
  79         struct qlist_node *next;
  80 };
  81 struct kasan_free_meta {
  82         /* This field is used while the object is in the quarantine.
  83          * Otherwise it might be used for the allocator freelist.
  84          */
  85         struct qlist_node quarantine_link;
  86 };
  87
  88 struct kasan_alloc_meta *get_alloc_info(struct kmem_cache *cache,
  89                                         const void *object);
  90 struct kasan_free_meta *get_free_info(struct kmem_cache *cache,
  91                                         const void *object);
  92
  93 static inline const void *kasan_shadow_to_mem(const void *shadow_addr)
  94 {
  95         return (void *)(((unsigned long)shadow_addr - KASAN_SHADOW_OFFSET)
  96                 << KASAN_SHADOW_SCALE_SHIFT);
  97 }
  98
  99 void kasan_report(unsigned long addr, size_t size,
 100                 bool is_write, unsigned long ip);
 101 void kasan_report_double_free(struct kmem_cache *cache, void *object,
 102                                         void *ip);
 103
 104 #if defined(CONFIG_SLAB) || defined(CONFIG_SLUB)
 105 void quarantine_put(struct kasan_free_meta *info, struct kmem_cache *cache);
 106 void quarantine_reduce(void);
 107 void quarantine_remove_cache(struct kmem_cache *cache);
 108 #else
 109 static inline void quarantine_put(struct kasan_free_meta *info,
 110                                 struct kmem_cache *cache) { }
 111 static inline void quarantine_reduce(void) { }
 112 static inline void quarantine_remove_cache(struct kmem_cache *cache) { }
 113 #endif
 114
 115 #endif