Allow exception forwarding to the system’s native crash reporter to be disabled

client/crashpad_info.h

 // Copyright 2014 The Crashpad Authors. All rights reserved.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
 // You may obtain a copy of the License at
 //
 //     http://www.apache.org/licenses/LICENSE-2.0
 //
 // Unless required by applicable law or agreed to in writing, software
 // distributed under the License is distributed on an "AS IS" BASIS,
@@ skipping 14 matching lines @@
 
 //! \brief A structure that can be used by a Crashpad-enabled program to
 //!     provide information to the Crashpad crash handler.
 //!
 //! It is possible for one CrashpadInfo structure to appear in each loaded code
 //! module in a process, but from the perspective of the user of the client
 //! interface, there is only one global CrashpadInfo structure, located in the
 //! module that contains the client interface code.
 struct CrashpadInfo {
  public:
+  //! \brief Options to enable and disable features.
+  enum TriState {
+    //! \brief No special behavior is requested, and the defaults are desired.
+    kDefault = 0,
+
+    //! \brief The behavior should be enabled.
+    kEnabled,
+
+    //! \brief The behavior should be disabled.
+    kDisabled,
+  };
+
   //! \brief Returns the global CrashpadInfo structure.
   static CrashpadInfo* GetCrashpadInfo();
 
   CrashpadInfo();
 
   void set_simple_annotations(SimpleStringDictionary* simple_annotations) {
     simple_annotations_ = simple_annotations;
   }
 
+  //! \brief Enables or disables Crashpad handler processing.
+  //!
+  //! When handling an exception, the Crashpad handler will scan all modules in
+  //! a process. The first one that has a CrashpadInfo structure populated with
+  //! a value other than #kDefault for \a state will dictate whether the handler
+  //! is functional or not. If all modules with a CrashpadInfo structure specify
+  //! #kDefault, the handler will be enabled. If disabled, the Crashpad handler
+  //! will still run and receive exceptions, but will not take any action on an
+  //! exception on its own behalf, except for the action necessary to determine
+  //! that it has been disabled.
+  //!
+  //! The Crashpad handler should not normally be disabled. More commonly, it
+  //! is appropraite to disable crash report upload by calling
+  //! Settings::SetUploadsEnabled().
+  void SetCrashpadHandlerState(TriState state);
+
+  //! \brief Enables or disables Crashpad forwarding of exceptions to the
+  //!     system’s native crash reporter.
+  //!
+  //! When handling an exception, the Crashpad handler will scan all modules in
+  //! a process. The first one that has a CrashpadInfo structure populated with
+  //! a value other than #kDefault for \a state will dictate whether the
+  //! exception is forwarded to the system’s native crash reporter. If all
+  //! modules with a CrashpadInfo structure specify #kDefault, forwarding will
+  //! be enabled. Unless disabled, forwarding may still occur if the Crashpad
+  //! handler is disabled by SetCrashpadHandlerState(). Even when forwarding is
+  //! enabled, the Crashpad handler may choose not to forward all exceptions to
+  //! the system’s native crash reporter in cases where it has reason to believe
+  //! that the system’s native crash reporter would not normally have handled
+  //! the exception in Crashpad’s absence.
+  void SetNativeCrashReporterForwarding(TriState state);
+
   static const uint32_t kSignature = 'CPad';
 
  private:
   // The compiler won’t necessarily see anyone using these fields, but it
   // shouldn’t warn about that. These fields aren’t intended for use by the
   // process they’re found in, they’re supposed to be read by the crash
   // reporting process.
 #if defined(__clang__)
 #pragma clang diagnostic push
 #pragma clang diagnostic ignored "-Wunused-private-field"
 #endif
 
   // Fields present in version 1:
   uint32_t signature_;  // kSignature
   uint32_t size_;  // The size of the entire CrashpadInfo structure.
   uint32_t version_;  // kVersion
-  uint32_t padding_0_;
+
+  // options_ stores the state for SetCrashpadHandlerState() and
+  // SetNativeCrashReporterForwarding().
+  uint8_t options_;
+
+  uint8_t padding_0_;
+  uint16_t padding_1_;
   SimpleStringDictionary* simple_annotations_;  // weak
 
 #if defined(__clang__)
 #pragma clang diagnostic pop
 #endif
 
   DISALLOW_COPY_AND_ASSIGN(CrashpadInfo);
 };
 
 }  // namespace crashpad
 
 #endif  // CRASHPAD_CLIENT_CRASHPAD_INFO_H_