Skip to content

clang-tidy: Fix IDE LCA #458

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pdschubert merged 2 commits into from
Jan 4, 2022
Merged

clang-tidy: Fix IDE LCA #458

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
98c2a3a
clang-tidy fixes for IDE LCA
Dec 22, 2021
de2fd5c
Merge branch 'development' into f-ClangTidyFixIDELCA
pdschubert Jan 4, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
127 changes: 65 additions & 62 deletions include/phasar/PhasarLLVM/DataFlowSolver/IfdsIde/Problems/IDELinearConstantAnalysis.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,9 @@ class IDELinearConstantAnalysis
: public IDETabulationProblem<IDELinearConstantAnalysisDomain> {
private:
// For debug purpose only
static unsigned CurrGenConstantId;
static unsigned CurrLCAIDId;
static unsigned CurrBinaryId;
static unsigned CurrGenConstantId; // NOLINT
Copy link
Copy Markdown
Collaborator

@vulder vulder Dec 26, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the problem here? unused?

Copy link
Copy Markdown
Member

@pdschubert pdschubert Jan 4, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Core guidelines: avoid non-constant global variables.

static unsigned CurrLCAIDId; // NOLINT
static unsigned CurrBinaryId; // NOLINT

public:
using IDETabProblemType =
Expand All @@ -66,34 +66,37 @@ class IDELinearConstantAnalysis
std::set<std::string> EntryPoints = {"main"});

~IDELinearConstantAnalysis() override;
IDELinearConstantAnalysis(const IDELinearConstantAnalysis &) = delete;
IDELinearConstantAnalysis &
operator=(const IDELinearConstantAnalysis &) = delete;

