OLD | NEW |
| (Empty) |
1 // Copyright 2014 The Crashpad Authors. All rights reserved. | |
2 // | |
3 // Licensed under the Apache License, Version 2.0 (the "License"); | |
4 // you may not use this file except in compliance with the License. | |
5 // You may obtain a copy of the License at | |
6 // | |
7 // http://www.apache.org/licenses/LICENSE-2.0 | |
8 // | |
9 // Unless required by applicable law or agreed to in writing, software | |
10 // distributed under the License is distributed on an "AS IS" BASIS, | |
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
12 // See the License for the specific language governing permissions and | |
13 // limitations under the License. | |
14 | |
15 #ifndef CRASHPAD_MINIDUMP_MINIDUMP_MEMORY_WRITER_TEST_UTIL_H_ | |
16 #define CRASHPAD_MINIDUMP_MINIDUMP_MEMORY_WRITER_TEST_UTIL_H_ | |
17 | |
18 #include "minidump/minidump_memory_writer.h" | |
19 | |
20 #include <dbghelp.h> | |
21 #include <stdint.h> | |
22 | |
23 #include <string> | |
24 | |
25 #include "base/basictypes.h" | |
26 #include "util/file/file_writer.h" | |
27 | |
28 namespace crashpad { | |
29 namespace test { | |
30 | |
31 //! \brief A MinidumpMemoryWriter implementation used for testing. | |
32 //! | |
33 //! TestMinidumpMemoryWriter objects are created with a fixed base address and | |
34 //! size, and will write the same byte (\a value) repeatedly, \a size times. | |
35 class TestMinidumpMemoryWriter final : public MinidumpMemoryWriter { | |
36 public: | |
37 TestMinidumpMemoryWriter(uint64_t base_address, size_t size, uint8_t value); | |
38 ~TestMinidumpMemoryWriter(); | |
39 | |
40 protected: | |
41 // MinidumpMemoryWriter: | |
42 uint64_t MemoryRangeBaseAddress() const override; | |
43 size_t MemoryRangeSize() const override; | |
44 | |
45 // MinidumpWritable: | |
46 bool WillWriteAtOffsetImpl(off_t offset) override; | |
47 bool WriteObject(FileWriterInterface* file_writer) override; | |
48 | |
49 private: | |
50 uint64_t base_address_; | |
51 off_t expected_offset_; | |
52 size_t size_; | |
53 uint8_t value_; | |
54 | |
55 DISALLOW_COPY_AND_ASSIGN(TestMinidumpMemoryWriter); | |
56 }; | |
57 | |
58 //! \brief Verifies, via gtest assertions, that a MINIDUMP_MEMORY_DESCRIPTOR | |
59 //! structure contains expected values. | |
60 //! | |
61 //! In \a expected and \a observed, | |
62 //! MINIDUMP_MEMORY_DESCRIPTOR::StartOfMemoryRange and | |
63 //! MINIDUMP_LOCATION_DESCRIPTOR::DataSize are compared and must match. If | |
64 //! MINIDUMP_LOCATION_DESCRIPTOR::Rva is nonzero in \a expected, the same field | |
65 //! in \a observed must match it, subject to a 16-byte alignment augmentation. | |
66 //! | |
67 //! \param[in] expected A MINIDUMP_MEMORY_DESCRIPTOR structure containing | |
68 //! expected values. | |
69 //! \param[in] observed A MINIDUMP_MEMORY_DESCRIPTOR structure containing | |
70 //! observed values. | |
71 void ExpectMinidumpMemoryDescriptor(const MINIDUMP_MEMORY_DESCRIPTOR* expected, | |
72 const MINIDUMP_MEMORY_DESCRIPTOR* observed); | |
73 | |
74 //! \brief Verifies, via gtest assertions, that a MINIDUMP_MEMORY_DESCRIPTOR | |
75 //! structure contains expected values, and that the memory region it points | |
76 //! to contains expected values assuming it was written by a | |
77 //! TestMinidumpMemoryWriter object. | |
78 //! | |
79 //! \a expected and \a observed are compared by | |
80 //! ExpectMinidumpMemoryDescriptor(). | |
81 //! | |
82 //! \param[in] expected A MINIDUMP_MEMORY_DESCRIPTOR structure containing | |
83 //! expected values. | |
84 //! \param[in] observed A MINIDUMP_MEMORY_DESCRIPTOR structure containing | |
85 //! observed values. | |
86 //! \param[in] file_contents The contents of the minidump file in which \a | |
87 //! observed was found. The memory region referenced by \a observed will be | |
88 //! read from this string. | |
89 //! \param[in] value The \a value used to create a TestMinidumpMemoryWriter. | |
90 //! Each byte of memory in the region referenced by \a observed must be this | |
91 //! value. | |
92 //! \param[in] at_eof If `true`, the region referenced by \a observed must | |
93 //! appear at the end of \a file_contents, without any data following it. | |
94 void ExpectMinidumpMemoryDescriptorAndContents( | |
95 const MINIDUMP_MEMORY_DESCRIPTOR* expected, | |
96 const MINIDUMP_MEMORY_DESCRIPTOR* observed, | |
97 const std::string& file_contents, | |
98 uint8_t value, | |
99 bool at_eof); | |
100 | |
101 } // namespace test | |
102 } // namespace crashpad | |
103 | |
104 #endif // CRASHPAD_MINIDUMP_MINIDUMP_MEMORY_WRITER_TEST_UTIL_H_ | |
OLD | NEW |