xref: /aosp_15_r20/external/google-breakpad/src/client/ios/handler/ios_exception_minidump_generator.h (revision 9712c20fc9bbfbac4935993a2ca0b3958c5adad2)
1 // Copyright 2012 Google LLC
2 //
3 // Redistribution and use in source and binary forms, with or without
4 // modification, are permitted provided that the following conditions are
5 // met:
6 //
7 //     * Redistributions of source code must retain the above copyright
8 // notice, this list of conditions and the following disclaimer.
9 //     * Redistributions in binary form must reproduce the above
10 // copyright notice, this list of conditions and the following disclaimer
11 // in the documentation and/or other materials provided with the
12 // distribution.
13 //     * Neither the name of Google LLC nor the names of its
14 // contributors may be used to endorse or promote products derived from
15 // this software without specific prior written permission.
16 //
17 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 
29 // ios_exception_minidump_generator.h:  Create a fake minidump from a
30 // NSException.
31 
32 #ifndef CLIENT_IOS_HANDLER_IOS_EXCEPTION_MINIDUMP_GENERATOR_H_
33 #define CLIENT_IOS_HANDLER_IOS_EXCEPTION_MINIDUMP_GENERATOR_H_
34 
35 #include <Foundation/Foundation.h>
36 
37 #include "client/mac/handler/minidump_generator.h"
38 
39 namespace google_breakpad {
40 
41 class IosExceptionMinidumpGenerator : public MinidumpGenerator {
42  public:
43   explicit IosExceptionMinidumpGenerator(NSException* exception);
44   virtual ~IosExceptionMinidumpGenerator();
45 
46  protected:
47   virtual bool WriteExceptionStream(MDRawDirectory* exception_stream);
48   virtual bool WriteThreadStream(mach_port_t thread_id, MDRawThread* thread);
49 
50  private:
51 
52   // Get the crashing program counter from the exception.
53   uintptr_t GetPCFromException();
54 
55   // Get the crashing link register from the exception.
56   uintptr_t GetLRFromException();
57 
58   // Write a virtual thread context for the crashing site.
59   bool WriteCrashingContext(MDLocationDescriptor* register_location);
60   // Per-CPU implementations of the above method.
61 #ifdef HAS_ARM_SUPPORT
62   bool WriteCrashingContextARM(MDLocationDescriptor* register_location);
63 #endif
64 #ifdef HAS_ARM64_SUPPORT
65   bool WriteCrashingContextARM64(MDLocationDescriptor* register_location);
66 #endif
67 
68   NSArray* return_addresses_;
69 };
70 
71 }  // namespace google_breakpad
72 
73 #endif  // CLIENT_IOS_HANDLER_IOS_EXCEPTION_MINIDUMP_GENERATOR_H_
74