xref: /aosp_15_r20/external/google-breakpad/src/google_breakpad/processor/microdump_processor.h (revision 9712c20fc9bbfbac4935993a2ca0b3958c5adad2)
1 // Copyright 2014 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 // The processor for microdump (a reduced dump containing only the state of the
30 // crashing thread). See crbug.com/410294 for more info and design docs.
31 
32 #ifndef GOOGLE_BREAKPAD_PROCESSOR_MICRODUMP_PROCESSOR_H__
33 #define GOOGLE_BREAKPAD_PROCESSOR_MICRODUMP_PROCESSOR_H__
34 
35 #include <string>
36 
37 #include "common/using_std_string.h"
38 #include "google_breakpad/processor/process_result.h"
39 
40 namespace google_breakpad {
41 
42 class Microdump;
43 class ProcessState;
44 class StackFrameSymbolizer;
45 
46 class MicrodumpProcessor {
47  public:
48   // Initializes the MicrodumpProcessor with a stack frame symbolizer.
49   // Does not take ownership of frame_symbolizer, which must NOT be NULL.
50   explicit MicrodumpProcessor(StackFrameSymbolizer* frame_symbolizer);
51 
52   virtual ~MicrodumpProcessor();
53 
54   // Processes the microdump contents and fills process_state with the result.
55   google_breakpad::ProcessResult Process(Microdump* microdump,
56                                          ProcessState* process_state);
57  private:
58   StackFrameSymbolizer* frame_symbolizer_;
59 };
60 
61 }  // namespace google_breakpad
62 
63 #endif  // GOOGLE_BREAKPAD_PROCESSOR_MICRODUMP_PROCESSOR_H__
64