1 //===- llvm/unittest/Support/DataExtractorTest.cpp - DataExtractor tests --===// 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/Support/DataExtractor.h" 10 #include "llvm/Testing/Support/Error.h" 11 #include "gtest/gtest.h" 12 using namespace llvm; 13 14 namespace { 15 16 const char numberData[] = "\x80\x90\xFF\xFF\x80\x00\x00\x00"; 17 const char leb128data[] = "\xA6\x49"; 18 const char bigleb128data[] = "\xAA\xA9\xFF\xAA\xFF\xAA\xFF\x4A"; 19 20 TEST(DataExtractorTest, OffsetOverflow) { 21 DataExtractor DE(StringRef(numberData, sizeof(numberData)-1), false, 8); 22 EXPECT_FALSE(DE.isValidOffsetForDataOfSize(-2U, 5)); 23 } 24 25 TEST(DataExtractorTest, UnsignedNumbers) { 26 DataExtractor DE(StringRef(numberData, sizeof(numberData)-1), false, 8); 27 uint64_t offset = 0; 28 29 EXPECT_EQ(0x80U, DE.getU8(&offset)); 30 EXPECT_EQ(1U, offset); 31 offset = 0; 32 EXPECT_EQ(0x8090U, DE.getU16(&offset)); 33 EXPECT_EQ(2U, offset); 34 offset = 0; 35 EXPECT_EQ(0x8090FFFFU, DE.getU32(&offset)); 36 EXPECT_EQ(4U, offset); 37 offset = 0; 38 EXPECT_EQ(0x8090FFFF80000000ULL, DE.getU64(&offset)); 39 EXPECT_EQ(8U, offset); 40 offset = 0; 41 EXPECT_EQ(0x8090FFFF80000000ULL, DE.getAddress(&offset)); 42 EXPECT_EQ(8U, offset); 43 offset = 0; 44 45 uint32_t data[2]; 46 EXPECT_EQ(data, DE.getU32(&offset, data, 2)); 47 EXPECT_EQ(0x8090FFFFU, data[0]); 48 EXPECT_EQ(0x80000000U, data[1]); 49 EXPECT_EQ(8U, offset); 50 offset = 0; 51 52 // Now for little endian. 53 DE = DataExtractor(StringRef(numberData, sizeof(numberData)-1), true, 4); 54 EXPECT_EQ(0x9080U, DE.getU16(&offset)); 55 EXPECT_EQ(2U, offset); 56 offset = 0; 57 EXPECT_EQ(0xFFFF9080U, DE.getU32(&offset)); 58 EXPECT_EQ(4U, offset); 59 offset = 0; 60 EXPECT_EQ(0x80FFFF9080ULL, DE.getU64(&offset)); 61 EXPECT_EQ(8U, offset); 62 offset = 0; 63 EXPECT_EQ(0xFFFF9080U, DE.getAddress(&offset)); 64 EXPECT_EQ(4U, offset); 65 offset = 0; 66 67 EXPECT_EQ(data, DE.getU32(&offset, data, 2)); 68 EXPECT_EQ(0xFFFF9080U, data[0]); 69 EXPECT_EQ(0x80U, data[1]); 70 EXPECT_EQ(8U, offset); 71 } 72 73 TEST(DataExtractorTest, SignedNumbers) { 74 DataExtractor DE(StringRef(numberData, sizeof(numberData)-1), false, 8); 75 uint64_t offset = 0; 76 77 EXPECT_EQ(-128, DE.getSigned(&offset, 1)); 78 EXPECT_EQ(1U, offset); 79 offset = 0; 80 EXPECT_EQ(-32624, DE.getSigned(&offset, 2)); 81 EXPECT_EQ(2U, offset); 82 offset = 0; 83 EXPECT_EQ(-2137980929, DE.getSigned(&offset, 4)); 84 EXPECT_EQ(4U, offset); 85 offset = 0; 86 EXPECT_EQ(-9182558167379214336LL, DE.getSigned(&offset, 8)); 87 EXPECT_EQ(8U, offset); 88 } 89 90 TEST(DataExtractorTest, Strings) { 91 const char stringData[] = "hellohello\0hello"; 92 DataExtractor DE(StringRef(stringData, sizeof(stringData)-1), false, 8); 93 uint64_t offset = 0; 94 95 EXPECT_EQ(stringData, DE.getCStr(&offset)); 96 EXPECT_EQ(11U, offset); 97 EXPECT_EQ(nullptr, DE.getCStr(&offset)); 98 EXPECT_EQ(11U, offset); 99 100 DataExtractor::Cursor C(0); 101 EXPECT_EQ(stringData, DE.getCStr(C)); 102 EXPECT_EQ(11U, C.tell()); 103 EXPECT_EQ(nullptr, DE.getCStr(C)); 104 EXPECT_EQ(11U, C.tell()); 105 EXPECT_THAT_ERROR(C.takeError(), 106 FailedWithMessage("unexpected end of data at offset 0xb")); 107 } 108 109 TEST(DataExtractorTest, LEB128) { 110 DataExtractor DE(StringRef(leb128data, sizeof(leb128data)-1), false, 8); 111 uint64_t offset = 0; 112 113 EXPECT_EQ(9382ULL, DE.getULEB128(&offset)); 114 EXPECT_EQ(2U, offset); 115 offset = 0; 116 EXPECT_EQ(-7002LL, DE.getSLEB128(&offset)); 117 EXPECT_EQ(2U, offset); 118 119 DataExtractor BDE(StringRef(bigleb128data, sizeof(bigleb128data)-1), false,8); 120 offset = 0; 121 EXPECT_EQ(42218325750568106ULL, BDE.getULEB128(&offset)); 122 EXPECT_EQ(8U, offset); 123 offset = 0; 124 EXPECT_EQ(-29839268287359830LL, BDE.getSLEB128(&offset)); 125 EXPECT_EQ(8U, offset); 126 } 127 128 TEST(DataExtractorTest, LEB128_error) { 129 DataExtractor DE(StringRef("\x81"), false, 8); 130 uint64_t Offset = 0; 131 EXPECT_EQ(0U, DE.getULEB128(&Offset)); 132 EXPECT_EQ(0U, Offset); 133 134 Offset = 0; 135 EXPECT_EQ(0U, DE.getSLEB128(&Offset)); 136 EXPECT_EQ(0U, Offset); 137 } 138 139 TEST(DataExtractorTest, Cursor_tell) { 140 DataExtractor DE(StringRef("AB"), false, 8); 141 DataExtractor::Cursor C(0); 142 // A successful read operation advances the cursor 143 EXPECT_EQ('A', DE.getU8(C)); 144 EXPECT_EQ(1u, C.tell()); 145 146 // An unsuccessful one doesn't. 147 EXPECT_EQ(0u, DE.getU16(C)); 148 EXPECT_EQ(1u, C.tell()); 149 150 // And neither do any subsequent operations. 151 EXPECT_EQ(0, DE.getU8(C)); 152 EXPECT_EQ(1u, C.tell()); 153 154 consumeError(C.takeError()); 155 } 156 157 TEST(DataExtractorTest, Cursor_takeError) { 158 DataExtractor DE(StringRef("AB"), false, 8); 159 DataExtractor::Cursor C(0); 160 // Initially, the cursor is in the "success" state. 161 EXPECT_THAT_ERROR(C.takeError(), Succeeded()); 162 163 // It remains "success" after a successful read. 164 EXPECT_EQ('A', DE.getU8(C)); 165 EXPECT_THAT_ERROR(C.takeError(), Succeeded()); 166 167 // An unsuccessful read sets the error state. 168 EXPECT_EQ(0u, DE.getU32(C)); 169 EXPECT_THAT_ERROR(C.takeError(), Failed()); 170 171 // Once set the error sticks until explicitly cleared. 172 EXPECT_EQ(0u, DE.getU32(C)); 173 EXPECT_EQ(0, DE.getU8(C)); 174 EXPECT_THAT_ERROR(C.takeError(), Failed()); 175 176 // At which point reads can be succeed again. 177 EXPECT_EQ('B', DE.getU8(C)); 178 EXPECT_THAT_ERROR(C.takeError(), Succeeded()); 179 } 180 181 TEST(DataExtractorTest, Cursor_chaining) { 182 DataExtractor DE(StringRef("ABCD"), false, 8); 183 DataExtractor::Cursor C(0); 184 185 // Multiple reads can be chained without trigerring any assertions. 186 EXPECT_EQ('A', DE.getU8(C)); 187 EXPECT_EQ('B', DE.getU8(C)); 188 EXPECT_EQ('C', DE.getU8(C)); 189 EXPECT_EQ('D', DE.getU8(C)); 190 // And the error checked at the end. 191 EXPECT_THAT_ERROR(C.takeError(), Succeeded()); 192 } 193 194 #if defined(GTEST_HAS_DEATH_TEST) && defined(_DEBUG) 195 TEST(DataExtractorDeathTest, Cursor) { 196 DataExtractor DE(StringRef("AB"), false, 8); 197 198 // Even an unused cursor must be checked for errors: 199 EXPECT_DEATH(DataExtractor::Cursor(0), 200 "Success values must still be checked prior to being destroyed"); 201 202 { 203 auto C = std::make_unique<DataExtractor::Cursor>(0); 204 EXPECT_EQ(0u, DE.getU32(*C)); 205 // It must also be checked after an unsuccessful operation. 206 // destruction. 207 EXPECT_DEATH(C.reset(), "unexpected end of data"); 208 EXPECT_THAT_ERROR(C->takeError(), Failed()); 209 } 210 { 211 auto C = std::make_unique<DataExtractor::Cursor>(0); 212 EXPECT_EQ('A', DE.getU8(*C)); 213 // Same goes for a successful one. 214 EXPECT_DEATH( 215 C.reset(), 216 "Success values must still be checked prior to being destroyed"); 217 EXPECT_THAT_ERROR(C->takeError(), Succeeded()); 218 } 219 { 220 auto C = std::make_unique<DataExtractor::Cursor>(0); 221 EXPECT_EQ('A', DE.getU8(*C)); 222 EXPECT_EQ(0u, DE.getU32(*C)); 223 // Even if a successful operation is followed by an unsuccessful one. 224 EXPECT_DEATH(C.reset(), "unexpected end of data"); 225 EXPECT_THAT_ERROR(C->takeError(), Failed()); 226 } 227 { 228 auto C = std::make_unique<DataExtractor::Cursor>(0); 229 EXPECT_EQ(0u, DE.getU32(*C)); 230 EXPECT_EQ(0, DE.getU8(*C)); 231 // Even if an unsuccessful operation is followed by one that would normally 232 // succeed. 233 EXPECT_DEATH(C.reset(), "unexpected end of data"); 234 EXPECT_THAT_ERROR(C->takeError(), Failed()); 235 } 236 } 237 #endif 238 239 TEST(DataExtractorTest, getU8_vector) { 240 DataExtractor DE(StringRef("AB"), false, 8); 241 DataExtractor::Cursor C(0); 242 SmallVector<uint8_t, 2> S; 243 244 DE.getU8(C, S, 4); 245 EXPECT_THAT_ERROR(C.takeError(), Failed()); 246 EXPECT_EQ("", toStringRef(S)); 247 248 DE.getU8(C, S, 2); 249 EXPECT_THAT_ERROR(C.takeError(), Succeeded()); 250 EXPECT_EQ("AB", toStringRef(S)); 251 } 252 253 TEST(DataExtractorTest, skip) { 254 DataExtractor DE(StringRef("AB"), false, 8); 255 DataExtractor::Cursor C(0); 256 257 DE.skip(C, 4); 258 EXPECT_THAT_ERROR(C.takeError(), Failed()); 259 EXPECT_EQ(0u, C.tell()); 260 261 DE.skip(C, 2); 262 EXPECT_THAT_ERROR(C.takeError(), Succeeded()); 263 EXPECT_EQ(2u, C.tell()); 264 } 265 266 TEST(DataExtractorTest, eof) { 267 DataExtractor DE(StringRef("A"), false, 8); 268 DataExtractor::Cursor C(0); 269 270 EXPECT_FALSE(DE.eof(C)); 271 272 EXPECT_EQ(0, DE.getU16(C)); 273 EXPECT_FALSE(DE.eof(C)); 274 EXPECT_THAT_ERROR(C.takeError(), Failed()); 275 276 EXPECT_EQ('A', DE.getU8(C)); 277 EXPECT_TRUE(DE.eof(C)); 278 EXPECT_THAT_ERROR(C.takeError(), Succeeded()); 279 } 280 281 TEST(DataExtractorTest, size) { 282 uint8_t Data[] = {'A', 'B', 'C', 'D'}; 283 DataExtractor DE1(StringRef(reinterpret_cast<char *>(Data), sizeof(Data)), 284 false, 8); 285 EXPECT_EQ(DE1.size(), sizeof(Data)); 286 DataExtractor DE2(ArrayRef<uint8_t>(Data), false, 8); 287 EXPECT_EQ(DE2.size(), sizeof(Data)); 288 } 289 290 TEST(DataExtractorTest, FixedLengthString) { 291 const char Data[] = "hello\x00\x00\x00world \thola\x00"; 292 DataExtractor DE(StringRef(Data, sizeof(Data)-1), false, 8); 293 uint64_t Offset = 0; 294 StringRef Str; 295 // Test extracting too many bytes doesn't modify Offset and returns None. 296 Str = DE.getFixedLengthString(&Offset, sizeof(Data)); 297 EXPECT_TRUE(Str.empty()); 298 EXPECT_EQ(Offset, 0u); 299 300 // Test extracting a fixed width C string with trailing NULL characters. 301 Str = DE.getFixedLengthString(&Offset, 8); 302 EXPECT_EQ(Offset, 8u); 303 EXPECT_EQ(Str.size(), 5u); 304 EXPECT_EQ(Str, "hello"); 305 // Test extracting a fixed width C string with trailing space and tab 306 // characters. 307 Str = DE.getFixedLengthString(&Offset, 8, " \t"); 308 EXPECT_EQ(Offset, 16u); 309 EXPECT_EQ(Str.size(), 5u); 310 EXPECT_EQ(Str, "world"); 311 // Now extract a normal C string. 312 Str = DE.getCStrRef(&Offset); 313 EXPECT_EQ(Str.size(), 4u); 314 EXPECT_EQ(Str, "hola"); 315 } 316 317 318 TEST(DataExtractorTest, GetBytes) { 319 // Use data with an embedded NULL character for good measure. 320 const char Data[] = "\x01\x02\x00\x04"; 321 StringRef Bytes(Data, sizeof(Data)-1); 322 DataExtractor DE(Bytes, false, 8); 323 uint64_t Offset = 0; 324 StringRef Str; 325 // Test extracting too many bytes doesn't modify Offset and returns None. 326 Str = DE.getBytes(&Offset, sizeof(Data)); 327 EXPECT_TRUE(Str.empty()); 328 EXPECT_EQ(Offset, 0u); 329 // Test extracting 4 bytes from the stream. 330 Str = DE.getBytes(&Offset, 4); 331 EXPECT_EQ(Offset, 4u); 332 EXPECT_EQ(Str.size(), 4u); 333 EXPECT_EQ(Str, Bytes); 334 } 335 336 } 337