LLVM 17.0.0git
GlobalAlias.h
Go to the documentation of this file.
1//===-------- llvm/GlobalAlias.h - GlobalAlias class ------------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// This file contains the declaration of the GlobalAlias class, which
10// represents a single function or variable alias in the IR.
11//
12//===----------------------------------------------------------------------===//
13
14#ifndef LLVM_IR_GLOBALALIAS_H
15#define LLVM_IR_GLOBALALIAS_H
16
17#include "llvm/ADT/ilist_node.h"
18#include "llvm/IR/GlobalValue.h"
20#include "llvm/IR/Value.h"
21
22namespace llvm {
23
24class Twine;
25class Module;
26template <typename ValueSubClass> class SymbolTableListTraits;
27
28class GlobalAlias : public GlobalValue, public ilist_node<GlobalAlias> {
30
32 const Twine &Name, Constant *Aliasee, Module *Parent);
33
34public:
35 GlobalAlias(const GlobalAlias &) = delete;
36 GlobalAlias &operator=(const GlobalAlias &) = delete;
37
38 /// If a parent module is specified, the alias is automatically inserted into
39 /// the end of the specified module's alias list.
40 static GlobalAlias *create(Type *Ty, unsigned AddressSpace,
42 Constant *Aliasee, Module *Parent);
43
44 // Without the Aliasee.
45 static GlobalAlias *create(Type *Ty, unsigned AddressSpace,
47 Module *Parent);
48
49 // The module is taken from the Aliasee.
50 static GlobalAlias *create(Type *Ty, unsigned AddressSpace,
52 GlobalValue *Aliasee);
53
54 // Type, Parent and AddressSpace taken from the Aliasee.
56 GlobalValue *Aliasee);
57
58 // Linkage, Type, Parent and AddressSpace taken from the Aliasee.
59 static GlobalAlias *create(const Twine &Name, GlobalValue *Aliasee);
60
61 // allocate space for exactly one operand
62 void *operator new(size_t S) { return User::operator new(S, 1); }
63 void operator delete(void *Ptr) { User::operator delete(Ptr); }
64
65 /// Provide fast operand accessors
67
70 }
71
72 /// removeFromParent - This method unlinks 'this' from the containing module,
73 /// but does not delete it.
74 ///
75 void removeFromParent();
76
77 /// eraseFromParent - This method unlinks 'this' from the containing module
78 /// and deletes it.
79 ///
80 void eraseFromParent();
81
82 /// These methods retrieve and set alias target.
83 void setAliasee(Constant *Aliasee);
84 const Constant *getAliasee() const {
85 return static_cast<Constant *>(Op<0>().get());
86 }
87 Constant *getAliasee() { return static_cast<Constant *>(Op<0>().get()); }
88
89 const GlobalObject *getAliaseeObject() const;
91 return const_cast<GlobalObject *>(
92 static_cast<const GlobalAlias *>(this)->getAliaseeObject());
93 }
94
96 return isExternalLinkage(L) || isLocalLinkage(L) || isWeakLinkage(L) ||
98 }
99
100 // Methods for support type inquiry through isa, cast, and dyn_cast:
101 static bool classof(const Value *V) {
102 return V->getValueID() == Value::GlobalAliasVal;
103 }
104};
105
106template <>
108 : public FixedNumOperandTraits<GlobalAlias, 1> {};
109
111
112} // end namespace llvm
113
114#endif // LLVM_IR_GLOBALALIAS_H
std::string Name
#define DEFINE_TRANSPARENT_OPERAND_ACCESSORS(CLASS, VALUECLASS)
Macro for generating out-of-class operand accessor definitions.
This is an important base class in LLVM.
Definition: Constant.h:41
void eraseFromParent()
eraseFromParent - This method unlinks 'this' from the containing module and deletes it.
Definition: Globals.cpp:552
static bool isValidLinkage(LinkageTypes L)
Definition: GlobalAlias.h:95
const GlobalObject * getAliaseeObject() const
Definition: Globals.cpp:562
GlobalAlias & operator=(const GlobalAlias &)=delete
DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Constant)
Provide fast operand accessors.
void setAliasee(Constant *Aliasee)
These methods retrieve and set alias target.
Definition: Globals.cpp:556
Constant * getAliasee()
Definition: GlobalAlias.h:87
const Constant * getAliasee() const
Definition: GlobalAlias.h:84
static bool classof(const Value *V)
Definition: GlobalAlias.h:101
static GlobalAlias * create(Type *Ty, unsigned AddressSpace, LinkageTypes Linkage, const Twine &Name, Constant *Aliasee, Module *Parent)
If a parent module is specified, the alias is automatically inserted into the end of the specified mo...
Definition: Globals.cpp:520
GlobalAlias(const GlobalAlias &)=delete
void removeFromParent()
removeFromParent - This method unlinks 'this' from the containing module, but does not delete it.
Definition: Globals.cpp:548
GlobalObject * getAliaseeObject()
Definition: GlobalAlias.h:90
void copyAttributesFrom(const GlobalAlias *Src)
Definition: GlobalAlias.h:68
static bool isLocalLinkage(LinkageTypes Linkage)
Definition: GlobalValue.h:404
static bool isLinkOnceLinkage(LinkageTypes Linkage)
Definition: GlobalValue.h:383
static bool isAvailableExternallyLinkage(LinkageTypes Linkage)
Definition: GlobalValue.h:374
static bool isExternalLinkage(LinkageTypes Linkage)
Definition: GlobalValue.h:371
void copyAttributesFrom(const GlobalValue *Src)
Copy all additional attributes (those not needed to create a GlobalValue) from the GlobalValue Src to...
Definition: Globals.cpp:63
static bool isWeakLinkage(LinkageTypes Linkage)
Definition: GlobalValue.h:392
unsigned Linkage
Definition: GlobalValue.h:94
LinkageTypes
An enumeration for the kinds of linkage for global values.
Definition: GlobalValue.h:47
A Module instance is used to store all the information related to an LLVM module.
Definition: Module.h:65
Twine - A lightweight data structure for efficiently representing the concatenation of temporary valu...
Definition: Twine.h:81
The instances of the Type class are immutable: once they are created, they are never changed.
Definition: Type.h:45
LLVM Value Representation.
Definition: Value.h:74
unsigned getValueID() const
Return an ID for the concrete type of this object.
Definition: Value.h:532
This file defines the ilist_node class template, which is a convenient base class for creating classe...
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
AddressSpace
Definition: NVPTXBaseInfo.h:21
FixedNumOperandTraits - determine the allocation regime of the Use array when it is a prefix to the U...
Definition: OperandTraits.h:30
Compile-time customization of User operands.
Definition: User.h:42