1 //===-- StringPrinter.cpp ----------------------------------------*- 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 #include "lldb/DataFormatters/StringPrinter.h" 11 12 #include "lldb/Core/DataExtractor.h" 13 #include "lldb/Core/Debugger.h" 14 #include "lldb/Core/Error.h" 15 #include "lldb/Core/ValueObject.h" 16 #include "lldb/Target/Process.h" 17 #include "lldb/Target/Target.h" 18 19 #include "llvm/Support/ConvertUTF.h" 20 21 #include <ctype.h> 22 #include <functional> 23 #include <locale> 24 25 using namespace lldb; 26 using namespace lldb_private; 27 using namespace lldb_private::formatters; 28 29 // I can't use a std::unique_ptr for this because the Deleter is a template argument there 30 // and I want the same type to represent both pointers I want to free and pointers I don't need 31 // to free - which is what this class essentially is 32 // It's very specialized to the needs of this file, and not suggested for general use 33 template <typename T = uint8_t, typename U = char, typename S = size_t> 34 struct StringPrinterBufferPointer 35 { 36 public: 37 38 typedef std::function<void(const T*)> Deleter; 39 40 StringPrinterBufferPointer (std::nullptr_t ptr) : 41 m_data(nullptr), 42 m_size(0), 43 m_deleter() 44 {} 45 46 StringPrinterBufferPointer(const T* bytes, S size, Deleter deleter = nullptr) : 47 m_data(bytes), 48 m_size(size), 49 m_deleter(deleter) 50 {} 51 52 StringPrinterBufferPointer(const U* bytes, S size, Deleter deleter = nullptr) : 53 m_data((T*)bytes), 54 m_size(size), 55 m_deleter(deleter) 56 {} 57 58 StringPrinterBufferPointer(StringPrinterBufferPointer&& rhs) : 59 m_data(rhs.m_data), 60 m_size(rhs.m_size), 61 m_deleter(rhs.m_deleter) 62 { 63 rhs.m_data = nullptr; 64 } 65 66 StringPrinterBufferPointer(const StringPrinterBufferPointer& rhs) : 67 m_data(rhs.m_data), 68 m_size(rhs.m_size), 69 m_deleter(rhs.m_deleter) 70 { 71 rhs.m_data = nullptr; // this is why m_data has to be mutable 72 } 73 74 const T* 75 GetBytes () const 76 { 77 return m_data; 78 } 79 80 const S 81 GetSize () const 82 { 83 return m_size; 84 } 85 86 ~StringPrinterBufferPointer () 87 { 88 if (m_data && m_deleter) 89 m_deleter(m_data); 90 m_data = nullptr; 91 } 92 93 StringPrinterBufferPointer& 94 operator = (const StringPrinterBufferPointer& rhs) 95 { 96 if (m_data && m_deleter) 97 m_deleter(m_data); 98 m_data = rhs.m_data; 99 m_size = rhs.m_size; 100 m_deleter = rhs.m_deleter; 101 rhs.m_data = nullptr; 102 return *this; 103 } 104 105 private: 106 mutable const T* m_data; 107 size_t m_size; 108 Deleter m_deleter; 109 }; 110 111 // we define this for all values of type but only implement it for those we care about 112 // that's good because we get linker errors for any unsupported type 113 template <StringElementType type> 114 static StringPrinterBufferPointer<> 115 GetPrintableImpl(uint8_t* buffer, uint8_t* buffer_end, uint8_t*& next); 116 117 // mimic isprint() for Unicode codepoints 118 static bool 119 isprint(char32_t codepoint) 120 { 121 if (codepoint <= 0x1F || codepoint == 0x7F) // C0 122 { 123 return false; 124 } 125 if (codepoint >= 0x80 && codepoint <= 0x9F) // C1 126 { 127 return false; 128 } 129 if (codepoint == 0x2028 || codepoint == 0x2029) // line/paragraph separators 130 { 131 return false; 132 } 133 if (codepoint == 0x200E || codepoint == 0x200F || (codepoint >= 0x202A && codepoint <= 0x202E)) // bidirectional text control 134 { 135 return false; 136 } 137 if (codepoint >= 0xFFF9 && codepoint <= 0xFFFF) // interlinears and generally specials 138 { 139 return false; 140 } 141 return true; 142 } 143 144 template <> 145 StringPrinterBufferPointer<> 146 GetPrintableImpl<StringElementType::ASCII> (uint8_t* buffer, uint8_t* buffer_end, uint8_t*& next) 147 { 148 StringPrinterBufferPointer<> retval = {nullptr}; 149 150 switch (*buffer) 151 { 152 case 0: 153 retval = {"\\0",2}; 154 break; 155 case '\a': 156 retval = {"\\a",2}; 157 break; 158 case '\b': 159 retval = {"\\b",2}; 160 break; 161 case '\f': 162 retval = {"\\f",2}; 163 break; 164 case '\n': 165 retval = {"\\n",2}; 166 break; 167 case '\r': 168 retval = {"\\r",2}; 169 break; 170 case '\t': 171 retval = {"\\t",2}; 172 break; 173 case '\v': 174 retval = {"\\v",2}; 175 break; 176 case '\"': 177 retval = {"\\\"",2}; 178 break; 179 case '\\': 180 retval = {"\\\\",2}; 181 break; 182 default: 183 if (isprint(*buffer)) 184 retval = {buffer,1}; 185 else 186 { 187 uint8_t* data = new uint8_t[5]; 188 sprintf((char*)data,"\\x%02x",*buffer); 189 retval = {data, 4, [] (const uint8_t* c) {delete[] c;} }; 190 break; 191 } 192 } 193 194 next = buffer + 1; 195 return retval; 196 } 197 198 static char32_t 199 ConvertUTF8ToCodePoint (unsigned char c0, unsigned char c1) 200 { 201 return (c0-192)*64+(c1-128); 202 } 203 static char32_t 204 ConvertUTF8ToCodePoint (unsigned char c0, unsigned char c1, unsigned char c2) 205 { 206 return (c0-224)*4096+(c1-128)*64+(c2-128); 207 } 208 static char32_t 209 ConvertUTF8ToCodePoint (unsigned char c0, unsigned char c1, unsigned char c2, unsigned char c3) 210 { 211 return (c0-240)*262144+(c2-128)*4096+(c2-128)*64+(c3-128); 212 } 213 214 template <> 215 StringPrinterBufferPointer<> 216 GetPrintableImpl<StringElementType::UTF8> (uint8_t* buffer, uint8_t* buffer_end, uint8_t*& next) 217 { 218 StringPrinterBufferPointer<> retval {nullptr}; 219 220 unsigned utf8_encoded_len = getNumBytesForUTF8(*buffer); 221 222 if (1+buffer_end-buffer < utf8_encoded_len) 223 { 224 // I don't have enough bytes - print whatever I have left 225 retval = {buffer,static_cast<size_t>(1+buffer_end-buffer)}; 226 next = buffer_end+1; 227 return retval; 228 } 229 230 char32_t codepoint = 0; 231 switch (utf8_encoded_len) 232 { 233 case 1: 234 // this is just an ASCII byte - ask ASCII 235 return GetPrintableImpl<StringElementType::ASCII>(buffer, buffer_end, next); 236 case 2: 237 codepoint = ConvertUTF8ToCodePoint((unsigned char)*buffer, (unsigned char)*(buffer+1)); 238 break; 239 case 3: 240 codepoint = ConvertUTF8ToCodePoint((unsigned char)*buffer, (unsigned char)*(buffer+1), (unsigned char)*(buffer+2)); 241 break; 242 case 4: 243 codepoint = ConvertUTF8ToCodePoint((unsigned char)*buffer, (unsigned char)*(buffer+1), (unsigned char)*(buffer+2), (unsigned char)*(buffer+3)); 244 break; 245 default: 246 // this is probably some bogus non-character thing 247 // just print it as-is and hope to sync up again soon 248 retval = {buffer,1}; 249 next = buffer+1; 250 return retval; 251 } 252 253 if (codepoint) 254 { 255 switch (codepoint) 256 { 257 case 0: 258 retval = {"\\0",2}; 259 break; 260 case '\a': 261 retval = {"\\a",2}; 262 break; 263 case '\b': 264 retval = {"\\b",2}; 265 break; 266 case '\f': 267 retval = {"\\f",2}; 268 break; 269 case '\n': 270 retval = {"\\n",2}; 271 break; 272 case '\r': 273 retval = {"\\r",2}; 274 break; 275 case '\t': 276 retval = {"\\t",2}; 277 break; 278 case '\v': 279 retval = {"\\v",2}; 280 break; 281 case '\"': 282 retval = {"\\\"",2}; 283 break; 284 case '\\': 285 retval = {"\\\\",2}; 286 break; 287 default: 288 if (isprint(codepoint)) 289 retval = {buffer,utf8_encoded_len}; 290 else 291 { 292 uint8_t* data = new uint8_t[11]; 293 sprintf((char*)data,"\\U%08x",codepoint); 294 retval = { data,10,[] (const uint8_t* c) {delete[] c;} }; 295 break; 296 } 297 } 298 299 next = buffer + utf8_encoded_len; 300 return retval; 301 } 302 303 // this should not happen - but just in case.. try to resync at some point 304 retval = {buffer,1}; 305 next = buffer+1; 306 return retval; 307 } 308 309 // Given a sequence of bytes, this function returns: 310 // a sequence of bytes to actually print out + a length 311 // the following unscanned position of the buffer is in next 312 static StringPrinterBufferPointer<> 313 GetPrintable(StringElementType type, uint8_t* buffer, uint8_t* buffer_end, uint8_t*& next) 314 { 315 if (!buffer) 316 return {nullptr}; 317 318 switch (type) 319 { 320 case StringElementType::ASCII: 321 return GetPrintableImpl<StringElementType::ASCII>(buffer, buffer_end, next); 322 case StringElementType::UTF8: 323 return GetPrintableImpl<StringElementType::UTF8>(buffer, buffer_end, next); 324 default: 325 return {nullptr}; 326 } 327 } 328 329 // use this call if you already have an LLDB-side buffer for the data 330 template<typename SourceDataType> 331 static bool 332 DumpUTFBufferToStream (ConversionResult (*ConvertFunction) (const SourceDataType**, 333 const SourceDataType*, 334 UTF8**, 335 UTF8*, 336 ConversionFlags), 337 const ReadBufferAndDumpToStreamOptions& dump_options) 338 { 339 Stream &stream(*dump_options.GetStream()); 340 if (dump_options.GetPrefixToken() != 0) 341 stream.Printf("%c",dump_options.GetPrefixToken()); 342 if (dump_options.GetQuote() != 0) 343 stream.Printf("%c",dump_options.GetQuote()); 344 auto data(dump_options.GetData()); 345 auto source_size(dump_options.GetSourceSize()); 346 if (data.GetByteSize() && data.GetDataStart() && data.GetDataEnd()) 347 { 348 const int bufferSPSize = data.GetByteSize(); 349 if (dump_options.GetSourceSize() == 0) 350 { 351 const int origin_encoding = 8*sizeof(SourceDataType); 352 source_size = bufferSPSize/(origin_encoding / 4); 353 } 354 355 const SourceDataType *data_ptr = (const SourceDataType*)data.GetDataStart(); 356 const SourceDataType *data_end_ptr = data_ptr + source_size; 357 358 const bool zero_is_terminator = dump_options.GetBinaryZeroIsTerminator(); 359 360 if (zero_is_terminator) 361 { 362 while (data_ptr < data_end_ptr) 363 { 364 if (!*data_ptr) 365 { 366 data_end_ptr = data_ptr; 367 break; 368 } 369 data_ptr++; 370 } 371 372 data_ptr = (const SourceDataType*)data.GetDataStart(); 373 } 374 375 lldb::DataBufferSP utf8_data_buffer_sp; 376 UTF8* utf8_data_ptr = nullptr; 377 UTF8* utf8_data_end_ptr = nullptr; 378 379 if (ConvertFunction) 380 { 381 utf8_data_buffer_sp.reset(new DataBufferHeap(4*bufferSPSize,0)); 382 utf8_data_ptr = (UTF8*)utf8_data_buffer_sp->GetBytes(); 383 utf8_data_end_ptr = utf8_data_ptr + utf8_data_buffer_sp->GetByteSize(); 384 ConvertFunction ( &data_ptr, data_end_ptr, &utf8_data_ptr, utf8_data_end_ptr, lenientConversion ); 385 utf8_data_ptr = (UTF8*)utf8_data_buffer_sp->GetBytes(); // needed because the ConvertFunction will change the value of the data_ptr 386 } 387 else 388 { 389 // just copy the pointers - the cast is necessary to make the compiler happy 390 // but this should only happen if we are reading UTF8 data 391 utf8_data_ptr = (UTF8*)data_ptr; 392 utf8_data_end_ptr = (UTF8*)data_end_ptr; 393 } 394 395 const bool escape_non_printables = dump_options.GetEscapeNonPrintables(); 396 397 // since we tend to accept partial data (and even partially malformed data) 398 // we might end up with no NULL terminator before the end_ptr 399 // hence we need to take a slower route and ensure we stay within boundaries 400 for (;utf8_data_ptr < utf8_data_end_ptr;) 401 { 402 if (zero_is_terminator && !*utf8_data_ptr) 403 break; 404 405 if (escape_non_printables) 406 { 407 uint8_t* next_data = nullptr; 408 auto printable = GetPrintable(StringElementType::UTF8, utf8_data_ptr, utf8_data_end_ptr, next_data); 409 auto printable_bytes = printable.GetBytes(); 410 auto printable_size = printable.GetSize(); 411 if (!printable_bytes || !next_data) 412 { 413 // GetPrintable() failed on us - print one byte in a desperate resync attempt 414 printable_bytes = utf8_data_ptr; 415 printable_size = 1; 416 next_data = utf8_data_ptr+1; 417 } 418 for (unsigned c = 0; c < printable_size; c++) 419 stream.Printf("%c", *(printable_bytes+c)); 420 utf8_data_ptr = (uint8_t*)next_data; 421 } 422 else 423 { 424 stream.Printf("%c",*utf8_data_ptr); 425 utf8_data_ptr++; 426 } 427 } 428 } 429 if (dump_options.GetQuote() != 0) 430 stream.Printf("%c",dump_options.GetQuote()); 431 return true; 432 } 433 434 lldb_private::formatters::ReadStringAndDumpToStreamOptions::ReadStringAndDumpToStreamOptions (ValueObject& valobj) : 435 ReadStringAndDumpToStreamOptions() 436 { 437 SetEscapeNonPrintables(valobj.GetTargetSP()->GetDebugger().GetEscapeNonPrintables()); 438 } 439 440 lldb_private::formatters::ReadBufferAndDumpToStreamOptions::ReadBufferAndDumpToStreamOptions (ValueObject& valobj) : 441 ReadBufferAndDumpToStreamOptions() 442 { 443 SetEscapeNonPrintables(valobj.GetTargetSP()->GetDebugger().GetEscapeNonPrintables()); 444 } 445 446 lldb_private::formatters::ReadBufferAndDumpToStreamOptions::ReadBufferAndDumpToStreamOptions (const lldb_private::formatters::ReadStringAndDumpToStreamOptions& options) : 447 ReadBufferAndDumpToStreamOptions() 448 { 449 SetStream(options.GetStream()); 450 SetPrefixToken(options.GetPrefixToken()); 451 SetQuote(options.GetQuote()); 452 SetEscapeNonPrintables(options.GetEscapeNonPrintables()); 453 SetBinaryZeroIsTerminator(options.GetBinaryZeroIsTerminator()); 454 } 455 456 457 namespace lldb_private 458 { 459 460 namespace formatters 461 { 462 463 template <> 464 bool 465 ReadStringAndDumpToStream<StringElementType::ASCII> (const ReadStringAndDumpToStreamOptions& options) 466 { 467 assert(options.GetStream() && "need a Stream to print the string to"); 468 Error my_error; 469 470 ProcessSP process_sp(options.GetProcessSP()); 471 472 if (process_sp.get() == nullptr || options.GetLocation() == 0) 473 return false; 474 475 size_t size; 476 477 if (options.GetSourceSize() == 0) 478 size = process_sp->GetTarget().GetMaximumSizeOfStringSummary(); 479 else if (!options.GetIgnoreMaxLength()) 480 size = std::min(options.GetSourceSize(),process_sp->GetTarget().GetMaximumSizeOfStringSummary()); 481 else 482 size = options.GetSourceSize(); 483 484 lldb::DataBufferSP buffer_sp(new DataBufferHeap(size,0)); 485 486 process_sp->ReadCStringFromMemory(options.GetLocation(), (char*)buffer_sp->GetBytes(), size, my_error); 487 488 if (my_error.Fail()) 489 return false; 490 491 char prefix_token = options.GetPrefixToken(); 492 char quote = options.GetQuote(); 493 494 if (prefix_token != 0) 495 options.GetStream()->Printf("%c%c",prefix_token,quote); 496 else if (quote != 0) 497 options.GetStream()->Printf("%c",quote); 498 499 uint8_t* data_end = buffer_sp->GetBytes()+buffer_sp->GetByteSize(); 500 501 // since we tend to accept partial data (and even partially malformed data) 502 // we might end up with no NULL terminator before the end_ptr 503 // hence we need to take a slower route and ensure we stay within boundaries 504 for (uint8_t* data = buffer_sp->GetBytes(); *data && (data < data_end);) 505 { 506 if (options.GetEscapeNonPrintables()) 507 { 508 uint8_t* next_data = nullptr; 509 auto printable = GetPrintable(StringElementType::ASCII, data, data_end, next_data); 510 auto printable_bytes = printable.GetBytes(); 511 auto printable_size = printable.GetSize(); 512 if (!printable_bytes || !next_data) 513 { 514 // GetPrintable() failed on us - print one byte in a desperate resync attempt 515 printable_bytes = data; 516 printable_size = 1; 517 next_data = data+1; 518 } 519 for (unsigned c = 0; c < printable_size; c++) 520 options.GetStream()->Printf("%c", *(printable_bytes+c)); 521 data = (uint8_t*)next_data; 522 } 523 else 524 { 525 options.GetStream()->Printf("%c",*data); 526 data++; 527 } 528 } 529 530 if (quote != 0) 531 options.GetStream()->Printf("%c",quote); 532 533 return true; 534 } 535 536 template<typename SourceDataType> 537 static bool 538 ReadUTFBufferAndDumpToStream (const ReadStringAndDumpToStreamOptions& options, 539 ConversionResult (*ConvertFunction) (const SourceDataType**, 540 const SourceDataType*, 541 UTF8**, 542 UTF8*, 543 ConversionFlags)) 544 { 545 assert(options.GetStream() && "need a Stream to print the string to"); 546 547 if (options.GetLocation() == 0 || options.GetLocation() == LLDB_INVALID_ADDRESS) 548 return false; 549 550 lldb::ProcessSP process_sp(options.GetProcessSP()); 551 552 if (!process_sp) 553 return false; 554 555 const int type_width = sizeof(SourceDataType); 556 const int origin_encoding = 8 * type_width ; 557 if (origin_encoding != 8 && origin_encoding != 16 && origin_encoding != 32) 558 return false; 559 // if not UTF8, I need a conversion function to return proper UTF8 560 if (origin_encoding != 8 && !ConvertFunction) 561 return false; 562 563 if (!options.GetStream()) 564 return false; 565 566 uint32_t sourceSize = options.GetSourceSize(); 567 bool needs_zero_terminator = options.GetNeedsZeroTermination(); 568 569 if (!sourceSize) 570 { 571 sourceSize = process_sp->GetTarget().GetMaximumSizeOfStringSummary(); 572 needs_zero_terminator = true; 573 } 574 else if (!options.GetIgnoreMaxLength()) 575 sourceSize = std::min(sourceSize,process_sp->GetTarget().GetMaximumSizeOfStringSummary()); 576 577 const int bufferSPSize = sourceSize * type_width; 578 579 lldb::DataBufferSP buffer_sp(new DataBufferHeap(bufferSPSize,0)); 580 581 if (!buffer_sp->GetBytes()) 582 return false; 583 584 Error error; 585 char *buffer = reinterpret_cast<char *>(buffer_sp->GetBytes()); 586 587 if (needs_zero_terminator) 588 process_sp->ReadStringFromMemory(options.GetLocation(), buffer, bufferSPSize, error, type_width); 589 else 590 process_sp->ReadMemoryFromInferior(options.GetLocation(), (char*)buffer_sp->GetBytes(), bufferSPSize, error); 591 592 if (error.Fail()) 593 { 594 options.GetStream()->Printf("unable to read data"); 595 return true; 596 } 597 598 DataExtractor data(buffer_sp, process_sp->GetByteOrder(), process_sp->GetAddressByteSize()); 599 600 ReadBufferAndDumpToStreamOptions dump_options(options); 601 dump_options.SetData(data); 602 dump_options.SetSourceSize(sourceSize); 603 604 return DumpUTFBufferToStream(ConvertFunction, dump_options); 605 } 606 607 template <> 608 bool 609 ReadStringAndDumpToStream<StringElementType::UTF8> (const ReadStringAndDumpToStreamOptions& options) 610 { 611 return ReadUTFBufferAndDumpToStream<UTF8>(options, 612 nullptr); 613 } 614 615 template <> 616 bool 617 ReadStringAndDumpToStream<StringElementType::UTF16> (const ReadStringAndDumpToStreamOptions& options) 618 { 619 return ReadUTFBufferAndDumpToStream<UTF16>(options, 620 ConvertUTF16toUTF8); 621 } 622 623 template <> 624 bool 625 ReadStringAndDumpToStream<StringElementType::UTF32> (const ReadStringAndDumpToStreamOptions& options) 626 { 627 return ReadUTFBufferAndDumpToStream<UTF32>(options, 628 ConvertUTF32toUTF8); 629 } 630 631 template <> 632 bool 633 ReadBufferAndDumpToStream<StringElementType::UTF8> (const ReadBufferAndDumpToStreamOptions& options) 634 { 635 assert(options.GetStream() && "need a Stream to print the string to"); 636 637 return DumpUTFBufferToStream<UTF8>(nullptr, options); 638 } 639 640 template <> 641 bool 642 ReadBufferAndDumpToStream<StringElementType::ASCII> (const ReadBufferAndDumpToStreamOptions& options) 643 { 644 // treat ASCII the same as UTF8 645 // FIXME: can we optimize ASCII some more? 646 return ReadBufferAndDumpToStream<StringElementType::UTF8>(options); 647 } 648 649 template <> 650 bool 651 ReadBufferAndDumpToStream<StringElementType::UTF16> (const ReadBufferAndDumpToStreamOptions& options) 652 { 653 assert(options.GetStream() && "need a Stream to print the string to"); 654 655 return DumpUTFBufferToStream(ConvertUTF16toUTF8, options); 656 } 657 658 template <> 659 bool 660 ReadBufferAndDumpToStream<StringElementType::UTF32> (const ReadBufferAndDumpToStreamOptions& options) 661 { 662 assert(options.GetStream() && "need a Stream to print the string to"); 663 664 return DumpUTFBufferToStream(ConvertUTF32toUTF8, options); 665 } 666 667 } // namespace formatters 668 669 } // namespace lldb_private 670