DataExtractor.h revision 36da2aa6dc5ad9994b638ed09eb81c44cc05540b
1//===-- DataExtractor.h -----------------------------------------*- C++ -*-===// 2// 3// The LLVM Compiler Infrastructure 4// 5// This file is distributed under the University of Illinois Open Source 6// License. See LICENSE.TXT for details. 7// 8//===----------------------------------------------------------------------===// 9 10#ifndef liblldb_DataExtractor_h_ 11#define liblldb_DataExtractor_h_ 12#if defined (__cplusplus) 13 14 15#include "lldb/lldb-private.h" 16#include <limits.h> 17#include <stdint.h> 18#include <string.h> 19 20namespace lldb_private { 21 22//---------------------------------------------------------------------- 23/// @class DataExtractor DataExtractor.h "lldb/Core/DataExtractor.h" 24/// @brief An data extractor class. 25/// 26/// DataExtractor is a class that can extract data (swapping if needed) 27/// from a data buffer. The data buffer can be caller owned, or can be 28/// shared data that can be shared between multiple DataExtractor 29/// instances. Multiple DataExtractor objects can share the same data, 30/// yet extract values in different address sizes and byte order modes. 31/// Each object can have a unique position in the shared data and extract 32/// data from different offsets. 33/// 34/// @see DataBuffer 35//---------------------------------------------------------------------- 36class DataExtractor 37{ 38public: 39 //------------------------------------------------------------------ 40 /// @typedef DataExtractor::Type 41 /// @brief Type enumerations used in the dump routines. 42 /// @see DataExtractor::Dump() 43 /// @see DataExtractor::DumpRawHexBytes() 44 //------------------------------------------------------------------ 45 typedef enum 46 { 47 TypeUInt8, ///< Format output as unsigned 8 bit integers 48 TypeChar, ///< Format output as characters 49 TypeUInt16, ///< Format output as unsigned 16 bit integers 50 TypeUInt32, ///< Format output as unsigned 32 bit integers 51 TypeUInt64, ///< Format output as unsigned 64 bit integers 52 TypePointer, ///< Format output as pointers 53 TypeULEB128, ///< Format output as ULEB128 numbers 54 TypeSLEB128 ///< Format output as SLEB128 numbers 55 } Type; 56 57 static void 58 DumpHexBytes (Stream *s, 59 const void *src, 60 size_t src_len, 61 uint32_t bytes_per_line, 62 lldb::addr_t base_addr); // Pass LLDB_INVALID_ADDRESS to not show address at start of line 63 //------------------------------------------------------------------ 64 /// Default constructor. 65 /// 66 /// Initialize all members to a default empty state. 67 //------------------------------------------------------------------ 68 DataExtractor (); 69 70 //------------------------------------------------------------------ 71 /// Construct with a buffer that is owned by the caller. 72 /// 73 /// This constructor allows us to use data that is owned by the 74 /// caller. The data must stay around as long as this object is 75 /// valid. 76 /// 77 /// @param[in] data 78 /// A pointer to caller owned data. 79 /// 80 /// @param[in] data_length 81 /// The length in bytes of \a data. 82 /// 83 /// @param[in] byte_order 84 /// A byte order of the data that we are extracting from. 85 /// 86 /// @param[in] addr_size 87 /// A new address byte size value. 88 //------------------------------------------------------------------ 89 DataExtractor (const void* data, lldb::offset_t data_length, lldb::ByteOrder byte_order, uint32_t addr_size); 90 91 //------------------------------------------------------------------ 92 /// Construct with shared data. 93 /// 94 /// Copies the data shared pointer which adds a reference to the 95 /// contained in \a data_sp. The shared data reference is reference 96 /// counted to ensure the data lives as long as anyone still has a 97 /// valid shared pointer to the data in \a data_sp. 98 /// 99 /// @param[in] data_sp 100 /// A shared pointer to data. 101 /// 102 /// @param[in] byte_order 103 /// A byte order of the data that we are extracting from. 104 /// 105 /// @param[in] addr_size 106 /// A new address byte size value. 107 //------------------------------------------------------------------ 108 DataExtractor (const lldb::DataBufferSP& data_sp, lldb::ByteOrder byte_order, uint32_t addr_size); 109 110 //------------------------------------------------------------------ 111 /// Construct with a subset of \a data. 112 /// 113 /// Initialize this object with a subset of the data bytes in \a 114 /// data. If \a data contains shared data, then a reference to the 115 /// shared data will be added to ensure the shared data stays around 116 /// as long as any objects have references to the shared data. The 117 /// byte order value and the address size settings are copied from \a 118 /// data. If \a offset is not a valid offset in \a data, then no 119 /// reference to the shared data will be added. If there are not 120 /// \a length bytes available in \a data starting at \a offset, 121 /// the length will be truncated to contain as many bytes as 122 /// possible. 123 /// 124 /// @param[in] data 125 /// Another DataExtractor object that contains data. 126 /// 127 /// @param[in] offset 128 /// The offset into \a data at which the subset starts. 129 /// 130 /// @param[in] length 131 /// The length in bytes of the subset of data. 132 //------------------------------------------------------------------ 133 DataExtractor (const DataExtractor& data, lldb::offset_t offset, lldb::offset_t length); 134 135 DataExtractor (const DataExtractor& rhs); 136 //------------------------------------------------------------------ 137 /// Assignment operator. 138 /// 139 /// Copies all data, byte order and address size settings from \a rhs into 140 /// this object. If \a rhs contains shared data, a reference to that 141 /// shared data will be added. 142 /// 143 /// @param[in] rhs 144 /// Another DataExtractor object to copy. 145 /// 146 /// @return 147 /// A const reference to this object. 148 //------------------------------------------------------------------ 149 const DataExtractor& 150 operator= (const DataExtractor& rhs); 151 152 //------------------------------------------------------------------ 153 /// Destructor 154 /// 155 /// If this object contains a valid shared data reference, the 156 /// reference count on the data will be decremented, and if zero, 157 /// the data will be freed. 158 //------------------------------------------------------------------ 159 ~DataExtractor (); 160 161 //------------------------------------------------------------------ 162 /// Clears the object state. 163 /// 164 /// Clears the object contents back to a default invalid state, and 165 /// release any references to shared data that this object may 166 /// contain. 167 //------------------------------------------------------------------ 168 void 169 Clear (); 170 171 //------------------------------------------------------------------ 172 /// Dumps the binary data as \a type objects to stream \a s (or to 173 /// Log() if \a s is NULL) starting \a offset bytes into the data 174 /// and stopping after dumping \a length bytes. The offset into the 175 /// data is displayed at the beginning of each line and can be 176 /// offset by base address \a base_addr. \a num_per_line objects 177 /// will be displayed on each line. 178 /// 179 /// @param[in] s 180 /// The stream to dump the output to. If NULL the output will 181 /// be dumped to Log(). 182 /// 183 /// @param[in] offset 184 /// The offset into the data at which to start dumping. 185 /// 186 /// @param[in] length 187 /// The number of bytes to dump. 188 /// 189 /// @param[in] base_addr 190 /// The base address that gets added to the offset displayed on 191 /// each line. 192 /// 193 /// @param[in] num_per_line 194 /// The number of \a type objects to display on each line. 195 /// 196 /// @param[in] type 197 /// The type of objects to use when dumping data from this 198 /// object. See DataExtractor::Type. 199 /// 200 /// @param[in] type_format 201 /// The optional format to use for the \a type objects. If this 202 /// is NULL, the default format for the \a type will be used. 203 /// 204 /// @return 205 /// The offset at which dumping ended. 206 //------------------------------------------------------------------ 207 lldb::offset_t 208 PutToLog (Log *log, 209 lldb::offset_t offset, 210 lldb::offset_t length, 211 uint64_t base_addr, 212 uint32_t num_per_line, 213 Type type, 214 const char *type_format = NULL) const; 215 216 //------------------------------------------------------------------ 217 /// Dumps \a item_count objects into the stream \a s. 218 /// 219 /// Dumps \a item_count objects using \a item_format, each of which 220 /// are \a item_byte_size bytes long starting at offset \a offset 221 /// bytes into the contained data, into the stream \a s. \a 222 /// num_per_line objects will be dumped on each line before a new 223 /// line will be output. If \a base_addr is a valid address, then 224 /// each new line of output will be prededed by the address value 225 /// plus appropriate offset, and a colon and space. Bitfield values 226 /// can be dumped by calling this function multiple times with the 227 /// same start offset, format and size, yet differing \a 228 /// item_bit_size and \a item_bit_offset values. 229 /// 230 /// @param[in] s 231 /// The stream to dump the output to. This value can not be NULL. 232 /// 233 /// @param[in] offset 234 /// The offset into the data at which to start dumping. 235 /// 236 /// @param[in] item_format 237 /// The format to use when dumping each item. 238 /// 239 /// @param[in] item_byte_size 240 /// The byte size of each item. 241 /// 242 /// @param[in] item_count 243 /// The number of items to dump. 244 /// 245 /// @param[in] num_per_line 246 /// The number of items to display on each line. 247 /// 248 /// @param[in] base_addr 249 /// The base address that gets added to the offset displayed on 250 /// each line if the value is valid. Is \a base_addr is 251 /// LLDB_INVALID_ADDRESS then no address values will be prepended 252 /// to any lines. 253 /// 254 /// @param[in] item_bit_size 255 /// If the value to display is a bitfield, this value should 256 /// be the number of bits that the bitfield item has within the 257 /// item's byte size value. This function will need to be called 258 /// multiple times with identical \a offset and \a item_byte_size 259 /// values in order to display multiple bitfield values that 260 /// exist within the same integer value. If the items being 261 /// displayed are not bitfields, this value should be zero. 262 /// 263 /// @param[in] item_bit_offset 264 /// If the value to display is a bitfield, this value should 265 /// be the offset in bits, or shift right amount, that the 266 /// bitfield item occupies within the item's byte size value. 267 /// This function will need to be called multiple times with 268 /// identical \a offset and \a item_byte_size values in order 269 /// to display multiple bitfield values that exist within the 270 /// same integer value. If the items being displayed are not 271 /// bitfields, this value should be zero. 272 /// 273 /// @return 274 /// The offset at which dumping ended. 275 //------------------------------------------------------------------ 276 lldb::offset_t 277 Dump (Stream *s, 278 lldb::offset_t offset, 279 lldb::Format item_format, 280 size_t item_byte_size, 281 size_t item_count, 282 size_t num_per_line, 283 uint64_t base_addr, 284 uint32_t item_bit_size, 285 uint32_t item_bit_offset, 286 ExecutionContextScope *exe_scope = NULL) const; 287 288 //------------------------------------------------------------------ 289 /// Dump a UUID value at \a offset. 290 /// 291 /// Dump a UUID starting at \a offset bytes into this object's data. 292 /// If the stream \a s is NULL, the output will be sent to Log(). 293 /// 294 /// @param[in] s 295 /// The stream to dump the output to. If NULL the output will 296 /// be dumped to Log(). 297 /// 298 /// @param[in] offset 299 /// The offset into the data at which to extract and dump a 300 /// UUID value. 301 //------------------------------------------------------------------ 302 void 303 DumpUUID (Stream *s, lldb::offset_t offset) const; 304 305 //------------------------------------------------------------------ 306 /// Extract an arbitrary number of bytes in the specified byte 307 /// order. 308 /// 309 /// Attemps to extract \a length bytes starting at \a offset bytes 310 /// into this data in the requested byte order (\a dst_byte_order) 311 /// and place the results in \a dst. \a dst must be at least \a 312 /// length bytes long. 313 /// 314 /// @param[in] offset 315 /// The offset in bytes into the contained data at which to 316 /// start extracting. 317 /// 318 /// @param[in] length 319 /// The number of bytes to extract. 320 /// 321 /// @param[in] dst_byte_order 322 /// A byte order of the data that we want when the value in 323 /// copied to \a dst. 324 /// 325 /// @param[out] dst 326 /// The buffer that will receive the extracted value if there 327 /// are enough bytes available in the current data. 328 /// 329 /// @return 330 /// The number of bytes that were extracted which will be \a 331 /// length when the value is successfully extracted, or zero 332 /// if there aren't enough bytes at the specified offset. 333 //------------------------------------------------------------------ 334 size_t 335 ExtractBytes (lldb::offset_t offset, lldb::offset_t length, lldb::ByteOrder dst_byte_order, void *dst) const; 336 337 //------------------------------------------------------------------ 338 /// Extract an address from \a *offset_ptr. 339 /// 340 /// Extract a single address from the data and update the offset 341 /// pointed to by \a offset_ptr. The size of the extracted address 342 /// comes from the \a m_addr_size member variable and should be 343 /// set correctly prior to extracting any address values. 344 /// 345 /// @param[in,out] offset_ptr 346 /// A pointer to an offset within the data that will be advanced 347 /// by the appropriate number of bytes if the value is extracted 348 /// correctly. If the offset is out of bounds or there are not 349 /// enough bytes to extract this value, the offset will be left 350 /// unmodified. 351 /// 352 /// @return 353 /// The extracted address value. 354 //------------------------------------------------------------------ 355 uint64_t 356 GetAddress (lldb::offset_t *offset_ptr) const; 357 358 uint64_t 359 GetAddress_unchecked (lldb::offset_t *offset_ptr) const; 360 361 //------------------------------------------------------------------ 362 /// Get the current address size. 363 /// 364 /// Return the size in bytes of any address values this object will 365 /// extract. 366 /// 367 /// @return 368 /// The size in bytes of address values that will be extracted. 369 //------------------------------------------------------------------ 370 uint32_t 371 GetAddressByteSize () const 372 { 373 return m_addr_size; 374 } 375 376 //------------------------------------------------------------------ 377 /// Get the number of bytes contained in this object. 378 /// 379 /// @return 380 /// The total number of bytes of data this object refers to. 381 //------------------------------------------------------------------ 382 uint64_t 383 GetByteSize () const 384 { 385 return m_end - m_start; 386 } 387 388 //------------------------------------------------------------------ 389 /// Extract a C string from \a *offset_ptr. 390 /// 391 /// Returns a pointer to a C String from the data at the offset 392 /// pointed to by \a offset_ptr. A variable length NULL terminated C 393 /// string will be extracted and the \a offset_ptr will be 394 /// updated with the offset of the byte that follows the NULL 395 /// terminator byte. 396 /// 397 /// @param[in,out] offset_ptr 398 /// A pointer to an offset within the data that will be advanced 399 /// by the appropriate number of bytes if the value is extracted 400 /// correctly. If the offset is out of bounds or there are not 401 /// enough bytes to extract this value, the offset will be left 402 /// unmodified. 403 /// 404 /// @return 405 /// A pointer to the C string value in the data. If the offset 406 /// pointed to by \a offset_ptr is out of bounds, or if the 407 /// offset plus the length of the C string is out of bounds, 408 /// NULL will be returned. 409 //------------------------------------------------------------------ 410 const char * 411 GetCStr (lldb::offset_t *offset_ptr) const; 412 413 //------------------------------------------------------------------ 414 /// Extract \a length bytes from \a *offset_ptr. 415 /// 416 /// Returns a pointer to a bytes in this object's data at the offset 417 /// pointed to by \a offset_ptr. If \a length is zero or too large, 418 /// then the offset pointed to by \a offset_ptr will not be updated 419 /// and NULL will be returned. 420 /// 421 /// @param[in,out] offset_ptr 422 /// A pointer to an offset within the data that will be advanced 423 /// by the appropriate number of bytes if the value is extracted 424 /// correctly. If the offset is out of bounds or there are not 425 /// enough bytes to extract this value, the offset will be left 426 /// unmodified. 427 /// 428 /// @param[in] length 429 /// The optional length of a string to extract. If the value is 430 /// zero, a NULL terminated C string will be extracted. 431 /// 432 /// @return 433 /// A pointer to the bytes in this object's data if the offset 434 /// and length are valid, or NULL otherwise. 435 //------------------------------------------------------------------ 436 const void* 437 GetData (lldb::offset_t *offset_ptr, lldb::offset_t length) const; 438 439 //------------------------------------------------------------------ 440 /// Copy \a dst_len bytes from \a *offset_ptr and ensure the copied 441 /// data is treated as a value that can be swapped to match the 442 /// specified byte order. 443 /// 444 /// For values that are larger than the supported integer sizes, 445 /// this function can be used to extract data in a specified byte 446 /// order. It can also be used to copy a smaller integer value from 447 /// to a larger value. The extra bytes left over will be padded 448 /// correctly according to the byte order of this object and the 449 /// \a dst_byte_order. This can be very handy when say copying a 450 /// partial data value into a register. 451 /// 452 /// @param[in] src_offset 453 /// The offset into this data from which to start copying an 454 /// endian entity 455 /// 456 /// @param[in] src_len 457 /// The length of the endian data to copy from this object 458 /// into the \a dst object 459 /// 460 /// @param[out] dst 461 /// The buffer where to place the endian data. The data might 462 /// need to be byte swapped (and appropriately padded with 463 /// zeroes if \a src_len != \a dst_len) if \a dst_byte_order 464 /// does not match the byte order in this object. 465 /// 466 /// @param[in] dst_len 467 /// The length number of bytes that the endian value will 468 /// occupy is \a dst. 469 /// 470 /// @param[in] byte_order 471 /// The byte order that the endian value should be in the \a dst 472 /// buffer. 473 /// 474 /// @return 475 /// Returns the number of bytes that were copied, or zero if 476 /// anything goes wrong. 477 //------------------------------------------------------------------ 478 lldb::offset_t 479 CopyByteOrderedData (lldb::offset_t src_offset, 480 lldb::offset_t src_len, 481 void *dst, 482 lldb::offset_t dst_len, 483 lldb::ByteOrder dst_byte_order) const; 484 485 //------------------------------------------------------------------ 486 /// Get the data end pointer. 487 /// 488 /// @return 489 /// Returns a pointer to the next byte contained in this 490 /// object's data, or NULL of there is no data in this object. 491 //------------------------------------------------------------------ 492 const uint8_t * 493 GetDataEnd () const 494 { 495 return m_end; 496 } 497 498 //------------------------------------------------------------------ 499 /// Get the shared data offset. 500 /// 501 /// Get the offset of the first byte of data in the shared data (if 502 /// any). 503 /// 504 /// @return 505 /// If this object contains shared data, this function returns 506 /// the offset in bytes into that shared data, zero otherwise. 507 //------------------------------------------------------------------ 508 size_t 509 GetSharedDataOffset () const; 510 511 //------------------------------------------------------------------ 512 /// Get a the data start pointer. 513 /// 514 /// @return 515 /// Returns a pointer to the first byte contained in this 516 /// object's data, or NULL of there is no data in this object. 517 //------------------------------------------------------------------ 518 const uint8_t * 519 GetDataStart () const 520 { 521 return m_start; 522 } 523 524 525 //------------------------------------------------------------------ 526 /// Extract a float from \a *offset_ptr. 527 /// 528 /// Extract a single float value. 529 /// 530 /// @param[in,out] offset_ptr 531 /// A pointer to an offset within the data that will be advanced 532 /// by the appropriate number of bytes if the value is extracted 533 /// correctly. If the offset is out of bounds or there are not 534 /// enough bytes to extract this value, the offset will be left 535 /// unmodified. 536 /// 537 /// @return 538 /// The floating value that was extracted, or zero on failure. 539 //------------------------------------------------------------------ 540 float 541 GetFloat (lldb::offset_t *offset_ptr) const; 542 543 double 544 GetDouble (lldb::offset_t *offset_ptr) const; 545 546 long double 547 GetLongDouble (lldb::offset_t *offset_ptr) const; 548 549 //------------------------------------------------------------------ 550 /// Extract a GNU encoded pointer value from \a *offset_ptr. 551 /// 552 /// @param[in,out] offset_ptr 553 /// A pointer to an offset within the data that will be advanced 554 /// by the appropriate number of bytes if the value is extracted 555 /// correctly. If the offset is out of bounds or there are not 556 /// enough bytes to extract this value, the offset will be left 557 /// unmodified. 558 /// 559 /// @param[in] eh_ptr_enc 560 /// The GNU pointer encoding type. 561 /// 562 /// @param[in] pc_rel_addr 563 /// The PC relative address to use when the encoding is 564 /// \c DW_GNU_EH_PE_pcrel. 565 /// 566 /// @param[in] text_addr 567 /// The text (code) relative address to use when the encoding is 568 /// \c DW_GNU_EH_PE_textrel. 569 /// 570 /// @param[in] data_addr 571 /// The data relative address to use when the encoding is 572 /// \c DW_GNU_EH_PE_datarel. 573 /// 574 /// @return 575 /// The extracted GNU encoded pointer value. 576 //------------------------------------------------------------------ 577 uint64_t 578 GetGNUEHPointer (lldb::offset_t *offset_ptr, 579 uint32_t eh_ptr_enc, 580 lldb::addr_t pc_rel_addr, 581 lldb::addr_t text_addr, 582 lldb::addr_t data_addr); 583 584 //------------------------------------------------------------------ 585 /// Extract an integer of size \a byte_size from \a *offset_ptr. 586 /// 587 /// Extract a single integer value and update the offset pointed to 588 /// by \a offset_ptr. The size of the extracted integer is specified 589 /// by the \a byte_size argument. \a byte_size should have a value 590 /// >= 1 and <= 4 since the return value is only 32 bits wide. Any 591 /// \a byte_size values less than 1 or greater than 4 will result in 592 /// nothing being extracted, and zero being returned. 593 /// 594 /// @param[in,out] offset_ptr 595 /// A pointer to an offset within the data that will be advanced 596 /// by the appropriate number of bytes if the value is extracted 597 /// correctly. If the offset is out of bounds or there are not 598 /// enough bytes to extract this value, the offset will be left 599 /// unmodified. 600 /// 601 /// @param[in] byte_size 602 /// The size in byte of the integer to extract. 603 /// 604 /// @return 605 /// The integer value that was extracted, or zero on failure. 606 //------------------------------------------------------------------ 607 uint32_t 608 GetMaxU32 (lldb::offset_t *offset_ptr, size_t byte_size) const; 609 610 //------------------------------------------------------------------ 611 /// Extract an unsigned integer of size \a byte_size from \a 612 /// *offset_ptr. 613 /// 614 /// Extract a single unsigned integer value and update the offset 615 /// pointed to by \a offset_ptr. The size of the extracted integer 616 /// is specified by the \a byte_size argument. \a byte_size should 617 /// have a value greater than or equal to one and less than or equal 618 /// to eight since the return value is 64 bits wide. Any 619 /// \a byte_size values less than 1 or greater than 8 will result in 620 /// nothing being extracted, and zero being returned. 621 /// 622 /// @param[in,out] offset_ptr 623 /// A pointer to an offset within the data that will be advanced 624 /// by the appropriate number of bytes if the value is extracted 625 /// correctly. If the offset is out of bounds or there are not 626 /// enough bytes to extract this value, the offset will be left 627 /// unmodified. 628 /// 629 /// @param[in] byte_size 630 /// The size in byte of the integer to extract. 631 /// 632 /// @return 633 /// The unsigned integer value that was extracted, or zero on 634 /// failure. 635 //------------------------------------------------------------------ 636 uint64_t 637 GetMaxU64 (lldb::offset_t *offset_ptr, size_t byte_size) const; 638 639 uint64_t 640 GetMaxU64_unchecked (lldb::offset_t *offset_ptr, size_t byte_size) const; 641 642 //------------------------------------------------------------------ 643 /// Extract an signed integer of size \a byte_size from \a *offset_ptr. 644 /// 645 /// Extract a single signed integer value (sign extending if required) 646 /// and update the offset pointed to by \a offset_ptr. The size of 647 /// the extracted integer is specified by the \a byte_size argument. 648 /// \a byte_size should have a value greater than or equal to one 649 /// and less than or equal to eight since the return value is 64 650 /// bits wide. Any \a byte_size values less than 1 or greater than 651 /// 8 will result in nothing being extracted, and zero being returned. 652 /// 653 /// @param[in,out] offset_ptr 654 /// A pointer to an offset within the data that will be advanced 655 /// by the appropriate number of bytes if the value is extracted 656 /// correctly. If the offset is out of bounds or there are not 657 /// enough bytes to extract this value, the offset will be left 658 /// unmodified. 659 /// 660 /// @param[in] byte_size 661 /// The size in byte of the integer to extract. 662 /// 663 /// @return 664 /// The sign extended signed integer value that was extracted, 665 /// or zero on failure. 666 //------------------------------------------------------------------ 667 int64_t 668 GetMaxS64 (lldb::offset_t *offset_ptr, size_t size) const; 669 670 //------------------------------------------------------------------ 671 /// Extract an unsigned integer of size \a byte_size from \a 672 /// *offset_ptr, then extract the bitfield from this value if 673 /// \a bitfield_bit_size is non-zero. 674 /// 675 /// Extract a single unsigned integer value and update the offset 676 /// pointed to by \a offset_ptr. The size of the extracted integer 677 /// is specified by the \a byte_size argument. \a byte_size should 678 /// have a value greater than or equal to one and less than or equal 679 /// to 8 since the return value is 64 bits wide. Any 680 /// \a byte_size values less than 1 or greater than 8 will result in 681 /// nothing being extracted, and zero being returned. 682 /// 683 /// @param[in,out] offset_ptr 684 /// A pointer to an offset within the data that will be advanced 685 /// by the appropriate number of bytes if the value is extracted 686 /// correctly. If the offset is out of bounds or there are not 687 /// enough bytes to extract this value, the offset will be left 688 /// unmodified. 689 /// 690 /// @param[in] byte_size 691 /// The size in byte of the integer to extract. 692 /// 693 /// @param[in] bitfield_bit_size 694 /// The size in bits of the bitfield value to extract, or zero 695 /// to just extract the entire integer value. 696 /// 697 /// @param[in] bitfield_bit_offset 698 /// The bit offset of the bitfield value in the extracted 699 /// integer (the number of bits to shift the integer to the 700 /// right). 701 /// 702 /// @return 703 /// The unsigned bitfield integer value that was extracted, or 704 /// zero on failure. 705 //------------------------------------------------------------------ 706 uint64_t 707 GetMaxU64Bitfield (lldb::offset_t *offset_ptr, 708 size_t size, 709 uint32_t bitfield_bit_size, 710 uint32_t bitfield_bit_offset) const; 711 712 //------------------------------------------------------------------ 713 /// Extract an signed integer of size \a byte_size from \a 714 /// *offset_ptr, then extract and signe extend the bitfield from 715 /// this value if \a bitfield_bit_size is non-zero. 716 /// 717 /// Extract a single signed integer value (sign extending if required) 718 /// and update the offset pointed to by \a offset_ptr. The size of 719 /// the extracted integer is specified by the \a byte_size argument. 720 /// \a byte_size should have a value greater than or equal to one 721 /// and less than or equal to eight since the return value is 64 722 /// bits wide. Any \a byte_size values less than 1 or greater than 723 /// 8 will result in nothing being extracted, and zero being returned. 724 /// 725 /// @param[in,out] offset_ptr 726 /// A pointer to an offset within the data that will be advanced 727 /// by the appropriate number of bytes if the value is extracted 728 /// correctly. If the offset is out of bounds or there are not 729 /// enough bytes to extract this value, the offset will be left 730 /// unmodified. 731 /// 732 /// @param[in] byte_size 733 /// The size in bytes of the integer to extract. 734 /// 735 /// @param[in] bitfield_bit_size 736 /// The size in bits of the bitfield value to extract, or zero 737 /// to just extract the entire integer value. 738 /// 739 /// @param[in] bitfield_bit_offset 740 /// The bit offset of the bitfield value in the extracted 741 /// integer (the number of bits to shift the integer to the 742 /// right). 743 /// 744 /// @return 745 /// The signed bitfield integer value that was extracted, or 746 /// zero on failure. 747 //------------------------------------------------------------------ 748 int64_t 749 GetMaxS64Bitfield (lldb::offset_t *offset_ptr, 750 size_t size, 751 uint32_t bitfield_bit_size, 752 uint32_t bitfield_bit_offset) const; 753 754 //------------------------------------------------------------------ 755 /// Extract an pointer from \a *offset_ptr. 756 /// 757 /// Extract a single pointer from the data and update the offset 758 /// pointed to by \a offset_ptr. The size of the extracted pointer 759 /// comes from the \a m_addr_size member variable and should be 760 /// set correctly prior to extracting any pointer values. 761 /// 762 /// @param[in,out] offset_ptr 763 /// A pointer to an offset within the data that will be advanced 764 /// by the appropriate number of bytes if the value is extracted 765 /// correctly. If the offset is out of bounds or there are not 766 /// enough bytes to extract this value, the offset will be left 767 /// unmodified. 768 /// 769 /// @return 770 /// The extracted pointer value as a 64 integer. 771 //------------------------------------------------------------------ 772 uint64_t 773 GetPointer (lldb::offset_t *offset_ptr) const; 774 775 //------------------------------------------------------------------ 776 /// Get the current byte order value. 777 /// 778 /// @return 779 /// The current byte order value from this object's internal 780 /// state. 781 //------------------------------------------------------------------ 782 lldb::ByteOrder 783 GetByteOrder() const 784 { 785 return m_byte_order; 786 } 787 788 //------------------------------------------------------------------ 789 /// Extract a uint8_t value from \a *offset_ptr. 790 /// 791 /// Extract a single uint8_t from the binary data at the offset 792 /// pointed to by \a offset_ptr, and advance the offset on success. 793 /// 794 /// @param[in,out] offset_ptr 795 /// A pointer to an offset within the data that will be advanced 796 /// by the appropriate number of bytes if the value is extracted 797 /// correctly. If the offset is out of bounds or there are not 798 /// enough bytes to extract this value, the offset will be left 799 /// unmodified. 800 /// 801 /// @return 802 /// The extracted uint8_t value. 803 //------------------------------------------------------------------ 804 uint8_t 805 GetU8 ( lldb::offset_t *offset_ptr) const; 806 807 uint8_t 808 GetU8_unchecked (lldb::offset_t *offset_ptr) const 809 { 810 uint8_t val = m_start[*offset_ptr]; 811 *offset_ptr += 1; 812 return val; 813 } 814 815 uint16_t 816 GetU16_unchecked (lldb::offset_t *offset_ptr) const; 817 818 uint32_t 819 GetU32_unchecked (lldb::offset_t *offset_ptr) const; 820 821 uint64_t 822 GetU64_unchecked (lldb::offset_t *offset_ptr) const; 823 //------------------------------------------------------------------ 824 /// Extract \a count uint8_t values from \a *offset_ptr. 825 /// 826 /// Extract \a count uint8_t values from the binary data at the 827 /// offset pointed to by \a offset_ptr, and advance the offset on 828 /// success. The extracted values are copied into \a dst. 829 /// 830 /// @param[in,out] offset_ptr 831 /// A pointer to an offset within the data that will be advanced 832 /// by the appropriate number of bytes if the value is extracted 833 /// correctly. If the offset is out of bounds or there are not 834 /// enough bytes to extract this value, the offset will be left 835 /// unmodified. 836 /// 837 /// @param[out] dst 838 /// A buffer to copy \a count uint8_t values into. \a dst must 839 /// be large enough to hold all requested data. 840 /// 841 /// @param[in] count 842 /// The number of uint8_t values to extract. 843 /// 844 /// @return 845 /// \a dst if all values were properly extracted and copied, 846 /// NULL otherise. 847 //------------------------------------------------------------------ 848 void * 849 GetU8 (lldb::offset_t *offset_ptr, void *dst, uint32_t count) const; 850 851 //------------------------------------------------------------------ 852 /// Extract a uint16_t value from \a *offset_ptr. 853 /// 854 /// Extract a single uint16_t from the binary data at the offset 855 /// pointed to by \a offset_ptr, and update the offset on success. 856 /// 857 /// @param[in,out] offset_ptr 858 /// A pointer to an offset within the data that will be advanced 859 /// by the appropriate number of bytes if the value is extracted 860 /// correctly. If the offset is out of bounds or there are not 861 /// enough bytes to extract this value, the offset will be left 862 /// unmodified. 863 /// 864 /// @return 865 /// The extracted uint16_t value. 866 //------------------------------------------------------------------ 867 uint16_t 868 GetU16 (lldb::offset_t *offset_ptr) const; 869 870 //------------------------------------------------------------------ 871 /// Extract \a count uint16_t values from \a *offset_ptr. 872 /// 873 /// Extract \a count uint16_t values from the binary data at the 874 /// offset pointed to by \a offset_ptr, and advance the offset on 875 /// success. The extracted values are copied into \a dst. 876 /// 877 /// @param[in,out] offset_ptr 878 /// A pointer to an offset within the data that will be advanced 879 /// by the appropriate number of bytes if the value is extracted 880 /// correctly. If the offset is out of bounds or there are not 881 /// enough bytes to extract this value, the offset will be left 882 /// unmodified. 883 /// 884 /// @param[out] dst 885 /// A buffer to copy \a count uint16_t values into. \a dst must 886 /// be large enough to hold all requested data. 887 /// 888 /// @param[in] count 889 /// The number of uint16_t values to extract. 890 /// 891 /// @return 892 /// \a dst if all values were properly extracted and copied, 893 /// NULL otherise. 894 //------------------------------------------------------------------ 895 void * 896 GetU16 (lldb::offset_t *offset_ptr, void *dst, uint32_t count) const; 897 898 //------------------------------------------------------------------ 899 /// Extract a uint32_t value from \a *offset_ptr. 900 /// 901 /// Extract a single uint32_t from the binary data at the offset 902 /// pointed to by \a offset_ptr, and update the offset on success. 903 /// 904 /// @param[in,out] offset_ptr 905 /// A pointer to an offset within the data that will be advanced 906 /// by the appropriate number of bytes if the value is extracted 907 /// correctly. If the offset is out of bounds or there are not 908 /// enough bytes to extract this value, the offset will be left 909 /// unmodified. 910 /// 911 /// @return 912 /// The extracted uint32_t value. 913 //------------------------------------------------------------------ 914 uint32_t 915 GetU32 (lldb::offset_t *offset_ptr) const; 916 917 //------------------------------------------------------------------ 918 /// Extract \a count uint32_t values from \a *offset_ptr. 919 /// 920 /// Extract \a count uint32_t values from the binary data at the 921 /// offset pointed to by \a offset_ptr, and advance the offset on 922 /// success. The extracted values are copied into \a dst. 923 /// 924 /// @param[in,out] offset_ptr 925 /// A pointer to an offset within the data that will be advanced 926 /// by the appropriate number of bytes if the value is extracted 927 /// correctly. If the offset is out of bounds or there are not 928 /// enough bytes to extract this value, the offset will be left 929 /// unmodified. 930 /// 931 /// @param[out] dst 932 /// A buffer to copy \a count uint32_t values into. \a dst must 933 /// be large enough to hold all requested data. 934 /// 935 /// @param[in] count 936 /// The number of uint32_t values to extract. 937 /// 938 /// @return 939 /// \a dst if all values were properly extracted and copied, 940 /// NULL otherise. 941 //------------------------------------------------------------------ 942 void * 943 GetU32 (lldb::offset_t *offset_ptr, void *dst, uint32_t count) const; 944 945 //------------------------------------------------------------------ 946 /// Extract a uint64_t value from \a *offset_ptr. 947 /// 948 /// Extract a single uint64_t from the binary data at the offset 949 /// pointed to by \a offset_ptr, and update the offset on success. 950 /// 951 /// @param[in,out] offset_ptr 952 /// A pointer to an offset within the data that will be advanced 953 /// by the appropriate number of bytes if the value is extracted 954 /// correctly. If the offset is out of bounds or there are not 955 /// enough bytes to extract this value, the offset will be left 956 /// unmodified. 957 /// 958 /// @return 959 /// The extracted uint64_t value. 960 //------------------------------------------------------------------ 961 uint64_t 962 GetU64 (lldb::offset_t *offset_ptr) const; 963 964 //------------------------------------------------------------------ 965 /// Extract \a count uint64_t values from \a *offset_ptr. 966 /// 967 /// Extract \a count uint64_t values from the binary data at the 968 /// offset pointed to by \a offset_ptr, and advance the offset on 969 /// success. The extracted values are copied into \a dst. 970 /// 971 /// @param[in,out] offset_ptr 972 /// A pointer to an offset within the data that will be advanced 973 /// by the appropriate number of bytes if the value is extracted 974 /// correctly. If the offset is out of bounds or there are not 975 /// enough bytes to extract this value, the offset will be left 976 /// unmodified. 977 /// 978 /// @param[out] dst 979 /// A buffer to copy \a count uint64_t values into. \a dst must 980 /// be large enough to hold all requested data. 981 /// 982 /// @param[in] count 983 /// The number of uint64_t values to extract. 984 /// 985 /// @return 986 /// \a dst if all values were properly extracted and copied, 987 /// NULL otherise. 988 //------------------------------------------------------------------ 989 void * 990 GetU64 ( lldb::offset_t *offset_ptr, void *dst, uint32_t count) const; 991 992 //------------------------------------------------------------------ 993 /// Extract a signed LEB128 value from \a *offset_ptr. 994 /// 995 /// Extracts an signed LEB128 number from this object's data 996 /// starting at the offset pointed to by \a offset_ptr. The offset 997 /// pointed to by \a offset_ptr will be updated with the offset of 998 /// the byte following the last extracted byte. 999 /// 1000 /// @param[in,out] offset_ptr 1001 /// A pointer to an offset within the data that will be advanced 1002 /// by the appropriate number of bytes if the value is extracted 1003 /// correctly. If the offset is out of bounds or there are not 1004 /// enough bytes to extract this value, the offset will be left 1005 /// unmodified. 1006 /// 1007 /// @return 1008 /// The extracted signed integer value. 1009 //------------------------------------------------------------------ 1010 int64_t 1011 GetSLEB128 (lldb::offset_t *offset_ptr) const; 1012 1013 //------------------------------------------------------------------ 1014 /// Extract a unsigned LEB128 value from \a *offset_ptr. 1015 /// 1016 /// Extracts an unsigned LEB128 number from this object's data 1017 /// starting at the offset pointed to by \a offset_ptr. The offset 1018 /// pointed to by \a offset_ptr will be updated with the offset of 1019 /// the byte following the last extracted byte. 1020 /// 1021 /// @param[in,out] offset_ptr 1022 /// A pointer to an offset within the data that will be advanced 1023 /// by the appropriate number of bytes if the value is extracted 1024 /// correctly. If the offset is out of bounds or there are not 1025 /// enough bytes to extract this value, the offset will be left 1026 /// unmodified. 1027 /// 1028 /// @return 1029 /// The extracted unsigned integer value. 1030 //------------------------------------------------------------------ 1031 uint64_t 1032 GetULEB128 (lldb::offset_t *offset_ptr) const; 1033 1034 lldb::DataBufferSP & 1035 GetSharedDataBuffer () 1036 { 1037 return m_data_sp; 1038 } 1039 1040 //------------------------------------------------------------------ 1041 /// Peek at a C string at \a offset. 1042 /// 1043 /// Peeks at a string in the contained data. No verification is done 1044 /// to make sure the entire string lies within the bounds of this 1045 /// object's data, only \a offset is verified to be a valid offset. 1046 /// 1047 /// @param[in] offset 1048 /// An offset into the data. 1049 /// 1050 /// @return 1051 /// A non-NULL C string pointer if \a offset is a valid offset, 1052 /// NULL otherwise. 1053 //------------------------------------------------------------------ 1054 const char * 1055 PeekCStr (lldb::offset_t offset) const; 1056 1057 //------------------------------------------------------------------ 1058 /// Peek at a bytes at \a offset. 1059 /// 1060 /// Returns a pointer to \a length bytes at \a offset as long as 1061 /// there are \a length bytes available starting at \a offset. 1062 /// 1063 /// @return 1064 /// A non-NULL data pointer if \a offset is a valid offset and 1065 /// there are \a length bytes available at that offset, NULL 1066 /// otherwise. 1067 //------------------------------------------------------------------ 1068 const uint8_t* 1069 PeekData (lldb::offset_t offset, lldb::offset_t length) const; 1070 1071 //------------------------------------------------------------------ 1072 /// Set the address byte size. 1073 /// 1074 /// Set the size in bytes that will be used when extracting any 1075 /// address and pointer values from data contained in this object. 1076 /// 1077 /// @param[in] addr_size 1078 /// The size in bytes to use when extracting addresses. 1079 //------------------------------------------------------------------ 1080 void 1081 SetAddressByteSize (uint32_t addr_size) 1082 { 1083 m_addr_size = addr_size; 1084 } 1085 1086 //------------------------------------------------------------------ 1087 /// Set data with a buffer that is caller owned. 1088 /// 1089 /// Use data that is owned by the caller when extracting values. 1090 /// The data must stay around as long as this object, or any object 1091 /// that copies a subset of this object's data, is valid. If \a 1092 /// bytes is NULL, or \a length is zero, this object will contain 1093 /// no data. 1094 /// 1095 /// @param[in] bytes 1096 /// A pointer to caller owned data. 1097 /// 1098 /// @param[in] length 1099 /// The length in bytes of \a bytes. 1100 /// 1101 /// @param[in] byte_order 1102 /// A byte order of the data that we are extracting from. 1103 /// 1104 /// @return 1105 /// The number of bytes that this object now contains. 1106 //------------------------------------------------------------------ 1107 lldb::offset_t 1108 SetData (const void *bytes, lldb::offset_t length, lldb::ByteOrder byte_order); 1109 1110 //------------------------------------------------------------------ 1111 /// Adopt a subset of \a data. 1112 /// 1113 /// Set this object's data to be a subset of the data bytes in \a 1114 /// data. If \a data contains shared data, then a reference to the 1115 /// shared data will be added to ensure the shared data stays around 1116 /// as long as any objects have references to the shared data. The 1117 /// byte order and the address size settings are copied from \a 1118 /// data. If \a offset is not a valid offset in \a data, then no 1119 /// reference to the shared data will be added. If there are not 1120 /// \a length bytes available in \a data starting at \a offset, 1121 /// the length will be truncated to contains as many bytes as 1122 /// possible. 1123 /// 1124 /// @param[in] data 1125 /// Another DataExtractor object that contains data. 1126 /// 1127 /// @param[in] offset 1128 /// The offset into \a data at which the subset starts. 1129 /// 1130 /// @param[in] length 1131 /// The length in bytes of the subset of \a data. 1132 /// 1133 /// @return 1134 /// The number of bytes that this object now contains. 1135 //------------------------------------------------------------------ 1136 lldb::offset_t 1137 SetData (const DataExtractor& data, lldb::offset_t offset, lldb::offset_t length); 1138 1139 //------------------------------------------------------------------ 1140 /// Adopt a subset of shared data in \a data_sp. 1141 /// 1142 /// Copies the data shared pointer which adds a reference to the 1143 /// contained in \a data_sp. The shared data reference is reference 1144 /// counted to ensure the data lives as long as anyone still has a 1145 /// valid shared pointer to the data in \a data_sp. The byte order 1146 /// and address byte size settings remain the same. If 1147 /// \a offset is not a valid offset in \a data_sp, then no reference 1148 /// to the shared data will be added. If there are not \a length 1149 /// bytes available in \a data starting at \a offset, the length 1150 /// will be truncated to contains as many bytes as possible. 1151 /// 1152 /// @param[in] data_sp 1153 /// A shared pointer to data. 1154 /// 1155 /// @param[in] offset 1156 /// The offset into \a data_sp at which the subset starts. 1157 /// 1158 /// @param[in] length 1159 /// The length in bytes of the subset of \a data_sp. 1160 /// 1161 /// @return 1162 /// The number of bytes that this object now contains. 1163 //------------------------------------------------------------------ 1164 lldb::offset_t 1165 SetData (const lldb::DataBufferSP& data_sp, lldb::offset_t offset = 0, lldb::offset_t length = LLDB_INVALID_OFFSET); 1166 1167 //------------------------------------------------------------------ 1168 /// Set the byte_order value. 1169 /// 1170 /// Sets the byte order of the data to extract. Extracted values 1171 /// will be swapped if necessary when decoding. 1172 /// 1173 /// @param[in] byte_order 1174 /// The byte order value to use when extracting data. 1175 //------------------------------------------------------------------ 1176 void 1177 SetByteOrder (lldb::ByteOrder byte_order) 1178 { 1179 m_byte_order = byte_order; 1180 } 1181 1182 //------------------------------------------------------------------ 1183 /// Skip an LEB128 number at \a *offset_ptr. 1184 /// 1185 /// Skips a LEB128 number (signed or unsigned) from this object's 1186 /// data starting at the offset pointed to by \a offset_ptr. The 1187 /// offset pointed to by \a offset_ptr will be updated with the 1188 /// offset of the byte following the last extracted byte. 1189 /// 1190 /// @param[in,out] offset_ptr 1191 /// A pointer to an offset within the data that will be advanced 1192 /// by the appropriate number of bytes if the value is extracted 1193 /// correctly. If the offset is out of bounds or there are not 1194 /// enough bytes to extract this value, the offset will be left 1195 /// unmodified. 1196 /// 1197 /// @return 1198 // The number of bytes consumed during the extraction. 1199 //------------------------------------------------------------------ 1200 uint32_t 1201 Skip_LEB128 (lldb::offset_t *offset_ptr) const; 1202 1203 //------------------------------------------------------------------ 1204 /// Test the validity of \a offset. 1205 /// 1206 /// @return 1207 /// \b true if \a offset is a valid offset into the data in this 1208 /// object, \b false otherwise. 1209 //------------------------------------------------------------------ 1210 bool 1211 ValidOffset (lldb::offset_t offset) const 1212 { 1213 return offset < GetByteSize(); 1214 } 1215 1216 //------------------------------------------------------------------ 1217 /// Test the availability of \a length bytes of data from \a offset. 1218 /// 1219 /// @return 1220 /// \b true if \a offset is a valid offset and there are \a 1221 /// length bytes available at that offset, \b false otherwise. 1222 //------------------------------------------------------------------ 1223 bool 1224 ValidOffsetForDataOfSize (lldb::offset_t offset, lldb::offset_t length) const; 1225 1226 size_t 1227 Copy (DataExtractor& dest_data) const; 1228 1229 bool 1230 Append (DataExtractor& rhs); 1231 1232 bool 1233 Append (void* bytes, lldb::offset_t length); 1234 1235protected: 1236 //------------------------------------------------------------------ 1237 // Member variables 1238 //------------------------------------------------------------------ 1239 const uint8_t * m_start; ///< A pointer to the first byte of data. 1240 const uint8_t * m_end; ///< A pointer to the byte that is past the end of the data. 1241 lldb::ByteOrder m_byte_order; ///< The byte order of the data we are extracting from. 1242 uint32_t m_addr_size; ///< The address size to use when extracting pointers or addresses 1243 mutable lldb::DataBufferSP m_data_sp; ///< The shared pointer to data that can be shared among multilple instances 1244}; 1245 1246} // namespace lldb_private 1247 1248#endif // #if defined (__cplusplus) 1249#endif // #ifndef liblldb_DataExtractor_h_ 1250