1//===- Facts.cpp - Lifetime Analysis Facts Implementation -------*- C++ -*-===//
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/Analyses/LifetimeSafety/Facts.h"
10#include "clang/AST/Decl.h"
11#include "clang/Analysis/Analyses/PostOrderCFGView.h"
12
13namespace clang::lifetimes::internal {
14
15void Fact::dump(llvm::raw_ostream &OS, const LoanManager &,
16 const OriginManager &) const {
17 OS << "Fact (Kind: " << static_cast<int>(K) << ")\n";
18}
19
20void IssueFact::dump(llvm::raw_ostream &OS, const LoanManager &LM,
21 const OriginManager &OM) const {
22 OS << "Issue (";
23 LM.getLoan(ID: getLoanID())->dump(OS);
24 OS << ", ToOrigin: ";
25 OM.dump(OID: getOriginID(), OS);
26 OS << ")\n";
27}
28
29void ExpireFact::dump(llvm::raw_ostream &OS, const LoanManager &LM,
30 const OriginManager &OM) const {
31 OS << "Expire (";
32 getAccessPath().dump(OS);
33 if (auto OID = getOriginID()) {
34 OS << ", Origin: ";
35 OM.dump(OID: *OID, OS);
36 }
37 OS << ")\n";
38}
39
40void OriginFlowFact::dump(llvm::raw_ostream &OS, const LoanManager &,
41 const OriginManager &OM) const {
42 OS << "OriginFlow: \n";
43 OS << "\tDest: ";
44 OM.dump(OID: getDestOriginID(), OS);
45 OS << "\n";
46 OS << "\tSrc: ";
47 OM.dump(OID: getSrcOriginID(), OS);
48 OS << (getKillDest() ? "" : ", Merge");
49 OS << "\n";
50}
51
52void MovedOriginFact::dump(llvm::raw_ostream &OS, const LoanManager &,
53 const OriginManager &OM) const {
54 OS << "MovedOrigins (";
55 OM.dump(OID: getMovedOrigin(), OS);
56 OS << ")\n";
57}
58
59void ReturnEscapeFact::dump(llvm::raw_ostream &OS, const LoanManager &,
60 const OriginManager &OM) const {
61 OS << "OriginEscapes (";
62 OM.dump(OID: getEscapedOriginID(), OS);
63 OS << ", via Return)\n";
64}
65
66void FieldEscapeFact::dump(llvm::raw_ostream &OS, const LoanManager &,
67 const OriginManager &OM) const {
68 OS << "OriginEscapes (";
69 OM.dump(OID: getEscapedOriginID(), OS);
70 OS << ", via Field)\n";
71}
72
73void GlobalEscapeFact::dump(llvm::raw_ostream &OS, const LoanManager &,
74 const OriginManager &OM) const {
75 OS << "OriginEscapes (";
76 OM.dump(OID: getEscapedOriginID(), OS);
77 OS << ", via Global)\n";
78}
79
80void UseFact::dump(llvm::raw_ostream &OS, const LoanManager &,
81 const OriginManager &OM) const {
82 OS << "Use (";
83 size_t NumUsedOrigins = getUsedOrigins()->getLength();
84 size_t I = 0;
85 for (const OriginList *Cur = getUsedOrigins(); Cur;
86 Cur = Cur->peelOuterOrigin(), ++I) {
87 OM.dump(OID: Cur->getOuterOriginID(), OS);
88 if (I < NumUsedOrigins - 1)
89 OS << ", ";
90 }
91 OS << ", " << (isWritten() ? "Write" : "Read") << ")\n";
92}
93
94void InvalidateOriginFact::dump(llvm::raw_ostream &OS, const LoanManager &,
95 const OriginManager &OM) const {
96 OS << "InvalidateOrigin (";
97 OM.dump(OID: getInvalidatedOrigin(), OS);
98 OS << ")\n";
99}
100
101void TestPointFact::dump(llvm::raw_ostream &OS, const LoanManager &,
102 const OriginManager &) const {
103 OS << "TestPoint (Annotation: \"" << getAnnotation() << "\")\n";
104}
105
106void KillOriginFact::dump(llvm::raw_ostream &OS, const LoanManager &,
107 const OriginManager &OM) const {
108 OS << "KillOrigin (";
109 OM.dump(OID: getKilledOrigin(), OS);
110 OS << ")\n";
111}
112
113llvm::StringMap<ProgramPoint> FactManager::getTestPoints() const {
114 llvm::StringMap<ProgramPoint> AnnotationToPointMap;
115 for (const auto &BlockFacts : BlockToFacts) {
116 for (const Fact *F : BlockFacts) {
117 if (const auto *TPF = F->getAs<TestPointFact>()) {
118 StringRef PointName = TPF->getAnnotation();
119 assert(!AnnotationToPointMap.contains(PointName) &&
120 "more than one test points with the same name");
121 AnnotationToPointMap[PointName] = F;
122 }
123 }
124 }
125 return AnnotationToPointMap;
126}
127
128void FactManager::dump(const CFG &Cfg, AnalysisDeclContext &AC) const {
129 llvm::dbgs() << "==========================================\n";
130 llvm::dbgs() << " Lifetime Analysis Facts:\n";
131 llvm::dbgs() << "==========================================\n";
132 if (const Decl *D = AC.getDecl())
133 if (const auto *ND = dyn_cast<NamedDecl>(Val: D))
134 llvm::dbgs() << "Function: " << ND->getQualifiedNameAsString() << "\n";
135 // Print blocks in the order as they appear in code for a stable ordering.
136 for (const CFGBlock *B : *AC.getAnalysis<PostOrderCFGView>()) {
137 llvm::dbgs() << " Block B" << B->getBlockID() << ":\n";
138 for (const Fact *F : getFacts(B)) {
139 llvm::dbgs() << " ";
140 F->dump(OS&: llvm::dbgs(), LoanMgr, OriginMgr);
141 }
142 llvm::dbgs() << " End of Block\n";
143 }
144}
145
146llvm::ArrayRef<const Fact *>
147FactManager::getBlockContaining(ProgramPoint P) const {
148 for (const auto &BlockToFactsVec : BlockToFacts) {
149 for (const Fact *F : BlockToFactsVec)
150 if (F == P)
151 return BlockToFactsVec;
152 }
153 return {};
154}
155
156} // namespace clang::lifetimes::internal
157