1 //===- VerifyDiagnosticConsumer.cpp - Verifying Diagnostic Client ---------===//
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
7 //===----------------------------------------------------------------------===//
9 // This is a concrete diagnostic client, which buffers the diagnostic messages.
11 //===----------------------------------------------------------------------===//
13 #include "clang/Frontend/VerifyDiagnosticConsumer.h"
14 #include "clang/Basic/CharInfo.h"
15 #include "clang/Basic/Diagnostic.h"
16 #include "clang/Basic/DiagnosticOptions.h"
17 #include "clang/Basic/FileManager.h"
18 #include "clang/Basic/LLVM.h"
19 #include "clang/Basic/SourceLocation.h"
20 #include "clang/Basic/SourceManager.h"
21 #include "clang/Basic/TokenKinds.h"
22 #include "clang/Frontend/FrontendDiagnostic.h"
23 #include "clang/Frontend/TextDiagnosticBuffer.h"
24 #include "clang/Lex/HeaderSearch.h"
25 #include "clang/Lex/Lexer.h"
26 #include "clang/Lex/PPCallbacks.h"
27 #include "clang/Lex/Preprocessor.h"
28 #include "clang/Lex/Token.h"
29 #include "llvm/ADT/STLExtras.h"
30 #include "llvm/ADT/SmallPtrSet.h"
31 #include "llvm/ADT/SmallString.h"
32 #include "llvm/ADT/StringRef.h"
33 #include "llvm/ADT/Twine.h"
34 #include "llvm/Support/ErrorHandling.h"
35 #include "llvm/Support/Regex.h"
36 #include "llvm/Support/raw_ostream.h"
47 using namespace clang;
49 using Directive = VerifyDiagnosticConsumer::Directive;
50 using DirectiveList = VerifyDiagnosticConsumer::DirectiveList;
51 using ExpectedData = VerifyDiagnosticConsumer::ExpectedData;
57 class VerifyFileTracker : public PPCallbacks {
58 VerifyDiagnosticConsumer &Verify;
62 VerifyFileTracker(VerifyDiagnosticConsumer &Verify, SourceManager &SM)
63 : Verify(Verify), SM(SM) {}
65 /// Hook into the preprocessor and update the list of parsed
66 /// files when the preprocessor indicates a new file is entered.
67 void FileChanged(SourceLocation Loc, FileChangeReason Reason,
68 SrcMgr::CharacteristicKind FileType,
69 FileID PrevFID) override {
70 Verify.UpdateParsedFileStatus(SM, SM.getFileID(Loc),
71 VerifyDiagnosticConsumer::IsParsed);
79 //===----------------------------------------------------------------------===//
80 // Checking diagnostics implementation.
81 //===----------------------------------------------------------------------===//
83 using DiagList = TextDiagnosticBuffer::DiagList;
84 using const_diag_iterator = TextDiagnosticBuffer::const_iterator;
88 /// StandardDirective - Directive with string matching.
89 class StandardDirective : public Directive {
91 StandardDirective(SourceLocation DirectiveLoc, SourceLocation DiagnosticLoc,
92 bool MatchAnyLine, StringRef Text, unsigned Min,
94 : Directive(DirectiveLoc, DiagnosticLoc, MatchAnyLine, Text, Min, Max) {}
96 bool isValid(std::string &Error) override {
97 // all strings are considered valid; even empty ones
101 bool match(StringRef S) override {
102 return S.find(Text) != StringRef::npos;
106 /// RegexDirective - Directive with regular-expression matching.
107 class RegexDirective : public Directive {
109 RegexDirective(SourceLocation DirectiveLoc, SourceLocation DiagnosticLoc,
110 bool MatchAnyLine, StringRef Text, unsigned Min, unsigned Max,
112 : Directive(DirectiveLoc, DiagnosticLoc, MatchAnyLine, Text, Min, Max),
115 bool isValid(std::string &Error) override {
116 return Regex.isValid(Error);
119 bool match(StringRef S) override {
120 return Regex.match(S);
130 ParseHelper(StringRef S)
131 : Begin(S.begin()), End(S.end()), C(Begin), P(Begin) {}
133 // Return true if string literal is next.
134 bool Next(StringRef S) {
139 return memcmp(P, S.data(), S.size()) == 0;
142 // Return true if number is next.
143 // Output N only if number is next.
144 bool Next(unsigned &N) {
148 for (; PEnd < End && *PEnd >= '0' && *PEnd <= '9'; ++PEnd) {
158 // Return true if a marker is next.
159 // A marker is the longest match for /#[A-Za-z0-9_-]+/.
162 if (P == End || *P != '#')
166 while ((isAlphanumeric(*PEnd) || *PEnd == '-' || *PEnd == '_') &&
172 // Return true if string literal S is matched in content.
173 // When true, P marks begin-position of the match, and calling Advance sets C
174 // to end-position of the match.
175 // If S is the empty string, then search for any letter instead (makes sense
176 // with FinishDirectiveToken=true).
177 // If EnsureStartOfWord, then skip matches that don't start a new word.
178 // If FinishDirectiveToken, then assume the match is the start of a comment
179 // directive for -verify, and extend the match to include the entire first
180 // token of that directive.
181 bool Search(StringRef S, bool EnsureStartOfWord = false,
182 bool FinishDirectiveToken = false) {
185 P = std::search(C, End, S.begin(), S.end());
190 while (P != End && !isLetter(*P))
196 // If not start of word but required, skip and search again.
197 if (EnsureStartOfWord
198 // Check if string literal starts a new word.
199 && !(P == Begin || isWhitespace(P[-1])
200 // Or it could be preceded by the start of a comment.
201 || (P > (Begin + 1) && (P[-1] == '/' || P[-1] == '*')
204 if (FinishDirectiveToken) {
205 while (PEnd != End && (isAlphanumeric(*PEnd)
206 || *PEnd == '-' || *PEnd == '_'))
208 // Put back trailing digits and hyphens to be parsed later as a count
209 // or count range. Because -verify prefixes must start with letters,
210 // we know the actual directive we found starts with a letter, so
211 // we won't put back the entire directive word and thus record an empty
213 assert(isLetter(*P) && "-verify prefix must start with a letter");
214 while (isDigit(PEnd[-1]) || PEnd[-1] == '-')
222 // Return true if a CloseBrace that closes the OpenBrace at the current nest
223 // level is found. When true, P marks begin-position of CloseBrace.
224 bool SearchClosingBrace(StringRef OpenBrace, StringRef CloseBrace) {
228 StringRef S(P, End - P);
229 if (S.startswith(OpenBrace)) {
231 P += OpenBrace.size();
232 } else if (S.startswith(CloseBrace)) {
235 PEnd = P + CloseBrace.size();
238 P += CloseBrace.size();
246 // Advance 1-past previous next/search.
247 // Behavior is undefined if previous next/search failed.
253 // Return the text matched by the previous next/search.
254 // Behavior is undefined if previous next/search failed.
255 StringRef Match() { return StringRef(P, PEnd - P); }
257 // Skip zero or more whitespace.
258 void SkipWhitespace() {
259 for (; C < End && isWhitespace(*C); ++C)
263 // Return true if EOF reached.
268 // Beginning of expected content.
269 const char * const Begin;
271 // End of expected content (1-past).
272 const char * const End;
274 // Position of next char in content.
277 // Previous next/search subject start.
281 // Previous next/search subject end (1-past).
282 const char *PEnd = nullptr;
285 // The information necessary to create a directive.
286 struct UnattachedDirective {
287 DirectiveList *DL = nullptr;
288 bool RegexKind = false;
289 SourceLocation DirectivePos, ContentBegin;
291 unsigned Min = 1, Max = 1;
294 // Attach the specified directive to the line of code indicated by
296 void attachDirective(DiagnosticsEngine &Diags, const UnattachedDirective &UD,
297 SourceLocation ExpectedLoc, bool MatchAnyLine = false) {
298 // Construct new directive.
299 std::unique_ptr<Directive> D =
300 Directive::create(UD.RegexKind, UD.DirectivePos, ExpectedLoc,
301 MatchAnyLine, UD.Text, UD.Min, UD.Max);
304 if (!D->isValid(Error)) {
305 Diags.Report(UD.ContentBegin, diag::err_verify_invalid_content)
306 << (UD.RegexKind ? "regex" : "string") << Error;
309 UD.DL->push_back(std::move(D));
314 // Tracker for markers in the input files. A marker is a comment of the form
318 // ... that can be referred to by a later expected-* directive:
320 // // expected-error@#123 {{undeclared identifier 'n'}}
322 // Marker declarations must be at the start of a comment or preceded by
323 // whitespace to distinguish them from uses of markers in directives.
324 class VerifyDiagnosticConsumer::MarkerTracker {
325 DiagnosticsEngine &Diags;
328 SourceLocation DefLoc;
329 SourceLocation RedefLoc;
330 SourceLocation UseLoc;
332 llvm::StringMap<Marker> Markers;
334 // Directives that couldn't be created yet because they name an unknown
336 llvm::StringMap<llvm::SmallVector<UnattachedDirective, 2>> DeferredDirectives;
339 MarkerTracker(DiagnosticsEngine &Diags) : Diags(Diags) {}
341 // Register a marker.
342 void addMarker(StringRef MarkerName, SourceLocation Pos) {
343 auto InsertResult = Markers.insert(
344 {MarkerName, Marker{Pos, SourceLocation(), SourceLocation()}});
346 Marker &M = InsertResult.first->second;
347 if (!InsertResult.second) {
348 // Marker was redefined.
351 // First definition: build any deferred directives.
352 auto Deferred = DeferredDirectives.find(MarkerName);
353 if (Deferred != DeferredDirectives.end()) {
354 for (auto &UD : Deferred->second) {
355 if (M.UseLoc.isInvalid())
356 M.UseLoc = UD.DirectivePos;
357 attachDirective(Diags, UD, Pos);
359 DeferredDirectives.erase(Deferred);
364 // Register a directive at the specified marker.
365 void addDirective(StringRef MarkerName, const UnattachedDirective &UD) {
366 auto MarkerIt = Markers.find(MarkerName);
367 if (MarkerIt != Markers.end()) {
368 Marker &M = MarkerIt->second;
369 if (M.UseLoc.isInvalid())
370 M.UseLoc = UD.DirectivePos;
371 return attachDirective(Diags, UD, M.DefLoc);
373 DeferredDirectives[MarkerName].push_back(UD);
376 // Ensure we have no remaining deferred directives, and no
377 // multiply-defined-and-used markers.
379 for (auto &MarkerInfo : Markers) {
380 StringRef Name = MarkerInfo.first();
381 Marker &M = MarkerInfo.second;
382 if (M.RedefLoc.isValid() && M.UseLoc.isValid()) {
383 Diags.Report(M.UseLoc, diag::err_verify_ambiguous_marker) << Name;
384 Diags.Report(M.DefLoc, diag::note_verify_ambiguous_marker) << Name;
385 Diags.Report(M.RedefLoc, diag::note_verify_ambiguous_marker) << Name;
389 for (auto &DeferredPair : DeferredDirectives) {
390 Diags.Report(DeferredPair.second.front().DirectivePos,
391 diag::err_verify_no_such_marker)
392 << DeferredPair.first();
397 /// ParseDirective - Go through the comment and see if it indicates expected
398 /// diagnostics. If so, then put them in the appropriate directive list.
400 /// Returns true if any valid directives were found.
401 static bool ParseDirective(StringRef S, ExpectedData *ED, SourceManager &SM,
402 Preprocessor *PP, SourceLocation Pos,
403 VerifyDiagnosticConsumer::DirectiveStatus &Status,
404 VerifyDiagnosticConsumer::MarkerTracker &Markers) {
405 DiagnosticsEngine &Diags = PP ? PP->getDiagnostics() : SM.getDiagnostics();
407 // First, scan the comment looking for markers.
408 for (ParseHelper PH(S); !PH.Done();) {
409 if (!PH.Search("#", true))
412 if (!PH.NextMarker()) {
418 Markers.addMarker(PH.Match(), Pos);
421 // A single comment may contain multiple directives.
422 bool FoundDirective = false;
423 for (ParseHelper PH(S); !PH.Done();) {
424 // Search for the initial directive token.
425 // If one prefix, save time by searching only for its directives.
426 // Otherwise, search for any potential directive token and check it later.
427 const auto &Prefixes = Diags.getDiagnosticOptions().VerifyPrefixes;
428 if (!(Prefixes.size() == 1 ? PH.Search(*Prefixes.begin(), true, true)
429 : PH.Search("", true, true)))
432 StringRef DToken = PH.Match();
435 // Default directive kind.
436 UnattachedDirective D;
437 const char *KindStr = "string";
439 // Parse the initial directive token in reverse so we can easily determine
440 // its exact actual prefix. If we were to parse it from the front instead,
441 // it would be harder to determine where the prefix ends because there
442 // might be multiple matching -verify prefixes because some might prefix
445 // Regex in initial directive token: -re
446 if (DToken.endswith("-re")) {
449 DToken = DToken.substr(0, DToken.size()-3);
452 // Type in initial directive token: -{error|warning|note|no-diagnostics}
455 if (DToken.endswith(DType="-error"))
456 D.DL = ED ? &ED->Errors : nullptr;
457 else if (DToken.endswith(DType="-warning"))
458 D.DL = ED ? &ED->Warnings : nullptr;
459 else if (DToken.endswith(DType="-remark"))
460 D.DL = ED ? &ED->Remarks : nullptr;
461 else if (DToken.endswith(DType="-note"))
462 D.DL = ED ? &ED->Notes : nullptr;
463 else if (DToken.endswith(DType="-no-diagnostics")) {
470 DToken = DToken.substr(0, DToken.size()-DType.size());
472 // What's left in DToken is the actual prefix. That might not be a -verify
473 // prefix even if there is only one -verify prefix (for example, the full
474 // DToken is foo-bar-warning, but foo is the only -verify prefix).
475 if (!std::binary_search(Prefixes.begin(), Prefixes.end(), DToken))
479 if (Status == VerifyDiagnosticConsumer::HasOtherExpectedDirectives)
480 Diags.Report(Pos, diag::err_verify_invalid_no_diags)
481 << /*IsExpectedNoDiagnostics=*/true;
483 Status = VerifyDiagnosticConsumer::HasExpectedNoDiagnostics;
486 if (Status == VerifyDiagnosticConsumer::HasExpectedNoDiagnostics) {
487 Diags.Report(Pos, diag::err_verify_invalid_no_diags)
488 << /*IsExpectedNoDiagnostics=*/false;
491 Status = VerifyDiagnosticConsumer::HasOtherExpectedDirectives;
493 // If a directive has been found but we're not interested
494 // in storing the directive information, return now.
498 // Next optional token: @
499 SourceLocation ExpectedLoc;
501 bool MatchAnyLine = false;
507 bool FoundPlus = PH.Next("+");
508 if (FoundPlus || PH.Next("-")) {
509 // Relative to current line.
511 bool Invalid = false;
512 unsigned ExpectedLine = SM.getSpellingLineNumber(Pos, &Invalid);
513 if (!Invalid && PH.Next(Line) && (FoundPlus || Line < ExpectedLine)) {
514 if (FoundPlus) ExpectedLine += Line;
515 else ExpectedLine -= Line;
516 ExpectedLoc = SM.translateLineCol(SM.getFileID(Pos), ExpectedLine, 1);
518 } else if (PH.Next(Line)) {
519 // Absolute line number.
521 ExpectedLoc = SM.translateLineCol(SM.getFileID(Pos), Line, 1);
522 } else if (PH.NextMarker()) {
524 } else if (PP && PH.Search(":")) {
525 // Specific source file.
526 StringRef Filename(PH.C, PH.P-PH.C);
529 // Lookup file via Preprocessor, like a #include.
530 const DirectoryLookup *CurDir;
531 const FileEntry *FE =
532 PP->LookupFile(Pos, Filename, false, nullptr, nullptr, CurDir,
533 nullptr, nullptr, nullptr, nullptr, nullptr);
535 Diags.Report(Pos.getLocWithOffset(PH.C-PH.Begin),
536 diag::err_verify_missing_file) << Filename << KindStr;
540 if (SM.translateFile(FE).isInvalid())
541 SM.createFileID(FE, Pos, SrcMgr::C_User);
543 if (PH.Next(Line) && Line > 0)
544 ExpectedLoc = SM.translateFileLineCol(FE, Line, 1);
545 else if (PH.Next("*")) {
547 ExpectedLoc = SM.translateFileLineCol(FE, 1, 1);
549 } else if (PH.Next("*")) {
551 ExpectedLoc = SourceLocation();
554 if (ExpectedLoc.isInvalid() && !MatchAnyLine && Marker.empty()) {
555 Diags.Report(Pos.getLocWithOffset(PH.C-PH.Begin),
556 diag::err_verify_missing_line) << KindStr;
562 // Skip optional whitespace.
565 // Next optional token: positive integer or a '+'.
566 if (PH.Next(D.Min)) {
568 // A positive integer can be followed by a '+' meaning min
569 // or more, or by a '-' meaning a range from min to max.
571 D.Max = Directive::MaxCount;
573 } else if (PH.Next("-")) {
575 if (!PH.Next(D.Max) || D.Max < D.Min) {
576 Diags.Report(Pos.getLocWithOffset(PH.C-PH.Begin),
577 diag::err_verify_invalid_range) << KindStr;
584 } else if (PH.Next("+")) {
585 // '+' on its own means "1 or more".
586 D.Max = Directive::MaxCount;
590 // Skip optional whitespace.
594 if (!PH.Next("{{")) {
595 Diags.Report(Pos.getLocWithOffset(PH.C-PH.Begin),
596 diag::err_verify_missing_start) << KindStr;
600 const char* const ContentBegin = PH.C; // mark content begin
601 // Search for token: }}
602 if (!PH.SearchClosingBrace("{{", "}}")) {
603 Diags.Report(Pos.getLocWithOffset(PH.C-PH.Begin),
604 diag::err_verify_missing_end) << KindStr;
607 const char* const ContentEnd = PH.P; // mark content end
610 D.DirectivePos = Pos;
611 D.ContentBegin = Pos.getLocWithOffset(ContentBegin - PH.Begin);
613 // Build directive text; convert \n to newlines.
614 StringRef NewlineStr = "\\n";
615 StringRef Content(ContentBegin, ContentEnd-ContentBegin);
618 while ((FPos = Content.find(NewlineStr, CPos)) != StringRef::npos) {
619 D.Text += Content.substr(CPos, FPos-CPos);
621 CPos = FPos + NewlineStr.size();
624 D.Text.assign(ContentBegin, ContentEnd);
626 // Check that regex directives contain at least one regex.
627 if (D.RegexKind && D.Text.find("{{") == StringRef::npos) {
628 Diags.Report(D.ContentBegin, diag::err_verify_missing_regex) << D.Text;
633 attachDirective(Diags, D, ExpectedLoc, MatchAnyLine);
635 Markers.addDirective(Marker, D);
636 FoundDirective = true;
639 return FoundDirective;
642 VerifyDiagnosticConsumer::VerifyDiagnosticConsumer(DiagnosticsEngine &Diags_)
643 : Diags(Diags_), PrimaryClient(Diags.getClient()),
644 PrimaryClientOwner(Diags.takeClient()),
645 Buffer(new TextDiagnosticBuffer()), Markers(new MarkerTracker(Diags)),
646 Status(HasNoDirectives) {
647 if (Diags.hasSourceManager())
648 setSourceManager(Diags.getSourceManager());
651 VerifyDiagnosticConsumer::~VerifyDiagnosticConsumer() {
652 assert(!ActiveSourceFiles && "Incomplete parsing of source files!");
653 assert(!CurrentPreprocessor && "CurrentPreprocessor should be invalid!");
654 SrcManager = nullptr;
656 assert(!Diags.ownsClient() &&
657 "The VerifyDiagnosticConsumer takes over ownership of the client!");
660 // DiagnosticConsumer interface.
662 void VerifyDiagnosticConsumer::BeginSourceFile(const LangOptions &LangOpts,
663 const Preprocessor *PP) {
664 // Attach comment handler on first invocation.
665 if (++ActiveSourceFiles == 1) {
667 CurrentPreprocessor = PP;
668 this->LangOpts = &LangOpts;
669 setSourceManager(PP->getSourceManager());
670 const_cast<Preprocessor *>(PP)->addCommentHandler(this);
672 // Debug build tracks parsed files.
673 const_cast<Preprocessor *>(PP)->addPPCallbacks(
674 llvm::make_unique<VerifyFileTracker>(*this, *SrcManager));
679 assert((!PP || CurrentPreprocessor == PP) && "Preprocessor changed!");
680 PrimaryClient->BeginSourceFile(LangOpts, PP);
683 void VerifyDiagnosticConsumer::EndSourceFile() {
684 assert(ActiveSourceFiles && "No active source files!");
685 PrimaryClient->EndSourceFile();
687 // Detach comment handler once last active source file completed.
688 if (--ActiveSourceFiles == 0) {
689 if (CurrentPreprocessor)
690 const_cast<Preprocessor *>(CurrentPreprocessor)->
691 removeCommentHandler(this);
693 // Diagnose any used-but-not-defined markers.
696 // Check diagnostics once last file completed.
698 CurrentPreprocessor = nullptr;
703 void VerifyDiagnosticConsumer::HandleDiagnostic(
704 DiagnosticsEngine::Level DiagLevel, const Diagnostic &Info) {
705 if (Info.hasSourceManager()) {
706 // If this diagnostic is for a different source manager, ignore it.
707 if (SrcManager && &Info.getSourceManager() != SrcManager)
710 setSourceManager(Info.getSourceManager());
714 // Debug build tracks unparsed files for possible
715 // unparsed expected-* directives.
717 SourceLocation Loc = Info.getLocation();
719 ParsedStatus PS = IsUnparsed;
721 Loc = SrcManager->getExpansionLoc(Loc);
722 FileID FID = SrcManager->getFileID(Loc);
724 const FileEntry *FE = SrcManager->getFileEntryForID(FID);
725 if (FE && CurrentPreprocessor && SrcManager->isLoadedFileID(FID)) {
726 // If the file is a modules header file it shall not be parsed
727 // for expected-* directives.
728 HeaderSearch &HS = CurrentPreprocessor->getHeaderSearchInfo();
729 if (HS.findModuleForHeader(FE))
730 PS = IsUnparsedNoDirectives;
733 UpdateParsedFileStatus(*SrcManager, FID, PS);
738 // Send the diagnostic to the buffer, we will check it once we reach the end
739 // of the source file (or are destructed).
740 Buffer->HandleDiagnostic(DiagLevel, Info);
743 /// HandleComment - Hook into the preprocessor and extract comments containing
744 /// expected errors and warnings.
745 bool VerifyDiagnosticConsumer::HandleComment(Preprocessor &PP,
746 SourceRange Comment) {
747 SourceManager &SM = PP.getSourceManager();
749 // If this comment is for a different source manager, ignore it.
750 if (SrcManager && &SM != SrcManager)
753 SourceLocation CommentBegin = Comment.getBegin();
755 const char *CommentRaw = SM.getCharacterData(CommentBegin);
756 StringRef C(CommentRaw, SM.getCharacterData(Comment.getEnd()) - CommentRaw);
761 // Fold any "\<EOL>" sequences
762 size_t loc = C.find('\\');
763 if (loc == StringRef::npos) {
764 ParseDirective(C, &ED, SM, &PP, CommentBegin, Status, *Markers);
769 C2.reserve(C.size());
771 for (size_t last = 0;; loc = C.find('\\', last)) {
772 if (loc == StringRef::npos || loc == C.size()) {
773 C2 += C.substr(last);
776 C2 += C.substr(last, loc-last);
779 if (C[last] == '\n' || C[last] == '\r') {
782 // Escape \r\n or \n\r, but not \n\n.
784 if (C[last] == '\n' || C[last] == '\r')
785 if (C[last] != C[last-1])
788 // This was just a normal backslash.
794 ParseDirective(C2, &ED, SM, &PP, CommentBegin, Status, *Markers);
799 /// Lex the specified source file to determine whether it contains
800 /// any expected-* directives. As a Lexer is used rather than a full-blown
801 /// Preprocessor, directives inside skipped #if blocks will still be found.
803 /// \return true if any directives were found.
804 static bool findDirectives(SourceManager &SM, FileID FID,
805 const LangOptions &LangOpts) {
806 // Create a raw lexer to pull all the comments out of FID.
810 // Create a lexer to lex all the tokens of the main file in raw mode.
811 const llvm::MemoryBuffer *FromFile = SM.getBuffer(FID);
812 Lexer RawLex(FID, FromFile, SM, LangOpts);
814 // Return comments as tokens, this is how we find expected diagnostics.
815 RawLex.SetCommentRetentionState(true);
818 Tok.setKind(tok::comment);
819 VerifyDiagnosticConsumer::DirectiveStatus Status =
820 VerifyDiagnosticConsumer::HasNoDirectives;
821 while (Tok.isNot(tok::eof)) {
822 RawLex.LexFromRawLexer(Tok);
823 if (!Tok.is(tok::comment)) continue;
825 std::string Comment = RawLex.getSpelling(Tok, SM, LangOpts);
826 if (Comment.empty()) continue;
828 // We don't care about tracking markers for this phase.
829 VerifyDiagnosticConsumer::MarkerTracker Markers(SM.getDiagnostics());
831 // Find first directive.
832 if (ParseDirective(Comment, nullptr, SM, nullptr, Tok.getLocation(),
840 /// Takes a list of diagnostics that have been generated but not matched
841 /// by an expected-* directive and produces a diagnostic to the user from this.
842 static unsigned PrintUnexpected(DiagnosticsEngine &Diags, SourceManager *SourceMgr,
843 const_diag_iterator diag_begin,
844 const_diag_iterator diag_end,
846 if (diag_begin == diag_end) return 0;
848 SmallString<256> Fmt;
849 llvm::raw_svector_ostream OS(Fmt);
850 for (const_diag_iterator I = diag_begin, E = diag_end; I != E; ++I) {
851 if (I->first.isInvalid() || !SourceMgr)
852 OS << "\n (frontend)";
855 if (const FileEntry *File = SourceMgr->getFileEntryForID(
856 SourceMgr->getFileID(I->first)))
857 OS << " File " << File->getName();
858 OS << " Line " << SourceMgr->getPresumedLineNumber(I->first);
860 OS << ": " << I->second;
863 Diags.Report(diag::err_verify_inconsistent_diags).setForceEmit()
864 << Kind << /*Unexpected=*/true << OS.str();
865 return std::distance(diag_begin, diag_end);
868 /// Takes a list of diagnostics that were expected to have been generated
869 /// but were not and produces a diagnostic to the user from this.
870 static unsigned PrintExpected(DiagnosticsEngine &Diags,
871 SourceManager &SourceMgr,
872 std::vector<Directive *> &DL, const char *Kind) {
876 SmallString<256> Fmt;
877 llvm::raw_svector_ostream OS(Fmt);
878 for (const auto *D : DL) {
879 if (D->DiagnosticLoc.isInvalid())
882 OS << "\n File " << SourceMgr.getFilename(D->DiagnosticLoc);
886 OS << " Line " << SourceMgr.getPresumedLineNumber(D->DiagnosticLoc);
887 if (D->DirectiveLoc != D->DiagnosticLoc)
888 OS << " (directive at "
889 << SourceMgr.getFilename(D->DirectiveLoc) << ':'
890 << SourceMgr.getPresumedLineNumber(D->DirectiveLoc) << ')';
891 OS << ": " << D->Text;
894 Diags.Report(diag::err_verify_inconsistent_diags).setForceEmit()
895 << Kind << /*Unexpected=*/false << OS.str();
899 /// Determine whether two source locations come from the same file.
900 static bool IsFromSameFile(SourceManager &SM, SourceLocation DirectiveLoc,
901 SourceLocation DiagnosticLoc) {
902 while (DiagnosticLoc.isMacroID())
903 DiagnosticLoc = SM.getImmediateMacroCallerLoc(DiagnosticLoc);
905 if (SM.isWrittenInSameFile(DirectiveLoc, DiagnosticLoc))
908 const FileEntry *DiagFile = SM.getFileEntryForID(SM.getFileID(DiagnosticLoc));
909 if (!DiagFile && SM.isWrittenInMainFile(DirectiveLoc))
912 return (DiagFile == SM.getFileEntryForID(SM.getFileID(DirectiveLoc)));
915 /// CheckLists - Compare expected to seen diagnostic lists and return the
916 /// the difference between them.
917 static unsigned CheckLists(DiagnosticsEngine &Diags, SourceManager &SourceMgr,
920 const_diag_iterator d2_begin,
921 const_diag_iterator d2_end,
922 bool IgnoreUnexpected) {
923 std::vector<Directive *> LeftOnly;
924 DiagList Right(d2_begin, d2_end);
926 for (auto &Owner : Left) {
927 Directive &D = *Owner;
928 unsigned LineNo1 = SourceMgr.getPresumedLineNumber(D.DiagnosticLoc);
930 for (unsigned i = 0; i < D.Max; ++i) {
931 DiagList::iterator II, IE;
932 for (II = Right.begin(), IE = Right.end(); II != IE; ++II) {
933 if (!D.MatchAnyLine) {
934 unsigned LineNo2 = SourceMgr.getPresumedLineNumber(II->first);
935 if (LineNo1 != LineNo2)
939 if (!D.DiagnosticLoc.isInvalid() &&
940 !IsFromSameFile(SourceMgr, D.DiagnosticLoc, II->first))
943 const std::string &RightText = II->second;
944 if (D.match(RightText))
949 if (i >= D.Min) break;
950 LeftOnly.push_back(&D);
952 // Found. The same cannot be found twice.
957 // Now all that's left in Right are those that were not matched.
958 unsigned num = PrintExpected(Diags, SourceMgr, LeftOnly, Label);
959 if (!IgnoreUnexpected)
960 num += PrintUnexpected(Diags, &SourceMgr, Right.begin(), Right.end(), Label);
964 /// CheckResults - This compares the expected results to those that
965 /// were actually reported. It emits any discrepencies. Return "true" if there
966 /// were problems. Return "false" otherwise.
967 static unsigned CheckResults(DiagnosticsEngine &Diags, SourceManager &SourceMgr,
968 const TextDiagnosticBuffer &Buffer,
970 // We want to capture the delta between what was expected and what was
973 // Expected \ Seen - set expected but not seen
974 // Seen \ Expected - set seen but not expected
975 unsigned NumProblems = 0;
977 const DiagnosticLevelMask DiagMask =
978 Diags.getDiagnosticOptions().getVerifyIgnoreUnexpected();
980 // See if there are error mismatches.
981 NumProblems += CheckLists(Diags, SourceMgr, "error", ED.Errors,
982 Buffer.err_begin(), Buffer.err_end(),
983 bool(DiagnosticLevelMask::Error & DiagMask));
985 // See if there are warning mismatches.
986 NumProblems += CheckLists(Diags, SourceMgr, "warning", ED.Warnings,
987 Buffer.warn_begin(), Buffer.warn_end(),
988 bool(DiagnosticLevelMask::Warning & DiagMask));
990 // See if there are remark mismatches.
991 NumProblems += CheckLists(Diags, SourceMgr, "remark", ED.Remarks,
992 Buffer.remark_begin(), Buffer.remark_end(),
993 bool(DiagnosticLevelMask::Remark & DiagMask));
995 // See if there are note mismatches.
996 NumProblems += CheckLists(Diags, SourceMgr, "note", ED.Notes,
997 Buffer.note_begin(), Buffer.note_end(),
998 bool(DiagnosticLevelMask::Note & DiagMask));
1003 void VerifyDiagnosticConsumer::UpdateParsedFileStatus(SourceManager &SM,
1006 // Check SourceManager hasn't changed.
1007 setSourceManager(SM);
1010 if (FID.isInvalid())
1013 const FileEntry *FE = SM.getFileEntryForID(FID);
1015 if (PS == IsParsed) {
1016 // Move the FileID from the unparsed set to the parsed set.
1017 UnparsedFiles.erase(FID);
1018 ParsedFiles.insert(std::make_pair(FID, FE));
1019 } else if (!ParsedFiles.count(FID) && !UnparsedFiles.count(FID)) {
1020 // Add the FileID to the unparsed set if we haven't seen it before.
1022 // Check for directives.
1023 bool FoundDirectives;
1024 if (PS == IsUnparsedNoDirectives)
1025 FoundDirectives = false;
1027 FoundDirectives = !LangOpts || findDirectives(SM, FID, *LangOpts);
1029 // Add the FileID to the unparsed set.
1030 UnparsedFiles.insert(std::make_pair(FID,
1031 UnparsedFileStatus(FE, FoundDirectives)));
1036 void VerifyDiagnosticConsumer::CheckDiagnostics() {
1037 // Ensure any diagnostics go to the primary client.
1038 DiagnosticConsumer *CurClient = Diags.getClient();
1039 std::unique_ptr<DiagnosticConsumer> Owner = Diags.takeClient();
1040 Diags.setClient(PrimaryClient, false);
1043 // In a debug build, scan through any files that may have been missed
1044 // during parsing and issue a fatal error if directives are contained
1045 // within these files. If a fatal error occurs, this suggests that
1046 // this file is being parsed separately from the main file, in which
1047 // case consider moving the directives to the correct place, if this
1049 if (!UnparsedFiles.empty()) {
1050 // Generate a cache of parsed FileEntry pointers for alias lookups.
1051 llvm::SmallPtrSet<const FileEntry *, 8> ParsedFileCache;
1052 for (const auto &I : ParsedFiles)
1053 if (const FileEntry *FE = I.second)
1054 ParsedFileCache.insert(FE);
1056 // Iterate through list of unparsed files.
1057 for (const auto &I : UnparsedFiles) {
1058 const UnparsedFileStatus &Status = I.second;
1059 const FileEntry *FE = Status.getFile();
1061 // Skip files that have been parsed via an alias.
1062 if (FE && ParsedFileCache.count(FE))
1065 // Report a fatal error if this file contained directives.
1066 if (Status.foundDirectives()) {
1067 llvm::report_fatal_error(Twine("-verify directives found after rather"
1068 " than during normal parsing of ",
1069 StringRef(FE ? FE->getName() : "(unknown)")));
1073 // UnparsedFiles has been processed now, so clear it.
1074 UnparsedFiles.clear();
1079 // Produce an error if no expected-* directives could be found in the
1080 // source file(s) processed.
1081 if (Status == HasNoDirectives) {
1082 Diags.Report(diag::err_verify_no_directives).setForceEmit();
1084 Status = HasNoDirectivesReported;
1087 // Check that the expected diagnostics occurred.
1088 NumErrors += CheckResults(Diags, *SrcManager, *Buffer, ED);
1090 const DiagnosticLevelMask DiagMask =
1091 ~Diags.getDiagnosticOptions().getVerifyIgnoreUnexpected();
1092 if (bool(DiagnosticLevelMask::Error & DiagMask))
1093 NumErrors += PrintUnexpected(Diags, nullptr, Buffer->err_begin(),
1094 Buffer->err_end(), "error");
1095 if (bool(DiagnosticLevelMask::Warning & DiagMask))
1096 NumErrors += PrintUnexpected(Diags, nullptr, Buffer->warn_begin(),
1097 Buffer->warn_end(), "warn");
1098 if (bool(DiagnosticLevelMask::Remark & DiagMask))
1099 NumErrors += PrintUnexpected(Diags, nullptr, Buffer->remark_begin(),
1100 Buffer->remark_end(), "remark");
1101 if (bool(DiagnosticLevelMask::Note & DiagMask))
1102 NumErrors += PrintUnexpected(Diags, nullptr, Buffer->note_begin(),
1103 Buffer->note_end(), "note");
1106 Diags.setClient(CurClient, Owner.release() != nullptr);
1108 // Reset the buffer, we have processed all the diagnostics in it.
1109 Buffer.reset(new TextDiagnosticBuffer());
1113 std::unique_ptr<Directive> Directive::create(bool RegexKind,
1114 SourceLocation DirectiveLoc,
1115 SourceLocation DiagnosticLoc,
1116 bool MatchAnyLine, StringRef Text,
1117 unsigned Min, unsigned Max) {
1119 return llvm::make_unique<StandardDirective>(DirectiveLoc, DiagnosticLoc,
1120 MatchAnyLine, Text, Min, Max);
1122 // Parse the directive into a regular expression.
1123 std::string RegexStr;
1125 while (!S.empty()) {
1126 if (S.startswith("{{")) {
1127 S = S.drop_front(2);
1128 size_t RegexMatchLength = S.find("}}");
1129 assert(RegexMatchLength != StringRef::npos);
1130 // Append the regex, enclosed in parentheses.
1132 RegexStr.append(S.data(), RegexMatchLength);
1134 S = S.drop_front(RegexMatchLength + 2);
1136 size_t VerbatimMatchLength = S.find("{{");
1137 if (VerbatimMatchLength == StringRef::npos)
1138 VerbatimMatchLength = S.size();
1139 // Escape and append the fixed string.
1140 RegexStr += llvm::Regex::escape(S.substr(0, VerbatimMatchLength));
1141 S = S.drop_front(VerbatimMatchLength);
1145 return llvm::make_unique<RegexDirective>(
1146 DirectiveLoc, DiagnosticLoc, MatchAnyLine, Text, Min, Max, RegexStr);