186277eb844c4983c81de62d7c050e92fe7155788Stephen Hines//===-- tsan_flags.inc ------------------------------------------*- C++ -*-===// 286277eb844c4983c81de62d7c050e92fe7155788Stephen Hines// 386277eb844c4983c81de62d7c050e92fe7155788Stephen Hines// The LLVM Compiler Infrastructure 486277eb844c4983c81de62d7c050e92fe7155788Stephen Hines// 586277eb844c4983c81de62d7c050e92fe7155788Stephen Hines// This file is distributed under the University of Illinois Open Source 686277eb844c4983c81de62d7c050e92fe7155788Stephen Hines// License. See LICENSE.TXT for details. 786277eb844c4983c81de62d7c050e92fe7155788Stephen Hines// 886277eb844c4983c81de62d7c050e92fe7155788Stephen Hines//===----------------------------------------------------------------------===// 986277eb844c4983c81de62d7c050e92fe7155788Stephen Hines// 1086277eb844c4983c81de62d7c050e92fe7155788Stephen Hines// TSan runtime flags. 1186277eb844c4983c81de62d7c050e92fe7155788Stephen Hines// 1286277eb844c4983c81de62d7c050e92fe7155788Stephen Hines//===----------------------------------------------------------------------===// 1386277eb844c4983c81de62d7c050e92fe7155788Stephen Hines#ifndef TSAN_FLAG 1486277eb844c4983c81de62d7c050e92fe7155788Stephen Hines# error "Define TSAN_FLAG prior to including this file!" 1586277eb844c4983c81de62d7c050e92fe7155788Stephen Hines#endif 1686277eb844c4983c81de62d7c050e92fe7155788Stephen Hines 1786277eb844c4983c81de62d7c050e92fe7155788Stephen Hines// TSAN_FLAG(Type, Name, DefaultValue, Description) 1886277eb844c4983c81de62d7c050e92fe7155788Stephen Hines// See COMMON_FLAG in sanitizer_flags.inc for more details. 1986277eb844c4983c81de62d7c050e92fe7155788Stephen Hines 2086277eb844c4983c81de62d7c050e92fe7155788Stephen HinesTSAN_FLAG(bool, enable_annotations, true, 2186277eb844c4983c81de62d7c050e92fe7155788Stephen Hines "Enable dynamic annotations, otherwise they are no-ops.") 2286277eb844c4983c81de62d7c050e92fe7155788Stephen Hines// Suppress a race report if we've already output another race report 2386277eb844c4983c81de62d7c050e92fe7155788Stephen Hines// with the same stack. 2486277eb844c4983c81de62d7c050e92fe7155788Stephen HinesTSAN_FLAG(bool, suppress_equal_stacks, true, 2586277eb844c4983c81de62d7c050e92fe7155788Stephen Hines "Suppress a race report if we've already output another race report " 2686277eb844c4983c81de62d7c050e92fe7155788Stephen Hines "with the same stack.") 2786277eb844c4983c81de62d7c050e92fe7155788Stephen HinesTSAN_FLAG(bool, suppress_equal_addresses, true, 2886277eb844c4983c81de62d7c050e92fe7155788Stephen Hines "Suppress a race report if we've already output another race report " 2986277eb844c4983c81de62d7c050e92fe7155788Stephen Hines "on the same address.") 3086277eb844c4983c81de62d7c050e92fe7155788Stephen Hines 3186277eb844c4983c81de62d7c050e92fe7155788Stephen HinesTSAN_FLAG(bool, report_bugs, true, 3286277eb844c4983c81de62d7c050e92fe7155788Stephen Hines "Turns off bug reporting entirely (useful for benchmarking).") 3386277eb844c4983c81de62d7c050e92fe7155788Stephen HinesTSAN_FLAG(bool, report_thread_leaks, true, "Report thread leaks at exit?") 3486277eb844c4983c81de62d7c050e92fe7155788Stephen HinesTSAN_FLAG(bool, report_destroy_locked, true, 3586277eb844c4983c81de62d7c050e92fe7155788Stephen Hines "Report destruction of a locked mutex?") 3686277eb844c4983c81de62d7c050e92fe7155788Stephen HinesTSAN_FLAG(bool, report_mutex_bugs, true, 3786277eb844c4983c81de62d7c050e92fe7155788Stephen Hines "Report incorrect usages of mutexes and mutex annotations?") 3886277eb844c4983c81de62d7c050e92fe7155788Stephen HinesTSAN_FLAG(bool, report_signal_unsafe, true, 3986277eb844c4983c81de62d7c050e92fe7155788Stephen Hines "Report violations of async signal-safety " 4086277eb844c4983c81de62d7c050e92fe7155788Stephen Hines "(e.g. malloc() call from a signal handler).") 4186277eb844c4983c81de62d7c050e92fe7155788Stephen HinesTSAN_FLAG(bool, report_atomic_races, true, 4286277eb844c4983c81de62d7c050e92fe7155788Stephen Hines "Report races between atomic and plain memory accesses.") 4386277eb844c4983c81de62d7c050e92fe7155788Stephen HinesTSAN_FLAG( 4486277eb844c4983c81de62d7c050e92fe7155788Stephen Hines bool, force_seq_cst_atomics, false, 4586277eb844c4983c81de62d7c050e92fe7155788Stephen Hines "If set, all atomics are effectively sequentially consistent (seq_cst), " 4686277eb844c4983c81de62d7c050e92fe7155788Stephen Hines "regardless of what user actually specified.") 4786277eb844c4983c81de62d7c050e92fe7155788Stephen HinesTSAN_FLAG(bool, print_benign, false, "Print matched \"benign\" races at exit.") 4886277eb844c4983c81de62d7c050e92fe7155788Stephen HinesTSAN_FLAG(int, exitcode, 66, "Override exit status if something was reported.") 4986277eb844c4983c81de62d7c050e92fe7155788Stephen HinesTSAN_FLAG(bool, halt_on_error, false, "Exit after first reported error.") 5086277eb844c4983c81de62d7c050e92fe7155788Stephen HinesTSAN_FLAG(int, atexit_sleep_ms, 1000, 5186277eb844c4983c81de62d7c050e92fe7155788Stephen Hines "Sleep in main thread before exiting for that many ms " 5286277eb844c4983c81de62d7c050e92fe7155788Stephen Hines "(useful to catch \"at exit\" races).") 5386277eb844c4983c81de62d7c050e92fe7155788Stephen HinesTSAN_FLAG(const char *, profile_memory, "", 5486277eb844c4983c81de62d7c050e92fe7155788Stephen Hines "If set, periodically write memory profile to that file.") 5586277eb844c4983c81de62d7c050e92fe7155788Stephen HinesTSAN_FLAG(int, flush_memory_ms, 0, "Flush shadow memory every X ms.") 5686277eb844c4983c81de62d7c050e92fe7155788Stephen HinesTSAN_FLAG(int, flush_symbolizer_ms, 5000, "Flush symbolizer caches every X ms.") 5786277eb844c4983c81de62d7c050e92fe7155788Stephen HinesTSAN_FLAG( 5886277eb844c4983c81de62d7c050e92fe7155788Stephen Hines int, memory_limit_mb, 0, 5986277eb844c4983c81de62d7c050e92fe7155788Stephen Hines "Resident memory limit in MB to aim at." 6086277eb844c4983c81de62d7c050e92fe7155788Stephen Hines "If the process consumes more memory, then TSan will flush shadow memory.") 6186277eb844c4983c81de62d7c050e92fe7155788Stephen HinesTSAN_FLAG(bool, stop_on_start, false, 6286277eb844c4983c81de62d7c050e92fe7155788Stephen Hines "Stops on start until __tsan_resume() is called (for debugging).") 6386277eb844c4983c81de62d7c050e92fe7155788Stephen HinesTSAN_FLAG(bool, running_on_valgrind, false, 6486277eb844c4983c81de62d7c050e92fe7155788Stephen Hines "Controls whether RunningOnValgrind() returns true or false.") 6586277eb844c4983c81de62d7c050e92fe7155788Stephen HinesTSAN_FLAG( 6686277eb844c4983c81de62d7c050e92fe7155788Stephen Hines int, history_size, kGoMode ? 1 : 3, // There are a lot of goroutines in Go. 6786277eb844c4983c81de62d7c050e92fe7155788Stephen Hines "Per-thread history size, controls how many previous memory accesses " 6886277eb844c4983c81de62d7c050e92fe7155788Stephen Hines "are remembered per thread. Possible values are [0..7]. " 6986277eb844c4983c81de62d7c050e92fe7155788Stephen Hines "history_size=0 amounts to 32K memory accesses. Each next value doubles " 7086277eb844c4983c81de62d7c050e92fe7155788Stephen Hines "the amount of memory accesses, up to history_size=7 that amounts to " 7186277eb844c4983c81de62d7c050e92fe7155788Stephen Hines "4M memory accesses. The default value is 2 (128K memory accesses).") 7286277eb844c4983c81de62d7c050e92fe7155788Stephen HinesTSAN_FLAG(int, io_sync, 1, 7386277eb844c4983c81de62d7c050e92fe7155788Stephen Hines "Controls level of synchronization implied by IO operations. " 7486277eb844c4983c81de62d7c050e92fe7155788Stephen Hines "0 - no synchronization " 7586277eb844c4983c81de62d7c050e92fe7155788Stephen Hines "1 - reasonable level of synchronization (write->read)" 7686277eb844c4983c81de62d7c050e92fe7155788Stephen Hines "2 - global synchronization of all IO operations.") 7786277eb844c4983c81de62d7c050e92fe7155788Stephen HinesTSAN_FLAG(bool, die_after_fork, true, 7886277eb844c4983c81de62d7c050e92fe7155788Stephen Hines "Die after multi-threaded fork if the child creates new threads.") 7986277eb844c4983c81de62d7c050e92fe7155788Stephen HinesTSAN_FLAG(const char *, suppressions, "", "Suppressions file name.") 80