IDELinearConstantAnalysis &
operator=(const IDELinearConstantAnalysis &) = delete;
struct LCAResult {
LCAResult() = default;
unsigned line_nr = 0;
std::string src_code;
std::map<std::string, l_t> variableToValue;
std::vector<n_t> ir_trace;
void print(std::ostream &os);
inline bool operator==(const LCAResult &rhs) const {
return src_code == rhs.src_code &&
variableToValue == rhs.variableToValue && ir_trace == rhs.ir_trace;
unsigned LineNr = 0;
std::string SrcNode;
std::map<std::string, l_t> VariableToValue;
std::vector<n_t> IRTrace;
void print(std::ostream &OS);
inline bool operator==(const LCAResult &Rhs) const {
return SrcNode == Rhs.SrcNode && VariableToValue == Rhs.VariableToValue &&
IRTrace == Rhs.IRTrace;
}

operator std::string() const {
std::stringstream OS;
OS << "Line " << line_nr << ": " << src_code << '\n';
OS << "Line " << LineNr << ": " << SrcNode << '\n';
OS << "Var(s): ";
for (auto It = variableToValue.begin(); It != variableToValue.end();
for (auto It = VariableToValue.begin(); It != VariableToValue.end();
++It) {
if (It != variableToValue.begin()) {
if (It != VariableToValue.begin()) {
OS << ", ";
}
OS << It->first << " = " << It->second;
}
OS << "\nCorresponding IR Instructions:\n";
for (const auto *Ir : ir_trace) {
for (const auto *Ir : IRTrace) {
OS << " " << llvmIRToString(Ir) << '\n';
}
return OS.str();
Expand All @@ -106,52 +109,52 @@ class IDELinearConstantAnalysis

// start formulating our analysis by specifying the parts required for IFDS

FlowFunctionPtrType getNormalFlowFunction(n_t curr, n_t succ) override;
FlowFunctionPtrType getNormalFlowFunction(n_t Curr, n_t Succ) override;

FlowFunctionPtrType getCallFlowFunction(n_t callSite, f_t destFun) override;
FlowFunctionPtrType getCallFlowFunction(n_t CallSite, f_t DestFun) override;

FlowFunctionPtrType getRetFlowFunction(n_t callSite, f_t calleeFun,
n_t exitInst, n_t retSite) override;
FlowFunctionPtrType getRetFlowFunction(n_t CallSite, f_t CalleeFun,
n_t ExitInst, n_t RetSite) override;

FlowFunctionPtrType getCallToRetFlowFunction(n_t callSite, n_t retSite,
std::set<f_t> callees) override;
FlowFunctionPtrType getCallToRetFlowFunction(n_t CallSite, n_t RetSite,
std::set<f_t> Callees) override;

FlowFunctionPtrType getSummaryFlowFunction(n_t callSite,
f_t destFun) override;
FlowFunctionPtrType getSummaryFlowFunction(n_t CallSite,
f_t DestFun) override;

[[nodiscard]] InitialSeeds<n_t, d_t, l_t> initialSeeds() override;

[[nodiscard]] d_t createZeroValue() const override;

bool isZeroValue(d_t d) const override;
[[nodiscard]] bool isZeroValue(d_t Fact) const override;

// in addition provide specifications for the IDE parts

std::shared_ptr<EdgeFunction<l_t>>
getNormalEdgeFunction(n_t curr, d_t currNode, n_t succ,
d_t succNode) override;
getNormalEdgeFunction(n_t Curr, d_t CurrNode, n_t Succ,
d_t SuccNode) override;

std::shared_ptr<EdgeFunction<l_t>>
getCallEdgeFunction(n_t callSite, d_t srcNode, f_t destinationFunction,
d_t destNode) override;
getCallEdgeFunction(n_t CallSite, d_t SrcNode, f_t DestinationFunction,
d_t DestNode) override;

std::shared_ptr<EdgeFunction<l_t>>
getReturnEdgeFunction(n_t callSite, f_t calleeFunction, n_t exitInst,
d_t exitNode, n_t reSite, d_t retNode) override;
getReturnEdgeFunction(n_t CallSite, f_t CalleeFunction, n_t ExitStmt,
d_t ExitNode, n_t RetSite, d_t RetNode) override;

std::shared_ptr<EdgeFunction<l_t>>
getCallToRetEdgeFunction(n_t callSite, d_t callNode, n_t retSite,
d_t retSiteNode, std::set<f_t> callees) override;
getCallToRetEdgeFunction(n_t CallSite, d_t CallNode, n_t RetSite,
d_t RetSiteNode, std::set<f_t> Callees) override;

std::shared_ptr<EdgeFunction<l_t>>
getSummaryEdgeFunction(n_t callSite, d_t callNode, n_t retSite,
d_t retSiteNode) override;
getSummaryEdgeFunction(n_t CallSite, d_t CallNode, n_t RetSite,
d_t RetSiteNode) override;

l_t topElement() override;

l_t bottomElement() override;

l_t join(l_t lhs, l_t rhs) override;
l_t join(l_t Lhs, l_t Rhs) override;

std::shared_ptr<EdgeFunction<l_t>> allTopFunction() override;

Expand All @@ -164,75 +167,75 @@ class IDELinearConstantAnalysis
: EdgeFunctionComposer<l_t>(F, G){};

std::shared_ptr<EdgeFunction<l_t>>
composeWith(std::shared_ptr<EdgeFunction<l_t>> secondFunction) override;
composeWith(std::shared_ptr<EdgeFunction<l_t>> SecondFunction) override;

std::shared_ptr<EdgeFunction<l_t>>
joinWith(std::shared_ptr<EdgeFunction<l_t>> otherFunction) override;
joinWith(std::shared_ptr<EdgeFunction<l_t>> OtherFunction) override;
};

class GenConstant : public EdgeFunction<l_t>,
public std::enable_shared_from_this<GenConstant> {
private:
const unsigned GenConstant_Id;
const unsigned GenConstantId;
const l_t IntConst;

public:
explicit GenConstant(l_t IntConst);

l_t computeTarget(l_t source) override;
l_t computeTarget(l_t Source) override;

std::shared_ptr<EdgeFunction<l_t>>
composeWith(std::shared_ptr<EdgeFunction<l_t>> secondFunction) override;
composeWith(std::shared_ptr<EdgeFunction<l_t>> SecondFunction) override;

std::shared_ptr<EdgeFunction<l_t>>
joinWith(std::shared_ptr<EdgeFunction<l_t>> otherFunction) override;
joinWith(std::shared_ptr<EdgeFunction<l_t>> OtherFunction) override;

bool equal_to(std::shared_ptr<EdgeFunction<l_t>> other) const override;
bool equal_to(std::shared_ptr<EdgeFunction<l_t>> Other) const override;

void print(std::ostream &OS, bool isForDebug = false) const override;
void print(std::ostream &OS, bool IsForDebug = false) const override;
};

class LCAIdentity : public EdgeFunction<l_t>,
public std::enable_shared_from_this<LCAIdentity> {
private:
const unsigned LCAID_Id;
const unsigned LCAIDId;

public:
explicit LCAIdentity();

l_t computeTarget(l_t source) override;
l_t computeTarget(l_t Source) override;

std::shared_ptr<EdgeFunction<l_t>>
composeWith(std::shared_ptr<EdgeFunction<l_t>> secondFunction) override;
composeWith(std::shared_ptr<EdgeFunction<l_t>> SecondFunction) override;

std::shared_ptr<EdgeFunction<l_t>>
joinWith(std::shared_ptr<EdgeFunction<l_t>> otherFunction) override;
joinWith(std::shared_ptr<EdgeFunction<l_t>> OtherFunction) override;

bool equal_to(std::shared_ptr<EdgeFunction<l_t>> other) const override;
bool equal_to(std::shared_ptr<EdgeFunction<l_t>> Other) const override;

void print(std::ostream &OS, bool isForDebug = false) const override;
void print(std::ostream &OS, bool IsForDebug = false) const override;
};

class BinOp : public EdgeFunction<l_t>,
public std::enable_shared_from_this<BinOp> {
private:
const unsigned EdgeFunctionID, Op;
d_t lop, rop, currNode;
d_t Lop, Rop, CurrNode;

public:
BinOp(const unsigned Op, d_t lop, d_t rop, d_t currNode);
BinOp(unsigned Op, d_t Lop, d_t Rop, d_t CurrNode);

l_t computeTarget(l_t source) override;
l_t computeTarget(l_t Source) override;

std::shared_ptr<EdgeFunction<l_t>>
composeWith(std::shared_ptr<EdgeFunction<l_t>> secondFunction) override;
composeWith(std::shared_ptr<EdgeFunction<l_t>> SecondFunction) override;

std::shared_ptr<EdgeFunction<l_t>>
joinWith(std::shared_ptr<EdgeFunction<l_t>> otherFunction) override;
joinWith(std::shared_ptr<EdgeFunction<l_t>> OtherFunction) override;

bool equal_to(std::shared_ptr<EdgeFunction<l_t>> other) const override;
bool equal_to(std::shared_ptr<EdgeFunction<l_t>> Other) const override;

void print(std::ostream &OS, bool isForDebug = false) const override;
void print(std::ostream &OS, bool IsForDebug = false) const override;
};

// Helper functions
Expand All @@ -251,19 +254,19 @@ class IDELinearConstantAnalysis
* @param rop right operand
* @return Result of binary operation
*/
static l_t executeBinOperation(const unsigned op, l_t lop, l_t rop);
static l_t executeBinOperation(unsigned Op, l_t Lop, l_t Rop);

static char opToChar(const unsigned op);
static char opToChar(unsigned Op);

[[nodiscard]] bool isEntryPoint(const std::string &FunctionName) const;

void printNode(std::ostream &os, n_t n) const override;
void printNode(std::ostream &OS, n_t Stmt) const override;

void printDataFlowFact(std::ostream &os, d_t d) const override;
void printDataFlowFact(std::ostream &OS, d_t Fact) const override;

void printFunction(std::ostream &os, f_t m) const override;
void printFunction(std::ostream &OS, f_t Func) const override;

void printEdgeFact(std::ostream &os, l_t l) const override;
void printEdgeFact(std::ostream &OS, l_t L) const override;

[[nodiscard]] lca_results_t getLCAResults(SolverResults<n_t, d_t, l_t> SR);

Expand Down
Loading