Revert r247684 - Replace Triple with a new TargetTuple ...
[oota-llvm.git] / lib / Target / NVPTX / NVVMReflect.cpp
index 3bbd1a13da029c2e7b6752ed248797c53114865a..20ab5db584d2c10123712594aada0c0be5644e65 100644 (file)
@@ -7,22 +7,29 @@
 //
 //===----------------------------------------------------------------------===//
 //
-// This pass replaces occurences of __nvvm_reflect("string") with an
+// This pass replaces occurrences of __nvvm_reflect("string") with an
 // integer based on -nvvm-reflect-list string=<int> option given to this pass.
+// If an undefined string value is seen in a call to __nvvm_reflect("string"),
+// a default value of 0 will be used.
 //
 //===----------------------------------------------------------------------===//
 
+#include "NVPTX.h"
+#include "llvm/ADT/DenseMap.h"
+#include "llvm/ADT/SmallVector.h"
 #include "llvm/ADT/StringMap.h"
-#include "llvm/Pass.h"
+#include "llvm/IR/Constants.h"
+#include "llvm/IR/DerivedTypes.h"
 #include "llvm/IR/Function.h"
+#include "llvm/IR/Instructions.h"
+#include "llvm/IR/Intrinsics.h"
 #include "llvm/IR/Module.h"
 #include "llvm/IR/Type.h"
-#include "llvm/IR/DerivedTypes.h"
-#include "llvm/IR/Instructions.h"
-#include "llvm/IR/Constants.h"
+#include "llvm/Pass.h"
 #include "llvm/Support/CommandLine.h"
 #include "llvm/Support/Debug.h"
 #include "llvm/Support/raw_os_ostream.h"
+#include "llvm/Support/raw_ostream.h"
 #include "llvm/Transforms/Scalar.h"
 #include <map>
 #include <sstream>
 
 using namespace llvm;
 
