Magic-Mirror/llvm-capstone
1
0
Fork 0
mirror of https://github.com/capstone-engine/llvm-capstone.git synced 2024-11-25 14:50:26 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

[IRSim] Adding basic implementation of llvm-sim.

Browse Source 
This is a similarity visualization tool that accepts a Module and
passes it to the IRSimilarityIdentifier.  The resulting SimilarityGroups
are output in a JSON file.

Tests are found in test/tools/llvm-sim and check for the file not found,
a bad module, and that the JSON is created correctly.

Reviewers: paquette, jroelofs

Differential Revision: https://reviews.llvm.org/D86974
This commit is contained in:
Andrew Litteken 2020-09-17 15:43:40 -05:00
parent 2a0ca17f66
commit 15645d044b
8 changed files with 324 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
llvm/test/tools/llvm-sim/Inputs/sim1.ll Normal file
View File

@ -0,0 +1,27 @@
define void @similar_func1() {
entry:
%a = alloca i32, align 4
%b = alloca i32, align 4
%c = alloca i32, align 4
store i32 2, i32* %a, align 4
store i32 3, i32* %b, align 4
store i32 4, i32* %c, align 4
%al = load i32, i32* %a
%bl = load i32, i32* %b
%cl = load i32, i32* %c
ret void
}
define void @similar_func2() {
entry:
%a = alloca i32, align 4
%b = alloca i32, align 4
%c = alloca i32, align 4
store i32 2, i32* %a, align 4
store i32 3, i32* %b, align 4
store i32 4, i32* %c, align 4
%al = load i32, i32* %a
%bl = load i32, i32* %b
%cl = load i32, i32* %c
ret void
}

8
llvm/test/tools/llvm-sim/fail-cases.test Normal file
View File

@ -0,0 +1,8 @@
# RUN: not llvm-sim %s 2>&1 | FileCheck %s
# RUN: not llvm-sim %s.2 2>&1 | FileCheck %s -check-prefix=EXIST
# File reading error messaging tests.
# CHECK: error: expected top-level entity
# EXIST: error: Could not open input file: No such file or directory

57
llvm/test/tools/llvm-sim/single-sim-file.test Normal file
View File

@ -0,0 +1,57 @@
# RUN: llvm-sim -o %t %S/Inputs/sim1.ll
# RUN: cat %t | FileCheck %s
# Checking the output of a single module test.
# CHECK: {
# CHECK-NEXT: "1": [
# CHECK-NEXT: {
# CHECK-NEXT: "start": 8,
# CHECK-NEXT: "end": 9
# CHECK-NEXT: },
# CHECK-NEXT: {
# CHECK-NEXT: "start": 18,
# CHECK-NEXT: "end": 19
# CHECK-NEXT: }
# CHECK-NEXT: ],
# CHECK-NEXT: "2": [
# CHECK-NEXT: {
# CHECK-NEXT: "start": 7,
# CHECK-NEXT: "end": 9
# CHECK-NEXT: },
# CHECK-NEXT: {
# CHECK-NEXT: "start": 17,
# CHECK-NEXT: "end": 19
# CHECK-NEXT: }
# CHECK-NEXT: ],
# CHECK-NEXT: "3": [
# CHECK-NEXT: {
# CHECK-NEXT: "start": 6,
# CHECK-NEXT: "end": 9
# CHECK-NEXT: },
# CHECK-NEXT: {
# CHECK-NEXT: "start": 16,
# CHECK-NEXT: "end": 19
# CHECK-NEXT: }
# CHECK-NEXT: ],
# CHECK-NEXT: "4": [
# CHECK-NEXT: {
# CHECK-NEXT: "start": 5,
# CHECK-NEXT: "end": 9
# CHECK-NEXT: },
# CHECK-NEXT: {
# CHECK-NEXT: "start": 15,
# CHECK-NEXT: "end": 19
# CHECK-NEXT: }
# CHECK-NEXT: ],
# CHECK-NEXT: "5": [
# CHECK-NEXT: {
# CHECK-NEXT: "start": 4,
# CHECK-NEXT: "end": 9
# CHECK-NEXT: },
# CHECK-NEXT: {
# CHECK-NEXT: "start": 14,
# CHECK-NEXT: "end": 19
# CHECK-NEXT: }
# CHECK-NEXT: ]
# CHECK-NEXT: }

