[RFC,v2,00/25] Add KernelMemorySanitizer infrastructure

Message

Alexander Potapenko Oct. 30, 2019, 2:22 p.m. UTC

KernelMemorySanitizer (KMSAN) is a detector of errors related to uses of
uninitialized memory. It relies on compile-time Clang instrumentation
(similar to MSan: https://clang.llvm.org/docs/MemorySanitizer.html)
and tracks the state of every bit of kernel memory, being able to report
an error if uninitialized value is used in a condition, dereferenced or
copied to userspace, USB or network.

KMSAN has reported more than 200 bugs in the past two years, most of
them with the help of syzkaller (http://syzkaller.appspot.com).

The proposed patchset contains KMSAN runtime implementation together
with small changes to other subsystems needed to make KMSAN work.
The latter changes fall into several categories:
 - nice-to-have features that are independent from KMSAN but simplify
   its implementation (stackdepot changes, CONFIG_GENERIC_CSUM etc.);
 - Kconfig changes that prohibit options incompatible with KMSAN;
 - calls to KMSAN runtime functions that help KMSAN do the bookkeeping
   (e.g. tell it to allocate, copy or delete the metadata);
 - calls to KMSAN runtime functions that tell KMSAN to check memory
   escaping the kernel for uninitialized values. These are required to
   increase the number of true positive error reports;
 - calls to runtime functions that tell KMSAN to ignore certain memory
   ranges to avoid false negative reports. Most certainly there can be
   better ways to deal with every such report.

This patchset allows one to boot and run a defconfig+KMSAN kernel on a QEMU
without known major false positives. It however doesn't guarantee there
are no false positives in drivers of certain devices or less tested
subsystems, although KMSAN is actively tested on syzbot with quite a
rich config.

One may find it handy to review these patches in Gerrit:
https://linux-review.googlesource.com/c/linux/kernel/git/torvalds/linux/+/1081
I've ensured the Change-Id: tags stay away from commit descriptions.

The patchset was generated relative to Linux v5.4-rc5.

I also apologize for not sending every patch in the previous series
to all recipients of patches from that series.

Note: checkpatch.pl complains a lot about the use of BUG_ON in KMSAN
source. I don't have a strong opinion on this, but KMSAN is a debugging
tool, so any runtime invariant violation in it renders the tool useless.
Therefore it doesn't make much sense to not terminate after a bug in
KMSAN.

Alexander Potapenko (25):
  stackdepot: check depot_index before accessing the stack slab
  stackdepot: prevent Clang from optimizing away stackdepot_memcmp()
  kasan: stackdepot: move filter_irq_stacks() to stackdepot.c
  stackdepot: reserve 5 extra bits in depot_stack_handle_t
  kmsan: add ReST documentation
  kmsan: gfp: introduce __GFP_NO_KMSAN_SHADOW
  kmsan: introduce __no_sanitize_memory and __SANITIZE_MEMORY__
  kmsan: reduce vmalloc space
  kmsan: add KMSAN runtime
  kmsan: define READ_ONCE_NOCHECK()
  kmsan: x86: sync metadata pages on page fault
  kmsan: add tests for KMSAN
  kmsan: make READ_ONCE_TASK_STACK() return initialized values
  kmsan: Kconfig changes to disable options incompatible with KMSAN
  kmsan: Changing existing files to enable KMSAN builds
  kmsan: disable KMSAN instrumentation for certain kernel parts
  kmsan: mm: call KMSAN hooks from SLUB code
  kmsan: call KMSAN hooks where needed
  kmsan: disable instrumentation of certain functions
  kmsan: unpoison |tlb| in arch_tlb_gather_mmu()
  kmsan: use __msan_memcpy() where possible.
  kmsan: unpoisoning buffers from devices etc.
  kmsan: hooks for copy_to_user() and friends
  kmsan: disable strscpy() optimization under KMSAN
  net: kasan: kmsan: support CONFIG_GENERIC_CSUM on x86, enable it for
    KASAN/KMSAN

To: Alexander Potapenko <[e-mail]>
Cc: Alexander Viro <[e-mail]>
Cc: Andrew Morton <[e-mail]>
Cc: Andrey Ryabinin <[e-mail]>
Cc: Andy Lutomirski <[e-mail]>
Cc: Ard Biesheuvel <[e-mail]>
Cc: Arnd Bergmann <[e-mail]>
Cc: Christoph Hellwig <[e-mail]>
Cc: Dmitry Torokhov <[e-mail]>
Cc: Dmitry Vyukov <[e-mail]>
Cc: Eric Dumazet <[e-mail]>
Cc: Eric Van Hensbergen <[e-mail]>
Cc: Greg Kroah-Hartman <[e-mail]>
Cc: Harry Wentland <[e-mail]>
Cc: Herbert Xu <[e-mail]>
Cc: Ingo Molnar <[e-mail]>
Cc: Jens Axboe <[e-mail]>
Cc: Martin K. Petersen <[e-mail]>
Cc: Martin Schwidefsky <[e-mail]>
Cc: "Michael S. Tsirkin" <[e-mail]>
Cc: Michal Simek <[e-mail]>
Cc: Petr Mladek <[e-mail]>
Cc: Sergey Senozhatsky <[e-mail]>
Cc: Steven Rostedt <[e-mail]>
Cc: Takashi Iwai <[e-mail]>
Cc: "Theodore Ts'o" <[e-mail]>
Cc: Thomas Gleixner <[e-mail]>
Cc: Vegard Nossum <[e-mail]>
Cc: Wolfram Sang <[e-mail]>
Cc: Vasily Gorbik <[e-mail]>
Cc: Ilya Leoshkevich <[e-mail]>
Cc: Mark Rutland <[e-mail]>
Cc: Matthew Wilcox <[e-mail]>
Cc: Randy Dunlap <[e-mail]>
Cc: Andrey Konovalov <[e-mail]>
Cc: Marco Elver <[e-mail]>
Cc: [e-mail]

 Documentation/dev-tools/index.rst       |   1 +
 Documentation/dev-tools/kmsan.rst       | 418 +++++++++++++++++
 Makefile                                |   3 +-
 arch/Kconfig                            |   2 +-
 arch/x86/Kconfig                        |   6 +
 arch/x86/Kconfig.debug                  |   3 +
 arch/x86/boot/Makefile                  |   2 +
 arch/x86/boot/compressed/Makefile       |   2 +
 arch/x86/boot/compressed/misc.h         |   1 +
 arch/x86/entry/common.c                 |   1 +
 arch/x86/entry/entry_64.S               |  18 +
 arch/x86/entry/vdso/Makefile            |   3 +
 arch/x86/include/asm/checksum.h         |  10 +-
 arch/x86/include/asm/irq_regs.h         |   1 +
 arch/x86/include/asm/kmsan.h            | 129 ++++++
 arch/x86/include/asm/page_64.h          |  13 +
 arch/x86/include/asm/page_64_types.h    |  12 +-
 arch/x86/include/asm/pgtable_64_types.h |  15 +
 arch/x86/include/asm/string_64.h        |   9 +-
 arch/x86/include/asm/syscall_wrapper.h  |   1 +
 arch/x86/include/asm/uaccess.h          |  12 +
 arch/x86/include/asm/unwind.h           |   9 +-
 arch/x86/kernel/Makefile                |   4 +
 arch/x86/kernel/apic/apic.c             |   2 +
 arch/x86/kernel/cpu/Makefile            |   1 +
 arch/x86/kernel/dumpstack_64.c          |   1 +
 arch/x86/kernel/process_64.c            |   5 +
 arch/x86/kernel/traps.c                 |  12 +-
 arch/x86/kernel/uprobes.c               |   7 +-
 arch/x86/lib/Makefile                   |   2 +
 arch/x86/mm/Makefile                    |   2 +
 arch/x86/mm/fault.c                     |  20 +
 arch/x86/mm/ioremap.c                   |   3 +
 arch/x86/realmode/rm/Makefile           |   2 +
 block/bio.c                             |  20 +
 block/blk.h                             |   7 +
 block/partition-generic.c               |   9 +-
 crypto/Kconfig                          |  26 ++
 drivers/char/random.c                   |   2 +
 drivers/firmware/efi/libstub/Makefile   |   1 +
 drivers/gpu/drm/amd/display/Kconfig     |   2 +-
 drivers/i2c/i2c-core-base.c             |   2 +
 drivers/input/serio/libps2.c            |   6 +-
 drivers/scsi/scsi_lib.c                 |   4 +
 drivers/usb/core/message.c              |   6 +-
 drivers/usb/core/urb.c                  |   2 +
 drivers/virtio/virtio_ring.c            |  14 +
 fs/buffer.c                             |   7 +-
 include/asm-generic/cacheflush.h        |   7 +-
 include/asm-generic/uaccess.h           |  12 +-
 include/linux/compiler-clang.h          |   8 +
 include/linux/compiler-gcc.h            |   5 +
 include/linux/compiler.h                |  15 +-
 include/linux/dma-mapping.h             |   2 +
 include/linux/gfp.h                     |   4 +-
 include/linux/highmem.h                 |   4 +
 include/linux/kmsan-checks.h            | 121 +++++
 include/linux/kmsan.h                   | 143 ++++++
 include/linux/mm_types.h                |   9 +
 include/linux/sched.h                   |   5 +
 include/linux/skbuff.h                  |   5 +-
 include/linux/stackdepot.h              |  10 +
 include/linux/string.h                  |   2 +
 include/linux/uaccess.h                 |  32 +-
 init/main.c                             |   3 +
 kernel/Makefile                         |   1 +
 kernel/exit.c                           |   2 +
 kernel/fork.c                           |   2 +
 kernel/kthread.c                        |   2 +
 kernel/printk/printk.c                  |   8 +-
 kernel/profile.c                        |   1 +
 kernel/sched/core.c                     |  11 +
 kernel/softirq.c                        |   5 +
 lib/Kconfig.debug                       |   5 +
 lib/Kconfig.kmsan                       |  22 +
 lib/Makefile                            |   2 +
 lib/ioremap.c                           |   5 +
 lib/iov_iter.c                          |   6 +
 lib/stackdepot.c                        |  72 ++-
 lib/string.c                            |   5 +-
 lib/test_kmsan.c                        | 231 ++++++++++
 lib/usercopy.c                          |   6 +-
 mm/Makefile                             |   1 +
 mm/compaction.c                         |   9 +
 mm/filemap.c                            |   1 +
 mm/gup.c                                |   3 +
 mm/kasan/common.c                       |  23 -
 mm/kmsan/Makefile                       |   4 +
 mm/kmsan/kmsan.c                        | 570 ++++++++++++++++++++++++
 mm/kmsan/kmsan.h                        | 149 +++++++
 mm/kmsan/kmsan_entry.c                  | 130 ++++++
 mm/kmsan/kmsan_hooks.c                  | 393 ++++++++++++++++
 mm/kmsan/kmsan_init.c                   |  88 ++++
 mm/kmsan/kmsan_instr.c                  | 259 +++++++++++
 mm/kmsan/kmsan_report.c                 | 133 ++++++
 mm/kmsan/kmsan_shadow.c                 | 543 ++++++++++++++++++++++
 mm/kmsan/kmsan_shadow.h                 |  30 ++
 mm/memory.c                             |   2 +
 mm/mmu_gather.c                         |  10 +
 mm/page_alloc.c                         |  16 +
 mm/readahead.c                          |   6 +
 mm/slub.c                               |  37 +-
 mm/vmalloc.c                            |  23 +-
 net/9p/protocol.c                       |   2 +
 net/sched/sch_generic.c                 |   2 +
 scripts/Makefile.kmsan                  |  12 +
 scripts/Makefile.lib                    |   6 +
 sound/core/oss/pcm_oss.c                |   7 +
 108 files changed, 3999 insertions(+), 73 deletions(-)
 create mode 100644 Documentation/dev-tools/kmsan.rst
 create mode 100644 arch/x86/include/asm/kmsan.h
 create mode 100644 include/linux/kmsan-checks.h
 create mode 100644 include/linux/kmsan.h
 create mode 100644 lib/Kconfig.kmsan
 create mode 100644 lib/test_kmsan.c
 create mode 100644 mm/kmsan/Makefile
 create mode 100644 mm/kmsan/kmsan.c
 create mode 100644 mm/kmsan/kmsan.h
 create mode 100644 mm/kmsan/kmsan_entry.c
 create mode 100644 mm/kmsan/kmsan_hooks.c
 create mode 100644 mm/kmsan/kmsan_init.c
 create mode 100644 mm/kmsan/kmsan_instr.c
 create mode 100644 mm/kmsan/kmsan_report.c
 create mode 100644 mm/kmsan/kmsan_shadow.c
 create mode 100644 mm/kmsan/kmsan_shadow.h
 create mode 100644 scripts/Makefile.kmsan