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/ADT/StringSet.h"
  24 #include "llvm/Support/CommandLine.h"
  25 #include "llvm/Support/MemoryBuffer.h"
  26 #include "llvm/Support/PrettyStackTrace.h"
  27 #include "llvm/Support/Regex.h"
  28 #include "llvm/Support/Signals.h"
  29 #include "llvm/Support/SourceMgr.h"
  30 #include "llvm/Support/raw_ostream.h"
  31 #include "llvm/Support/system_error.h"
  32 #include <algorithm>
  33 #include <cctype>
  34 #include <map>
  35 #include <string>
  36 #include <vector>
  37 using namespace llvm;
  38
  39 static cl::opt<std::string>
  40 CheckFilename(cl::Positional, cl::desc("<check-file>"), cl::Required);
  41
  42 static cl::opt<std::string>
  43 InputFilename("input-file", cl::desc("File to check (defaults to stdin)"),
  44               cl::init("-"), cl::value_desc("filename"));
  45
  46 static cl::list<std::string>
  47 CheckPrefixes("check-prefix",
  48               cl::desc("Prefix to use from check file (defaults to 'CHECK')"));
  49
  50 static cl::opt<bool>
  51 NoCanonicalizeWhiteSpace("strict-whitespace",
  52               cl::desc("Do not treat all horizontal whitespace as equivalent"));
  53
  54 typedef cl::list<std::string>::const_iterator prefix_iterator;
  55
  56 //===----------------------------------------------------------------------===//
  57 // Pattern Handling Code.
  58 //===----------------------------------------------------------------------===//
  59
  60 namespace Check {
  61   enum CheckType {
  62     CheckNone = 0,
  63     CheckPlain,
  64     CheckNext,
  65     CheckNot,
  66     CheckDAG,
  67     CheckLabel,
  68
  69     /// MatchEOF - When set, this pattern only matches the end of file. This is
  70     /// used for trailing CHECK-NOTs.
  71     CheckEOF
  72   };
  73 }
  74
  75 class Pattern {
  76   SMLoc PatternLoc;
  77
  78   Check::CheckType CheckTy;
  79
  80   /// FixedStr - If non-empty, this pattern is a fixed string match with the
  81   /// specified fixed string.
  82   StringRef FixedStr;
  83
  84   /// RegEx - If non-empty, this is a regex pattern.
  85   std::string RegExStr;
  86
  87   /// \brief Contains the number of line this pattern is in.
  88   unsigned LineNumber;
  89
  90   /// VariableUses - Entries in this vector map to uses of a variable in the
  91   /// pattern, e.g. "foo[[bar]]baz".  In this case, the RegExStr will contain
  92   /// "foobaz" and we'll get an entry in this vector that tells us to insert the
  93   /// value of bar at offset 3.
  94   std::vector<std::pair<StringRef, unsigned> > VariableUses;
  95
  96   /// VariableDefs - Maps definitions of variables to their parenthesized
  97   /// capture numbers.
  98   /// E.g. for the pattern "foo[[bar:.*]]baz", VariableDefs will map "bar" to 1.
  99   std::map<StringRef, unsigned> VariableDefs;
 100
 101 public:
 102
 103   Pattern(Check::CheckType Ty)
 104     : CheckTy(Ty) { }
 105
 106   /// getLoc - Return the location in source code.
 107   SMLoc getLoc() const { return PatternLoc; }
 108
 109   /// ParsePattern - Parse the given string into the Pattern. Prefix provides
 110   /// which prefix is being matched, SM provides the SourceMgr used for error
 111   /// reports, and LineNumber is the line number in the input file from which
 112   /// the pattern string was read.  Returns true in case of an error, false
 113   /// otherwise.
 114   bool ParsePattern(StringRef PatternStr,
 115                     StringRef Prefix,
 116                     SourceMgr &SM,
 117                     unsigned LineNumber);
 118
 119   /// Match - Match the pattern string against the input buffer Buffer.  This
 120   /// returns the position that is matched or npos if there is no match.  If
 121   /// there is a match, the size of the matched string is returned in MatchLen.
 122   ///
 123   /// The VariableTable StringMap provides the current values of filecheck
 124   /// variables and is updated if this match defines new values.
 125   size_t Match(StringRef Buffer, size_t &MatchLen,
 126                StringMap<StringRef> &VariableTable) const;
 127
 128   /// PrintFailureInfo - Print additional information about a failure to match
 129   /// involving this pattern.
 130   void PrintFailureInfo(const SourceMgr &SM, StringRef Buffer,
 131                         const StringMap<StringRef> &VariableTable) const;
 132
 133   bool hasVariable() const { return !(VariableUses.empty() &&
 134                                       VariableDefs.empty()); }
 135
 136   Check::CheckType getCheckTy() const { return CheckTy; }
 137
 138 private:
 139   static void AddFixedStringToRegEx(StringRef FixedStr, std::string &TheStr);
 140   bool AddRegExToRegEx(StringRef RS, unsigned &CurParen, SourceMgr &SM);
 141   void AddBackrefToRegEx(unsigned BackrefNum);
 142
 143   /// ComputeMatchDistance - Compute an arbitrary estimate for the quality of
 144   /// matching this pattern at the start of \arg Buffer; a distance of zero
 145   /// should correspond to a perfect match.
 146   unsigned ComputeMatchDistance(StringRef Buffer,
 147                                const StringMap<StringRef> &VariableTable) const;
 148
 149   /// \brief Evaluates expression and stores the result to \p Value.
 150   /// \return true on success. false when the expression has invalid syntax.
 151   bool EvaluateExpression(StringRef Expr, std::string &Value) const;
 152
 153   /// \brief Finds the closing sequence of a regex variable usage or
 154   /// definition. Str has to point in the beginning of the definition
 155   /// (right after the opening sequence).
 156   /// \return offset of the closing sequence within Str, or npos if it was not
 157   /// found.
 158   size_t FindRegexVarEnd(StringRef Str);
 159 };
 160
 161
 162 bool Pattern::ParsePattern(StringRef PatternStr,
 163                            StringRef Prefix,
 164                            SourceMgr &SM,
 165                            unsigned LineNumber) {
 166   this->LineNumber = LineNumber;
 167   PatternLoc = SMLoc::getFromPointer(PatternStr.data());
 168
 169   // Ignore trailing whitespace.
 170   while (!PatternStr.empty() &&
 171          (PatternStr.back() == ' ' || PatternStr.back() == '\t'))
 172     PatternStr = PatternStr.substr(0, PatternStr.size()-1);
 173
 174   // Check that there is something on the line.
 175   if (PatternStr.empty()) {
 176     SM.PrintMessage(PatternLoc, SourceMgr::DK_Error,
 177                     "found empty check string with prefix '" +
 178                     Prefix + ":'");
 179     return true;
 180   }
 181
 182   // Check to see if this is a fixed string, or if it has regex pieces.
 183   if (PatternStr.size() < 2 ||
 184       (PatternStr.find("{{") == StringRef::npos &&
 185        PatternStr.find("[[") == StringRef::npos)) {
 186     FixedStr = PatternStr;
 187     return false;
 188   }
 189
 190   // Paren value #0 is for the fully matched string.  Any new parenthesized
 191   // values add from there.
 192   unsigned CurParen = 1;
 193
 194   // Otherwise, there is at least one regex piece.  Build up the regex pattern
 195   // by escaping scary characters in fixed strings, building up one big regex.
 196   while (!PatternStr.empty()) {
 197     // RegEx matches.
 198     if (PatternStr.startswith("{{")) {
 199       // This is the start of a regex match.  Scan for the }}.
 200       size_t End = PatternStr.find("}}");
 201       if (End == StringRef::npos) {
 202         SM.PrintMessage(SMLoc::getFromPointer(PatternStr.data()),
 203                         SourceMgr::DK_Error,
 204                         "found start of regex string with no end '}}'");
 205         return true;
 206       }
 207
 208       // Enclose {{}} patterns in parens just like [[]] even though we're not
 209       // capturing the result for any purpose.  This is required in case the
 210       // expression contains an alternation like: CHECK:  abc{{x|z}}def.  We
 211       // want this to turn into: "abc(x|z)def" not "abcx|zdef".
 212       RegExStr += '(';
 213       ++CurParen;
 214
 215       if (AddRegExToRegEx(PatternStr.substr(2, End-2), CurParen, SM))
 216         return true;
 217       RegExStr += ')';
 218
 219       PatternStr = PatternStr.substr(End+2);
 220       continue;
 221     }
 222
 223     // Named RegEx matches.  These are of two forms: [[foo:.*]] which matches .*
 224     // (or some other regex) and assigns it to the FileCheck variable 'foo'. The
 225     // second form is [[foo]] which is a reference to foo.  The variable name
 226     // itself must be of the form "[a-zA-Z_][0-9a-zA-Z_]*", otherwise we reject
 227     // it.  This is to catch some common errors.
 228     if (PatternStr.startswith("[[")) {
 229       // Find the closing bracket pair ending the match.  End is going to be an
 230       // offset relative to the beginning of the match string.
 231       size_t End = FindRegexVarEnd(PatternStr.substr(2));
 232
 233       if (End == StringRef::npos) {
 234         SM.PrintMessage(SMLoc::getFromPointer(PatternStr.data()),
 235                         SourceMgr::DK_Error,
 236                         "invalid named regex reference, no ]] found");
 237         return true;
 238       }
 239
 240       StringRef MatchStr = PatternStr.substr(2, End);
 241       PatternStr = PatternStr.substr(End+4);
 242
 243       // Get the regex name (e.g. "foo").
 244       size_t NameEnd = MatchStr.find(':');
 245       StringRef Name = MatchStr.substr(0, NameEnd);
 246
 247       if (Name.empty()) {
 248         SM.PrintMessage(SMLoc::getFromPointer(Name.data()), SourceMgr::DK_Error,
 249                         "invalid name in named regex: empty name");
 250         return true;
 251       }
 252
 253       // Verify that the name/expression is well formed. FileCheck currently
 254       // supports @LINE, @LINE+number, @LINE-number expressions. The check here
 255       // is relaxed, more strict check is performed in \c EvaluateExpression.
 256       bool IsExpression = false;
 257       for (unsigned i = 0, e = Name.size(); i != e; ++i) {
 258         if (i == 0 && Name[i] == '@') {
 259           if (NameEnd != StringRef::npos) {
 260             SM.PrintMessage(SMLoc::getFromPointer(Name.data()),
 261                             SourceMgr::DK_Error,
 262                             "invalid name in named regex definition");
 263             return true;
 264           }
 265           IsExpression = true;
 266           continue;
 267         }
 268         if (Name[i] != '_' && !isalnum(Name[i]) &&
 269             (!IsExpression || (Name[i] != '+' && Name[i] != '-'))) {
 270           SM.PrintMessage(SMLoc::getFromPointer(Name.data()+i),
 271                           SourceMgr::DK_Error, "invalid name in named regex");
 272           return true;
 273         }
 274       }
 275
 276       // Name can't start with a digit.
 277       if (isdigit(static_cast<unsigned char>(Name[0]))) {
 278         SM.PrintMessage(SMLoc::getFromPointer(Name.data()), SourceMgr::DK_Error,
 279                         "invalid name in named regex");
 280         return true;
 281       }
 282
 283       // Handle [[foo]].
 284       if (NameEnd == StringRef::npos) {
 285         // Handle variables that were defined earlier on the same line by
 286         // emitting a backreference.
 287         if (VariableDefs.find(Name) != VariableDefs.end()) {
 288           unsigned VarParenNum = VariableDefs[Name];
 289           if (VarParenNum < 1 || VarParenNum > 9) {
 290             SM.PrintMessage(SMLoc::getFromPointer(Name.data()),
 291                             SourceMgr::DK_Error,
 292                             "Can't back-reference more than 9 variables");
 293             return true;
 294           }
 295           AddBackrefToRegEx(VarParenNum);
 296         } else {
 297           VariableUses.push_back(std::make_pair(Name, RegExStr.size()));
 298         }
 299         continue;
 300       }
 301
 302       // Handle [[foo:.*]].
 303       VariableDefs[Name] = CurParen;
 304       RegExStr += '(';
 305       ++CurParen;
 306
 307       if (AddRegExToRegEx(MatchStr.substr(NameEnd+1), CurParen, SM))
 308         return true;
 309
 310       RegExStr += ')';
 311     }
 312
 313     // Handle fixed string matches.
 314     // Find the end, which is the start of the next regex.
 315     size_t FixedMatchEnd = PatternStr.find("{{");
 316     FixedMatchEnd = std::min(FixedMatchEnd, PatternStr.find("[["));
 317     AddFixedStringToRegEx(PatternStr.substr(0, FixedMatchEnd), RegExStr);
 318     PatternStr = PatternStr.substr(FixedMatchEnd);
 319   }
 320
 321   return false;
 322 }
 323
 324 void Pattern::AddFixedStringToRegEx(StringRef FixedStr, std::string &TheStr) {
 325   // Add the characters from FixedStr to the regex, escaping as needed.  This
 326   // avoids "leaning toothpicks" in common patterns.
 327   for (unsigned i = 0, e = FixedStr.size(); i != e; ++i) {
 328     switch (FixedStr[i]) {
 329     // These are the special characters matched in "p_ere_exp".
 330     case '(':
 331     case ')':
 332     case '^':
 333     case '$':
 334     case '|':
 335     case '*':
 336     case '+':
 337     case '?':
 338     case '.':
 339     case '[':
 340     case '\\':
 341     case '{':
 342       TheStr += '\\';
 343       // FALL THROUGH.
 344     default:
 345       TheStr += FixedStr[i];
 346       break;
 347     }
 348   }
 349 }
 350
 351 bool Pattern::AddRegExToRegEx(StringRef RS, unsigned &CurParen,
 352                               SourceMgr &SM) {
 353   Regex R(RS);
 354   std::string Error;
 355   if (!R.isValid(Error)) {
 356     SM.PrintMessage(SMLoc::getFromPointer(RS.data()), SourceMgr::DK_Error,
 357                     "invalid regex: " + Error);
 358     return true;
 359   }
 360
 361   RegExStr += RS.str();
 362   CurParen += R.getNumMatches();
 363   return false;
 364 }
 365
 366 void Pattern::AddBackrefToRegEx(unsigned BackrefNum) {
 367   assert(BackrefNum >= 1 && BackrefNum <= 9 && "Invalid backref number");
 368   std::string Backref = std::string("\\") +
 369                         std::string(1, '0' + BackrefNum);
 370   RegExStr += Backref;
 371 }
 372
 373 bool Pattern::EvaluateExpression(StringRef Expr, std::string &Value) const {
 374   // The only supported expression is @LINE([\+-]\d+)?
 375   if (!Expr.startswith("@LINE"))
 376     return false;
 377   Expr = Expr.substr(StringRef("@LINE").size());
 378   int Offset = 0;
 379   if (!Expr.empty()) {
 380     if (Expr[0] == '+')
 381       Expr = Expr.substr(1);
 382     else if (Expr[0] != '-')
 383       return false;
 384     if (Expr.getAsInteger(10, Offset))
 385       return false;
 386   }
 387   Value = llvm::itostr(LineNumber + Offset);
 388   return true;
 389 }
 390
 391 /// Match - Match the pattern string against the input buffer Buffer.  This
 392 /// returns the position that is matched or npos if there is no match.  If
 393 /// there is a match, the size of the matched string is returned in MatchLen.
 394 size_t Pattern::Match(StringRef Buffer, size_t &MatchLen,
 395                       StringMap<StringRef> &VariableTable) const {
 396   // If this is the EOF pattern, match it immediately.
 397   if (CheckTy == Check::CheckEOF) {
 398     MatchLen = 0;
 399     return Buffer.size();
 400   }
 401
 402   // If this is a fixed string pattern, just match it now.
 403   if (!FixedStr.empty()) {
 404     MatchLen = FixedStr.size();
 405     return Buffer.find(FixedStr);
 406   }
 407
 408   // Regex match.
 409
 410   // If there are variable uses, we need to create a temporary string with the
 411   // actual value.
 412   StringRef RegExToMatch = RegExStr;
 413   std::string TmpStr;
 414   if (!VariableUses.empty()) {
 415     TmpStr = RegExStr;
 416
 417     unsigned InsertOffset = 0;
 418     for (unsigned i = 0, e = VariableUses.size(); i != e; ++i) {
 419       std::string Value;
 420
 421       if (VariableUses[i].first[0] == '@') {
 422         if (!EvaluateExpression(VariableUses[i].first, Value))
 423           return StringRef::npos;
 424       } else {
 425         StringMap<StringRef>::iterator it =
 426           VariableTable.find(VariableUses[i].first);
 427         // If the variable is undefined, return an error.
 428         if (it == VariableTable.end())
 429           return StringRef::npos;
 430
 431         // Look up the value and escape it so that we can plop it into the regex.
 432         AddFixedStringToRegEx(it->second, Value);
 433       }
 434
 435       // Plop it into the regex at the adjusted offset.
 436       TmpStr.insert(TmpStr.begin()+VariableUses[i].second+InsertOffset,
 437                     Value.begin(), Value.end());
 438       InsertOffset += Value.size();
 439     }
 440
 441     // Match the newly constructed regex.
 442     RegExToMatch = TmpStr;
 443   }
 444
 445
 446   SmallVector<StringRef, 4> MatchInfo;
 447   if (!Regex(RegExToMatch, Regex::Newline).match(Buffer, &MatchInfo))
 448     return StringRef::npos;
 449
 450   // Successful regex match.
 451   assert(!MatchInfo.empty() && "Didn't get any match");
 452   StringRef FullMatch = MatchInfo[0];
 453
 454   // If this defines any variables, remember their values.
 455   for (std::map<StringRef, unsigned>::const_iterator I = VariableDefs.begin(),
 456                                                      E = VariableDefs.end();
 457        I != E; ++I) {
 458     assert(I->second < MatchInfo.size() && "Internal paren error");
 459     VariableTable[I->first] = MatchInfo[I->second];
 460   }
 461
 462   MatchLen = FullMatch.size();
 463   return FullMatch.data()-Buffer.data();
 464 }
 465
 466 unsigned Pattern::ComputeMatchDistance(StringRef Buffer,
 467                               const StringMap<StringRef> &VariableTable) const {
 468   // Just compute the number of matching characters. For regular expressions, we
 469   // just compare against the regex itself and hope for the best.
 470   //
 471   // FIXME: One easy improvement here is have the regex lib generate a single
 472   // example regular expression which matches, and use that as the example
 473   // string.
 474   StringRef ExampleString(FixedStr);
 475   if (ExampleString.empty())
 476     ExampleString = RegExStr;
 477
 478   // Only compare up to the first line in the buffer, or the string size.
 479   StringRef BufferPrefix = Buffer.substr(0, ExampleString.size());
 480   BufferPrefix = BufferPrefix.split('\n').first;
 481   return BufferPrefix.edit_distance(ExampleString);
 482 }
 483
 484 void Pattern::PrintFailureInfo(const SourceMgr &SM, StringRef Buffer,
 485                                const StringMap<StringRef> &VariableTable) const{
 486   // If this was a regular expression using variables, print the current
 487   // variable values.
 488   if (!VariableUses.empty()) {
 489     for (unsigned i = 0, e = VariableUses.size(); i != e; ++i) {
 490       SmallString<256> Msg;
 491       raw_svector_ostream OS(Msg);
 492       StringRef Var = VariableUses[i].first;
 493       if (Var[0] == '@') {
 494         std::string Value;
 495         if (EvaluateExpression(Var, Value)) {
 496           OS << "with expression \"";
 497           OS.write_escaped(Var) << "\" equal to \"";
 498           OS.write_escaped(Value) << "\"";
 499         } else {
 500           OS << "uses incorrect expression \"";
 501           OS.write_escaped(Var) << "\"";
 502         }
 503       } else {
 504         StringMap<StringRef>::const_iterator it = VariableTable.find(Var);
 505
 506         // Check for undefined variable references.
 507         if (it == VariableTable.end()) {
 508           OS << "uses undefined variable \"";
 509           OS.write_escaped(Var) << "\"";
 510         } else {
 511           OS << "with variable \"";
 512           OS.write_escaped(Var) << "\" equal to \"";
 513           OS.write_escaped(it->second) << "\"";
 514         }
 515       }
 516
 517       SM.PrintMessage(SMLoc::getFromPointer(Buffer.data()), SourceMgr::DK_Note,
 518                       OS.str());
 519     }
 520   }
 521
 522   // Attempt to find the closest/best fuzzy match.  Usually an error happens
 523   // because some string in the output didn't exactly match. In these cases, we
 524   // would like to show the user a best guess at what "should have" matched, to
 525   // save them having to actually check the input manually.
 526   size_t NumLinesForward = 0;
 527   size_t Best = StringRef::npos;
 528   double BestQuality = 0;
 529
 530   // Use an arbitrary 4k limit on how far we will search.
 531   for (size_t i = 0, e = std::min(size_t(4096), Buffer.size()); i != e; ++i) {
 532     if (Buffer[i] == '\n')
 533       ++NumLinesForward;
 534
 535     // Patterns have leading whitespace stripped, so skip whitespace when
 536     // looking for something which looks like a pattern.
 537     if (Buffer[i] == ' ' || Buffer[i] == '\t')
 538       continue;
 539
 540     // Compute the "quality" of this match as an arbitrary combination of the
 541     // match distance and the number of lines skipped to get to this match.
 542     unsigned Distance = ComputeMatchDistance(Buffer.substr(i), VariableTable);
 543     double Quality = Distance + (NumLinesForward / 100.);
 544
 545     if (Quality < BestQuality || Best == StringRef::npos) {
 546       Best = i;
 547       BestQuality = Quality;
 548     }
 549   }
 550
 551   // Print the "possible intended match here" line if we found something
 552   // reasonable and not equal to what we showed in the "scanning from here"
 553   // line.
 554   if (Best && Best != StringRef::npos && BestQuality < 50) {
 555       SM.PrintMessage(SMLoc::getFromPointer(Buffer.data() + Best),
 556                       SourceMgr::DK_Note, "possible intended match here");
 557
 558     // FIXME: If we wanted to be really friendly we would show why the match
 559     // failed, as it can be hard to spot simple one character differences.
 560   }
 561 }
 562
 563 size_t Pattern::FindRegexVarEnd(StringRef Str) {
 564   // Offset keeps track of the current offset within the input Str
 565   size_t Offset = 0;
 566   // [...] Nesting depth
 567   size_t BracketDepth = 0;
 568
 569   while (!Str.empty()) {
 570     if (Str.startswith("]]") && BracketDepth == 0)
 571       return Offset;
 572     if (Str[0] == '\\') {
 573       // Backslash escapes the next char within regexes, so skip them both.
 574       Str = Str.substr(2);
 575       Offset += 2;
 576     } else {
 577       switch (Str[0]) {
 578         default:
 579           break;
 580         case '[':
 581           BracketDepth++;
 582           break;
 583         case ']':
 584           assert(BracketDepth > 0 && "Invalid regex");
 585           BracketDepth--;
 586           break;
 587       }
 588       Str = Str.substr(1);
 589       Offset++;
 590     }
 591   }
 592
 593   return StringRef::npos;
 594 }
 595
 596
 597 //===----------------------------------------------------------------------===//
 598 // Check Strings.
 599 //===----------------------------------------------------------------------===//
 600
 601 /// CheckString - This is a check that we found in the input file.
 602 struct CheckString {
 603   /// Pat - The pattern to match.
 604   Pattern Pat;
 605
 606   /// Prefix - Which prefix name this check matched.
 607   StringRef Prefix;
 608
 609   /// Loc - The location in the match file that the check string was specified.
 610   SMLoc Loc;
 611
 612   /// CheckTy - Specify what kind of check this is. e.g. CHECK-NEXT: directive,
 613   /// as opposed to a CHECK: directive.
 614   Check::CheckType CheckTy;
 615
 616   /// DagNotStrings - These are all of the strings that are disallowed from
 617   /// occurring between this match string and the previous one (or start of
 618   /// file).
 619   std::vector<Pattern> DagNotStrings;
 620
 621
 622   CheckString(const Pattern &P,
 623               StringRef S,
 624               SMLoc L,
 625               Check::CheckType Ty)
 626     : Pat(P), Prefix(S), Loc(L), CheckTy(Ty) {}
 627
 628   /// Check - Match check string and its "not strings" and/or "dag strings".
 629   size_t Check(const SourceMgr &SM, StringRef Buffer, bool IsLabelScanMode,
 630                size_t &MatchLen, StringMap<StringRef> &VariableTable) const;
 631
 632   /// CheckNext - Verify there is a single line in the given buffer.
 633   bool CheckNext(const SourceMgr &SM, StringRef Buffer) const;
 634
 635   /// CheckNot - Verify there's no "not strings" in the given buffer.
 636   bool CheckNot(const SourceMgr &SM, StringRef Buffer,
 637                 const std::vector<const Pattern *> &NotStrings,
 638                 StringMap<StringRef> &VariableTable) const;
 639
 640   /// CheckDag - Match "dag strings" and their mixed "not strings".
 641   size_t CheckDag(const SourceMgr &SM, StringRef Buffer,
 642                   std::vector<const Pattern *> &NotStrings,
 643                   StringMap<StringRef> &VariableTable) const;
 644 };
 645
 646 /// Canonicalize whitespaces in the input file. Line endings are replaced
 647 /// with UNIX-style '\n'.
 648 ///
 649 /// \param PreserveHorizontal Don't squash consecutive horizontal whitespace
 650 /// characters to a single space.
 651 static MemoryBuffer *CanonicalizeInputFile(MemoryBuffer *MB,
 652                                            bool PreserveHorizontal) {
 653   SmallString<128> NewFile;
 654   NewFile.reserve(MB->getBufferSize());
 655
 656   for (const char *Ptr = MB->getBufferStart(), *End = MB->getBufferEnd();
 657        Ptr != End; ++Ptr) {
 658     // Eliminate trailing dosish \r.
 659     if (Ptr <= End - 2 && Ptr[0] == '\r' && Ptr[1] == '\n') {
 660       continue;
 661     }
 662
 663     // If current char is not a horizontal whitespace or if horizontal
 664     // whitespace canonicalization is disabled, dump it to output as is.
 665     if (PreserveHorizontal || (*Ptr != ' ' && *Ptr != '\t')) {
 666       NewFile.push_back(*Ptr);
 667       continue;
 668     }
 669
 670     // Otherwise, add one space and advance over neighboring space.
 671     NewFile.push_back(' ');
 672     while (Ptr+1 != End &&
 673            (Ptr[1] == ' ' || Ptr[1] == '\t'))
 674       ++Ptr;
 675   }
 676
 677   // Free the old buffer and return a new one.
 678   MemoryBuffer *MB2 =
 679     MemoryBuffer::getMemBufferCopy(NewFile.str(), MB->getBufferIdentifier());
 680
 681   delete MB;
 682   return MB2;
 683 }
 684
 685 static bool IsPartOfWord(char c) {
 686   return (isalnum(c) || c == '-' || c == '_');
 687 }
 688
 689 // Get the size of the prefix extension.
 690 static size_t CheckTypeSize(Check::CheckType Ty) {
 691   switch (Ty) {
 692   case Check::CheckNone:
 693     return 0;
 694
 695   case Check::CheckPlain:
 696     return sizeof(":") - 1;
 697
 698   case Check::CheckNext:
 699     return sizeof("-NEXT:") - 1;
 700
 701   case Check::CheckNot:
 702     return sizeof("-NOT:") - 1;
 703
 704   case Check::CheckDAG:
 705     return sizeof("-DAG:") - 1;
 706
 707   case Check::CheckLabel:
 708     return sizeof("-LABEL:") - 1;
 709
 710   case Check::CheckEOF:
 711     llvm_unreachable("Should not be using EOF size");
 712   }
 713
 714   llvm_unreachable("Bad check type");
 715 }
 716
 717 static Check::CheckType FindCheckType(StringRef Buffer, StringRef Prefix) {
 718   char NextChar = Buffer[Prefix.size()];
 719
 720   // Verify that the : is present after the prefix.
 721   if (NextChar == ':')
 722     return Check::CheckPlain;
 723
 724   if (NextChar != '-')
 725     return Check::CheckNone;
 726
 727   StringRef Rest = Buffer.drop_front(Prefix.size() + 1);
 728   if (Rest.startswith("NEXT:"))
 729     return Check::CheckNext;
 730
 731   if (Rest.startswith("NOT:"))
 732     return Check::CheckNot;
 733
 734   if (Rest.startswith("DAG:"))
 735     return Check::CheckDAG;
 736
 737   if (Rest.startswith("LABEL:"))
 738     return Check::CheckLabel;
 739
 740   return Check::CheckNone;
 741 }
 742
 743 // From the given position, find the next character after the word.
 744 static size_t SkipWord(StringRef Str, size_t Loc) {
 745   while (Loc < Str.size() && IsPartOfWord(Str[Loc]))
 746     ++Loc;
 747   return Loc;
 748 }
 749
 750 // Try to find the first match in buffer for any prefix. If a valid match is
 751 // found, return that prefix and set its type and location.  If there are almost
 752 // matches (e.g. the actual prefix string is found, but is not an actual check
 753 // string), but no valid match, return an empty string and set the position to
 754 // resume searching from. If no partial matches are found, return an empty
 755 // string and the location will be StringRef::npos. If one prefix is a substring
 756 // of another, the maximal match should be found. e.g. if "A" and "AA" are
 757 // prefixes then AA-CHECK: should match the second one.
 758 static StringRef FindFirstCandidateMatch(StringRef &Buffer,
 759                                          Check::CheckType &CheckTy,
 760                                          size_t &CheckLoc) {
 761   StringRef FirstPrefix;
 762   size_t FirstLoc = StringRef::npos;
 763   size_t SearchLoc = StringRef::npos;
 764   Check::CheckType FirstTy = Check::CheckNone;
 765
 766   CheckTy = Check::CheckNone;
 767   CheckLoc = StringRef::npos;
 768
 769   for (prefix_iterator I = CheckPrefixes.begin(), E = CheckPrefixes.end();
 770        I != E; ++I) {
 771     StringRef Prefix(*I);
 772     size_t PrefixLoc = Buffer.find(Prefix);
 773
 774     if (PrefixLoc == StringRef::npos)
 775       continue;
 776
 777     // Track where we are searching for invalid prefixes that look almost right.
 778     // We need to only advance to the first partial match on the next attempt
 779     // since a partial match could be a substring of a later, valid prefix.
 780     // Need to skip to the end of the word, otherwise we could end up
 781     // matching a prefix in a substring later.
 782     if (PrefixLoc < SearchLoc)
 783       SearchLoc = SkipWord(Buffer, PrefixLoc);
 784
 785     // We only want to find the first match to avoid skipping some.
 786     if (PrefixLoc > FirstLoc)
 787       continue;
 788     // If one matching check-prefix is a prefix of another, choose the
 789     // longer one.
 790     if (PrefixLoc == FirstLoc && Prefix.size() < FirstPrefix.size())
 791       continue;
 792
 793     StringRef Rest = Buffer.drop_front(PrefixLoc);
 794     // Make sure we have actually found the prefix, and not a word containing
 795     // it. This should also prevent matching the wrong prefix when one is a
 796     // substring of another.
 797     if (PrefixLoc != 0 && IsPartOfWord(Buffer[PrefixLoc - 1]))
 798       continue;
 799
 800     FirstLoc = PrefixLoc;
 801     FirstTy = FindCheckType(Rest, Prefix);
 802     FirstPrefix = Prefix;
 803   }
 804
 805   // If the first prefix is invalid, we should continue the search after it.
 806   if (FirstTy == Check::CheckNone) {
 807     CheckLoc = SearchLoc;
 808     return "";
 809   }
 810
 811   CheckTy = FirstTy;
 812   CheckLoc = FirstLoc;
 813   return FirstPrefix;
 814 }
 815
 816 static StringRef FindFirstMatchingPrefix(StringRef &Buffer,
 817                                          unsigned &LineNumber,
 818                                          Check::CheckType &CheckTy,
 819                                          size_t &CheckLoc) {
 820   while (!Buffer.empty()) {
 821     StringRef Prefix = FindFirstCandidateMatch(Buffer, CheckTy, CheckLoc);
 822     // If we found a real match, we are done.
 823     if (!Prefix.empty()) {
 824       LineNumber += Buffer.substr(0, CheckLoc).count('\n');
 825       return Prefix;
 826     }
 827
 828     // We didn't find any almost matches either, we are also done.
 829     if (CheckLoc == StringRef::npos)
 830       return StringRef();
 831
 832     LineNumber += Buffer.substr(0, CheckLoc + 1).count('\n');
 833
 834     // Advance to the last possible match we found and try again.
 835     Buffer = Buffer.drop_front(CheckLoc + 1);
 836   }
 837
 838   return StringRef();
 839 }
 840
 841 /// ReadCheckFile - Read the check file, which specifies the sequence of
 842 /// expected strings.  The strings are added to the CheckStrings vector.
 843 /// Returns true in case of an error, false otherwise.
 844 static bool ReadCheckFile(SourceMgr &SM,
 845                           std::vector<CheckString> &CheckStrings) {
 846   OwningPtr<MemoryBuffer> File;
 847   if (error_code ec =
 848         MemoryBuffer::getFileOrSTDIN(CheckFilename, File)) {
 849     errs() << "Could not open check file '" << CheckFilename << "': "
 850            << ec.message() << '\n';
 851     return true;
 852   }
 853
 854   // If we want to canonicalize whitespace, strip excess whitespace from the
 855   // buffer containing the CHECK lines. Remove DOS style line endings.
 856   MemoryBuffer *F =
 857     CanonicalizeInputFile(File.take(), NoCanonicalizeWhiteSpace);
 858
 859   SM.AddNewSourceBuffer(F, SMLoc());
 860
 861   // Find all instances of CheckPrefix followed by : in the file.
 862   StringRef Buffer = F->getBuffer();
 863   std::vector<Pattern> DagNotMatches;
 864
 865   // LineNumber keeps track of the line on which CheckPrefix instances are
 866   // found.
 867   unsigned LineNumber = 1;
 868
 869   while (1) {
 870     Check::CheckType CheckTy;
 871     size_t PrefixLoc;
 872
 873     // See if a prefix occurs in the memory buffer.
 874     StringRef UsedPrefix = FindFirstMatchingPrefix(Buffer,
 875                                                    LineNumber,
 876                                                    CheckTy,
 877                                                    PrefixLoc);
 878     if (UsedPrefix.empty())
 879       break;
 880
 881     Buffer = Buffer.drop_front(PrefixLoc);
 882
 883     // Location to use for error messages.
 884     const char *UsedPrefixStart = Buffer.data() + (PrefixLoc == 0 ? 0 : 1);
 885
 886     // PrefixLoc is to the start of the prefix. Skip to the end.
 887     Buffer = Buffer.drop_front(UsedPrefix.size() + CheckTypeSize(CheckTy));
 888
 889     // Okay, we found the prefix, yay. Remember the rest of the line, but ignore
 890     // leading and trailing whitespace.
 891     Buffer = Buffer.substr(Buffer.find_first_not_of(" \t"));
 892
 893     // Scan ahead to the end of line.
 894     size_t EOL = Buffer.find_first_of("\n\r");
 895
 896     // Remember the location of the start of the pattern, for diagnostics.
 897     SMLoc PatternLoc = SMLoc::getFromPointer(Buffer.data());
 898
 899     // Parse the pattern.
 900     Pattern P(CheckTy);
 901     if (P.ParsePattern(Buffer.substr(0, EOL), UsedPrefix, SM, LineNumber))
 902       return true;
 903
 904     // Verify that CHECK-LABEL lines do not define or use variables
 905     if ((CheckTy == Check::CheckLabel) && P.hasVariable()) {
 906       SM.PrintMessage(SMLoc::getFromPointer(UsedPrefixStart),
 907                       SourceMgr::DK_Error,
 908                       "found '" + UsedPrefix + "-LABEL:'"
 909                       " with variable definition or use");
 910       return true;
 911     }
 912
 913     Buffer = Buffer.substr(EOL);
 914
 915     // Verify that CHECK-NEXT lines have at least one CHECK line before them.
 916     if ((CheckTy == Check::CheckNext) && CheckStrings.empty()) {
 917       SM.PrintMessage(SMLoc::getFromPointer(UsedPrefixStart),
 918                       SourceMgr::DK_Error,
 919                       "found '" + UsedPrefix + "-NEXT:' without previous '"
 920                       + UsedPrefix + ": line");
 921       return true;
 922     }
 923
 924     // Handle CHECK-DAG/-NOT.
 925     if (CheckTy == Check::CheckDAG || CheckTy == Check::CheckNot) {
 926       DagNotMatches.push_back(P);
 927       continue;
 928     }
 929
 930     // Okay, add the string we captured to the output vector and move on.
 931     CheckStrings.push_back(CheckString(P,
 932                                        UsedPrefix,
 933                                        PatternLoc,
 934                                        CheckTy));
 935     std::swap(DagNotMatches, CheckStrings.back().DagNotStrings);
 936   }
 937
 938   // Add an EOF pattern for any trailing CHECK-DAG/-NOTs, and use the first
 939   // prefix as a filler for the error message.
 940   if (!DagNotMatches.empty()) {
 941     CheckStrings.push_back(CheckString(Pattern(Check::CheckEOF),
 942                                        CheckPrefixes[0],
 943                                        SMLoc::getFromPointer(Buffer.data()),
 944                                        Check::CheckEOF));
 945     std::swap(DagNotMatches, CheckStrings.back().DagNotStrings);
 946   }
 947
 948   if (CheckStrings.empty()) {
 949     errs() << "error: no check strings found with prefix"
 950            << (CheckPrefixes.size() > 1 ? "es " : " ");
 951     for (size_t I = 0, N = CheckPrefixes.size(); I != N; ++I) {
 952       StringRef Prefix(CheckPrefixes[I]);
 953       errs() << '\'' << Prefix << ":'";
 954       if (I != N - 1)
 955         errs() << ", ";
 956     }
 957
 958     errs() << '\n';
 959     return true;
 960   }
 961
 962   return false;
 963 }
 964
 965 static void PrintCheckFailed(const SourceMgr &SM, const SMLoc &Loc,
 966                              const Pattern &Pat, StringRef Buffer,
 967                              StringMap<StringRef> &VariableTable) {
 968   // Otherwise, we have an error, emit an error message.
 969   SM.PrintMessage(Loc, SourceMgr::DK_Error,
 970                   "expected string not found in input");
 971
 972   // Print the "scanning from here" line.  If the current position is at the
 973   // end of a line, advance to the start of the next line.
 974   Buffer = Buffer.substr(Buffer.find_first_not_of(" \t\n\r"));
 975
 976   SM.PrintMessage(SMLoc::getFromPointer(Buffer.data()), SourceMgr::DK_Note,
 977                   "scanning from here");
 978
 979   // Allow the pattern to print additional information if desired.
 980   Pat.PrintFailureInfo(SM, Buffer, VariableTable);
 981 }
 982
 983 static void PrintCheckFailed(const SourceMgr &SM, const CheckString &CheckStr,
 984                              StringRef Buffer,
 985                              StringMap<StringRef> &VariableTable) {
 986   PrintCheckFailed(SM, CheckStr.Loc, CheckStr.Pat, Buffer, VariableTable);
 987 }
 988
 989 /// CountNumNewlinesBetween - Count the number of newlines in the specified
 990 /// range.
 991 static unsigned CountNumNewlinesBetween(StringRef Range) {
 992   unsigned NumNewLines = 0;
 993   while (1) {
 994     // Scan for newline.
 995     Range = Range.substr(Range.find_first_of("\n\r"));
 996     if (Range.empty()) return NumNewLines;
 997
 998     ++NumNewLines;
 999
1000     // Handle \n\r and \r\n as a single newline.
1001     if (Range.size() > 1 &&
1002         (Range[1] == '\n' || Range[1] == '\r') &&
1003         (Range[0] != Range[1]))
1004       Range = Range.substr(1);
1005     Range = Range.substr(1);
1006   }
1007 }
1008
1009 size_t CheckString::Check(const SourceMgr &SM, StringRef Buffer,
1010                           bool IsLabelScanMode, size_t &MatchLen,
1011                           StringMap<StringRef> &VariableTable) const {
1012   size_t LastPos = 0;
1013   std::vector<const Pattern *> NotStrings;
1014
1015   // IsLabelScanMode is true when we are scanning forward to find CHECK-LABEL
1016   // bounds; we have not processed variable definitions within the bounded block
1017   // yet so cannot handle any final CHECK-DAG yet; this is handled when going
1018   // over the block again (including the last CHECK-LABEL) in normal mode.
1019   if (!IsLabelScanMode) {
1020     // Match "dag strings" (with mixed "not strings" if any).
1021     LastPos = CheckDag(SM, Buffer, NotStrings, VariableTable);
1022     if (LastPos == StringRef::npos)
1023       return StringRef::npos;
1024   }
1025
1026   // Match itself from the last position after matching CHECK-DAG.
1027   StringRef MatchBuffer = Buffer.substr(LastPos);
1028   size_t MatchPos = Pat.Match(MatchBuffer, MatchLen, VariableTable);
1029   if (MatchPos == StringRef::npos) {
1030     PrintCheckFailed(SM, *this, MatchBuffer, VariableTable);
1031     return StringRef::npos;
1032   }
1033   MatchPos += LastPos;
1034
1035   // Similar to the above, in "label-scan mode" we can't yet handle CHECK-NEXT
1036   // or CHECK-NOT
1037   if (!IsLabelScanMode) {
1038     StringRef SkippedRegion = Buffer.substr(LastPos, MatchPos);
1039
1040     // If this check is a "CHECK-NEXT", verify that the previous match was on
1041     // the previous line (i.e. that there is one newline between them).
1042     if (CheckNext(SM, SkippedRegion))
1043       return StringRef::npos;
1044
1045     // If this match had "not strings", verify that they don't exist in the
1046     // skipped region.
1047     if (CheckNot(SM, SkippedRegion, NotStrings, VariableTable))
1048       return StringRef::npos;
1049   }
1050
1051   return MatchPos;
1052 }
1053
1054 bool CheckString::CheckNext(const SourceMgr &SM, StringRef Buffer) const {
1055   if (CheckTy != Check::CheckNext)
1056     return false;
1057
1058   // Count the number of newlines between the previous match and this one.
1059   assert(Buffer.data() !=
1060          SM.getMemoryBuffer(
1061            SM.FindBufferContainingLoc(
1062              SMLoc::getFromPointer(Buffer.data())))->getBufferStart() &&
1063          "CHECK-NEXT can't be the first check in a file");
1064
1065   unsigned NumNewLines = CountNumNewlinesBetween(Buffer);
1066
1067   if (NumNewLines == 0) {
1068     SM.PrintMessage(Loc, SourceMgr::DK_Error, Prefix +
1069                     "-NEXT: is on the same line as previous match");
1070     SM.PrintMessage(SMLoc::getFromPointer(Buffer.end()),
1071                     SourceMgr::DK_Note, "'next' match was here");
1072     SM.PrintMessage(SMLoc::getFromPointer(Buffer.data()), SourceMgr::DK_Note,
1073                     "previous match ended here");
1074     return true;
1075   }
1076
1077   if (NumNewLines != 1) {
1078     SM.PrintMessage(Loc, SourceMgr::DK_Error, Prefix +
1079                     "-NEXT: is not on the line after the previous match");
1080     SM.PrintMessage(SMLoc::getFromPointer(Buffer.end()),
1081                     SourceMgr::DK_Note, "'next' match was here");
1082     SM.PrintMessage(SMLoc::getFromPointer(Buffer.data()), SourceMgr::DK_Note,
1083                     "previous match ended here");
1084     return true;
1085   }
1086
1087   return false;
1088 }
1089
1090 bool CheckString::CheckNot(const SourceMgr &SM, StringRef Buffer,
1091                            const std::vector<const Pattern *> &NotStrings,
1092                            StringMap<StringRef> &VariableTable) const {
1093   for (unsigned ChunkNo = 0, e = NotStrings.size();
1094        ChunkNo != e; ++ChunkNo) {
1095     const Pattern *Pat = NotStrings[ChunkNo];
1096     assert((Pat->getCheckTy() == Check::CheckNot) && "Expect CHECK-NOT!");
1097
1098     size_t MatchLen = 0;
1099     size_t Pos = Pat->Match(Buffer, MatchLen, VariableTable);
1100
1101     if (Pos == StringRef::npos) continue;
1102
1103     SM.PrintMessage(SMLoc::getFromPointer(Buffer.data()+Pos),
1104                     SourceMgr::DK_Error,
1105                     Prefix + "-NOT: string occurred!");
1106     SM.PrintMessage(Pat->getLoc(), SourceMgr::DK_Note,
1107                     Prefix + "-NOT: pattern specified here");
1108     return true;
1109   }
1110
1111   return false;
1112 }
1113
1114 size_t CheckString::CheckDag(const SourceMgr &SM, StringRef Buffer,
1115                              std::vector<const Pattern *> &NotStrings,
1116                              StringMap<StringRef> &VariableTable) const {
1117   if (DagNotStrings.empty())
1118     return 0;
1119
1120   size_t LastPos = 0;
1121   size_t StartPos = LastPos;
1122
1123   for (unsigned ChunkNo = 0, e = DagNotStrings.size();
1124        ChunkNo != e; ++ChunkNo) {
1125     const Pattern &Pat = DagNotStrings[ChunkNo];
1126
1127     assert((Pat.getCheckTy() == Check::CheckDAG ||
1128             Pat.getCheckTy() == Check::CheckNot) &&
1129            "Invalid CHECK-DAG or CHECK-NOT!");
1130
1131     if (Pat.getCheckTy() == Check::CheckNot) {
1132       NotStrings.push_back(&Pat);
1133       continue;
1134     }
1135
1136     assert((Pat.getCheckTy() == Check::CheckDAG) && "Expect CHECK-DAG!");
1137
1138     size_t MatchLen = 0, MatchPos;
1139
1140     // CHECK-DAG always matches from the start.
1141     StringRef MatchBuffer = Buffer.substr(StartPos);
1142     MatchPos = Pat.Match(MatchBuffer, MatchLen, VariableTable);
1143     // With a group of CHECK-DAGs, a single mismatching means the match on
1144     // that group of CHECK-DAGs fails immediately.
1145     if (MatchPos == StringRef::npos) {
1146       PrintCheckFailed(SM, Pat.getLoc(), Pat, MatchBuffer, VariableTable);
1147       return StringRef::npos;
1148     }
1149     // Re-calc it as the offset relative to the start of the original string.
1150     MatchPos += StartPos;
1151
1152     if (!NotStrings.empty()) {
1153       if (MatchPos < LastPos) {
1154         // Reordered?
1155         SM.PrintMessage(SMLoc::getFromPointer(Buffer.data() + MatchPos),
1156                         SourceMgr::DK_Error,
1157                         Prefix + "-DAG: found a match of CHECK-DAG"
1158                         " reordering across a CHECK-NOT");
1159         SM.PrintMessage(SMLoc::getFromPointer(Buffer.data() + LastPos),
1160                         SourceMgr::DK_Note,
1161                         Prefix + "-DAG: the farthest match of CHECK-DAG"
1162                         " is found here");
1163         SM.PrintMessage(NotStrings[0]->getLoc(), SourceMgr::DK_Note,
1164                         Prefix + "-NOT: the crossed pattern specified"
1165                         " here");
1166         SM.PrintMessage(Pat.getLoc(), SourceMgr::DK_Note,
1167                         Prefix + "-DAG: the reordered pattern specified"
1168                         " here");
1169         return StringRef::npos;
1170       }
1171       // All subsequent CHECK-DAGs should be matched from the farthest
1172       // position of all precedent CHECK-DAGs (including this one.)
1173       StartPos = LastPos;
1174       // If there's CHECK-NOTs between two CHECK-DAGs or from CHECK to
1175       // CHECK-DAG, verify that there's no 'not' strings occurred in that
1176       // region.
1177       StringRef SkippedRegion = Buffer.substr(LastPos, MatchPos);
1178       if (CheckNot(SM, SkippedRegion, NotStrings, VariableTable))
1179         return StringRef::npos;
1180       // Clear "not strings".
1181       NotStrings.clear();
1182     }
1183
1184     // Update the last position with CHECK-DAG matches.
1185     LastPos = std::max(MatchPos + MatchLen, LastPos);
1186   }
1187
1188   return LastPos;
1189 }
1190
1191 // A check prefix must contain only alphanumeric, hyphens and underscores.
1192 static bool ValidateCheckPrefix(StringRef CheckPrefix) {
1193   Regex Validator("^[a-zA-Z0-9_-]*$");
1194   return Validator.match(CheckPrefix);
1195 }
1196
1197 static bool ValidateCheckPrefixes() {
1198   StringSet<> PrefixSet;
1199
1200   for (prefix_iterator I = CheckPrefixes.begin(), E = CheckPrefixes.end();
1201        I != E; ++I) {
1202     StringRef Prefix(*I);
1203
1204     if (!PrefixSet.insert(Prefix))
1205       return false;
1206
1207     if (!ValidateCheckPrefix(Prefix))
1208       return false;
1209   }
1210
1211   return true;
1212 }
1213
1214 // I don't think there's a way to specify an initial value for cl::list,
1215 // so if nothing was specified, add the default
1216 static void AddCheckPrefixIfNeeded() {
1217   if (CheckPrefixes.empty())
1218     CheckPrefixes.push_back("CHECK");
1219 }
1220
1221 int main(int argc, char **argv) {
1222   sys::PrintStackTraceOnErrorSignal();
1223   PrettyStackTraceProgram X(argc, argv);
1224   cl::ParseCommandLineOptions(argc, argv);
1225
1226   if (!ValidateCheckPrefixes()) {
1227     errs() << "Supplied check-prefix is invalid! Prefixes must be unique and "
1228               "start with a letter and contain only alphanumeric characters, "
1229               "hyphens and underscores\n";
1230     return 2;
1231   }
1232
1233   AddCheckPrefixIfNeeded();
1234
1235   SourceMgr SM;
1236
1237   // Read the expected strings from the check file.
1238   std::vector<CheckString> CheckStrings;
1239   if (ReadCheckFile(SM, CheckStrings))
1240     return 2;
1241
1242   // Open the file to check and add it to SourceMgr.
1243   OwningPtr<MemoryBuffer> File;
1244   if (error_code ec =
1245         MemoryBuffer::getFileOrSTDIN(InputFilename, File)) {
1246     errs() << "Could not open input file '" << InputFilename << "': "
1247            << ec.message() << '\n';
1248     return 2;
1249   }
1250
1251   if (File->getBufferSize() == 0) {
1252     errs() << "FileCheck error: '" << InputFilename << "' is empty.\n";
1253     return 2;
1254   }
1255
1256   // Remove duplicate spaces in the input file if requested.
1257   // Remove DOS style line endings.
1258   MemoryBuffer *F =
1259     CanonicalizeInputFile(File.take(), NoCanonicalizeWhiteSpace);
1260
1261   SM.AddNewSourceBuffer(F, SMLoc());
1262
1263   /// VariableTable - This holds all the current filecheck variables.
1264   StringMap<StringRef> VariableTable;
1265
1266   // Check that we have all of the expected strings, in order, in the input
1267   // file.
1268   StringRef Buffer = F->getBuffer();
1269
1270   bool hasError = false;
1271
1272   unsigned i = 0, j = 0, e = CheckStrings.size();
1273
1274   while (true) {
1275     StringRef CheckRegion;
1276     if (j == e) {
1277       CheckRegion = Buffer;
1278     } else {
1279       const CheckString &CheckLabelStr = CheckStrings[j];
1280       if (CheckLabelStr.CheckTy != Check::CheckLabel) {
1281         ++j;
1282         continue;
1283       }
1284
1285       // Scan to next CHECK-LABEL match, ignoring CHECK-NOT and CHECK-DAG
1286       size_t MatchLabelLen = 0;
1287       size_t MatchLabelPos = CheckLabelStr.Check(SM, Buffer, true,
1288                                                  MatchLabelLen, VariableTable);
1289       if (MatchLabelPos == StringRef::npos) {
1290         hasError = true;
1291         break;
1292       }
1293
1294       CheckRegion = Buffer.substr(0, MatchLabelPos + MatchLabelLen);
1295       Buffer = Buffer.substr(MatchLabelPos + MatchLabelLen);
1296       ++j;
1297     }
1298
1299     for ( ; i != j; ++i) {
1300       const CheckString &CheckStr = CheckStrings[i];
1301
1302       // Check each string within the scanned region, including a second check
1303       // of any final CHECK-LABEL (to verify CHECK-NOT and CHECK-DAG)
1304       size_t MatchLen = 0;
1305       size_t MatchPos = CheckStr.Check(SM, CheckRegion, false, MatchLen,
1306                                        VariableTable);
1307
1308       if (MatchPos == StringRef::npos) {
1309         hasError = true;
1310         i = j;
1311         break;
1312       }
1313
1314       CheckRegion = CheckRegion.substr(MatchPos + MatchLen);
1315     }
1316
1317     if (j == e)
1318       break;
1319   }
1320
1321   return hasError ? 1 : 0;
1322 }