contrib/llvm/tools/clang/lib/Analysis/PrintfFormatString.cpp

   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 #include "clang/Basic/TargetInfo.h"
  18
  19 using clang::analyze_format_string::ArgType;
  20 using clang::analyze_format_string::FormatStringHandler;
  21 using clang::analyze_format_string::LengthModifier;
  22 using clang::analyze_format_string::OptionalAmount;
  23 using clang::analyze_format_string::ConversionSpecifier;
  24 using clang::analyze_printf::PrintfSpecifier;
  25
  26 using namespace clang;
  27
  28 typedef clang::analyze_format_string::SpecifierResult<PrintfSpecifier>
  29         PrintfSpecifierResult;
  30
  31 //===----------------------------------------------------------------------===//
  32 // Methods for parsing format strings.
  33 //===----------------------------------------------------------------------===//
  34
  35 using analyze_format_string::ParseNonPositionAmount;
  36
  37 static bool ParsePrecision(FormatStringHandler &H, PrintfSpecifier &FS,
  38                            const char *Start, const char *&Beg, const char *E,
  39                            unsigned *argIndex) {
  40   if (argIndex) {
  41     FS.setPrecision(ParseNonPositionAmount(Beg, E, *argIndex));
  42   } else {
  43     const OptionalAmount Amt = ParsePositionAmount(H, Start, Beg, E,
  44                                            analyze_format_string::PrecisionPos);
  45     if (Amt.isInvalid())
  46       return true;
  47     FS.setPrecision(Amt);
  48   }
  49   return false;
  50 }
  51
  52 static bool ParseObjCFlags(FormatStringHandler &H, PrintfSpecifier &FS,
  53                            const char *FlagBeg, const char *E, bool Warn) {
  54    StringRef Flag(FlagBeg, E - FlagBeg);
  55    // Currently there is only one flag.
  56    if (Flag == "tt") {
  57      FS.setHasObjCTechnicalTerm(FlagBeg);
  58      return false;
  59    }
  60    // Handle either the case of no flag or an invalid flag.
  61    if (Warn) {
  62      if (Flag == "")
  63        H.HandleEmptyObjCModifierFlag(FlagBeg, E  - FlagBeg);
  64      else
  65        H.HandleInvalidObjCModifierFlag(FlagBeg, E  - FlagBeg);
  66    }
  67    return true;
  68 }
  69
  70 static PrintfSpecifierResult ParsePrintfSpecifier(FormatStringHandler &H,
  71                                                   const char *&Beg,
  72                                                   const char *E,
  73                                                   unsigned &argIndex,
  74                                                   const LangOptions &LO,
  75                                                   const TargetInfo &Target,
  76                                                   bool Warn,
  77                                                   bool isFreeBSDKPrintf) {
  78
  79   using namespace clang::analyze_format_string;
  80   using namespace clang::analyze_printf;
  81
  82   const char *I = Beg;
  83   const char *Start = nullptr;
  84   UpdateOnReturn <const char*> UpdateBeg(Beg, I);
  85
  86   // Look for a '%' character that indicates the start of a format specifier.
  87   for ( ; I != E ; ++I) {
  88     char c = *I;
  89     if (c == '\0') {
  90       // Detect spurious null characters, which are likely errors.
  91       H.HandleNullChar(I);
  92       return true;
  93     }
  94     if (c == '%') {
  95       Start = I++;  // Record the start of the format specifier.
  96       break;
  97     }
  98   }
  99
 100   // No format specifier found?
 101   if (!Start)
 102     return false;
 103
 104   if (I == E) {
 105     // No more characters left?
 106     if (Warn)
 107       H.HandleIncompleteSpecifier(Start, E - Start);
 108     return true;
 109   }
 110
 111   PrintfSpecifier FS;
 112   if (ParseArgPosition(H, FS, Start, I, E))
 113     return true;
 114
 115   if (I == E) {
 116     // No more characters left?
 117     if (Warn)
 118       H.HandleIncompleteSpecifier(Start, E - Start);
 119     return true;
 120   }
 121
 122   const char *OSLogVisibilityFlagsStart = nullptr,
 123              *OSLogVisibilityFlagsEnd = nullptr;
 124   if (*I == '{') {
 125     OSLogVisibilityFlagsStart = I++;
 126     // Find the end of the modifier.
 127     while (I != E && *I != '}') {
 128       I++;
 129     }
 130     if (I == E) {
 131       if (Warn)
 132         H.HandleIncompleteSpecifier(Start, E - Start);
 133       return true;
 134     }
 135     assert(*I == '}');
 136     OSLogVisibilityFlagsEnd = I++;
 137
 138     // Just see if 'private' or 'public' is the first word. os_log itself will
 139     // do any further parsing.
 140     const char *P = OSLogVisibilityFlagsStart + 1;
 141     while (P < OSLogVisibilityFlagsEnd && isspace(*P))
 142       P++;
 143     const char *WordStart = P;
 144     while (P < OSLogVisibilityFlagsEnd && (isalnum(*P) || *P == '_'))
 145       P++;
 146     const char *WordEnd = P;
 147     StringRef Word(WordStart, WordEnd - WordStart);
 148     if (Word == "private") {
 149       FS.setIsPrivate(WordStart);
 150     } else if (Word == "public") {
 151       FS.setIsPublic(WordStart);
 152     }
 153   }
 154
 155   // Look for flags (if any).
 156   bool hasMore = true;
 157   for ( ; I != E; ++I) {
 158     switch (*I) {
 159       default: hasMore = false; break;
 160       case '\'':
 161         // FIXME: POSIX specific.  Always accept?
 162         FS.setHasThousandsGrouping(I);
 163         break;
 164       case '-': FS.setIsLeftJustified(I); break;
 165       case '+': FS.setHasPlusPrefix(I); break;
 166       case ' ': FS.setHasSpacePrefix(I); break;
 167       case '#': FS.setHasAlternativeForm(I); break;
 168       case '0': FS.setHasLeadingZeros(I); break;
 169     }
 170     if (!hasMore)
 171       break;
 172   }
 173
 174   if (I == E) {
 175     // No more characters left?
 176     if (Warn)
 177       H.HandleIncompleteSpecifier(Start, E - Start);
 178     return true;
 179   }
 180
 181   // Look for the field width (if any).
 182   if (ParseFieldWidth(H, FS, Start, I, E,
 183                       FS.usesPositionalArg() ? nullptr : &argIndex))
 184     return true;
 185
 186   if (I == E) {
 187     // No more characters left?
 188     if (Warn)
 189       H.HandleIncompleteSpecifier(Start, E - Start);
 190     return true;
 191   }
 192
 193   // Look for the precision (if any).
 194   if (*I == '.') {
 195     ++I;
 196     if (I == E) {
 197       if (Warn)
 198         H.HandleIncompleteSpecifier(Start, E - Start);
 199       return true;
 200     }
 201
 202     if (ParsePrecision(H, FS, Start, I, E,
 203                        FS.usesPositionalArg() ? nullptr : &argIndex))
 204       return true;
 205
 206     if (I == E) {
 207       // No more characters left?
 208       if (Warn)
 209         H.HandleIncompleteSpecifier(Start, E - Start);
 210       return true;
 211     }
 212   }
 213
 214   // Look for the length modifier.
 215   if (ParseLengthModifier(FS, I, E, LO) && I == E) {
 216     // No more characters left?
 217     if (Warn)
 218       H.HandleIncompleteSpecifier(Start, E - Start);
 219     return true;
 220   }
 221
 222   // Look for the Objective-C modifier flags, if any.
 223   // We parse these here, even if they don't apply to
 224   // the conversion specifier, and then emit an error
 225   // later if the conversion specifier isn't '@'.  This
 226   // enables better recovery, and we don't know if
 227   // these flags are applicable until later.
 228   const char *ObjCModifierFlagsStart = nullptr,
 229              *ObjCModifierFlagsEnd = nullptr;
 230   if (*I == '[') {
 231     ObjCModifierFlagsStart = I;
 232     ++I;
 233     auto flagStart = I;
 234     for (;; ++I) {
 235       ObjCModifierFlagsEnd = I;
 236       if (I == E) {
 237         if (Warn)
 238           H.HandleIncompleteSpecifier(Start, E - Start);
 239         return true;
 240       }
 241       // Did we find the closing ']'?
 242       if (*I == ']') {
 243         if (ParseObjCFlags(H, FS, flagStart, I, Warn))
 244           return true;
 245         ++I;
 246         break;
 247       }
 248       // There are no separators defined yet for multiple
 249       // Objective-C modifier flags.  When those are
 250       // defined, this is the place to check.
 251     }
 252   }
 253
 254   if (*I == '\0') {
 255     // Detect spurious null characters, which are likely errors.
 256     H.HandleNullChar(I);
 257     return true;
 258   }
 259
 260   // Finally, look for the conversion specifier.
 261   const char *conversionPosition = I++;
 262   ConversionSpecifier::Kind k = ConversionSpecifier::InvalidSpecifier;
 263   switch (*conversionPosition) {
 264     default:
 265       break;
 266     // C99: 7.19.6.1 (section 8).
 267     case '%': k = ConversionSpecifier::PercentArg;   break;
 268     case 'A': k = ConversionSpecifier::AArg; break;
 269     case 'E': k = ConversionSpecifier::EArg; break;
 270     case 'F': k = ConversionSpecifier::FArg; break;
 271     case 'G': k = ConversionSpecifier::GArg; break;
 272     case 'X': k = ConversionSpecifier::XArg; break;
 273     case 'a': k = ConversionSpecifier::aArg; break;
 274     case 'c': k = ConversionSpecifier::cArg; break;
 275     case 'd': k = ConversionSpecifier::dArg; break;
 276     case 'e': k = ConversionSpecifier::eArg; break;
 277     case 'f': k = ConversionSpecifier::fArg; break;
 278     case 'g': k = ConversionSpecifier::gArg; break;
 279     case 'i': k = ConversionSpecifier::iArg; break;
 280     case 'n': k = ConversionSpecifier::nArg; break;
 281     case 'o': k = ConversionSpecifier::oArg; break;
 282     case 'p': k = ConversionSpecifier::pArg; break;
 283     case 's': k = ConversionSpecifier::sArg; break;
 284     case 'u': k = ConversionSpecifier::uArg; break;
 285     case 'x': k = ConversionSpecifier::xArg; break;
 286     // POSIX specific.
 287     case 'C': k = ConversionSpecifier::CArg; break;
 288     case 'S': k = ConversionSpecifier::SArg; break;
 289     // Apple extension for os_log
 290     case 'P':
 291       k = ConversionSpecifier::PArg;
 292       break;
 293     // Objective-C.
 294     case '@': k = ConversionSpecifier::ObjCObjArg; break;
 295     // Glibc specific.
 296     case 'm': k = ConversionSpecifier::PrintErrno; break;
 297     // FreeBSD kernel specific.
 298     case 'b':
 299       if (isFreeBSDKPrintf)
 300         k = ConversionSpecifier::FreeBSDbArg; // int followed by char *
 301       break;
 302     case 'r':
 303       if (isFreeBSDKPrintf)
 304         k = ConversionSpecifier::FreeBSDrArg; // int
 305       break;
 306     case 'y':
 307       if (isFreeBSDKPrintf)
 308         k = ConversionSpecifier::FreeBSDyArg; // int
 309       break;
 310     // Apple-specific.
 311     case 'D':
 312       if (isFreeBSDKPrintf)
 313         k = ConversionSpecifier::FreeBSDDArg; // void * followed by char *
 314       else if (Target.getTriple().isOSDarwin())
 315         k = ConversionSpecifier::DArg;
 316       break;
 317     case 'O':
 318       if (Target.getTriple().isOSDarwin())
 319         k = ConversionSpecifier::OArg;
 320       break;
 321     case 'U':
 322       if (Target.getTriple().isOSDarwin())
 323         k = ConversionSpecifier::UArg;
 324       break;
 325     // MS specific.
 326     case 'Z':
 327       if (Target.getTriple().isOSMSVCRT())
 328         k = ConversionSpecifier::ZArg;
 329   }
 330
 331   // Check to see if we used the Objective-C modifier flags with
 332   // a conversion specifier other than '@'.
 333   if (k != ConversionSpecifier::ObjCObjArg &&
 334       k != ConversionSpecifier::InvalidSpecifier &&
 335       ObjCModifierFlagsStart) {
 336     H.HandleObjCFlagsWithNonObjCConversion(ObjCModifierFlagsStart,
 337                                            ObjCModifierFlagsEnd + 1,
 338                                            conversionPosition);
 339     return true;
 340   }
 341
 342   PrintfConversionSpecifier CS(conversionPosition, k);
 343   FS.setConversionSpecifier(CS);
 344   if (CS.consumesDataArgument() && !FS.usesPositionalArg())
 345     FS.setArgIndex(argIndex++);
 346   // FreeBSD kernel specific.
 347   if (k == ConversionSpecifier::FreeBSDbArg ||
 348       k == ConversionSpecifier::FreeBSDDArg)
 349     argIndex++;
 350
 351   if (k == ConversionSpecifier::InvalidSpecifier) {
 352     unsigned Len = I - Start;
 353     if (ParseUTF8InvalidSpecifier(Start, E, Len)) {
 354       CS.setEndScanList(Start + Len);
 355       FS.setConversionSpecifier(CS);
 356     }
 357     // Assume the conversion takes one argument.
 358     return !H.HandleInvalidPrintfConversionSpecifier(FS, Start, Len);
 359   }
 360   return PrintfSpecifierResult(Start, FS);
 361 }
 362
 363 bool clang::analyze_format_string::ParsePrintfString(FormatStringHandler &H,
 364                                                      const char *I,
 365                                                      const char *E,
 366                                                      const LangOptions &LO,
 367                                                      const TargetInfo &Target,
 368                                                      bool isFreeBSDKPrintf) {
 369
 370   unsigned argIndex = 0;
 371
 372   // Keep looking for a format specifier until we have exhausted the string.
 373   while (I != E) {
 374     const PrintfSpecifierResult &FSR = ParsePrintfSpecifier(H, I, E, argIndex,
 375                                                             LO, Target, true,
 376                                                             isFreeBSDKPrintf);
 377     // Did a fail-stop error of any kind occur when parsing the specifier?
 378     // If so, don't do any more processing.
 379     if (FSR.shouldStop())
 380       return true;
 381     // Did we exhaust the string or encounter an error that
 382     // we can recover from?
 383     if (!FSR.hasValue())
 384       continue;
 385     // We have a format specifier.  Pass it to the callback.
 386     if (!H.HandlePrintfSpecifier(FSR.getValue(), FSR.getStart(),
 387                                  I - FSR.getStart()))
 388       return true;
 389   }
 390   assert(I == E && "Format string not exhausted");
 391   return false;
 392 }
 393
 394 bool clang::analyze_format_string::ParseFormatStringHasSArg(const char *I,
 395                                                             const char *E,
 396                                                             const LangOptions &LO,
 397                                                             const TargetInfo &Target) {
 398
 399   unsigned argIndex = 0;
 400
 401   // Keep looking for a %s format specifier until we have exhausted the string.
 402   FormatStringHandler H;
 403   while (I != E) {
 404     const PrintfSpecifierResult &FSR = ParsePrintfSpecifier(H, I, E, argIndex,
 405                                                             LO, Target, false,
 406                                                             false);
 407     // Did a fail-stop error of any kind occur when parsing the specifier?
 408     // If so, don't do any more processing.
 409     if (FSR.shouldStop())
 410       return false;
 411     // Did we exhaust the string or encounter an error that
 412     // we can recover from?
 413     if (!FSR.hasValue())
 414       continue;
 415     const analyze_printf::PrintfSpecifier &FS = FSR.getValue();
 416     // Return true if this a %s format specifier.
 417     if (FS.getConversionSpecifier().getKind() == ConversionSpecifier::Kind::sArg)
 418       return true;
 419   }
 420   return false;
 421 }
 422
 423 //===----------------------------------------------------------------------===//
 424 // Methods on PrintfSpecifier.
 425 //===----------------------------------------------------------------------===//
 426
 427 ArgType PrintfSpecifier::getArgType(ASTContext &Ctx,
 428                                     bool IsObjCLiteral) const {
 429   const PrintfConversionSpecifier &CS = getConversionSpecifier();
 430
 431   if (!CS.consumesDataArgument())
 432     return ArgType::Invalid();
 433
 434   if (CS.getKind() == ConversionSpecifier::cArg)
 435     switch (LM.getKind()) {
 436       case LengthModifier::None:
 437         return Ctx.IntTy;
 438       case LengthModifier::AsLong:
 439       case LengthModifier::AsWide:
 440         return ArgType(ArgType::WIntTy, "wint_t");
 441       case LengthModifier::AsShort:
 442         if (Ctx.getTargetInfo().getTriple().isOSMSVCRT())
 443           return Ctx.IntTy;
 444         LLVM_FALLTHROUGH;
 445       default:
 446         return ArgType::Invalid();
 447     }
 448
 449   if (CS.isIntArg())
 450     switch (LM.getKind()) {
 451       case LengthModifier::AsLongDouble:
 452         // GNU extension.
 453         return Ctx.LongLongTy;
 454       case LengthModifier::None:
 455         return Ctx.IntTy;
 456       case LengthModifier::AsInt32:
 457         return ArgType(Ctx.IntTy, "__int32");
 458       case LengthModifier::AsChar: return ArgType::AnyCharTy;
 459       case LengthModifier::AsShort: return Ctx.ShortTy;
 460       case LengthModifier::AsLong: return Ctx.LongTy;
 461       case LengthModifier::AsLongLong:
 462       case LengthModifier::AsQuad:
 463         return Ctx.LongLongTy;
 464       case LengthModifier::AsInt64:
 465         return ArgType(Ctx.LongLongTy, "__int64");
 466       case LengthModifier::AsIntMax:
 467         return ArgType(Ctx.getIntMaxType(), "intmax_t");
 468       case LengthModifier::AsSizeT:
 469         // FIXME: How to get the corresponding signed version of size_t?
 470         return ArgType();
 471       case LengthModifier::AsInt3264:
 472         return Ctx.getTargetInfo().getTriple().isArch64Bit()
 473                    ? ArgType(Ctx.LongLongTy, "__int64")
 474                    : ArgType(Ctx.IntTy, "__int32");
 475       case LengthModifier::AsPtrDiff:
 476         return ArgType(Ctx.getPointerDiffType(), "ptrdiff_t");
 477       case LengthModifier::AsAllocate:
 478       case LengthModifier::AsMAllocate:
 479       case LengthModifier::AsWide:
 480         return ArgType::Invalid();
 481     }
 482
 483   if (CS.isUIntArg())
 484     switch (LM.getKind()) {
 485       case LengthModifier::AsLongDouble:
 486         // GNU extension.
 487         return Ctx.UnsignedLongLongTy;
 488       case LengthModifier::None:
 489         return Ctx.UnsignedIntTy;
 490       case LengthModifier::AsInt32:
 491         return ArgType(Ctx.UnsignedIntTy, "unsigned __int32");
 492       case LengthModifier::AsChar: return Ctx.UnsignedCharTy;
 493       case LengthModifier::AsShort: return Ctx.UnsignedShortTy;
 494       case LengthModifier::AsLong: return Ctx.UnsignedLongTy;
 495       case LengthModifier::AsLongLong:
 496       case LengthModifier::AsQuad:
 497         return Ctx.UnsignedLongLongTy;
 498       case LengthModifier::AsInt64:
 499         return ArgType(Ctx.UnsignedLongLongTy, "unsigned __int64");
 500       case LengthModifier::AsIntMax:
 501         return ArgType(Ctx.getUIntMaxType(), "uintmax_t");
 502       case LengthModifier::AsSizeT:
 503         return ArgType(Ctx.getSizeType(), "size_t");
 504       case LengthModifier::AsInt3264:
 505         return Ctx.getTargetInfo().getTriple().isArch64Bit()
 506                    ? ArgType(Ctx.UnsignedLongLongTy, "unsigned __int64")
 507                    : ArgType(Ctx.UnsignedIntTy, "unsigned __int32");
 508       case LengthModifier::AsPtrDiff:
 509         // FIXME: How to get the corresponding unsigned
 510         // version of ptrdiff_t?
 511         return ArgType();
 512       case LengthModifier::AsAllocate:
 513       case LengthModifier::AsMAllocate:
 514       case LengthModifier::AsWide:
 515         return ArgType::Invalid();
 516     }
 517
 518   if (CS.isDoubleArg()) {
 519     if (LM.getKind() == LengthModifier::AsLongDouble)
 520       return Ctx.LongDoubleTy;
 521     return Ctx.DoubleTy;
 522   }
 523
 524   if (CS.getKind() == ConversionSpecifier::nArg) {
 525     switch (LM.getKind()) {
 526       case LengthModifier::None:
 527         return ArgType::PtrTo(Ctx.IntTy);
 528       case LengthModifier::AsChar:
 529         return ArgType::PtrTo(Ctx.SignedCharTy);
 530       case LengthModifier::AsShort:
 531         return ArgType::PtrTo(Ctx.ShortTy);
 532       case LengthModifier::AsLong:
 533         return ArgType::PtrTo(Ctx.LongTy);
 534       case LengthModifier::AsLongLong:
 535       case LengthModifier::AsQuad:
 536         return ArgType::PtrTo(Ctx.LongLongTy);
 537       case LengthModifier::AsIntMax:
 538         return ArgType::PtrTo(ArgType(Ctx.getIntMaxType(), "intmax_t"));
 539       case LengthModifier::AsSizeT:
 540         return ArgType(); // FIXME: ssize_t
 541       case LengthModifier::AsPtrDiff:
 542         return ArgType::PtrTo(ArgType(Ctx.getPointerDiffType(), "ptrdiff_t"));
 543       case LengthModifier::AsLongDouble:
 544         return ArgType(); // FIXME: Is this a known extension?
 545       case LengthModifier::AsAllocate:
 546       case LengthModifier::AsMAllocate:
 547       case LengthModifier::AsInt32:
 548       case LengthModifier::AsInt3264:
 549       case LengthModifier::AsInt64:
 550       case LengthModifier::AsWide:
 551         return ArgType::Invalid();
 552     }
 553   }
 554
 555   switch (CS.getKind()) {
 556     case ConversionSpecifier::sArg:
 557       if (LM.getKind() == LengthModifier::AsWideChar) {
 558         if (IsObjCLiteral)
 559           return ArgType(Ctx.getPointerType(Ctx.UnsignedShortTy.withConst()),
 560                          "const unichar *");
 561         return ArgType(ArgType::WCStrTy, "wchar_t *");
 562       }
 563       if (LM.getKind() == LengthModifier::AsWide)
 564         return ArgType(ArgType::WCStrTy, "wchar_t *");
 565       return ArgType::CStrTy;
 566     case ConversionSpecifier::SArg:
 567       if (IsObjCLiteral)
 568         return ArgType(Ctx.getPointerType(Ctx.UnsignedShortTy.withConst()),
 569                        "const unichar *");
 570       if (Ctx.getTargetInfo().getTriple().isOSMSVCRT() &&
 571           LM.getKind() == LengthModifier::AsShort)
 572         return ArgType::CStrTy;
 573       return ArgType(ArgType::WCStrTy, "wchar_t *");
 574     case ConversionSpecifier::CArg:
 575       if (IsObjCLiteral)
 576         return ArgType(Ctx.UnsignedShortTy, "unichar");
 577       if (Ctx.getTargetInfo().getTriple().isOSMSVCRT() &&
 578           LM.getKind() == LengthModifier::AsShort)
 579         return Ctx.IntTy;
 580       return ArgType(Ctx.WideCharTy, "wchar_t");
 581     case ConversionSpecifier::pArg:
 582     case ConversionSpecifier::PArg:
 583       return ArgType::CPointerTy;
 584     case ConversionSpecifier::ObjCObjArg:
 585       return ArgType::ObjCPointerTy;
 586     default:
 587       break;
 588   }
 589
 590   // FIXME: Handle other cases.
 591   return ArgType();
 592 }
 593
 594 bool PrintfSpecifier::fixType(QualType QT, const LangOptions &LangOpt,
 595                               ASTContext &Ctx, bool IsObjCLiteral) {
 596   // %n is different from other conversion specifiers; don't try to fix it.
 597   if (CS.getKind() == ConversionSpecifier::nArg)
 598     return false;
 599
 600   // Handle Objective-C objects first. Note that while the '%@' specifier will
 601   // not warn for structure pointer or void pointer arguments (because that's
 602   // how CoreFoundation objects are implemented), we only show a fixit for '%@'
 603   // if we know it's an object (block, id, class, or __attribute__((NSObject))).
 604   if (QT->isObjCRetainableType()) {
 605     if (!IsObjCLiteral)
 606       return false;
 607
 608     CS.setKind(ConversionSpecifier::ObjCObjArg);
 609
 610     // Disable irrelevant flags
 611     HasThousandsGrouping = false;
 612     HasPlusPrefix = false;
 613     HasSpacePrefix = false;
 614     HasAlternativeForm = false;
 615     HasLeadingZeroes = false;
 616     Precision.setHowSpecified(OptionalAmount::NotSpecified);
 617     LM.setKind(LengthModifier::None);
 618
 619     return true;
 620   }
 621
 622   // Handle strings next (char *, wchar_t *)
 623   if (QT->isPointerType() && (QT->getPointeeType()->isAnyCharacterType())) {
 624     CS.setKind(ConversionSpecifier::sArg);
 625
 626     // Disable irrelevant flags
 627     HasAlternativeForm = 0;
 628     HasLeadingZeroes = 0;
 629
 630     // Set the long length modifier for wide characters
 631     if (QT->getPointeeType()->isWideCharType())
 632       LM.setKind(LengthModifier::AsWideChar);
 633     else
 634       LM.setKind(LengthModifier::None);
 635
 636     return true;
 637   }
 638
 639   // If it's an enum, get its underlying type.
 640   if (const EnumType *ETy = QT->getAs<EnumType>())
 641     QT = ETy->getDecl()->getIntegerType();
 642
 643   // We can only work with builtin types.
 644   const BuiltinType *BT = QT->getAs<BuiltinType>();
 645   if (!BT)
 646     return false;
 647
 648   // Set length modifier
 649   switch (BT->getKind()) {
 650   case BuiltinType::Bool:
 651   case BuiltinType::WChar_U:
 652   case BuiltinType::WChar_S:
 653   case BuiltinType::Char16:
 654   case BuiltinType::Char32:
 655   case BuiltinType::UInt128:
 656   case BuiltinType::Int128:
 657   case BuiltinType::Half:
 658   case BuiltinType::Float128:
 659     // Various types which are non-trivial to correct.
 660     return false;
 661
 662 #define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
 663   case BuiltinType::Id:
 664 #include "clang/Basic/OpenCLImageTypes.def"
 665 #define SIGNED_TYPE(Id, SingletonId)
 666 #define UNSIGNED_TYPE(Id, SingletonId)
 667 #define FLOATING_TYPE(Id, SingletonId)
 668 #define BUILTIN_TYPE(Id, SingletonId) \
 669   case BuiltinType::Id:
 670 #include "clang/AST/BuiltinTypes.def"
 671     // Misc other stuff which doesn't make sense here.
 672     return false;
 673
 674   case BuiltinType::UInt:
 675   case BuiltinType::Int:
 676   case BuiltinType::Float:
 677   case BuiltinType::Double:
 678     LM.setKind(LengthModifier::None);
 679     break;
 680
 681   case BuiltinType::Char_U:
 682   case BuiltinType::UChar:
 683   case BuiltinType::Char_S:
 684   case BuiltinType::SChar:
 685     LM.setKind(LengthModifier::AsChar);
 686     break;
 687
 688   case BuiltinType::Short:
 689   case BuiltinType::UShort:
 690     LM.setKind(LengthModifier::AsShort);
 691     break;
 692
 693   case BuiltinType::Long:
 694   case BuiltinType::ULong:
 695     LM.setKind(LengthModifier::AsLong);
 696     break;
 697
 698   case BuiltinType::LongLong:
 699   case BuiltinType::ULongLong:
 700     LM.setKind(LengthModifier::AsLongLong);
 701     break;
 702
 703   case BuiltinType::LongDouble:
 704     LM.setKind(LengthModifier::AsLongDouble);
 705     break;
 706   }
 707
 708   // Handle size_t, ptrdiff_t, etc. that have dedicated length modifiers in C99.
 709   if (isa<TypedefType>(QT) && (LangOpt.C99 || LangOpt.CPlusPlus11))
 710     namedTypeToLengthModifier(QT, LM);
 711
 712   // If fixing the length modifier was enough, we might be done.
 713   if (hasValidLengthModifier(Ctx.getTargetInfo())) {
 714     // If we're going to offer a fix anyway, make sure the sign matches.
 715     switch (CS.getKind()) {
 716     case ConversionSpecifier::uArg:
 717     case ConversionSpecifier::UArg:
 718       if (QT->isSignedIntegerType())
 719         CS.setKind(clang::analyze_format_string::ConversionSpecifier::dArg);
 720       break;
 721     case ConversionSpecifier::dArg:
 722     case ConversionSpecifier::DArg:
 723     case ConversionSpecifier::iArg:
 724       if (QT->isUnsignedIntegerType() && !HasPlusPrefix)
 725         CS.setKind(clang::analyze_format_string::ConversionSpecifier::uArg);
 726       break;
 727     default:
 728       // Other specifiers do not have signed/unsigned variants.
 729       break;
 730     }
 731
 732     const analyze_printf::ArgType &ATR = getArgType(Ctx, IsObjCLiteral);
 733     if (ATR.isValid() && ATR.matchesType(Ctx, QT))
 734       return true;
 735   }
 736
 737   // Set conversion specifier and disable any flags which do not apply to it.
 738   // Let typedefs to char fall through to int, as %c is silly for uint8_t.
 739   if (!isa<TypedefType>(QT) && QT->isCharType()) {
 740     CS.setKind(ConversionSpecifier::cArg);
 741     LM.setKind(LengthModifier::None);
 742     Precision.setHowSpecified(OptionalAmount::NotSpecified);
 743     HasAlternativeForm = 0;
 744     HasLeadingZeroes = 0;
 745     HasPlusPrefix = 0;
 746   }
 747   // Test for Floating type first as LongDouble can pass isUnsignedIntegerType
 748   else if (QT->isRealFloatingType()) {
 749     CS.setKind(ConversionSpecifier::fArg);
 750   }
 751   else if (QT->isSignedIntegerType()) {
 752     CS.setKind(ConversionSpecifier::dArg);
 753     HasAlternativeForm = 0;
 754   }
 755   else if (QT->isUnsignedIntegerType()) {
 756     CS.setKind(ConversionSpecifier::uArg);
 757     HasAlternativeForm = 0;
 758     HasPlusPrefix = 0;
 759   } else {
 760     llvm_unreachable("Unexpected type");
 761   }
 762
 763   return true;
 764 }
 765
 766 void PrintfSpecifier::toString(raw_ostream &os) const {
 767   // Whilst some features have no defined order, we are using the order
 768   // appearing in the C99 standard (ISO/IEC 9899:1999 (E) 7.19.6.1)
 769   os << "%";
 770
 771   // Positional args
 772   if (usesPositionalArg()) {
 773     os << getPositionalArgIndex() << "$";
 774   }
 775
 776   // Conversion flags
 777   if (IsLeftJustified)    os << "-";
 778   if (HasPlusPrefix)      os << "+";
 779   if (HasSpacePrefix)     os << " ";
 780   if (HasAlternativeForm) os << "#";
 781   if (HasLeadingZeroes)   os << "0";
 782
 783   // Minimum field width
 784   FieldWidth.toString(os);
 785   // Precision
 786   Precision.toString(os);
 787   // Length modifier
 788   os << LM.toString();
 789   // Conversion specifier
 790   os << CS.toString();
 791 }
 792
 793 bool PrintfSpecifier::hasValidPlusPrefix() const {
 794   if (!HasPlusPrefix)
 795     return true;
 796
 797   // The plus prefix only makes sense for signed conversions
 798   switch (CS.getKind()) {
 799   case ConversionSpecifier::dArg:
 800   case ConversionSpecifier::DArg:
 801   case ConversionSpecifier::iArg:
 802   case ConversionSpecifier::fArg:
 803   case ConversionSpecifier::FArg:
 804   case ConversionSpecifier::eArg:
 805   case ConversionSpecifier::EArg:
 806   case ConversionSpecifier::gArg:
 807   case ConversionSpecifier::GArg:
 808   case ConversionSpecifier::aArg:
 809   case ConversionSpecifier::AArg:
 810   case ConversionSpecifier::FreeBSDrArg:
 811   case ConversionSpecifier::FreeBSDyArg:
 812     return true;
 813
 814   default:
 815     return false;
 816   }
 817 }
 818
 819 bool PrintfSpecifier::hasValidAlternativeForm() const {
 820   if (!HasAlternativeForm)
 821     return true;
 822
 823   // Alternate form flag only valid with the oxXaAeEfFgG conversions
 824   switch (CS.getKind()) {
 825   case ConversionSpecifier::oArg:
 826   case ConversionSpecifier::OArg:
 827   case ConversionSpecifier::xArg:
 828   case ConversionSpecifier::XArg:
 829   case ConversionSpecifier::aArg:
 830   case ConversionSpecifier::AArg:
 831   case ConversionSpecifier::eArg:
 832   case ConversionSpecifier::EArg:
 833   case ConversionSpecifier::fArg:
 834   case ConversionSpecifier::FArg:
 835   case ConversionSpecifier::gArg:
 836   case ConversionSpecifier::GArg:
 837   case ConversionSpecifier::FreeBSDrArg:
 838   case ConversionSpecifier::FreeBSDyArg:
 839     return true;
 840
 841   default:
 842     return false;
 843   }
 844 }
 845
 846 bool PrintfSpecifier::hasValidLeadingZeros() const {
 847   if (!HasLeadingZeroes)
 848     return true;
 849
 850   // Leading zeroes flag only valid with the diouxXaAeEfFgG conversions
 851   switch (CS.getKind()) {
 852   case ConversionSpecifier::dArg:
 853   case ConversionSpecifier::DArg:
 854   case ConversionSpecifier::iArg:
 855   case ConversionSpecifier::oArg:
 856   case ConversionSpecifier::OArg:
 857   case ConversionSpecifier::uArg:
 858   case ConversionSpecifier::UArg:
 859   case ConversionSpecifier::xArg:
 860   case ConversionSpecifier::XArg:
 861   case ConversionSpecifier::aArg:
 862   case ConversionSpecifier::AArg:
 863   case ConversionSpecifier::eArg:
 864   case ConversionSpecifier::EArg:
 865   case ConversionSpecifier::fArg:
 866   case ConversionSpecifier::FArg:
 867   case ConversionSpecifier::gArg:
 868   case ConversionSpecifier::GArg:
 869   case ConversionSpecifier::FreeBSDrArg:
 870   case ConversionSpecifier::FreeBSDyArg:
 871     return true;
 872
 873   default:
 874     return false;
 875   }
 876 }
 877
 878 bool PrintfSpecifier::hasValidSpacePrefix() const {
 879   if (!HasSpacePrefix)
 880     return true;
 881
 882   // The space prefix only makes sense for signed conversions
 883   switch (CS.getKind()) {
 884   case ConversionSpecifier::dArg:
 885   case ConversionSpecifier::DArg:
 886   case ConversionSpecifier::iArg:
 887   case ConversionSpecifier::fArg:
 888   case ConversionSpecifier::FArg:
 889   case ConversionSpecifier::eArg:
 890   case ConversionSpecifier::EArg:
 891   case ConversionSpecifier::gArg:
 892   case ConversionSpecifier::GArg:
 893   case ConversionSpecifier::aArg:
 894   case ConversionSpecifier::AArg:
 895   case ConversionSpecifier::FreeBSDrArg:
 896   case ConversionSpecifier::FreeBSDyArg:
 897     return true;
 898
 899   default:
 900     return false;
 901   }
 902 }
 903
 904 bool PrintfSpecifier::hasValidLeftJustified() const {
 905   if (!IsLeftJustified)
 906     return true;
 907
 908   // The left justified flag is valid for all conversions except n
 909   switch (CS.getKind()) {
 910   case ConversionSpecifier::nArg:
 911     return false;
 912
 913   default:
 914     return true;
 915   }
 916 }
 917
 918 bool PrintfSpecifier::hasValidThousandsGroupingPrefix() const {
 919   if (!HasThousandsGrouping)
 920     return true;
 921
 922   switch (CS.getKind()) {
 923     case ConversionSpecifier::dArg:
 924     case ConversionSpecifier::DArg:
 925     case ConversionSpecifier::iArg:
 926     case ConversionSpecifier::uArg:
 927     case ConversionSpecifier::UArg:
 928     case ConversionSpecifier::fArg:
 929     case ConversionSpecifier::FArg:
 930     case ConversionSpecifier::gArg:
 931     case ConversionSpecifier::GArg:
 932       return true;
 933     default:
 934       return false;
 935   }
 936 }
 937
 938 bool PrintfSpecifier::hasValidPrecision() const {
 939   if (Precision.getHowSpecified() == OptionalAmount::NotSpecified)
 940     return true;
 941
 942   // Precision is only valid with the diouxXaAeEfFgGsP conversions
 943   switch (CS.getKind()) {
 944   case ConversionSpecifier::dArg:
 945   case ConversionSpecifier::DArg:
 946   case ConversionSpecifier::iArg:
 947   case ConversionSpecifier::oArg:
 948   case ConversionSpecifier::OArg:
 949   case ConversionSpecifier::uArg:
 950   case ConversionSpecifier::UArg:
 951   case ConversionSpecifier::xArg:
 952   case ConversionSpecifier::XArg:
 953   case ConversionSpecifier::aArg:
 954   case ConversionSpecifier::AArg:
 955   case ConversionSpecifier::eArg:
 956   case ConversionSpecifier::EArg:
 957   case ConversionSpecifier::fArg:
 958   case ConversionSpecifier::FArg:
 959   case ConversionSpecifier::gArg:
 960   case ConversionSpecifier::GArg:
 961   case ConversionSpecifier::sArg:
 962   case ConversionSpecifier::FreeBSDrArg:
 963   case ConversionSpecifier::FreeBSDyArg:
 964   case ConversionSpecifier::PArg:
 965     return true;
 966
 967   default:
 968     return false;
 969   }
 970 }
 971 bool PrintfSpecifier::hasValidFieldWidth() const {
 972   if (FieldWidth.getHowSpecified() == OptionalAmount::NotSpecified)
 973       return true;
 974
 975   // The field width is valid for all conversions except n
 976   switch (CS.getKind()) {
 977   case ConversionSpecifier::nArg:
 978     return false;
 979
 980   default:
 981     return true;
 982   }
 983 }