blob: 7f084a377f0c7a1f4d127e19b20b73d5064d6bc5 [file] [log] [blame]
//===-- DifferenceEngine.h - Module comparator ------------------*- C++ -*-===//
// The LLVM Compiler Infrastructure
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
// This header defines the interface to the LLVM difference engine,
// which structurally compares functions within a module.
#include "DiffConsumer.h"
#include "DiffLog.h"
#include "llvm/ADT/StringRef.h"
#include <utility>
namespace llvm {
class Function;
class GlobalValue;
class Instruction;
class LLVMContext;
class Module;
class Twine;
class Value;
/// A class for performing structural comparisons of LLVM assembly.
class DifferenceEngine {
/// A RAII object for recording the current context.
struct Context {
Context(DifferenceEngine &Engine, Value *L, Value *R) : Engine(Engine) {
Engine.consumer.enterContext(L, R);
~Context() {
DifferenceEngine &Engine;
/// An oracle for answering whether two values are equivalent as
/// operands.
class Oracle {
virtual void anchor();
virtual bool operator()(Value *L, Value *R) = 0;
virtual ~Oracle() {}
DifferenceEngine(Consumer &consumer)
: consumer(consumer), globalValueOracle(nullptr) {}
void diff(Module *L, Module *R);
void diff(Function *L, Function *R);
void log(StringRef text) {
LogBuilder logf(StringRef text) {
return LogBuilder(consumer, text);
Consumer& getConsumer() const { return consumer; }
/// Installs an oracle to decide whether two global values are
/// equivalent as operands. Without an oracle, global values are
/// considered equivalent as operands precisely when they have the
/// same name.
void setGlobalValueOracle(Oracle *oracle) {
globalValueOracle = oracle;
/// Determines whether two global values are equivalent.
bool equivalentAsOperands(GlobalValue *L, GlobalValue *R);
Consumer &consumer;
Oracle *globalValueOracle;