LLVM 19.0.0git
Minidump.h
Go to the documentation of this file.
1//===- Minidump.h - Minidump constants and structures -----------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// This header constants and data structures pertaining to the Windows Minidump
10// core file format.
11//
12// Reference:
13// https://msdn.microsoft.com/en-us/library/windows/desktop/ms679293(v=vs.85).aspx
14// https://chromium.googlesource.com/breakpad/breakpad/
15//
16//===----------------------------------------------------------------------===//
17
18#ifndef LLVM_BINARYFORMAT_MINIDUMP_H
19#define LLVM_BINARYFORMAT_MINIDUMP_H
20
23#include "llvm/Support/Endian.h"
24
25namespace llvm {
26namespace minidump {
27
29
30/// The minidump header is the first part of a minidump file. It identifies the
31/// file as a minidump file, and gives the location of the stream directory.
32struct Header {
33 static constexpr uint32_t MagicSignature = 0x504d444d; // PMDM
34 static constexpr uint16_t MagicVersion = 0xa793;
35
37 // The high 16 bits of version field are implementation specific. The low 16
38 // bits should be MagicVersion.
45};
46static_assert(sizeof(Header) == 32);
47
48/// The type of a minidump stream identifies its contents. Streams numbers after
49/// LastReserved are for application-defined data streams.
50enum class StreamType : uint32_t {
51#define HANDLE_MDMP_STREAM_TYPE(CODE, NAME) NAME = CODE,
52#include "llvm/BinaryFormat/MinidumpConstants.def"
53 Unused = 0,
54 LastReserved = 0x0000ffff,
55};
56
57/// Specifies the location (and size) of various objects in the minidump file.
58/// The location is relative to the start of the file.
62};
63static_assert(sizeof(LocationDescriptor) == 8);
64
65/// Describes a single memory range (both its VM address and where to find it in
66/// the file) of the process from which this minidump file was generated.
70};
71static_assert(sizeof(MemoryDescriptor) == 16);
72
76};
77
82
88};
89static_assert(sizeof(MemoryInfoListHeader) == 16);
90
92#define HANDLE_MDMP_PROTECT(CODE, NAME, NATIVENAME) NAME = CODE,
93#include "llvm/BinaryFormat/MinidumpConstants.def"
94 LLVM_MARK_AS_BITMASK_ENUM(/*LargestValue=*/0xffffffffu),
95};
96
97enum class MemoryState : uint32_t {
98#define HANDLE_MDMP_MEMSTATE(CODE, NAME, NATIVENAME) NAME = CODE,
99#include "llvm/BinaryFormat/MinidumpConstants.def"
100 LLVM_MARK_AS_BITMASK_ENUM(/*LargestValue=*/0xffffffffu),
101};
102
103enum class MemoryType : uint32_t {
104#define HANDLE_MDMP_MEMTYPE(CODE, NAME, NATIVENAME) NAME = CODE,
105#include "llvm/BinaryFormat/MinidumpConstants.def"
106 LLVM_MARK_AS_BITMASK_ENUM(/*LargestValue=*/0xffffffffu),
107};
108
119};
120static_assert(sizeof(MemoryInfo) == 48);
121
122/// Specifies the location and type of a single stream in the minidump file. The
123/// minidump stream directory is an array of entries of this type, with its size
124/// given by Header.NumberOfStreams.
125struct Directory {
128};
129static_assert(sizeof(Directory) == 12);
130
131/// The processor architecture of the system that generated this minidump. Used
132/// in the ProcessorArch field of the SystemInfo stream.
134#define HANDLE_MDMP_ARCH(CODE, NAME) NAME = CODE,
135#include "llvm/BinaryFormat/MinidumpConstants.def"
136};
137
138/// The OS Platform of the system that generated this minidump. Used in the
139/// PlatformId field of the SystemInfo stream.
140enum class OSPlatform : uint32_t {
141#define HANDLE_MDMP_PLATFORM(CODE, NAME) NAME = CODE,
142#include "llvm/BinaryFormat/MinidumpConstants.def"
143};
144
145/// Detailed information about the processor of the system that generated this
146/// minidump. Its interpretation depends on the ProcessorArchitecture enum.
147union CPUInfo {
148 struct X86Info {
149 char VendorID[12]; // cpuid 0: ebx, edx, ecx
154 struct ArmInfo {
156 support::ulittle32_t ElfHWCaps; // linux specific, 0 otherwise
158 struct OtherInfo {
159 uint8_t ProcessorFeatures[16];
161};
162static_assert(sizeof(CPUInfo) == 24);
163
164/// The SystemInfo stream, containing various information about the system where
165/// this minidump was generated.
170
172 uint8_t ProductType;
173
179
182
184};
185static_assert(sizeof(SystemInfo) == 56);
186
201};
202static_assert(sizeof(VSFixedFileInfo) == 52);
203
204inline bool operator==(const VSFixedFileInfo &LHS, const VSFixedFileInfo &RHS) {
205 return memcmp(&LHS, &RHS, sizeof(VSFixedFileInfo)) == 0;
206}
207
208struct Module {
219};
220static_assert(sizeof(Module) == 108);
221
222/// Describes a single thread in the minidump file. Part of the ThreadList
223/// stream.
224struct Thread {
232};
233static_assert(sizeof(Thread) == 48);
234
235struct Exception {
236 static constexpr size_t MaxParameters = 15;
237
245};
246static_assert(sizeof(Exception) == 152);
247
253};
254static_assert(sizeof(ExceptionStream) == 168);
255
256} // namespace minidump
257
258template <> struct DenseMapInfo<minidump::StreamType> {
260
262 return minidump::StreamType(-2);
263 }
264
265 static unsigned getHashValue(minidump::StreamType Val) {
266 return DenseMapInfo<uint32_t>::getHashValue(static_cast<uint32_t>(Val));
267 }
268
270 return LHS == RHS;
271 }
272};
273
274} // namespace llvm
275
276#endif // LLVM_BINARYFORMAT_MINIDUMP_H
This file defines DenseMapInfo traits for DenseMap.
Merge contiguous icmps into a memcmp
Definition: MergeICmps.cpp:911
Value * RHS
Value * LHS
ProcessorArchitecture
The processor architecture of the system that generated this minidump.
Definition: Minidump.h:133
StreamType
The type of a minidump stream identifies its contents.
Definition: Minidump.h:50
OSPlatform
The OS Platform of the system that generated this minidump.
Definition: Minidump.h:140
LLVM_ENABLE_BITMASK_ENUMS_IN_NAMESPACE()
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
bool operator==(const AddressRangeValuePair &LHS, const AddressRangeValuePair &RHS)
static unsigned getHashValue(minidump::StreamType Val)
Definition: Minidump.h:265
static minidump::StreamType getTombstoneKey()
Definition: Minidump.h:261
static bool isEqual(minidump::StreamType LHS, minidump::StreamType RHS)
Definition: Minidump.h:269
static minidump::StreamType getEmptyKey()
Definition: Minidump.h:259
An information struct used to provide DenseMap with the various necessary components for a given valu...
Definition: DenseMapInfo.h:52
support::ulittle32_t CPUID
Definition: Minidump.h:155
support::ulittle32_t ElfHWCaps
Definition: Minidump.h:156
support::ulittle32_t AMDExtendedFeatures
Definition: Minidump.h:152
support::ulittle32_t VersionInfo
Definition: Minidump.h:150
support::ulittle32_t FeatureInfo
Definition: Minidump.h:151
Specifies the location and type of a single stream in the minidump file.
Definition: Minidump.h:125
LocationDescriptor Location
Definition: Minidump.h:127
support::little_t< StreamType > Type
Definition: Minidump.h:126
support::ulittle32_t UnusedAlignment
Definition: Minidump.h:250
LocationDescriptor ThreadContext
Definition: Minidump.h:252
support::ulittle32_t ThreadId
Definition: Minidump.h:249
static constexpr size_t MaxParameters
Definition: Minidump.h:236
support::ulittle32_t ExceptionFlags
Definition: Minidump.h:239
support::ulittle32_t NumberParameters
Definition: Minidump.h:242
support::ulittle64_t ExceptionInformation[MaxParameters]
Definition: Minidump.h:244
support::ulittle64_t ExceptionRecord
Definition: Minidump.h:240
support::ulittle64_t ExceptionAddress
Definition: Minidump.h:241
support::ulittle32_t UnusedAlignment
Definition: Minidump.h:243
support::ulittle32_t ExceptionCode
Definition: Minidump.h:238
The minidump header is the first part of a minidump file.
Definition: Minidump.h:32
support::ulittle64_t Flags
Definition: Minidump.h:44
support::ulittle32_t NumberOfStreams
Definition: Minidump.h:40
support::ulittle32_t Version
Definition: Minidump.h:39
support::ulittle32_t TimeDateStamp
Definition: Minidump.h:43
static constexpr uint32_t MagicSignature
Definition: Minidump.h:33
static constexpr uint16_t MagicVersion
Definition: Minidump.h:34
support::ulittle32_t Signature
Definition: Minidump.h:36
support::ulittle32_t Checksum
Definition: Minidump.h:42
support::ulittle32_t StreamDirectoryRVA
Definition: Minidump.h:41
Specifies the location (and size) of various objects in the minidump file.
Definition: Minidump.h:59
support::ulittle32_t RVA
Definition: Minidump.h:61
support::ulittle32_t DataSize
Definition: Minidump.h:60
support::ulittle64_t DataSize
Definition: Minidump.h:75
support::ulittle64_t StartOfMemoryRange
Definition: Minidump.h:74
Describes a single memory range (both its VM address and where to find it in the file) of the process...
Definition: Minidump.h:67
support::ulittle64_t StartOfMemoryRange
Definition: Minidump.h:68
LocationDescriptor Memory
Definition: Minidump.h:69
support::ulittle32_t SizeOfHeader
Definition: Minidump.h:79
support::ulittle32_t SizeOfEntry
Definition: Minidump.h:80
support::ulittle64_t NumberOfEntries
Definition: Minidump.h:81
MemoryInfoListHeader(uint32_t SizeOfHeader, uint32_t SizeOfEntry, uint64_t NumberOfEntries)
Definition: Minidump.h:84
support::little_t< MemoryState > State
Definition: Minidump.h:115
support::ulittle64_t BaseAddress
Definition: Minidump.h:110
support::little_t< MemoryProtection > AllocationProtect
Definition: Minidump.h:112
support::little_t< MemoryType > Type
Definition: Minidump.h:117
support::little_t< MemoryProtection > Protect
Definition: Minidump.h:116
support::ulittle32_t Reserved1
Definition: Minidump.h:118
support::ulittle64_t AllocationBase
Definition: Minidump.h:111
support::ulittle32_t Reserved0
Definition: Minidump.h:113
support::ulittle64_t RegionSize
Definition: Minidump.h:114
LocationDescriptor CvRecord
Definition: Minidump.h:215
support::ulittle64_t Reserved0
Definition: Minidump.h:217
support::ulittle32_t TimeDateStamp
Definition: Minidump.h:212
support::ulittle64_t Reserved1
Definition: Minidump.h:218
support::ulittle32_t Checksum
Definition: Minidump.h:211
LocationDescriptor MiscRecord
Definition: Minidump.h:216
VSFixedFileInfo VersionInfo
Definition: Minidump.h:214
support::ulittle32_t SizeOfImage
Definition: Minidump.h:210
support::ulittle64_t BaseOfImage
Definition: Minidump.h:209
support::ulittle32_t ModuleNameRVA
Definition: Minidump.h:213
The SystemInfo stream, containing various information about the system where this minidump was genera...
Definition: Minidump.h:166
support::ulittle16_t ProcessorRevision
Definition: Minidump.h:169
support::little_t< ProcessorArchitecture > ProcessorArch
Definition: Minidump.h:167
support::ulittle32_t BuildNumber
Definition: Minidump.h:176
support::ulittle16_t SuiteMask
Definition: Minidump.h:180
support::ulittle32_t MajorVersion
Definition: Minidump.h:174
support::little_t< OSPlatform > PlatformId
Definition: Minidump.h:177
support::ulittle32_t CSDVersionRVA
Definition: Minidump.h:178
support::ulittle32_t MinorVersion
Definition: Minidump.h:175
support::ulittle16_t Reserved
Definition: Minidump.h:181
support::ulittle16_t ProcessorLevel
Definition: Minidump.h:168
Describes a single thread in the minidump file.
Definition: Minidump.h:224
support::ulittle32_t Priority
Definition: Minidump.h:228
support::ulittle64_t EnvironmentBlock
Definition: Minidump.h:229
support::ulittle32_t PriorityClass
Definition: Minidump.h:227
MemoryDescriptor Stack
Definition: Minidump.h:230
LocationDescriptor Context
Definition: Minidump.h:231
support::ulittle32_t SuspendCount
Definition: Minidump.h:226
support::ulittle32_t ThreadId
Definition: Minidump.h:225
support::ulittle32_t Signature
Definition: Minidump.h:188
support::ulittle32_t StructVersion
Definition: Minidump.h:189
support::ulittle32_t FileDateLow
Definition: Minidump.h:200
support::ulittle32_t FileVersionLow
Definition: Minidump.h:191
support::ulittle32_t FileDateHigh
Definition: Minidump.h:199
support::ulittle32_t FileFlagsMask
Definition: Minidump.h:194
support::ulittle32_t ProductVersionLow
Definition: Minidump.h:193
support::ulittle32_t FileFlags
Definition: Minidump.h:195
support::ulittle32_t FileSubtype
Definition: Minidump.h:198
support::ulittle32_t FileOS
Definition: Minidump.h:196
support::ulittle32_t FileType
Definition: Minidump.h:197
support::ulittle32_t FileVersionHigh
Definition: Minidump.h:190
support::ulittle32_t ProductVersionHigh
Definition: Minidump.h:192
Detailed information about the processor of the system that generated this minidump.
Definition: Minidump.h:147
struct llvm::minidump::CPUInfo::ArmInfo Arm
struct llvm::minidump::CPUInfo::OtherInfo Other
struct llvm::minidump::CPUInfo::X86Info X86