1 //===- llvm/GlobalIndirectSymbol.h - GlobalIndirectSymbol 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 GlobalIndirectSymbol class, which
11 // is a base class for GlobalAlias and GlobalIFunc. It contains all common code
12 // for aliases and ifuncs.
14 //===----------------------------------------------------------------------===//
16 #ifndef LLVM_IR_GLOBALINDIRECTSYMBOL_H
17 #define LLVM_IR_GLOBALINDIRECTSYMBOL_H
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"
29 class GlobalIndirectSymbol : public GlobalValue {
31 GlobalIndirectSymbol(Type *Ty, ValueTy VTy, unsigned AddressSpace,
32 LinkageTypes Linkage, const Twine &Name, Constant *Symbol);
35 GlobalIndirectSymbol(const GlobalIndirectSymbol &) = delete;
36 GlobalIndirectSymbol &operator=(const GlobalIndirectSymbol &) = delete;
38 // allocate space for exactly one operand
39 void *operator new(size_t s) {
40 return User::operator new(s, 1);
43 /// Provide fast operand accessors
44 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Constant);
46 /// These methods set and retrieve indirect symbol.
47 void setIndirectSymbol(Constant *Symbol) {
48 setOperand(0, Symbol);
50 const Constant *getIndirectSymbol() const {
53 Constant *getIndirectSymbol() {
54 return const_cast<Constant *>(
55 static_cast<const GlobalIndirectSymbol *>(this)->getIndirectSymbol());
58 const GlobalObject *getBaseObject() const {
59 return dyn_cast<GlobalObject>(getIndirectSymbol()->stripInBoundsOffsets());
61 GlobalObject *getBaseObject() {
62 return const_cast<GlobalObject *>(
63 static_cast<const GlobalIndirectSymbol *>(this)->getBaseObject());
66 const GlobalObject *getBaseObject(const DataLayout &DL, APInt &Offset) const {
67 return dyn_cast<GlobalObject>(
68 getIndirectSymbol()->stripAndAccumulateInBoundsConstantOffsets(DL,
71 GlobalObject *getBaseObject(const DataLayout &DL, APInt &Offset) {
72 return const_cast<GlobalObject *>(
73 static_cast<const GlobalIndirectSymbol *>(this)
74 ->getBaseObject(DL, Offset));
77 // Methods for support type inquiry through isa, cast, and dyn_cast:
78 static bool classof(const Value *V) {
79 return V->getValueID() == Value::GlobalAliasVal ||
80 V->getValueID() == Value::GlobalIFuncVal;
85 struct OperandTraits<GlobalIndirectSymbol> :
86 public FixedNumOperandTraits<GlobalIndirectSymbol, 1> {
89 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(GlobalIndirectSymbol, Constant)
91 } // end namespace llvm
93 #endif // LLVM_IR_GLOBALINDIRECTSYMBOL_H