blob: b52433a0a4ef64875963506045273d427336e59a [file] [log] [blame]
Ted Kremenek826a3452010-07-16 02:11:22 +00001//== PrintfFormatString.cpp - Analysis of printf format strings --*- C++ -*-==//
Ted Kremenek8f0a1c72010-01-27 23:43:25 +00002//
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
Ted Kremenek826a3452010-07-16 02:11:22 +000015#include "clang/Analysis/Analyses/FormatString.h"
16#include "FormatStringParsing.h"
Chandler Carruth55fc8732012-12-04 09:13:33 +000017#include "clang/Basic/TargetInfo.h"
Ted Kremenek8f0a1c72010-01-27 23:43:25 +000018
Hans Wennborgf3749f42012-08-07 08:11:26 +000019using clang::analyze_format_string::ArgType;
Ted Kremenek826a3452010-07-16 02:11:22 +000020using clang::analyze_format_string::FormatStringHandler;
21using clang::analyze_format_string::LengthModifier;
22using clang::analyze_format_string::OptionalAmount;
Ted Kremenek6ecb9502010-07-20 20:04:27 +000023using clang::analyze_format_string::ConversionSpecifier;
Ted Kremenek826a3452010-07-16 02:11:22 +000024using clang::analyze_printf::PrintfSpecifier;
Ted Kremenekefaff192010-02-27 01:41:03 +000025
Ted Kremenek808015a2010-01-29 03:16:21 +000026using namespace clang;
Ted Kremenek8f0a1c72010-01-27 23:43:25 +000027
Ted Kremenek826a3452010-07-16 02:11:22 +000028typedef clang::analyze_format_string::SpecifierResult<PrintfSpecifier>
29 PrintfSpecifierResult;
Ted Kremenek4e4b30e2010-02-16 01:46:59 +000030
31//===----------------------------------------------------------------------===//
32// Methods for parsing format strings.
33//===----------------------------------------------------------------------===//
Ted Kremenek8f0a1c72010-01-27 23:43:25 +000034
Ted Kremenek826a3452010-07-16 02:11:22 +000035using analyze_format_string::ParseNonPositionAmount;
Ted Kremenek4e4b30e2010-02-16 01:46:59 +000036
Ted Kremenek826a3452010-07-16 02:11:22 +000037static bool ParsePrecision(FormatStringHandler &H, PrintfSpecifier &FS,
Ted Kremenekefaff192010-02-27 01:41:03 +000038 const char *Start, const char *&Beg, const char *E,
39 unsigned *argIndex) {
40 if (argIndex) {
41 FS.setPrecision(ParseNonPositionAmount(Beg, E, *argIndex));
Chad Rosier30601782011-08-17 23:08:45 +000042 } else {
Ted Kremenekefaff192010-02-27 01:41:03 +000043 const OptionalAmount Amt = ParsePositionAmount(H, Start, Beg, E,
Ted Kremenek826a3452010-07-16 02:11:22 +000044 analyze_format_string::PrecisionPos);
Ted Kremenekefaff192010-02-27 01:41:03 +000045 if (Amt.isInvalid())
46 return true;
47 FS.setPrecision(Amt);
48 }
49 return false;
50}
51
Ted Kremenek826a3452010-07-16 02:11:22 +000052static PrintfSpecifierResult ParsePrintfSpecifier(FormatStringHandler &H,
Ted Kremenek74d56a12010-02-04 20:46:58 +000053 const char *&Beg,
Ted Kremenek7f70dc82010-02-26 19:18:41 +000054 const char *E,
Hans Wennborgd02deeb2011-12-15 10:25:47 +000055 unsigned &argIndex,
Jordan Rose275b6f52012-09-13 02:11:03 +000056 const LangOptions &LO,
57 const TargetInfo &Target) {
Ted Kremenek4e4b30e2010-02-16 01:46:59 +000058
Ted Kremenek6ecb9502010-07-20 20:04:27 +000059 using namespace clang::analyze_format_string;
Ted Kremenek4b220fa2010-01-29 02:13:53 +000060 using namespace clang::analyze_printf;
Ted Kremenek4e4b30e2010-02-16 01:46:59 +000061
Ted Kremenek8f0a1c72010-01-27 23:43:25 +000062 const char *I = Beg;
Ted Kremenekc7ae51a2010-01-28 00:02:05 +000063 const char *Start = 0;
Ted Kremenek8f0a1c72010-01-27 23:43:25 +000064 UpdateOnReturn <const char*> UpdateBeg(Beg, I);
65
66 // Look for a '%' character that indicates the start of a format specifier.
Ted Kremeneke729acb2010-01-28 23:56:52 +000067 for ( ; I != E ; ++I) {
Ted Kremenek8f0a1c72010-01-27 23:43:25 +000068 char c = *I;
Ted Kremenek8f0a1c72010-01-27 23:43:25 +000069 if (c == '\0') {
70 // Detect spurious null characters, which are likely errors.
71 H.HandleNullChar(I);
72 return true;
73 }
74 if (c == '%') {
Ted Kremeneke729acb2010-01-28 23:56:52 +000075 Start = I++; // Record the start of the format specifier.
Ted Kremenek8f0a1c72010-01-27 23:43:25 +000076 break;
77 }
78 }
Ted Kremenek4e4b30e2010-02-16 01:46:59 +000079
Ted Kremenek8f0a1c72010-01-27 23:43:25 +000080 // No format specifier found?
81 if (!Start)
82 return false;
Ted Kremenek4e4b30e2010-02-16 01:46:59 +000083
Ted Kremenek8f0a1c72010-01-27 23:43:25 +000084 if (I == E) {
85 // No more characters left?
Ted Kremenek826a3452010-07-16 02:11:22 +000086 H.HandleIncompleteSpecifier(Start, E - Start);
Ted Kremenek8f0a1c72010-01-27 23:43:25 +000087 return true;
88 }
Ted Kremenek4e4b30e2010-02-16 01:46:59 +000089
Ted Kremenek826a3452010-07-16 02:11:22 +000090 PrintfSpecifier FS;
Ted Kremenekefaff192010-02-27 01:41:03 +000091 if (ParseArgPosition(H, FS, Start, I, E))
92 return true;
93
94 if (I == E) {
95 // No more characters left?
Ted Kremenek826a3452010-07-16 02:11:22 +000096 H.HandleIncompleteSpecifier(Start, E - Start);
Ted Kremenekefaff192010-02-27 01:41:03 +000097 return true;
98 }
Ted Kremenek4e4b30e2010-02-16 01:46:59 +000099
Ted Kremenek8f0a1c72010-01-27 23:43:25 +0000100 // Look for flags (if any).
101 bool hasMore = true;
102 for ( ; I != E; ++I) {
103 switch (*I) {
104 default: hasMore = false; break;
NAKAMURA Takumidfbb02a2011-01-27 07:10:08 +0000105 case '\'':
Ted Kremenekbd18d452011-01-08 05:28:38 +0000106 // FIXME: POSIX specific. Always accept?
107 FS.setHasThousandsGrouping(I);
108 break;
Tom Caree4ee9662010-06-17 19:00:27 +0000109 case '-': FS.setIsLeftJustified(I); break;
110 case '+': FS.setHasPlusPrefix(I); break;
111 case ' ': FS.setHasSpacePrefix(I); break;
112 case '#': FS.setHasAlternativeForm(I); break;
113 case '0': FS.setHasLeadingZeros(I); break;
Ted Kremenek8f0a1c72010-01-27 23:43:25 +0000114 }
115 if (!hasMore)
116 break;
Ted Kremenek4e4b30e2010-02-16 01:46:59 +0000117 }
Ted Kremenek8f0a1c72010-01-27 23:43:25 +0000118
119 if (I == E) {
120 // No more characters left?
Ted Kremenek826a3452010-07-16 02:11:22 +0000121 H.HandleIncompleteSpecifier(Start, E - Start);
Ted Kremenek8f0a1c72010-01-27 23:43:25 +0000122 return true;
123 }
Ted Kremenek4e4b30e2010-02-16 01:46:59 +0000124
Ted Kremenek8f0a1c72010-01-27 23:43:25 +0000125 // Look for the field width (if any).
Ted Kremenekefaff192010-02-27 01:41:03 +0000126 if (ParseFieldWidth(H, FS, Start, I, E,
127 FS.usesPositionalArg() ? 0 : &argIndex))
128 return true;
Ted Kremenek4e4b30e2010-02-16 01:46:59 +0000129
Ted Kremenek8f0a1c72010-01-27 23:43:25 +0000130 if (I == E) {
131 // No more characters left?
Ted Kremenek826a3452010-07-16 02:11:22 +0000132 H.HandleIncompleteSpecifier(Start, E - Start);
Ted Kremenek8f0a1c72010-01-27 23:43:25 +0000133 return true;
Ted Kremenek4e4b30e2010-02-16 01:46:59 +0000134 }
135
136 // Look for the precision (if any).
Ted Kremenek8f0a1c72010-01-27 23:43:25 +0000137 if (*I == '.') {
Ted Kremenek808015a2010-01-29 03:16:21 +0000138 ++I;
Ted Kremenek8f0a1c72010-01-27 23:43:25 +0000139 if (I == E) {
Ted Kremenek826a3452010-07-16 02:11:22 +0000140 H.HandleIncompleteSpecifier(Start, E - Start);
Ted Kremenek8f0a1c72010-01-27 23:43:25 +0000141 return true;
142 }
Ted Kremenek4e4b30e2010-02-16 01:46:59 +0000143
Ted Kremenekefaff192010-02-27 01:41:03 +0000144 if (ParsePrecision(H, FS, Start, I, E,
145 FS.usesPositionalArg() ? 0 : &argIndex))
146 return true;
Ted Kremenek8f0a1c72010-01-27 23:43:25 +0000147
148 if (I == E) {
149 // No more characters left?
Ted Kremenek826a3452010-07-16 02:11:22 +0000150 H.HandleIncompleteSpecifier(Start, E - Start);
Ted Kremenek8f0a1c72010-01-27 23:43:25 +0000151 return true;
152 }
153 }
154
155 // Look for the length modifier.
Hans Wennborgd02deeb2011-12-15 10:25:47 +0000156 if (ParseLengthModifier(FS, I, E, LO) && I == E) {
Ted Kremenek8f0a1c72010-01-27 23:43:25 +0000157 // No more characters left?
Ted Kremenek826a3452010-07-16 02:11:22 +0000158 H.HandleIncompleteSpecifier(Start, E - Start);
Ted Kremenek8f0a1c72010-01-27 23:43:25 +0000159 return true;
160 }
Ted Kremenekdf17f9d2010-02-09 00:04:09 +0000161
Ted Kremenek4dcb18f2010-01-29 20:29:53 +0000162 if (*I == '\0') {
Ted Kremenekdf17f9d2010-02-09 00:04:09 +0000163 // Detect spurious null characters, which are likely errors.
164 H.HandleNullChar(I);
165 return true;
Ted Kremenek4dcb18f2010-01-29 20:29:53 +0000166 }
Ted Kremenek4e4b30e2010-02-16 01:46:59 +0000167
Ted Kremenek8f0a1c72010-01-27 23:43:25 +0000168 // Finally, look for the conversion specifier.
Ted Kremeneka8d8fec2010-01-28 02:46:17 +0000169 const char *conversionPosition = I++;
Ted Kremenek26ac2e02010-01-29 02:40:24 +0000170 ConversionSpecifier::Kind k = ConversionSpecifier::InvalidSpecifier;
Ted Kremeneka8d8fec2010-01-28 02:46:17 +0000171 switch (*conversionPosition) {
Ted Kremenek8f0a1c72010-01-27 23:43:25 +0000172 default:
Ted Kremenek26ac2e02010-01-29 02:40:24 +0000173 break;
Ted Kremenekc7cbb9b2010-01-28 00:55:28 +0000174 // C99: 7.19.6.1 (section 8).
Ted Kremenek87260c72010-02-24 00:05:54 +0000175 case '%': k = ConversionSpecifier::PercentArg; break;
176 case 'A': k = ConversionSpecifier::AArg; break;
177 case 'E': k = ConversionSpecifier::EArg; break;
178 case 'F': k = ConversionSpecifier::FArg; break;
179 case 'G': k = ConversionSpecifier::GArg; break;
180 case 'X': k = ConversionSpecifier::XArg; break;
181 case 'a': k = ConversionSpecifier::aArg; break;
Ted Kremenek92a6feb2010-07-20 20:03:49 +0000182 case 'c': k = ConversionSpecifier::cArg; break;
Ted Kremeneka8d8fec2010-01-28 02:46:17 +0000183 case 'd': k = ConversionSpecifier::dArg; break;
Ted Kremenek87260c72010-02-24 00:05:54 +0000184 case 'e': k = ConversionSpecifier::eArg; break;
185 case 'f': k = ConversionSpecifier::fArg; break;
186 case 'g': k = ConversionSpecifier::gArg; break;
Ted Kremeneka8d8fec2010-01-28 02:46:17 +0000187 case 'i': k = ConversionSpecifier::iArg; break;
Ted Kremenek35d353b2010-07-20 20:04:10 +0000188 case 'n': k = ConversionSpecifier::nArg; break;
Ted Kremeneka8d8fec2010-01-28 02:46:17 +0000189 case 'o': k = ConversionSpecifier::oArg; break;
Ted Kremenek66932052010-07-20 20:04:04 +0000190 case 'p': k = ConversionSpecifier::pArg; break;
Ted Kremenek99196b12010-07-20 20:03:58 +0000191 case 's': k = ConversionSpecifier::sArg; break;
Ted Kremeneka8d8fec2010-01-28 02:46:17 +0000192 case 'u': k = ConversionSpecifier::uArg; break;
193 case 'x': k = ConversionSpecifier::xArg; break;
Ted Kremenekbd18d452011-01-08 05:28:38 +0000194 // POSIX specific.
Ted Kremenek87260c72010-02-24 00:05:54 +0000195 case 'C': k = ConversionSpecifier::CArg; break;
Ted Kremenekde183a42010-07-20 20:04:15 +0000196 case 'S': k = ConversionSpecifier::SArg; break;
Ted Kremenekc7cbb9b2010-01-28 00:55:28 +0000197 // Objective-C.
Ted Kremenek4dcb18f2010-01-29 20:29:53 +0000198 case '@': k = ConversionSpecifier::ObjCObjArg; break;
Ted Kremenekdf17f9d2010-02-09 00:04:09 +0000199 // Glibc specific.
Ted Kremenek4dcb18f2010-01-29 20:29:53 +0000200 case 'm': k = ConversionSpecifier::PrintErrno; break;
Jordan Rose275b6f52012-09-13 02:11:03 +0000201 // Apple-specific
202 case 'D':
203 if (Target.getTriple().isOSDarwin())
204 k = ConversionSpecifier::DArg;
205 break;
206 case 'O':
207 if (Target.getTriple().isOSDarwin())
208 k = ConversionSpecifier::OArg;
209 break;
210 case 'U':
211 if (Target.getTriple().isOSDarwin())
212 k = ConversionSpecifier::UArg;
213 break;
Ted Kremenek8f0a1c72010-01-27 23:43:25 +0000214 }
Ted Kremenek6ecb9502010-07-20 20:04:27 +0000215 PrintfConversionSpecifier CS(conversionPosition, k);
Ted Kremenek7f70dc82010-02-26 19:18:41 +0000216 FS.setConversionSpecifier(CS);
Ted Kremenekefaff192010-02-27 01:41:03 +0000217 if (CS.consumesDataArgument() && !FS.usesPositionalArg())
Ted Kremenek7f70dc82010-02-26 19:18:41 +0000218 FS.setArgIndex(argIndex++);
Ted Kremenek26ac2e02010-01-29 02:40:24 +0000219
220 if (k == ConversionSpecifier::InvalidSpecifier) {
Ted Kremenek7f70dc82010-02-26 19:18:41 +0000221 // Assume the conversion takes one argument.
Ted Kremenek79662972010-12-02 20:57:51 +0000222 return !H.HandleInvalidPrintfConversionSpecifier(FS, Start, I - Start);
Ted Kremenek26ac2e02010-01-29 02:40:24 +0000223 }
Ted Kremenek826a3452010-07-16 02:11:22 +0000224 return PrintfSpecifierResult(Start, FS);
Ted Kremenek8f0a1c72010-01-27 23:43:25 +0000225}
226
Ted Kremenek826a3452010-07-16 02:11:22 +0000227bool clang::analyze_format_string::ParsePrintfString(FormatStringHandler &H,
228 const char *I,
Hans Wennborgd02deeb2011-12-15 10:25:47 +0000229 const char *E,
Jordan Rose275b6f52012-09-13 02:11:03 +0000230 const LangOptions &LO,
231 const TargetInfo &Target) {
Ted Kremenek7f70dc82010-02-26 19:18:41 +0000232
233 unsigned argIndex = 0;
234
Ted Kremenek8f0a1c72010-01-27 23:43:25 +0000235 // Keep looking for a format specifier until we have exhausted the string.
236 while (I != E) {
Hans Wennborgd02deeb2011-12-15 10:25:47 +0000237 const PrintfSpecifierResult &FSR = ParsePrintfSpecifier(H, I, E, argIndex,
Jordan Rose275b6f52012-09-13 02:11:03 +0000238 LO, Target);
Ted Kremenek26ac2e02010-01-29 02:40:24 +0000239 // Did a fail-stop error of any kind occur when parsing the specifier?
240 // If so, don't do any more processing.
241 if (FSR.shouldStop())
Dmitri Gribenko1ad23d62012-09-10 21:20:09 +0000242 return true;
Ted Kremenek26ac2e02010-01-29 02:40:24 +0000243 // Did we exhaust the string or encounter an error that
244 // we can recover from?
Ted Kremenek8f0a1c72010-01-27 23:43:25 +0000245 if (!FSR.hasValue())
Ted Kremenek26ac2e02010-01-29 02:40:24 +0000246 continue;
Ted Kremenek8f0a1c72010-01-27 23:43:25 +0000247 // We have a format specifier. Pass it to the callback.
Ted Kremenek826a3452010-07-16 02:11:22 +0000248 if (!H.HandlePrintfSpecifier(FSR.getValue(), FSR.getStart(),
Ted Kremeneka8d8fec2010-01-28 02:46:17 +0000249 I - FSR.getStart()))
Ted Kremenek4dcb18f2010-01-29 20:29:53 +0000250 return true;
Ted Kremenek4e4b30e2010-02-16 01:46:59 +0000251 }
252 assert(I == E && "Format string not exhausted");
Ted Kremenek8f0a1c72010-01-27 23:43:25 +0000253 return false;
254}
Ted Kremenek8f0a1c72010-01-27 23:43:25 +0000255
Ted Kremenek4e4b30e2010-02-16 01:46:59 +0000256//===----------------------------------------------------------------------===//
Ted Kremenek826a3452010-07-16 02:11:22 +0000257// Methods on PrintfSpecifier.
Tom Care3bfc5f42010-06-09 04:11:11 +0000258//===----------------------------------------------------------------------===//
259
Hans Wennborgf3749f42012-08-07 08:11:26 +0000260ArgType PrintfSpecifier::getArgType(ASTContext &Ctx,
261 bool IsObjCLiteral) const {
Ted Kremenek6ecb9502010-07-20 20:04:27 +0000262 const PrintfConversionSpecifier &CS = getConversionSpecifier();
NAKAMURA Takumidfbb02a2011-01-27 07:10:08 +0000263
Ted Kremenek33567d22010-01-29 22:59:32 +0000264 if (!CS.consumesDataArgument())
Hans Wennborgf3749f42012-08-07 08:11:26 +0000265 return ArgType::Invalid();
Ted Kremenek4e4b30e2010-02-16 01:46:59 +0000266
Ted Kremenek9325eaf2010-08-24 22:24:51 +0000267 if (CS.getKind() == ConversionSpecifier::cArg)
268 switch (LM.getKind()) {
269 case LengthModifier::None: return Ctx.IntTy;
Hans Wennborgf4f0c602011-12-09 12:22:12 +0000270 case LengthModifier::AsLong:
Hans Wennborgf3749f42012-08-07 08:11:26 +0000271 return ArgType(ArgType::WIntTy, "wint_t");
Ted Kremenek9325eaf2010-08-24 22:24:51 +0000272 default:
Hans Wennborgf3749f42012-08-07 08:11:26 +0000273 return ArgType::Invalid();
Ted Kremenek9325eaf2010-08-24 22:24:51 +0000274 }
NAKAMURA Takumidfbb02a2011-01-27 07:10:08 +0000275
Ted Kremenek33567d22010-01-29 22:59:32 +0000276 if (CS.isIntArg())
Tom Care3bfc5f42010-06-09 04:11:11 +0000277 switch (LM.getKind()) {
278 case LengthModifier::AsLongDouble:
Ted Kremenek9d24c2c2012-01-24 21:29:54 +0000279 // GNU extension.
280 return Ctx.LongLongTy;
Tom Care3bfc5f42010-06-09 04:11:11 +0000281 case LengthModifier::None: return Ctx.IntTy;
Hans Wennborgf3749f42012-08-07 08:11:26 +0000282 case LengthModifier::AsChar: return ArgType::AnyCharTy;
Tom Care3bfc5f42010-06-09 04:11:11 +0000283 case LengthModifier::AsShort: return Ctx.ShortTy;
284 case LengthModifier::AsLong: return Ctx.LongTy;
Hans Wennborg32addd52012-02-16 16:34:54 +0000285 case LengthModifier::AsLongLong:
286 case LengthModifier::AsQuad:
287 return Ctx.LongLongTy;
Hans Wennborga792aff2011-12-07 10:33:11 +0000288 case LengthModifier::AsIntMax:
Hans Wennborgf3749f42012-08-07 08:11:26 +0000289 return ArgType(Ctx.getIntMaxType(), "intmax_t");
Hans Wennborg29e97cb2011-10-27 08:29:09 +0000290 case LengthModifier::AsSizeT:
291 // FIXME: How to get the corresponding signed version of size_t?
Hans Wennborgf3749f42012-08-07 08:11:26 +0000292 return ArgType();
Hans Wennborga792aff2011-12-07 10:33:11 +0000293 case LengthModifier::AsPtrDiff:
Hans Wennborgf3749f42012-08-07 08:11:26 +0000294 return ArgType(Ctx.getPointerDiffType(), "ptrdiff_t");
Hans Wennborgd02deeb2011-12-15 10:25:47 +0000295 case LengthModifier::AsAllocate:
Hans Wennborg37969b72012-01-12 17:11:12 +0000296 case LengthModifier::AsMAllocate:
Hans Wennborgf3749f42012-08-07 08:11:26 +0000297 return ArgType::Invalid();
Ted Kremenek33567d22010-01-29 22:59:32 +0000298 }
299
300 if (CS.isUIntArg())
Tom Care3bfc5f42010-06-09 04:11:11 +0000301 switch (LM.getKind()) {
302 case LengthModifier::AsLongDouble:
Ted Kremenek9d24c2c2012-01-24 21:29:54 +0000303 // GNU extension.
304 return Ctx.UnsignedLongLongTy;
Tom Care3bfc5f42010-06-09 04:11:11 +0000305 case LengthModifier::None: return Ctx.UnsignedIntTy;
306 case LengthModifier::AsChar: return Ctx.UnsignedCharTy;
307 case LengthModifier::AsShort: return Ctx.UnsignedShortTy;
308 case LengthModifier::AsLong: return Ctx.UnsignedLongTy;
Hans Wennborg32addd52012-02-16 16:34:54 +0000309 case LengthModifier::AsLongLong:
310 case LengthModifier::AsQuad:
311 return Ctx.UnsignedLongLongTy;
Hans Wennborga792aff2011-12-07 10:33:11 +0000312 case LengthModifier::AsIntMax:
Hans Wennborgf3749f42012-08-07 08:11:26 +0000313 return ArgType(Ctx.getUIntMaxType(), "uintmax_t");
Tom Care3bfc5f42010-06-09 04:11:11 +0000314 case LengthModifier::AsSizeT:
Hans Wennborgf3749f42012-08-07 08:11:26 +0000315 return ArgType(Ctx.getSizeType(), "size_t");
Tom Care3bfc5f42010-06-09 04:11:11 +0000316 case LengthModifier::AsPtrDiff:
Ted Kremenek33567d22010-01-29 22:59:32 +0000317 // FIXME: How to get the corresponding unsigned
318 // version of ptrdiff_t?
Hans Wennborgf3749f42012-08-07 08:11:26 +0000319 return ArgType();
Hans Wennborgd02deeb2011-12-15 10:25:47 +0000320 case LengthModifier::AsAllocate:
Hans Wennborg37969b72012-01-12 17:11:12 +0000321 case LengthModifier::AsMAllocate:
Hans Wennborgf3749f42012-08-07 08:11:26 +0000322 return ArgType::Invalid();
Ted Kremenek33567d22010-01-29 22:59:32 +0000323 }
Ted Kremenek4e4b30e2010-02-16 01:46:59 +0000324
Ted Kremenekf911eba2010-02-01 23:23:50 +0000325 if (CS.isDoubleArg()) {
Tom Care3bfc5f42010-06-09 04:11:11 +0000326 if (LM.getKind() == LengthModifier::AsLongDouble)
Ted Kremenekf911eba2010-02-01 23:23:50 +0000327 return Ctx.LongDoubleTy;
Ted Kremenekc9a89fe2010-01-30 01:02:18 +0000328 return Ctx.DoubleTy;
Ted Kremenekf911eba2010-02-01 23:23:50 +0000329 }
Ted Kremenek7f70dc82010-02-26 19:18:41 +0000330
Hans Wennborgf7158fa2012-08-07 09:13:19 +0000331 if (CS.getKind() == ConversionSpecifier::nArg) {
332 switch (LM.getKind()) {
333 case LengthModifier::None:
334 return ArgType::PtrTo(Ctx.IntTy);
335 case LengthModifier::AsChar:
336 return ArgType::PtrTo(Ctx.SignedCharTy);
337 case LengthModifier::AsShort:
338 return ArgType::PtrTo(Ctx.ShortTy);
339 case LengthModifier::AsLong:
340 return ArgType::PtrTo(Ctx.LongTy);
341 case LengthModifier::AsLongLong:
342 case LengthModifier::AsQuad:
343 return ArgType::PtrTo(Ctx.LongLongTy);
344 case LengthModifier::AsIntMax:
345 return ArgType::PtrTo(ArgType(Ctx.getIntMaxType(), "intmax_t"));
346 case LengthModifier::AsSizeT:
347 return ArgType(); // FIXME: ssize_t
348 case LengthModifier::AsPtrDiff:
349 return ArgType::PtrTo(ArgType(Ctx.getPointerDiffType(), "ptrdiff_t"));
350 case LengthModifier::AsLongDouble:
351 return ArgType(); // FIXME: Is this a known extension?
352 case LengthModifier::AsAllocate:
353 case LengthModifier::AsMAllocate:
354 return ArgType::Invalid();
355 }
356 }
357
Ted Kremenek87260c72010-02-24 00:05:54 +0000358 switch (CS.getKind()) {
Hans Wennborg63082182011-12-09 15:57:33 +0000359 case ConversionSpecifier::sArg:
Nico Weber339b9072012-01-31 01:43:25 +0000360 if (LM.getKind() == LengthModifier::AsWideChar) {
361 if (IsObjCLiteral)
Jordan Rose2cd34402012-12-05 18:44:49 +0000362 return ArgType(Ctx.getPointerType(Ctx.UnsignedShortTy.withConst()),
363 "const unichar *");
Hans Wennborgf3749f42012-08-07 08:11:26 +0000364 return ArgType(ArgType::WCStrTy, "wchar_t *");
Nico Weber339b9072012-01-31 01:43:25 +0000365 }
Hans Wennborgf3749f42012-08-07 08:11:26 +0000366 return ArgType::CStrTy;
Ted Kremenekde183a42010-07-20 20:04:15 +0000367 case ConversionSpecifier::SArg:
Nico Weber339b9072012-01-31 01:43:25 +0000368 if (IsObjCLiteral)
Jordan Rose2cd34402012-12-05 18:44:49 +0000369 return ArgType(Ctx.getPointerType(Ctx.UnsignedShortTy.withConst()),
370 "const unichar *");
Hans Wennborgf3749f42012-08-07 08:11:26 +0000371 return ArgType(ArgType::WCStrTy, "wchar_t *");
Ted Kremenek87260c72010-02-24 00:05:54 +0000372 case ConversionSpecifier::CArg:
Nico Weber339b9072012-01-31 01:43:25 +0000373 if (IsObjCLiteral)
Jordan Rose2cd34402012-12-05 18:44:49 +0000374 return ArgType(Ctx.UnsignedShortTy, "unichar");
Hans Wennborgf3749f42012-08-07 08:11:26 +0000375 return ArgType(Ctx.WCharTy, "wchar_t");
Ted Kremenek66932052010-07-20 20:04:04 +0000376 case ConversionSpecifier::pArg:
Hans Wennborgf3749f42012-08-07 08:11:26 +0000377 return ArgType::CPointerTy;
Ted Kremeneke6ca97f2012-01-25 00:04:09 +0000378 case ConversionSpecifier::ObjCObjArg:
Hans Wennborgf3749f42012-08-07 08:11:26 +0000379 return ArgType::ObjCPointerTy;
Ted Kremenek87260c72010-02-24 00:05:54 +0000380 default:
381 break;
382 }
Ted Kremenek7f70dc82010-02-26 19:18:41 +0000383
Ted Kremenek33567d22010-01-29 22:59:32 +0000384 // FIXME: Handle other cases.
Hans Wennborgf3749f42012-08-07 08:11:26 +0000385 return ArgType();
Ted Kremenek33567d22010-01-29 22:59:32 +0000386}
387
Hans Wennborgbe6126a2012-02-15 09:59:46 +0000388bool PrintfSpecifier::fixType(QualType QT, const LangOptions &LangOpt,
389 ASTContext &Ctx, bool IsObjCLiteral) {
Hans Wennborgcec9ce42012-07-30 17:11:32 +0000390 // %n is different from other conversion specifiers; don't try to fix it.
391 if (CS.getKind() == ConversionSpecifier::nArg)
392 return false;
393
Jordan Rose153acdb2012-05-30 21:53:13 +0000394 // Handle Objective-C objects first. Note that while the '%@' specifier will
395 // not warn for structure pointer or void pointer arguments (because that's
396 // how CoreFoundation objects are implemented), we only show a fixit for '%@'
397 // if we know it's an object (block, id, class, or __attribute__((NSObject))).
398 if (QT->isObjCRetainableType()) {
399 if (!IsObjCLiteral)
400 return false;
401
402 CS.setKind(ConversionSpecifier::ObjCObjArg);
403
404 // Disable irrelevant flags
405 HasThousandsGrouping = false;
406 HasPlusPrefix = false;
407 HasSpacePrefix = false;
408 HasAlternativeForm = false;
409 HasLeadingZeroes = false;
410 Precision.setHowSpecified(OptionalAmount::NotSpecified);
411 LM.setKind(LengthModifier::None);
412
413 return true;
414 }
415
416 // Handle strings next (char *, wchar_t *)
Tom Care3bfc5f42010-06-09 04:11:11 +0000417 if (QT->isPointerType() && (QT->getPointeeType()->isAnyCharacterType())) {
Ted Kremenek99196b12010-07-20 20:03:58 +0000418 CS.setKind(ConversionSpecifier::sArg);
Tom Care3bfc5f42010-06-09 04:11:11 +0000419
Tom Care876e9942010-06-11 04:22:02 +0000420 // Disable irrelevant flags
421 HasAlternativeForm = 0;
422 HasLeadingZeroes = 0;
423
Tom Care3bfc5f42010-06-09 04:11:11 +0000424 // Set the long length modifier for wide characters
425 if (QT->getPointeeType()->isWideCharType())
426 LM.setKind(LengthModifier::AsWideChar);
Hans Wennborg117348c2011-12-09 10:51:29 +0000427 else
428 LM.setKind(LengthModifier::None);
Tom Care3bfc5f42010-06-09 04:11:11 +0000429
430 return true;
431 }
432
Jordan Rose033a9c02012-06-04 22:49:02 +0000433 // If it's an enum, get its underlying type.
434 if (const EnumType *ETy = QT->getAs<EnumType>())
435 QT = ETy->getDecl()->getIntegerType();
436
Tom Care3bfc5f42010-06-09 04:11:11 +0000437 // We can only work with builtin types.
Tom Care3bfc5f42010-06-09 04:11:11 +0000438 const BuiltinType *BT = QT->getAs<BuiltinType>();
John McCall2dde35b2011-10-18 22:28:37 +0000439 if (!BT)
440 return false;
Tom Care876e9942010-06-11 04:22:02 +0000441
Tom Care3bfc5f42010-06-09 04:11:11 +0000442 // Set length modifier
443 switch (BT->getKind()) {
Eli Friedman06d88ec2011-04-27 22:06:20 +0000444 case BuiltinType::Bool:
445 case BuiltinType::WChar_U:
446 case BuiltinType::WChar_S:
447 case BuiltinType::Char16:
448 case BuiltinType::Char32:
449 case BuiltinType::UInt128:
450 case BuiltinType::Int128:
Anton Korobeynikovaa4a99b2011-10-14 23:23:15 +0000451 case BuiltinType::Half:
John McCall2dde35b2011-10-18 22:28:37 +0000452 // Various types which are non-trivial to correct.
Eli Friedman06d88ec2011-04-27 22:06:20 +0000453 return false;
454
John McCall2dde35b2011-10-18 22:28:37 +0000455#define SIGNED_TYPE(Id, SingletonId)
456#define UNSIGNED_TYPE(Id, SingletonId)
457#define FLOATING_TYPE(Id, SingletonId)
458#define BUILTIN_TYPE(Id, SingletonId) \
459 case BuiltinType::Id:
460#include "clang/AST/BuiltinTypes.def"
Eli Friedman06d88ec2011-04-27 22:06:20 +0000461 // Misc other stuff which doesn't make sense here.
462 return false;
463
464 case BuiltinType::UInt:
465 case BuiltinType::Int:
466 case BuiltinType::Float:
467 case BuiltinType::Double:
Tom Care876e9942010-06-11 04:22:02 +0000468 LM.setKind(LengthModifier::None);
Tom Care3bfc5f42010-06-09 04:11:11 +0000469 break;
Tom Care876e9942010-06-11 04:22:02 +0000470
Ted Kremenek4d8ae4d2010-10-21 04:00:58 +0000471 case BuiltinType::Char_U:
472 case BuiltinType::UChar:
473 case BuiltinType::Char_S:
474 case BuiltinType::SChar:
475 LM.setKind(LengthModifier::AsChar);
476 break;
477
478 case BuiltinType::Short:
479 case BuiltinType::UShort:
480 LM.setKind(LengthModifier::AsShort);
481 break;
482
Tom Care3bfc5f42010-06-09 04:11:11 +0000483 case BuiltinType::Long:
484 case BuiltinType::ULong:
485 LM.setKind(LengthModifier::AsLong);
486 break;
487
488 case BuiltinType::LongLong:
489 case BuiltinType::ULongLong:
490 LM.setKind(LengthModifier::AsLongLong);
491 break;
492
493 case BuiltinType::LongDouble:
494 LM.setKind(LengthModifier::AsLongDouble);
495 break;
496 }
497
Hans Wennborga7da2152011-10-18 08:10:06 +0000498 // Handle size_t, ptrdiff_t, etc. that have dedicated length modifiers in C99.
Richard Smith80ad52f2013-01-02 11:42:31 +0000499 if (isa<TypedefType>(QT) && (LangOpt.C99 || LangOpt.CPlusPlus11))
Hans Wennborg46847782012-07-27 19:17:46 +0000500 namedTypeToLengthModifier(QT, LM);
Hans Wennborga7da2152011-10-18 08:10:06 +0000501
Hans Wennborgbe6126a2012-02-15 09:59:46 +0000502 // If fixing the length modifier was enough, we are done.
Jordan Rosebbb6bb42012-09-08 04:00:03 +0000503 if (hasValidLengthModifier(Ctx.getTargetInfo())) {
504 const analyze_printf::ArgType &ATR = getArgType(Ctx, IsObjCLiteral);
505 if (ATR.isValid() && ATR.matchesType(Ctx, QT))
506 return true;
507 }
Hans Wennborgbe6126a2012-02-15 09:59:46 +0000508
Tom Care3bfc5f42010-06-09 04:11:11 +0000509 // Set conversion specifier and disable any flags which do not apply to it.
Ted Kremenek4d8ae4d2010-10-21 04:00:58 +0000510 // Let typedefs to char fall through to int, as %c is silly for uint8_t.
Jordan Roseff7be482012-12-05 18:44:37 +0000511 if (!isa<TypedefType>(QT) && QT->isCharType()) {
Ted Kremenek92a6feb2010-07-20 20:03:49 +0000512 CS.setKind(ConversionSpecifier::cArg);
Ted Kremenek4d8ae4d2010-10-21 04:00:58 +0000513 LM.setKind(LengthModifier::None);
Tom Care3bfc5f42010-06-09 04:11:11 +0000514 Precision.setHowSpecified(OptionalAmount::NotSpecified);
515 HasAlternativeForm = 0;
516 HasLeadingZeroes = 0;
Tom Caree4ee9662010-06-17 19:00:27 +0000517 HasPlusPrefix = 0;
Tom Care3bfc5f42010-06-09 04:11:11 +0000518 }
519 // Test for Floating type first as LongDouble can pass isUnsignedIntegerType
Douglas Gregor0c293ea2010-06-22 23:07:26 +0000520 else if (QT->isRealFloatingType()) {
Tom Care3bfc5f42010-06-09 04:11:11 +0000521 CS.setKind(ConversionSpecifier::fArg);
522 }
Tom Care3bfc5f42010-06-09 04:11:11 +0000523 else if (QT->isSignedIntegerType()) {
524 CS.setKind(ConversionSpecifier::dArg);
525 HasAlternativeForm = 0;
526 }
Douglas Gregorc8c4b402010-06-09 05:25:34 +0000527 else if (QT->isUnsignedIntegerType()) {
Hans Wennborgbe6126a2012-02-15 09:59:46 +0000528 CS.setKind(ConversionSpecifier::uArg);
Tom Care3bfc5f42010-06-09 04:11:11 +0000529 HasAlternativeForm = 0;
Tom Caree4ee9662010-06-17 19:00:27 +0000530 HasPlusPrefix = 0;
Chad Rosier30601782011-08-17 23:08:45 +0000531 } else {
David Blaikieb219cfc2011-09-23 05:06:16 +0000532 llvm_unreachable("Unexpected type");
Tom Care3bfc5f42010-06-09 04:11:11 +0000533 }
534
535 return true;
536}
537
Chris Lattner5f9e2722011-07-23 10:55:15 +0000538void PrintfSpecifier::toString(raw_ostream &os) const {
Tom Care3bfc5f42010-06-09 04:11:11 +0000539 // Whilst some features have no defined order, we are using the order
NAKAMURA Takumi00995302011-01-27 07:09:49 +0000540 // appearing in the C99 standard (ISO/IEC 9899:1999 (E) 7.19.6.1)
Tom Care3bfc5f42010-06-09 04:11:11 +0000541 os << "%";
542
543 // Positional args
544 if (usesPositionalArg()) {
545 os << getPositionalArgIndex() << "$";
546 }
547
548 // Conversion flags
549 if (IsLeftJustified) os << "-";
550 if (HasPlusPrefix) os << "+";
551 if (HasSpacePrefix) os << " ";
552 if (HasAlternativeForm) os << "#";
553 if (HasLeadingZeroes) os << "0";
554
555 // Minimum field width
556 FieldWidth.toString(os);
557 // Precision
558 Precision.toString(os);
559 // Length modifier
560 os << LM.toString();
561 // Conversion specifier
562 os << CS.toString();
563}
Tom Caree4ee9662010-06-17 19:00:27 +0000564
Ted Kremenek826a3452010-07-16 02:11:22 +0000565bool PrintfSpecifier::hasValidPlusPrefix() const {
Tom Caree4ee9662010-06-17 19:00:27 +0000566 if (!HasPlusPrefix)
567 return true;
568
569 // The plus prefix only makes sense for signed conversions
570 switch (CS.getKind()) {
571 case ConversionSpecifier::dArg:
Jordan Rose275b6f52012-09-13 02:11:03 +0000572 case ConversionSpecifier::DArg:
Tom Caree4ee9662010-06-17 19:00:27 +0000573 case ConversionSpecifier::iArg:
574 case ConversionSpecifier::fArg:
575 case ConversionSpecifier::FArg:
576 case ConversionSpecifier::eArg:
577 case ConversionSpecifier::EArg:
578 case ConversionSpecifier::gArg:
579 case ConversionSpecifier::GArg:
580 case ConversionSpecifier::aArg:
581 case ConversionSpecifier::AArg:
582 return true;
583
584 default:
585 return false;
586 }
587}
588
Ted Kremenek826a3452010-07-16 02:11:22 +0000589bool PrintfSpecifier::hasValidAlternativeForm() const {
Tom Caree4ee9662010-06-17 19:00:27 +0000590 if (!HasAlternativeForm)
591 return true;
592
Anders Carlsson2e6c19a2010-11-21 18:34:21 +0000593 // Alternate form flag only valid with the oxXaAeEfFgG conversions
Tom Caree4ee9662010-06-17 19:00:27 +0000594 switch (CS.getKind()) {
595 case ConversionSpecifier::oArg:
Jordan Rose275b6f52012-09-13 02:11:03 +0000596 case ConversionSpecifier::OArg:
Tom Caree4ee9662010-06-17 19:00:27 +0000597 case ConversionSpecifier::xArg:
Anders Carlsson2e6c19a2010-11-21 18:34:21 +0000598 case ConversionSpecifier::XArg:
Tom Caree4ee9662010-06-17 19:00:27 +0000599 case ConversionSpecifier::aArg:
600 case ConversionSpecifier::AArg:
601 case ConversionSpecifier::eArg:
602 case ConversionSpecifier::EArg:
603 case ConversionSpecifier::fArg:
604 case ConversionSpecifier::FArg:
605 case ConversionSpecifier::gArg:
606 case ConversionSpecifier::GArg:
607 return true;
608
609 default:
610 return false;
611 }
612}
613
Ted Kremenek826a3452010-07-16 02:11:22 +0000614bool PrintfSpecifier::hasValidLeadingZeros() const {
Tom Caree4ee9662010-06-17 19:00:27 +0000615 if (!HasLeadingZeroes)
616 return true;
617
618 // Leading zeroes flag only valid with the diouxXaAeEfFgG conversions
619 switch (CS.getKind()) {
620 case ConversionSpecifier::dArg:
Jordan Rose275b6f52012-09-13 02:11:03 +0000621 case ConversionSpecifier::DArg:
Tom Caree4ee9662010-06-17 19:00:27 +0000622 case ConversionSpecifier::iArg:
623 case ConversionSpecifier::oArg:
Jordan Rose275b6f52012-09-13 02:11:03 +0000624 case ConversionSpecifier::OArg:
Tom Caree4ee9662010-06-17 19:00:27 +0000625 case ConversionSpecifier::uArg:
Jordan Rose275b6f52012-09-13 02:11:03 +0000626 case ConversionSpecifier::UArg:
Tom Caree4ee9662010-06-17 19:00:27 +0000627 case ConversionSpecifier::xArg:
628 case ConversionSpecifier::XArg:
629 case ConversionSpecifier::aArg:
630 case ConversionSpecifier::AArg:
631 case ConversionSpecifier::eArg:
632 case ConversionSpecifier::EArg:
633 case ConversionSpecifier::fArg:
634 case ConversionSpecifier::FArg:
635 case ConversionSpecifier::gArg:
636 case ConversionSpecifier::GArg:
637 return true;
638
639 default:
640 return false;
641 }
642}
643
Ted Kremenek826a3452010-07-16 02:11:22 +0000644bool PrintfSpecifier::hasValidSpacePrefix() const {
Tom Caree4ee9662010-06-17 19:00:27 +0000645 if (!HasSpacePrefix)
646 return true;
647
648 // The space prefix only makes sense for signed conversions
649 switch (CS.getKind()) {
650 case ConversionSpecifier::dArg:
Jordan Rose275b6f52012-09-13 02:11:03 +0000651 case ConversionSpecifier::DArg:
Tom Caree4ee9662010-06-17 19:00:27 +0000652 case ConversionSpecifier::iArg:
653 case ConversionSpecifier::fArg:
654 case ConversionSpecifier::FArg:
655 case ConversionSpecifier::eArg:
656 case ConversionSpecifier::EArg:
657 case ConversionSpecifier::gArg:
658 case ConversionSpecifier::GArg:
659 case ConversionSpecifier::aArg:
660 case ConversionSpecifier::AArg:
661 return true;
662
663 default:
664 return false;
665 }
666}
667
Ted Kremenek826a3452010-07-16 02:11:22 +0000668bool PrintfSpecifier::hasValidLeftJustified() const {
Tom Caree4ee9662010-06-17 19:00:27 +0000669 if (!IsLeftJustified)
670 return true;
671
672 // The left justified flag is valid for all conversions except n
673 switch (CS.getKind()) {
Ted Kremenek35d353b2010-07-20 20:04:10 +0000674 case ConversionSpecifier::nArg:
Tom Caree4ee9662010-06-17 19:00:27 +0000675 return false;
676
677 default:
678 return true;
679 }
680}
681
Ted Kremenek65197b42011-01-08 05:28:46 +0000682bool PrintfSpecifier::hasValidThousandsGroupingPrefix() const {
683 if (!HasThousandsGrouping)
684 return true;
NAKAMURA Takumidfbb02a2011-01-27 07:10:08 +0000685
Ted Kremenek65197b42011-01-08 05:28:46 +0000686 switch (CS.getKind()) {
687 case ConversionSpecifier::dArg:
Jordan Rose275b6f52012-09-13 02:11:03 +0000688 case ConversionSpecifier::DArg:
Ted Kremenek65197b42011-01-08 05:28:46 +0000689 case ConversionSpecifier::iArg:
690 case ConversionSpecifier::uArg:
Jordan Rose275b6f52012-09-13 02:11:03 +0000691 case ConversionSpecifier::UArg:
Ted Kremenek65197b42011-01-08 05:28:46 +0000692 case ConversionSpecifier::fArg:
693 case ConversionSpecifier::FArg:
694 case ConversionSpecifier::gArg:
695 case ConversionSpecifier::GArg:
696 return true;
697 default:
698 return false;
699 }
700}
701
Ted Kremenek826a3452010-07-16 02:11:22 +0000702bool PrintfSpecifier::hasValidPrecision() const {
Tom Caree4ee9662010-06-17 19:00:27 +0000703 if (Precision.getHowSpecified() == OptionalAmount::NotSpecified)
704 return true;
705
706 // Precision is only valid with the diouxXaAeEfFgGs conversions
707 switch (CS.getKind()) {
708 case ConversionSpecifier::dArg:
Jordan Rose275b6f52012-09-13 02:11:03 +0000709 case ConversionSpecifier::DArg:
Tom Caree4ee9662010-06-17 19:00:27 +0000710 case ConversionSpecifier::iArg:
711 case ConversionSpecifier::oArg:
Jordan Rose275b6f52012-09-13 02:11:03 +0000712 case ConversionSpecifier::OArg:
Tom Caree4ee9662010-06-17 19:00:27 +0000713 case ConversionSpecifier::uArg:
Jordan Rose275b6f52012-09-13 02:11:03 +0000714 case ConversionSpecifier::UArg:
Tom Caree4ee9662010-06-17 19:00:27 +0000715 case ConversionSpecifier::xArg:
716 case ConversionSpecifier::XArg:
717 case ConversionSpecifier::aArg:
718 case ConversionSpecifier::AArg:
719 case ConversionSpecifier::eArg:
720 case ConversionSpecifier::EArg:
721 case ConversionSpecifier::fArg:
722 case ConversionSpecifier::FArg:
723 case ConversionSpecifier::gArg:
724 case ConversionSpecifier::GArg:
Ted Kremenek99196b12010-07-20 20:03:58 +0000725 case ConversionSpecifier::sArg:
Tom Caree4ee9662010-06-17 19:00:27 +0000726 return true;
727
728 default:
729 return false;
730 }
731}
Ted Kremenek826a3452010-07-16 02:11:22 +0000732bool PrintfSpecifier::hasValidFieldWidth() const {
Tom Caree4ee9662010-06-17 19:00:27 +0000733 if (FieldWidth.getHowSpecified() == OptionalAmount::NotSpecified)
734 return true;
735
736 // The field width is valid for all conversions except n
737 switch (CS.getKind()) {
Ted Kremenek35d353b2010-07-20 20:04:10 +0000738 case ConversionSpecifier::nArg:
Tom Caree4ee9662010-06-17 19:00:27 +0000739 return false;
740
741 default:
742 return true;
743 }
744}