llvm-mirror/lib/Transforms/Instrumentation/ProfilePaths/EdgeCode.cpp

//===-- EdgeCode.cpp - generate LLVM instrumentation code -----------------===//
//It implements the class EdgeCode: which provides 
//support for inserting "appropriate" instrumentation at
//designated points in the graph
//
//It also has methods to insert initialization code in 
//top block of cfg
//===----------------------------------------------------------------------===//

#include "llvm/Transforms/Instrumentation/Graph.h"
#include "llvm/Constants.h"
#include "llvm/DerivedTypes.h"
#include "llvm/iMemory.h"
#include "llvm/iTerminators.h"
#include "llvm/iOther.h"
#include "llvm/iOperators.h"
#include "llvm/iPHINode.h"
#include "llvm/Module.h"
#include <stdio.h>

#define INSERT_LOAD_COUNT
#define INSERT_STORE

using std::vector;


static void getTriggerCode(Module *M, BasicBlock *BB, int MethNo, Value *pathNo,
                           Value *cnt, Instruction *InsertPos){ 
  
  vector<const Type*> args;
  //args.push_back(PointerType::get(Type::SByteTy));
  args.push_back(Type::IntTy);
  args.push_back(Type::IntTy);
  args.push_back(Type::IntTy);
  const FunctionType *MTy = FunctionType::get(Type::VoidTy, args, false);

  Function *trigMeth = M->getOrInsertFunction("trigger", MTy);
  assert(trigMeth && "trigger method could not be inserted!");

  vector<Value *> trargs;

  trargs.push_back(ConstantSInt::get(Type::IntTy,MethNo));
  trargs.push_back(pathNo);
  trargs.push_back(cnt);

  Instruction *callInst=new CallInst(trigMeth, trargs, "", InsertPos);
}


//get the code to be inserted on the edge
//This is determined from cond (1-6)
void getEdgeCode::getCode(Instruction *rInst, 
			  Instruction *countInst, 
			  Function *M, 
			  BasicBlock *BB, int numPaths, int MethNo){
  
  Instruction *InsertPos = BB->getInstList().begin();
  
  //case: r=k code to be inserted
  switch(cond){
  case 1:{
    Value *val=ConstantSInt::get(Type::IntTy,inc);
#ifdef INSERT_STORE
    Instruction *stInst=new StoreInst(val, rInst, InsertPos);
#endif
    break;
    }

  //case: r=0 to be inserted
  case 2:
#ifdef INSERT_STORE
    new StoreInst(ConstantSInt::getNullValue(Type::IntTy), rInst, InsertPos);
#endif
    break;
    
  //r+=k
  case 3:{
    Instruction *ldInst = new LoadInst(rInst, "ti1", InsertPos);
    Value *val = ConstantSInt::get(Type::IntTy,inc);
    Value *addIn = BinaryOperator::create(Instruction::Add, ldInst, val,
                                          "ti2", InsertPos);
#ifdef INSERT_STORE
    new StoreInst(addIn, rInst, InsertPos);
#endif
    break;
  }

  //count[inc]++
  case 4:{
    assert(inc>=0 && inc<=numPaths && "inc out of bound!");
   
    Instruction *Idx = new GetElementPtrInst(countInst, 
                 vector<Value*>(1,ConstantSInt::get(Type::LongTy, inc)),
                                             "", InsertPos);

    Instruction *ldInst=new LoadInst(Idx, "ti1", InsertPos);
 
    Value *val = ConstantSInt::get(Type::IntTy, 1);
    Instruction *addIn =
      BinaryOperator::create(Instruction::Add, ldInst, val,"ti2", InsertPos);

#ifdef INSERT_STORE
    Instruction *stInst=new StoreInst(addIn, Idx, InsertPos);
#endif

    //insert trigger
    getTriggerCode(M->getParent(), BB, MethNo, 
		   ConstantSInt::get(Type::IntTy,inc), addIn, InsertPos);
    //end trigger code

    assert(inc>=0 && "IT MUST BE POSITIVE NOW");
    break;
  }

  //case: count[r+inc]++
  case 5:{
   
    //ti1=inc+r
    Instruction *ldIndex=new LoadInst(rInst, "ti1", InsertPos);
    Value *val=ConstantSInt::get(Type::IntTy,inc);
    Instruction *addIndex=BinaryOperator::
      create(Instruction::Add, ldIndex, val,"ti2", InsertPos);
    
    //now load count[addIndex]
    Instruction *castInst=new CastInst(addIndex, 
				       Type::LongTy,"ctin", InsertPos);
    Instruction *Idx = new GetElementPtrInst(countInst, 
                                             vector<Value*>(1,castInst), "",
                                             InsertPos);

    Instruction *ldInst=new LoadInst(Idx, "ti3", InsertPos);
    Value *cons=ConstantSInt::get(Type::IntTy,1);
    //count[addIndex]++
    Value *addIn = BinaryOperator::create(Instruction::Add, ldInst, 
                                          cons,"", InsertPos);
    
#ifdef INSERT_STORE
    Instruction *stInst = new StoreInst(addIn, Idx, InsertPos);
#endif

    //insert trigger
    getTriggerCode(M->getParent(), BB, MethNo, addIndex, addIn, InsertPos);
    //end trigger code

    break;
  }

    //case: count[r]+
  case 6:{
    //ti1=inc+r
    Instruction *ldIndex=new LoadInst(rInst, "ti1", InsertPos);
    
    //now load count[addIndex]
    Instruction *castInst2=new CastInst(ldIndex, Type::LongTy,"ctin",InsertPos);
    Instruction *Idx = new GetElementPtrInst(countInst, 
                                             vector<Value*>(1,castInst2), "",
                                             InsertPos);
    
    Instruction *ldInst=new LoadInst(Idx, "ti2", InsertPos);
    Value *cons=ConstantSInt::get(Type::IntTy,1);

    //count[addIndex]++
    Instruction *addIn=BinaryOperator::create(Instruction::Add, ldInst,
                                              cons,"ti3", InsertPos);

#ifdef INSERT_STORE
    new StoreInst(addIn, Idx, InsertPos);
#endif
    //insert trigger
    getTriggerCode(M->getParent(), BB, MethNo, ldIndex, addIn, InsertPos);
    //end trigger code
    break;
  }
    
  }
  //now check for cdIn and cdOut
  //first put cdOut
  if(cdIn!=NULL){
    cdIn->getCode(rInst, countInst, M, BB, numPaths, MethNo);
  }
  if(cdOut!=NULL){
    cdOut->getCode(rInst, countInst, M, BB, numPaths, MethNo);
  }
}



