LLDB  mainline
MinidumpTypes.h
Go to the documentation of this file.
1 //===-- MinidumpTypes.h -----------------------------------------*- 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 #ifndef LLDB_SOURCE_PLUGINS_PROCESS_MINIDUMP_MINIDUMPTYPES_H
10 #define LLDB_SOURCE_PLUGINS_PROCESS_MINIDUMP_MINIDUMPTYPES_H
11 
12 #include "lldb/Utility/Status.h"
13 
14 #include "llvm/ADT/ArrayRef.h"
15 #include "llvm/ADT/BitmaskEnum.h"
16 #include "llvm/ADT/Optional.h"
17 #include "llvm/ADT/SmallVector.h"
18 #include "llvm/ADT/StringRef.h"
19 #include "llvm/BinaryFormat/Minidump.h"
20 #include "llvm/Support/ConvertUTF.h"
21 #include "llvm/Support/Endian.h"
22 
23 // C includes
24 // C++ includes
25 
26 // Reference:
27 // https://msdn.microsoft.com/en-us/library/windows/desktop/ms679293(v=vs.85).aspx
28 // https://chromium.googlesource.com/breakpad/breakpad/
29 
30 namespace lldb_private {
31 
32 namespace minidump {
33 
34 using namespace llvm::minidump;
35 
37 
38 enum class CvSignature : uint32_t {
39  Pdb70 = 0x53445352, // RSDS
40  ElfBuildId = 0x4270454c, // BpEL (Breakpad/Crashpad minidumps)
41 };
42 
44  ProcessID = (1 << 0),
45  ProcessTimes = (1 << 1),
46  LLVM_MARK_AS_BITMASK_ENUM(/* LargestValue = */ ProcessTimes)
47 };
48 
49 template <typename T>
50 Status consumeObject(llvm::ArrayRef<uint8_t> &Buffer, const T *&Object) {
51  Status error;
52  if (Buffer.size() < sizeof(T)) {
53  error.SetErrorString("Insufficient buffer!");
54  return error;
55  }
56 
57  Object = reinterpret_cast<const T *>(Buffer.data());
58  Buffer = Buffer.drop_front(sizeof(T));
59  return error;
60 }
61 
63  llvm::support::ulittle64_t start_of_memory_range;
64  llvm::support::ulittle64_t data_size;
65 
66  static std::pair<llvm::ArrayRef<MinidumpMemoryDescriptor64>, uint64_t>
67  ParseMemory64List(llvm::ArrayRef<uint8_t> &data);
68 };
69 static_assert(sizeof(MinidumpMemoryDescriptor64) == 16,
70  "sizeof MinidumpMemoryDescriptor64 is not correct!");
71 
72 // TODO misc2, misc3 ?
73 // Reference:
74 // https://msdn.microsoft.com/en-us/library/windows/desktop/ms680389(v=vs.85).aspx
76  llvm::support::ulittle32_t size;
77  // flags1 represents what info in the struct is valid
78  llvm::support::ulittle32_t flags1;
79  llvm::support::ulittle32_t process_id;
80  llvm::support::ulittle32_t process_create_time;
81  llvm::support::ulittle32_t process_user_time;
82  llvm::support::ulittle32_t process_kernel_time;
83 
84  static const MinidumpMiscInfo *Parse(llvm::ArrayRef<uint8_t> &data);
85 
86  llvm::Optional<lldb::pid_t> GetPid() const;
87 };
88 static_assert(sizeof(MinidumpMiscInfo) == 24,
89  "sizeof MinidumpMiscInfo is not correct!");
90 
91 // The /proc/pid/status is saved as an ascii string in the file
93 public:
94  llvm::StringRef proc_status;
96 
97  static llvm::Optional<LinuxProcStatus> Parse(llvm::ArrayRef<uint8_t> &data);
98 
99  lldb::pid_t GetPid() const;
100 
101 private:
102  LinuxProcStatus() = default;
103 };
104 
105 } // namespace minidump
106 } // namespace lldb_private
107 #endif // LLDB_SOURCE_PLUGINS_PROCESS_MINIDUMP_MINIDUMPTYPES_H
lldb_private::minidump::CvSignature::ElfBuildId
@ ElfBuildId
lldb_private::minidump::MinidumpMiscInfo
Definition: MinidumpTypes.h:75
lldb_private::minidump::LLVM_ENABLE_BITMASK_ENUMS_IN_NAMESPACE
LLVM_ENABLE_BITMASK_ENUMS_IN_NAMESPACE()
lldb_private::minidump::MinidumpMiscInfoFlags::ProcessID
@ ProcessID
lldb_private::minidump::MinidumpMiscInfo::process_id
llvm::support::ulittle32_t process_id
Definition: MinidumpTypes.h:79
lldb_private::minidump::MinidumpMiscInfo::process_user_time
llvm::support::ulittle32_t process_user_time
Definition: MinidumpTypes.h:81
error
static llvm::raw_ostream & error(Stream &strm)
Definition: CommandReturnObject.cpp:17
lldb_private::minidump::MinidumpMiscInfo::size
llvm::support::ulittle32_t size
Definition: MinidumpTypes.h:76
lldb_private::minidump::LinuxProcStatus::proc_status
llvm::StringRef proc_status
Definition: MinidumpTypes.h:94
lldb_private::minidump::LinuxProcStatus
Definition: MinidumpTypes.h:92
lldb_private::minidump::MinidumpMiscInfo::process_kernel_time
llvm::support::ulittle32_t process_kernel_time
Definition: MinidumpTypes.h:82
lldb_private::minidump::CvSignature::Pdb70
@ Pdb70
lldb_private::minidump::MinidumpMiscInfo::flags1
llvm::support::ulittle32_t flags1
Definition: MinidumpTypes.h:78
lldb_private::minidump::MinidumpMiscInfoFlags::ProcessTimes
@ ProcessTimes
lldb_private::Status
Definition: Status.h:44
uint32_t
lldb::pid_t
uint64_t pid_t
Definition: lldb-types.h:85
lldb_private::minidump::MinidumpMemoryDescriptor64
Definition: MinidumpTypes.h:62
lldb_private::minidump::consumeObject
Status consumeObject(llvm::ArrayRef< uint8_t > &Buffer, const T *&Object)
Definition: MinidumpTypes.h:50
lldb_private::minidump::LinuxProcStatus::pid
lldb::pid_t pid
Definition: MinidumpTypes.h:95
Status.h
lldb_private
A class that represents a running process on the host machine.
Definition: SBCommandInterpreterRunOptions.h:16
lldb_private::minidump::MinidumpMemoryDescriptor64::start_of_memory_range
llvm::support::ulittle64_t start_of_memory_range
Definition: MinidumpTypes.h:63
lldb_private::minidump::MinidumpMemoryDescriptor64::data_size
llvm::support::ulittle64_t data_size
Definition: MinidumpTypes.h:64
lldb_private::minidump::MinidumpMiscInfo::process_create_time
llvm::support::ulittle32_t process_create_time
Definition: MinidumpTypes.h:80
lldb_private::minidump::MinidumpMiscInfoFlags
MinidumpMiscInfoFlags
Definition: MinidumpTypes.h:43
lldb_private::minidump::CvSignature
CvSignature
Definition: MinidumpTypes.h:38