56
llvm/test/tools/llvm-sim/single-sim.test Normal file
View File

@ -0,0 +1,56 @@
# RUN: llvm-sim -o - %S/Inputs/sim1.ll | FileCheck %s
# Checking the output of a single module test.
# CHECK: {
# CHECK-NEXT: "1": [
# CHECK-NEXT: {
# CHECK-NEXT: "start": 8,
# CHECK-NEXT: "end": 9
# CHECK-NEXT: },
# CHECK-NEXT: {
# CHECK-NEXT: "start": 18,
# CHECK-NEXT: "end": 19
# CHECK-NEXT: }
# CHECK-NEXT: ],
# CHECK-NEXT: "2": [
# CHECK-NEXT: {
# CHECK-NEXT: "start": 7,
# CHECK-NEXT: "end": 9
# CHECK-NEXT: },
# CHECK-NEXT: {
# CHECK-NEXT: "start": 17,
# CHECK-NEXT: "end": 19
# CHECK-NEXT: }
# CHECK-NEXT: ],
# CHECK-NEXT: "3": [
# CHECK-NEXT: {
# CHECK-NEXT: "start": 6,
# CHECK-NEXT: "end": 9
# CHECK-NEXT: },
# CHECK-NEXT: {
# CHECK-NEXT: "start": 16,
# CHECK-NEXT: "end": 19
# CHECK-NEXT: }
# CHECK-NEXT: ],
# CHECK-NEXT: "4": [
# CHECK-NEXT: {
# CHECK-NEXT: "start": 5,
# CHECK-NEXT: "end": 9
# CHECK-NEXT: },
# CHECK-NEXT: {
# CHECK-NEXT: "start": 15,
# CHECK-NEXT: "end": 19
# CHECK-NEXT: }
# CHECK-NEXT: ],
# CHECK-NEXT: "5": [
# CHECK-NEXT: {
# CHECK-NEXT: "start": 4,
# CHECK-NEXT: "end": 9
# CHECK-NEXT: },
# CHECK-NEXT: {
# CHECK-NEXT: "start": 14,
# CHECK-NEXT: "end": 19
# CHECK-NEXT: }
# CHECK-NEXT: ]
# CHECK-NEXT: }

1
llvm/tools/LLVMBuild.txt
View File

@ -51,6 +51,7 @@ subdirectories =
llvm-rc
llvm-reduce
llvm-rtdyld
llvm-sim
llvm-size
llvm-split
llvm-undname

5
llvm/tools/llvm-sim/CMakeLists.txt Normal file
View File

@ -0,0 +1,5 @@
set(LLVM_LINK_COMPONENTS core support object coverage AsmParser IRReader TransformUtils ipo)
add_llvm_tool(llvm-sim
llvm-sim.cpp
)

21
llvm/tools/llvm-sim/LLVMBuild.txt Normal file
View File

@ -0,0 +1,21 @@
;===- ./tools/llvm-sim/LLVMBuild.txt ---------------------------*- Conf -*--===;
;
; Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
; See https://llvm.org/LICENSE.txt for license information.
; SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
;
;===------------------------------------------------------------------------===;
;
; This is an LLVMBuild description file for the components in this subdirectory.
;
; For more information on the LLVMBuild system, please see:
;
; http://llvm.org/docs/LLVMBuild.html
;
;===------------------------------------------------------------------------===;
[component_0]
type = Tool
name = llvm-sim
parent = Tools
required_libraries = Core Support AsmParser IRReader IPO

149
llvm/tools/llvm-sim/llvm-sim.cpp Normal file
View File

