utils/FileCheck/FileCheck.cpp

   1 //===- FileCheck.cpp - Check that File's Contents match what is expected --===//
   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 // FileCheck does a line-by line check of a file that validates whether it
  11 // contains the expected content.  This is useful for regression tests etc.
  12 //
  13 // This program exits with an error status of 2 on error, exit status of 0 if
  14 // the file matched the expected contents, and exit status of 1 if it did not
  15 // contain the expected contents.
  16 //
  17 //===----------------------------------------------------------------------===//
  18
  19 #include "llvm/ADT/OwningPtr.h"
  20 #include "llvm/ADT/SmallString.h"
  21 #include "llvm/ADT/StringExtras.h"
  22 #include "llvm/ADT/StringMap.h"
  23 #include "llvm/Support/CommandLine.h"
  24 #include "llvm/Support/MemoryBuffer.h"
  25 #include "llvm/Support/PrettyStackTrace.h"
  26 #include "llvm/Support/Regex.h"
  27 #include "llvm/Support/Signals.h"
  28 #include "llvm/Support/SourceMgr.h"
  29 #include "llvm/Support/raw_ostream.h"
  30 #include "llvm/Support/system_error.h"
  31 #include <algorithm>
  32 #include <map>
  33 #include <string>
  34 #include <vector>
  35 using namespace llvm;
  36
  37 static cl::opt<std::string>
  38 CheckFilename(cl::Positional, cl::desc("<check-file>"), cl::Required);
  39
  40 static cl::opt<std::string>
  41 InputFilename("input-file", cl::desc("File to check (defaults to stdin)"),
  42               cl::init("-"), cl::value_desc("filename"));
  43
  44 static cl::opt<std::string>
  45 CheckPrefix("check-prefix", cl::init("CHECK"),
  46             cl::desc("Prefix to use from check file (defaults to 'CHECK')"));
  47
  48 static cl::opt<bool>
  49 NoCanonicalizeWhiteSpace("strict-whitespace",
  50               cl::desc("Do not treat all horizontal whitespace as equivalent"));
  51
  52 //===----------------------------------------------------------------------===//
  53 // Pattern Handling Code.
  54 //===----------------------------------------------------------------------===//
  55
  56 class Pattern {
  57   SMLoc PatternLoc;
  58
  59   /// MatchEOF - When set, this pattern only matches the end of file. This is
  60   /// used for trailing CHECK-NOTs.
  61   bool MatchEOF;
  62
  63   /// MatchNot
  64   bool MatchNot;
  65
  66   /// MatchDag
  67   bool MatchDag;
  68
  69   /// FixedStr - If non-empty, this pattern is a fixed string match with the
  70   /// specified fixed string.
  71   StringRef FixedStr;
  72
  73   /// RegEx - If non-empty, this is a regex pattern.
  74   std::string RegExStr;
  75
  76   /// \brief Contains the number of line this pattern is in.
  77   unsigned LineNumber;
  78
  79   /// VariableUses - Entries in this vector map to uses of a variable in the
  80   /// pattern, e.g. "foo[[bar]]baz".  In this case, the RegExStr will contain
  81   /// "foobaz" and we'll get an entry in this vector that tells us to insert the
  82   /// value of bar at offset 3.
  83   std::vector<std::pair<StringRef, unsigned> > VariableUses;
  84
  85   /// VariableDefs - Maps definitions of variables to their parenthesized
  86   /// capture numbers.
  87   /// E.g. for the pattern "foo[[bar:.*]]baz", VariableDefs will map "bar" to 1.
  88   std::map<StringRef, unsigned> VariableDefs;
  89
  90 public:
  91
  92   Pattern(bool matchEOF = false)
  93     : MatchEOF(matchEOF), MatchNot(false), MatchDag(false) { }
  94
  95   /// getLoc - Return the location in source code.
  96   SMLoc getLoc() const { return PatternLoc; }
  97
  98   /// ParsePattern - Parse the given string into the Pattern.  SM provides the
  99   /// SourceMgr used for error reports, and LineNumber is the line number in
 100   /// the input file from which the pattern string was read.
 101   /// Returns true in case of an error, false otherwise.
 102   bool ParsePattern(StringRef PatternStr, SourceMgr &SM, unsigned LineNumber);
 103
 104   /// Match - Match the pattern string against the input buffer Buffer.  This
 105   /// returns the position that is matched or npos if there is no match.  If
 106   /// there is a match, the size of the matched string is returned in MatchLen.
 107   ///
 108   /// The VariableTable StringMap provides the current values of filecheck
 109   /// variables and is updated if this match defines new values.
 110   size_t Match(StringRef Buffer, size_t &MatchLen,
 111                StringMap<StringRef> &VariableTable) const;
 112
 113   /// PrintFailureInfo - Print additional information about a failure to match
 114   /// involving this pattern.
 115   void PrintFailureInfo(const SourceMgr &SM, StringRef Buffer,
 116                         const StringMap<StringRef> &VariableTable) const;
 117
 118   void setMatchNot(bool Not) { MatchNot = Not; }
 119   bool getMatchNot() const { return MatchNot; }
 120
 121   void setMatchDag(bool Dag) { MatchDag = Dag; }
 122   bool getMatchDag() const { return MatchDag; }
 123
 124 private:
 125   static void AddFixedStringToRegEx(StringRef FixedStr, std::string &TheStr);
 126   bool AddRegExToRegEx(StringRef RS, unsigned &CurParen, SourceMgr &SM);
 127   void AddBackrefToRegEx(unsigned BackrefNum);
 128
 129   /// ComputeMatchDistance - Compute an arbitrary estimate for the quality of
 130   /// matching this pattern at the start of \arg Buffer; a distance of zero
 131   /// should correspond to a perfect match.
 132   unsigned ComputeMatchDistance(StringRef Buffer,
 133                                const StringMap<StringRef> &VariableTable) const;
 134
 135   /// \brief Evaluates expression and stores the result to \p Value.
 136   /// \return true on success. false when the expression has invalid syntax.
 137   bool EvaluateExpression(StringRef Expr, std::string &Value) const;
 138
 139   /// \brief Finds the closing sequence of a regex variable usage or
 140   /// definition. Str has to point in the beginning of the definition
 141   /// (right after the opening sequence).
 142   /// \return offset of the closing sequence within Str, or npos if it was not
 143   /// found.
 144   size_t FindRegexVarEnd(StringRef Str);
 145 };
 146
 147
 148 bool Pattern::ParsePattern(StringRef PatternStr, SourceMgr &SM,
 149                            unsigned LineNumber) {
 150   this->LineNumber = LineNumber;
 151   PatternLoc = SMLoc::getFromPointer(PatternStr.data());
 152
 153   // Ignore trailing whitespace.
 154   while (!PatternStr.empty() &&
 155          (PatternStr.back() == ' ' || PatternStr.back() == '\t'))
 156     PatternStr = PatternStr.substr(0, PatternStr.size()-1);
 157
 158   // Check that there is something on the line.
 159   if (PatternStr.empty()) {
 160     SM.PrintMessage(PatternLoc, SourceMgr::DK_Error,
 161                     "found empty check string with prefix '" +
 162                     CheckPrefix+":'");
 163     return true;
 164   }
 165
 166   // Check to see if this is a fixed string, or if it has regex pieces.
 167   if (PatternStr.size() < 2 ||
 168       (PatternStr.find("{{") == StringRef::npos &&
 169        PatternStr.find("[[") == StringRef::npos)) {
 170     FixedStr = PatternStr;
 171     return false;
 172   }
 173
 174   // Paren value #0 is for the fully matched string.  Any new parenthesized
 175   // values add from there.
 176   unsigned CurParen = 1;
 177
 178   // Otherwise, there is at least one regex piece.  Build up the regex pattern
 179   // by escaping scary characters in fixed strings, building up one big regex.
 180   while (!PatternStr.empty()) {
 181     // RegEx matches.
 182     if (PatternStr.startswith("{{")) {
 183       // This is the start of a regex match.  Scan for the }}.
 184       size_t End = PatternStr.find("}}");
 185       if (End == StringRef::npos) {
 186         SM.PrintMessage(SMLoc::getFromPointer(PatternStr.data()),
 187                         SourceMgr::DK_Error,
 188                         "found start of regex string with no end '}}'");
 189         return true;
 190       }
 191
 192       // Enclose {{}} patterns in parens just like [[]] even though we're not
 193       // capturing the result for any purpose.  This is required in case the
 194       // expression contains an alternation like: CHECK:  abc{{x|z}}def.  We
 195       // want this to turn into: "abc(x|z)def" not "abcx|zdef".
 196       RegExStr += '(';
 197       ++CurParen;
 198
 199       if (AddRegExToRegEx(PatternStr.substr(2, End-2), CurParen, SM))
 200         return true;
 201       RegExStr += ')';
 202
 203       PatternStr = PatternStr.substr(End+2);
 204       continue;
 205     }
 206
 207     // Named RegEx matches.  These are of two forms: [[foo:.*]] which matches .*
 208     // (or some other regex) and assigns it to the FileCheck variable 'foo'. The
 209     // second form is [[foo]] which is a reference to foo.  The variable name
 210     // itself must be of the form "[a-zA-Z_][0-9a-zA-Z_]*", otherwise we reject
 211     // it.  This is to catch some common errors.
 212     if (PatternStr.startswith("[[")) {
 213       // Find the closing bracket pair ending the match.  End is going to be an
 214       // offset relative to the beginning of the match string.
 215       size_t End = FindRegexVarEnd(PatternStr.substr(2));
 216
 217       if (End == StringRef::npos) {
 218         SM.PrintMessage(SMLoc::getFromPointer(PatternStr.data()),
 219                         SourceMgr::DK_Error,
 220                         "invalid named regex reference, no ]] found");
 221         return true;
 222       }
 223
 224       StringRef MatchStr = PatternStr.substr(2, End);
 225       PatternStr = PatternStr.substr(End+4);
 226
 227       // Get the regex name (e.g. "foo").
 228       size_t NameEnd = MatchStr.find(':');
 229       StringRef Name = MatchStr.substr(0, NameEnd);
 230
 231       if (Name.empty()) {
 232         SM.PrintMessage(SMLoc::getFromPointer(Name.data()), SourceMgr::DK_Error,
 233                         "invalid name in named regex: empty name");
 234         return true;
 235       }
 236
 237       // Verify that the name/expression is well formed. FileCheck currently
 238       // supports @LINE, @LINE+number, @LINE-number expressions. The check here
 239       // is relaxed, more strict check is performed in \c EvaluateExpression.
 240       bool IsExpression = false;
 241       for (unsigned i = 0, e = Name.size(); i != e; ++i) {
 242         if (i == 0 && Name[i] == '@') {
 243           if (NameEnd != StringRef::npos) {
 244             SM.PrintMessage(SMLoc::getFromPointer(Name.data()),
 245                             SourceMgr::DK_Error,
 246                             "invalid name in named regex definition");
 247             return true;
 248           }
 249           IsExpression = true;
 250           continue;
 251         }
 252         if (Name[i] != '_' && !isalnum(Name[i]) &&
 253             (!IsExpression || (Name[i] != '+' && Name[i] != '-'))) {
 254           SM.PrintMessage(SMLoc::getFromPointer(Name.data()+i),
 255                           SourceMgr::DK_Error, "invalid name in named regex");
 256           return true;
 257         }
 258       }
 259
 260       // Name can't start with a digit.
 261       if (isdigit(static_cast<unsigned char>(Name[0]))) {
 262         SM.PrintMessage(SMLoc::getFromPointer(Name.data()), SourceMgr::DK_Error,
 263                         "invalid name in named regex");
 264         return true;
 265       }
 266
 267       // Handle [[foo]].
 268       if (NameEnd == StringRef::npos) {
 269         // Handle variables that were defined earlier on the same line by
 270         // emitting a backreference.
 271         if (VariableDefs.find(Name) != VariableDefs.end()) {
 272           unsigned VarParenNum = VariableDefs[Name];
 273           if (VarParenNum < 1 || VarParenNum > 9) {
 274             SM.PrintMessage(SMLoc::getFromPointer(Name.data()),
 275                             SourceMgr::DK_Error,
 276                             "Can't back-reference more than 9 variables");
 277             return true;
 278           }
 279           AddBackrefToRegEx(VarParenNum);
 280         } else {
 281           VariableUses.push_back(std::make_pair(Name, RegExStr.size()));
 282         }
 283         continue;
 284       }
 285
 286       // Handle [[foo:.*]].
 287       VariableDefs[Name] = CurParen;
 288       RegExStr += '(';
 289       ++CurParen;
 290
 291       if (AddRegExToRegEx(MatchStr.substr(NameEnd+1), CurParen, SM))
 292         return true;
 293
 294       RegExStr += ')';
 295     }
 296
 297     // Handle fixed string matches.
 298     // Find the end, which is the start of the next regex.
 299     size_t FixedMatchEnd = PatternStr.find("{{");
 300     FixedMatchEnd = std::min(FixedMatchEnd, PatternStr.find("[["));
 301     AddFixedStringToRegEx(PatternStr.substr(0, FixedMatchEnd), RegExStr);
 302     PatternStr = PatternStr.substr(FixedMatchEnd);
 303   }
 304
 305   return false;
 306 }
 307
 308 void Pattern::AddFixedStringToRegEx(StringRef FixedStr, std::string &TheStr) {
 309   // Add the characters from FixedStr to the regex, escaping as needed.  This
 310   // avoids "leaning toothpicks" in common patterns.
 311   for (unsigned i = 0, e = FixedStr.size(); i != e; ++i) {
 312     switch (FixedStr[i]) {
 313     // These are the special characters matched in "p_ere_exp".
 314     case '(':
 315     case ')':
 316     case '^':
 317     case '$':
 318     case '|':
 319     case '*':
 320     case '+':
 321     case '?':
 322     case '.':
 323     case '[':
 324     case '\\':
 325     case '{':
 326       TheStr += '\\';
 327       // FALL THROUGH.
 328     default:
 329       TheStr += FixedStr[i];
 330       break;
 331     }
 332   }
 333 }
 334
 335 bool Pattern::AddRegExToRegEx(StringRef RS, unsigned &CurParen,
 336                               SourceMgr &SM) {
 337   Regex R(RS);
 338   std::string Error;
 339   if (!R.isValid(Error)) {
 340     SM.PrintMessage(SMLoc::getFromPointer(RS.data()), SourceMgr::DK_Error,
 341                     "invalid regex: " + Error);
 342     return true;
 343   }
 344
 345   RegExStr += RS.str();
 346   CurParen += R.getNumMatches();
 347   return false;
 348 }
 349
 350 void Pattern::AddBackrefToRegEx(unsigned BackrefNum) {
 351   assert(BackrefNum >= 1 && BackrefNum <= 9 && "Invalid backref number");
 352   std::string Backref = std::string("\\") +
 353                         std::string(1, '0' + BackrefNum);
 354   RegExStr += Backref;
 355 }
 356
 357 bool Pattern::EvaluateExpression(StringRef Expr, std::string &Value) const {
 358   // The only supported expression is @LINE([\+-]\d+)?
 359   if (!Expr.startswith("@LINE"))
 360     return false;
 361   Expr = Expr.substr(StringRef("@LINE").size());
 362   int Offset = 0;
 363   if (!Expr.empty()) {
 364     if (Expr[0] == '+')
 365       Expr = Expr.substr(1);
 366     else if (Expr[0] != '-')
 367       return false;
 368     if (Expr.getAsInteger(10, Offset))
 369       return false;
 370   }
 371   Value = llvm::itostr(LineNumber + Offset);
 372   return true;
 373 }
 374
 375 /// Match - Match the pattern string against the input buffer Buffer.  This
 376 /// returns the position that is matched or npos if there is no match.  If
 377 /// there is a match, the size of the matched string is returned in MatchLen.
 378 size_t Pattern::Match(StringRef Buffer, size_t &MatchLen,
 379                       StringMap<StringRef> &VariableTable) const {
 380   // If this is the EOF pattern, match it immediately.
 381   if (MatchEOF) {
 382     MatchLen = 0;
 383     return Buffer.size();
 384   }
 385
 386   // If this is a fixed string pattern, just match it now.
 387   if (!FixedStr.empty()) {
 388     MatchLen = FixedStr.size();
 389     return Buffer.find(FixedStr);
 390   }
 391
 392   // Regex match.
 393
 394   // If there are variable uses, we need to create a temporary string with the
 395   // actual value.
 396   StringRef RegExToMatch = RegExStr;
 397   std::string TmpStr;
 398   if (!VariableUses.empty()) {
 399     TmpStr = RegExStr;
 400
 401     unsigned InsertOffset = 0;
 402     for (unsigned i = 0, e = VariableUses.size(); i != e; ++i) {
 403       std::string Value;
 404
 405       if (VariableUses[i].first[0] == '@') {
 406         if (!EvaluateExpression(VariableUses[i].first, Value))
 407           return StringRef::npos;
 408       } else {
 409         StringMap<StringRef>::iterator it =
 410           VariableTable.find(VariableUses[i].first);
 411         // If the variable is undefined, return an error.
 412         if (it == VariableTable.end())
 413           return StringRef::npos;
 414
 415         // Look up the value and escape it so that we can plop it into the regex.
 416         AddFixedStringToRegEx(it->second, Value);
 417       }
 418
 419       // Plop it into the regex at the adjusted offset.
 420       TmpStr.insert(TmpStr.begin()+VariableUses[i].second+InsertOffset,
 421                     Value.begin(), Value.end());
 422       InsertOffset += Value.size();
 423     }
 424
 425     // Match the newly constructed regex.
 426     RegExToMatch = TmpStr;
 427   }
 428
 429
 430   SmallVector<StringRef, 4> MatchInfo;
 431   if (!Regex(RegExToMatch, Regex::Newline).match(Buffer, &MatchInfo))
 432     return StringRef::npos;
 433
 434   // Successful regex match.
 435   assert(!MatchInfo.empty() && "Didn't get any match");
 436   StringRef FullMatch = MatchInfo[0];
 437
 438   // If this defines any variables, remember their values.
 439   for (std::map<StringRef, unsigned>::const_iterator I = VariableDefs.begin(),
 440                                                      E = VariableDefs.end();
 441        I != E; ++I) {
 442     assert(I->second < MatchInfo.size() && "Internal paren error");
 443     VariableTable[I->first] = MatchInfo[I->second];
 444   }
 445
 446   MatchLen = FullMatch.size();
 447   return FullMatch.data()-Buffer.data();
 448 }
 449
 450 unsigned Pattern::ComputeMatchDistance(StringRef Buffer,
 451                               const StringMap<StringRef> &VariableTable) const {
 452   // Just compute the number of matching characters. For regular expressions, we
 453   // just compare against the regex itself and hope for the best.
 454   //
 455   // FIXME: One easy improvement here is have the regex lib generate a single
 456   // example regular expression which matches, and use that as the example
 457   // string.
 458   StringRef ExampleString(FixedStr);
 459   if (ExampleString.empty())
 460     ExampleString = RegExStr;
 461
 462   // Only compare up to the first line in the buffer, or the string size.
 463   StringRef BufferPrefix = Buffer.substr(0, ExampleString.size());
 464   BufferPrefix = BufferPrefix.split('\n').first;
 465   return BufferPrefix.edit_distance(ExampleString);
 466 }
 467
 468 void Pattern::PrintFailureInfo(const SourceMgr &SM, StringRef Buffer,
 469                                const StringMap<StringRef> &VariableTable) const{
 470   // If this was a regular expression using variables, print the current
 471   // variable values.
 472   if (!VariableUses.empty()) {
 473     for (unsigned i = 0, e = VariableUses.size(); i != e; ++i) {
 474       SmallString<256> Msg;
 475       raw_svector_ostream OS(Msg);
 476       StringRef Var = VariableUses[i].first;
 477       if (Var[0] == '@') {
 478         std::string Value;
 479         if (EvaluateExpression(Var, Value)) {
 480           OS << "with expression \"";
 481           OS.write_escaped(Var) << "\" equal to \"";
 482           OS.write_escaped(Value) << "\"";
 483         } else {
 484           OS << "uses incorrect expression \"";
 485           OS.write_escaped(Var) << "\"";
 486         }
 487       } else {
 488         StringMap<StringRef>::const_iterator it = VariableTable.find(Var);
 489
 490         // Check for undefined variable references.
 491         if (it == VariableTable.end()) {
 492           OS << "uses undefined variable \"";
 493           OS.write_escaped(Var) << "\"";
 494         } else {
 495           OS << "with variable \"";
 496           OS.write_escaped(Var) << "\" equal to \"";
 497           OS.write_escaped(it->second) << "\"";
 498         }
 499       }
 500
 501       SM.PrintMessage(SMLoc::getFromPointer(Buffer.data()), SourceMgr::DK_Note,
 502                       OS.str());
 503     }
 504   }
 505
 506   // Attempt to find the closest/best fuzzy match.  Usually an error happens
 507   // because some string in the output didn't exactly match. In these cases, we
 508   // would like to show the user a best guess at what "should have" matched, to
 509   // save them having to actually check the input manually.
 510   size_t NumLinesForward = 0;
 511   size_t Best = StringRef::npos;
 512   double BestQuality = 0;
 513
 514   // Use an arbitrary 4k limit on how far we will search.
 515   for (size_t i = 0, e = std::min(size_t(4096), Buffer.size()); i != e; ++i) {
 516     if (Buffer[i] == '\n')
 517       ++NumLinesForward;
 518
 519     // Patterns have leading whitespace stripped, so skip whitespace when
 520     // looking for something which looks like a pattern.
 521     if (Buffer[i] == ' ' || Buffer[i] == '\t')
 522       continue;
 523
 524     // Compute the "quality" of this match as an arbitrary combination of the
 525     // match distance and the number of lines skipped to get to this match.
 526     unsigned Distance = ComputeMatchDistance(Buffer.substr(i), VariableTable);
 527     double Quality = Distance + (NumLinesForward / 100.);
 528
 529     if (Quality < BestQuality || Best == StringRef::npos) {
 530       Best = i;
 531       BestQuality = Quality;
 532     }
 533   }
 534
 535   // Print the "possible intended match here" line if we found something
 536   // reasonable and not equal to what we showed in the "scanning from here"
 537   // line.
 538   if (Best && Best != StringRef::npos && BestQuality < 50) {
 539       SM.PrintMessage(SMLoc::getFromPointer(Buffer.data() + Best),
 540                       SourceMgr::DK_Note, "possible intended match here");
 541
 542     // FIXME: If we wanted to be really friendly we would show why the match
 543     // failed, as it can be hard to spot simple one character differences.
 544   }
 545 }
 546
 547 size_t Pattern::FindRegexVarEnd(StringRef Str) {
 548   // Offset keeps track of the current offset within the input Str
 549   size_t Offset = 0;
 550   // [...] Nesting depth
 551   size_t BracketDepth = 0;
 552
 553   while (!Str.empty()) {
 554     if (Str.startswith("]]") && BracketDepth == 0)
 555       return Offset;
 556     if (Str[0] == '\\') {
 557       // Backslash escapes the next char within regexes, so skip them both.
 558       Str = Str.substr(2);
 559       Offset += 2;
 560     } else {
 561       switch (Str[0]) {
 562         default:
 563           break;
 564         case '[':
 565           BracketDepth++;
 566           break;
 567         case ']':
 568           assert(BracketDepth > 0 && "Invalid regex");
 569           BracketDepth--;
 570           break;
 571       }
 572       Str = Str.substr(1);
 573       Offset++;
 574     }
 575   }
 576
 577   return StringRef::npos;
 578 }
 579
 580
 581 //===----------------------------------------------------------------------===//
 582 // Check Strings.
 583 //===----------------------------------------------------------------------===//
 584
 585 /// CheckString - This is a check that we found in the input file.
 586 struct CheckString {
 587   /// Pat - The pattern to match.
 588   Pattern Pat;
 589
 590   /// Loc - The location in the match file that the check string was specified.
 591   SMLoc Loc;
 592
 593   /// IsCheckNext - This is true if this is a CHECK-NEXT: directive (as opposed
 594   /// to a CHECK: directive.
 595   bool IsCheckNext;
 596
 597   /// DagNotStrings - These are all of the strings that are disallowed from
 598   /// occurring between this match string and the previous one (or start of
 599   /// file).
 600   std::vector<Pattern> DagNotStrings;
 601
 602   CheckString(const Pattern &P, SMLoc L, bool isCheckNext)
 603     : Pat(P), Loc(L), IsCheckNext(isCheckNext) {}
 604
 605   /// Check - Match check string and its "not strings" and/or "dag strings".
 606   size_t Check(const SourceMgr &SM, StringRef Buffer, size_t &MatchLen,
 607                StringMap<StringRef> &VariableTable) const;
 608
 609   /// CheckNext - Verify there is a single line in the given buffer.
 610   bool CheckNext(const SourceMgr &SM, StringRef Buffer) const;
 611
 612   /// CheckNot - Verify there's no "not strings" in the given buffer.
 613   bool CheckNot(const SourceMgr &SM, StringRef Buffer,
 614                 const std::vector<const Pattern *> &NotStrings,
 615                 StringMap<StringRef> &VariableTable) const;
 616
 617   /// CheckDag - Match "dag strings" and their mixed "not strings".
 618   size_t CheckDag(const SourceMgr &SM, StringRef Buffer,
 619                   std::vector<const Pattern *> &NotStrings,
 620                   StringMap<StringRef> &VariableTable) const;
 621 };
 622
 623 /// Canonicalize whitespaces in the input file. Line endings are replaced
 624 /// with UNIX-style '\n'.
 625 ///
 626 /// \param PreserveHorizontal Don't squash consecutive horizontal whitespace
 627 /// characters to a single space.
 628 static MemoryBuffer *CanonicalizeInputFile(MemoryBuffer *MB,
 629                                            bool PreserveHorizontal) {
 630   SmallString<128> NewFile;
 631   NewFile.reserve(MB->getBufferSize());
 632
 633   for (const char *Ptr = MB->getBufferStart(), *End = MB->getBufferEnd();
 634        Ptr != End; ++Ptr) {
 635     // Eliminate trailing dosish \r.
 636     if (Ptr <= End - 2 && Ptr[0] == '\r' && Ptr[1] == '\n') {
 637       continue;
 638     }
 639
 640     // If current char is not a horizontal whitespace or if horizontal
 641     // whitespace canonicalization is disabled, dump it to output as is.
 642     if (PreserveHorizontal || (*Ptr != ' ' && *Ptr != '\t')) {
 643       NewFile.push_back(*Ptr);
 644       continue;
 645     }
 646
 647     // Otherwise, add one space and advance over neighboring space.
 648     NewFile.push_back(' ');
 649     while (Ptr+1 != End &&
 650            (Ptr[1] == ' ' || Ptr[1] == '\t'))
 651       ++Ptr;
 652   }
 653
 654   // Free the old buffer and return a new one.
 655   MemoryBuffer *MB2 =
 656     MemoryBuffer::getMemBufferCopy(NewFile.str(), MB->getBufferIdentifier());
 657
 658   delete MB;
 659   return MB2;
 660 }
 661
 662
 663 /// ReadCheckFile - Read the check file, which specifies the sequence of
 664 /// expected strings.  The strings are added to the CheckStrings vector.
 665 /// Returns true in case of an error, false otherwise.
 666 static bool ReadCheckFile(SourceMgr &SM,
 667                           std::vector<CheckString> &CheckStrings) {
 668   OwningPtr<MemoryBuffer> File;
 669   if (error_code ec =
 670         MemoryBuffer::getFileOrSTDIN(CheckFilename.c_str(), File)) {
 671     errs() << "Could not open check file '" << CheckFilename << "': "
 672            << ec.message() << '\n';
 673     return true;
 674   }
 675
 676   // If we want to canonicalize whitespace, strip excess whitespace from the
 677   // buffer containing the CHECK lines. Remove DOS style line endings.
 678   MemoryBuffer *F =
 679     CanonicalizeInputFile(File.take(), NoCanonicalizeWhiteSpace);
 680
 681   SM.AddNewSourceBuffer(F, SMLoc());
 682
 683   // Find all instances of CheckPrefix followed by : in the file.
 684   StringRef Buffer = F->getBuffer();
 685   std::vector<Pattern> DagNotMatches;
 686
 687   // LineNumber keeps track of the line on which CheckPrefix instances are
 688   // found.
 689   unsigned LineNumber = 1;
 690
 691   while (1) {
 692     // See if Prefix occurs in the memory buffer.
 693     size_t PrefixLoc = Buffer.find(CheckPrefix);
 694     // If we didn't find a match, we're done.
 695     if (PrefixLoc == StringRef::npos)
 696       break;
 697
 698     LineNumber += Buffer.substr(0, PrefixLoc).count('\n');
 699
 700     Buffer = Buffer.substr(PrefixLoc);
 701
 702     const char *CheckPrefixStart = Buffer.data();
 703
 704     // When we find a check prefix, keep track of whether we find CHECK: or
 705     // CHECK-NEXT:
 706     bool IsCheckNext = false, IsCheckNot = false, IsCheckDag = false;
 707
 708     // Verify that the : is present after the prefix.
 709     if (Buffer[CheckPrefix.size()] == ':') {
 710       Buffer = Buffer.substr(CheckPrefix.size()+1);
 711     } else if (Buffer.size() > CheckPrefix.size()+6 &&
 712                memcmp(Buffer.data()+CheckPrefix.size(), "-NEXT:", 6) == 0) {
 713       Buffer = Buffer.substr(CheckPrefix.size()+6);
 714       IsCheckNext = true;
 715     } else if (Buffer.size() > CheckPrefix.size()+5 &&
 716                memcmp(Buffer.data()+CheckPrefix.size(), "-NOT:", 5) == 0) {
 717       Buffer = Buffer.substr(CheckPrefix.size()+5);
 718       IsCheckNot = true;
 719     } else if (Buffer.size() > CheckPrefix.size()+5 &&
 720                memcmp(Buffer.data()+CheckPrefix.size(), "-DAG:", 5) == 0) {
 721       Buffer = Buffer.substr(CheckPrefix.size()+5);
 722       IsCheckDag = true;
 723     } else {
 724       Buffer = Buffer.substr(1);
 725       continue;
 726     }
 727
 728     // Okay, we found the prefix, yay.  Remember the rest of the line, but
 729     // ignore leading and trailing whitespace.
 730     Buffer = Buffer.substr(Buffer.find_first_not_of(" \t"));
 731
 732     // Scan ahead to the end of line.
 733     size_t EOL = Buffer.find_first_of("\n\r");
 734
 735     // Remember the location of the start of the pattern, for diagnostics.
 736     SMLoc PatternLoc = SMLoc::getFromPointer(Buffer.data());
 737
 738     // Parse the pattern.
 739     Pattern P;
 740     if (P.ParsePattern(Buffer.substr(0, EOL), SM, LineNumber))
 741       return true;
 742
 743     P.setMatchNot(IsCheckNot);
 744     P.setMatchDag(IsCheckDag);
 745
 746     Buffer = Buffer.substr(EOL);
 747
 748     // Verify that CHECK-NEXT lines have at least one CHECK line before them.
 749     if (IsCheckNext && CheckStrings.empty()) {
 750       SM.PrintMessage(SMLoc::getFromPointer(CheckPrefixStart),
 751                       SourceMgr::DK_Error,
 752                       "found '"+CheckPrefix+"-NEXT:' without previous '"+
 753                       CheckPrefix+ ": line");
 754       return true;
 755     }
 756
 757     // Handle CHECK-DAG/-NOT.
 758     if (IsCheckDag || IsCheckNot) {
 759       DagNotMatches.push_back(P);
 760       continue;
 761     }
 762
 763     // Okay, add the string we captured to the output vector and move on.
 764     CheckStrings.push_back(CheckString(P,
 765                                        PatternLoc,
 766                                        IsCheckNext));
 767     std::swap(DagNotMatches, CheckStrings.back().DagNotStrings);
 768   }
 769
 770   // Add an EOF pattern for any trailing CHECK-DAG/-NOTs.
 771   if (!DagNotMatches.empty()) {
 772     CheckStrings.push_back(CheckString(Pattern(true),
 773                                        SMLoc::getFromPointer(Buffer.data()),
 774                                        false));
 775     std::swap(DagNotMatches, CheckStrings.back().DagNotStrings);
 776   }
 777
 778   if (CheckStrings.empty()) {
 779     errs() << "error: no check strings found with prefix '" << CheckPrefix
 780            << ":'\n";
 781     return true;
 782   }
 783
 784   return false;
 785 }
 786
 787 static void PrintCheckFailed(const SourceMgr &SM, const SMLoc &Loc,
 788                              const Pattern &Pat, StringRef Buffer,
 789                              StringMap<StringRef> &VariableTable) {
 790   // Otherwise, we have an error, emit an error message.
 791   SM.PrintMessage(Loc, SourceMgr::DK_Error,
 792                   "expected string not found in input");
 793
 794   // Print the "scanning from here" line.  If the current position is at the
 795   // end of a line, advance to the start of the next line.
 796   Buffer = Buffer.substr(Buffer.find_first_not_of(" \t\n\r"));
 797
 798   SM.PrintMessage(SMLoc::getFromPointer(Buffer.data()), SourceMgr::DK_Note,
 799                   "scanning from here");
 800
 801   // Allow the pattern to print additional information if desired.
 802   Pat.PrintFailureInfo(SM, Buffer, VariableTable);
 803 }
 804
 805 static void PrintCheckFailed(const SourceMgr &SM, const CheckString &CheckStr,
 806                              StringRef Buffer,
 807                              StringMap<StringRef> &VariableTable) {
 808   PrintCheckFailed(SM, CheckStr.Loc, CheckStr.Pat, Buffer, VariableTable);
 809 }
 810
 811 /// CountNumNewlinesBetween - Count the number of newlines in the specified
 812 /// range.
 813 static unsigned CountNumNewlinesBetween(StringRef Range) {
 814   unsigned NumNewLines = 0;
 815   while (1) {
 816     // Scan for newline.
 817     Range = Range.substr(Range.find_first_of("\n\r"));
 818     if (Range.empty()) return NumNewLines;
 819
 820     ++NumNewLines;
 821
 822     // Handle \n\r and \r\n as a single newline.
 823     if (Range.size() > 1 &&
 824         (Range[1] == '\n' || Range[1] == '\r') &&
 825         (Range[0] != Range[1]))
 826       Range = Range.substr(1);
 827     Range = Range.substr(1);
 828   }
 829 }
 830
 831 size_t CheckString::Check(const SourceMgr &SM, StringRef Buffer,
 832                           size_t &MatchLen,
 833                           StringMap<StringRef> &VariableTable) const {
 834   size_t LastPos = 0;
 835   std::vector<const Pattern *> NotStrings;
 836
 837   // Match "dag strings" (with mixed "not strings" if any).
 838   LastPos = CheckDag(SM, Buffer, NotStrings, VariableTable);
 839   if (LastPos == StringRef::npos)
 840     return StringRef::npos;
 841
 842   // Match itself from the last position after matching CHECK-DAG.
 843   StringRef MatchBuffer = Buffer.substr(LastPos);
 844   size_t MatchPos = Pat.Match(MatchBuffer, MatchLen, VariableTable);
 845   if (MatchPos == StringRef::npos) {
 846     PrintCheckFailed(SM, *this, MatchBuffer, VariableTable);
 847     return StringRef::npos;
 848   }
 849   MatchPos += LastPos;
 850
 851   StringRef SkippedRegion = Buffer.substr(LastPos, MatchPos);
 852
 853   // If this check is a "CHECK-NEXT", verify that the previous match was on
 854   // the previous line (i.e. that there is one newline between them).
 855   if (CheckNext(SM, SkippedRegion))
 856     return StringRef::npos;
 857
 858   // If this match had "not strings", verify that they don't exist in the
 859   // skipped region.
 860   if (CheckNot(SM, SkippedRegion, NotStrings, VariableTable))
 861     return StringRef::npos;
 862
 863   return MatchPos;
 864 }
 865
 866 bool CheckString::CheckNext(const SourceMgr &SM, StringRef Buffer) const {
 867   if (!IsCheckNext)
 868     return false;
 869
 870   // Count the number of newlines between the previous match and this one.
 871   assert(Buffer.data() !=
 872          SM.getMemoryBuffer(
 873            SM.FindBufferContainingLoc(
 874              SMLoc::getFromPointer(Buffer.data())))->getBufferStart() &&
 875          "CHECK-NEXT can't be the first check in a file");
 876
 877   unsigned NumNewLines = CountNumNewlinesBetween(Buffer);
 878
 879   if (NumNewLines == 0) {
 880     SM.PrintMessage(Loc, SourceMgr::DK_Error, CheckPrefix+
 881                     "-NEXT: is on the same line as previous match");
 882     SM.PrintMessage(SMLoc::getFromPointer(Buffer.end()),
 883                     SourceMgr::DK_Note, "'next' match was here");
 884     SM.PrintMessage(SMLoc::getFromPointer(Buffer.data()), SourceMgr::DK_Note,
 885                     "previous match ended here");
 886     return true;
 887   }
 888
 889   if (NumNewLines != 1) {
 890     SM.PrintMessage(Loc, SourceMgr::DK_Error, CheckPrefix+
 891                     "-NEXT: is not on the line after the previous match");
 892     SM.PrintMessage(SMLoc::getFromPointer(Buffer.end()),
 893                     SourceMgr::DK_Note, "'next' match was here");
 894     SM.PrintMessage(SMLoc::getFromPointer(Buffer.data()), SourceMgr::DK_Note,
 895                     "previous match ended here");
 896     return true;
 897   }
 898
 899   return false;
 900 }
 901
 902 bool CheckString::CheckNot(const SourceMgr &SM, StringRef Buffer,
 903                            const std::vector<const Pattern *> &NotStrings,
 904                            StringMap<StringRef> &VariableTable) const {
 905   for (unsigned ChunkNo = 0, e = NotStrings.size();
 906        ChunkNo != e; ++ChunkNo) {
 907     const Pattern *Pat = NotStrings[ChunkNo];
 908     assert(Pat->getMatchNot() && "Expect CHECK-NOT!");
 909
 910     size_t MatchLen = 0;
 911     size_t Pos = Pat->Match(Buffer, MatchLen, VariableTable);
 912
 913     if (Pos == StringRef::npos) continue;
 914
 915     SM.PrintMessage(SMLoc::getFromPointer(Buffer.data()+Pos),
 916                     SourceMgr::DK_Error,
 917                     CheckPrefix+"-NOT: string occurred!");
 918     SM.PrintMessage(Pat->getLoc(), SourceMgr::DK_Note,
 919                     CheckPrefix+"-NOT: pattern specified here");
 920     return true;
 921   }
 922
 923   return false;
 924 }
 925
 926 size_t CheckString::CheckDag(const SourceMgr &SM, StringRef Buffer,
 927                              std::vector<const Pattern *> &NotStrings,
 928                              StringMap<StringRef> &VariableTable) const {
 929   if (DagNotStrings.empty())
 930     return 0;
 931
 932   size_t LastPos = 0;
 933   size_t StartPos = LastPos;
 934
 935   for (unsigned ChunkNo = 0, e = DagNotStrings.size();
 936        ChunkNo != e; ++ChunkNo) {
 937     const Pattern &Pat = DagNotStrings[ChunkNo];
 938
 939     assert((Pat.getMatchDag() ^ Pat.getMatchNot()) &&
 940            "Invalid CHECK-DAG or CHECK-NOT!");
 941
 942     if (Pat.getMatchNot()) {
 943       NotStrings.push_back(&Pat);
 944       continue;
 945     }
 946
 947     assert(Pat.getMatchDag() && "Expect CHECK-DAG!");
 948
 949     size_t MatchLen = 0, MatchPos;
 950
 951     // CHECK-DAG always matches from the start.
 952     StringRef MatchBuffer = Buffer.substr(StartPos);
 953     MatchPos = Pat.Match(MatchBuffer, MatchLen, VariableTable);
 954     // With a group of CHECK-DAGs, a single mismatching means the match on
 955     // that group of CHECK-DAGs fails immediately.
 956     if (MatchPos == StringRef::npos) {
 957       PrintCheckFailed(SM, Pat.getLoc(), Pat, MatchBuffer, VariableTable);
 958       return StringRef::npos;
 959     }
 960     // Re-calc it as the offset relative to the start of the original string.
 961     MatchPos += StartPos;
 962
 963     if (!NotStrings.empty()) {
 964       if (MatchPos < LastPos) {
 965         // Reordered?
 966         SM.PrintMessage(SMLoc::getFromPointer(Buffer.data() + MatchPos),
 967                         SourceMgr::DK_Error,
 968                         CheckPrefix+"-DAG: found a match of CHECK-DAG"
 969                         " reordering across a CHECK-NOT");
 970         SM.PrintMessage(SMLoc::getFromPointer(Buffer.data() + LastPos),
 971                         SourceMgr::DK_Note,
 972                         CheckPrefix+"-DAG: the farthest match of CHECK-DAG"
 973                         " is found here");
 974         SM.PrintMessage(NotStrings[0]->getLoc(), SourceMgr::DK_Note,
 975                         CheckPrefix+"-NOT: the crossed pattern specified"
 976                         " here");
 977         SM.PrintMessage(Pat.getLoc(), SourceMgr::DK_Note,
 978                         CheckPrefix+"-DAG: the reordered pattern specified"
 979                         " here");
 980         return StringRef::npos;
 981       }
 982       // All subsequent CHECK-DAGs should be matched from the farthest
 983       // position of all precedent CHECK-DAGs (including this one.)
 984       StartPos = LastPos;
 985       // If there's CHECK-NOTs between two CHECK-DAGs or from CHECK to
 986       // CHECK-DAG, verify that there's no 'not' strings occurred in that
 987       // region.
 988       StringRef SkippedRegion = Buffer.substr(LastPos, MatchPos);
 989       size_t Pos = CheckNot(SM, SkippedRegion, NotStrings, VariableTable);
 990       if (Pos != StringRef::npos)
 991         return StringRef::npos;
 992       // Clear "not strings".
 993       NotStrings.clear();
 994     }
 995
 996     // Update the last position with CHECK-DAG matches.
 997     LastPos = std::max(MatchPos + MatchLen, LastPos);
 998   }
 999
1000   return LastPos;
1001 }
1002
1003 int main(int argc, char **argv) {
1004   sys::PrintStackTraceOnErrorSignal();
1005   PrettyStackTraceProgram X(argc, argv);
1006   cl::ParseCommandLineOptions(argc, argv);
1007
1008   SourceMgr SM;
1009
1010   // Read the expected strings from the check file.
1011   std::vector<CheckString> CheckStrings;
1012   if (ReadCheckFile(SM, CheckStrings))
1013     return 2;
1014
1015   // Open the file to check and add it to SourceMgr.
1016   OwningPtr<MemoryBuffer> File;
1017   if (error_code ec =
1018         MemoryBuffer::getFileOrSTDIN(InputFilename.c_str(), File)) {
1019     errs() << "Could not open input file '" << InputFilename << "': "
1020            << ec.message() << '\n';
1021     return 2;
1022   }
1023
1024   if (File->getBufferSize() == 0) {
1025     errs() << "FileCheck error: '" << InputFilename << "' is empty.\n";
1026     return 2;
1027   }
1028
1029   // Remove duplicate spaces in the input file if requested.
1030   // Remove DOS style line endings.
1031   MemoryBuffer *F =
1032     CanonicalizeInputFile(File.take(), NoCanonicalizeWhiteSpace);
1033
1034   SM.AddNewSourceBuffer(F, SMLoc());
1035
1036   /// VariableTable - This holds all the current filecheck variables.
1037   StringMap<StringRef> VariableTable;
1038
1039   // Check that we have all of the expected strings, in order, in the input
1040   // file.
1041   StringRef Buffer = F->getBuffer();
1042
1043   for (unsigned StrNo = 0, e = CheckStrings.size(); StrNo != e; ++StrNo) {
1044     const CheckString &CheckStr = CheckStrings[StrNo];
1045
1046     // Find StrNo in the file.
1047     size_t MatchLen = 0;
1048     size_t MatchPos = CheckStr.Check(SM, Buffer, MatchLen, VariableTable);
1049
1050     if (MatchPos == StringRef::npos)
1051       return 1;
1052
1053     Buffer = Buffer.substr(MatchPos + MatchLen);
1054   }
1055
1056   return 0;
1057 }