| //===- MinidumpTest.cpp - Tests for Minidump.cpp --------------------------===// |
| // |
| // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. |
| // See https://llvm.org/LICENSE.txt for license information. |
| // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception |
| // |
| //===----------------------------------------------------------------------===// |
| |
| #include "llvm/Object/Minidump.h" |
| #include "llvm/Support/MemoryBuffer.h" |
| #include "llvm/Testing/Support/Error.h" |
| #include "gtest/gtest.h" |
| |
| using namespace llvm; |
| using namespace llvm::object; |
| using namespace minidump; |
| |
| static Expected<std::unique_ptr<MinidumpFile>> create(ArrayRef<uint8_t> Data) { |
| return MinidumpFile::create( |
| MemoryBufferRef(toStringRef(Data), "Test buffer")); |
| } |
| |
| TEST(MinidumpFile, BasicInterface) { |
| // A very simple minidump file which contains just a single stream. |
| auto ExpectedFile = |
| create({ // Header |
| 'M', 'D', 'M', 'P', 0x93, 0xa7, 0, 0, // Signature, Version |
| 1, 0, 0, 0, // NumberOfStreams, |
| 0x20, 0, 0, 0, // StreamDirectoryRVA |
| 0, 1, 2, 3, 4, 5, 6, 7, // Checksum, TimeDateStamp |
| 8, 9, 0, 1, 2, 3, 4, 5, // Flags |
| // Stream Directory |
| 3, 0, 0x67, 0x47, 7, 0, 0, 0, // Type, DataSize, |
| 0x2c, 0, 0, 0, // RVA |
| // Stream |
| 'C', 'P', 'U', 'I', 'N', 'F', 'O'}); |
| ASSERT_THAT_EXPECTED(ExpectedFile, Succeeded()); |
| const MinidumpFile &File = **ExpectedFile; |
| const Header &H = File.header(); |
| EXPECT_EQ(Header::MagicSignature, H.Signature); |
| EXPECT_EQ(Header::MagicVersion, H.Version); |
| EXPECT_EQ(1u, H.NumberOfStreams); |
| EXPECT_EQ(0x20u, H.StreamDirectoryRVA); |
| EXPECT_EQ(0x03020100u, H.Checksum); |
| EXPECT_EQ(0x07060504u, H.TimeDateStamp); |
| EXPECT_EQ(uint64_t(0x0504030201000908), H.Flags); |
| |
| ASSERT_EQ(1u, File.streams().size()); |
| const Directory &Stream0 = File.streams()[0]; |
| EXPECT_EQ(StreamType::LinuxCPUInfo, Stream0.Type); |
| EXPECT_EQ(7u, Stream0.Location.DataSize); |
| EXPECT_EQ(0x2cu, Stream0.Location.RVA); |
| |
| EXPECT_EQ("CPUINFO", toStringRef(File.getRawStream(Stream0))); |
| EXPECT_EQ("CPUINFO", |
| toStringRef(*File.getRawStream(StreamType::LinuxCPUInfo))); |
| |
| EXPECT_THAT_EXPECTED(File.getSystemInfo(), Failed<BinaryError>()); |
| } |
| |
| // Use the input from the previous test, but corrupt it in various ways |
| TEST(MinidumpFile, create_ErrorCases) { |
| // File too short |
| EXPECT_THAT_EXPECTED(create({'M', 'D', 'M', 'P'}), Failed<BinaryError>()); |
| |
| // Wrong Signature |
| EXPECT_THAT_EXPECTED( |
| create({ // Header |
| '!', 'D', 'M', 'P', 0x93, 0xa7, 0, 0, // Signature, Version |
| 1, 0, 0, 0, // NumberOfStreams, |
| 0x20, 0, 0, 0, // StreamDirectoryRVA |
| 0, 1, 2, 3, 4, 5, 6, 7, // Checksum, TimeDateStamp |
| 8, 9, 0, 1, 2, 3, 4, 5, // Flags |
| // Stream Directory |
| 3, 0, 0x67, 0x47, 7, 0, 0, 0, // Type, DataSize, |
| 0x2c, 0, 0, 0, // RVA |
| // Stream |
| 'C', 'P', 'U', 'I', 'N', 'F', 'O'}), |
| Failed<BinaryError>()); |
| |
| // Wrong Version |
| EXPECT_THAT_EXPECTED( |
| create({ // Header |
| 'M', 'D', 'M', 'P', 0x39, 0xa7, 0, 0, // Signature, Version |
| 1, 0, 0, 0, // NumberOfStreams, |
| 0x20, 0, 0, 0, // StreamDirectoryRVA |
| 0, 1, 2, 3, 4, 5, 6, 7, // Checksum, TimeDateStamp |
| 8, 9, 0, 1, 2, 3, 4, 5, // Flags |
| // Stream Directory |
| 3, 0, 0x67, 0x47, 7, 0, 0, 0, // Type, DataSize, |
| 0x2c, 0, 0, 0, // RVA |
| // Stream |
| 'C', 'P', 'U', 'I', 'N', 'F', 'O'}), |
| Failed<BinaryError>()); |
| |
| // Stream directory after EOF |
| EXPECT_THAT_EXPECTED( |
| create({ // Header |
| 'M', 'D', 'M', 'P', 0x93, 0xa7, 0, 0, // Signature, Version |
| 1, 0, 0, 0, // NumberOfStreams, |
| 0x20, 1, 0, 0, // StreamDirectoryRVA |
| 0, 1, 2, 3, 4, 5, 6, 7, // Checksum, TimeDateStamp |
| 8, 9, 0, 1, 2, 3, 4, 5, // Flags |
| // Stream Directory |
| 3, 0, 0x67, 0x47, 7, 0, 0, 0, // Type, DataSize, |
| 0x2c, 0, 0, 0, // RVA |
| // Stream |
| 'C', 'P', 'U', 'I', 'N', 'F', 'O'}), |
| Failed<BinaryError>()); |
| |
| // Truncated stream directory |
| EXPECT_THAT_EXPECTED( |
| create({ // Header |
| 'M', 'D', 'M', 'P', 0x93, 0xa7, 0, 0, // Signature, Version |
| 1, 1, 0, 0, // NumberOfStreams, |
| 0x20, 0, 0, 0, // StreamDirectoryRVA |
| 0, 1, 2, 3, 4, 5, 6, 7, // Checksum, TimeDateStamp |
| 8, 9, 0, 1, 2, 3, 4, 5, // Flags |
| // Stream Directory |
| 3, 0, 0x67, 0x47, 7, 0, 0, 0, // Type, DataSize, |
| 0x2c, 0, 0, 0, // RVA |
| // Stream |
| 'C', 'P', 'U', 'I', 'N', 'F', 'O'}), |
| Failed<BinaryError>()); |
| |
| // Stream0 after EOF |
| EXPECT_THAT_EXPECTED( |
| create({ // Header |
| 'M', 'D', 'M', 'P', 0x93, 0xa7, 0, 0, // Signature, Version |
| 1, 0, 0, 0, // NumberOfStreams, |
| 0x20, 0, 0, 0, // StreamDirectoryRVA |
| 0, 1, 2, 3, 4, 5, 6, 7, // Checksum, TimeDateStamp |
| 8, 9, 0, 1, 2, 3, 4, 5, // Flags |
| // Stream Directory |
| 3, 0, 0x67, 0x47, 7, 0, 0, 0, // Type, DataSize, |
| 0x2c, 1, 0, 0, // RVA |
| // Stream |
| 'C', 'P', 'U', 'I', 'N', 'F', 'O'}), |
| Failed<BinaryError>()); |
| |
| // Truncated Stream0 |
| EXPECT_THAT_EXPECTED( |
| create({ // Header |
| 'M', 'D', 'M', 'P', 0x93, 0xa7, 0, 0, // Signature, Version |
| 1, 0, 0, 0, // NumberOfStreams, |
| 0x20, 0, 0, 0, // StreamDirectoryRVA |
| 0, 1, 2, 3, 4, 5, 6, 7, // Checksum, TimeDateStamp |
| 8, 9, 0, 1, 2, 3, 4, 5, // Flags |
| // Stream Directory |
| 3, 0, 0x67, 0x47, 8, 0, 0, 0, // Type, DataSize, |
| 0x2c, 0, 0, 0, // RVA |
| // Stream |
| 'C', 'P', 'U', 'I', 'N', 'F', 'O'}), |
| Failed<BinaryError>()); |
| |
| // Duplicate Stream |
| EXPECT_THAT_EXPECTED( |
| create({ // Header |
| 'M', 'D', 'M', 'P', 0x93, 0xa7, 0, 0, // Signature, Version |
| 2, 0, 0, 0, // NumberOfStreams, |
| 0x20, 0, 0, 0, // StreamDirectoryRVA |
| 0, 1, 2, 3, 4, 5, 6, 7, // Checksum, TimeDateStamp |
| 8, 9, 0, 1, 2, 3, 4, 5, // Flags |
| // Stream Directory |
| 3, 0, 0x67, 0x47, 7, 0, 0, 0, // Type, DataSize, |
| 0x40, 0, 0, 0, // RVA |
| // Stream |
| 3, 0, 0x67, 0x47, 7, 0, 0, 0, // Type, DataSize, |
| 0x40, 0, 0, 0, // RVA |
| // Stream |
| 'C', 'P', 'U', 'I', 'N', 'F', 'O'}), |
| Failed<BinaryError>()); |
| |
| // Stream matching one of the DenseMapInfo magic values |
| EXPECT_THAT_EXPECTED( |
| create({ // Header |
| 'M', 'D', 'M', 'P', 0x93, 0xa7, 0, 0, // Signature, Version |
| 1, 0, 0, 0, // NumberOfStreams, |
| 0x20, 0, 0, 0, // StreamDirectoryRVA |
| 0, 1, 2, 3, 4, 5, 6, 7, // Checksum, TimeDateStamp |
| 8, 9, 0, 1, 2, 3, 4, 5, // Flags |
| // Stream Directory |
| 0xff, 0xff, 0xff, 0xff, 7, 0, 0, 0, // Type, DataSize, |
| 0x2c, 0, 0, 0, // RVA |
| // Stream |
| 'C', 'P', 'U', 'I', 'N', 'F', 'O'}), |
| Failed<BinaryError>()); |
| } |
| |
| TEST(MinidumpFile, IngoresDummyStreams) { |
| auto ExpectedFile = create({ |
| // Header |
| 'M', 'D', 'M', 'P', 0x93, 0xa7, 0, 0, // Signature, Version |
| 2, 0, 0, 0, // NumberOfStreams, |
| 0x20, 0, 0, 0, // StreamDirectoryRVA |
| 0, 1, 2, 3, 4, 5, 6, 7, // Checksum, TimeDateStamp |
| 8, 9, 0, 1, 2, 3, 4, 5, // Flags |
| // Stream Directory |
| 0, 0, 0, 0, 0, 0, 0, 0, // Type, DataSize, |
| 0x20, 0, 0, 0, // RVA |
| 0, 0, 0, 0, 0, 0, 0, 0, // Type, DataSize, |
| 0x20, 0, 0, 0, // RVA |
| }); |
| ASSERT_THAT_EXPECTED(ExpectedFile, Succeeded()); |
| const MinidumpFile &File = **ExpectedFile; |
| ASSERT_EQ(2u, File.streams().size()); |
| EXPECT_EQ(StreamType::Unused, File.streams()[0].Type); |
| EXPECT_EQ(StreamType::Unused, File.streams()[1].Type); |
| EXPECT_EQ(None, File.getRawStream(StreamType::Unused)); |
| } |
| |
| TEST(MinidumpFile, getSystemInfo) { |
| auto ExpectedFile = create({ |
| // Header |
| 'M', 'D', 'M', 'P', 0x93, 0xa7, 0, 0, // Signature, Version |
| 1, 0, 0, 0, // NumberOfStreams, |
| 0x20, 0, 0, 0, // StreamDirectoryRVA |
| 0, 1, 2, 3, 4, 5, 6, 7, // Checksum, TimeDateStamp |
| 8, 9, 0, 1, 2, 3, 4, 5, // Flags |
| // Stream Directory |
| 7, 0, 0, 0, 56, 0, 0, 0, // Type, DataSize, |
| 0x2c, 0, 0, 0, // RVA |
| // SystemInfo |
| 0, 0, 1, 2, // ProcessorArch, ProcessorLevel |
| 3, 4, 5, 6, // ProcessorRevision, NumberOfProcessors, ProductType |
| 7, 8, 9, 0, 1, 2, 3, 4, // MajorVersion, MinorVersion |
| 5, 6, 7, 8, 2, 0, 0, 0, // BuildNumber, PlatformId |
| 1, 2, 3, 4, 5, 6, 7, 8, // CSDVersionRVA, SuiteMask, Reserved |
| 'L', 'L', 'V', 'M', 'L', 'L', 'V', 'M', 'L', 'L', 'V', 'M', // VendorID |
| 1, 2, 3, 4, 5, 6, 7, 8, // VersionInfo, FeatureInfo |
| 9, 0, 1, 2, // AMDExtendedFeatures |
| }); |
| ASSERT_THAT_EXPECTED(ExpectedFile, Succeeded()); |
| const MinidumpFile &File = **ExpectedFile; |
| |
| auto ExpectedInfo = File.getSystemInfo(); |
| ASSERT_THAT_EXPECTED(ExpectedInfo, Succeeded()); |
| const SystemInfo &Info = *ExpectedInfo; |
| EXPECT_EQ(ProcessorArchitecture::X86, Info.ProcessorArch); |
| EXPECT_EQ(0x0201, Info.ProcessorLevel); |
| EXPECT_EQ(0x0403, Info.ProcessorRevision); |
| EXPECT_EQ(5, Info.NumberOfProcessors); |
| EXPECT_EQ(6, Info.ProductType); |
| EXPECT_EQ(0x00090807u, Info.MajorVersion); |
| EXPECT_EQ(0x04030201u, Info.MinorVersion); |
| EXPECT_EQ(0x08070605u, Info.BuildNumber); |
| EXPECT_EQ(OSPlatform::Win32NT, Info.PlatformId); |
| EXPECT_EQ(0x04030201u, Info.CSDVersionRVA); |
| EXPECT_EQ(0x0605u, Info.SuiteMask); |
| EXPECT_EQ(0x0807u, Info.Reserved); |
| EXPECT_EQ("LLVMLLVMLLVM", llvm::StringRef(Info.CPU.X86.VendorID, |
| sizeof(Info.CPU.X86.VendorID))); |
| EXPECT_EQ(0x04030201u, Info.CPU.X86.VersionInfo); |
| EXPECT_EQ(0x08070605u, Info.CPU.X86.FeatureInfo); |
| EXPECT_EQ(0x02010009u, Info.CPU.X86.AMDExtendedFeatures); |
| } |