Ted Kremenek | d9c904d | 2010-07-16 02:11:31 +0000 | [diff] [blame] | 1 | //= ScanfFormatString.cpp - Analysis of printf format strings --*- C++ -*-===// |
| 2 | // |
| 3 | // The LLVM Compiler Infrastructure |
| 4 | // |
| 5 | // This file is distributed under the University of Illinois Open Source |
| 6 | // License. See LICENSE.TXT for details. |
| 7 | // |
| 8 | //===----------------------------------------------------------------------===// |
| 9 | // |
| 10 | // Handling of format string in scanf and friends. The structure of format |
| 11 | // strings for fscanf() are described in C99 7.19.6.2. |
| 12 | // |
| 13 | //===----------------------------------------------------------------------===// |
| 14 | |
| 15 | #include "clang/Analysis/Analyses/FormatString.h" |
| 16 | #include "FormatStringParsing.h" |
Chandler Carruth | 55fc873 | 2012-12-04 09:13:33 +0000 | [diff] [blame] | 17 | #include "clang/Basic/TargetInfo.h" |
Ted Kremenek | d9c904d | 2010-07-16 02:11:31 +0000 | [diff] [blame] | 18 | |
Hans Wennborg | f3749f4 | 2012-08-07 08:11:26 +0000 | [diff] [blame] | 19 | using clang::analyze_format_string::ArgType; |
Ted Kremenek | d9c904d | 2010-07-16 02:11:31 +0000 | [diff] [blame] | 20 | using clang::analyze_format_string::FormatStringHandler; |
| 21 | using clang::analyze_format_string::LengthModifier; |
| 22 | using clang::analyze_format_string::OptionalAmount; |
Ted Kremenek | 1e51c20 | 2010-07-20 20:04:47 +0000 | [diff] [blame] | 23 | using clang::analyze_format_string::ConversionSpecifier; |
Ted Kremenek | 6ecb950 | 2010-07-20 20:04:27 +0000 | [diff] [blame] | 24 | using clang::analyze_scanf::ScanfConversionSpecifier; |
Ted Kremenek | d9c904d | 2010-07-16 02:11:31 +0000 | [diff] [blame] | 25 | using clang::analyze_scanf::ScanfSpecifier; |
Dan Gohman | 3c46e8d | 2010-07-26 21:25:24 +0000 | [diff] [blame] | 26 | using clang::UpdateOnReturn; |
Hans Wennborg | 6fcd932 | 2011-12-10 13:20:11 +0000 | [diff] [blame] | 27 | using namespace clang; |
Ted Kremenek | d9c904d | 2010-07-16 02:11:31 +0000 | [diff] [blame] | 28 | |
| 29 | typedef clang::analyze_format_string::SpecifierResult<ScanfSpecifier> |
| 30 | ScanfSpecifierResult; |
| 31 | |
| 32 | static bool ParseScanList(FormatStringHandler &H, |
Ted Kremenek | 6ecb950 | 2010-07-20 20:04:27 +0000 | [diff] [blame] | 33 | ScanfConversionSpecifier &CS, |
Ted Kremenek | d9c904d | 2010-07-16 02:11:31 +0000 | [diff] [blame] | 34 | const char *&Beg, const char *E) { |
| 35 | const char *I = Beg; |
| 36 | const char *start = I - 1; |
| 37 | UpdateOnReturn <const char*> UpdateBeg(Beg, I); |
| 38 | |
| 39 | // No more characters? |
| 40 | if (I == E) { |
| 41 | H.HandleIncompleteScanList(start, I); |
| 42 | return true; |
| 43 | } |
| 44 | |
| 45 | // Special case: ']' is the first character. |
| 46 | if (*I == ']') { |
| 47 | if (++I == E) { |
Ted Kremenek | b7c2101 | 2010-07-16 18:28:03 +0000 | [diff] [blame] | 48 | H.HandleIncompleteScanList(start, I - 1); |
Ted Kremenek | d9c904d | 2010-07-16 02:11:31 +0000 | [diff] [blame] | 49 | return true; |
| 50 | } |
| 51 | } |
| 52 | |
Stephen Hines | 6bcf27b | 2014-05-29 04:14:42 -0700 | [diff] [blame] | 53 | // Special case: "^]" are the first characters. |
| 54 | if (I + 1 != E && I[0] == '^' && I[1] == ']') { |
| 55 | I += 2; |
| 56 | if (I == E) { |
| 57 | H.HandleIncompleteScanList(start, I - 1); |
| 58 | return true; |
| 59 | } |
| 60 | } |
| 61 | |
Ted Kremenek | d9c904d | 2010-07-16 02:11:31 +0000 | [diff] [blame] | 62 | // Look for a ']' character which denotes the end of the scan list. |
| 63 | while (*I != ']') { |
| 64 | if (++I == E) { |
Ted Kremenek | b7c2101 | 2010-07-16 18:28:03 +0000 | [diff] [blame] | 65 | H.HandleIncompleteScanList(start, I - 1); |
Ted Kremenek | d9c904d | 2010-07-16 02:11:31 +0000 | [diff] [blame] | 66 | return true; |
| 67 | } |
| 68 | } |
| 69 | |
| 70 | CS.setEndScanList(I); |
| 71 | return false; |
| 72 | } |
| 73 | |
| 74 | // FIXME: Much of this is copy-paste from ParsePrintfSpecifier. |
| 75 | // We can possibly refactor. |
| 76 | static ScanfSpecifierResult ParseScanfSpecifier(FormatStringHandler &H, |
| 77 | const char *&Beg, |
| 78 | const char *E, |
Hans Wennborg | d02deeb | 2011-12-15 10:25:47 +0000 | [diff] [blame] | 79 | unsigned &argIndex, |
Jordan Rose | 275b6f5 | 2012-09-13 02:11:03 +0000 | [diff] [blame] | 80 | const LangOptions &LO, |
| 81 | const TargetInfo &Target) { |
Ted Kremenek | d9c904d | 2010-07-16 02:11:31 +0000 | [diff] [blame] | 82 | |
| 83 | using namespace clang::analyze_scanf; |
| 84 | const char *I = Beg; |
Stephen Hines | 6bcf27b | 2014-05-29 04:14:42 -0700 | [diff] [blame] | 85 | const char *Start = nullptr; |
Ted Kremenek | d9c904d | 2010-07-16 02:11:31 +0000 | [diff] [blame] | 86 | UpdateOnReturn <const char*> UpdateBeg(Beg, I); |
| 87 | |
| 88 | // Look for a '%' character that indicates the start of a format specifier. |
| 89 | for ( ; I != E ; ++I) { |
| 90 | char c = *I; |
| 91 | if (c == '\0') { |
| 92 | // Detect spurious null characters, which are likely errors. |
| 93 | H.HandleNullChar(I); |
| 94 | return true; |
| 95 | } |
| 96 | if (c == '%') { |
| 97 | Start = I++; // Record the start of the format specifier. |
| 98 | break; |
| 99 | } |
| 100 | } |
| 101 | |
| 102 | // No format specifier found? |
| 103 | if (!Start) |
| 104 | return false; |
| 105 | |
| 106 | if (I == E) { |
| 107 | // No more characters left? |
| 108 | H.HandleIncompleteSpecifier(Start, E - Start); |
| 109 | return true; |
| 110 | } |
| 111 | |
| 112 | ScanfSpecifier FS; |
| 113 | if (ParseArgPosition(H, FS, Start, I, E)) |
| 114 | return true; |
| 115 | |
| 116 | if (I == E) { |
| 117 | // No more characters left? |
| 118 | H.HandleIncompleteSpecifier(Start, E - Start); |
| 119 | return true; |
| 120 | } |
| 121 | |
| 122 | // Look for '*' flag if it is present. |
| 123 | if (*I == '*') { |
| 124 | FS.setSuppressAssignment(I); |
| 125 | if (++I == E) { |
| 126 | H.HandleIncompleteSpecifier(Start, E - Start); |
| 127 | return true; |
| 128 | } |
| 129 | } |
| 130 | |
| 131 | // Look for the field width (if any). Unlike printf, this is either |
| 132 | // a fixed integer or isn't present. |
| 133 | const OptionalAmount &Amt = clang::analyze_format_string::ParseAmount(I, E); |
| 134 | if (Amt.getHowSpecified() != OptionalAmount::NotSpecified) { |
| 135 | assert(Amt.getHowSpecified() == OptionalAmount::Constant); |
| 136 | FS.setFieldWidth(Amt); |
| 137 | |
| 138 | if (I == E) { |
| 139 | // No more characters left? |
| 140 | H.HandleIncompleteSpecifier(Start, E - Start); |
| 141 | return true; |
| 142 | } |
| 143 | } |
| 144 | |
| 145 | // Look for the length modifier. |
Hans Wennborg | d02deeb | 2011-12-15 10:25:47 +0000 | [diff] [blame] | 146 | if (ParseLengthModifier(FS, I, E, LO, /*scanf=*/true) && I == E) { |
Ted Kremenek | d9c904d | 2010-07-16 02:11:31 +0000 | [diff] [blame] | 147 | // No more characters left? |
| 148 | H.HandleIncompleteSpecifier(Start, E - Start); |
| 149 | return true; |
| 150 | } |
| 151 | |
| 152 | // Detect spurious null characters, which are likely errors. |
| 153 | if (*I == '\0') { |
| 154 | H.HandleNullChar(I); |
| 155 | return true; |
| 156 | } |
| 157 | |
| 158 | // Finally, look for the conversion specifier. |
| 159 | const char *conversionPosition = I++; |
Ted Kremenek | 6ecb950 | 2010-07-20 20:04:27 +0000 | [diff] [blame] | 160 | ScanfConversionSpecifier::Kind k = ScanfConversionSpecifier::InvalidSpecifier; |
Ted Kremenek | d9c904d | 2010-07-16 02:11:31 +0000 | [diff] [blame] | 161 | switch (*conversionPosition) { |
| 162 | default: |
| 163 | break; |
Ted Kremenek | 1e51c20 | 2010-07-20 20:04:47 +0000 | [diff] [blame] | 164 | case '%': k = ConversionSpecifier::PercentArg; break; |
| 165 | case 'A': k = ConversionSpecifier::AArg; break; |
| 166 | case 'E': k = ConversionSpecifier::EArg; break; |
| 167 | case 'F': k = ConversionSpecifier::FArg; break; |
| 168 | case 'G': k = ConversionSpecifier::GArg; break; |
| 169 | case 'X': k = ConversionSpecifier::XArg; break; |
| 170 | case 'a': k = ConversionSpecifier::aArg; break; |
| 171 | case 'd': k = ConversionSpecifier::dArg; break; |
| 172 | case 'e': k = ConversionSpecifier::eArg; break; |
| 173 | case 'f': k = ConversionSpecifier::fArg; break; |
| 174 | case 'g': k = ConversionSpecifier::gArg; break; |
| 175 | case 'i': k = ConversionSpecifier::iArg; break; |
| 176 | case 'n': k = ConversionSpecifier::nArg; break; |
| 177 | case 'c': k = ConversionSpecifier::cArg; break; |
| 178 | case 'C': k = ConversionSpecifier::CArg; break; |
| 179 | case 'S': k = ConversionSpecifier::SArg; break; |
| 180 | case '[': k = ConversionSpecifier::ScanListArg; break; |
| 181 | case 'u': k = ConversionSpecifier::uArg; break; |
| 182 | case 'x': k = ConversionSpecifier::xArg; break; |
| 183 | case 'o': k = ConversionSpecifier::oArg; break; |
| 184 | case 's': k = ConversionSpecifier::sArg; break; |
| 185 | case 'p': k = ConversionSpecifier::pArg; break; |
Jordan Rose | 275b6f5 | 2012-09-13 02:11:03 +0000 | [diff] [blame] | 186 | // Apple extensions |
| 187 | // Apple-specific |
| 188 | case 'D': |
| 189 | if (Target.getTriple().isOSDarwin()) |
| 190 | k = ConversionSpecifier::DArg; |
| 191 | break; |
| 192 | case 'O': |
| 193 | if (Target.getTriple().isOSDarwin()) |
| 194 | k = ConversionSpecifier::OArg; |
| 195 | break; |
| 196 | case 'U': |
| 197 | if (Target.getTriple().isOSDarwin()) |
| 198 | k = ConversionSpecifier::UArg; |
| 199 | break; |
Ted Kremenek | d9c904d | 2010-07-16 02:11:31 +0000 | [diff] [blame] | 200 | } |
Ted Kremenek | 6ecb950 | 2010-07-20 20:04:27 +0000 | [diff] [blame] | 201 | ScanfConversionSpecifier CS(conversionPosition, k); |
| 202 | if (k == ScanfConversionSpecifier::ScanListArg) { |
Hans Wennborg | 6de0b48 | 2012-01-12 14:44:54 +0000 | [diff] [blame] | 203 | if (ParseScanList(H, CS, I, E)) |
Ted Kremenek | d9c904d | 2010-07-16 02:11:31 +0000 | [diff] [blame] | 204 | return true; |
| 205 | } |
| 206 | FS.setConversionSpecifier(CS); |
| 207 | if (CS.consumesDataArgument() && !FS.getSuppressAssignment() |
| 208 | && !FS.usesPositionalArg()) |
| 209 | FS.setArgIndex(argIndex++); |
| 210 | |
| 211 | // FIXME: '%' and '*' doesn't make sense. Issue a warning. |
| 212 | // FIXME: 'ConsumedSoFar' and '*' doesn't make sense. |
| 213 | |
Ted Kremenek | 6ecb950 | 2010-07-20 20:04:27 +0000 | [diff] [blame] | 214 | if (k == ScanfConversionSpecifier::InvalidSpecifier) { |
Ted Kremenek | d9c904d | 2010-07-16 02:11:31 +0000 | [diff] [blame] | 215 | // Assume the conversion takes one argument. |
| 216 | return !H.HandleInvalidScanfConversionSpecifier(FS, Beg, I - Beg); |
| 217 | } |
| 218 | return ScanfSpecifierResult(Start, FS); |
| 219 | } |
Hans Wennborg | 6fcd932 | 2011-12-10 13:20:11 +0000 | [diff] [blame] | 220 | |
Hans Wennborg | 58e1e54 | 2012-08-07 08:59:46 +0000 | [diff] [blame] | 221 | ArgType ScanfSpecifier::getArgType(ASTContext &Ctx) const { |
Hans Wennborg | 6fcd932 | 2011-12-10 13:20:11 +0000 | [diff] [blame] | 222 | const ScanfConversionSpecifier &CS = getConversionSpecifier(); |
| 223 | |
| 224 | if (!CS.consumesDataArgument()) |
Hans Wennborg | 58e1e54 | 2012-08-07 08:59:46 +0000 | [diff] [blame] | 225 | return ArgType::Invalid(); |
Hans Wennborg | 6fcd932 | 2011-12-10 13:20:11 +0000 | [diff] [blame] | 226 | |
| 227 | switch(CS.getKind()) { |
| 228 | // Signed int. |
| 229 | case ConversionSpecifier::dArg: |
Jordan Rose | 275b6f5 | 2012-09-13 02:11:03 +0000 | [diff] [blame] | 230 | case ConversionSpecifier::DArg: |
Hans Wennborg | 6fcd932 | 2011-12-10 13:20:11 +0000 | [diff] [blame] | 231 | case ConversionSpecifier::iArg: |
| 232 | switch (LM.getKind()) { |
Hans Wennborg | 58e1e54 | 2012-08-07 08:59:46 +0000 | [diff] [blame] | 233 | case LengthModifier::None: |
| 234 | return ArgType::PtrTo(Ctx.IntTy); |
Hans Wennborg | 6fcd932 | 2011-12-10 13:20:11 +0000 | [diff] [blame] | 235 | case LengthModifier::AsChar: |
Hans Wennborg | 58e1e54 | 2012-08-07 08:59:46 +0000 | [diff] [blame] | 236 | return ArgType::PtrTo(ArgType::AnyCharTy); |
| 237 | case LengthModifier::AsShort: |
| 238 | return ArgType::PtrTo(Ctx.ShortTy); |
| 239 | case LengthModifier::AsLong: |
| 240 | return ArgType::PtrTo(Ctx.LongTy); |
Hans Wennborg | 32addd5 | 2012-02-16 16:34:54 +0000 | [diff] [blame] | 241 | case LengthModifier::AsLongLong: |
| 242 | case LengthModifier::AsQuad: |
Hans Wennborg | 58e1e54 | 2012-08-07 08:59:46 +0000 | [diff] [blame] | 243 | return ArgType::PtrTo(Ctx.LongLongTy); |
David Majnemer | 47ad6ce | 2013-08-21 21:54:46 +0000 | [diff] [blame] | 244 | case LengthModifier::AsInt64: |
| 245 | return ArgType::PtrTo(ArgType(Ctx.LongLongTy, "__int64")); |
Hans Wennborg | 6fcd932 | 2011-12-10 13:20:11 +0000 | [diff] [blame] | 246 | case LengthModifier::AsIntMax: |
Hans Wennborg | 58e1e54 | 2012-08-07 08:59:46 +0000 | [diff] [blame] | 247 | return ArgType::PtrTo(ArgType(Ctx.getIntMaxType(), "intmax_t")); |
Hans Wennborg | 6fcd932 | 2011-12-10 13:20:11 +0000 | [diff] [blame] | 248 | case LengthModifier::AsSizeT: |
| 249 | // FIXME: ssize_t. |
Hans Wennborg | 58e1e54 | 2012-08-07 08:59:46 +0000 | [diff] [blame] | 250 | return ArgType(); |
Hans Wennborg | 6fcd932 | 2011-12-10 13:20:11 +0000 | [diff] [blame] | 251 | case LengthModifier::AsPtrDiff: |
Hans Wennborg | 58e1e54 | 2012-08-07 08:59:46 +0000 | [diff] [blame] | 252 | return ArgType::PtrTo(ArgType(Ctx.getPointerDiffType(), "ptrdiff_t")); |
Ted Kremenek | 9d24c2c | 2012-01-24 21:29:54 +0000 | [diff] [blame] | 253 | case LengthModifier::AsLongDouble: |
| 254 | // GNU extension. |
Hans Wennborg | 58e1e54 | 2012-08-07 08:59:46 +0000 | [diff] [blame] | 255 | return ArgType::PtrTo(Ctx.LongLongTy); |
| 256 | case LengthModifier::AsAllocate: |
Hans Wennborg | 58e1e54 | 2012-08-07 08:59:46 +0000 | [diff] [blame] | 257 | case LengthModifier::AsMAllocate: |
David Majnemer | 47ad6ce | 2013-08-21 21:54:46 +0000 | [diff] [blame] | 258 | case LengthModifier::AsInt32: |
| 259 | case LengthModifier::AsInt3264: |
Stephen Hines | 176edba | 2014-12-01 14:53:08 -0800 | [diff] [blame] | 260 | case LengthModifier::AsWide: |
Hans Wennborg | 58e1e54 | 2012-08-07 08:59:46 +0000 | [diff] [blame] | 261 | return ArgType::Invalid(); |
Hans Wennborg | 6fcd932 | 2011-12-10 13:20:11 +0000 | [diff] [blame] | 262 | } |
| 263 | |
| 264 | // Unsigned int. |
| 265 | case ConversionSpecifier::oArg: |
Jordan Rose | 275b6f5 | 2012-09-13 02:11:03 +0000 | [diff] [blame] | 266 | case ConversionSpecifier::OArg: |
Hans Wennborg | 6fcd932 | 2011-12-10 13:20:11 +0000 | [diff] [blame] | 267 | case ConversionSpecifier::uArg: |
Jordan Rose | 275b6f5 | 2012-09-13 02:11:03 +0000 | [diff] [blame] | 268 | case ConversionSpecifier::UArg: |
Hans Wennborg | 6fcd932 | 2011-12-10 13:20:11 +0000 | [diff] [blame] | 269 | case ConversionSpecifier::xArg: |
| 270 | case ConversionSpecifier::XArg: |
| 271 | switch (LM.getKind()) { |
Hans Wennborg | 58e1e54 | 2012-08-07 08:59:46 +0000 | [diff] [blame] | 272 | case LengthModifier::None: |
| 273 | return ArgType::PtrTo(Ctx.UnsignedIntTy); |
| 274 | case LengthModifier::AsChar: |
| 275 | return ArgType::PtrTo(Ctx.UnsignedCharTy); |
| 276 | case LengthModifier::AsShort: |
| 277 | return ArgType::PtrTo(Ctx.UnsignedShortTy); |
| 278 | case LengthModifier::AsLong: |
| 279 | return ArgType::PtrTo(Ctx.UnsignedLongTy); |
Hans Wennborg | 6fcd932 | 2011-12-10 13:20:11 +0000 | [diff] [blame] | 280 | case LengthModifier::AsLongLong: |
Hans Wennborg | 32addd5 | 2012-02-16 16:34:54 +0000 | [diff] [blame] | 281 | case LengthModifier::AsQuad: |
Hans Wennborg | 58e1e54 | 2012-08-07 08:59:46 +0000 | [diff] [blame] | 282 | return ArgType::PtrTo(Ctx.UnsignedLongLongTy); |
David Majnemer | 47ad6ce | 2013-08-21 21:54:46 +0000 | [diff] [blame] | 283 | case LengthModifier::AsInt64: |
| 284 | return ArgType::PtrTo(ArgType(Ctx.UnsignedLongLongTy, "unsigned __int64")); |
Hans Wennborg | 6fcd932 | 2011-12-10 13:20:11 +0000 | [diff] [blame] | 285 | case LengthModifier::AsIntMax: |
Hans Wennborg | 58e1e54 | 2012-08-07 08:59:46 +0000 | [diff] [blame] | 286 | return ArgType::PtrTo(ArgType(Ctx.getUIntMaxType(), "uintmax_t")); |
Hans Wennborg | 6fcd932 | 2011-12-10 13:20:11 +0000 | [diff] [blame] | 287 | case LengthModifier::AsSizeT: |
Hans Wennborg | 58e1e54 | 2012-08-07 08:59:46 +0000 | [diff] [blame] | 288 | return ArgType::PtrTo(ArgType(Ctx.getSizeType(), "size_t")); |
Hans Wennborg | 6fcd932 | 2011-12-10 13:20:11 +0000 | [diff] [blame] | 289 | case LengthModifier::AsPtrDiff: |
| 290 | // FIXME: Unsigned version of ptrdiff_t? |
Hans Wennborg | 58e1e54 | 2012-08-07 08:59:46 +0000 | [diff] [blame] | 291 | return ArgType(); |
Ted Kremenek | 9d24c2c | 2012-01-24 21:29:54 +0000 | [diff] [blame] | 292 | case LengthModifier::AsLongDouble: |
| 293 | // GNU extension. |
Hans Wennborg | 58e1e54 | 2012-08-07 08:59:46 +0000 | [diff] [blame] | 294 | return ArgType::PtrTo(Ctx.UnsignedLongLongTy); |
| 295 | case LengthModifier::AsAllocate: |
Hans Wennborg | 58e1e54 | 2012-08-07 08:59:46 +0000 | [diff] [blame] | 296 | case LengthModifier::AsMAllocate: |
David Majnemer | 47ad6ce | 2013-08-21 21:54:46 +0000 | [diff] [blame] | 297 | case LengthModifier::AsInt32: |
| 298 | case LengthModifier::AsInt3264: |
Stephen Hines | 176edba | 2014-12-01 14:53:08 -0800 | [diff] [blame] | 299 | case LengthModifier::AsWide: |
Hans Wennborg | 58e1e54 | 2012-08-07 08:59:46 +0000 | [diff] [blame] | 300 | return ArgType::Invalid(); |
Hans Wennborg | 6fcd932 | 2011-12-10 13:20:11 +0000 | [diff] [blame] | 301 | } |
| 302 | |
| 303 | // Float. |
| 304 | case ConversionSpecifier::aArg: |
| 305 | case ConversionSpecifier::AArg: |
| 306 | case ConversionSpecifier::eArg: |
| 307 | case ConversionSpecifier::EArg: |
| 308 | case ConversionSpecifier::fArg: |
| 309 | case ConversionSpecifier::FArg: |
| 310 | case ConversionSpecifier::gArg: |
| 311 | case ConversionSpecifier::GArg: |
| 312 | switch (LM.getKind()) { |
Hans Wennborg | 58e1e54 | 2012-08-07 08:59:46 +0000 | [diff] [blame] | 313 | case LengthModifier::None: |
| 314 | return ArgType::PtrTo(Ctx.FloatTy); |
| 315 | case LengthModifier::AsLong: |
| 316 | return ArgType::PtrTo(Ctx.DoubleTy); |
Hans Wennborg | 6fcd932 | 2011-12-10 13:20:11 +0000 | [diff] [blame] | 317 | case LengthModifier::AsLongDouble: |
Hans Wennborg | 58e1e54 | 2012-08-07 08:59:46 +0000 | [diff] [blame] | 318 | return ArgType::PtrTo(Ctx.LongDoubleTy); |
Hans Wennborg | 6fcd932 | 2011-12-10 13:20:11 +0000 | [diff] [blame] | 319 | default: |
Hans Wennborg | 58e1e54 | 2012-08-07 08:59:46 +0000 | [diff] [blame] | 320 | return ArgType::Invalid(); |
Hans Wennborg | 6fcd932 | 2011-12-10 13:20:11 +0000 | [diff] [blame] | 321 | } |
| 322 | |
| 323 | // Char, string and scanlist. |
| 324 | case ConversionSpecifier::cArg: |
| 325 | case ConversionSpecifier::sArg: |
| 326 | case ConversionSpecifier::ScanListArg: |
| 327 | switch (LM.getKind()) { |
Hans Wennborg | 58e1e54 | 2012-08-07 08:59:46 +0000 | [diff] [blame] | 328 | case LengthModifier::None: |
| 329 | return ArgType::PtrTo(ArgType::AnyCharTy); |
Hans Wennborg | 6fcd932 | 2011-12-10 13:20:11 +0000 | [diff] [blame] | 330 | case LengthModifier::AsLong: |
Stephen Hines | 176edba | 2014-12-01 14:53:08 -0800 | [diff] [blame] | 331 | case LengthModifier::AsWide: |
Hans Wennborg | 15f92ba | 2013-05-10 10:08:40 +0000 | [diff] [blame] | 332 | return ArgType::PtrTo(ArgType(Ctx.getWideCharType(), "wchar_t")); |
Hans Wennborg | 37969b7 | 2012-01-12 17:11:12 +0000 | [diff] [blame] | 333 | case LengthModifier::AsAllocate: |
| 334 | case LengthModifier::AsMAllocate: |
Hans Wennborg | 58e1e54 | 2012-08-07 08:59:46 +0000 | [diff] [blame] | 335 | return ArgType::PtrTo(ArgType::CStrTy); |
Stephen Hines | 176edba | 2014-12-01 14:53:08 -0800 | [diff] [blame] | 336 | case LengthModifier::AsShort: |
| 337 | if (Ctx.getTargetInfo().getTriple().isOSMSVCRT()) |
| 338 | return ArgType::PtrTo(ArgType::AnyCharTy); |
Hans Wennborg | 6fcd932 | 2011-12-10 13:20:11 +0000 | [diff] [blame] | 339 | default: |
Hans Wennborg | 58e1e54 | 2012-08-07 08:59:46 +0000 | [diff] [blame] | 340 | return ArgType::Invalid(); |
Hans Wennborg | 6fcd932 | 2011-12-10 13:20:11 +0000 | [diff] [blame] | 341 | } |
| 342 | case ConversionSpecifier::CArg: |
| 343 | case ConversionSpecifier::SArg: |
| 344 | // FIXME: Mac OS X specific? |
Hans Wennborg | 37969b7 | 2012-01-12 17:11:12 +0000 | [diff] [blame] | 345 | switch (LM.getKind()) { |
| 346 | case LengthModifier::None: |
Stephen Hines | 176edba | 2014-12-01 14:53:08 -0800 | [diff] [blame] | 347 | case LengthModifier::AsWide: |
Hans Wennborg | 15f92ba | 2013-05-10 10:08:40 +0000 | [diff] [blame] | 348 | return ArgType::PtrTo(ArgType(Ctx.getWideCharType(), "wchar_t")); |
Hans Wennborg | 37969b7 | 2012-01-12 17:11:12 +0000 | [diff] [blame] | 349 | case LengthModifier::AsAllocate: |
| 350 | case LengthModifier::AsMAllocate: |
Hans Wennborg | 58e1e54 | 2012-08-07 08:59:46 +0000 | [diff] [blame] | 351 | return ArgType::PtrTo(ArgType(ArgType::WCStrTy, "wchar_t *")); |
Stephen Hines | 176edba | 2014-12-01 14:53:08 -0800 | [diff] [blame] | 352 | case LengthModifier::AsShort: |
| 353 | if (Ctx.getTargetInfo().getTriple().isOSMSVCRT()) |
| 354 | return ArgType::PtrTo(ArgType::AnyCharTy); |
Hans Wennborg | 37969b7 | 2012-01-12 17:11:12 +0000 | [diff] [blame] | 355 | default: |
Hans Wennborg | 58e1e54 | 2012-08-07 08:59:46 +0000 | [diff] [blame] | 356 | return ArgType::Invalid(); |
Hans Wennborg | 37969b7 | 2012-01-12 17:11:12 +0000 | [diff] [blame] | 357 | } |
Hans Wennborg | 6fcd932 | 2011-12-10 13:20:11 +0000 | [diff] [blame] | 358 | |
| 359 | // Pointer. |
| 360 | case ConversionSpecifier::pArg: |
Hans Wennborg | 58e1e54 | 2012-08-07 08:59:46 +0000 | [diff] [blame] | 361 | return ArgType::PtrTo(ArgType::CPointerTy); |
Hans Wennborg | 6fcd932 | 2011-12-10 13:20:11 +0000 | [diff] [blame] | 362 | |
Hans Wennborg | 58e1e54 | 2012-08-07 08:59:46 +0000 | [diff] [blame] | 363 | // Write-back. |
Hans Wennborg | cec9ce4 | 2012-07-30 17:11:32 +0000 | [diff] [blame] | 364 | case ConversionSpecifier::nArg: |
Hans Wennborg | f7158fa | 2012-08-07 09:13:19 +0000 | [diff] [blame] | 365 | switch (LM.getKind()) { |
| 366 | case LengthModifier::None: |
| 367 | return ArgType::PtrTo(Ctx.IntTy); |
| 368 | case LengthModifier::AsChar: |
| 369 | return ArgType::PtrTo(Ctx.SignedCharTy); |
| 370 | case LengthModifier::AsShort: |
| 371 | return ArgType::PtrTo(Ctx.ShortTy); |
| 372 | case LengthModifier::AsLong: |
| 373 | return ArgType::PtrTo(Ctx.LongTy); |
| 374 | case LengthModifier::AsLongLong: |
| 375 | case LengthModifier::AsQuad: |
| 376 | return ArgType::PtrTo(Ctx.LongLongTy); |
David Majnemer | 47ad6ce | 2013-08-21 21:54:46 +0000 | [diff] [blame] | 377 | case LengthModifier::AsInt64: |
| 378 | return ArgType::PtrTo(ArgType(Ctx.LongLongTy, "__int64")); |
Hans Wennborg | f7158fa | 2012-08-07 09:13:19 +0000 | [diff] [blame] | 379 | case LengthModifier::AsIntMax: |
| 380 | return ArgType::PtrTo(ArgType(Ctx.getIntMaxType(), "intmax_t")); |
| 381 | case LengthModifier::AsSizeT: |
| 382 | return ArgType(); // FIXME: ssize_t |
| 383 | case LengthModifier::AsPtrDiff: |
| 384 | return ArgType::PtrTo(ArgType(Ctx.getPointerDiffType(), "ptrdiff_t")); |
| 385 | case LengthModifier::AsLongDouble: |
| 386 | return ArgType(); // FIXME: Is this a known extension? |
| 387 | case LengthModifier::AsAllocate: |
| 388 | case LengthModifier::AsMAllocate: |
David Majnemer | 47ad6ce | 2013-08-21 21:54:46 +0000 | [diff] [blame] | 389 | case LengthModifier::AsInt32: |
| 390 | case LengthModifier::AsInt3264: |
Stephen Hines | 176edba | 2014-12-01 14:53:08 -0800 | [diff] [blame] | 391 | case LengthModifier::AsWide: |
Hans Wennborg | f7158fa | 2012-08-07 09:13:19 +0000 | [diff] [blame] | 392 | return ArgType::Invalid(); |
| 393 | } |
Hans Wennborg | cec9ce4 | 2012-07-30 17:11:32 +0000 | [diff] [blame] | 394 | |
Hans Wennborg | 6fcd932 | 2011-12-10 13:20:11 +0000 | [diff] [blame] | 395 | default: |
| 396 | break; |
| 397 | } |
| 398 | |
Hans Wennborg | 58e1e54 | 2012-08-07 08:59:46 +0000 | [diff] [blame] | 399 | return ArgType(); |
Hans Wennborg | 6fcd932 | 2011-12-10 13:20:11 +0000 | [diff] [blame] | 400 | } |
| 401 | |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 402 | bool ScanfSpecifier::fixType(QualType QT, QualType RawQT, |
| 403 | const LangOptions &LangOpt, |
Hans Wennborg | be6126a | 2012-02-15 09:59:46 +0000 | [diff] [blame] | 404 | ASTContext &Ctx) { |
Hans Wennborg | 6fcd932 | 2011-12-10 13:20:11 +0000 | [diff] [blame] | 405 | |
Hans Wennborg | cec9ce4 | 2012-07-30 17:11:32 +0000 | [diff] [blame] | 406 | // %n is different from other conversion specifiers; don't try to fix it. |
| 407 | if (CS.getKind() == ConversionSpecifier::nArg) |
| 408 | return false; |
| 409 | |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 410 | if (!QT->isPointerType()) |
| 411 | return false; |
| 412 | |
Hans Wennborg | 6fcd932 | 2011-12-10 13:20:11 +0000 | [diff] [blame] | 413 | QualType PT = QT->getPointeeType(); |
Jordan Rose | 033a9c0 | 2012-06-04 22:49:02 +0000 | [diff] [blame] | 414 | |
| 415 | // If it's an enum, get its underlying type. |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 416 | if (const EnumType *ETy = PT->getAs<EnumType>()) |
| 417 | PT = ETy->getDecl()->getIntegerType(); |
| 418 | |
Hans Wennborg | 6fcd932 | 2011-12-10 13:20:11 +0000 | [diff] [blame] | 419 | const BuiltinType *BT = PT->getAs<BuiltinType>(); |
| 420 | if (!BT) |
| 421 | return false; |
| 422 | |
| 423 | // Pointer to a character. |
| 424 | if (PT->isAnyCharacterType()) { |
| 425 | CS.setKind(ConversionSpecifier::sArg); |
| 426 | if (PT->isWideCharType()) |
| 427 | LM.setKind(LengthModifier::AsWideChar); |
| 428 | else |
| 429 | LM.setKind(LengthModifier::None); |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 430 | |
| 431 | // If we know the target array length, we can use it as a field width. |
| 432 | if (const ConstantArrayType *CAT = Ctx.getAsConstantArrayType(RawQT)) { |
| 433 | if (CAT->getSizeModifier() == ArrayType::Normal) |
| 434 | FieldWidth = OptionalAmount(OptionalAmount::Constant, |
| 435 | CAT->getSize().getZExtValue() - 1, |
| 436 | "", 0, false); |
| 437 | |
| 438 | } |
Hans Wennborg | 6fcd932 | 2011-12-10 13:20:11 +0000 | [diff] [blame] | 439 | return true; |
| 440 | } |
| 441 | |
| 442 | // Figure out the length modifier. |
| 443 | switch (BT->getKind()) { |
| 444 | // no modifier |
| 445 | case BuiltinType::UInt: |
| 446 | case BuiltinType::Int: |
| 447 | case BuiltinType::Float: |
| 448 | LM.setKind(LengthModifier::None); |
| 449 | break; |
| 450 | |
| 451 | // hh |
| 452 | case BuiltinType::Char_U: |
| 453 | case BuiltinType::UChar: |
| 454 | case BuiltinType::Char_S: |
| 455 | case BuiltinType::SChar: |
| 456 | LM.setKind(LengthModifier::AsChar); |
| 457 | break; |
| 458 | |
| 459 | // h |
| 460 | case BuiltinType::Short: |
| 461 | case BuiltinType::UShort: |
| 462 | LM.setKind(LengthModifier::AsShort); |
| 463 | break; |
| 464 | |
| 465 | // l |
| 466 | case BuiltinType::Long: |
| 467 | case BuiltinType::ULong: |
| 468 | case BuiltinType::Double: |
| 469 | LM.setKind(LengthModifier::AsLong); |
| 470 | break; |
| 471 | |
| 472 | // ll |
| 473 | case BuiltinType::LongLong: |
| 474 | case BuiltinType::ULongLong: |
| 475 | LM.setKind(LengthModifier::AsLongLong); |
| 476 | break; |
| 477 | |
| 478 | // L |
| 479 | case BuiltinType::LongDouble: |
| 480 | LM.setKind(LengthModifier::AsLongDouble); |
| 481 | break; |
| 482 | |
| 483 | // Don't know. |
| 484 | default: |
| 485 | return false; |
| 486 | } |
| 487 | |
| 488 | // Handle size_t, ptrdiff_t, etc. that have dedicated length modifiers in C99. |
Richard Smith | 80ad52f | 2013-01-02 11:42:31 +0000 | [diff] [blame] | 489 | if (isa<TypedefType>(PT) && (LangOpt.C99 || LangOpt.CPlusPlus11)) |
Hans Wennborg | 4684778 | 2012-07-27 19:17:46 +0000 | [diff] [blame] | 490 | namedTypeToLengthModifier(PT, LM); |
Hans Wennborg | 6fcd932 | 2011-12-10 13:20:11 +0000 | [diff] [blame] | 491 | |
Hans Wennborg | be6126a | 2012-02-15 09:59:46 +0000 | [diff] [blame] | 492 | // If fixing the length modifier was enough, we are done. |
Jordan Rose | bbb6bb4 | 2012-09-08 04:00:03 +0000 | [diff] [blame] | 493 | if (hasValidLengthModifier(Ctx.getTargetInfo())) { |
| 494 | const analyze_scanf::ArgType &AT = getArgType(Ctx); |
| 495 | if (AT.isValid() && AT.matchesType(Ctx, QT)) |
| 496 | return true; |
| 497 | } |
Hans Wennborg | be6126a | 2012-02-15 09:59:46 +0000 | [diff] [blame] | 498 | |
Hans Wennborg | 6fcd932 | 2011-12-10 13:20:11 +0000 | [diff] [blame] | 499 | // Figure out the conversion specifier. |
| 500 | if (PT->isRealFloatingType()) |
| 501 | CS.setKind(ConversionSpecifier::fArg); |
| 502 | else if (PT->isSignedIntegerType()) |
| 503 | CS.setKind(ConversionSpecifier::dArg); |
Hans Wennborg | be6126a | 2012-02-15 09:59:46 +0000 | [diff] [blame] | 504 | else if (PT->isUnsignedIntegerType()) |
| 505 | CS.setKind(ConversionSpecifier::uArg); |
| 506 | else |
Hans Wennborg | 6fcd932 | 2011-12-10 13:20:11 +0000 | [diff] [blame] | 507 | llvm_unreachable("Unexpected type"); |
| 508 | |
| 509 | return true; |
| 510 | } |
| 511 | |
| 512 | void ScanfSpecifier::toString(raw_ostream &os) const { |
| 513 | os << "%"; |
| 514 | |
| 515 | if (usesPositionalArg()) |
| 516 | os << getPositionalArgIndex() << "$"; |
| 517 | if (SuppressAssignment) |
| 518 | os << "*"; |
| 519 | |
| 520 | FieldWidth.toString(os); |
| 521 | os << LM.toString(); |
| 522 | os << CS.toString(); |
| 523 | } |
| 524 | |
Ted Kremenek | d9c904d | 2010-07-16 02:11:31 +0000 | [diff] [blame] | 525 | bool clang::analyze_format_string::ParseScanfString(FormatStringHandler &H, |
| 526 | const char *I, |
Hans Wennborg | d02deeb | 2011-12-15 10:25:47 +0000 | [diff] [blame] | 527 | const char *E, |
Jordan Rose | 275b6f5 | 2012-09-13 02:11:03 +0000 | [diff] [blame] | 528 | const LangOptions &LO, |
| 529 | const TargetInfo &Target) { |
Ted Kremenek | d9c904d | 2010-07-16 02:11:31 +0000 | [diff] [blame] | 530 | |
| 531 | unsigned argIndex = 0; |
| 532 | |
| 533 | // Keep looking for a format specifier until we have exhausted the string. |
| 534 | while (I != E) { |
Hans Wennborg | d02deeb | 2011-12-15 10:25:47 +0000 | [diff] [blame] | 535 | const ScanfSpecifierResult &FSR = ParseScanfSpecifier(H, I, E, argIndex, |
Jordan Rose | 275b6f5 | 2012-09-13 02:11:03 +0000 | [diff] [blame] | 536 | LO, Target); |
Ted Kremenek | d9c904d | 2010-07-16 02:11:31 +0000 | [diff] [blame] | 537 | // Did a fail-stop error of any kind occur when parsing the specifier? |
| 538 | // If so, don't do any more processing. |
| 539 | if (FSR.shouldStop()) |
Dmitri Gribenko | 1ad23d6 | 2012-09-10 21:20:09 +0000 | [diff] [blame] | 540 | return true; |
Ted Kremenek | d9c904d | 2010-07-16 02:11:31 +0000 | [diff] [blame] | 541 | // Did we exhaust the string or encounter an error that |
| 542 | // we can recover from? |
| 543 | if (!FSR.hasValue()) |
| 544 | continue; |
| 545 | // We have a format specifier. Pass it to the callback. |
| 546 | if (!H.HandleScanfSpecifier(FSR.getValue(), FSR.getStart(), |
| 547 | I - FSR.getStart())) { |
| 548 | return true; |
| 549 | } |
| 550 | } |
| 551 | assert(I == E && "Format string not exhausted"); |
| 552 | return false; |
| 553 | } |