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_TARGET_MANGLER_H
  15 #define LLVM_TARGET_MANGLER_H
  16
  17 #include "llvm/ADT/DenseMap.h"
  18
  19 namespace llvm {
  20
  21 class GlobalValue;
  22 class MCContext;
  23 class MCSymbol;
  24 template <typename T> class SmallVectorImpl;
  25 class TargetMachine;
  26 class Twine;
  27
  28 class Mangler {
  29 public:
  30   enum ManglerPrefixTy {
  31     Default,               ///< Emit default string before each symbol.
  32     Private,               ///< Emit "private" prefix before each symbol.
  33     LinkerPrivate          ///< Emit "linker private" prefix before each symbol.
  34   };
  35
  36 private:
  37   MCContext &Context;
  38   const TargetMachine *TM;
  39
  40   /// AnonGlobalIDs - We need to give global values the same name every time
  41   /// they are mangled.  This keeps track of the number we give to anonymous
  42   /// ones.
  43   ///
  44   DenseMap<const GlobalValue*, unsigned> AnonGlobalIDs;
  45
  46   /// NextAnonGlobalID - This simple counter is used to unique value names.
  47   ///
  48   unsigned NextAnonGlobalID;
  49
  50 public:
  51   Mangler(MCContext &Context, const TargetMachine *TM)
  52     : Context(Context), TM(TM), NextAnonGlobalID(1) {}
  53
  54   /// getSymbol - Return the MCSymbol for the specified global value.  This
  55   /// symbol is the main label that is the address of the global.
  56   MCSymbol *getSymbol(const GlobalValue *GV);
  57
  58   /// getNameWithPrefix - Fill OutName with the name of the appropriate prefix
  59   /// and the specified global variable's name.  If the global variable doesn't
  60   /// have a name, this fills in a unique name for the global.
  61   void getNameWithPrefix(SmallVectorImpl<char> &OutName, const GlobalValue *GV,
  62                          bool isImplicitlyPrivate);
  63
  64   /// getNameWithPrefix - Fill OutName with the name of the appropriate prefix
  65   /// and the specified name as the global variable name.  GVName must not be
  66   /// empty.
  67   void getNameWithPrefix(SmallVectorImpl<char> &OutName, const Twine &GVName,
  68                          ManglerPrefixTy PrefixTy = Mangler::Default);
  69 };
  70
  71 } // End llvm namespace
  72
  73 #endif // LLVM_TARGET_MANGLER_H