LLVM  9.0.0svn
Minidump.cpp
Go to the documentation of this file.
1 //===- Minidump.cpp - Minidump object file implementation -----------------===//
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 #include "llvm/Object/Minidump.h"
10 #include "llvm/Object/Error.h"
12 
13 using namespace llvm;
14 using namespace llvm::object;
15 using namespace llvm::minidump;
16 
19  auto It = StreamMap.find(Type);
20  if (It != StreamMap.end())
21  return getRawStream(Streams[It->second]);
22  return None;
23 }
24 
26  // Minidump strings consist of a 32-bit length field, which gives the size of
27  // the string in *bytes*. This is followed by the actual string encoded in
28  // UTF16.
29  auto ExpectedSize =
30  getDataSliceAs<support::ulittle32_t>(getData(), Offset, 1);
31  if (!ExpectedSize)
32  return ExpectedSize.takeError();
33  size_t Size = (*ExpectedSize)[0];
34  if (Size % 2 != 0)
35  return createError("String size not even");
36  Size /= 2;
37  if (Size == 0)
38  return "";
39 
40  Offset += sizeof(support::ulittle32_t);
41  auto ExpectedData =
42  getDataSliceAs<support::ulittle16_t>(getData(), Offset, Size);
43  if (!ExpectedData)
44  return ExpectedData.takeError();
45 
46  SmallVector<UTF16, 32> WStr(Size);
47  copy(*ExpectedData, WStr.begin());
48 
49  std::string Result;
50  if (!convertUTF16ToUTF8String(WStr, Result))
51  return createError("String decoding failed");
52 
53  return Result;
54 }
55 
57  auto OptionalStream = getRawStream(StreamType::ModuleList);
58  if (!OptionalStream)
59  return createError("No such stream");
60  auto ExpectedSize =
61  getDataSliceAs<support::ulittle32_t>(*OptionalStream, 0, 1);
62  if (!ExpectedSize)
63  return ExpectedSize.takeError();
64 
65  size_t ListSize = ExpectedSize.get()[0];
66 
67  size_t ListOffset = 4;
68  // Some producers insert additional padding bytes to align the module list to
69  // 8-byte boundary. Check for that by comparing the module list size with the
70  // overall stream size.
71  if (ListOffset + sizeof(Module) * ListSize < OptionalStream->size())
72  ListOffset = 8;
73 
74  return getDataSliceAs<Module>(*OptionalStream, ListOffset, ListSize);
75 }
76 
78 MinidumpFile::getDataSlice(ArrayRef<uint8_t> Data, size_t Offset, size_t Size) {
79  // Check for overflow.
80  if (Offset + Size < Offset || Offset + Size < Size ||
81  Offset + Size > Data.size())
82  return createEOFError();
83  return Data.slice(Offset, Size);
84 }
85 
89  auto ExpectedHeader = getDataSliceAs<minidump::Header>(Data, 0, 1);
90  if (!ExpectedHeader)
91  return ExpectedHeader.takeError();
92 
93  const minidump::Header &Hdr = (*ExpectedHeader)[0];
94  if (Hdr.Signature != Header::MagicSignature)
95  return createError("Invalid signature");
96  if ((Hdr.Version & 0xffff) != Header::MagicVersion)
97  return createError("Invalid version");
98 
99  auto ExpectedStreams = getDataSliceAs<Directory>(Data, Hdr.StreamDirectoryRVA,
100  Hdr.NumberOfStreams);
101  if (!ExpectedStreams)
102  return ExpectedStreams.takeError();
103 
105  for (const auto &Stream : llvm::enumerate(*ExpectedStreams)) {
106  StreamType Type = Stream.value().Type;
107  const LocationDescriptor &Loc = Stream.value().Location;
108 
109  auto ExpectedStream = getDataSlice(Data, Loc.RVA, Loc.DataSize);
110  if (!ExpectedStream)
111  return ExpectedStream.takeError();
112 
113  if (Type == StreamType::Unused && Loc.DataSize == 0) {
114  // Ignore dummy streams. This is technically ill-formed, but a number of
115  // existing minidumps seem to contain such streams.
116  continue;
117  }
118 
121  return createError("Cannot handle one of the minidump streams");
122 
123  // Update the directory map, checking for duplicate stream types.
124  if (!StreamMap.try_emplace(Type, Stream.index()).second)
125  return createError("Duplicate stream type");
126  }
127 
128  return std::unique_ptr<MinidumpFile>(
129  new MinidumpFile(Source, Hdr, *ExpectedStreams, std::move(StreamMap)));
130 }
Expected< ArrayRef< minidump::Module > > getModuleList() const
Returns the module list embedded in the ModuleList stream.
Definition: Minidump.cpp:56
const NoneType None
Definition: None.h:23
This class represents lattice values for constants.
Definition: AllocatorList.h:23
Specifies the location (and size) of various objects in the minidump file.
Definition: Minidump.h:56
A Module instance is used to store all the information related to an LLVM module. ...
Definition: Module.h:65
support::ulittle32_t NumberOfStreams
Definition: Minidump.h:37
support::ulittle32_t Signature
Definition: Minidump.h:33
ArrayRef< uint8_t > arrayRefFromStringRef(StringRef Input)
Construct a string ref from an array ref of unsigned chars.
Definition: StringExtras.h:60
unsigned second
static Error createError(StringRef Err)
Definition: ELF.h:47
Expected< std::string > getString(size_t Offset) const
Returns the minidump string at the given offset.
Definition: Minidump.cpp:25
StreamType
The type of a minidump stream identifies its contents.
Definition: Minidump.h:47
StringRef getBuffer() const
Definition: MemoryBuffer.h:272
Tagged union holding either a T or a Error.
Definition: CachePruning.h:22
The minidump header is the first part of a minidump file.
Definition: Minidump.h:29
support::ulittle32_t StreamDirectoryRVA
Definition: Minidump.h:38
Type(LLVMContext &C, TypeID tid)
Definition: Type.h:90
static Expected< std::unique_ptr< MinidumpFile > > create(MemoryBufferRef Source)
Construct a new MinidumpFile object from the given memory buffer.
Definition: Minidump.cpp:87
The instances of the Type class are immutable: once they are created, they are never changed...
Definition: Type.h:45
detail::packed_endian_specific_integral< uint32_t, little, unaligned > ulittle32_t
Definition: Endian.h:274
size_t size() const
size - Get the array size.
Definition: ArrayRef.h:148
ArrayRef< uint8_t > getRawStream(const minidump::Directory &Stream) const
Returns the raw contents of the stream given by the directory entry.
Definition: Minidump.h:38
support::ulittle32_t Version
Definition: Minidump.h:36
auto size(R &&Range, typename std::enable_if< std::is_same< typename std::iterator_traits< decltype(Range.begin())>::iterator_category, std::random_access_iterator_tag >::value, void >::type *=nullptr) -> decltype(std::distance(Range.begin(), Range.end()))
Get the size of a range.
Definition: STLExtras.h:1166
This is a &#39;vector&#39; (really, a variable-sized array), optimized for the case when the array is small...
Definition: SmallVector.h:841
support::ulittle32_t RVA
Definition: Minidump.h:58
ArrayRef< T > slice(size_t N, size_t M) const
slice(n, m) - Chop off the first N elements of the array, and keep M elements in the array...
Definition: ArrayRef.h:178
bool convertUTF16ToUTF8String(ArrayRef< char > SrcBytes, std::string &Out)
Converts a stream of raw bytes assumed to be UTF16 into a UTF8 std::string.
support::ulittle32_t DataSize
Definition: Minidump.h:57
uint32_t Size
Definition: Profile.cpp:46
OutputIt copy(R &&Range, OutputIt Out)
Definition: STLExtras.h:1237
A class providing access to the contents of a minidump file.
Definition: Minidump.h:22
detail::enumerator< R > enumerate(R &&TheRange)
Given an input range, returns a new range whose values are are pair (A,B) such that A is the 0-based ...
Definition: STLExtras.h:1571