Skip to content

One clang pass #488

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
kyleheadley merged 15 commits into from
Mar 23, 2021
Merged

One clang pass #488

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
2efa47e
prototype without Diagnostics
kyleheadley Mar 12, 2021
50d8d78
enableSourceFileDiagnostics
kyleheadley Mar 12, 2021
67e3aae
only enable diags once per ast
kyleheadley Mar 12, 2021
f72b851
add fail case
kyleheadley Mar 12, 2021
1cc0bf6
FileEntry path before CanonicalFilePath
kyleheadley Mar 15, 2021
70a9804
Diagnostic errors cause non-zero exit code
kyleheadley Mar 16, 2021
2ed898d
setup multipass verifier
kyleheadley Mar 17, 2021
7443b1c
remove unused prefixes
kyleheadley Mar 19, 2021
fcc0b99
delete unused code; create ASTs in seperate function
kyleheadley Mar 19, 2021
08e04fa
rework canonical file path
kyleheadley Mar 19, 2021
889a9bd
add test refactoring TODOs
kyleheadley Mar 19, 2021
f56b017
Merge remote-tracking branch 'origin/main' into one_clang_pass
kyleheadley Mar 19, 2021
15ca7d2
:disable diag_verifier tests
kyleheadley Mar 19, 2021
4a5766e
Wording
kyleheadley Mar 23, 2021
123129b
Slight improvements and comments for file path canonicalization (for …
mattmccutchen-cci Mar 23, 2021
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
3 changes: 3 additions & 0 deletions clang/include/clang/3C/3C.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,9 @@ class _3CInterface {
// Mutex for this interface.
std::mutex InterfaceMutex;

// saved ASTs
std::vector< std::unique_ptr< ASTUnit >> ASTs;

// If the parameters are invalid, this function prints an error message to
// stderr and returns null.
//
Expand Down
191 changes: 114 additions & 77 deletions clang/lib/3C/3C.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -351,18 +351,25 @@ bool _3CInterface::addVariables() {

std::lock_guard<std::mutex> Lock(InterfaceMutex);

// first step, so load the ASTs
ClangTool &Tool = getGlobalClangTool();
Tool.buildASTs(ASTs);
Copy link
Member

@mwhicks1 mwhicks1 Mar 17, 2021

Choose a reason for hiding this comment

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

It feels odd to me to build the ASTs here, since the name of the method is addVariables.

Perhaps there should be another method call in _3CInterface that you specifically invoke to the build the ASTs, and then the subsequent passes can check to confirm the ASTs have been built already?

Copy link
Member Author

@kyleheadley kyleheadley Mar 18, 2021

Choose a reason for hiding this comment

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

yep. I'll do a minor refactor once the functionality is stable and I agree this needs its own little section.


// 1a. Add Variables.
std::unique_ptr<ToolAction> AdderTool = newFrontendActionFactoryA<
GenericAction<VariableAdderConsumer, ProgramInfo>>(GlobalProgramInfo);
VariableAdderConsumer VA = VariableAdderConsumer(GlobalProgramInfo, nullptr);
for (auto &TU : ASTs) {
VA.HandleTranslationUnit(TU->getASTContext());
Copy link
Member

@mwhicks1 mwhicks1 Mar 17, 2021

Choose a reason for hiding this comment

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

No return code form this call? Tool.run() below returns an exit code that could cause a return value of false.

Copy link
Member

@mwhicks1 mwhicks1 Mar 17, 2021

Choose a reason for hiding this comment

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

(Same question for the passes below.)

Copy link
Member Author

@kyleheadley kyleheadley Mar 18, 2021

Choose a reason for hiding this comment

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

yep. fixed.

}

if (AdderTool) {
int ToolExitCode = Tool.run(AdderTool.get());
if (ToolExitCode != 0)
return false;
} else
llvm_unreachable("No action");
// // 1a. Add Variables.
// std::unique_ptr<ToolAction> AdderTool = newFrontendActionFactoryA<
// GenericAction<VariableAdderConsumer, ProgramInfo>>(GlobalProgramInfo);
//
// if (AdderTool) {
// int ToolExitCode = Tool.run(AdderTool.get());
// if (ToolExitCode != 0)
// return false;
// } else
// llvm_unreachable("No action");

return true;
}
Expand All @@ -371,18 +378,23 @@ bool _3CInterface::buildInitialConstraints() {

std::lock_guard<std::mutex> Lock(InterfaceMutex);

ClangTool &Tool = getGlobalClangTool();
// ClangTool &Tool = getGlobalClangTool();

// 1b. Gather constraints.
std::unique_ptr<ToolAction> ConstraintTool = newFrontendActionFactoryA<
GenericAction<ConstraintBuilderConsumer, ProgramInfo>>(GlobalProgramInfo);
ConstraintBuilderConsumer CB = ConstraintBuilderConsumer(GlobalProgramInfo, nullptr);
for (auto &TU : ASTs) {
CB.HandleTranslationUnit(TU->getASTContext());
}

if (ConstraintTool) {
int ToolExitCode = Tool.run(ConstraintTool.get());
if (ToolExitCode != 0)
return false;
} else
llvm_unreachable("No action");
// // 1b. Gather constraints.
// std::unique_ptr<ToolAction> ConstraintTool = newFrontendActionFactoryA<
// GenericAction<ConstraintBuilderConsumer, ProgramInfo>>(GlobalProgramInfo);
//
// if (ConstraintTool) {
// int ToolExitCode = Tool.run(ConstraintTool.get());
// if (ToolExitCode != 0)
// return false;
// } else
// llvm_unreachable("No action");

if (!GlobalProgramInfo.link()) {
errs() << "Linking failed!\n";
Expand Down Expand Up @@ -420,7 +432,8 @@ bool _3CInterface::solveConstraints() {
if (DumpIntermediate)
dumpConstraintOutputJson(FINAL_OUTPUT_SUFFIX, GlobalProgramInfo);

ClangTool &Tool = getGlobalClangTool();
// ClangTool &Tool = getGlobalClangTool();

if (AllTypes) {
if (DebugArrSolver)
GlobalProgramInfo.getABoundsInfo().dumpAVarGraph(
Expand All @@ -430,31 +443,42 @@ bool _3CInterface::solveConstraints() {
// bounds declarations.
GlobalProgramInfo.getABoundsInfo().performFlowAnalysis(&GlobalProgramInfo);

// 3. Infer the bounds based on calls to malloc and calloc
std::unique_ptr<ToolAction> ABInfTool = newFrontendActionFactoryA<
GenericAction<AllocBasedBoundsInference, ProgramInfo>>(
GlobalProgramInfo);
if (ABInfTool) {
int ToolExitCode = Tool.run(ABInfTool.get());
if (ToolExitCode != 0)
return false;
} else
llvm_unreachable("No Action");
AllocBasedBoundsInference ABBI = AllocBasedBoundsInference(GlobalProgramInfo, nullptr);
for (auto &TU : ASTs) {
ABBI.HandleTranslationUnit(TU->getASTContext());
}


// // 3. Infer the bounds based on calls to malloc and calloc
// std::unique_ptr<ToolAction> ABInfTool = newFrontendActionFactoryA<
// GenericAction<AllocBasedBoundsInference, ProgramInfo>>(
// GlobalProgramInfo);
// if (ABInfTool) {
// int ToolExitCode = Tool.run(ABInfTool.get());
// if (ToolExitCode != 0)
// return false;
// } else
// llvm_unreachable("No Action");

// Propagate the information from allocator bounds.
GlobalProgramInfo.getABoundsInfo().performFlowAnalysis(&GlobalProgramInfo);
}

// 4. Run intermediate tool hook to run visitors that need to be executed
// after constraint solving but before rewriting.
std::unique_ptr<ToolAction> IMTool = newFrontendActionFactoryA<
GenericAction<IntermediateToolHook, ProgramInfo>>(GlobalProgramInfo);
if (IMTool) {
int ToolExitCode = Tool.run(IMTool.get());
if (ToolExitCode != 0)
return false;
} else
llvm_unreachable("No Action");
IntermediateToolHook ITH = IntermediateToolHook(GlobalProgramInfo, nullptr);
for (auto &TU : ASTs) {
ITH.HandleTranslationUnit(TU->getASTContext());
}

// // 4. Run intermediate tool hook to run visitors that need to be executed
// // after constraint solving but before rewriting.
// std::unique_ptr<ToolAction> IMTool = newFrontendActionFactoryA<
// GenericAction<IntermediateToolHook, ProgramInfo>>(GlobalProgramInfo);
// if (IMTool) {
// int ToolExitCode = Tool.run(IMTool.get());
// if (ToolExitCode != 0)
// return false;
// } else
// llvm_unreachable("No Action");

if (AllTypes) {
// Propagate data-flow information for Array pointers.
Expand Down Expand Up @@ -497,48 +521,61 @@ bool _3CInterface::solveConstraints() {
return true;
}

bool _3CInterface::writeConvertedFileToDisk(const std::string &FilePath) {
std::lock_guard<std::mutex> Lock(InterfaceMutex);
bool RetVal = false;
if (std::find(SourceFiles.begin(), SourceFiles.end(), FilePath) !=
SourceFiles.end()) {
RetVal = true;
std::vector<std::string> SourceFiles;
SourceFiles.clear();
SourceFiles.push_back(FilePath);
// Don't use global tool. Create a new tool for give single file.
ClangTool Tool(*CurrCompDB, SourceFiles);
Tool.appendArgumentsAdjuster(getIgnoreCheckedPointerAdjuster());
std::unique_ptr<ToolAction> RewriteTool =
newFrontendActionFactoryA<RewriteAction<RewriteConsumer, ProgramInfo>>(
GlobalProgramInfo, VerifyDiagnosticOutput);

if (RewriteTool) {
int ToolExitCode = Tool.run(RewriteTool.get());
if (ToolExitCode != 0)
RetVal = false;
}
}
GlobalProgramInfo.getPerfStats().endTotalTime();
GlobalProgramInfo.getPerfStats().startTotalTime();
return RetVal;
}
//bool _3CInterface::writeConvertedFileToDisk(const std::string &FilePath) {
// std::lock_guard<std::mutex> Lock(InterfaceMutex);
// bool RetVal = false;
// if (std::find(SourceFiles.begin(), SourceFiles.end(), FilePath) !=
// SourceFiles.end()) {
// RetVal = true;
// std::vector<std::string> SourceFiles;
// SourceFiles.clear();
// SourceFiles.push_back(FilePath);
// // Don't use global tool. Create a new tool for give single file.
// ClangTool Tool(*CurrCompDB, SourceFiles);
// Tool.appendArgumentsAdjuster(getIgnoreCheckedPointerAdjuster());
//
// RewriteConsumer RC = RewriteConsumer(GlobalProgramInfo);
// for (auto &TU : ASTs) {
// RC.HandleTranslationUnit(TU->getASTContext());
// }
//
//
//// std::unique_ptr<ToolAction> RewriteTool =
//// newFrontendActionFactoryA<RewriteAction<RewriteConsumer, ProgramInfo>>(
//// GlobalProgramInfo, VerifyDiagnosticOutput);
////
//// if (RewriteTool) {
//// int ToolExitCode = Tool.run(RewriteTool.get());
//// if (ToolExitCode != 0)
//// RetVal = false;
//// }
//
// }
// GlobalProgramInfo.getPerfStats().endTotalTime();
// GlobalProgramInfo.getPerfStats().startTotalTime();
// return RetVal;
//}

bool _3CInterface::writeAllConvertedFilesToDisk() {
std::lock_guard<std::mutex> Lock(InterfaceMutex);

ClangTool &Tool = getGlobalClangTool();
// ClangTool &Tool = getGlobalClangTool();

RewriteConsumer RC = RewriteConsumer(GlobalProgramInfo);
for (auto &TU : ASTs) {
RC.HandleTranslationUnit(TU->getASTContext());
}
Copy link
Member

@mwhicks1 mwhicks1 Mar 17, 2021

Choose a reason for hiding this comment

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

After rewriting happens, do you need to delete/free the ASTs? Maybe add another method to free them, to complement the one I'm suggesting you add, to build them?

Copy link
Member Author

@kyleheadley kyleheadley Mar 18, 2021

Choose a reason for hiding this comment

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

From what I could tell the destructors handled everything. That might be different if we had to save/load for memory, or maintain the diagnostics for verification. If you can think of anything else, I'll check it out and add it.


// Rewrite the input files.
std::unique_ptr<ToolAction> RewriteTool =
newFrontendActionFactoryA<RewriteAction<RewriteConsumer, ProgramInfo>>(
GlobalProgramInfo, VerifyDiagnosticOutput);
if (RewriteTool) {
int ToolExitCode = Tool.run(RewriteTool.get());
if (ToolExitCode != 0)
return false;
} else
llvm_unreachable("No action");
// // Rewrite the input files.
// std::unique_ptr<ToolAction> RewriteTool =
// newFrontendActionFactoryA<RewriteAction<RewriteConsumer, ProgramInfo>>(
// GlobalProgramInfo, VerifyDiagnosticOutput);
// if (RewriteTool) {
// int ToolExitCode = Tool.run(RewriteTool.get());
// if (ToolExitCode != 0)
// return false;
// } else
// llvm_unreachable("No action");

GlobalProgramInfo.getPerfStats().endTotalTime();
GlobalProgramInfo.getPerfStats().startTotalTime();
Expand Down