Add GhostLinkage for marking functions before they're fully materialized
[oota-llvm.git] / include / llvm / GlobalValue.h
1 //===-- llvm/GlobalValue.h - Class to represent a global value --*- C++ -*-===//
2 // 
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
7 // 
8 //===----------------------------------------------------------------------===//
9 //
10 // This file is a common base class of all globally definable objects.  As such,
11 // it is subclassed by GlobalVariable and by Function.  This is used because you
12 // can do certain things with these global objects that you can't do to anything
13 // else.  For example, use the address of one as a constant.
14 //
15 //===----------------------------------------------------------------------===//
16
17 #ifndef LLVM_GLOBALVALUE_H
18 #define LLVM_GLOBALVALUE_H
19
20 #include "llvm/Constant.h"
21
22 namespace llvm {
23
24 class PointerType;
25 class Module;
26
27 class GlobalValue : public Constant {
28   GlobalValue(const GlobalValue &);             // do not implement
29 public:
30   enum LinkageTypes {
31     ExternalLinkage,   // Externally visible function
32     LinkOnceLinkage,   // Keep one copy of named function when linking (inline)
33     WeakLinkage,       // Keep one copy of named function when linking (weak)
34     AppendingLinkage,  // Special purpose, only applies to global arrays
35     InternalLinkage,   // Rename collisions when linking (static functions)
36     GhostLinkage       // Stand-in functions for streaming fns from BC files
37   };
38 protected:
39   GlobalValue(const Type *Ty, ValueTy vty, LinkageTypes linkage,
40               const std::string &name = "")
41     : Constant(Ty, vty, name), Linkage(linkage), Parent(0) { }
42
43   LinkageTypes Linkage;   // The linkage of this global
44   Module *Parent;
45 public:
46   ~GlobalValue() {
47     removeDeadConstantUsers();   // remove any dead constants using this.
48   }
49
50   /// If the usage is empty (except transitively dead constants), then this
51   /// global value can can be safely deleted since the destructor will 
52   /// delete the dead constants as well.
53   /// @brief Determine if the usage of this global value is empty except 
54   /// for transitively dead constants.
55   bool use_empty_except_constants();
56
57   /// getType - Global values are always pointers.
58   inline const PointerType *getType() const {
59     return reinterpret_cast<const PointerType*>(User::getType());
60   }
61
62   bool hasExternalLinkage()  const { return Linkage == ExternalLinkage; }
63   bool hasLinkOnceLinkage()  const { return Linkage == LinkOnceLinkage; }
64   bool hasWeakLinkage()      const { return Linkage == WeakLinkage; }
65   bool hasAppendingLinkage() const { return Linkage == AppendingLinkage; }
66   bool hasInternalLinkage()  const { return Linkage == InternalLinkage; }
67   void setLinkage(LinkageTypes LT) { Linkage = LT; }
68   LinkageTypes getLinkage() const { return Linkage; }
69
70   /// Override from Constant class. No GlobalValue's have null values so
71   /// this always returns false.
72   virtual bool isNullValue() const { return false; }
73
74   /// Override from Constant class.
75   virtual void destroyConstant();
76
77   /// isExternal - Return true if the primary definition of this global value is
78   /// outside of the current translation unit...
79   virtual bool isExternal() const = 0;
80
81   /// getParent - Get the module that this global value is contained inside
82   /// of...
83   inline Module *getParent() { return Parent; }
84   inline const Module *getParent() const { return Parent; }
85
86   /// removeDeadConstantUsers - If there are any dead constant users dangling
87   /// off of this global value, remove them.  This method is useful for clients
88   /// that want to check to see if a global is unused, but don't want to deal
89   /// with potentially dead constants hanging off of the globals.
90   ///
91   /// This method tries to make the global dead.  If it detects a user that
92   /// would prevent it from becoming completely dead, it gives up early,
93   /// potentially leaving some dead constant users around.
94   void removeDeadConstantUsers();
95
96   // Methods for support type inquiry through isa, cast, and dyn_cast:
97   static inline bool classof(const GlobalValue *T) { return true; }
98   static inline bool classof(const Value *V) {
99     return V->getValueType() == Value::FunctionVal || 
100            V->getValueType() == Value::GlobalVariableVal;
101   }
102 };
103
104 } // End llvm namespace
105
106 #endif