Coverage Report

Created: 2024-01-17 10:31

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