File: CheckForbiddenFieldsVisitor.h

package info (click to toggle)
chromium 138.0.7204.157-1
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 6,071,864 kB
  • sloc: cpp: 34,936,859; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,953; asm: 946,768; xml: 739,967; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,806; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (61 lines) | stat: -rw-r--r-- 1,973 bytes parent folder | download | duplicates (4)
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
// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef TOOLS_CLANG_BLINK_GC_PLUGIN_CHECKFORBIDDENFIELDSVISITOR_H_
#define TOOLS_CLANG_BLINK_GC_PLUGIN_CHECKFORBIDDENFIELDSVISITOR_H_

#include <set>
#include <vector>

#include "Edge.h"
#include "RecordInfo.h"

// This visitor checks that the fields of a class and the fields of
// its embedded objects don't define GC roots.
class CheckForbiddenFieldsVisitor : public RecursiveEdgeVisitor {
 public:
  enum class Error {
    kTaskRunnerInGCManaged,
    kMojoRemoteInGCManaged,
    kMojoReceiverInGCManaged,
    kMojoAssociatedRemoteInGCManaged,
    kMojoAssociatedReceiverInGCManaged,
  };

  using RootPath = std::vector<FieldPoint*>;
  using VisitingSet = std::set<RecordInfo*>;
  using Errors = std::vector<std::pair<RootPath, Error>>;

  explicit CheckForbiddenFieldsVisitor();

  // The forbidden fields found across the call(s) to
  // `ContainsForbiddenFields`.
  Errors& forbidden_fields();

  // Checks whether the record recursively contains forbidden fields (either the
  // record itself or an embedded object).
  // Returns whether forbidden fields were found.
  bool ContainsForbiddenFields(RecordInfo* info);

  void VisitValue(Value* edge) override;
  void VisitArrayEdge(ArrayEdge* edge) override;

 private:
  bool ContainsForbiddenFieldsInternal(RecordInfo* info);
  bool ContainsInvalidFieldTypes(Value* edge);

  // The current path that we are working on.
  // This permits to find the path back to the GCed type when handling embedded
  // objects.
  RootPath current_;

  // The currently visited nodes. This is used to handle cyclic dependencies
  // between the embedded objects we are going through.
  VisitingSet visiting_set_;

  // The actual fields that were found while inspecting the record.
  Errors forbidden_fields_;
};

#endif  // TOOLS_CLANG_BLINK_GC_PLUGIN_CHECKFORBIDDENFIELDSVISITOR_H_