Coverage Report

Created: 2023-05-31 04:38

/Users/buildslave/jenkins/workspace/coverage/llvm-project/clang/lib/Analysis/FlowSensitive/Logger.cpp
Line
Count
Source (jump to first uncovered line)
1
//===-- Logger.cpp --------------------------------------------------------===//
2
//
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
6
//
7
//===----------------------------------------------------------------------===//
8
9
#include "clang/Analysis/FlowSensitive/Logger.h"
10
#include "clang/Analysis/FlowSensitive/ControlFlowContext.h"
11
#include "clang/Analysis/FlowSensitive/TypeErasedDataflowAnalysis.h"
12
#include "llvm/Support/WithColor.h"
13
14
namespace clang::dataflow {
15
16
577
Logger &Logger::null() {
17
577
  struct NullLogger final : Logger {};
18
577
  static auto *Instance = new NullLogger();
19
577
  return *Instance;
20
577
}
21
22
namespace {
23
struct TextualLogger final : Logger {
24
  llvm::raw_ostream &OS;
25
  const CFG *CurrentCFG;
26
  const CFGBlock *CurrentBlock;
27
  const CFGElement *CurrentElement;
28
  unsigned CurrentElementIndex;
29
  bool ShowColors;
30
  llvm::DenseMap<const CFGBlock *, unsigned> VisitCount;
31
  TypeErasedDataflowAnalysis *CurrentAnalysis;
32
33
  TextualLogger(llvm::raw_ostream &OS)
34
0
      : OS(OS), ShowColors(llvm::WithColor::defaultAutoDetectFunction()(OS)) {}
35
36
  virtual void beginAnalysis(const ControlFlowContext &CFG,
37
0
                             TypeErasedDataflowAnalysis &Analysis) override {
38
0
    {
39
0
      llvm::WithColor Header(OS, llvm::raw_ostream::Colors::RED, /*Bold=*/true);
40
0
      OS << "=== Beginning data flow analysis ===\n";
41
0
    }
42
0
    if (auto *D = CFG.getDecl()) {
43
0
      D->print(OS);
44
0
      OS << "\n";
45
0
      D->dump(OS);
46
0
    }
47
0
    CurrentCFG = &CFG.getCFG();
48
0
    CurrentCFG->print(OS, Analysis.getASTContext().getLangOpts(), ShowColors);
49
0
    CurrentAnalysis = &Analysis;
50
0
  }
51
0
  virtual void endAnalysis() override {
52
0
    llvm::WithColor Header(OS, llvm::raw_ostream::Colors::RED, /*Bold=*/true);
53
0
    unsigned Blocks = 0, Steps = 0;
54
0
    for (const auto &E : VisitCount) {
55
0
      ++Blocks;
56
0
      Steps += E.second;
57
0
    }
58
0
    llvm::errs() << "=== Finished analysis: " << Blocks << " blocks in "
59
0
                 << Steps << " total steps ===\n";
60
0
  }
61
0
  virtual void enterBlock(const CFGBlock &Block) override {
62
0
    unsigned Count = ++VisitCount[&Block];
63
0
    {
64
0
      llvm::WithColor Header(OS, llvm::raw_ostream::Colors::RED, /*Bold=*/true);
65
0
      OS << "=== Entering block B" << Block.getBlockID() << " (iteration "
66
0
         << Count << ") ===\n";
67
0
    }
68
0
    Block.print(OS, CurrentCFG, CurrentAnalysis->getASTContext().getLangOpts(),
69
0
                ShowColors);
70
0
    CurrentBlock = &Block;
71
0
    CurrentElement = nullptr;
72
0
    CurrentElementIndex = 0;
73
0
  }
74
0
  virtual void enterElement(const CFGElement &Element) override {
75
0
    ++CurrentElementIndex;
76
0
    CurrentElement = &Element;
77
0
    {
78
0
      llvm::WithColor Subheader(OS, llvm::raw_ostream::Colors::CYAN,
79
0
                                /*Bold=*/true);
80
0
      OS << "Processing element B" << CurrentBlock->getBlockID() << "."
81
0
         << CurrentElementIndex << ": ";
82
0
      Element.dumpToStream(OS);
83
0
    }
84
0
  }
85
0
  void recordState(TypeErasedDataflowAnalysisState &State) override {
86
0
    {
87
0
      llvm::WithColor Subheader(OS, llvm::raw_ostream::Colors::CYAN,
88
0
                                /*Bold=*/true);
89
0
      OS << "Computed state for B" << CurrentBlock->getBlockID() << "."
90
0
         << CurrentElementIndex << ":\n";
91
0
    }
92
    // FIXME: currently the environment dump is verbose and unenlightening.
93
    // FIXME: dump the user-defined lattice, too.
94
0
    State.Env.dump(OS);
95
0
    OS << "\n";
96
0
  }
97
0
  void blockConverged() override {
98
0
    OS << "B" << CurrentBlock->getBlockID() << " has converged!\n";
99
0
  }
100
0
  virtual void logText(llvm::StringRef S) override { OS << S << "\n"; }
101
};
102
} // namespace
103
104
0
std::unique_ptr<Logger> Logger::textual(llvm::raw_ostream &OS) {
105
0
  return std::make_unique<TextualLogger>(OS);
106
0
}
107
108
} // namespace clang::dataflow