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 DataExtractor::Cursor C(0); 139 EXPECT_EQ(0U, DE.getULEB128(C)); 140 EXPECT_THAT_ERROR( 141 C.takeError(), 142 FailedWithMessage("unable to decode LEB128 at offset 0x00000000: " 143 "malformed uleb128, extends past end")); 144 145 C = DataExtractor::Cursor(0); 146 EXPECT_EQ(0U, DE.getSLEB128(C)); 147 EXPECT_THAT_ERROR( 148 C.takeError(), 149 FailedWithMessage("unable to decode LEB128 at offset 0x00000000: " 150 "malformed sleb128, extends past end")); 151 152 // Show non-zero offsets are reported appropriately. 153 C = DataExtractor::Cursor(1); 154 EXPECT_EQ(0U, DE.getULEB128(C)); 155 EXPECT_THAT_ERROR( 156 C.takeError(), 157 FailedWithMessage("unable to decode LEB128 at offset 0x00000001: " 158 "malformed uleb128, extends past end")); 159 } 160 161 TEST(DataExtractorTest, Cursor_tell) { 162 DataExtractor DE(StringRef("AB"), false, 8); 163 DataExtractor::Cursor C(0); 164 // A successful read operation advances the cursor 165 EXPECT_EQ('A', DE.getU8(C)); 166 EXPECT_EQ(1u, C.tell()); 167 168 // An unsuccessful one doesn't. 169 EXPECT_EQ(0u, DE.getU16(C)); 170 EXPECT_EQ(1u, C.tell()); 171 172 // And neither do any subsequent operations. 173 EXPECT_EQ(0, DE.getU8(C)); 174 EXPECT_EQ(1u, C.tell()); 175 176 consumeError(C.takeError()); 177 } 178 179 TEST(DataExtractorTest, Cursor_takeError) { 180 DataExtractor DE(StringRef("AB"), false, 8); 181 DataExtractor::Cursor C(0); 182 // Initially, the cursor is in the "success" state. 183 EXPECT_THAT_ERROR(C.takeError(), Succeeded()); 184 185 // It remains "success" after a successful read. 186 EXPECT_EQ('A', DE.getU8(C)); 187 EXPECT_THAT_ERROR(C.takeError(), Succeeded()); 188 189 // An unsuccessful read sets the error state. 190 EXPECT_EQ(0u, DE.getU32(C)); 191 EXPECT_THAT_ERROR(C.takeError(), Failed()); 192 193 // Once set the error sticks until explicitly cleared. 194 EXPECT_EQ(0u, DE.getU32(C)); 195 EXPECT_EQ(0, DE.getU8(C)); 196 EXPECT_THAT_ERROR(C.takeError(), Failed()); 197 198 // At which point reads can be succeed again. 199 EXPECT_EQ('B', DE.getU8(C)); 200 EXPECT_THAT_ERROR(C.takeError(), Succeeded()); 201 } 202 203 TEST(DataExtractorTest, Cursor_chaining) { 204 DataExtractor DE(StringRef("ABCD"), false, 8); 205 DataExtractor::Cursor C(0); 206 207 // Multiple reads can be chained without trigerring any assertions. 208 EXPECT_EQ('A', DE.getU8(C)); 209 EXPECT_EQ('B', DE.getU8(C)); 210 EXPECT_EQ('C', DE.getU8(C)); 211 EXPECT_EQ('D', DE.getU8(C)); 212 // And the error checked at the end. 213 EXPECT_THAT_ERROR(C.takeError(), Succeeded()); 214 } 215 216 #if defined(GTEST_HAS_DEATH_TEST) && defined(_DEBUG) 217 TEST(DataExtractorDeathTest, Cursor) { 218 DataExtractor DE(StringRef("AB"), false, 8); 219 220 // Even an unused cursor must be checked for errors: 221 EXPECT_DEATH(DataExtractor::Cursor(0), 222 "Success values must still be checked prior to being destroyed"); 223 224 { 225 auto C = std::make_unique<DataExtractor::Cursor>(0); 226 EXPECT_EQ(0u, DE.getU32(*C)); 227 // It must also be checked after an unsuccessful operation. 228 // destruction. 229 EXPECT_DEATH(C.reset(), "unexpected end of data"); 230 EXPECT_THAT_ERROR(C->takeError(), Failed()); 231 } 232 { 233 auto C = std::make_unique<DataExtractor::Cursor>(0); 234 EXPECT_EQ('A', DE.getU8(*C)); 235 // Same goes for a successful one. 236 EXPECT_DEATH( 237 C.reset(), 238 "Success values must still be checked prior to being destroyed"); 239 EXPECT_THAT_ERROR(C->takeError(), Succeeded()); 240 } 241 { 242 auto C = std::make_unique<DataExtractor::Cursor>(0); 243 EXPECT_EQ('A', DE.getU8(*C)); 244 EXPECT_EQ(0u, DE.getU32(*C)); 245 // Even if a successful operation is followed by an unsuccessful one. 246 EXPECT_DEATH(C.reset(), "unexpected end of data"); 247 EXPECT_THAT_ERROR(C->takeError(), Failed()); 248 } 249 { 250 auto C = std::make_unique<DataExtractor::Cursor>(0); 251 EXPECT_EQ(0u, DE.getU32(*C)); 252 EXPECT_EQ(0, DE.getU8(*C)); 253 // Even if an unsuccessful operation is followed by one that would normally 254 // succeed. 255 EXPECT_DEATH(C.reset(), "unexpected end of data"); 256 EXPECT_THAT_ERROR(C->takeError(), Failed()); 257 } 258 } 259 #endif 260 261 TEST(DataExtractorTest, getU8_vector) { 262 DataExtractor DE(StringRef("AB"), false, 8); 263 DataExtractor::Cursor C(0); 264 SmallVector<uint8_t, 2> S; 265 266 DE.getU8(C, S, 4); 267 EXPECT_THAT_ERROR(C.takeError(), Failed()); 268 EXPECT_EQ("", toStringRef(S)); 269 270 DE.getU8(C, S, 2); 271 EXPECT_THAT_ERROR(C.takeError(), Succeeded()); 272 EXPECT_EQ("AB", toStringRef(S)); 273 } 274 275 TEST(DataExtractorTest, getU24) { 276 DataExtractor DE(StringRef("ABCD"), false, 8); 277 DataExtractor::Cursor C(0); 278 279 EXPECT_EQ(0x414243u, DE.getU24(C)); 280 EXPECT_EQ(0u, DE.getU24(C)); 281 EXPECT_EQ(3u, C.tell()); 282 EXPECT_THAT_ERROR(C.takeError(), Failed()); 283 } 284 285 TEST(DataExtractorTest, skip) { 286 DataExtractor DE(StringRef("AB"), false, 8); 287 DataExtractor::Cursor C(0); 288 289 DE.skip(C, 4); 290 EXPECT_THAT_ERROR(C.takeError(), Failed()); 291 EXPECT_EQ(0u, C.tell()); 292 293 DE.skip(C, 2); 294 EXPECT_THAT_ERROR(C.takeError(), Succeeded()); 295 EXPECT_EQ(2u, C.tell()); 296 } 297 298 TEST(DataExtractorTest, eof) { 299 DataExtractor DE(StringRef("A"), false, 8); 300 DataExtractor::Cursor C(0); 301 302 EXPECT_FALSE(DE.eof(C)); 303 304 EXPECT_EQ(0, DE.getU16(C)); 305 EXPECT_FALSE(DE.eof(C)); 306 EXPECT_THAT_ERROR(C.takeError(), Failed()); 307 308 EXPECT_EQ('A', DE.getU8(C)); 309 EXPECT_TRUE(DE.eof(C)); 310 EXPECT_THAT_ERROR(C.takeError(), Succeeded()); 311 } 312 313 TEST(DataExtractorTest, size) { 314 uint8_t Data[] = {'A', 'B', 'C', 'D'}; 315 DataExtractor DE1(StringRef(reinterpret_cast<char *>(Data), sizeof(Data)), 316 false, 8); 317 EXPECT_EQ(DE1.size(), sizeof(Data)); 318 DataExtractor DE2(ArrayRef<uint8_t>(Data), false, 8); 319 EXPECT_EQ(DE2.size(), sizeof(Data)); 320 } 321 322 TEST(DataExtractorTest, FixedLengthString) { 323 const char Data[] = "hello\x00\x00\x00world \thola\x00"; 324 DataExtractor DE(StringRef(Data, sizeof(Data)-1), false, 8); 325 uint64_t Offset = 0; 326 StringRef Str; 327 // Test extracting too many bytes doesn't modify Offset and returns None. 328 Str = DE.getFixedLengthString(&Offset, sizeof(Data)); 329 EXPECT_TRUE(Str.empty()); 330 EXPECT_EQ(Offset, 0u); 331 332 // Test extracting a fixed width C string with trailing NULL characters. 333 Str = DE.getFixedLengthString(&Offset, 8); 334 EXPECT_EQ(Offset, 8u); 335 EXPECT_EQ(Str.size(), 5u); 336 EXPECT_EQ(Str, "hello"); 337 // Test extracting a fixed width C string with trailing space and tab 338 // characters. 339 Str = DE.getFixedLengthString(&Offset, 8, " \t"); 340 EXPECT_EQ(Offset, 16u); 341 EXPECT_EQ(Str.size(), 5u); 342 EXPECT_EQ(Str, "world"); 343 // Now extract a normal C string. 344 Str = DE.getCStrRef(&Offset); 345 EXPECT_EQ(Str.size(), 4u); 346 EXPECT_EQ(Str, "hola"); 347 } 348 349 350 TEST(DataExtractorTest, GetBytes) { 351 // Use data with an embedded NULL character for good measure. 352 const char Data[] = "\x01\x02\x00\x04"; 353 StringRef Bytes(Data, sizeof(Data)-1); 354 DataExtractor DE(Bytes, false, 8); 355 uint64_t Offset = 0; 356 StringRef Str; 357 // Test extracting too many bytes doesn't modify Offset and returns None. 358 Str = DE.getBytes(&Offset, sizeof(Data)); 359 EXPECT_TRUE(Str.empty()); 360 EXPECT_EQ(Offset, 0u); 361 // Test extracting 4 bytes from the stream. 362 Str = DE.getBytes(&Offset, 4); 363 EXPECT_EQ(Offset, 4u); 364 EXPECT_EQ(Str.size(), 4u); 365 EXPECT_EQ(Str, Bytes); 366 367 DataExtractor::Cursor C(0); 368 EXPECT_EQ(StringRef("\x01\x02"), DE.getBytes(C, 2)); 369 EXPECT_EQ(StringRef("\x00\x04", 2), DE.getBytes(C, 2)); 370 EXPECT_EQ(StringRef(), DE.getBytes(C, 2)); 371 EXPECT_EQ(StringRef(), DE.getBytes(C, 2)); 372 EXPECT_EQ(4u, C.tell()); 373 EXPECT_THAT_ERROR(C.takeError(), Failed()); 374 } 375 376 } 377