Initial commit

Tools/Crashpad/include/handler/mac/crash_report_exception_handler.h

@@ -0,0 +1,93 @@
+// Copyright 2015 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,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#ifndef CRASHPAD_HANDLER_MAC_CRASH_REPORT_EXCEPTION_HANDLER_H_
+#define CRASHPAD_HANDLER_MAC_CRASH_REPORT_EXCEPTION_HANDLER_H_
+
+#include <mach/mach.h>
+
+#include <map>
+#include <string>
+
+#include "base/macros.h"
+#include "client/crash_report_database.h"
+#include "handler/crash_report_upload_thread.h"
+#include "handler/user_stream_data_source.h"
+#include "util/mach/exc_server_variants.h"
+
+namespace crashpad {
+
+//! \brief An exception handler that writes crash reports for exception messages
+//!     to a CrashReportDatabase.
+class CrashReportExceptionHandler : public UniversalMachExcServer::Interface {
+ public:
+  //! \brief Creates a new object that will store crash reports in \a database.
+  //!
+  //! \param[in] database The database to store crash reports in. Weak.
+  //! \param[in] upload_thread The upload thread to notify when a new crash
+  //!     report is written into \a database.
+  //! \param[in] process_annotations A map of annotations to insert as
+  //!     process-level annotations into each crash report that is written. Do
+  //!     not confuse this with module-level annotations, which are under the
+  //!     control of the crashing process, and are used to implement Chrome’s
+  //!     “crash keys.” Process-level annotations are those that are beyond the
+  //!     control of the crashing process, which must reliably be set even if
+  //!     the process crashes before it’s able to establish its own annotations.
+  //!     To interoperate with Breakpad servers, the recommended practice is to
+  //!     specify values for the `"prod"` and `"ver"` keys as process
+  //!     annotations.
+  //! \param[in] user_stream_data_sources Data sources to be used to extend
+  //!     crash reports. For each crash report that is written, the data sources
+  //!     are called in turn. These data sources may contribute additional
+  //!     minidump streams. `nullptr` if not required.
+  CrashReportExceptionHandler(
+      CrashReportDatabase* database,
+      CrashReportUploadThread* upload_thread,
+      const std::map<std::string, std::string>* process_annotations,
+      const UserStreamDataSources* user_stream_data_sources);
+
+  ~CrashReportExceptionHandler();
+
+  // UniversalMachExcServer::Interface:
+
+  //! \brief Processes an exception message by writing a crash report to this
+  //!     object’s CrashReportDatabase.
+  kern_return_t CatchMachException(
+      exception_behavior_t behavior,
+      exception_handler_t exception_port,
+      thread_t thread,
+      task_t task,
+      exception_type_t exception,
+      const mach_exception_data_type_t* code,
+      mach_msg_type_number_t code_count,
+      thread_state_flavor_t* flavor,
+      ConstThreadState old_state,
+      mach_msg_type_number_t old_state_count,
+      thread_state_t new_state,
+      mach_msg_type_number_t* new_state_count,
+      const mach_msg_trailer_t* trailer,
+      bool* destroy_complex_request) override;
+
+ private:
+  CrashReportDatabase* database_;  // weak
+  CrashReportUploadThread* upload_thread_;  // weak
+  const std::map<std::string, std::string>* process_annotations_;  // weak
+  const UserStreamDataSources* user_stream_data_sources_;  // weak
+
+  DISALLOW_COPY_AND_ASSIGN(CrashReportExceptionHandler);
+};
+
+}  // namespace crashpad
+
+#endif  // CRASHPAD_HANDLER_MAC_CRASH_REPORT_EXCEPTION_HANDLER_H_

Tools/Crashpad/include/handler/mac/exception_handler_server.h

