ValueSymbolTable.h revision 321369
1179100Syongari//===- llvm/ValueSymbolTable.h - Implement a Value Symtab -------*- C++ -*-===// 2179100Syongari// 3179100Syongari// The LLVM Compiler Infrastructure 4179100Syongari// 5179100Syongari// This file is distributed under the University of Illinois Open Source 6179100Syongari// License. See LICENSE.TXT for details. 7179100Syongari// 8179100Syongari//===----------------------------------------------------------------------===// 9179100Syongari// 10179100Syongari// This file implements the name/Value symbol table for LLVM. 11179100Syongari// 12179100Syongari//===----------------------------------------------------------------------===// 13179100Syongari 14179100Syongari#ifndef LLVM_IR_VALUESYMBOLTABLE_H 15179100Syongari#define LLVM_IR_VALUESYMBOLTABLE_H 16179100Syongari 17179100Syongari#include "llvm/ADT/StringMap.h" 18179100Syongari#include "llvm/ADT/StringRef.h" 19179100Syongari#include "llvm/IR/Value.h" 20179100Syongari#include <cstdint> 21179100Syongari 22179100Syongarinamespace llvm { 23179100Syongari 24179100Syongariclass Argument; 25179100Syongariclass BasicBlock; 26179100Syongariclass Function; 27179100Syongariclass GlobalAlias; 28179100Syongariclass GlobalIFunc; 29179100Syongariclass GlobalVariable; 30179100Syongariclass Instruction; 31179100Syongaritemplate <unsigned InternalLen> class SmallString; 32179100Syongaritemplate <typename ValueSubClass> class SymbolTableListTraits; 33179100Syongari 34179100Syongari/// This class provides a symbol table of name/value pairs. It is essentially 35179100Syongari/// a std::map<std::string,Value*> but has a controlled interface provided by 36179100Syongari/// LLVM as well as ensuring uniqueness of names. 37179100Syongari/// 38179100Syongariclass ValueSymbolTable { 39179100Syongari friend class SymbolTableListTraits<Argument>; 40179100Syongari friend class SymbolTableListTraits<BasicBlock>; 41179100Syongari friend class SymbolTableListTraits<Function>; 42179100Syongari friend class SymbolTableListTraits<GlobalAlias>; 43179100Syongari friend class SymbolTableListTraits<GlobalIFunc>; 44179100Syongari friend class SymbolTableListTraits<GlobalVariable>; 45179100Syongari friend class SymbolTableListTraits<Instruction>; 46179100Syongari friend class Value; 47179100Syongari 48179100Syongari/// @name Types 49179100Syongari/// @{ 50257176Sglebiuspublic: 51179100Syongari /// @brief A mapping of names to values. 52179100Syongari using ValueMap = StringMap<Value*>; 53179100Syongari 54179100Syongari /// @brief An iterator over a ValueMap. 55179100Syongari using iterator = ValueMap::iterator; 56179100Syongari 57179100Syongari /// @brief A const_iterator over a ValueMap. 58179100Syongari using const_iterator = ValueMap::const_iterator; 59179100Syongari 60179100Syongari/// @} 61179100Syongari/// @name Constructors 62179100Syongari/// @{ 63179100Syongari 64179100Syongari ValueSymbolTable() : vmap(0) {} 65179100Syongari ~ValueSymbolTable(); 66179100Syongari 67179100Syongari/// @} 68179100Syongari/// @name Accessors 69179100Syongari/// @{ 70179100Syongari 71179100Syongari /// This method finds the value with the given \p Name in the 72179100Syongari /// the symbol table. 73179100Syongari /// @returns the value associated with the \p Name 74179100Syongari /// @brief Lookup a named Value. 75179100Syongari Value *lookup(StringRef Name) const { return vmap.lookup(Name); } 76179100Syongari 77179100Syongari /// @returns true iff the symbol table is empty 78179100Syongari /// @brief Determine if the symbol table is empty 79179100Syongari inline bool empty() const { return vmap.empty(); } 80179100Syongari 81179100Syongari /// @brief The number of name/type pairs is returned. 82179100Syongari inline unsigned size() const { return unsigned(vmap.size()); } 83179100Syongari 84179100Syongari /// This function can be used from the debugger to display the 85179100Syongari /// content of the symbol table while debugging. 86179100Syongari /// @brief Print out symbol table on stderr 87179100Syongari void dump() const; 88179100Syongari 89179100Syongari/// @} 90179100Syongari/// @name Iteration 91179100Syongari/// @{ 92179100Syongari 93179100Syongari /// @brief Get an iterator that from the beginning of the symbol table. 94179100Syongari inline iterator begin() { return vmap.begin(); } 95179100Syongari 96179100Syongari /// @brief Get a const_iterator that from the beginning of the symbol table. 97179100Syongari inline const_iterator begin() const { return vmap.begin(); } 98179100Syongari 99179100Syongari /// @brief Get an iterator to the end of the symbol table. 100179100Syongari inline iterator end() { return vmap.end(); } 101179100Syongari 102179100Syongari /// @brief Get a const_iterator to the end of the symbol table. 103179100Syongari inline const_iterator end() const { return vmap.end(); } 104179100Syongari 105179100Syongari /// @} 106179100Syongari /// @name Mutators 107179100Syongari /// @{ 108179100Syongariprivate: 109179100Syongari ValueName *makeUniqueName(Value *V, SmallString<256> &UniqueName); 110179100Syongari 111179100Syongari /// This method adds the provided value \p N to the symbol table. The Value 112179100Syongari /// must have a name which is used to place the value in the symbol table. 113179100Syongari /// If the inserted name conflicts, this renames the value. 114179100Syongari /// @brief Add a named value to the symbol table 115179100Syongari void reinsertValue(Value *V); 116179100Syongari 117179100Syongari /// createValueName - This method attempts to create a value name and insert 118179100Syongari /// it into the symbol table with the specified name. If it conflicts, it 119179100Syongari /// auto-renames the name and returns that instead. 120179100Syongari ValueName *createValueName(StringRef Name, Value *V); 121179100Syongari 122179100Syongari /// This method removes a value from the symbol table. It leaves the 123216925Sjhb /// ValueName attached to the value, but it is no longer inserted in the 124179100Syongari /// symtab. 125179100Syongari void removeValueName(ValueName *V); 126179100Syongari 127179100Syongari /// @} 128179100Syongari /// @name Internal Data 129179100Syongari /// @{ 130179100Syongari 131179100Syongari ValueMap vmap; ///< The map that holds the symbol table. 132179100Syongari mutable uint32_t LastUnique = 0; ///< Counter for tracking unique names 133179100Syongari 134179100Syongari/// @} 135179100Syongari}; 136179100Syongari 137179100Syongari} // end namespace llvm 138179100Syongari 139179100Syongari#endif // LLVM_IR_VALUESYMBOLTABLE_H 140179100Syongari