LLVM  4.0.0
GlobalIndirectSymbol.h
Go to the documentation of this file.
1 //===- llvm/GlobalIndirectSymbol.h - GlobalIndirectSymbol 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 GlobalIndirectSymbol class, which
11 // is a base class for GlobalAlias and GlobalIFunc. It contains all common code
12 // for aliases and ifuncs.
13 //
14 //===----------------------------------------------------------------------===//
15 
16 #ifndef LLVM_IR_GLOBALINDIRECTSYMBOL_H
17 #define LLVM_IR_GLOBALINDIRECTSYMBOL_H
18 
19 #include "llvm/IR/GlobalObject.h"
20 #include "llvm/IR/GlobalValue.h"
21 #include "llvm/IR/OperandTraits.h"
22 #include "llvm/IR/User.h"
23 #include "llvm/IR/Value.h"
24 #include "llvm/Support/Casting.h"
25 #include <cstddef>
26 
27 namespace llvm {
28 
30 protected:
31  GlobalIndirectSymbol(Type *Ty, ValueTy VTy, unsigned AddressSpace,
33 
34 public:
37 
38  // allocate space for exactly one operand
39  void *operator new(size_t s) {
40  return User::operator new(s, 1);
41  }
42 
43  /// Provide fast operand accessors
45 
46  /// These methods set and retrieve indirect symbol.
47  void setIndirectSymbol(Constant *Symbol) {
48  setOperand(0, Symbol);
49  }
50  const Constant *getIndirectSymbol() const {
51  return const_cast<GlobalIndirectSymbol *>(this)->getIndirectSymbol();
52  }
54  return getOperand(0);
55  }
56 
57  const GlobalObject *getBaseObject() const {
58  return const_cast<GlobalIndirectSymbol *>(this)->getBaseObject();
59  }
62  }
63 
64  const GlobalObject *getBaseObject(const DataLayout &DL, APInt &Offset) const {
65  return const_cast<GlobalIndirectSymbol *>(this)->getBaseObject(DL, Offset);
66  }
68  return dyn_cast<GlobalObject>(
70  Offset));
71  }
72 
73  // Methods for support type inquiry through isa, cast, and dyn_cast:
74  static inline bool classof(const Value *V) {
75  return V->getValueID() == Value::GlobalAliasVal ||
76  V->getValueID() == Value::GlobalIFuncVal;
77  }
78 };
79 
80 template <>
82  public FixedNumOperandTraits<GlobalIndirectSymbol, 1> {
83 };
84 
86 
87 } // end namespace llvm
88 
89 #endif // LLVM_IR_GLOBALINDIRECTSYMBOL_H
A parsed version of the target data layout string in and methods for querying it. ...
Definition: DataLayout.h:102
void setIndirectSymbol(Constant *Symbol)
These methods set and retrieve indirect symbol.
Twine - A lightweight data structure for efficiently representing the concatenation of temporary valu...
Definition: Twine.h:81
GlobalIndirectSymbol & operator=(const GlobalIndirectSymbol &)=delete
Value * stripAndAccumulateInBoundsConstantOffsets(const DataLayout &DL, APInt &Offset)
Accumulate offsets from stripInBoundsConstantOffsets().
Definition: Value.cpp:502
#define DEFINE_TRANSPARENT_OPERAND_ACCESSORS(CLASS, VALUECLASS)
Macro for generating out-of-class operand accessor definitions.
The instances of the Type class are immutable: once they are created, they are never changed...
Definition: Type.h:45
This is an important base class in LLVM.
Definition: Constant.h:42
Value * stripInBoundsOffsets()
Strip off pointer casts and inbounds GEPs.
Definition: Value.cpp:544
uint32_t Offset
const GlobalObject * getBaseObject() const
unsigned getValueID() const
Return an ID for the concrete type of this object.
Definition: Value.h:434
Value * getOperand(unsigned i) const
Definition: User.h:145
static bool classof(const Value *V)
AddressSpace
Definition: NVPTXBaseInfo.h:22
unsigned Linkage
Definition: GlobalValue.h:93
ValueTy
Concrete subclass of this.
Definition: Value.h:415
void setOperand(unsigned i, Value *Val)
Definition: User.h:150
Class for arbitrary precision integers.
Definition: APInt.h:77
LinkageTypes
An enumeration for the kinds of linkage for global values.
Definition: GlobalValue.h:48
Compile-time customization of User operands.
Definition: User.h:43
LLVM_NODISCARD std::enable_if<!is_simple_type< Y >::value, typename cast_retty< X, const Y >::ret_type >::type dyn_cast(const Y &Val)
Definition: Casting.h:287
const Constant * getIndirectSymbol() const
const GlobalObject * getBaseObject(const DataLayout &DL, APInt &Offset) const
LLVM Value Representation.
Definition: Value.h:71
GlobalObject * getBaseObject(const DataLayout &DL, APInt &Offset)
GlobalIndirectSymbol(Type *Ty, ValueTy VTy, unsigned AddressSpace, LinkageTypes Linkage, const Twine &Name, Constant *Symbol)
Definition: Globals.cpp:363
DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Constant)
Provide fast operand accessors.
FixedNumOperandTraits - determine the allocation regime of the Use array when it is a prefix to the U...
Definition: OperandTraits.h:31