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_UTIL_H_
31 #define COMMON_WINDOWS_PE_UTIL_H_
32
33 #include <windows.h>
34
35 #include "common/windows/module_info.h"
36
37 namespace google_breakpad {
38
39 using std::wstring;
40
41 // Reads |pe_file| and populates |info|. Returns true on success.
42 // Only supports PE32+ format, ie. a 64bit PE file.
43 // Will fail if |pe_file| does not contain a valid CodeView record.
44 bool ReadModuleInfo(const wstring& pe_file, PDBModuleInfo* info);
45
46 // Reads |pe_file| and populates |info|. Returns true on success.
47 bool ReadPEInfo(const wstring& pe_file, PEModuleInfo* info);
48
49 // Reads |pe_file| and prints frame data (aka. unwind info) to |out_file|.
50 // Only supports PE32+ format, ie. a 64bit PE file.
51 bool PrintPEFrameData(const wstring& pe_file, FILE* out_file);
52
53 // Combines a GUID |signature| and DWORD |age| to create a Breakpad debug
54 // identifier.
55 wstring GenerateDebugIdentifier(DWORD age, GUID signature);
56
57 // Combines a DWORD |signature| and DWORD |age| to create a Breakpad debug
58 // identifier.
59 wstring GenerateDebugIdentifier(DWORD age, DWORD signature);
60
61 // Converts |machine| enum value to the corresponding string used by Breakpad.
62 // The enum is IMAGE_FILE_MACHINE_*, contained in winnt.h.
FileHeaderMachineToCpuString(WORD machine)63 constexpr const wchar_t* FileHeaderMachineToCpuString(WORD machine) {
64 switch (machine) {
65 case IMAGE_FILE_MACHINE_I386: {
66 return L"x86";
67 }
68 case IMAGE_FILE_MACHINE_IA64:
69 case IMAGE_FILE_MACHINE_AMD64: {
70 return L"x86_64";
71 }
72 default: { return L"unknown"; }
73 }
74 }
75
76 } // namespace google_breakpad
77
78 #endif // COMMON_WINDOWS_PE_UTIL_H_
79