1 // Copyright (c) 2019, Google Inc.
2 // All rights reserved.
3 //
4 // Redistribution and use in source and binary forms, with or without
5 // modification, are permitted provided that the following conditions are
6 // met:
7 //
8 //     * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 //     * Redistributions in binary form must reproduce the above
11 // copyright notice, this list of conditions and the following disclaimer
12 // in the documentation and/or other materials provided with the
13 // distribution.
14 //     * Neither the name of Google Inc. nor the names of its
15 // contributors may be used to endorse or promote products derived from
16 // this software without specific prior written permission.
17 //
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 
30 #ifndef COMMON_WINDOWS_PE_SOURCE_LINE_WRITER_H_
31 #define COMMON_WINDOWS_PE_SOURCE_LINE_WRITER_H_
32 
33 #include <string>
34 
35 #include "common/basictypes.h"
36 #include "common/windows/module_info.h"
37 
38 namespace google_breakpad {
39 
40 using std::wstring;
41 
42 // PESourceLineWriter uses a pe file produced by Visual C++ to output
43 // a line/address map for use with BasicSourceLineResolver.
44 // NOTE: Only supports PE32+ format, ie. a 64bit PE file.
45 class PESourceLineWriter {
46 public:
47   explicit PESourceLineWriter(const wstring& pe_file);
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   DISALLOW_COPY_AND_ASSIGN(PESourceLineWriter);
65 };
66 
67 }  // namespace google_breakpad
68 
69 #endif  // COMMON_WINDOWS_PE_SOURCE_LINE_WRITER_H_
70