PrintfFormatString.cpp revision 29e97cb35fab314388f62b68fefa78947e93c1dc
1//== PrintfFormatString.cpp - Analysis of printf format strings --*- 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// Handling of format string in printf and friends. The structure of format 11// strings for fprintf() are described in C99 7.19.6.1. 12// 13//===----------------------------------------------------------------------===// 14 15#include "clang/Analysis/Analyses/FormatString.h" 16#include "FormatStringParsing.h" 17 18using clang::analyze_format_string::ArgTypeResult; 19using clang::analyze_format_string::FormatStringHandler; 20using clang::analyze_format_string::LengthModifier; 21using clang::analyze_format_string::OptionalAmount; 22using clang::analyze_format_string::ConversionSpecifier; 23using clang::analyze_printf::PrintfSpecifier; 24 25using namespace clang; 26 27typedef clang::analyze_format_string::SpecifierResult<PrintfSpecifier> 28 PrintfSpecifierResult; 29 30//===----------------------------------------------------------------------===// 31// Methods for parsing format strings. 32//===----------------------------------------------------------------------===// 33 34using analyze_format_string::ParseNonPositionAmount; 35 36static bool ParsePrecision(FormatStringHandler &H, PrintfSpecifier &FS, 37 const char *Start, const char *&Beg, const char *E, 38 unsigned *argIndex) { 39 if (argIndex) { 40 FS.setPrecision(ParseNonPositionAmount(Beg, E, *argIndex)); 41 } else { 42 const OptionalAmount Amt = ParsePositionAmount(H, Start, Beg, E, 43 analyze_format_string::PrecisionPos); 44 if (Amt.isInvalid()) 45 return true; 46 FS.setPrecision(Amt); 47 } 48 return false; 49} 50 51static PrintfSpecifierResult ParsePrintfSpecifier(FormatStringHandler &H, 52 const char *&Beg, 53 const char *E, 54 unsigned &argIndex) { 55 56 using namespace clang::analyze_format_string; 57 using namespace clang::analyze_printf; 58 59 const char *I = Beg; 60 const char *Start = 0; 61 UpdateOnReturn <const char*> UpdateBeg(Beg, I); 62 63 // Look for a '%' character that indicates the start of a format specifier. 64 for ( ; I != E ; ++I) { 65 char c = *I; 66 if (c == '\0') { 67 // Detect spurious null characters, which are likely errors. 68 H.HandleNullChar(I); 69 return true; 70 } 71 if (c == '%') { 72 Start = I++; // Record the start of the format specifier. 73 break; 74 } 75 } 76 77 // No format specifier found? 78 if (!Start) 79 return false; 80 81 if (I == E) { 82 // No more characters left? 83 H.HandleIncompleteSpecifier(Start, E - Start); 84 return true; 85 } 86 87 PrintfSpecifier FS; 88 if (ParseArgPosition(H, FS, Start, I, E)) 89 return true; 90 91 if (I == E) { 92 // No more characters left? 93 H.HandleIncompleteSpecifier(Start, E - Start); 94 return true; 95 } 96 97 // Look for flags (if any). 98 bool hasMore = true; 99 for ( ; I != E; ++I) { 100 switch (*I) { 101 default: hasMore = false; break; 102 case '\'': 103 // FIXME: POSIX specific. Always accept? 104 FS.setHasThousandsGrouping(I); 105 break; 106 case '-': FS.setIsLeftJustified(I); break; 107 case '+': FS.setHasPlusPrefix(I); break; 108 case ' ': FS.setHasSpacePrefix(I); break; 109 case '#': FS.setHasAlternativeForm(I); break; 110 case '0': FS.setHasLeadingZeros(I); break; 111 } 112 if (!hasMore) 113 break; 114 } 115 116 if (I == E) { 117 // No more characters left? 118 H.HandleIncompleteSpecifier(Start, E - Start); 119 return true; 120 } 121 122 // Look for the field width (if any). 123 if (ParseFieldWidth(H, FS, Start, I, E, 124 FS.usesPositionalArg() ? 0 : &argIndex)) 125 return true; 126 127 if (I == E) { 128 // No more characters left? 129 H.HandleIncompleteSpecifier(Start, E - Start); 130 return true; 131 } 132 133 // Look for the precision (if any). 134 if (*I == '.') { 135 ++I; 136 if (I == E) { 137 H.HandleIncompleteSpecifier(Start, E - Start); 138 return true; 139 } 140 141 if (ParsePrecision(H, FS, Start, I, E, 142 FS.usesPositionalArg() ? 0 : &argIndex)) 143 return true; 144 145 if (I == E) { 146 // No more characters left? 147 H.HandleIncompleteSpecifier(Start, E - Start); 148 return true; 149 } 150 } 151 152 // Look for the length modifier. 153 if (ParseLengthModifier(FS, I, E) && I == E) { 154 // No more characters left? 155 H.HandleIncompleteSpecifier(Start, E - Start); 156 return true; 157 } 158 159 if (*I == '\0') { 160 // Detect spurious null characters, which are likely errors. 161 H.HandleNullChar(I); 162 return true; 163 } 164 165 // Finally, look for the conversion specifier. 166 const char *conversionPosition = I++; 167 ConversionSpecifier::Kind k = ConversionSpecifier::InvalidSpecifier; 168 switch (*conversionPosition) { 169 default: 170 break; 171 // C99: 7.19.6.1 (section 8). 172 case '%': k = ConversionSpecifier::PercentArg; break; 173 case 'A': k = ConversionSpecifier::AArg; break; 174 case 'E': k = ConversionSpecifier::EArg; break; 175 case 'F': k = ConversionSpecifier::FArg; break; 176 case 'G': k = ConversionSpecifier::GArg; break; 177 case 'X': k = ConversionSpecifier::XArg; break; 178 case 'a': k = ConversionSpecifier::aArg; break; 179 case 'c': k = ConversionSpecifier::cArg; break; 180 case 'd': k = ConversionSpecifier::dArg; break; 181 case 'e': k = ConversionSpecifier::eArg; break; 182 case 'f': k = ConversionSpecifier::fArg; break; 183 case 'g': k = ConversionSpecifier::gArg; break; 184 case 'i': k = ConversionSpecifier::iArg; break; 185 case 'n': k = ConversionSpecifier::nArg; break; 186 case 'o': k = ConversionSpecifier::oArg; break; 187 case 'p': k = ConversionSpecifier::pArg; break; 188 case 's': k = ConversionSpecifier::sArg; break; 189 case 'u': k = ConversionSpecifier::uArg; break; 190 case 'x': k = ConversionSpecifier::xArg; break; 191 // POSIX specific. 192 case 'C': k = ConversionSpecifier::CArg; break; 193 case 'S': k = ConversionSpecifier::SArg; break; 194 // Objective-C. 195 case '@': k = ConversionSpecifier::ObjCObjArg; break; 196 // Glibc specific. 197 case 'm': k = ConversionSpecifier::PrintErrno; break; 198 } 199 PrintfConversionSpecifier CS(conversionPosition, k); 200 FS.setConversionSpecifier(CS); 201 if (CS.consumesDataArgument() && !FS.usesPositionalArg()) 202 FS.setArgIndex(argIndex++); 203 204 if (k == ConversionSpecifier::InvalidSpecifier) { 205 // Assume the conversion takes one argument. 206 return !H.HandleInvalidPrintfConversionSpecifier(FS, Start, I - Start); 207 } 208 return PrintfSpecifierResult(Start, FS); 209} 210 211bool clang::analyze_format_string::ParsePrintfString(FormatStringHandler &H, 212 const char *I, 213 const char *E) { 214 215 unsigned argIndex = 0; 216 217 // Keep looking for a format specifier until we have exhausted the string. 218 while (I != E) { 219 const PrintfSpecifierResult &FSR = ParsePrintfSpecifier(H, I, E, argIndex); 220 // Did a fail-stop error of any kind occur when parsing the specifier? 221 // If so, don't do any more processing. 222 if (FSR.shouldStop()) 223 return true;; 224 // Did we exhaust the string or encounter an error that 225 // we can recover from? 226 if (!FSR.hasValue()) 227 continue; 228 // We have a format specifier. Pass it to the callback. 229 if (!H.HandlePrintfSpecifier(FSR.getValue(), FSR.getStart(), 230 I - FSR.getStart())) 231 return true; 232 } 233 assert(I == E && "Format string not exhausted"); 234 return false; 235} 236 237//===----------------------------------------------------------------------===// 238// Methods on ConversionSpecifier. 239//===----------------------------------------------------------------------===// 240const char *ConversionSpecifier::toString() const { 241 switch (kind) { 242 case dArg: return "d"; 243 case iArg: return "i"; 244 case oArg: return "o"; 245 case uArg: return "u"; 246 case xArg: return "x"; 247 case XArg: return "X"; 248 case fArg: return "f"; 249 case FArg: return "F"; 250 case eArg: return "e"; 251 case EArg: return "E"; 252 case gArg: return "g"; 253 case GArg: return "G"; 254 case aArg: return "a"; 255 case AArg: return "A"; 256 case cArg: return "c"; 257 case sArg: return "s"; 258 case pArg: return "p"; 259 case nArg: return "n"; 260 case PercentArg: return "%"; 261 case ScanListArg: return "["; 262 case InvalidSpecifier: return NULL; 263 264 // MacOS X unicode extensions. 265 case CArg: return "C"; 266 case SArg: return "S"; 267 268 // Objective-C specific specifiers. 269 case ObjCObjArg: return "@"; 270 271 // GlibC specific specifiers. 272 case PrintErrno: return "m"; 273 } 274 return NULL; 275} 276 277//===----------------------------------------------------------------------===// 278// Methods on PrintfSpecifier. 279//===----------------------------------------------------------------------===// 280 281ArgTypeResult PrintfSpecifier::getArgType(ASTContext &Ctx) const { 282 const PrintfConversionSpecifier &CS = getConversionSpecifier(); 283 284 if (!CS.consumesDataArgument()) 285 return ArgTypeResult::Invalid(); 286 287 if (CS.getKind() == ConversionSpecifier::cArg) 288 switch (LM.getKind()) { 289 case LengthModifier::None: return Ctx.IntTy; 290 case LengthModifier::AsLong: return ArgTypeResult::WIntTy; 291 default: 292 return ArgTypeResult::Invalid(); 293 } 294 295 if (CS.isIntArg()) 296 switch (LM.getKind()) { 297 case LengthModifier::AsLongDouble: 298 return ArgTypeResult::Invalid(); 299 case LengthModifier::None: return Ctx.IntTy; 300 case LengthModifier::AsChar: return ArgTypeResult::AnyCharTy; 301 case LengthModifier::AsShort: return Ctx.ShortTy; 302 case LengthModifier::AsLong: return Ctx.LongTy; 303 case LengthModifier::AsLongLong: return Ctx.LongLongTy; 304 case LengthModifier::AsIntMax: return Ctx.getIntMaxType(); 305 case LengthModifier::AsSizeT: 306 // FIXME: How to get the corresponding signed version of size_t? 307 return ArgTypeResult(); 308 case LengthModifier::AsPtrDiff: return Ctx.getPointerDiffType(); 309 } 310 311 if (CS.isUIntArg()) 312 switch (LM.getKind()) { 313 case LengthModifier::AsLongDouble: 314 return ArgTypeResult::Invalid(); 315 case LengthModifier::None: return Ctx.UnsignedIntTy; 316 case LengthModifier::AsChar: return Ctx.UnsignedCharTy; 317 case LengthModifier::AsShort: return Ctx.UnsignedShortTy; 318 case LengthModifier::AsLong: return Ctx.UnsignedLongTy; 319 case LengthModifier::AsLongLong: return Ctx.UnsignedLongLongTy; 320 case LengthModifier::AsIntMax: return Ctx.getUIntMaxType(); 321 case LengthModifier::AsSizeT: 322 return Ctx.getSizeType(); 323 case LengthModifier::AsPtrDiff: 324 // FIXME: How to get the corresponding unsigned 325 // version of ptrdiff_t? 326 return ArgTypeResult(); 327 } 328 329 if (CS.isDoubleArg()) { 330 if (LM.getKind() == LengthModifier::AsLongDouble) 331 return Ctx.LongDoubleTy; 332 return Ctx.DoubleTy; 333 } 334 335 switch (CS.getKind()) { 336 case ConversionSpecifier::sArg: 337 return ArgTypeResult(LM.getKind() == LengthModifier::AsWideChar ? 338 ArgTypeResult::WCStrTy : ArgTypeResult::CStrTy); 339 case ConversionSpecifier::SArg: 340 // FIXME: This appears to be Mac OS X specific. 341 return ArgTypeResult::WCStrTy; 342 case ConversionSpecifier::CArg: 343 return Ctx.WCharTy; 344 case ConversionSpecifier::pArg: 345 return ArgTypeResult::CPointerTy; 346 default: 347 break; 348 } 349 350 // FIXME: Handle other cases. 351 return ArgTypeResult(); 352} 353 354bool PrintfSpecifier::fixType(QualType QT, const LangOptions &LangOpt) { 355 // Handle strings first (char *, wchar_t *) 356 if (QT->isPointerType() && (QT->getPointeeType()->isAnyCharacterType())) { 357 CS.setKind(ConversionSpecifier::sArg); 358 359 // Disable irrelevant flags 360 HasAlternativeForm = 0; 361 HasLeadingZeroes = 0; 362 363 // Set the long length modifier for wide characters 364 if (QT->getPointeeType()->isWideCharType()) 365 LM.setKind(LengthModifier::AsWideChar); 366 367 return true; 368 } 369 370 // We can only work with builtin types. 371 const BuiltinType *BT = QT->getAs<BuiltinType>(); 372 if (!BT) 373 return false; 374 375 // Set length modifier 376 switch (BT->getKind()) { 377 case BuiltinType::Bool: 378 case BuiltinType::WChar_U: 379 case BuiltinType::WChar_S: 380 case BuiltinType::Char16: 381 case BuiltinType::Char32: 382 case BuiltinType::UInt128: 383 case BuiltinType::Int128: 384 case BuiltinType::Half: 385 // Various types which are non-trivial to correct. 386 return false; 387 388#define SIGNED_TYPE(Id, SingletonId) 389#define UNSIGNED_TYPE(Id, SingletonId) 390#define FLOATING_TYPE(Id, SingletonId) 391#define BUILTIN_TYPE(Id, SingletonId) \ 392 case BuiltinType::Id: 393#include "clang/AST/BuiltinTypes.def" 394 // Misc other stuff which doesn't make sense here. 395 return false; 396 397 case BuiltinType::UInt: 398 case BuiltinType::Int: 399 case BuiltinType::Float: 400 case BuiltinType::Double: 401 LM.setKind(LengthModifier::None); 402 break; 403 404 case BuiltinType::Char_U: 405 case BuiltinType::UChar: 406 case BuiltinType::Char_S: 407 case BuiltinType::SChar: 408 LM.setKind(LengthModifier::AsChar); 409 break; 410 411 case BuiltinType::Short: 412 case BuiltinType::UShort: 413 LM.setKind(LengthModifier::AsShort); 414 break; 415 416 case BuiltinType::Long: 417 case BuiltinType::ULong: 418 LM.setKind(LengthModifier::AsLong); 419 break; 420 421 case BuiltinType::LongLong: 422 case BuiltinType::ULongLong: 423 LM.setKind(LengthModifier::AsLongLong); 424 break; 425 426 case BuiltinType::LongDouble: 427 LM.setKind(LengthModifier::AsLongDouble); 428 break; 429 } 430 431 // Handle size_t, ptrdiff_t, etc. that have dedicated length modifiers in C99. 432 if (isa<TypedefType>(QT) && (LangOpt.C99 || LangOpt.CPlusPlus0x)) { 433 const IdentifierInfo *Identifier = QT.getBaseTypeIdentifier(); 434 if (Identifier->getName() == "size_t") { 435 LM.setKind(LengthModifier::AsSizeT); 436 } else if (Identifier->getName() == "ssize_t") { 437 // Not C99, but common in Unix. 438 LM.setKind(LengthModifier::AsSizeT); 439 } else if (Identifier->getName() == "intmax_t") { 440 LM.setKind(LengthModifier::AsIntMax); 441 } else if (Identifier->getName() == "uintmax_t") { 442 LM.setKind(LengthModifier::AsIntMax); 443 } else if (Identifier->getName() == "ptrdiff_t") { 444 LM.setKind(LengthModifier::AsPtrDiff); 445 } 446 } 447 448 // Set conversion specifier and disable any flags which do not apply to it. 449 // Let typedefs to char fall through to int, as %c is silly for uint8_t. 450 if (isa<TypedefType>(QT) && QT->isAnyCharacterType()) { 451 CS.setKind(ConversionSpecifier::cArg); 452 LM.setKind(LengthModifier::None); 453 Precision.setHowSpecified(OptionalAmount::NotSpecified); 454 HasAlternativeForm = 0; 455 HasLeadingZeroes = 0; 456 HasPlusPrefix = 0; 457 } 458 // Test for Floating type first as LongDouble can pass isUnsignedIntegerType 459 else if (QT->isRealFloatingType()) { 460 CS.setKind(ConversionSpecifier::fArg); 461 } 462 else if (QT->isSignedIntegerType()) { 463 CS.setKind(ConversionSpecifier::dArg); 464 HasAlternativeForm = 0; 465 } 466 else if (QT->isUnsignedIntegerType()) { 467 // Preserve the original formatting, e.g. 'X', 'o'. 468 if (!cast<PrintfConversionSpecifier>(CS).isUIntArg()) 469 CS.setKind(ConversionSpecifier::uArg); 470 HasAlternativeForm = 0; 471 HasPlusPrefix = 0; 472 } else { 473 llvm_unreachable("Unexpected type"); 474 } 475 476 return true; 477} 478 479void PrintfSpecifier::toString(raw_ostream &os) const { 480 // Whilst some features have no defined order, we are using the order 481 // appearing in the C99 standard (ISO/IEC 9899:1999 (E) 7.19.6.1) 482 os << "%"; 483 484 // Positional args 485 if (usesPositionalArg()) { 486 os << getPositionalArgIndex() << "$"; 487 } 488 489 // Conversion flags 490 if (IsLeftJustified) os << "-"; 491 if (HasPlusPrefix) os << "+"; 492 if (HasSpacePrefix) os << " "; 493 if (HasAlternativeForm) os << "#"; 494 if (HasLeadingZeroes) os << "0"; 495 496 // Minimum field width 497 FieldWidth.toString(os); 498 // Precision 499 Precision.toString(os); 500 // Length modifier 501 os << LM.toString(); 502 // Conversion specifier 503 os << CS.toString(); 504} 505 506bool PrintfSpecifier::hasValidPlusPrefix() const { 507 if (!HasPlusPrefix) 508 return true; 509 510 // The plus prefix only makes sense for signed conversions 511 switch (CS.getKind()) { 512 case ConversionSpecifier::dArg: 513 case ConversionSpecifier::iArg: 514 case ConversionSpecifier::fArg: 515 case ConversionSpecifier::FArg: 516 case ConversionSpecifier::eArg: 517 case ConversionSpecifier::EArg: 518 case ConversionSpecifier::gArg: 519 case ConversionSpecifier::GArg: 520 case ConversionSpecifier::aArg: 521 case ConversionSpecifier::AArg: 522 return true; 523 524 default: 525 return false; 526 } 527} 528 529bool PrintfSpecifier::hasValidAlternativeForm() const { 530 if (!HasAlternativeForm) 531 return true; 532 533 // Alternate form flag only valid with the oxXaAeEfFgG conversions 534 switch (CS.getKind()) { 535 case ConversionSpecifier::oArg: 536 case ConversionSpecifier::xArg: 537 case ConversionSpecifier::XArg: 538 case ConversionSpecifier::aArg: 539 case ConversionSpecifier::AArg: 540 case ConversionSpecifier::eArg: 541 case ConversionSpecifier::EArg: 542 case ConversionSpecifier::fArg: 543 case ConversionSpecifier::FArg: 544 case ConversionSpecifier::gArg: 545 case ConversionSpecifier::GArg: 546 return true; 547 548 default: 549 return false; 550 } 551} 552 553bool PrintfSpecifier::hasValidLeadingZeros() const { 554 if (!HasLeadingZeroes) 555 return true; 556 557 // Leading zeroes flag only valid with the diouxXaAeEfFgG conversions 558 switch (CS.getKind()) { 559 case ConversionSpecifier::dArg: 560 case ConversionSpecifier::iArg: 561 case ConversionSpecifier::oArg: 562 case ConversionSpecifier::uArg: 563 case ConversionSpecifier::xArg: 564 case ConversionSpecifier::XArg: 565 case ConversionSpecifier::aArg: 566 case ConversionSpecifier::AArg: 567 case ConversionSpecifier::eArg: 568 case ConversionSpecifier::EArg: 569 case ConversionSpecifier::fArg: 570 case ConversionSpecifier::FArg: 571 case ConversionSpecifier::gArg: 572 case ConversionSpecifier::GArg: 573 return true; 574 575 default: 576 return false; 577 } 578} 579 580bool PrintfSpecifier::hasValidSpacePrefix() const { 581 if (!HasSpacePrefix) 582 return true; 583 584 // The space prefix only makes sense for signed conversions 585 switch (CS.getKind()) { 586 case ConversionSpecifier::dArg: 587 case ConversionSpecifier::iArg: 588 case ConversionSpecifier::fArg: 589 case ConversionSpecifier::FArg: 590 case ConversionSpecifier::eArg: 591 case ConversionSpecifier::EArg: 592 case ConversionSpecifier::gArg: 593 case ConversionSpecifier::GArg: 594 case ConversionSpecifier::aArg: 595 case ConversionSpecifier::AArg: 596 return true; 597 598 default: 599 return false; 600 } 601} 602 603bool PrintfSpecifier::hasValidLeftJustified() const { 604 if (!IsLeftJustified) 605 return true; 606 607 // The left justified flag is valid for all conversions except n 608 switch (CS.getKind()) { 609 case ConversionSpecifier::nArg: 610 return false; 611 612 default: 613 return true; 614 } 615} 616 617bool PrintfSpecifier::hasValidThousandsGroupingPrefix() const { 618 if (!HasThousandsGrouping) 619 return true; 620 621 switch (CS.getKind()) { 622 case ConversionSpecifier::dArg: 623 case ConversionSpecifier::iArg: 624 case ConversionSpecifier::uArg: 625 case ConversionSpecifier::fArg: 626 case ConversionSpecifier::FArg: 627 case ConversionSpecifier::gArg: 628 case ConversionSpecifier::GArg: 629 return true; 630 default: 631 return false; 632 } 633} 634 635bool PrintfSpecifier::hasValidPrecision() const { 636 if (Precision.getHowSpecified() == OptionalAmount::NotSpecified) 637 return true; 638 639 // Precision is only valid with the diouxXaAeEfFgGs conversions 640 switch (CS.getKind()) { 641 case ConversionSpecifier::dArg: 642 case ConversionSpecifier::iArg: 643 case ConversionSpecifier::oArg: 644 case ConversionSpecifier::uArg: 645 case ConversionSpecifier::xArg: 646 case ConversionSpecifier::XArg: 647 case ConversionSpecifier::aArg: 648 case ConversionSpecifier::AArg: 649 case ConversionSpecifier::eArg: 650 case ConversionSpecifier::EArg: 651 case ConversionSpecifier::fArg: 652 case ConversionSpecifier::FArg: 653 case ConversionSpecifier::gArg: 654 case ConversionSpecifier::GArg: 655 case ConversionSpecifier::sArg: 656 return true; 657 658 default: 659 return false; 660 } 661} 662bool PrintfSpecifier::hasValidFieldWidth() const { 663 if (FieldWidth.getHowSpecified() == OptionalAmount::NotSpecified) 664 return true; 665 666 // The field width is valid for all conversions except n 667 switch (CS.getKind()) { 668 case ConversionSpecifier::nArg: 669 return false; 670 671 default: 672 return true; 673 } 674} 675