OLD | NEW |
1 // Copyright 2015 The Crashpad Authors. All rights reserved. | 1 // Copyright 2015 The Crashpad Authors. All rights reserved. |
2 // | 2 // |
3 // Licensed under the Apache License, Version 2.0 (the "License"); | 3 // Licensed under the Apache License, Version 2.0 (the "License"); |
4 // you may not use this file except in compliance with the License. | 4 // you may not use this file except in compliance with the License. |
5 // You may obtain a copy of the License at | 5 // You may obtain a copy of the License at |
6 // | 6 // |
7 // http://www.apache.org/licenses/LICENSE-2.0 | 7 // http://www.apache.org/licenses/LICENSE-2.0 |
8 // | 8 // |
9 // Unless required by applicable law or agreed to in writing, software | 9 // Unless required by applicable law or agreed to in writing, software |
10 // distributed under the License is distributed on an "AS IS" BASIS, | 10 // distributed under the License is distributed on an "AS IS" BASIS, |
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | 11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
12 // See the License for the specific language governing permissions and | 12 // See the License for the specific language governing permissions and |
13 // limitations under the License. | 13 // limitations under the License. |
14 | 14 |
15 #ifndef CRASHPAD_HANDLER_MAC_CRASH_REPORT_EXCEPTION_HANDLER_H_ | 15 #ifndef CRASHPAD_HANDLER_MAC_CRASH_REPORT_EXCEPTION_HANDLER_H_ |
16 #define CRASHPAD_HANDLER_MAC_CRASH_REPORT_EXCEPTION_HANDLER_H_ | 16 #define CRASHPAD_HANDLER_MAC_CRASH_REPORT_EXCEPTION_HANDLER_H_ |
17 | 17 |
18 #include <mach/mach.h> | 18 #include <mach/mach.h> |
19 | 19 |
| 20 #include <map> |
| 21 #include <string> |
| 22 |
20 #include "base/basictypes.h" | 23 #include "base/basictypes.h" |
21 #include "client/crash_report_database.h" | 24 #include "client/crash_report_database.h" |
22 #include "handler/mac/crash_report_upload_thread.h" | 25 #include "handler/mac/crash_report_upload_thread.h" |
23 #include "util/mach/exc_server_variants.h" | 26 #include "util/mach/exc_server_variants.h" |
24 | 27 |
25 namespace crashpad { | 28 namespace crashpad { |
26 | 29 |
27 //! \brief An exception handler that writes crash reports for exception messages | 30 //! \brief An exception handler that writes crash reports for exception messages |
28 //! to a CrashReportDatabase. | 31 //! to a CrashReportDatabase. |
29 class CrashReportExceptionHandler : public UniversalMachExcServer::Interface { | 32 class CrashReportExceptionHandler : public UniversalMachExcServer::Interface { |
30 public: | 33 public: |
31 //! \brief Creates a new object that will store crash reports in \a database. | 34 //! \brief Creates a new object that will store crash reports in \a database. |
32 //! | 35 //! |
33 //! \param[in] database The database to store crash reports in. Weak. | 36 //! \param[in] database The database to store crash reports in. Weak. |
34 //! \param[in] upload_thread The upload thread to notify when a new crash | 37 //! \param[in] upload_thread The upload thread to notify when a new crash |
35 //! report is written into \a database. | 38 //! report is written into \a database. |
36 CrashReportExceptionHandler(CrashReportDatabase* database, | 39 //! \param[in] process_annotations A map of annotations to insert as |
37 CrashReportUploadThread* upload_thread); | 40 //! process-level annotations into each crash report that is written. Do |
| 41 //! not confuse this with module-level annotations, which are under the |
| 42 //! control of the crashing process, and are used to implement Chrome’s |
| 43 //! “crash keys.” Process-level annotations are those that are beyond the |
| 44 //! control of the crashing process, which must reliably be set even if |
| 45 //! the process crashes before it’s able to establish its own annotations. |
| 46 //! To interoperate with Breakpad servers, the recommended practice is to |
| 47 //! specify values for the `"prod"` and `"ver"` keys as process |
| 48 //! annotations. |
| 49 CrashReportExceptionHandler( |
| 50 CrashReportDatabase* database, |
| 51 CrashReportUploadThread* upload_thread, |
| 52 const std::map<std::string, std::string>* process_annotations); |
38 | 53 |
39 ~CrashReportExceptionHandler(); | 54 ~CrashReportExceptionHandler(); |
40 | 55 |
41 // UniversalMachExcServer::Interface: | 56 // UniversalMachExcServer::Interface: |
42 | 57 |
43 //! \brief Processes an exception message by writing a crash report to this | 58 //! \brief Processes an exception message by writing a crash report to this |
44 //! object’s CrashReportDatabase. | 59 //! object’s CrashReportDatabase. |
45 kern_return_t CatchMachException( | 60 kern_return_t CatchMachException( |
46 exception_behavior_t behavior, | 61 exception_behavior_t behavior, |
47 exception_handler_t exception_port, | 62 exception_handler_t exception_port, |
48 thread_t thread, | 63 thread_t thread, |
49 task_t task, | 64 task_t task, |
50 exception_type_t exception, | 65 exception_type_t exception, |
51 const mach_exception_data_type_t* code, | 66 const mach_exception_data_type_t* code, |
52 mach_msg_type_number_t code_count, | 67 mach_msg_type_number_t code_count, |
53 thread_state_flavor_t* flavor, | 68 thread_state_flavor_t* flavor, |
54 const natural_t* old_state, | 69 const natural_t* old_state, |
55 mach_msg_type_number_t old_state_count, | 70 mach_msg_type_number_t old_state_count, |
56 thread_state_t new_state, | 71 thread_state_t new_state, |
57 mach_msg_type_number_t* new_state_count, | 72 mach_msg_type_number_t* new_state_count, |
58 const mach_msg_trailer_t* trailer, | 73 const mach_msg_trailer_t* trailer, |
59 bool* destroy_complex_request) override; | 74 bool* destroy_complex_request) override; |
60 | 75 |
61 private: | 76 private: |
62 CrashReportDatabase* database_; // weak | 77 CrashReportDatabase* database_; // weak |
63 CrashReportUploadThread* upload_thread_; // weak | 78 CrashReportUploadThread* upload_thread_; // weak |
| 79 const std::map<std::string, std::string>* process_annotations_; // weak |
64 | 80 |
65 DISALLOW_COPY_AND_ASSIGN(CrashReportExceptionHandler); | 81 DISALLOW_COPY_AND_ASSIGN(CrashReportExceptionHandler); |
66 }; | 82 }; |
67 | 83 |
68 } // namespace crashpad | 84 } // namespace crashpad |
69 | 85 |
70 #endif // CRASHPAD_HANDLER_MAC_CRASH_REPORT_EXCEPTION_HANDLER_H_ | 86 #endif // CRASHPAD_HANDLER_MAC_CRASH_REPORT_EXCEPTION_HANDLER_H_ |
OLD | NEW |