1 //===-- llvm/ValueSymbolTable.h - Implement a Value Symtab ------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the name/Value symbol table for LLVM.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_VALUE_SYMBOL_TABLE_H
15 #define LLVM_VALUE_SYMBOL_TABLE_H
17 #include "llvm/Value.h"
18 #include "llvm/ADT/StringMap.h"
19 #include "llvm/System/DataTypes.h"
22 template<typename ValueSubClass, typename ItemParentClass>
23 class SymbolTableListTraits;
30 /// This class provides a symbol table of name/value pairs. It is essentially
31 /// a std::map<std::string,Value*> but has a controlled interface provided by
32 /// LLVM as well as ensuring uniqueness of names.
34 class ValueSymbolTable {
36 friend class SymbolTableListTraits<Argument, Function>;
37 friend class SymbolTableListTraits<BasicBlock, Function>;
38 friend class SymbolTableListTraits<Instruction, BasicBlock>;
39 friend class SymbolTableListTraits<Function, Module>;
40 friend class SymbolTableListTraits<GlobalVariable, Module>;
41 friend class SymbolTableListTraits<GlobalAlias, Module>;
45 /// @brief A mapping of names to values.
46 typedef StringMap<Value*> ValueMap;
48 /// @brief An iterator over a ValueMap.
49 typedef ValueMap::iterator iterator;
51 /// @brief A const_iterator over a ValueMap.
52 typedef ValueMap::const_iterator const_iterator;
55 /// @name Constructors
59 ValueSymbolTable() : vmap(0), LastUnique(0) {}
67 /// This method finds the value with the given \p Name in the
69 /// @returns the value associated with the \p Name
70 /// @brief Lookup a named Value.
71 Value *lookup(StringRef Name) const { return vmap.lookup(Name); }
73 /// @returns true iff the symbol table is empty
74 /// @brief Determine if the symbol table is empty
75 inline bool empty() const { return vmap.empty(); }
77 /// @brief The number of name/type pairs is returned.
78 inline unsigned size() const { return unsigned(vmap.size()); }
80 /// This function can be used from the debugger to display the
81 /// content of the symbol table while debugging.
82 /// @brief Print out symbol table on stderr
89 /// @brief Get an iterator that from the beginning of the symbol table.
90 inline iterator begin() { return vmap.begin(); }
92 /// @brief Get a const_iterator that from the beginning of the symbol table.
93 inline const_iterator begin() const { return vmap.begin(); }
95 /// @brief Get an iterator to the end of the symbol table.
96 inline iterator end() { return vmap.end(); }
98 /// @brief Get a const_iterator to the end of the symbol table.
99 inline const_iterator end() const { return vmap.end(); }
105 /// This method adds the provided value \p N to the symbol table. The Value
106 /// must have a name which is used to place the value in the symbol table.
107 /// If the inserted name conflicts, this renames the value.
108 /// @brief Add a named value to the symbol table
109 void reinsertValue(Value *V);
111 /// createValueName - This method attempts to create a value name and insert
112 /// it into the symbol table with the specified name. If it conflicts, it
113 /// auto-renames the name and returns that instead.
114 ValueName *createValueName(StringRef Name, Value *V);
116 /// This method removes a value from the symbol table. It leaves the
117 /// ValueName attached to the value, but it is no longer inserted in the
119 void removeValueName(ValueName *V);
122 /// @name Internal Data
125 ValueMap vmap; ///< The map that holds the symbol table.
126 mutable uint32_t LastUnique; ///< Counter for tracking unique names
131 /// This class provides a symbol table of name/NamedMDNode pairs. It is
132 /// essentially a StringMap wrapper.
134 class MDSymbolTable {
135 friend class SymbolTableListTraits<NamedMDNode, Module>;
139 /// @brief A mapping of names to metadata
140 typedef StringMap<NamedMDNode*> MDMap;
143 /// @brief An iterator over a ValueMap.
144 typedef MDMap::iterator iterator;
146 /// @brief A const_iterator over a ValueMap.
147 typedef MDMap::const_iterator const_iterator;
150 /// @name Constructors
154 MDSymbolTable(const MDNode &); // DO NOT IMPLEMENT
155 void operator=(const MDSymbolTable &); // DO NOT IMPLEMENT
156 MDSymbolTable() : mmap(0) {}
164 /// This method finds the value with the given \p Name in the
165 /// the symbol table.
166 /// @returns the NamedMDNode associated with the \p Name
167 /// @brief Lookup a named Value.
168 NamedMDNode *lookup(StringRef Name) const { return mmap.lookup(Name); }
170 /// @returns true iff the symbol table is empty
171 /// @brief Determine if the symbol table is empty
172 inline bool empty() const { return mmap.empty(); }
174 /// @brief The number of name/type pairs is returned.
175 inline unsigned size() const { return unsigned(mmap.size()); }
181 /// @brief Get an iterator that from the beginning of the symbol table.
182 inline iterator begin() { return mmap.begin(); }
184 /// @brief Get a const_iterator that from the beginning of the symbol table.
185 inline const_iterator begin() const { return mmap.begin(); }
187 /// @brief Get an iterator to the end of the symbol table.
188 inline iterator end() { return mmap.end(); }
190 /// @brief Get a const_iterator to the end of the symbol table.
191 inline const_iterator end() const { return mmap.end(); }
197 /// insert - The method inserts a new entry into the stringmap. This will
198 /// replace existing entry, if any.
199 void insert(StringRef Name, NamedMDNode *Node) {
200 StringMapEntry<NamedMDNode *> &Entry =
201 mmap.GetOrCreateValue(Name, Node);
202 if (Entry.getValue() != Node) {
204 (void) mmap.GetOrCreateValue(Name, Node);
208 /// This method removes a NamedMDNode from the symbol table.
209 void remove(StringRef Name) { mmap.erase(Name); }
212 /// @name Internal Data
215 MDMap mmap; ///< The map that holds the symbol table.
219 } // End llvm namespace