@@ -0,0 +1,82 @@
+// 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,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#ifndef CRASHPAD_HANDLER_MAC_EXCEPTION_HANDLER_SERVER_H_
+#define CRASHPAD_HANDLER_MAC_EXCEPTION_HANDLER_SERVER_H_
+
+#include <mach/mach.h>
+
+#include "base/mac/scoped_mach_port.h"
+#include "base/macros.h"
+#include "util/mach/exc_server_variants.h"
+
+namespace crashpad {
+
+//! \brief Runs the main exception-handling server in Crashpad’s handler
+//!     process.
+class ExceptionHandlerServer {
+ public:
+  //! \brief Constructs an ExceptionHandlerServer object.
+  //!
+  //! \param[in] receive_port The port that exception messages and no-senders
+  //!     notifications will be received on.
+  //! \param[in] launchd If `true`, the exception handler is being run from
+  //!     launchd. \a receive_port is not monitored for no-senders
+  //!     notifications, and instead, Stop() must be called to provide a “quit”
+  //!     signal.
+  ExceptionHandlerServer(base::mac::ScopedMachReceiveRight receive_port,
+                         bool launchd);
+  ~ExceptionHandlerServer();
+
+  //! \brief Runs the exception-handling server.
+  //!
+  //! \param[in] exception_interface An object to send exception messages to.
+  //!
+  //! This method monitors the receive port for exception messages and, if
+  //! not being run by launchd, no-senders notifications. It continues running
+  //! until it has no more clients, indicated by the receipt of a no-senders
+  //! notification, or until Stop() is called. When not being run by launchd, it
+  //! is important to assure that a send right exists in a client (or has been
+  //! queued by `mach_msg()` to be sent to a client) prior to calling this
+  //! method, or it will detect that it is sender-less and return immediately.
+  //!
+  //! All exception messages will be passed to \a exception_interface.
+  //!
+  //! This method must only be called once on an ExceptionHandlerServer object.
+  //!
+  //! If an unexpected condition that prevents this method from functioning is
+  //! encountered, it will log a message and terminate execution. Receipt of an
+  //! invalid message on the receive port will cause a message to be logged, but
+  //! this method will continue running normally.
+  void Run(UniversalMachExcServer::Interface* exception_interface);
+
+  //! \brief Stops a running exception-handling server.
+  //!
+  //! Stop() may be called at any time, and may be called from a signal handler.
+  //! If Stop() is called before Run() it will cause Run() to return as soon as
+  //! it is called. It is harmless to call Stop() after Run() has already
+  //! returned, or to call Stop() after it has already been called.
+  void Stop();
+
+ private:
+  base::mac::ScopedMachReceiveRight receive_port_;
+  base::mac::ScopedMachReceiveRight notify_port_;
+  bool launchd_;
+
+  DISALLOW_COPY_AND_ASSIGN(ExceptionHandlerServer);
+};
+
+}  // namespace crashpad
+
+#endif  // CRASHPAD_HANDLER_MAC_EXCEPTION_HANDLER_SERVER_H_

Tools/Crashpad/include/handler/mac/file_limit_annotation.h

@@ -0,0 +1,38 @@
+// Copyright 2017 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,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#ifndef CRASHPAD_HANDLER_MAC_FILE_LIMIT_ANNOTATION_H_
+#define CRASHPAD_HANDLER_MAC_FILE_LIMIT_ANNOTATION_H_
+
+namespace crashpad {
+
+//! \brief Records a `"file-limits"` simple annotation for the process.
+//!
+//! This annotation will be used to confirm the theory that certain crashes are
+//! caused by systems at or near their file descriptor table size limits.
+//!
+//! The format of the annotation is four comma-separated values: the system-wide
+//! `kern.num_files` and `kern.maxfiles` values from `sysctl()`, and the
+//! process-specific current and maximum file descriptor limits from
+//! `getrlimit(RLIMIT_NOFILE, …)`.
+//!
+//! See https://crashpad.chromium.org/bug/180.
+//!
+//! TODO(mark): Remove this annotation after sufficient data has been collected
+//! for analysis.
+void RecordFileLimitAnnotation();
+
+}  // namespace crashpad
+
+#endif  // CRASHPAD_HANDLER_MAC_FILE_LIMIT_ANNOTATION_H_