lib/VMCore/Mangler.cpp

   1 //===-- Mangler.cpp - Self-contained c/asm llvm name mangler --------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // Unified name mangler for CWriter and assembly backends.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/Support/Mangler.h"
  15 #include "llvm/DerivedTypes.h"
  16 #include "llvm/Module.h"
  17 #include "llvm/ADT/StringExtras.h"
  18 using namespace llvm;
  19
  20 static char HexDigit(int V) {
  21   return V < 10 ? V+'0' : V+'A'-10;
  22 }
  23
  24 static std::string MangleLetter(unsigned char C) {
  25   return std::string("_")+HexDigit(C >> 4) + HexDigit(C & 15) + "_";
  26 }
  27
  28 /// makeNameProper - We don't want identifier names non-C-identifier characters
  29 /// in them, so mangle them as appropriate.
  30 ///
  31 std::string Mangler::makeNameProper(const std::string &X, const char *Prefix) {
  32   std::string Result;
  33
  34   if (!UseQuotes) {
  35     // If X does not start with (char)1, add the prefix.
  36     std::string::const_iterator I = X.begin();
  37     if (*I != 1)
  38       Result = Prefix;
  39     else
  40       ++I;  // Skip over the marker.
  41
  42     // Mangle the first letter specially, don't allow numbers...
  43     if (*I >= '0' && *I <= '9')
  44       Result += MangleLetter(*I++);
  45
  46     for (std::string::const_iterator E = X.end(); I != E; ++I)
  47       if ((*I < 'a' || *I > 'z') && (*I < 'A' || *I > 'Z') &&
  48           (*I < '0' || *I > '9') && *I != '_' && *I != '$')
  49         Result += MangleLetter(*I);
  50       else
  51         Result += *I;
  52   } else {
  53     bool NeedsQuotes = false;
  54
  55     // If X does not start with (char)1, add the prefix.
  56     std::string::const_iterator I = X.begin();
  57     if (*I != 1)
  58       Result = Prefix;
  59     else
  60       ++I;  // Skip over the marker.
  61
  62     // If the first character is a number, we need quotes.
  63     if (*I >= '0' && *I <= '9')
  64       NeedsQuotes = true;
  65
  66     for (std::string::const_iterator E = X.end(); I != E; ++I)
  67       if (*I == '"')
  68         Result += "_QQ_";
  69       else {
  70         if ((*I < 'a' || *I > 'z') && (*I < 'A' || *I > 'Z') &&
  71             (*I < '0' || *I > '9') && *I != '_' && *I != '$' && *I != '.')
  72           NeedsQuotes = true;
  73         Result += *I;
  74       }
  75     if (NeedsQuotes)
  76       Result = '"' + Result + '"';
  77   }
  78   return Result;
  79 }
  80
  81 /// getTypeID - Return a unique ID for the specified LLVM type.
  82 ///
  83 unsigned Mangler::getTypeID(const Type *Ty) {
  84   unsigned &E = TypeMap[Ty];
  85   if (E == 0) E = ++TypeCounter;
  86   return E;
  87 }
  88
  89 std::string Mangler::getValueName(const Value *V) {
  90   if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
  91     return getValueName(GV);
  92
  93   std::string &Name = Memo[V];
  94   if (!Name.empty())
  95     return Name;       // Return the already-computed name for V.
  96
  97   // Always mangle local names.
  98   Name = "ltmp_" + utostr(Count++) + "_" + utostr(getTypeID(V->getType()));
  99   return Name;
 100 }
 101
 102
 103 std::string Mangler::getValueName(const GlobalValue *GV) {
 104   // Check to see whether we've already named V.
 105   std::string &Name = Memo[GV];
 106   if (!Name.empty())
 107     return Name;       // Return the already-computed name for V.
 108
 109   // Name mangling occurs as follows:
 110   // - If V is an intrinsic function, do not change name at all
 111   // - Otherwise, mangling occurs if global collides with existing name.
 112   if (isa<Function>(GV) && cast<Function>(GV)->getIntrinsicID()) {
 113     Name = GV->getName(); // Is an intrinsic function
 114   } else if (!MangledGlobals.count(GV)) {
 115     Name = makeNameProper(GV->getName(), Prefix);
 116   } else {
 117     unsigned TypeUniqueID = getTypeID(GV->getType());
 118     Name = "l" + utostr(TypeUniqueID) + "_" + makeNameProper(GV->getName());
 119   }
 120
 121   return Name;
 122 }
 123
 124 void Mangler::InsertName(GlobalValue *GV,
 125                          std::map<std::string, GlobalValue*> &Names) {
 126   if (!GV->hasName()) {   // We must mangle unnamed globals.
 127     MangledGlobals.insert(GV);
 128     return;
 129   }
 130
 131   // Figure out if this is already used.
 132   GlobalValue *&ExistingValue = Names[GV->getName()];
 133   if (!ExistingValue) {
 134     ExistingValue = GV;
 135   } else {
 136     // If GV is external but the existing one is static, mangle the existing one
 137     if (GV->hasExternalLinkage() && !ExistingValue->hasExternalLinkage()) {
 138       MangledGlobals.insert(ExistingValue);
 139       ExistingValue = GV;
 140     } else {
 141       // Otherwise, mangle GV
 142       MangledGlobals.insert(GV);
 143     }
 144   }
 145 }
 146
 147
 148 Mangler::Mangler(Module &M, const char *prefix)
 149   : Prefix(prefix), UseQuotes(false), Count(0), TypeCounter(0) {
 150   // Calculate which global values have names that will collide when we throw
 151   // away type information.
 152   std::map<std::string, GlobalValue*> Names;
 153   for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
 154     InsertName(I, Names);
 155   for (Module::global_iterator I = M.global_begin(), E = M.global_end(); I != E; ++I)
 156     InsertName(I, Names);
 157 }