@ -0,0 +1,149 @@
//===-- llvm-sim.cpp - Find similar sections of programs -------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
// This program finds similar sections of a Module, and exports them as a JSON
// file.
//
// To find similarities contained across multiple modules, please use llvm-link
// first to merge the modules.
//
//===----------------------------------------------------------------------===//
#include "llvm/Analysis/IRSimilarityIdentifier.h"
#include "llvm/IRReader/IRReader.h"
#include "llvm/Support/CommandLine.h"
#include "llvm/Support/FileSystem.h"
#include "llvm/Support/InitLLVM.h"
#include "llvm/Support/JSON.h"
#include "llvm/Support/SourceMgr.h"
#include "llvm/Support/ToolOutputFile.h"
using namespace llvm;
using namespace IRSimilarity;
static cl::opt<std::string> OutputFilename("o", cl::desc("Output Filename"),
cl::init("-"),
cl::value_desc("filename"));
static cl::opt<std::string> InputSourceFile(cl::Positional,
cl::desc("<Source file>"),
cl::init("-"),
cl::value_desc("filename"));
/// Retrieve the unique number \p I was mapped to in parseBitcodeFile.
///
/// \param I - The Instruction to find the instruction number for.
/// \param LLVMInstNum - The mapping of Instructions to their location in the
/// module represented by an unsigned integer.
/// \returns The instruction number for \p I if it exists.
Optional<unsigned>
getPositionInModule(const Instruction *I,
const DenseMap<Instruction *, unsigned> &LLVMInstNum) {
assert(I && "Instruction is nullptr!");
DenseMap<Instruction *, unsigned>::const_iterator It = LLVMInstNum.find(I);
if (It == LLVMInstNum.end())
return None;
return It->second;
}
/// Exports the given SimilarityGroups to a JSON file at \p FilePath.
///
/// \param FilePath - The path to the output location.
/// \param SimSections - The similarity groups to process.
/// \param LLVMInstNum - The mapping of Instructions to their location in the
/// module represented by an unsigned integer.
/// \returns A nonzero error code if there was a failure creating the file.
std::error_code
exportToFile(const StringRef FilePath,
const SimilarityGroupList &SimSections,
const DenseMap<Instruction *, unsigned> &LLVMInstNum) {
std::error_code EC;
std::unique_ptr<ToolOutputFile> Out(
new ToolOutputFile(FilePath, EC, sys::fs::OF_None));
if (EC)
return EC;
json::OStream J(Out->os(), 1);
J.objectBegin();
unsigned SimOption = 1;
// Process each list of SimilarityGroups organized by the Module.
for (const SimilarityGroup &G : SimSections) {
std::string SimOptionStr = std::to_string(SimOption);
J.attributeBegin(SimOptionStr);
J.arrayBegin();
// For each file there is a list of the range where the similarity
// exists.
for (const IRSimilarityCandidate &C : G) {
Optional<unsigned> Start =
getPositionInModule((*C.front()).Inst, LLVMInstNum);
Optional<unsigned> End =
getPositionInModule((*C.back()).Inst, LLVMInstNum);
assert(Start.hasValue() &&
"Could not find instruction number for first instruction");
assert(End.hasValue() &&
"Could not find instruction number for last instruction");
J.object([&] {
J.attribute("start", Start.getValue());
J.attribute("end", End.getValue());
});
}
J.arrayEnd();
J.attributeEnd();
SimOption++;
}
J.objectEnd();
Out->keep();
return EC;
}
int main(int argc, const char *argv[]) {
InitLLVM X(argc, argv);
cl::ParseCommandLineOptions(argc, argv, "LLVM IR Similarity Visualizer\n");
LLVMContext CurrContext;
SMDiagnostic Err;
std::unique_ptr<Module> ModuleToAnalyze =
parseIRFile(InputSourceFile, Err, CurrContext);
if (!ModuleToAnalyze) {
Err.print(argv[0], errs());
return 1;
}
// Mapping from an Instruction pointer to its occurrence in a sequential
// list of all the Instructions in a Module.
DenseMap<Instruction *, unsigned> LLVMInstNum;
// We give each instruction a number, which gives us a start and end value
// for the beginning and end of each IRSimilarityCandidate.
unsigned InstructionNumber = 1;
for (Function &F : *ModuleToAnalyze)
for (BasicBlock &BB : F)
for (Instruction &I : BB.instructionsWithoutDebug())
LLVMInstNum[&I]= InstructionNumber++;
// The similarity identifier we will use to find the similar sections.
IRSimilarityIdentifier SimIdent;
SimilarityGroupList SimilaritySections =
SimIdent.findSimilarity(*ModuleToAnalyze);
std::error_code E =
exportToFile(OutputFilename, SimilaritySections, LLVMInstNum);
if (E) {
errs() << argv[0] << ": " << E.message() << '\n';
return 2;
}
return 0;
}