1eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer//===-- llvm/ValueSymbolTable.h - Implement a Value Symtab ------*- C++ -*-===// 2eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer// 3eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer// The LLVM Compiler Infrastructure 4eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer// 57ed47a13356daed2a34cd2209a31f92552e3bdd8Chris Lattner// This file is distributed under the University of Illinois Open Source 67ed47a13356daed2a34cd2209a31f92552e3bdd8Chris Lattner// License. See LICENSE.TXT for details. 7eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer// 8eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer//===----------------------------------------------------------------------===// 9eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer// 10eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer// This file implements the name/Value symbol table for LLVM. 11eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer// 12eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer//===----------------------------------------------------------------------===// 13eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer 14674be02d525d4e24bc6943ed9274958c580bcfbcJakub Staszak#ifndef LLVM_IR_VALUESYMBOLTABLE_H 15674be02d525d4e24bc6943ed9274958c580bcfbcJakub Staszak#define LLVM_IR_VALUESYMBOLTABLE_H 16eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer 17dec628eead87b20773c98a00830580df211acc98Chris Lattner#include "llvm/ADT/StringMap.h" 180b8c9a80f20772c3793201ab5b251d3520b9cea3Chandler Carruth#include "llvm/IR/Value.h" 191f6efa3996dd1929fbc129203ce5009b620e6969Michael J. Spencer#include "llvm/Support/DataTypes.h" 20eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer 21eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencernamespace llvm { 2217fcdd5e1b78b829068ca657c97357a39d6e768bChris Lattner template<typename ValueSubClass, typename ItemParentClass> 231e348549d930f1a3e636dcb2c78bad95636daec2Chris Lattner class SymbolTableListTraits; 241e348549d930f1a3e636dcb2c78bad95636daec2Chris Lattner class BasicBlock; 251e348549d930f1a3e636dcb2c78bad95636daec2Chris Lattner class Function; 2628bc9d88260a3e153ead4311c9129e3d3ad07736Devang Patel class NamedMDNode; 271e348549d930f1a3e636dcb2c78bad95636daec2Chris Lattner class Module; 28bc8d813f715e47afd27b73b0b7abd00978e0ba51Daniel Dunbar class StringRef; 290386f01e061513094504bc11f8352a40173cada7Devang Patel 30eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer/// This class provides a symbol table of name/value pairs. It is essentially 31eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer/// a std::map<std::string,Value*> but has a controlled interface provided by 32eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer/// LLVM as well as ensuring uniqueness of names. 33eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer/// 34eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencerclass ValueSymbolTable { 351e348549d930f1a3e636dcb2c78bad95636daec2Chris Lattner friend class Value; 3617fcdd5e1b78b829068ca657c97357a39d6e768bChris Lattner friend class SymbolTableListTraits<Argument, Function>; 3717fcdd5e1b78b829068ca657c97357a39d6e768bChris Lattner friend class SymbolTableListTraits<BasicBlock, Function>; 3817fcdd5e1b78b829068ca657c97357a39d6e768bChris Lattner friend class SymbolTableListTraits<Instruction, BasicBlock>; 3917fcdd5e1b78b829068ca657c97357a39d6e768bChris Lattner friend class SymbolTableListTraits<Function, Module>; 4017fcdd5e1b78b829068ca657c97357a39d6e768bChris Lattner friend class SymbolTableListTraits<GlobalVariable, Module>; 418b0a8c84da2030ee8f4440d5b60a8033de691222Anton Korobeynikov friend class SymbolTableListTraits<GlobalAlias, Module>; 42eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer/// @name Types 43eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer/// @{ 44eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencerpublic: 45eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer /// @brief A mapping of names to values. 464f95d2bda4235d36acd95688d0744d7363214706Chris Lattner typedef StringMap<Value*> ValueMap; 47eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer 48eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer /// @brief An iterator over a ValueMap. 49eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer typedef ValueMap::iterator iterator; 50eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer 51eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer /// @brief A const_iterator over a ValueMap. 52eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer typedef ValueMap::const_iterator const_iterator; 53eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer 54eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer/// @} 55eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer/// @name Constructors 56eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer/// @{ 57eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencerpublic: 58eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer 59cb917f7abd1d929ea1e2558c6fd5860ed23339c2Chris Lattner ValueSymbolTable() : vmap(0), LastUnique(0) {} 60eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer ~ValueSymbolTable(); 61eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer 62eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer/// @} 63eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer/// @name Accessors 64eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer/// @{ 65eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencerpublic: 66eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer 67bc8d813f715e47afd27b73b0b7abd00978e0ba51Daniel Dunbar /// This method finds the value with the given \p Name in the 68eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer /// the symbol table. 69bc8d813f715e47afd27b73b0b7abd00978e0ba51Daniel Dunbar /// @returns the value associated with the \p Name 70eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer /// @brief Lookup a named Value. 712928c83b010f7cfdb0f819199d806f6942a7d995Daniel Dunbar Value *lookup(StringRef Name) const { return vmap.lookup(Name); } 72eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer 7394c22716d60ff5edf6a98a3c67e0faa001be1142Sylvestre Ledru /// @returns true iff the symbol table is empty 74eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer /// @brief Determine if the symbol table is empty 75eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer inline bool empty() const { return vmap.empty(); } 76eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer 77eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer /// @brief The number of name/type pairs is returned. 78eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer inline unsigned size() const { return unsigned(vmap.size()); } 79eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer 80eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer /// This function can be used from the debugger to display the 81eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer /// content of the symbol table while debugging. 82eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer /// @brief Print out symbol table on stderr 83eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer void dump() const; 84eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer 85eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer/// @} 86eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer/// @name Iteration 87eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer/// @{ 88eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencerpublic: 89eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer /// @brief Get an iterator that from the beginning of the symbol table. 90eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer inline iterator begin() { return vmap.begin(); } 91eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer 92eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer /// @brief Get a const_iterator that from the beginning of the symbol table. 93eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer inline const_iterator begin() const { return vmap.begin(); } 94eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer 95eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer /// @brief Get an iterator to the end of the symbol table. 96eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer inline iterator end() { return vmap.end(); } 97eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer 98eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer /// @brief Get a const_iterator to the end of the symbol table. 99eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer inline const_iterator end() const { return vmap.end(); } 100dec628eead87b20773c98a00830580df211acc98Chris Lattner 101eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer/// @} 102eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer/// @name Mutators 103eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer/// @{ 1041e348549d930f1a3e636dcb2c78bad95636daec2Chris Lattnerprivate: 105eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer /// This method adds the provided value \p N to the symbol table. The Value 106eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer /// must have a name which is used to place the value in the symbol table. 107dec628eead87b20773c98a00830580df211acc98Chris Lattner /// If the inserted name conflicts, this renames the value. 108eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer /// @brief Add a named value to the symbol table 109dec628eead87b20773c98a00830580df211acc98Chris Lattner void reinsertValue(Value *V); 110dec628eead87b20773c98a00830580df211acc98Chris Lattner 111dec628eead87b20773c98a00830580df211acc98Chris Lattner /// createValueName - This method attempts to create a value name and insert 112dec628eead87b20773c98a00830580df211acc98Chris Lattner /// it into the symbol table with the specified name. If it conflicts, it 113dec628eead87b20773c98a00830580df211acc98Chris Lattner /// auto-renames the name and returns that instead. 1142928c83b010f7cfdb0f819199d806f6942a7d995Daniel Dunbar ValueName *createValueName(StringRef Name, Value *V); 115dec628eead87b20773c98a00830580df211acc98Chris Lattner 116dec628eead87b20773c98a00830580df211acc98Chris Lattner /// This method removes a value from the symbol table. It leaves the 117dec628eead87b20773c98a00830580df211acc98Chris Lattner /// ValueName attached to the value, but it is no longer inserted in the 118dec628eead87b20773c98a00830580df211acc98Chris Lattner /// symtab. 119dec628eead87b20773c98a00830580df211acc98Chris Lattner void removeValueName(ValueName *V); 12056920a0eccb281e4f7cc71cb69c0d23c9d531a84Chris Lattner 121eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer/// @} 122eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer/// @name Internal Data 123eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer/// @{ 124eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencerprivate: 125eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer ValueMap vmap; ///< The map that holds the symbol table. 1269e3264a1eaf7ed2340859938ab386985a413d602Andrew Lenharth mutable uint32_t LastUnique; ///< Counter for tracking unique names 127eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer 128eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer/// @} 129eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer}; 130eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer 131eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer} // End llvm namespace 132eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer 133eb7116bb08a99897c69570a3789af97343bff9f2Reid Spencer#endif 134