ALSA: memalloc: Drop snd_dma_pci_data() macro
[linux-2.6-block.git] / lib / Kconfig.kasan
CommitLineData
ec8f24b7 1# SPDX-License-Identifier: GPL-2.0-only
2bd926b4 2# This config refers to the generic KASAN mode.
0b24becc
AR
3config HAVE_ARCH_KASAN
4 bool
5
2bd926b4
AK
6config HAVE_ARCH_KASAN_SW_TAGS
7 bool
8
9config CC_HAS_KASAN_GENERIC
10 def_bool $(cc-option, -fsanitize=kernel-address)
11
12config CC_HAS_KASAN_SW_TAGS
13 def_bool $(cc-option, -fsanitize=kernel-hwaddress)
0b24becc
AR
14
15config KASAN
2bd926b4
AK
16 bool "KASAN: runtime memory debugger"
17 depends on (HAVE_ARCH_KASAN && CC_HAS_KASAN_GENERIC) || \
18 (HAVE_ARCH_KASAN_SW_TAGS && CC_HAS_KASAN_SW_TAGS)
19 depends on (SLUB && SYSFS) || (SLAB && !DEBUG_SLAB)
20 help
21 Enables KASAN (KernelAddressSANitizer) - runtime memory debugger,
22 designed to find out-of-bounds accesses and use-after-free bugs.
23 See Documentation/dev-tools/kasan.rst for details.
24
25choice
26 prompt "KASAN mode"
27 depends on KASAN
28 default KASAN_GENERIC
29 help
30 KASAN has two modes: generic KASAN (similar to userspace ASan,
31 x86_64/arm64/xtensa, enabled with CONFIG_KASAN_GENERIC) and
32 software tag-based KASAN (a version based on software memory
33 tagging, arm64 only, similar to userspace HWASan, enabled with
34 CONFIG_KASAN_SW_TAGS).
35 Both generic and tag-based KASAN are strictly debugging features.
36
37config KASAN_GENERIC
38 bool "Generic mode"
39 depends on HAVE_ARCH_KASAN && CC_HAS_KASAN_GENERIC
03758dbb 40 depends on (SLUB && SYSFS) || (SLAB && !DEBUG_SLAB)
dd275caf 41 select SLUB_DEBUG if SLUB
bebf56a1 42 select CONSTRUCTORS
80a9201a 43 select STACKDEPOT
0b24becc 44 help
2bd926b4
AK
45 Enables generic KASAN mode.
46 Supported in both GCC and Clang. With GCC it requires version 4.9.2
47 or later for basic support and version 5.0 or later for detection of
48 out-of-bounds accesses for stack and global variables and for inline
49 instrumentation mode (CONFIG_KASAN_INLINE). With Clang it requires
50 version 3.7.0 or later and it doesn't support detection of
51 out-of-bounds accesses for global variables yet.
52 This mode consumes about 1/8th of available memory at kernel start
53 and introduces an overhead of ~x1.5 for the rest of the allocations.
54 The performance slowdown is ~x3.
89d3c87e 55 For better error detection enable CONFIG_STACKTRACE.
2bd926b4 56 Currently CONFIG_KASAN_GENERIC doesn't work with CONFIG_DEBUG_SLAB
7ed2f9e6 57 (the resulting kernel does not boot).
0b24becc 58
2bd926b4
AK
59config KASAN_SW_TAGS
60 bool "Software tag-based mode"
61 depends on HAVE_ARCH_KASAN_SW_TAGS && CC_HAS_KASAN_SW_TAGS
62 depends on (SLUB && SYSFS) || (SLAB && !DEBUG_SLAB)
63 select SLUB_DEBUG if SLUB
64 select CONSTRUCTORS
65 select STACKDEPOT
66 help
67 Enables software tag-based KASAN mode.
68 This mode requires Top Byte Ignore support by the CPU and therefore
69 is only supported for arm64.
70 This mode requires Clang version 7.0.0 or later.
71 This mode consumes about 1/16th of available memory at kernel start
72 and introduces an overhead of ~20% for the rest of the allocations.
73 This mode may potentially introduce problems relating to pointer
74 casting and comparison, as it embeds tags into the top byte of each
75 pointer.
76 For better error detection enable CONFIG_STACKTRACE.
77 Currently CONFIG_KASAN_SW_TAGS doesn't work with CONFIG_DEBUG_SLAB
78 (the resulting kernel does not boot).
79
80endchoice
81
0b24becc
AR
82choice
83 prompt "Instrumentation type"
84 depends on KASAN
85 default KASAN_OUTLINE
86
87config KASAN_OUTLINE
88 bool "Outline instrumentation"
89 help
90 Before every memory access compiler insert function call
91 __asan_load*/__asan_store*. These functions performs check
92 of shadow memory. This is slower than inline instrumentation,
93 however it doesn't bloat size of kernel's .text section so
94 much as inline does.
95
96config KASAN_INLINE
97 bool "Inline instrumentation"
98 help
99 Compiler directly inserts code checking shadow memory before
100 memory accesses. This is faster than outline (in some workloads
101 it gives about x2 boost over outline instrumentation), but
102 make kernel's .text size much bigger.
2bd926b4 103 For CONFIG_KASAN_GENERIC this requires GCC 5.0 or later.
0b24becc
AR
104
105endchoice
106
6baec880
AB
107config KASAN_STACK_ENABLE
108 bool "Enable stack instrumentation (unsafe)" if CC_IS_CLANG && !COMPILE_TEST
6baec880
AB
109 depends on KASAN
110 help
111 The LLVM stack address sanitizer has a know problem that
112 causes excessive stack usage in a lot of functions, see
113 https://bugs.llvm.org/show_bug.cgi?id=38809
114 Disabling asan-stack makes it safe to run kernels build
115 with clang-8 with KASAN enabled, though it loses some of
116 the functionality.
ebb6d35a
AB
117 This feature is always disabled when compile-testing with clang
118 to avoid cluttering the output in stack overflow warnings,
119 but clang users can still enable it for builds without
120 CONFIG_COMPILE_TEST. On gcc it is assumed to always be safe
121 to use and enabled by default.
6baec880
AB
122
123config KASAN_STACK
124 int
125 default 1 if KASAN_STACK_ENABLE || CC_IS_GCC
126 default 0
127
5dff0381
VG
128config KASAN_S390_4_LEVEL_PAGING
129 bool "KASan: use 4-level paging"
130 depends on KASAN && S390
131 help
132 Compiling the kernel with KASan disables automatic 3-level vs
133 4-level paging selection. 3-level paging is used by default (up
134 to 3TB of RAM with KASan enabled). This options allows to force
135 4-level paging instead.
136
ae8f06b3
WW
137config KASAN_SW_TAGS_IDENTIFY
138 bool "Enable memory corruption identification"
139 depends on KASAN_SW_TAGS
140 help
141 This option enables best-effort identification of bug type
142 (use-after-free or out-of-bounds) at the cost of increased
143 memory consumption.
144
3f15801c 145config TEST_KASAN
2bd926b4 146 tristate "Module for testing KASAN for bug detection"
3f15801c
AR
147 depends on m && KASAN
148 help
149 This is a test module doing various nasty things like
150 out of bounds accesses, use after free. It is useful for testing
2bd926b4 151 kernel debugging features like KASAN.