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