hwasan_flags.inc 3.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283
  1. //===-- hwasan_flags.inc ----------------------------------------*- C++ -*-===//
  2. //
  3. // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
  4. // See https://llvm.org/LICENSE.txt for license information.
  5. // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
  6. //
  7. //===----------------------------------------------------------------------===//
  8. //
  9. // Hwasan runtime flags.
  10. //
  11. //===----------------------------------------------------------------------===//
  12. #ifndef HWASAN_FLAG
  13. # error "Define HWASAN_FLAG prior to including this file!"
  14. #endif
  15. // HWASAN_FLAG(Type, Name, DefaultValue, Description)
  16. // See COMMON_FLAG in sanitizer_flags.inc for more details.
  17. HWASAN_FLAG(bool, verbose_threads, false,
  18. "inform on thread creation/destruction")
  19. HWASAN_FLAG(bool, tag_in_malloc, true, "")
  20. HWASAN_FLAG(bool, tag_in_free, true, "")
  21. HWASAN_FLAG(bool, print_stats, false, "")
  22. HWASAN_FLAG(bool, halt_on_error, true, "")
  23. HWASAN_FLAG(bool, atexit, false, "")
  24. // Test only flag to disable malloc/realloc/free memory tagging on startup.
  25. // Tagging can be reenabled with __hwasan_enable_allocator_tagging().
  26. HWASAN_FLAG(bool, disable_allocator_tagging, false, "")
  27. // If false, use simple increment of a thread local counter to generate new
  28. // tags.
  29. HWASAN_FLAG(bool, random_tags, true, "")
  30. HWASAN_FLAG(
  31. int, max_malloc_fill_size, 0,
  32. "HWASan allocator flag. max_malloc_fill_size is the maximal amount of "
  33. "bytes that will be filled with malloc_fill_byte on malloc.")
  34. HWASAN_FLAG(bool, free_checks_tail_magic, 1,
  35. "If set, free() will check the magic values "
  36. "to the right of the allocated object "
  37. "if the allocation size is not a divident of the granule size")
  38. HWASAN_FLAG(
  39. int, max_free_fill_size, 0,
  40. "HWASan allocator flag. max_free_fill_size is the maximal amount of "
  41. "bytes that will be filled with free_fill_byte during free.")
  42. HWASAN_FLAG(int, malloc_fill_byte, 0xbe,
  43. "Value used to fill the newly allocated memory.")
  44. HWASAN_FLAG(int, free_fill_byte, 0x55,
  45. "Value used to fill deallocated memory.")
  46. HWASAN_FLAG(int, heap_history_size, 1023,
  47. "The number of heap (de)allocations remembered per thread. "
  48. "Affects the quality of heap-related reports, but not the ability "
  49. "to find bugs.")
  50. HWASAN_FLAG(bool, export_memory_stats, true,
  51. "Export up-to-date memory stats through /proc")
  52. HWASAN_FLAG(int, stack_history_size, 1024,
  53. "The number of stack frames remembered per thread. "
  54. "Affects the quality of stack-related reports, but not the ability "
  55. "to find bugs.")
  56. // Malloc / free bisection. Only tag malloc and free calls when a hash of
  57. // allocation size and stack trace is between malloc_bisect_left and
  58. // malloc_bisect_right (both inclusive). [0, 0] range is special and disables
  59. // bisection (i.e. everything is tagged). Once the range is narrowed down
  60. // enough, use malloc_bisect_dump to see interesting allocations.
  61. HWASAN_FLAG(uptr, malloc_bisect_left, 0,
  62. "Left bound of malloc bisection, inclusive.")
  63. HWASAN_FLAG(uptr, malloc_bisect_right, 0,
  64. "Right bound of malloc bisection, inclusive.")
  65. HWASAN_FLAG(bool, malloc_bisect_dump, false,
  66. "Print all allocations within [malloc_bisect_left, "
  67. "malloc_bisect_right] range ")
  68. // Exit if we fail to enable the AArch64 kernel ABI relaxation which allows
  69. // tagged pointers in syscalls. This is the default, but being able to disable
  70. // that behaviour is useful for running the testsuite on more platforms (the
  71. // testsuite can run since we manually ensure any pointer arguments to syscalls
  72. // are untagged before the call.
  73. HWASAN_FLAG(bool, fail_without_syscall_abi, true,
  74. "Exit if fail to request relaxed syscall ABI.")