include/llvm/IR/GlobalAlias.h

   1 //===-------- llvm/GlobalAlias.h - GlobalAlias class ------------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file contains the declaration of the GlobalAlias class, which
  11 // represents a single function or variable alias in the IR.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_IR_GLOBALALIAS_H
  16 #define LLVM_IR_GLOBALALIAS_H
  17
  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"
  22
  23 namespace llvm {
  24
  25 class Module;
  26 template<typename ValueSubClass, typename ItemParentClass>
  27   class SymbolTableListTraits;
  28
  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;
  33
  34   void setParent(Module *parent);
  35
  36 public:
  37   // allocate space for exactly one operand
  38   void *operator new(size_t s) {
  39     return User::operator new(s, 1);
  40   }
  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, LinkageTypes Linkage, const Twine &Name = "",
  44               GlobalObject *Aliasee = nullptr, Module *Parent = nullptr,
  45               unsigned AddressSpace = 0);
  46
  47   /// Provide fast operand accessors
  48   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Constant);
  49
  50   /// removeFromParent - This method unlinks 'this' from the containing module,
  51   /// but does not delete it.
  52   ///
  53   void removeFromParent() override;
  54
  55   /// eraseFromParent - This method unlinks 'this' from the containing module
  56   /// and deletes it.
  57   ///
  58   void eraseFromParent() override;
  59
  60   /// set/getAliasee - These methods retrive and set alias target.
  61   void setAliasee(GlobalObject *GO);
  62   const GlobalObject *getAliasee() const {
  63     return const_cast<GlobalAlias *>(this)->getAliasee();
  64   }
  65
  66   GlobalObject *getAliasee() {
  67     return cast_or_null<GlobalObject>(getOperand(0));
  68   }
  69
  70   GlobalObject *getAliasedGlobal() {
  71     return getAliasee();
  72   }
  73
  74   const GlobalObject *getAliasedGlobal() const {
  75     return const_cast<GlobalAlias *>(this)->getAliasedGlobal();
  76   }
  77
  78   static bool isValidLinkage(LinkageTypes L) {
  79     return isExternalLinkage(L) || isLocalLinkage(L) ||
  80       isWeakLinkage(L) || isLinkOnceLinkage(L);
  81   }
  82
  83   // Methods for support type inquiry through isa, cast, and dyn_cast:
  84   static inline bool classof(const Value *V) {
  85     return V->getValueID() == Value::GlobalAliasVal;
  86   }
  87 };
  88
  89 template <>
  90 struct OperandTraits<GlobalAlias> :
  91   public FixedNumOperandTraits<GlobalAlias, 1> {
  92 };
  93
  94 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(GlobalAlias, Constant)
  95
  96 } // End llvm namespace
  97
  98 #endif