File: CheckLayoutObjectMethodsVisitor.cpp

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (151 lines) | stat: -rw-r--r-- 5,368 bytes parent folder | download | duplicates (10)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
// Copyright 2021 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "CheckLayoutObjectMethodsVisitor.h"

#include "clang/AST/AST.h"
#include "clang/AST/ASTContext.h"
#include "clang/ASTMatchers/ASTMatchFinder.h"
#include "clang/ASTMatchers/ASTMatchers.h"

using namespace clang::ast_matchers;

namespace chrome_checker {

std::string CheckLayoutObjectMethodsVisitor::layout_directory =
    "third_party/blink/renderer/core/layout";
std::string CheckLayoutObjectMethodsVisitor::test_directory =
    "tools/clang/plugins/tests";

namespace {

const char kLayoutObjectMethodWithoutIsNotDestroyedCheck[] =
    "[layout] LayoutObject's method %0 in %1 must call CheckIsNotDestroyed() "
    "at the beginning.";

class DiagnosticsReporter {
 public:
  explicit DiagnosticsReporter(clang::CompilerInstance& instance)
      : instance_(instance), diagnostic_(instance.getDiagnostics()) {
    diag_layout_object_method_without_is_not_destroyed_check_ =
        diagnostic_.getCustomDiagID(
            getErrorLevel(), kLayoutObjectMethodWithoutIsNotDestroyedCheck);
  }

  bool hasErrorOccurred() const { return diagnostic_.hasErrorOccurred(); }

  clang::DiagnosticsEngine::Level getErrorLevel() const {
    return diagnostic_.getWarningsAsErrors()
               ? clang::DiagnosticsEngine::Error
               : clang::DiagnosticsEngine::Warning;
  }

  void LayoutObjectMethodWithoutIsNotDestroyedCheck(
      const clang::CXXMethodDecl* expr,
      const clang::CXXRecordDecl* record) {
    ReportDiagnostic(expr->getBeginLoc(),
                     diag_layout_object_method_without_is_not_destroyed_check_)
        << expr << record << expr->getSourceRange();
  }

 private:
  clang::DiagnosticBuilder ReportDiagnostic(clang::SourceLocation location,
                                            unsigned diag_id) {
    clang::SourceManager& manager = instance_.getSourceManager();
    clang::FullSourceLoc full_loc(location, manager);
    return diagnostic_.Report(full_loc, diag_id);
  }

  clang::CompilerInstance& instance_;
  clang::DiagnosticsEngine& diagnostic_;

  unsigned diag_layout_object_method_without_is_not_destroyed_check_;
};

class LayoutObjectMethodMatcher : public MatchFinder::MatchCallback {
 public:
  explicit LayoutObjectMethodMatcher(class DiagnosticsReporter& diagnostics)
      : diagnostics_(diagnostics) {}

  void Register(MatchFinder& match_finder) {
    const DeclarationMatcher function_call =
        cxxMethodDecl(
            hasParent(
                cxxRecordDecl(isSameOrDerivedFrom("::blink::LayoutObject"))),
            has(compoundStmt()),
            // Avoid matching the following cases
            unless(anyOf(isConstexpr(), isDefaulted(), isPure(),
                         cxxConstructorDecl(), cxxDestructorDecl(),
                         isStaticStorageClass(),
                         // Do not trace lambdas (no name, possibly tracking
                         // more parameters than intended because of [&]).
                         hasParent(cxxRecordDecl(isLambda())),
                         // Do not include CheckIsDestroyed() itself.
                         hasName("CheckIsNotDestroyed"),
                         // Do not include tracing methods.
                         hasName("Trace"), hasName("TraceAfterDispatch"))))
            .bind("layout_method");
    match_finder.addDynamicMatcher(function_call, this);
  }

  void run(const MatchFinder::MatchResult& result) override {
    auto* method =
        result.Nodes.getNodeAs<clang::CXXMethodDecl>("layout_method");

    const auto* stmt = method->getBody();
    assert(stmt);

    if (!llvm::dyn_cast<clang::CompoundStmt>(stmt)->body_empty()) {
      auto* stmts = llvm::dyn_cast<clang::CompoundStmt>(stmt)->body_front();
      if (clang::CXXMemberCallExpr::classof(stmts)) {
        auto* call = llvm::dyn_cast<clang::CXXMemberCallExpr>(stmts);
        const std::string& name = call->getMethodDecl()->getNameAsString();
        if (name == "CheckIsNotDestroyed")
          return;
      }
    }

    auto* type = method->getParent();
    diagnostics_.LayoutObjectMethodWithoutIsNotDestroyedCheck(method, type);
  }

 private:
  DiagnosticsReporter& diagnostics_;
};

}  // namespace

CheckLayoutObjectMethodsVisitor::CheckLayoutObjectMethodsVisitor(
    clang::CompilerInstance& compiler)
    : compiler_(compiler) {}

void CheckLayoutObjectMethodsVisitor::VisitLayoutObjectMethods(
    clang::ASTContext& ast_context) {
  const clang::FileEntry* file_entry =
      ast_context.getSourceManager().getFileEntryForID(
          ast_context.getSourceManager().getMainFileID());
  if (!file_entry)
    return;

  auto file_name_ref = file_entry->tryGetRealPathName();
  if (file_name_ref.empty())
    return;
  std::string file_name = file_name_ref.str();
#if defined(_WIN32)
  std::replace(file_name.begin(), file_name.end(), '\\', '/');
#endif
  if (file_name.find(layout_directory) == std::string::npos &&
      file_name.find(test_directory) == std::string::npos)
    return;

  MatchFinder match_finder;
  DiagnosticsReporter diagnostics(compiler_);

  LayoutObjectMethodMatcher layout_object_method_matcher(diagnostics);
  layout_object_method_matcher.Register(match_finder);

  match_finder.matchAST(ast_context);
}

}  // namespace chrome_checker