tsan_flags.inc 4.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182
  1. //===-- tsan_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. // TSan runtime flags.
  10. //
  11. //===----------------------------------------------------------------------===//
  12. #ifndef TSAN_FLAG
  13. # error "Define TSAN_FLAG prior to including this file!"
  14. #endif
  15. // TSAN_FLAG(Type, Name, DefaultValue, Description)
  16. // See COMMON_FLAG in sanitizer_flags.inc for more details.
  17. TSAN_FLAG(bool, enable_annotations, true,
  18. "Enable dynamic annotations, otherwise they are no-ops.")
  19. // Suppress a race report if we've already output another race report
  20. // with the same stack.
  21. TSAN_FLAG(bool, suppress_equal_stacks, true,
  22. "Suppress a race report if we've already output another race report "
  23. "with the same stack.")
  24. TSAN_FLAG(bool, report_bugs, true,
  25. "Turns off bug reporting entirely (useful for benchmarking).")
  26. TSAN_FLAG(bool, report_thread_leaks, true, "Report thread leaks at exit?")
  27. TSAN_FLAG(bool, report_destroy_locked, true,
  28. "Report destruction of a locked mutex?")
  29. TSAN_FLAG(bool, report_mutex_bugs, true,
  30. "Report incorrect usages of mutexes and mutex annotations?")
  31. TSAN_FLAG(bool, report_signal_unsafe, true,
  32. "Report violations of async signal-safety "
  33. "(e.g. malloc() call from a signal handler).")
  34. TSAN_FLAG(bool, report_atomic_races, true,
  35. "Report races between atomic and plain memory accesses.")
  36. TSAN_FLAG(
  37. bool, force_seq_cst_atomics, false,
  38. "If set, all atomics are effectively sequentially consistent (seq_cst), "
  39. "regardless of what user actually specified.")
  40. TSAN_FLAG(bool, force_background_thread, false,
  41. "If set, eagerly launch a background thread for memory reclamation "
  42. "instead of waiting for a user call to pthread_create.")
  43. TSAN_FLAG(bool, halt_on_error, false, "Exit after first reported error.")
  44. TSAN_FLAG(int, atexit_sleep_ms, 1000,
  45. "Sleep in main thread before exiting for that many ms "
  46. "(useful to catch \"at exit\" races).")
  47. TSAN_FLAG(const char *, profile_memory, "",
  48. "If set, periodically write memory profile to that file.")
  49. TSAN_FLAG(int, flush_memory_ms, 0, "Flush shadow memory every X ms.")
  50. TSAN_FLAG(int, flush_symbolizer_ms, 5000, "Flush symbolizer caches every X ms.")
  51. TSAN_FLAG(
  52. int, memory_limit_mb, 0,
  53. "Resident memory limit in MB to aim at."
  54. "If the process consumes more memory, then TSan will flush shadow memory.")
  55. TSAN_FLAG(bool, stop_on_start, false,
  56. "Stops on start until __tsan_resume() is called (for debugging).")
  57. TSAN_FLAG(bool, running_on_valgrind, false,
  58. "Controls whether RunningOnValgrind() returns true or false.")
  59. TSAN_FLAG(
  60. uptr, history_size, 0,
  61. "Per-thread history size,"
  62. " controls how many extra previous memory accesses are remembered per thread.")
  63. TSAN_FLAG(int, io_sync, 1,
  64. "Controls level of synchronization implied by IO operations. "
  65. "0 - no synchronization "
  66. "1 - reasonable level of synchronization (write->read)"
  67. "2 - global synchronization of all IO operations.")
  68. TSAN_FLAG(bool, die_after_fork, true,
  69. "Die after multi-threaded fork if the child creates new threads.")
  70. TSAN_FLAG(const char *, suppressions, "", "Suppressions file name.")
  71. TSAN_FLAG(bool, ignore_interceptors_accesses, SANITIZER_APPLE ? true : false,
  72. "Ignore reads and writes from all interceptors.")
  73. TSAN_FLAG(bool, ignore_noninstrumented_modules, SANITIZER_APPLE ? true : false,
  74. "Interceptors should only detect races when called from instrumented "
  75. "modules.")
  76. TSAN_FLAG(bool, shared_ptr_interceptor, true,
  77. "Track atomic reference counting in libc++ shared_ptr and weak_ptr.")
  78. TSAN_FLAG(bool, print_full_thread_history, false,
  79. "If set, prints thread creation stacks for the threads involved in "
  80. "the report and their ancestors up to the main thread.")