2003-09-30 20:37:50 +02:00
|
|
|
//===-- llvm/SymbolTableListTraits.h - Traits for iplist --------*- C++ -*-===//
|
2005-04-21 22:19:05 +02:00
|
|
|
//
|
2003-10-20 22:19:47 +02:00
|
|
|
// The LLVM Compiler Infrastructure
|
|
|
|
//
|
2007-12-29 20:59:42 +01:00
|
|
|
// This file is distributed under the University of Illinois Open Source
|
|
|
|
// License. See LICENSE.TXT for details.
|
2005-04-21 22:19:05 +02:00
|
|
|
//
|
2003-10-20 22:19:47 +02:00
|
|
|
//===----------------------------------------------------------------------===//
|
2002-06-25 18:12:52 +02:00
|
|
|
//
|
|
|
|
// This file defines a generic class that is used to implement the automatic
|
|
|
|
// symbol table manipulation that occurs when you put (for example) a named
|
|
|
|
// instruction into a basic block.
|
|
|
|
//
|
|
|
|
// The way that this is implemented is by using a special traits class with the
|
|
|
|
// intrusive list that makes up the list of instructions in a basic block. When
|
|
|
|
// a new element is added to the list of instructions, the traits class is
|
|
|
|
// notified, allowing the symbol table to be updated.
|
|
|
|
//
|
|
|
|
// This generic class implements the traits class. It must be generic so that
|
|
|
|
// it can work for all uses it, which include lists of instructions, basic
|
|
|
|
// blocks, arguments, functions, global variables, etc...
|
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
2013-01-10 01:45:19 +01:00
|
|
|
#ifndef LLVM_IR_SYMBOLTABLELISTTRAITS_H
|
|
|
|
#define LLVM_IR_SYMBOLTABLELISTTRAITS_H
|
2002-06-25 18:12:52 +02:00
|
|
|
|
2008-07-28 23:51:04 +02:00
|
|
|
#include "llvm/ADT/ilist.h"
|
|
|
|
|
2003-11-11 23:41:34 +01:00
|
|
|
namespace llvm {
|
2009-09-30 02:08:25 +02:00
|
|
|
class ValueSymbolTable;
|
2015-09-22 13:13:55 +02:00
|
|
|
|
|
|
|
template <typename NodeTy> class ilist_iterator;
|
|
|
|
template <typename NodeTy, typename Traits> class iplist;
|
|
|
|
template <typename Ty> struct ilist_traits;
|
2002-06-25 18:12:52 +02:00
|
|
|
|
2015-10-07 22:05:10 +02:00
|
|
|
template <typename NodeTy>
|
|
|
|
struct SymbolTableListSentinelTraits
|
|
|
|
: public ilist_embedded_sentinel_traits<NodeTy> {};
|
|
|
|
|
|
|
|
/// Template metafunction to get the parent type for a symbol table list.
|
|
|
|
///
|
|
|
|
/// Implementations create a typedef called \c type so that we only need a
|
|
|
|
/// single template parameter for the list and traits.
|
|
|
|
template <typename NodeTy> struct SymbolTableListParentType {};
|
|
|
|
class Argument;
|
|
|
|
class BasicBlock;
|
|
|
|
class Function;
|
|
|
|
class Instruction;
|
|
|
|
class GlobalVariable;
|
|
|
|
class GlobalAlias;
|
|
|
|
class Module;
|
|
|
|
#define DEFINE_SYMBOL_TABLE_PARENT_TYPE(NODE, PARENT) \
|
|
|
|
template <> struct SymbolTableListParentType<NODE> { typedef PARENT type; };
|
|
|
|
DEFINE_SYMBOL_TABLE_PARENT_TYPE(Instruction, BasicBlock)
|
|
|
|
DEFINE_SYMBOL_TABLE_PARENT_TYPE(BasicBlock, Function)
|
|
|
|
DEFINE_SYMBOL_TABLE_PARENT_TYPE(Argument, Function)
|
|
|
|
DEFINE_SYMBOL_TABLE_PARENT_TYPE(Function, Module)
|
|
|
|
DEFINE_SYMBOL_TABLE_PARENT_TYPE(GlobalVariable, Module)
|
|
|
|
DEFINE_SYMBOL_TABLE_PARENT_TYPE(GlobalAlias, Module)
|
|
|
|
#undef DEFINE_SYMBOL_TABLE_PARENT_TYPE
|
|
|
|
|
|
|
|
template <typename NodeTy> class SymbolTableList;
|
|
|
|
|
2009-02-27 10:33:37 +01:00
|
|
|
// ValueSubClass - The type of objects that I hold, e.g. Instruction.
|
|
|
|
// ItemParentClass - The type of object that owns the list, e.g. BasicBlock.
|
2002-06-25 18:12:52 +02:00
|
|
|
//
|
2015-10-07 22:05:10 +02:00
|
|
|
template <typename ValueSubClass>
|
|
|
|
class SymbolTableListTraits
|
|
|
|
: public ilist_nextprev_traits<ValueSubClass>,
|
|
|
|
public SymbolTableListSentinelTraits<ValueSubClass>,
|
|
|
|
public ilist_node_traits<ValueSubClass> {
|
|
|
|
typedef SymbolTableList<ValueSubClass> ListTy;
|
|
|
|
typedef
|
|
|
|
typename SymbolTableListParentType<ValueSubClass>::type ItemParentClass;
|
|
|
|
|
2002-06-25 18:12:52 +02:00
|
|
|
public:
|
2007-04-17 06:04:14 +02:00
|
|
|
SymbolTableListTraits() {}
|
2002-06-25 18:12:52 +02:00
|
|
|
|
2015-10-07 00:14:06 +02:00
|
|
|
private:
|
2007-04-17 06:04:14 +02:00
|
|
|
/// getListOwner - Return the object that owns this list. If this is a list
|
|
|
|
/// of instructions, it returns the BasicBlock that owns them.
|
|
|
|
ItemParentClass *getListOwner() {
|
2014-04-09 08:08:46 +02:00
|
|
|
size_t Offset(size_t(&((ItemParentClass*)nullptr->*ItemParentClass::
|
|
|
|
getSublistAccess(static_cast<ValueSubClass*>(nullptr)))));
|
2015-10-07 22:05:10 +02:00
|
|
|
ListTy *Anchor(static_cast<ListTy *>(this));
|
2009-03-07 11:00:35 +01:00
|
|
|
return reinterpret_cast<ItemParentClass*>(reinterpret_cast<char*>(Anchor)-
|
|
|
|
Offset);
|
2007-04-17 06:04:14 +02:00
|
|
|
}
|
2002-06-25 18:12:52 +02:00
|
|
|
|
2015-10-07 22:05:10 +02:00
|
|
|
static ListTy &getList(ItemParentClass *Par) {
|
2014-04-09 08:08:46 +02:00
|
|
|
return Par->*(Par->getSublistAccess((ValueSubClass*)nullptr));
|
2009-03-07 13:33:24 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
static ValueSymbolTable *getSymTab(ItemParentClass *Par) {
|
2014-04-09 08:08:46 +02:00
|
|
|
return Par ? toPtr(Par->getValueSymbolTable()) : nullptr;
|
2009-03-07 13:33:24 +01:00
|
|
|
}
|
2009-03-07 11:49:57 +01:00
|
|
|
|
2015-10-06 23:31:07 +02:00
|
|
|
public:
|
2002-06-25 18:12:52 +02:00
|
|
|
void addNodeToList(ValueSubClass *V);
|
|
|
|
void removeNodeFromList(ValueSubClass *V);
|
2015-10-07 22:05:10 +02:00
|
|
|
void transferNodesFromList(SymbolTableListTraits &L2,
|
2002-06-25 18:12:52 +02:00
|
|
|
ilist_iterator<ValueSubClass> first,
|
|
|
|
ilist_iterator<ValueSubClass> last);
|
|
|
|
//private:
|
2007-04-17 05:26:42 +02:00
|
|
|
template<typename TPtr>
|
|
|
|
void setSymTabObject(TPtr *, TPtr);
|
2009-03-07 13:33:24 +01:00
|
|
|
static ValueSymbolTable *toPtr(ValueSymbolTable *P) { return P; }
|
|
|
|
static ValueSymbolTable *toPtr(ValueSymbolTable &R) { return &R; }
|
2002-06-25 18:12:52 +02:00
|
|
|
};
|
|
|
|
|
2015-10-07 22:05:10 +02:00
|
|
|
/// List that automatically updates parent links and symbol tables.
|
|
|
|
///
|
|
|
|
/// When nodes are inserted into and removed from this list, the associated
|
|
|
|
/// symbol table will be automatically updated. Similarly, parent links get
|
|
|
|
/// updated automatically.
|
|
|
|
template <typename NodeTy>
|
|
|
|
class SymbolTableList : public iplist<NodeTy, SymbolTableListTraits<NodeTy>> {};
|
|
|
|
|
2015-06-23 11:49:53 +02:00
|
|
|
} // End llvm namespace
|
2003-11-11 23:41:34 +01:00
|
|
|
|
2002-06-25 18:12:52 +02:00
|
|
|
#endif
|