//===- DebugInstrumentation.h - Adds debug information to run-time checks ----//
// 
//                     The LLVM Compiler Infrastructure
//
// This file was developed by the LLVM research group and is distributed under
// the University of Illinois Open Source License. See LICENSE.TXT for details.
// 
//===----------------------------------------------------------------------===//
//
// This pass modifies calls to the pool allocator and SAFECode run-times to
// track source level debugging information.
//
//===----------------------------------------------------------------------===//

#ifndef DEBUG_INSTRUMENTATION_H
#define DEBUG_INSTRUMENTATION_H

#include "llvm/Pass.h"
#include "llvm/IR/Instructions.h"
#include "llvm/IR/Type.h"
#include "llvm/IR/Value.h"

#include <map>
#include <string>
#include <utility>

namespace llvm {

class GetSourceInfo {
  protected:
    // The ID for debug metadata
    unsigned dbgKind;

  public:
    GetSourceInfo (unsigned dbgKindID) : dbgKind(dbgKindID) {}
    virtual std::pair<Value *, Value *> operator() (CallInst * I) = 0;
    virtual ~GetSourceInfo();
};

class LocationSourceInfo : public GetSourceInfo {
  protected:
    // Cache of file names which already have a global variable for them
    std::map<std::string, Value *> SourceFileMap;

  public:
    LocationSourceInfo (unsigned dbgKindID) : GetSourceInfo (dbgKindID) {}
    virtual std::pair<Value *, Value *> operator() (CallInst * I);
};

class VariableSourceInfo : public GetSourceInfo {
  protected:
    // Cache of file names which already have a global variable for them
    std::map<std::string, Value *> SourceFileMap;

  public:
    VariableSourceInfo (unsigned dbgKindID) : GetSourceInfo (dbgKindID) {}
    virtual std::pair<Value *, Value *> operator() (CallInst * I);
};

struct DebugInstrument : public ModulePass {
  public:
    static char ID;

    virtual bool runOnModule(Module &M);
    DebugInstrument () : ModulePass (ID) {
      return;
    }

    const char *getPassName() const {
      return "SAFECode Debug Instrumentation Pass";
    }

    virtual void getAnalysisUsage(AnalysisUsage &AU) const {
      AU.setPreservesCFG();
      AU.setPreservesAll();
    };

  private:
    // LLVM type for void pointers (void *)
    Type * VoidPtrTy;

    // Private methods
    void transformFunction (Function * F, GetSourceInfo & SI);
};

}

#endif