]> git.saurik.com Git - apple/xnu.git/blobdiff - san/kasan_internal.h
xnu-6153.101.6.tar.gz
[apple/xnu.git] / san / kasan_internal.h
index 36ae0b234dffa7b20665902244567b5bfed82bd3..f0565a0043c5e45b9d965ebc4b77c72db39a8229 100644 (file)
 
 typedef uintptr_t uptr;
 
+#define MiB(x) ((x) * 1024UL * 1024)
+
 /*
  * KASAN features and config
  */
-#define KASAN_DEBUG   1
 #define FAKESTACK     1
-#define MEMINTRINSICS 1
 /* KASAN_KALLOC defined in kasan.h */
 /* KASAN_ZALLOC defined in kasan.h */
 #define FAKESTACK_QUARANTINE (1 && FAKESTACK)
 
 #define QUARANTINE_ENTRIES 5000
-#define QUARANTINE_MAXSIZE (10UL * 1024 * 1024)
+#define QUARANTINE_MAXSIZE MiB(10)
+
+/*
+ * The amount of physical memory stolen by KASan at boot to back the shadow memory
+ * and page tables. Larger memory systems need to steal proportionally less.
+ */
+#ifdef __arm64__
+/* Works out at about 25% of 512 MiB and 15% of 3GiB system */
+# define STOLEN_MEM_PERCENT  13UL
+# define STOLEN_MEM_BYTES    MiB(40)
+# define HW_PAGE_SIZE        (ARM_PGBYTES)
+# define HW_PAGE_MASK        (ARM_PGMASK)
+#else
+# define STOLEN_MEM_PERCENT  25UL
+# define STOLEN_MEM_BYTES    0
+# define HW_PAGE_SIZE        (PAGE_SIZE)
+# define HW_PAGE_MASK        (PAGE_MASK)
+#endif
+
+/* boot-args */
+#define KASAN_ARGS_FAKESTACK       0x0010U
+#define KASAN_ARGS_REPORTIGNORED   0x0020U
+#define KASAN_ARGS_NODYCHECKS      0x0100U
+#define KASAN_ARGS_NOPOISON_HEAP   0x0200U
+#define KASAN_ARGS_NOPOISON_GLOBAL 0x0400U
+#define KASAN_ARGS_CHECK_LEAKS     0x0800U
+
+/* uninitialized memory detection */
+#define KASAN_UNINITIALIZED_HEAP   0xbe
 
 #ifndef KASAN
 # error KASAN undefined
@@ -59,61 +87,88 @@ typedef uintptr_t uptr;
 #define ADDRESS_FOR_SHADOW(x) (((x) - KASAN_SHIFT) << 3)
 #define SHADOW_FOR_ADDRESS(x) (uint8_t *)(((x) >> 3) + KASAN_SHIFT)
 
-#define NOINLINE __attribute__ ((noinline))
+#if KASAN_DEBUG
+# define NOINLINE OS_NOINLINE
+#else
+# define NOINLINE
+#endif
 #define ALWAYS_INLINE inline __attribute__((always_inline))
 
 #define CLANG_MIN_VERSION(x) (defined(__apple_build_version__) && (__apple_build_version__ >= (x)))
 
 #define BIT(x) (1U << (x))
 
