//===-- tsan_flags.inc ------------------------------------------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
// TSan runtime flags.
//
//===----------------------------------------------------------------------===//
#ifndef TSAN_FLAG
# error "Define TSAN_FLAG prior to including this file!"
#endif

// TSAN_FLAG(Type, Name, DefaultValue, Description)
// See COMMON_FLAG in sanitizer_flags.inc for more details.

TSAN_FLAG(bool, enable_annotations, true,
          "Enable dynamic annotations, otherwise they are no-ops.")
// Suppress a race report if we've already output another race report
// with the same stack.
TSAN_FLAG(bool, suppress_equal_stacks, true,
          "Suppress a race report if we've already output another race report "
          "with the same stack.")
TSAN_FLAG(bool, report_bugs, true,
          "Turns off bug reporting entirely (useful for benchmarking).")
TSAN_FLAG(bool, report_thread_leaks, true, "Report thread leaks at exit?")
TSAN_FLAG(bool, report_destroy_locked, true,
          "Report destruction of a locked mutex?")
TSAN_FLAG(bool, report_mutex_bugs, true,
          "Report incorrect usages of mutexes and mutex annotations?")
TSAN_FLAG(bool, report_signal_unsafe, true,
          "Report violations of async signal-safety "
          "(e.g. malloc() call from a signal handler).")
TSAN_FLAG(bool, report_atomic_races, true,
          "Report races between atomic and plain memory accesses.")
TSAN_FLAG(
    bool, force_seq_cst_atomics, false,
    "If set, all atomics are effectively sequentially consistent (seq_cst), "
    "regardless of what user actually specified.")
TSAN_FLAG(bool, force_background_thread, false,
          "If set, eagerly launch a background thread for memory reclamation "
          "instead of waiting for a user call to pthread_create.")
TSAN_FLAG(bool, halt_on_error, false, "Exit after first reported error.")
TSAN_FLAG(int, atexit_sleep_ms, 1000,
          "Sleep in main thread before exiting for that many ms "
          "(useful to catch \"at exit\" races).")
TSAN_FLAG(const char *, profile_memory, "",
          "If set, periodically write memory profile to that file.")
TSAN_FLAG(int, flush_memory_ms, 0, "Flush shadow memory every X ms.")
TSAN_FLAG(int, flush_symbolizer_ms, 5000, "Flush symbolizer caches every X ms.")
TSAN_FLAG(
    int, memory_limit_mb, 0,
    "Resident memory limit in MB to aim at."
    "If the process consumes more memory, then TSan will flush shadow memory.")
TSAN_FLAG(bool, stop_on_start, false,
          "Stops on start until __tsan_resume() is called (for debugging).")
TSAN_FLAG(bool, running_on_valgrind, false,
          "Controls whether RunningOnValgrind() returns true or false.")
TSAN_FLAG(
    uptr, history_size, 0,
    "Per-thread history size,"
    " controls how many extra previous memory accesses are remembered per thread.")
TSAN_FLAG(int, io_sync, 1,
          "Controls level of synchronization implied by IO operations. "
          "0 - no synchronization "
          "1 - reasonable level of synchronization (write->read)"
          "2 - global synchronization of all IO operations.")
TSAN_FLAG(bool, die_after_fork, true,
          "Die after multi-threaded fork if the child creates new threads.")
TSAN_FLAG(const char *, suppressions, "", "Suppressions file name.")
TSAN_FLAG(bool, ignore_interceptors_accesses, SANITIZER_APPLE ? true : false,
          "Ignore reads and writes from all interceptors.")
TSAN_FLAG(bool, ignore_noninstrumented_modules, SANITIZER_APPLE ? true : false,
          "Interceptors should only detect races when called from instrumented "
          "modules.")
TSAN_FLAG(bool, shared_ptr_interceptor, true,
          "Track atomic reference counting in libc++ shared_ptr and weak_ptr.")
TSAN_FLAG(bool, print_full_thread_history, false,
          "If set, prints thread creation stacks for the threads involved in "
          "the report and their ancestors up to the main thread.")

#if SANITIZER_APPLE && !SANITIZER_GO
TSAN_FLAG(LockDuringWriteSetting, lock_during_write, kLockDuringAllWrites,
          "Determines whether to obtain a lock while writing logs or error "
          "reports. "
          "\"on\" - [default] lock during all writes. "
          "\"disable_for_current_process\" - don't lock during all writes in "
          "the current process, but do lock for all writes in child "
          "processes."
          "\"disable_for_all_processes\" - don't lock during all writes in "
          "the current process and it's children processes.")
#endif

TSAN_FLAG(bool, enable_adaptive_delay, false,
          "Enable adaptive delay injection to expose data races. When "
          "enabled, delays are strategically injected at synchronization "
          "points, atomic operations, and thread lifecycle events to increase "
          "the likelihood of exposing races while maintaining a configurable "
          "overhead budget.")

TSAN_FLAG(
    int, adaptive_delay_aggressiveness, 25,
    "Controls delay injection intensity for race detection. Higher values "
    "inject more delays to expose races. Suggested values: 10 (minimal delay), "
    "50 (moderate delay), 200 (aggressive). "
    "This is a tuning parameter; actual overhead varies by workload and "
    "platform.")
TSAN_FLAG(int, adaptive_delay_relaxed_sample_rate, 10000,
          "Sample 1 in N relaxed atomic operations for delay")
TSAN_FLAG(int, adaptive_delay_sync_atomic_sample_rate, 100,
          "Sample 1 in N acquire/release/seq_cst atomic operations for delay")
TSAN_FLAG(int, adaptive_delay_mutex_sample_rate, 10,
          "Sample 1 in N mutex/cv operations for delay")
TSAN_FLAG(const char*, adaptive_delay_max_atomic, "sleep_us=50",
          "Delay for atomic operations: 'spin=N' (max N spins), 'yield', or "
          "'sleep_us=N' (max N>0 us sleep)")
TSAN_FLAG(const char*, adaptive_delay_max_sync, "sleep_us=500",
          "Delay for sync operations: 'spin=N' (max N spins), 'yield', or "
          "'sleep_us=N' (max N>0 us sleep)")