+#define DEBUG_TYPE "nvptx-reflect"
+
 namespace llvm { void initializeNVVMReflectPass(PassRegistry &); }
 
 namespace {
-class LLVM_LIBRARY_VISIBILITY NVVMReflect : public ModulePass {
+class NVVMReflect : public ModulePass {
 private:
-  //std::map<std::string, int> VarMap;
   StringMap<int> VarMap;
-  typedef std::map<std::string, int>::iterator VarMapIter;
-  Function *reflectFunction;
+  typedef DenseMap<std::string, int>::iterator VarMapIter;
 
 public:
   static char ID;
   NVVMReflect() : ModulePass(ID) {
+    initializeNVVMReflectPass(*PassRegistry::getPassRegistry());
     VarMap.clear();
-    reflectFunction = 0;
   }
 
-  void getAnalysisUsage(AnalysisUsage &AU) const { AU.setPreservesAll(); }
-  virtual bool runOnModule(Module &);
+  NVVMReflect(const StringMap<int> &Mapping)
+  : ModulePass(ID) {
+    initializeNVVMReflectPass(*PassRegistry::getPassRegistry());
+    for (StringMap<int>::const_iterator I = Mapping.begin(), E = Mapping.end();
+         I != E; ++I) {
+      VarMap[(*I).getKey()] = (*I).getValue();
+    }
+  }
 
+  void getAnalysisUsage(AnalysisUsage &AU) const override {
+    AU.setPreservesAll();
+  }
+  bool runOnModule(Module &) override;
+
+private:
+  bool handleFunction(Function *ReflectFunction);
   void setVarMap();
 };
 }
 
+ModulePass *llvm::createNVVMReflectPass() {
+  return new NVVMReflect();
+}
+
+ModulePass *llvm::createNVVMReflectPass(const StringMap<int>& Mapping) {
+  return new NVVMReflect(Mapping);
+}
+
 static cl::opt<bool>
-NVVMReflectEnabled("nvvm-reflect-enable", cl::init(true),
+NVVMReflectEnabled("nvvm-reflect-enable", cl::init(true), cl::Hidden,
                    cl::desc("NVVM reflection, enabled by default"));
 
 char NVVMReflect::ID = 0;
 INITIALIZE_PASS(NVVMReflect, "nvvm-reflect",
-                "Replace occurences of __nvvm_reflect() calls with 0/1", false,
+                "Replace occurrences of __nvvm_reflect() calls with 0/1", false,
                 false)
 
 static cl::list<std::string>
-ReflectList("nvvm-reflect-list", cl::value_desc("name=0/1"),
-            cl::desc("A list of string=num assignments, where num=0 or 1"),
+ReflectList("nvvm-reflect-list", cl::value_desc("name=<int>"), cl::Hidden,
+            cl::desc("A list of string=num assignments"),
             cl::ValueRequired);
 
-/// This function does the same operation as perl's split.
-/// For example, calling this with ("a=1,b=2,c=0", ",") will
-/// return ["a=1", "b=2", "c=0"] in the return std::vector.
-static std::vector<std::string>
-Tokenize(const std::string &str, const std::string &delim) {
-  std::vector<std::string> tokens;
-
-  size_t p0 = 0, p1 = std::string::npos;
-  while (p0 != std::string::npos) {
-    p1 = str.find_first_of(delim, p0);
-    if (p1 != p0) {
-      std::string token = str.substr(p0, p1 - p0);
-      tokens.push_back(token);
-    }
-    p0 = str.find_first_not_of(delim, p1);
-  }
-
-  return tokens;
-}
-
 /// The command line can look as follows :
-/// -R a=1,b=2 -R c=3,d=0 -R e=2
+/// -nvvm-reflect-list a=1,b=2 -nvvm-reflect-list c=3,d=0 -R e=2
 /// The strings "a=1,b=2", "c=3,d=0", "e=2" are available in the
 /// ReflectList vector. First, each of ReflectList[i] is 'split'
 /// using "," as the delimiter. Then each of this part is split
 /// using "=" as the delimiter.
 void NVVMReflect::setVarMap() {
   for (unsigned i = 0, e = ReflectList.size(); i != e; ++i) {
-    //    DEBUG(dbgs() << "Option : "  << ReflectList[i] << std::endl);
-    std::vector<std::string> nameValList = Tokenize(ReflectList[i], ",");
-    for (unsigned j = 0, ej = nameValList.size(); j != ej; ++j) {
-      std::vector<std::string> nameValPair = Tokenize(nameValList[j], "=");
-      assert(nameValPair.size() == 2 && "name=val expected");
-      std::stringstream valstream(nameValPair[1]);
-      int val;
-      valstream >> val;
-      assert((!(valstream.fail())) && "integer value expected");
-      VarMap[nameValPair[0]] = val;
+    DEBUG(dbgs() << "Option : "  << ReflectList[i] << "\n");
+    SmallVector<StringRef, 4> NameValList;
+    StringRef(ReflectList[i]).split(NameValList, ',');
+    for (unsigned j = 0, ej = NameValList.size(); j != ej; ++j) {
+      SmallVector<StringRef, 2> NameValPair;
+      NameValList[j].split(NameValPair, '=');
+      assert(NameValPair.size() == 2 && "name=val expected");
+      std::stringstream ValStream(NameValPair[1]);
+      int Val;
+      ValStream >> Val;
+      assert((!(ValStream.fail())) && "integer value expected");
+      VarMap[NameValPair[0]] = Val;
     }
   }
 }
 
-bool NVVMReflect::runOnModule(Module &M) {
-  if (!NVVMReflectEnabled)
-    return false;
-
-  setVarMap();
-
-  reflectFunction = M.getFunction(NVVM_REFLECT_FUNCTION);
-
-  // If reflect function is not used, then there will be
-  // no entry in the module.
-  if (reflectFunction == 0) {
-    return false;
-  }
-
+bool NVVMReflect::handleFunction(Function *ReflectFunction) {
   // Validate _reflect function
-  assert(reflectFunction->isDeclaration() &&
+  assert(ReflectFunction->isDeclaration() &&
          "_reflect function should not have a body");
-  assert(reflectFunction->getReturnType()->isIntegerTy() &&
+  assert(ReflectFunction->getReturnType()->isIntegerTy() &&
          "_reflect's return type should be integer");
 
-  std::vector<Instruction *> toRemove;
+  std::vector<Instruction *> ToRemove;
 
-  // Go through the uses of reflectFunction in this Function.
+  // Go through the uses of ReflectFunction in this Function.
   // Each of them should a CallInst with a ConstantArray argument.
   // First validate that. If the c-string corresponding to the
   // ConstantArray can be found successfully, see if it can be
   // found in VarMap. If so, replace the uses of CallInst with the
   // value found in VarMap. If not, replace the use  with value 0.
-  for (Value::use_iterator iter = reflectFunction->use_begin(),
-                           iterEnd = reflectFunction->use_end();
-       iter != iterEnd; ++iter) {
-    assert(isa<CallInst>(*iter) && "Only a call instruction can use _reflect");
-    CallInst *reflect = cast<CallInst>(*iter);
 
-    assert((reflect->getNumOperands() == 2) &&
+  // IR for __nvvm_reflect calls differs between CUDA versions:
+  // CUDA 6.5 and earlier uses this sequence:
+  //    %ptr = tail call i8* @llvm.nvvm.ptr.constant.to.gen.p0i8.p4i8
+  //        (i8 addrspace(4)* getelementptr inbounds
+  //           ([8 x i8], [8 x i8] addrspace(4)* @str, i32 0, i32 0))
+  //    %reflect = tail call i32 @__nvvm_reflect(i8* %ptr)
+  //
+  // Value returned by Sym->getOperand(0) is a Constant with a
+  // ConstantDataSequential operand which can be converted to string and used
+  // for lookup.
+  //
+  // CUDA 7.0 does it slightly differently:
+  //   %reflect = call i32 @__nvvm_reflect(i8* addrspacecast
+  //        (i8 addrspace(1)* getelementptr inbounds
+  //           ([8 x i8], [8 x i8] addrspace(1)* @str, i32 0, i32 0) to i8*))
+  //
+  // In this case, we get a Constant with a GlobalVariable operand and we need
+  // to dig deeper to find its initializer with the string we'll use for lookup.
+
+  for (User *U : ReflectFunction->users()) {
+    assert(isa<CallInst>(U) && "Only a call instruction can use _reflect");
+    CallInst *Reflect = cast<CallInst>(U);
+
+    assert((Reflect->getNumOperands() == 2) &&
            "Only one operand expect for _reflect function");
     // In cuda, we will have an extra constant-to-generic conversion of
     // the string.
-    const Value *conv = reflect->getArgOperand(0);
-    assert(isa<CallInst>(conv) && "Expected a const-to-gen conversion");
-    const CallInst *convcall = cast<CallInst>(conv);
-    const Value *str = convcall->getArgOperand(0);
-    assert(isa<ConstantExpr>(str) &&
+    const Value *Str = Reflect->getArgOperand(0);
+    if (isa<CallInst>(Str)) {
+      // CUDA path
+      const CallInst *ConvCall = cast<CallInst>(Str);
+      Str = ConvCall->getArgOperand(0);
+    }
+    assert(isa<ConstantExpr>(Str) &&
            "Format of _reflect function not recognized");
-    const ConstantExpr *gep = cast<ConstantExpr>(str);
-
-    const Value *sym = gep->getOperand(0);
-    assert(isa<Constant>(sym) && "Format of _reflect function not recognized");
-
-    const Constant *symstr = cast<Constant>(sym);
+    const ConstantExpr *GEP = cast<ConstantExpr>(Str);
+
+    const Value *Sym = GEP->getOperand(0);
+    assert(isa<Constant>(Sym) && "Format of _reflect function not recognized");
+
+    const Value *Operand = cast<Constant>(Sym)->getOperand(0);
+    if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(Operand)) {
+      // For CUDA-7.0 style __nvvm_reflect calls we need to find operand's
+      // initializer.
+      assert(GV->hasInitializer() &&
+             "Format of _reflect function not recognized");
+      const Constant *Initializer = GV->getInitializer();
+      Operand = Initializer;
+    }
 
-    assert(isa<ConstantDataSequential>(symstr->getOperand(0)) &&
+    assert(isa<ConstantDataSequential>(Operand) &&
            "Format of _reflect function not recognized");
-
-    assert(cast<ConstantDataSequential>(symstr->getOperand(0))->isCString() &&
+    assert(cast<ConstantDataSequential>(Operand)->isCString() &&
            "Format of _reflect function not recognized");
 
-    std::string reflectArg =
-        cast<ConstantDataSequential>(symstr->getOperand(0))->getAsString();
+    std::string ReflectArg =
+        cast<ConstantDataSequential>(Operand)->getAsString();
 
-    reflectArg = reflectArg.substr(0, reflectArg.size() - 1);
-    //    DEBUG(dbgs() << "Arg of _reflect : " << reflectArg << std::endl);
+    ReflectArg = ReflectArg.substr(0, ReflectArg.size() - 1);
+    DEBUG(dbgs() << "Arg of _reflect : " << ReflectArg << "\n");
 
-    int reflectVal = 0; // The default value is 0
-    if (VarMap.find(reflectArg) != VarMap.end()) {
-      reflectVal = VarMap[reflectArg];
+    int ReflectVal = 0; // The default value is 0
+    if (VarMap.find(ReflectArg) != VarMap.end()) {
+      ReflectVal = VarMap[ReflectArg];
     }
-    reflect->replaceAllUsesWith(
-        ConstantInt::get(reflect->getType(), reflectVal));
-    toRemove.push_back(reflect);
+    Reflect->replaceAllUsesWith(
+        ConstantInt::get(Reflect->getType(), ReflectVal));
+    ToRemove.push_back(Reflect);
   }
-  if (toRemove.size() == 0)
+  if (ToRemove.size() == 0)
     return false;
 
-  for (unsigned i = 0, e = toRemove.size(); i != e; ++i)
-    toRemove[i]->eraseFromParent();
+  for (unsigned i = 0, e = ToRemove.size(); i != e; ++i)
+    ToRemove[i]->eraseFromParent();
   return true;
 }
+
+bool NVVMReflect::runOnModule(Module &M) {
+  if (!NVVMReflectEnabled)
+    return false;
+
+  setVarMap();
+
+
+  bool Res = false;
+  std::string Name;
+  Type *Tys[1];
+  Type *I8Ty = Type::getInt8Ty(M.getContext());
+  Function *ReflectFunction;
+
+  // Check for standard overloaded versions of llvm.nvvm.reflect
+
+  for (unsigned i = 0; i != 5; ++i) {
+    Tys[0] = PointerType::get(I8Ty, i);
+    Name = Intrinsic::getName(Intrinsic::nvvm_reflect, Tys);
+    ReflectFunction = M.getFunction(Name);
+    if(ReflectFunction != 0) {
+      Res |= handleFunction(ReflectFunction);
+    }
+  }
+
+  ReflectFunction = M.getFunction(NVVM_REFLECT_FUNCTION);
+  // If reflect function is not used, then there will be
+  // no entry in the module.
+  if (ReflectFunction != 0)
+    Res |= handleFunction(ReflectFunction);
+
+  return Res;
+}