Home | History | Annotate | Download | only in debug
      1 // Copyright (c) 2011 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 // This is a cross platform interface for helper functions related to
      6 // debuggers.  You should use this to test if you're running under a debugger,
      7 // and if you would like to yield (breakpoint) into the debugger.
      8 
      9 #ifndef BASE_DEBUG_DEBUGGER_H
     10 #define BASE_DEBUG_DEBUGGER_H
     11 
     12 #include "base/base_export.h"
     13 
     14 namespace base {
     15 namespace debug {
     16 
     17 // Starts the registered system-wide JIT debugger to attach it to specified
     18 // process.
     19 BASE_EXPORT bool SpawnDebuggerOnProcess(unsigned process_id);
     20 
     21 // Waits wait_seconds seconds for a debugger to attach to the current process.
     22 // When silent is false, an exception is thrown when a debugger is detected.
     23 BASE_EXPORT bool WaitForDebugger(int wait_seconds, bool silent);
     24 
     25 // Returns true if the given process is being run under a debugger.
     26 //
     27 // On OS X, the underlying mechanism doesn't work when the sandbox is enabled.
     28 // To get around this, this function caches its value.
     29 //
     30 // WARNING: Because of this, on OS X, a call MUST be made to this function
     31 // BEFORE the sandbox is enabled.
     32 BASE_EXPORT bool BeingDebugged();
     33 
     34 // Break into the debugger, assumes a debugger is present.
     35 BASE_EXPORT void BreakDebugger();
     36 
     37 // Used in test code, this controls whether showing dialogs and breaking into
     38 // the debugger is suppressed for debug errors, even in debug mode (normally
     39 // release mode doesn't do this stuff --  this is controlled separately).
     40 // Normally UI is not suppressed.  This is normally used when running automated
     41 // tests where we want a crash rather than a dialog or a debugger.
     42 BASE_EXPORT void SetSuppressDebugUI(bool suppress);
     43 BASE_EXPORT bool IsDebugUISuppressed();
     44 
     45 }  // namespace debug
     46 }  // namespace base
     47 
     48 #endif  // BASE_DEBUG_DEBUGGER_H
     49