build/config/sanitizers/sanitizers.gni

   1 # Copyright 2015 The Chromium Authors. All rights reserved.
   2 # Use of this source code is governed by a BSD-style license that can be
   3 # found in the LICENSE file.
   4
   5 declare_args() {
   6   # Compile for Address Sanitizer to find memory bugs.
   7   is_asan = false
   8
   9   # Compile for Leak Sanitizer to find leaks.
  10   is_lsan = false
  11
  12   # Compile for Memory Sanitizer to find uninitialized reads.
  13   is_msan = false
  14
  15   # Compile for Thread Sanitizer to find threading bugs.
  16   is_tsan = false
  17
  18   # Use libc++ (buildtools/third_party/libc++ and
  19   # buildtools/third_party/libc++abi) instead of stdlibc++ as standard library.
  20   # This is intended to be used for instrumented builds.
  21   use_custom_libcxx = (is_asan && is_linux) || is_tsan || is_msan
  22
  23   # Track where uninitialized memory originates from. From fastest to slowest:
  24   # 0 - no tracking, 1 - track only the initial allocation site, 2 - track the
  25   # chain of stores leading from allocation site to use site.
  26   msan_track_origins = 2
  27
  28   # Use dynamic libraries instrumented by one of the sanitizers instead of the
  29   # standard system libraries. Set this flag to download prebuilt binaries from
  30   # GCS.
  31   use_prebuilt_instrumented_libraries = false
  32
  33   # Enable building with SyzyAsan which can find certain types of memory
  34   # errors. Only works on Windows. See
  35   # https://code.google.com/p/sawbuck/wiki/SyzyASanHowTo
  36   is_syzyasan = false
  37
  38   # Compile with Control Flow Integrity to protect virtual calls and casts.
  39   # See http://clang.llvm.org/docs/ControlFlowIntegrity.html
  40   is_cfi = false
  41
  42   # By default, Control Flow Integrity will crash the program if it detects a
  43   # violation. Set this to true to print detailed diagnostics instead.
  44   use_cfi_diag = false
  45 }
  46
  47 # TODO(GYP) bug 527515: is_ubsan, is_ubsan_vptr
  48 using_sanitizer = is_asan || is_lsan || is_tsan || is_msan
  49
  50 assert(!using_sanitizer || is_clang,
  51        "Sanitizers (is_*san) require setting is_clang = true in 'gn args'")
  52
  53 # MSan only links Chrome properly in release builds (brettw -- 9/1/2015). The
  54 # same is possibly true for the other non-ASan sanitizers. But regardless of
  55 # whether it links, one would normally never run a sanitizer in debug mode.
  56 # Running in debug mode probably indicates you forgot to set the "is_debug =
  57 # false" flag in the build args. ASan seems to run fine in debug mode.
  58 #
  59 # If you find a use-case where you want to compile a sanitizer in debug mode
  60 # and have verified it works, ask brettw and we can consider removing it from
  61 # this condition. We may also be able to find another way to enable your case
  62 # without having people accidentally get broken builds by compiling an
  63 # unsupported or unadvisable configurations.
  64 #
  65 # For one-off testing, just comment this assertion out.
  66 assert(!is_debug || !(is_msan || is_lsan || is_tsan),
  67        "Sanitizers should generally be used in release (set is_debug=false).")