xref: /aosp_15_r20/external/google-breakpad/src/common/windows/pe_source_line_writer.h (revision 9712c20fc9bbfbac4935993a2ca0b3958c5adad2)
1 // Copyright 2019 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 #ifndef COMMON_WINDOWS_PE_SOURCE_LINE_WRITER_H_
30 #define COMMON_WINDOWS_PE_SOURCE_LINE_WRITER_H_
31 
32 #include <string>
33 
34 #include "common/windows/module_info.h"
35 
36 namespace google_breakpad {
37 
38 using std::wstring;
39 
40 // PESourceLineWriter uses a pe file produced by Visual C++ to output
41 // a line/address map for use with BasicSourceLineResolver.
42 // NOTE: Only supports PE32+ format, ie. a 64bit PE file.
43 class PESourceLineWriter {
44 public:
45   explicit PESourceLineWriter(const wstring& pe_file);
46   PESourceLineWriter(const PESourceLineWriter&) = delete;
47   void operator=(const PESourceLineWriter&) = delete;
48   ~PESourceLineWriter();
49 
50   // Writes Breakpad symbols from the pe file to |symbol_file|.
51   // Returns true on success.
52   bool WriteSymbols(FILE* symbol_file);
53 
54   // Retrieves information about the module. Returns true on success.
55   bool GetModuleInfo(PDBModuleInfo* info);
56 
57   // Retrieves information about the module's PE file.  Returns
58   // true on success.
59   bool GetPEInfo(PEModuleInfo* info);
60 
61 private:
62  const wstring pe_file_;
63 };
64 
65 }  // namespace google_breakpad
66 
67 #endif  // COMMON_WINDOWS_PE_SOURCE_LINE_WRITER_H_
68