150
|
1 // FormatString.cpp - Common stuff for handling printf/scanf formats -*- C++ -*-
|
|
2 //
|
|
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
4 // See https://llvm.org/LICENSE.txt for license information.
|
|
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
6 //
|
|
7 //===----------------------------------------------------------------------===//
|
|
8 //
|
|
9 // Shared details for processing format strings of printf and scanf
|
|
10 // (and friends).
|
|
11 //
|
|
12 //===----------------------------------------------------------------------===//
|
|
13
|
|
14 #include "FormatStringParsing.h"
|
|
15 #include "clang/Basic/LangOptions.h"
|
|
16 #include "clang/Basic/TargetInfo.h"
|
|
17 #include "llvm/Support/ConvertUTF.h"
|
|
18
|
|
19 using clang::analyze_format_string::ArgType;
|
|
20 using clang::analyze_format_string::FormatStringHandler;
|
|
21 using clang::analyze_format_string::FormatSpecifier;
|
|
22 using clang::analyze_format_string::LengthModifier;
|
|
23 using clang::analyze_format_string::OptionalAmount;
|
|
24 using clang::analyze_format_string::PositionContext;
|
|
25 using clang::analyze_format_string::ConversionSpecifier;
|
|
26 using namespace clang;
|
|
27
|
|
28 // Key function to FormatStringHandler.
|
|
29 FormatStringHandler::~FormatStringHandler() {}
|
|
30
|
|
31 //===----------------------------------------------------------------------===//
|
|
32 // Functions for parsing format strings components in both printf and
|
|
33 // scanf format strings.
|
|
34 //===----------------------------------------------------------------------===//
|
|
35
|
|
36 OptionalAmount
|
|
37 clang::analyze_format_string::ParseAmount(const char *&Beg, const char *E) {
|
|
38 const char *I = Beg;
|
|
39 UpdateOnReturn <const char*> UpdateBeg(Beg, I);
|
|
40
|
|
41 unsigned accumulator = 0;
|
|
42 bool hasDigits = false;
|
|
43
|
|
44 for ( ; I != E; ++I) {
|
|
45 char c = *I;
|
|
46 if (c >= '0' && c <= '9') {
|
|
47 hasDigits = true;
|
|
48 accumulator = (accumulator * 10) + (c - '0');
|
|
49 continue;
|
|
50 }
|
|
51
|
|
52 if (hasDigits)
|
|
53 return OptionalAmount(OptionalAmount::Constant, accumulator, Beg, I - Beg,
|
|
54 false);
|
|
55
|
|
56 break;
|
|
57 }
|
|
58
|
|
59 return OptionalAmount();
|
|
60 }
|
|
61
|
|
62 OptionalAmount
|
|
63 clang::analyze_format_string::ParseNonPositionAmount(const char *&Beg,
|
|
64 const char *E,
|
|
65 unsigned &argIndex) {
|
|
66 if (*Beg == '*') {
|
|
67 ++Beg;
|
|
68 return OptionalAmount(OptionalAmount::Arg, argIndex++, Beg, 0, false);
|
|
69 }
|
|
70
|
|
71 return ParseAmount(Beg, E);
|
|
72 }
|
|
73
|
|
74 OptionalAmount
|
|
75 clang::analyze_format_string::ParsePositionAmount(FormatStringHandler &H,
|
|
76 const char *Start,
|
|
77 const char *&Beg,
|
|
78 const char *E,
|
|
79 PositionContext p) {
|
|
80 if (*Beg == '*') {
|
|
81 const char *I = Beg + 1;
|
|
82 const OptionalAmount &Amt = ParseAmount(I, E);
|
|
83
|
|
84 if (Amt.getHowSpecified() == OptionalAmount::NotSpecified) {
|
|
85 H.HandleInvalidPosition(Beg, I - Beg, p);
|
|
86 return OptionalAmount(false);
|
|
87 }
|
|
88
|
|
89 if (I == E) {
|
|
90 // No more characters left?
|
|
91 H.HandleIncompleteSpecifier(Start, E - Start);
|
|
92 return OptionalAmount(false);
|
|
93 }
|
|
94
|
|
95 assert(Amt.getHowSpecified() == OptionalAmount::Constant);
|
|
96
|
|
97 if (*I == '$') {
|
|
98 // Handle positional arguments
|
|
99
|
|
100 // Special case: '*0$', since this is an easy mistake.
|
|
101 if (Amt.getConstantAmount() == 0) {
|
|
102 H.HandleZeroPosition(Beg, I - Beg + 1);
|
|
103 return OptionalAmount(false);
|
|
104 }
|
|
105
|
|
106 const char *Tmp = Beg;
|
|
107 Beg = ++I;
|
|
108
|
|
109 return OptionalAmount(OptionalAmount::Arg, Amt.getConstantAmount() - 1,
|
|
110 Tmp, 0, true);
|
|
111 }
|
|
112
|
|
113 H.HandleInvalidPosition(Beg, I - Beg, p);
|
|
114 return OptionalAmount(false);
|
|
115 }
|
|
116
|
|
117 return ParseAmount(Beg, E);
|
|
118 }
|
|
119
|
|
120
|
|
121 bool
|
|
122 clang::analyze_format_string::ParseFieldWidth(FormatStringHandler &H,
|
|
123 FormatSpecifier &CS,
|
|
124 const char *Start,
|
|
125 const char *&Beg, const char *E,
|
|
126 unsigned *argIndex) {
|
|
127 // FIXME: Support negative field widths.
|
|
128 if (argIndex) {
|
|
129 CS.setFieldWidth(ParseNonPositionAmount(Beg, E, *argIndex));
|
|
130 }
|
|
131 else {
|
|
132 const OptionalAmount Amt =
|
|
133 ParsePositionAmount(H, Start, Beg, E,
|
|
134 analyze_format_string::FieldWidthPos);
|
|
135
|
|
136 if (Amt.isInvalid())
|
|
137 return true;
|
|
138 CS.setFieldWidth(Amt);
|
|
139 }
|
|
140 return false;
|
|
141 }
|
|
142
|
|
143 bool
|
|
144 clang::analyze_format_string::ParseArgPosition(FormatStringHandler &H,
|
|
145 FormatSpecifier &FS,
|
|
146 const char *Start,
|
|
147 const char *&Beg,
|
|
148 const char *E) {
|
|
149 const char *I = Beg;
|
|
150
|
|
151 const OptionalAmount &Amt = ParseAmount(I, E);
|
|
152
|
|
153 if (I == E) {
|
|
154 // No more characters left?
|
|
155 H.HandleIncompleteSpecifier(Start, E - Start);
|
|
156 return true;
|
|
157 }
|
|
158
|
|
159 if (Amt.getHowSpecified() == OptionalAmount::Constant && *(I++) == '$') {
|
|
160 // Warn that positional arguments are non-standard.
|
|
161 H.HandlePosition(Start, I - Start);
|
|
162
|
|
163 // Special case: '%0$', since this is an easy mistake.
|
|
164 if (Amt.getConstantAmount() == 0) {
|
|
165 H.HandleZeroPosition(Start, I - Start);
|
|
166 return true;
|
|
167 }
|
|
168
|
|
169 FS.setArgIndex(Amt.getConstantAmount() - 1);
|
|
170 FS.setUsesPositionalArg();
|
|
171 // Update the caller's pointer if we decided to consume
|
|
172 // these characters.
|
|
173 Beg = I;
|
|
174 return false;
|
|
175 }
|
|
176
|
|
177 return false;
|
|
178 }
|
|
179
|
|
180 bool
|
|
181 clang::analyze_format_string::ParseVectorModifier(FormatStringHandler &H,
|
|
182 FormatSpecifier &FS,
|
|
183 const char *&I,
|
|
184 const char *E,
|
|
185 const LangOptions &LO) {
|
|
186 if (!LO.OpenCL)
|
|
187 return false;
|
|
188
|
|
189 const char *Start = I;
|
|
190 if (*I == 'v') {
|
|
191 ++I;
|
|
192
|
|
193 if (I == E) {
|
|
194 H.HandleIncompleteSpecifier(Start, E - Start);
|
|
195 return true;
|
|
196 }
|
|
197
|
|
198 OptionalAmount NumElts = ParseAmount(I, E);
|
|
199 if (NumElts.getHowSpecified() != OptionalAmount::Constant) {
|
|
200 H.HandleIncompleteSpecifier(Start, E - Start);
|
|
201 return true;
|
|
202 }
|
|
203
|
|
204 FS.setVectorNumElts(NumElts);
|
|
205 }
|
|
206
|
|
207 return false;
|
|
208 }
|
|
209
|
|
210 bool
|
|
211 clang::analyze_format_string::ParseLengthModifier(FormatSpecifier &FS,
|
|
212 const char *&I,
|
|
213 const char *E,
|
|
214 const LangOptions &LO,
|
|
215 bool IsScanf) {
|
|
216 LengthModifier::Kind lmKind = LengthModifier::None;
|
|
217 const char *lmPosition = I;
|
|
218 switch (*I) {
|
|
219 default:
|
|
220 return false;
|
|
221 case 'h':
|
|
222 ++I;
|
|
223 if (I != E && *I == 'h') {
|
|
224 ++I;
|
|
225 lmKind = LengthModifier::AsChar;
|
|
226 } else if (I != E && *I == 'l' && LO.OpenCL) {
|
|
227 ++I;
|
|
228 lmKind = LengthModifier::AsShortLong;
|
|
229 } else {
|
|
230 lmKind = LengthModifier::AsShort;
|
|
231 }
|
|
232 break;
|
|
233 case 'l':
|
|
234 ++I;
|
|
235 if (I != E && *I == 'l') {
|
|
236 ++I;
|
|
237 lmKind = LengthModifier::AsLongLong;
|
|
238 } else {
|
|
239 lmKind = LengthModifier::AsLong;
|
|
240 }
|
|
241 break;
|
|
242 case 'j': lmKind = LengthModifier::AsIntMax; ++I; break;
|
|
243 case 'z': lmKind = LengthModifier::AsSizeT; ++I; break;
|
|
244 case 't': lmKind = LengthModifier::AsPtrDiff; ++I; break;
|
|
245 case 'L': lmKind = LengthModifier::AsLongDouble; ++I; break;
|
|
246 case 'q': lmKind = LengthModifier::AsQuad; ++I; break;
|
|
247 case 'a':
|
|
248 if (IsScanf && !LO.C99 && !LO.CPlusPlus11) {
|
|
249 // For scanf in C90, look at the next character to see if this should
|
|
250 // be parsed as the GNU extension 'a' length modifier. If not, this
|
|
251 // will be parsed as a conversion specifier.
|
|
252 ++I;
|
|
253 if (I != E && (*I == 's' || *I == 'S' || *I == '[')) {
|
|
254 lmKind = LengthModifier::AsAllocate;
|
|
255 break;
|
|
256 }
|
|
257 --I;
|
|
258 }
|
|
259 return false;
|
|
260 case 'm':
|
|
261 if (IsScanf) {
|
|
262 lmKind = LengthModifier::AsMAllocate;
|
|
263 ++I;
|
|
264 break;
|
|
265 }
|
|
266 return false;
|
|
267 // printf: AsInt64, AsInt32, AsInt3264
|
|
268 // scanf: AsInt64
|
|
269 case 'I':
|
|
270 if (I + 1 != E && I + 2 != E) {
|
|
271 if (I[1] == '6' && I[2] == '4') {
|
|
272 I += 3;
|
|
273 lmKind = LengthModifier::AsInt64;
|
|
274 break;
|
|
275 }
|
|
276 if (IsScanf)
|
|
277 return false;
|
|
278
|
|
279 if (I[1] == '3' && I[2] == '2') {
|
|
280 I += 3;
|
|
281 lmKind = LengthModifier::AsInt32;
|
|
282 break;
|
|
283 }
|
|
284 }
|
|
285 ++I;
|
|
286 lmKind = LengthModifier::AsInt3264;
|
|
287 break;
|
|
288 case 'w':
|
|
289 lmKind = LengthModifier::AsWide; ++I; break;
|
|
290 }
|
|
291 LengthModifier lm(lmPosition, lmKind);
|
|
292 FS.setLengthModifier(lm);
|
|
293 return true;
|
|
294 }
|
|
295
|
|
296 bool clang::analyze_format_string::ParseUTF8InvalidSpecifier(
|
|
297 const char *SpecifierBegin, const char *FmtStrEnd, unsigned &Len) {
|
|
298 if (SpecifierBegin + 1 >= FmtStrEnd)
|
|
299 return false;
|
|
300
|
|
301 const llvm::UTF8 *SB =
|
|
302 reinterpret_cast<const llvm::UTF8 *>(SpecifierBegin + 1);
|
|
303 const llvm::UTF8 *SE = reinterpret_cast<const llvm::UTF8 *>(FmtStrEnd);
|
|
304 const char FirstByte = *SB;
|
|
305
|
|
306 // If the invalid specifier is a multibyte UTF-8 string, return the
|
|
307 // total length accordingly so that the conversion specifier can be
|
|
308 // properly updated to reflect a complete UTF-8 specifier.
|
|
309 unsigned NumBytes = llvm::getNumBytesForUTF8(FirstByte);
|
|
310 if (NumBytes == 1)
|
|
311 return false;
|
|
312 if (SB + NumBytes > SE)
|
|
313 return false;
|
|
314
|
|
315 Len = NumBytes + 1;
|
|
316 return true;
|
|
317 }
|
|
318
|
|
319 //===----------------------------------------------------------------------===//
|
|
320 // Methods on ArgType.
|
|
321 //===----------------------------------------------------------------------===//
|
|
322
|
|
323 clang::analyze_format_string::ArgType::MatchKind
|
|
324 ArgType::matchesType(ASTContext &C, QualType argTy) const {
|
|
325 if (Ptr) {
|
|
326 // It has to be a pointer.
|
|
327 const PointerType *PT = argTy->getAs<PointerType>();
|
|
328 if (!PT)
|
|
329 return NoMatch;
|
|
330
|
|
331 // We cannot write through a const qualified pointer.
|
|
332 if (PT->getPointeeType().isConstQualified())
|
|
333 return NoMatch;
|
|
334
|
|
335 argTy = PT->getPointeeType();
|
|
336 }
|
|
337
|
|
338 switch (K) {
|
|
339 case InvalidTy:
|
|
340 llvm_unreachable("ArgType must be valid");
|
|
341
|
|
342 case UnknownTy:
|
|
343 return Match;
|
|
344
|
|
345 case AnyCharTy: {
|
|
346 if (const EnumType *ETy = argTy->getAs<EnumType>()) {
|
|
347 // If the enum is incomplete we know nothing about the underlying type.
|
|
348 // Assume that it's 'int'.
|
|
349 if (!ETy->getDecl()->isComplete())
|
|
350 return NoMatch;
|
|
351 argTy = ETy->getDecl()->getIntegerType();
|
|
352 }
|
|
353
|
|
354 if (const BuiltinType *BT = argTy->getAs<BuiltinType>())
|
|
355 switch (BT->getKind()) {
|
|
356 default:
|
|
357 break;
|
|
358 case BuiltinType::Char_S:
|
|
359 case BuiltinType::SChar:
|
|
360 case BuiltinType::UChar:
|
|
361 case BuiltinType::Char_U:
|
|
362 case BuiltinType::Bool:
|
|
363 return Match;
|
|
364 }
|
|
365 return NoMatch;
|
|
366 }
|
|
367
|
|
368 case SpecificTy: {
|
|
369 if (const EnumType *ETy = argTy->getAs<EnumType>()) {
|
|
370 // If the enum is incomplete we know nothing about the underlying type.
|
|
371 // Assume that it's 'int'.
|
|
372 if (!ETy->getDecl()->isComplete())
|
|
373 argTy = C.IntTy;
|
|
374 else
|
|
375 argTy = ETy->getDecl()->getIntegerType();
|
|
376 }
|
|
377 argTy = C.getCanonicalType(argTy).getUnqualifiedType();
|
|
378
|
|
379 if (T == argTy)
|
|
380 return Match;
|
|
381 // Check for "compatible types".
|
|
382 if (const BuiltinType *BT = argTy->getAs<BuiltinType>())
|
|
383 switch (BT->getKind()) {
|
|
384 default:
|
|
385 break;
|
|
386 case BuiltinType::Char_S:
|
|
387 case BuiltinType::SChar:
|
|
388 case BuiltinType::Char_U:
|
|
389 case BuiltinType::UChar:
|
|
390 case BuiltinType::Bool:
|
|
391 if (T == C.UnsignedShortTy || T == C.ShortTy)
|
|
392 return NoMatchTypeConfusion;
|
|
393 return T == C.UnsignedCharTy || T == C.SignedCharTy ? Match
|
|
394 : NoMatch;
|
|
395 case BuiltinType::Short:
|
|
396 return T == C.UnsignedShortTy ? Match : NoMatch;
|
|
397 case BuiltinType::UShort:
|
|
398 return T == C.ShortTy ? Match : NoMatch;
|
|
399 case BuiltinType::Int:
|
|
400 return T == C.UnsignedIntTy ? Match : NoMatch;
|
|
401 case BuiltinType::UInt:
|
|
402 return T == C.IntTy ? Match : NoMatch;
|
|
403 case BuiltinType::Long:
|
|
404 return T == C.UnsignedLongTy ? Match : NoMatch;
|
|
405 case BuiltinType::ULong:
|
|
406 return T == C.LongTy ? Match : NoMatch;
|
|
407 case BuiltinType::LongLong:
|
|
408 return T == C.UnsignedLongLongTy ? Match : NoMatch;
|
|
409 case BuiltinType::ULongLong:
|
|
410 return T == C.LongLongTy ? Match : NoMatch;
|
|
411 }
|
|
412 return NoMatch;
|
|
413 }
|
|
414
|
|
415 case CStrTy: {
|
|
416 const PointerType *PT = argTy->getAs<PointerType>();
|
|
417 if (!PT)
|
|
418 return NoMatch;
|
|
419 QualType pointeeTy = PT->getPointeeType();
|
|
420 if (const BuiltinType *BT = pointeeTy->getAs<BuiltinType>())
|
|
421 switch (BT->getKind()) {
|
|
422 case BuiltinType::Void:
|
|
423 case BuiltinType::Char_U:
|
|
424 case BuiltinType::UChar:
|
|
425 case BuiltinType::Char_S:
|
|
426 case BuiltinType::SChar:
|
152
|
427 #ifndef noCbC
|
|
428 case BuiltinType::__Code:
|
|
429 #endif
|
150
|
430 return Match;
|
|
431 default:
|
|
432 break;
|
|
433 }
|
|
434
|
|
435 return NoMatch;
|
|
436 }
|
|
437
|
|
438 case WCStrTy: {
|
|
439 const PointerType *PT = argTy->getAs<PointerType>();
|
|
440 if (!PT)
|
|
441 return NoMatch;
|
|
442 QualType pointeeTy =
|
|
443 C.getCanonicalType(PT->getPointeeType()).getUnqualifiedType();
|
|
444 return pointeeTy == C.getWideCharType() ? Match : NoMatch;
|
|
445 }
|
|
446
|
|
447 case WIntTy: {
|
|
448 QualType WInt = C.getCanonicalType(C.getWIntType()).getUnqualifiedType();
|
|
449
|
|
450 if (C.getCanonicalType(argTy).getUnqualifiedType() == WInt)
|
|
451 return Match;
|
|
452
|
|
453 QualType PromoArg = argTy->isPromotableIntegerType()
|
|
454 ? C.getPromotedIntegerType(argTy)
|
|
455 : argTy;
|
|
456 PromoArg = C.getCanonicalType(PromoArg).getUnqualifiedType();
|
|
457
|
|
458 // If the promoted argument is the corresponding signed type of the
|
|
459 // wint_t type, then it should match.
|
|
460 if (PromoArg->hasSignedIntegerRepresentation() &&
|
|
461 C.getCorrespondingUnsignedType(PromoArg) == WInt)
|
|
462 return Match;
|
|
463
|
|
464 return WInt == PromoArg ? Match : NoMatch;
|
|
465 }
|
|
466
|
|
467 case CPointerTy:
|
|
468 if (argTy->isVoidPointerType()) {
|
|
469 return Match;
|
|
470 } if (argTy->isPointerType() || argTy->isObjCObjectPointerType() ||
|
|
471 argTy->isBlockPointerType() || argTy->isNullPtrType()) {
|
|
472 return NoMatchPedantic;
|
|
473 } else {
|
|
474 return NoMatch;
|
|
475 }
|
|
476
|
|
477 case ObjCPointerTy: {
|
|
478 if (argTy->getAs<ObjCObjectPointerType>() ||
|
|
479 argTy->getAs<BlockPointerType>())
|
|
480 return Match;
|
|
481
|
|
482 // Handle implicit toll-free bridging.
|
|
483 if (const PointerType *PT = argTy->getAs<PointerType>()) {
|
|
484 // Things such as CFTypeRef are really just opaque pointers
|
|
485 // to C structs representing CF types that can often be bridged
|
|
486 // to Objective-C objects. Since the compiler doesn't know which
|
|
487 // structs can be toll-free bridged, we just accept them all.
|
|
488 QualType pointee = PT->getPointeeType();
|
|
489 if (pointee->getAsStructureType() || pointee->isVoidType())
|
|
490 return Match;
|
|
491 }
|
|
492 return NoMatch;
|
|
493 }
|
|
494 }
|
|
495
|
|
496 llvm_unreachable("Invalid ArgType Kind!");
|
|
497 }
|
|
498
|
|
499 ArgType ArgType::makeVectorType(ASTContext &C, unsigned NumElts) const {
|
|
500 // Check for valid vector element types.
|
|
501 if (T.isNull())
|
|
502 return ArgType::Invalid();
|
|
503
|
|
504 QualType Vec = C.getExtVectorType(T, NumElts);
|
|
505 return ArgType(Vec, Name);
|
|
506 }
|
|
507
|
|
508 QualType ArgType::getRepresentativeType(ASTContext &C) const {
|
|
509 QualType Res;
|
|
510 switch (K) {
|
|
511 case InvalidTy:
|
|
512 llvm_unreachable("No representative type for Invalid ArgType");
|
|
513 case UnknownTy:
|
|
514 llvm_unreachable("No representative type for Unknown ArgType");
|
|
515 case AnyCharTy:
|
|
516 Res = C.CharTy;
|
|
517 break;
|
|
518 case SpecificTy:
|
|
519 Res = T;
|
|
520 break;
|
|
521 case CStrTy:
|
|
522 Res = C.getPointerType(C.CharTy);
|
|
523 break;
|
|
524 case WCStrTy:
|
|
525 Res = C.getPointerType(C.getWideCharType());
|
|
526 break;
|
|
527 case ObjCPointerTy:
|
|
528 Res = C.ObjCBuiltinIdTy;
|
|
529 break;
|
|
530 case CPointerTy:
|
|
531 Res = C.VoidPtrTy;
|
|
532 break;
|
|
533 case WIntTy: {
|
|
534 Res = C.getWIntType();
|
|
535 break;
|
|
536 }
|
|
537 }
|
|
538
|
|
539 if (Ptr)
|
|
540 Res = C.getPointerType(Res);
|
|
541 return Res;
|
|
542 }
|
|
543
|
|
544 std::string ArgType::getRepresentativeTypeName(ASTContext &C) const {
|
173
|
545 std::string S = getRepresentativeType(C).getAsString(C.getPrintingPolicy());
|
150
|
546
|
|
547 std::string Alias;
|
|
548 if (Name) {
|
|
549 // Use a specific name for this type, e.g. "size_t".
|
|
550 Alias = Name;
|
|
551 if (Ptr) {
|
|
552 // If ArgType is actually a pointer to T, append an asterisk.
|
|
553 Alias += (Alias[Alias.size()-1] == '*') ? "*" : " *";
|
|
554 }
|
|
555 // If Alias is the same as the underlying type, e.g. wchar_t, then drop it.
|
|
556 if (S == Alias)
|
|
557 Alias.clear();
|
|
558 }
|
|
559
|
|
560 if (!Alias.empty())
|
|
561 return std::string("'") + Alias + "' (aka '" + S + "')";
|
|
562 return std::string("'") + S + "'";
|
|
563 }
|
|
564
|
|
565
|
|
566 //===----------------------------------------------------------------------===//
|
|
567 // Methods on OptionalAmount.
|
|
568 //===----------------------------------------------------------------------===//
|
|
569
|
|
570 ArgType
|
|
571 analyze_format_string::OptionalAmount::getArgType(ASTContext &Ctx) const {
|
|
572 return Ctx.IntTy;
|
|
573 }
|
|
574
|
|
575 //===----------------------------------------------------------------------===//
|
|
576 // Methods on LengthModifier.
|
|
577 //===----------------------------------------------------------------------===//
|
|
578
|
|
579 const char *
|
|
580 analyze_format_string::LengthModifier::toString() const {
|
|
581 switch (kind) {
|
|
582 case AsChar:
|
|
583 return "hh";
|
|
584 case AsShort:
|
|
585 return "h";
|
|
586 case AsShortLong:
|
|
587 return "hl";
|
|
588 case AsLong: // or AsWideChar
|
|
589 return "l";
|
|
590 case AsLongLong:
|
|
591 return "ll";
|
|
592 case AsQuad:
|
|
593 return "q";
|
|
594 case AsIntMax:
|
|
595 return "j";
|
|
596 case AsSizeT:
|
|
597 return "z";
|
|
598 case AsPtrDiff:
|
|
599 return "t";
|
|
600 case AsInt32:
|
|
601 return "I32";
|
|
602 case AsInt3264:
|
|
603 return "I";
|
|
604 case AsInt64:
|
|
605 return "I64";
|
|
606 case AsLongDouble:
|
|
607 return "L";
|
|
608 case AsAllocate:
|
|
609 return "a";
|
|
610 case AsMAllocate:
|
|
611 return "m";
|
|
612 case AsWide:
|
|
613 return "w";
|
|
614 case None:
|
|
615 return "";
|
|
616 }
|
|
617 return nullptr;
|
|
618 }
|
|
619
|
|
620 //===----------------------------------------------------------------------===//
|
|
621 // Methods on ConversionSpecifier.
|
|
622 //===----------------------------------------------------------------------===//
|
|
623
|
|
624 const char *ConversionSpecifier::toString() const {
|
|
625 switch (kind) {
|
|
626 case dArg: return "d";
|
|
627 case DArg: return "D";
|
|
628 case iArg: return "i";
|
|
629 case oArg: return "o";
|
|
630 case OArg: return "O";
|
|
631 case uArg: return "u";
|
|
632 case UArg: return "U";
|
|
633 case xArg: return "x";
|
|
634 case XArg: return "X";
|
|
635 case fArg: return "f";
|
|
636 case FArg: return "F";
|
|
637 case eArg: return "e";
|
|
638 case EArg: return "E";
|
|
639 case gArg: return "g";
|
|
640 case GArg: return "G";
|
|
641 case aArg: return "a";
|
|
642 case AArg: return "A";
|
|
643 case cArg: return "c";
|
|
644 case sArg: return "s";
|
|
645 case pArg: return "p";
|
|
646 case PArg:
|
|
647 return "P";
|
|
648 case nArg: return "n";
|
|
649 case PercentArg: return "%";
|
|
650 case ScanListArg: return "[";
|
|
651 case InvalidSpecifier: return nullptr;
|
|
652
|
|
653 // POSIX unicode extensions.
|
|
654 case CArg: return "C";
|
|
655 case SArg: return "S";
|
|
656
|
|
657 // Objective-C specific specifiers.
|
|
658 case ObjCObjArg: return "@";
|
|
659
|
|
660 // FreeBSD kernel specific specifiers.
|
|
661 case FreeBSDbArg: return "b";
|
|
662 case FreeBSDDArg: return "D";
|
|
663 case FreeBSDrArg: return "r";
|
|
664 case FreeBSDyArg: return "y";
|
|
665
|
|
666 // GlibC specific specifiers.
|
|
667 case PrintErrno: return "m";
|
|
668
|
|
669 // MS specific specifiers.
|
|
670 case ZArg: return "Z";
|
|
671 }
|
|
672 return nullptr;
|
|
673 }
|
|
674
|
|
675 Optional<ConversionSpecifier>
|
|
676 ConversionSpecifier::getStandardSpecifier() const {
|
|
677 ConversionSpecifier::Kind NewKind;
|
|
678
|
|
679 switch (getKind()) {
|
|
680 default:
|
|
681 return None;
|
|
682 case DArg:
|
|
683 NewKind = dArg;
|
|
684 break;
|
|
685 case UArg:
|
|
686 NewKind = uArg;
|
|
687 break;
|
|
688 case OArg:
|
|
689 NewKind = oArg;
|
|
690 break;
|
|
691 }
|
|
692
|
|
693 ConversionSpecifier FixedCS(*this);
|
|
694 FixedCS.setKind(NewKind);
|
|
695 return FixedCS;
|
|
696 }
|
|
697
|
|
698 //===----------------------------------------------------------------------===//
|
|
699 // Methods on OptionalAmount.
|
|
700 //===----------------------------------------------------------------------===//
|
|
701
|
|
702 void OptionalAmount::toString(raw_ostream &os) const {
|
|
703 switch (hs) {
|
|
704 case Invalid:
|
|
705 case NotSpecified:
|
|
706 return;
|
|
707 case Arg:
|
|
708 if (UsesDotPrefix)
|
|
709 os << ".";
|
|
710 if (usesPositionalArg())
|
|
711 os << "*" << getPositionalArgIndex() << "$";
|
|
712 else
|
|
713 os << "*";
|
|
714 break;
|
|
715 case Constant:
|
|
716 if (UsesDotPrefix)
|
|
717 os << ".";
|
|
718 os << amt;
|
|
719 break;
|
|
720 }
|
|
721 }
|
|
722
|
|
723 bool FormatSpecifier::hasValidLengthModifier(const TargetInfo &Target,
|
|
724 const LangOptions &LO) const {
|
|
725 switch (LM.getKind()) {
|
|
726 case LengthModifier::None:
|
|
727 return true;
|
|
728
|
|
729 // Handle most integer flags
|
|
730 case LengthModifier::AsShort:
|
|
731 // Length modifier only applies to FP vectors.
|
|
732 if (LO.OpenCL && CS.isDoubleArg())
|
|
733 return !VectorNumElts.isInvalid();
|
|
734
|
|
735 if (Target.getTriple().isOSMSVCRT()) {
|
|
736 switch (CS.getKind()) {
|
|
737 case ConversionSpecifier::cArg:
|
|
738 case ConversionSpecifier::CArg:
|
|
739 case ConversionSpecifier::sArg:
|
|
740 case ConversionSpecifier::SArg:
|
|
741 case ConversionSpecifier::ZArg:
|
|
742 return true;
|
|
743 default:
|
|
744 break;
|
|
745 }
|
|
746 }
|
|
747 LLVM_FALLTHROUGH;
|
|
748 case LengthModifier::AsChar:
|
|
749 case LengthModifier::AsLongLong:
|
|
750 case LengthModifier::AsQuad:
|
|
751 case LengthModifier::AsIntMax:
|
|
752 case LengthModifier::AsSizeT:
|
|
753 case LengthModifier::AsPtrDiff:
|
|
754 switch (CS.getKind()) {
|
|
755 case ConversionSpecifier::dArg:
|
|
756 case ConversionSpecifier::DArg:
|
|
757 case ConversionSpecifier::iArg:
|
|
758 case ConversionSpecifier::oArg:
|
|
759 case ConversionSpecifier::OArg:
|
|
760 case ConversionSpecifier::uArg:
|
|
761 case ConversionSpecifier::UArg:
|
|
762 case ConversionSpecifier::xArg:
|
|
763 case ConversionSpecifier::XArg:
|
|
764 case ConversionSpecifier::nArg:
|
|
765 return true;
|
|
766 case ConversionSpecifier::FreeBSDrArg:
|
|
767 case ConversionSpecifier::FreeBSDyArg:
|
|
768 return Target.getTriple().isOSFreeBSD() || Target.getTriple().isPS4();
|
|
769 default:
|
|
770 return false;
|
|
771 }
|
|
772
|
|
773 case LengthModifier::AsShortLong:
|
|
774 return LO.OpenCL && !VectorNumElts.isInvalid();
|
|
775
|
|
776 // Handle 'l' flag
|
|
777 case LengthModifier::AsLong: // or AsWideChar
|
|
778 if (CS.isDoubleArg()) {
|
|
779 // Invalid for OpenCL FP scalars.
|
|
780 if (LO.OpenCL && VectorNumElts.isInvalid())
|
|
781 return false;
|
|
782 return true;
|
|
783 }
|
|
784
|
|
785 switch (CS.getKind()) {
|
|
786 case ConversionSpecifier::dArg:
|
|
787 case ConversionSpecifier::DArg:
|
|
788 case ConversionSpecifier::iArg:
|
|
789 case ConversionSpecifier::oArg:
|
|
790 case ConversionSpecifier::OArg:
|
|
791 case ConversionSpecifier::uArg:
|
|
792 case ConversionSpecifier::UArg:
|
|
793 case ConversionSpecifier::xArg:
|
|
794 case ConversionSpecifier::XArg:
|
|
795 case ConversionSpecifier::nArg:
|
|
796 case ConversionSpecifier::cArg:
|
|
797 case ConversionSpecifier::sArg:
|
|
798 case ConversionSpecifier::ScanListArg:
|
|
799 case ConversionSpecifier::ZArg:
|
|
800 return true;
|
|
801 case ConversionSpecifier::FreeBSDrArg:
|
|
802 case ConversionSpecifier::FreeBSDyArg:
|
|
803 return Target.getTriple().isOSFreeBSD() || Target.getTriple().isPS4();
|
|
804 default:
|
|
805 return false;
|
|
806 }
|
|
807
|
|
808 case LengthModifier::AsLongDouble:
|
|
809 switch (CS.getKind()) {
|
|
810 case ConversionSpecifier::aArg:
|
|
811 case ConversionSpecifier::AArg:
|
|
812 case ConversionSpecifier::fArg:
|
|
813 case ConversionSpecifier::FArg:
|
|
814 case ConversionSpecifier::eArg:
|
|
815 case ConversionSpecifier::EArg:
|
|
816 case ConversionSpecifier::gArg:
|
|
817 case ConversionSpecifier::GArg:
|
|
818 return true;
|
|
819 // GNU libc extension.
|
|
820 case ConversionSpecifier::dArg:
|
|
821 case ConversionSpecifier::iArg:
|
|
822 case ConversionSpecifier::oArg:
|
|
823 case ConversionSpecifier::uArg:
|
|
824 case ConversionSpecifier::xArg:
|
|
825 case ConversionSpecifier::XArg:
|
|
826 return !Target.getTriple().isOSDarwin() &&
|
|
827 !Target.getTriple().isOSWindows();
|
|
828 default:
|
|
829 return false;
|
|
830 }
|
|
831
|
|
832 case LengthModifier::AsAllocate:
|
|
833 switch (CS.getKind()) {
|
|
834 case ConversionSpecifier::sArg:
|
|
835 case ConversionSpecifier::SArg:
|
|
836 case ConversionSpecifier::ScanListArg:
|
|
837 return true;
|
|
838 default:
|
|
839 return false;
|
|
840 }
|
|
841
|
|
842 case LengthModifier::AsMAllocate:
|
|
843 switch (CS.getKind()) {
|
|
844 case ConversionSpecifier::cArg:
|
|
845 case ConversionSpecifier::CArg:
|
|
846 case ConversionSpecifier::sArg:
|
|
847 case ConversionSpecifier::SArg:
|
|
848 case ConversionSpecifier::ScanListArg:
|
|
849 return true;
|
|
850 default:
|
|
851 return false;
|
|
852 }
|
|
853 case LengthModifier::AsInt32:
|
|
854 case LengthModifier::AsInt3264:
|
|
855 case LengthModifier::AsInt64:
|
|
856 switch (CS.getKind()) {
|
|
857 case ConversionSpecifier::dArg:
|
|
858 case ConversionSpecifier::iArg:
|
|
859 case ConversionSpecifier::oArg:
|
|
860 case ConversionSpecifier::uArg:
|
|
861 case ConversionSpecifier::xArg:
|
|
862 case ConversionSpecifier::XArg:
|
|
863 return Target.getTriple().isOSMSVCRT();
|
|
864 default:
|
|
865 return false;
|
|
866 }
|
|
867 case LengthModifier::AsWide:
|
|
868 switch (CS.getKind()) {
|
|
869 case ConversionSpecifier::cArg:
|
|
870 case ConversionSpecifier::CArg:
|
|
871 case ConversionSpecifier::sArg:
|
|
872 case ConversionSpecifier::SArg:
|
|
873 case ConversionSpecifier::ZArg:
|
|
874 return Target.getTriple().isOSMSVCRT();
|
|
875 default:
|
|
876 return false;
|
|
877 }
|
|
878 }
|
|
879 llvm_unreachable("Invalid LengthModifier Kind!");
|
|
880 }
|
|
881
|
|
882 bool FormatSpecifier::hasStandardLengthModifier() const {
|
|
883 switch (LM.getKind()) {
|
|
884 case LengthModifier::None:
|
|
885 case LengthModifier::AsChar:
|
|
886 case LengthModifier::AsShort:
|
|
887 case LengthModifier::AsLong:
|
|
888 case LengthModifier::AsLongLong:
|
|
889 case LengthModifier::AsIntMax:
|
|
890 case LengthModifier::AsSizeT:
|
|
891 case LengthModifier::AsPtrDiff:
|
|
892 case LengthModifier::AsLongDouble:
|
|
893 return true;
|
|
894 case LengthModifier::AsAllocate:
|
|
895 case LengthModifier::AsMAllocate:
|
|
896 case LengthModifier::AsQuad:
|
|
897 case LengthModifier::AsInt32:
|
|
898 case LengthModifier::AsInt3264:
|
|
899 case LengthModifier::AsInt64:
|
|
900 case LengthModifier::AsWide:
|
|
901 case LengthModifier::AsShortLong: // ???
|
|
902 return false;
|
|
903 }
|
|
904 llvm_unreachable("Invalid LengthModifier Kind!");
|
|
905 }
|
|
906
|
|
907 bool FormatSpecifier::hasStandardConversionSpecifier(
|
|
908 const LangOptions &LangOpt) const {
|
|
909 switch (CS.getKind()) {
|
|
910 case ConversionSpecifier::cArg:
|
|
911 case ConversionSpecifier::dArg:
|
|
912 case ConversionSpecifier::iArg:
|
|
913 case ConversionSpecifier::oArg:
|
|
914 case ConversionSpecifier::uArg:
|
|
915 case ConversionSpecifier::xArg:
|
|
916 case ConversionSpecifier::XArg:
|
|
917 case ConversionSpecifier::fArg:
|
|
918 case ConversionSpecifier::FArg:
|
|
919 case ConversionSpecifier::eArg:
|
|
920 case ConversionSpecifier::EArg:
|
|
921 case ConversionSpecifier::gArg:
|
|
922 case ConversionSpecifier::GArg:
|
|
923 case ConversionSpecifier::aArg:
|
|
924 case ConversionSpecifier::AArg:
|
|
925 case ConversionSpecifier::sArg:
|
|
926 case ConversionSpecifier::pArg:
|
|
927 case ConversionSpecifier::nArg:
|
|
928 case ConversionSpecifier::ObjCObjArg:
|
|
929 case ConversionSpecifier::ScanListArg:
|
|
930 case ConversionSpecifier::PercentArg:
|
|
931 case ConversionSpecifier::PArg:
|
|
932 return true;
|
|
933 case ConversionSpecifier::CArg:
|
|
934 case ConversionSpecifier::SArg:
|
|
935 return LangOpt.ObjC;
|
|
936 case ConversionSpecifier::InvalidSpecifier:
|
|
937 case ConversionSpecifier::FreeBSDbArg:
|
|
938 case ConversionSpecifier::FreeBSDDArg:
|
|
939 case ConversionSpecifier::FreeBSDrArg:
|
|
940 case ConversionSpecifier::FreeBSDyArg:
|
|
941 case ConversionSpecifier::PrintErrno:
|
|
942 case ConversionSpecifier::DArg:
|
|
943 case ConversionSpecifier::OArg:
|
|
944 case ConversionSpecifier::UArg:
|
|
945 case ConversionSpecifier::ZArg:
|
|
946 return false;
|
|
947 }
|
|
948 llvm_unreachable("Invalid ConversionSpecifier Kind!");
|
|
949 }
|
|
950
|
|
951 bool FormatSpecifier::hasStandardLengthConversionCombination() const {
|
|
952 if (LM.getKind() == LengthModifier::AsLongDouble) {
|
|
953 switch(CS.getKind()) {
|
|
954 case ConversionSpecifier::dArg:
|
|
955 case ConversionSpecifier::iArg:
|
|
956 case ConversionSpecifier::oArg:
|
|
957 case ConversionSpecifier::uArg:
|
|
958 case ConversionSpecifier::xArg:
|
|
959 case ConversionSpecifier::XArg:
|
|
960 return false;
|
|
961 default:
|
|
962 return true;
|
|
963 }
|
|
964 }
|
|
965 return true;
|
|
966 }
|
|
967
|
|
968 Optional<LengthModifier> FormatSpecifier::getCorrectedLengthModifier() const {
|
|
969 if (CS.isAnyIntArg() || CS.getKind() == ConversionSpecifier::nArg) {
|
|
970 if (LM.getKind() == LengthModifier::AsLongDouble ||
|
|
971 LM.getKind() == LengthModifier::AsQuad) {
|
|
972 LengthModifier FixedLM(LM);
|
|
973 FixedLM.setKind(LengthModifier::AsLongLong);
|
|
974 return FixedLM;
|
|
975 }
|
|
976 }
|
|
977
|
|
978 return None;
|
|
979 }
|
|
980
|
|
981 bool FormatSpecifier::namedTypeToLengthModifier(QualType QT,
|
|
982 LengthModifier &LM) {
|
|
983 assert(isa<TypedefType>(QT) && "Expected a TypedefType");
|
|
984 const TypedefNameDecl *Typedef = cast<TypedefType>(QT)->getDecl();
|
|
985
|
|
986 for (;;) {
|
|
987 const IdentifierInfo *Identifier = Typedef->getIdentifier();
|
|
988 if (Identifier->getName() == "size_t") {
|
|
989 LM.setKind(LengthModifier::AsSizeT);
|
|
990 return true;
|
|
991 } else if (Identifier->getName() == "ssize_t") {
|
|
992 // Not C99, but common in Unix.
|
|
993 LM.setKind(LengthModifier::AsSizeT);
|
|
994 return true;
|
|
995 } else if (Identifier->getName() == "intmax_t") {
|
|
996 LM.setKind(LengthModifier::AsIntMax);
|
|
997 return true;
|
|
998 } else if (Identifier->getName() == "uintmax_t") {
|
|
999 LM.setKind(LengthModifier::AsIntMax);
|
|
1000 return true;
|
|
1001 } else if (Identifier->getName() == "ptrdiff_t") {
|
|
1002 LM.setKind(LengthModifier::AsPtrDiff);
|
|
1003 return true;
|
|
1004 }
|
|
1005
|
|
1006 QualType T = Typedef->getUnderlyingType();
|
|
1007 if (!isa<TypedefType>(T))
|
|
1008 break;
|
|
1009
|
|
1010 Typedef = cast<TypedefType>(T)->getDecl();
|
|
1011 }
|
|
1012 return false;
|
|
1013 }
|