-enum kasan_access_type {
-       /* exactly one of these bits must be set */
-       TYPE_LOAD       = BIT(0),
-       TYPE_STORE      = BIT(1),
-       TYPE_KFREE      = BIT(2),
-       TYPE_ZFREE      = BIT(3),
-       TYPE_FSFREE     = BIT(4), /* fakestack free */
-       TYPE_MEMLD      = BIT(5), /* memory intrinsic - load */
-       TYPE_MEMSTR     = BIT(6), /* memory intrinsic - store */
-       TYPE_STRINGLD   = BIT(7), /* string intrinsic - load */
-       TYPE_STRINGSTR  = BIT(8), /* string intrinsic - store */
-       TYPE_TEST       = BIT(15),
+enum __attribute__((flag_enum)) kasan_access_types {
+       TYPE_LOAD    = BIT(0),  /* regular memory load */
+       TYPE_STORE   = BIT(1),  /* regular store */
+       TYPE_MEMR    = BIT(2),  /* memory intrinsic (read) */
+       TYPE_MEMW    = BIT(3),  /* memory intrinsic (write) */
+       TYPE_STRR    = BIT(4),  /* string intrinsic (read) */
+       TYPE_STRW    = BIT(5),  /* string intrinsic (write) */
+       TYPE_KFREE   = BIT(6),  /* kfree() */
+       TYPE_ZFREE   = BIT(7),  /* zfree() */
+       TYPE_FSFREE  = BIT(8),  /* fakestack free */
+
+       TYPE_UAF           = BIT(12),
+       TYPE_POISON_GLOBAL = BIT(13),
+       TYPE_POISON_HEAP   = BIT(14),
+       /* no TYPE_POISON_STACK, because the runtime does not control stack poisoning */
+       TYPE_TEST          = BIT(15),
+       TYPE_LEAK          = BIT(16),
 
        /* masks */
-       TYPE_LDSTR      = TYPE_LOAD|TYPE_STORE, /* regular loads and stores */
-       TYPE_FREE       = TYPE_KFREE|TYPE_ZFREE|TYPE_FSFREE,
-       TYPE_MEM        = TYPE_MEMLD|TYPE_MEMSTR,
-       TYPE_STRING     = TYPE_STRINGLD|TYPE_STRINGSTR,
-       TYPE_LOAD_ALL   = TYPE_LOAD|TYPE_MEMLD|TYPE_STRINGLD,
-       TYPE_STORE_ALL  = TYPE_STORE|TYPE_MEMSTR|TYPE_STRINGSTR,
-       TYPE_ALL        = ~0U
+       TYPE_MEM     = TYPE_MEMR | TYPE_MEMW,            /* memory intrinsics */
+       TYPE_STR     = TYPE_STRR | TYPE_STRW,            /* string intrinsics */
+       TYPE_READ    = TYPE_LOAD | TYPE_MEMR | TYPE_STRR,  /* all reads */
+       TYPE_WRITE   = TYPE_STORE | TYPE_MEMW | TYPE_STRW, /* all writes */
+       TYPE_RW      = TYPE_READ | TYPE_WRITE,           /* reads and writes */
+       TYPE_FREE    = TYPE_KFREE | TYPE_ZFREE | TYPE_FSFREE,
+       TYPE_NORMAL  = TYPE_RW | TYPE_FREE,
+       TYPE_DYNAMIC = TYPE_NORMAL | TYPE_UAF,
+       TYPE_POISON  = TYPE_POISON_GLOBAL | TYPE_POISON_HEAP,
+       TYPE_ALL     = ~0U,
+};
+
+enum kasan_violation_types {
+       REASON_POISONED =       0, /* read or write of poisoned data */
+       REASON_BAD_METADATA =   1, /* incorrect kasan metadata */
+       REASON_INVALID_SIZE =   2, /* free size did not match alloc size */
+       REASON_MOD_AFTER_FREE = 3, /* object modified after free */
+       REASON_MOD_OOB =        4, /* out of bounds modification of object */
+       REASON_UNINITIALIZED =  5, /* leak of uninitialized kernel memory */
 };
 
+typedef enum kasan_access_types access_t;
+typedef enum kasan_violation_types violation_t;
+
 bool kasan_range_poisoned(vm_offset_t base, vm_size_t size, vm_offset_t *first_invalid);
-void kasan_check_range(const void *x, size_t sz, unsigned access_type);
+void kasan_check_range(const void *x, size_t sz, access_t);
 void kasan_test(int testno, int fail);
 void kasan_handle_test(void);
-void kasan_unpoison_curstack(void);
 void kasan_free_internal(void **addrp, vm_size_t *sizep, int type, zone_t *, vm_size_t user_size, int locked, bool doquarantine);
 void kasan_poison(vm_offset_t base, vm_size_t size, vm_size_t leftrz, vm_size_t rightrz, uint8_t flags);
-void kasan_unpoison(void *base, vm_size_t size);
 void kasan_lock(boolean_t *b);
 void kasan_unlock(boolean_t b);
+bool kasan_lock_held(thread_t thread);
 void kasan_init_fakestack(void);
 
 /* dynamic blacklist */
 void kasan_init_dybl(void);
-bool kasan_is_blacklisted(unsigned type);
+bool kasan_is_blacklisted(access_t);
 void kasan_dybl_load_kext(uintptr_t addr, const char *kextname);
 void kasan_dybl_unload_kext(uintptr_t addr);
 
 /* arch-specific interface */
 void kasan_arch_init(void);
+bool kasan_is_shadow_mapped(uintptr_t shadowp);
 
 extern vm_address_t kernel_vbase;
 extern vm_address_t kernel_vtop;
 
-extern long shadow_pages_used;
+extern unsigned shadow_pages_used;
+
+/* boot-arg configurable */
+extern int fakestack_enabled;
 
 /* Describes the source location where a global is defined. */
 struct asan_global_source_location {
@@ -138,11 +193,14 @@ struct asan_global {
 
 #if defined(__x86_64__)
 # define _JBLEN ((9 * 2) + 3 + 16)
+#elif defined(__arm64__)
+# define _JBLEN ((14 + 8 + 2) * 2)
+#else
+# error "Unknown arch"
 #endif
 
-
 typedef int jmp_buf[_JBLEN];
-void _longjmp(jmp_buf env, int val);
-int _setjmp(jmp_buf env);
+void _longjmp(jmp_buf env, int val) OS_NORETURN;
+int _setjmp(jmp_buf env) __attribute__((returns_twice));
 
 #endif /* _KASAN_INTERNAL_H_ */