xref: /aosp_15_r20/external/google-breakpad/src/common/windows/module_info.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_MODULE_INFO_H_
30 #define COMMON_WINDOWS_MODULE_INFO_H_
31 
32 #include <string>
33 
34 namespace google_breakpad {
35 
36 using std::wstring;
37 // A structure that carries information that identifies a module.
38 struct PDBModuleInfo {
39 public:
40   // The basename of the pe/pdb file from which information was loaded.
41   wstring debug_file;
42 
43   // The module's identifier.  For recent pe/pdb files, the identifier consists
44   // of the pe/pdb's guid, in uppercase hexadecimal form without any dashes
45   // or separators, followed immediately by the pe/pdb's age, also in
46   // uppercase hexadecimal form.  For older pe/pdb files which have no guid,
47   // the identifier is the pe/pdb's 32-bit signature value, in zero-padded
48   // hexadecimal form, followed immediately by the pe/pdb's age, in lowercase
49   // hexadecimal form.
50   wstring debug_identifier;
51 
52   // A string identifying the cpu that the pe/pdb is associated with.
53   // Currently, this may be "x86" or "unknown".
54   wstring cpu;
55 };
56 
57 // A structure that carries information that identifies a PE file,
58 // either an EXE or a DLL.
59 struct PEModuleInfo {
60   // The basename of the PE file.
61   wstring code_file;
62 
63   // The PE file's code identifier, which consists of its timestamp
64   // and file size concatenated together into a single hex string.
65   // (The fields IMAGE_OPTIONAL_HEADER::SizeOfImage and
66   // IMAGE_FILE_HEADER::TimeDateStamp, as defined in the ImageHlp
67   // documentation.) This is not well documented, if it's documented
68   // at all, but it's what symstore does and what DbgHelp supports.
69   wstring code_identifier;
70 };
71 
72 }  // namespace google_breakpad
73 
74 #endif  // COMMON_WINDOWS_MODULE_INFO_H_
75