include/llvm/Target/Mangler.h

   1 //===-- llvm/Target/Mangler.h - Self-contained name mangler -----*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // Unified name mangler for various backends.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_SUPPORT_MANGLER_H
  15 #define LLVM_SUPPORT_MANGLER_H
  16
  17 #include "llvm/ADT/DenseMap.h"
  18 #include <string>
  19
  20 namespace llvm {
  21 class StringRef;
  22 class Twine;
  23 class Value;
  24 class GlobalValue;
  25 template <typename T> class SmallVectorImpl;
  26 class MCContext;
  27 class MCSymbol;
  28 class TargetData;
  29
  30 class Mangler {
  31 public:
  32   enum ManglerPrefixTy {
  33     Default,               ///< Emit default string before each symbol.
  34     Private,               ///< Emit "private" prefix before each symbol.
  35     LinkerPrivate          ///< Emit "linker private" prefix before each symbol.
  36   };
  37
  38 private:
  39   MCContext &Context;
  40   const TargetData &TD;
  41
  42   /// AnonGlobalIDs - We need to give global values the same name every time
  43   /// they are mangled.  This keeps track of the number we give to anonymous
  44   /// ones.
  45   ///
  46   DenseMap<const GlobalValue*, unsigned> AnonGlobalIDs;
  47
  48   /// NextAnonGlobalID - This simple counter is used to unique value names.
  49   ///
  50   unsigned NextAnonGlobalID;
  51
  52 public:
  53   Mangler(MCContext &context, const TargetData &td)
  54     : Context(context), TD(td), NextAnonGlobalID(1) {}
  55
  56   /// getSymbol - Return the MCSymbol for the specified global value.  This
  57   /// symbol is the main label that is the address of the global.
  58   MCSymbol *getSymbol(const GlobalValue *GV);
  59
  60
  61   /// getNameWithPrefix - Fill OutName with the name of the appropriate prefix
  62   /// and the specified global variable's name.  If the global variable doesn't
  63   /// have a name, this fills in a unique name for the global.
  64   void getNameWithPrefix(SmallVectorImpl<char> &OutName, const GlobalValue *GV,
  65                          bool isImplicitlyPrivate);
  66
  67   /// getNameWithPrefix - Fill OutName with the name of the appropriate prefix
  68   /// and the specified name as the global variable name.  GVName must not be
  69   /// empty.
  70   void getNameWithPrefix(SmallVectorImpl<char> &OutName, const Twine &GVName,
  71                          ManglerPrefixTy PrefixTy = Mangler::Default);
  72
  73   /// getNameWithPrefix - Return the name of the appropriate prefix
  74   /// and the specified global variable's name.  If the global variable doesn't
  75   /// have a name, this fills in a unique name for the global.
  76   std::string getNameWithPrefix(const GlobalValue *GV,
  77                                 bool isImplicitlyPrivate = false);
  78 };
  79
  80 } // End llvm namespace
  81
  82 #endif // LLVM_SUPPORT_MANGLER_H