//Insert the initialization code in the top BB
//this includes initializing r, and count
//r is like an accumulator, that 
//keeps on adding increments as we traverse along a path
//and at the end of the path, r contains the path
//number of that path
//Count is an array, where Count[k] represents
//the number of executions of path k
void insertInTopBB(BasicBlock *front, 
		   int k, 
		   Instruction *rVar, 
		   Instruction *countVar){
  //rVar is variable r, 
  //countVar is array Count, and these are allocatted outside

  Value *Int0 = ConstantInt::get(Type::IntTy, 0);
  
  //now push all instructions in front of the BB
  BasicBlock::iterator here=front->begin();
  front->getInstList().insert(here, rVar);
  front->getInstList().insert(here,countVar);
  
  //Initialize Count[...] with 0

  for (int i=0;i<k; i++){
    Value *GEP2 = new GetElementPtrInst(countVar,
                          vector<Value *>(1,ConstantSInt::get(Type::LongTy, i)),
                                        "", here);
    new StoreInst(Int0, GEP2, here);
  }

  //store uint 0, uint *%R
  new StoreInst(Int0, rVar, here);

  if(front->getParent()->getName() == "main"){
    
    //if its a main function, do the following!
    //A global variable: %llvm_threshold
    //%llvm_threshold = uninitialized global int
    GlobalVariable *threshold = new GlobalVariable(Type::IntTy, false, true, 0,
                                                   "reopt_threshold");

    front->getParent()->getParent()->getGlobalList().push_back(threshold);

    vector<const Type*> initialize_args;
    initialize_args.push_back(PointerType::get(Type::IntTy));
    
    const FunctionType *Fty = FunctionType::get(Type::VoidTy, initialize_args,
                                                false);
    Function *initialMeth = front->getParent()->getParent()->getOrInsertFunction("reoptimizerInitialize", Fty);
    assert(initialMeth && "Initialize method could not be inserted!");
    
    vector<Value *> trargs;
    trargs.push_back(threshold);
  
    new CallInst(initialMeth, trargs, "", front->begin());
  }
}


//insert a basic block with appropriate code
//along a given edge
void insertBB(Edge ed,
	      getEdgeCode *edgeCode, 
	      Instruction *rInst, 
	      Instruction *countInst, 
	      int numPaths, int Methno){

  BasicBlock* BB1=ed.getFirst()->getElement();
  BasicBlock* BB2=ed.getSecond()->getElement();
  
#ifdef DEBUG_PATH_PROFILES
  //debugging info
  cerr<<"Edges with codes ######################\n";
  cerr<<BB1->getName()<<"->"<<BB2->getName()<<"\n";
  cerr<<"########################\n";
#endif
  
  //We need to insert a BB between BB1 and BB2 
  TerminatorInst *TI=BB1->getTerminator();
  BasicBlock *newBB=new BasicBlock("counter", BB1->getParent());

  //Is terminator a branch instruction?
  //then we need to change branch destinations to include new BB

  BranchInst *BI =  cast<BranchInst>(TI);

  if(BI->isUnconditional()){
    BI->setUnconditionalDest(newBB);
    Instruction *newBI2=new BranchInst(BB2);
    newBB->getInstList().push_back(newBI2);
  }
  else{
      if(BI->getSuccessor(0)==BB2)
      BI->setSuccessor(0, newBB);
    
    if(BI->getSuccessor(1)==BB2)
      BI->setSuccessor(1, newBB);

    Instruction *newBI2=new BranchInst(BB2);
    newBB->getInstList().push_back(newBI2);
  }

  //get code for the new BB
  edgeCode->getCode(rInst, countInst, BB1->getParent(), newBB, numPaths, Methno);

  //get code for the new BB
  //now iterate over BB2, and set its Phi nodes right
  for(BasicBlock::iterator BB2Inst = BB2->begin(), BBend = BB2->end(); 
      BB2Inst != BBend; ++BB2Inst){
   
    if(PHINode *phiInst=dyn_cast<PHINode>(&*BB2Inst)){
      int bbIndex=phiInst->getBasicBlockIndex(BB1);
      assert(bbIndex>=0);
      phiInst->setIncomingBlock(bbIndex, newBB);
    }
  }
}