1 //===-------- llvm/GlobalAlias.h - GlobalAlias class ------------*- 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 contains the declaration of the GlobalAlias class, which
11 // represents a single function or variable alias in the IR.
13 //===----------------------------------------------------------------------===//
15 #ifndef LLVM_IR_GLOBALALIAS_H
16 #define LLVM_IR_GLOBALALIAS_H
18 #include "llvm/ADT/Twine.h"
19 #include "llvm/ADT/ilist_node.h"
20 #include "llvm/IR/GlobalValue.h"
21 #include "llvm/IR/OperandTraits.h"
26 template<typename ValueSubClass, typename ItemParentClass>
27 class SymbolTableListTraits;
29 class GlobalAlias : public GlobalValue, public ilist_node<GlobalAlias> {
30 friend class SymbolTableListTraits<GlobalAlias, Module>;
31 void operator=(const GlobalAlias &) LLVM_DELETED_FUNCTION;
32 GlobalAlias(const GlobalAlias &) LLVM_DELETED_FUNCTION;
34 void setParent(Module *parent);
37 // allocate space for exactly one operand
38 void *operator new(size_t s) {
39 return User::operator new(s, 1);
41 /// If a parent module is specified, the alias is automatically inserted into
42 /// the end of the specified module's alias list.
43 GlobalAlias(Type *Ty, unsigned AddressSpace, LinkageTypes Linkage,
44 const Twine &Name, GlobalObject *Aliasee, Module *Parent);
46 // Without the Aliasee.
47 GlobalAlias(Type *Ty, unsigned AddressSpace, LinkageTypes Linkage,
48 const Twine &Name, Module *Parent);
50 // The module is taken from the Aliasee.
51 GlobalAlias(Type *Ty, unsigned AddressSpace, LinkageTypes Linkage,
52 const Twine &Name, GlobalObject *Aliasee);
54 // Type, Parent and AddressSpace taken from the Aliasee.
55 GlobalAlias(LinkageTypes Linkage, const Twine &Name, GlobalObject *Aliasee);
57 // Linkage, Type, Parent and AddressSpace taken from the Aliasee.
58 GlobalAlias(const Twine &Name, GlobalObject *Aliasee);
60 /// Provide fast operand accessors
61 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Constant);
63 /// removeFromParent - This method unlinks 'this' from the containing module,
64 /// but does not delete it.
66 void removeFromParent() override;
68 /// eraseFromParent - This method unlinks 'this' from the containing module
71 void eraseFromParent() override;
73 /// set/getAliasee - These methods retrive and set alias target.
74 void setAliasee(GlobalObject *GO);
75 const GlobalObject *getAliasee() const {
76 return const_cast<GlobalAlias *>(this)->getAliasee();
79 GlobalObject *getAliasee() {
80 return cast_or_null<GlobalObject>(getOperand(0));
83 static bool isValidLinkage(LinkageTypes L) {
84 return isExternalLinkage(L) || isLocalLinkage(L) ||
85 isWeakLinkage(L) || isLinkOnceLinkage(L);
88 // Methods for support type inquiry through isa, cast, and dyn_cast:
89 static inline bool classof(const Value *V) {
90 return V->getValueID() == Value::GlobalAliasVal;
95 struct OperandTraits<GlobalAlias> :
96 public FixedNumOperandTraits<GlobalAlias, 1> {
99 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(GlobalAlias, Constant)
101 } // End llvm namespace