LLVM 22.0.0git
Globals.cpp
Go to the documentation of this file.
1//===-- Globals.cpp - Implement the GlobalValue & GlobalVariable class ----===//
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 implements the GlobalValue & GlobalVariable classes for the IR
10// library.
11//
12//===----------------------------------------------------------------------===//
13
14#include "LLVMContextImpl.h"
16#include "llvm/IR/Constants.h"
18#include "llvm/IR/GlobalAlias.h"
19#include "llvm/IR/GlobalValue.h"
21#include "llvm/IR/MDBuilder.h"
22#include "llvm/IR/Module.h"
23#include "llvm/Support/Error.h"
25#include "llvm/Support/MD5.h"
27using namespace llvm;
28
29//===----------------------------------------------------------------------===//
30// GlobalValue Class
31//===----------------------------------------------------------------------===//
32
33// GlobalValue should be a Constant, plus a type, a module, some flags, and an
34// intrinsic ID. Add an assert to prevent people from accidentally growing
35// GlobalValue while adding flags.
36static_assert(sizeof(GlobalValue) ==
37 sizeof(Constant) + 2 * sizeof(void *) + 2 * sizeof(unsigned),
38 "unexpected GlobalValue size growth");
39
40// GlobalObject adds a comdat.
41static_assert(sizeof(GlobalObject) == sizeof(GlobalValue) + sizeof(void *),
42 "unexpected GlobalObject size growth");
43
45 if (const Function *F = dyn_cast<Function>(this))
46 return F->isMaterializable();
47 return false;
48}
50
51/// Override destroyConstantImpl to make sure it doesn't get called on
52/// GlobalValue's because they shouldn't be treated like other constants.
53void GlobalValue::destroyConstantImpl() {
54 llvm_unreachable("You can't GV->destroyConstantImpl()!");
55}
56
57Value *GlobalValue::handleOperandChangeImpl(Value *From, Value *To) {
58 llvm_unreachable("Unsupported class for handleOperandChange()!");
59}
60
61/// copyAttributesFrom - copy all additional attributes (those not needed to
62/// create a GlobalValue) from the GlobalValue Src to this one.
64 setVisibility(Src->getVisibility());
65 setUnnamedAddr(Src->getUnnamedAddr());
66 setThreadLocalMode(Src->getThreadLocalMode());
67 setDLLStorageClass(Src->getDLLStorageClass());
68 setDSOLocal(Src->isDSOLocal());
69 setPartition(Src->getPartition());
70 if (Src->hasSanitizerMetadata())
71 setSanitizerMetadata(Src->getSanitizerMetadata());
72 else
74}
75
78 return MD5Hash(GlobalIdentifier);
79}
80
82 switch (getValueID()) {
83#define HANDLE_GLOBAL_VALUE(NAME) \
84 case Value::NAME##Val: \
85 return static_cast<NAME *>(this)->removeFromParent();
86#include "llvm/IR/Value.def"
87 default:
88 break;
89 }
90 llvm_unreachable("not a global");
91}
92
94 switch (getValueID()) {
95#define HANDLE_GLOBAL_VALUE(NAME) \
96 case Value::NAME##Val: \
97 return static_cast<NAME *>(this)->eraseFromParent();
98#include "llvm/IR/Value.def"
99 default:
100 break;
101 }
102 llvm_unreachable("not a global");
103}
104
106
109 return true;
111 !isDSOLocal();
112}
113
115 if (isTagged()) {
116 // Cannot create local aliases to MTE tagged globals. The address of a
117 // tagged global includes a tag that is assigned by the loader in the
118 // GOT.
119 return false;
120 }
121 // See AsmPrinter::getSymbolPreferLocal(). For a deduplicate comdat kind,
122 // references to a discarded local symbol from outside the group are not
123 // allowed, so avoid the local alias.
124 auto isDeduplicateComdat = [](const Comdat *C) {
125 return C && C->getSelectionKind() != Comdat::NoDeduplicate;
126 };
127 return hasDefaultVisibility() &&
129 !isa<GlobalIFunc>(this) && !isDeduplicateComdat(getComdat());
130}
131
133 return getParent()->getDataLayout();
134}
135
138 "Alignment is greater than MaximumAlignment!");
139 unsigned AlignmentData = encode(Align);
140 unsigned OldData = getGlobalValueSubClassData();
141 setGlobalValueSubClassData((OldData & ~AlignmentMask) | AlignmentData);
142 assert(getAlign() == Align && "Alignment representation error!");
143}
144
147 "Alignment is greater than MaximumAlignment!");
148 unsigned AlignmentData = encode(Align);
149 unsigned OldData = getGlobalValueSubClassData();
150 setGlobalValueSubClassData((OldData & ~AlignmentMask) | AlignmentData);
151 assert(getAlign() && *getAlign() == Align &&
152 "Alignment representation error!");
153}
154
157 setAlignment(Src->getAlign());
158 setSection(Src->getSection());
159}
160
163 StringRef FileName) {
164 // Value names may be prefixed with a binary '1' to indicate
165 // that the backend should not modify the symbols due to any platform
166 // naming convention. Do not include that '1' in the PGO profile name.
167 Name.consume_front("\1");
168
169 std::string GlobalName;
171 // For local symbols, prepend the main file name to distinguish them.
172 // Do not include the full path in the file name since there's no guarantee
173 // that it will stay the same, e.g., if the files are checked out from
174 // version control in different locations.
175 if (FileName.empty())
176 GlobalName += "<unknown>";
177 else
178 GlobalName += FileName;
179
180 GlobalName += GlobalIdentifierDelimiter;
181 }
182 GlobalName += Name;
183 return GlobalName;
184}
185
186std::string GlobalValue::getGlobalIdentifier() const {
188 getParent()->getSourceFileName());
189}
190
192 if (auto *GA = dyn_cast<GlobalAlias>(this)) {
193 // In general we cannot compute this at the IR level, but we try.
194 if (const GlobalObject *GO = GA->getAliaseeObject())
195 return GO->getSection();
196 return "";
197 }
198 return cast<GlobalObject>(this)->getSection();
199}
200
202 if (auto *GA = dyn_cast<GlobalAlias>(this)) {
203 // In general we cannot compute this at the IR level, but we try.
204 if (const GlobalObject *GO = GA->getAliaseeObject())
205 return const_cast<GlobalObject *>(GO)->getComdat();
206 return nullptr;
207 }
208 // ifunc and its resolver are separate things so don't use resolver comdat.
209 if (isa<GlobalIFunc>(this))
210 return nullptr;
211 return cast<GlobalObject>(this)->getComdat();
212}
213
215 if (ObjComdat)
216 ObjComdat->removeUser(this);
217 ObjComdat = C;
218 if (C)
219 C->addUser(this);
220}
221
223 if (!hasPartition())
224 return "";
225 return getContext().pImpl->GlobalValuePartitions[this];
226}
227
229 // Do nothing if we're clearing the partition and it is already empty.
230 if (!hasPartition() && S.empty())
231 return;
232
233 // Get or create a stable partition name string and put it in the table in the
234 // context.
235 if (!S.empty())
236 S = getContext().pImpl->Saver.save(S);
238
239 // Update the HasPartition field. Setting the partition to the empty string
240 // means this global no longer has a partition.
241 HasPartition = !S.empty();
242}
243
247 assert(getContext().pImpl->GlobalValueSanitizerMetadata.count(this));
249}
250
255
262
265 Meta.NoAddress = true;
266 Meta.NoHWAddress = true;
268}
269
270StringRef GlobalObject::getSectionImpl() const {
272 return getContext().pImpl->GlobalObjectSections[this];
273}
274
276 // Do nothing if we're clearing the section and it is already empty.
277 if (!hasSection() && S.empty())
278 return;
279
280 // Get or create a stable section name string and put it in the table in the
281 // context.
282 if (!S.empty())
283 S = getContext().pImpl->Saver.save(S);
285
286 // Update the HasSectionHashEntryBit. Setting the section to the empty string
287 // means this global no longer has a section.
288 setGlobalObjectFlag(HasSectionHashEntryBit, !S.empty());
289}
290
292 StringRef ExistingPrefix;
293 if (std::optional<StringRef> MaybePrefix = getSectionPrefix())
294 ExistingPrefix = *MaybePrefix;
295
296 if (ExistingPrefix == Prefix)
297 return false;
298
299 if (Prefix.empty()) {
300 setMetadata(LLVMContext::MD_section_prefix, nullptr);
301 return true;
302 }
303 MDBuilder MDB(getContext());
304 setMetadata(LLVMContext::MD_section_prefix,
306 return true;
307}
308
309std::optional<StringRef> GlobalObject::getSectionPrefix() const {
310 if (MDNode *MD = getMetadata(LLVMContext::MD_section_prefix)) {
311 [[maybe_unused]] StringRef MDName =
312 cast<MDString>(MD->getOperand(0))->getString();
313 assert((MDName == "section_prefix" ||
314 (isa<Function>(this) && MDName == "function_section_prefix")) &&
315 "Metadata not match");
316 return cast<MDString>(MD->getOperand(1))->getString();
317 }
318 return std::nullopt;
319}
320
321bool GlobalValue::isNobuiltinFnDef() const {
322 const Function *F = dyn_cast<Function>(this);
323 if (!F || F->empty())
324 return false;
325 return F->hasFnAttribute(Attribute::NoBuiltin);
326}
327
329 // Globals are definitions if they have an initializer.
330 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(this))
331 return GV->getNumOperands() == 0;
332
333 // Functions are definitions if they have a body.
334 if (const Function *F = dyn_cast<Function>(this))
335 return F->empty() && !F->isMaterializable();
336
337 // Aliases and ifuncs are always definitions.
339 return false;
340}
341
343 // Firstly, can only increase the alignment of a global if it
344 // is a strong definition.
346 return false;
347
348 // It also has to either not have a section defined, or, not have
349 // alignment specified. (If it is assigned a section, the global
350 // could be densely packed with other objects in the section, and
351 // increasing the alignment could cause padding issues.)
352 if (hasSection() && getAlign())
353 return false;
354
355 // On ELF platforms, we're further restricted in that we can't
356 // increase the alignment of any variable which might be emitted
357 // into a shared library, and which is exported. If the main
358 // executable accesses a variable found in a shared-lib, the main
359 // exe actually allocates memory for and exports the symbol ITSELF,
360 // overriding the symbol found in the library. That is, at link
361 // time, the observed alignment of the variable is copied into the
362 // executable binary. (A COPY relocation is also generated, to copy
363 // the initial data from the shadowed variable in the shared-lib
364 // into the location in the main binary, before running code.)
365 //
366 // And thus, even though you might think you are defining the
367 // global, and allocating the memory for the global in your object
368 // file, and thus should be able to set the alignment arbitrarily,
369 // that's not actually true. Doing so can cause an ABI breakage; an
370 // executable might have already been built with the previous
371 // alignment of the variable, and then assuming an increased
372 // alignment will be incorrect.
373
374 // Conservatively assume ELF if there's no parent pointer.
375 bool isELF = (!Parent || Parent->getTargetTriple().isOSBinFormatELF());
376 if (isELF && !isDSOLocal())
377 return false;
378
379 // GV with toc-data attribute is defined in a TOC entry. To mitigate TOC
380 // overflow, the alignment of such symbol should not be increased. Otherwise,
381 // padding is needed thus more TOC entries are wasted.
382 bool isXCOFF = (!Parent || Parent->getTargetTriple().isOSBinFormatXCOFF());
383 if (isXCOFF)
384 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(this))
385 if (GV->hasAttribute("toc-data"))
386 return false;
387
388 return true;
389}
390
391template <typename Operation>
392static const GlobalObject *
394 const Operation &Op) {
395 if (auto *GO = dyn_cast<GlobalObject>(C)) {
396 Op(*GO);
397 return GO;
398 }
399 if (auto *GA = dyn_cast<GlobalAlias>(C)) {
400 Op(*GA);
401 if (Aliases.insert(GA).second)
402 return findBaseObject(GA->getOperand(0), Aliases, Op);
403 }
404 if (auto *CE = dyn_cast<ConstantExpr>(C)) {
405 switch (CE->getOpcode()) {
406 case Instruction::Add: {
407 auto *LHS = findBaseObject(CE->getOperand(0), Aliases, Op);
408 auto *RHS = findBaseObject(CE->getOperand(1), Aliases, Op);
409 if (LHS && RHS)
410 return nullptr;
411 return LHS ? LHS : RHS;
412 }
413 case Instruction::Sub: {
414 if (findBaseObject(CE->getOperand(1), Aliases, Op))
415 return nullptr;
416 return findBaseObject(CE->getOperand(0), Aliases, Op);
417 }
418 case Instruction::IntToPtr:
419 case Instruction::PtrToAddr:
420 case Instruction::PtrToInt:
421 case Instruction::BitCast:
422 case Instruction::GetElementPtr:
423 return findBaseObject(CE->getOperand(0), Aliases, Op);
424 default:
425 break;
426 }
427 }
428 return nullptr;
429}
430
433 return findBaseObject(this, Aliases, [](const GlobalValue &) {});
434}
435
437 auto *GO = dyn_cast<GlobalObject>(this);
438 if (!GO)
439 return false;
440
441 return GO->getMetadata(LLVMContext::MD_absolute_symbol);
442}
443
444std::optional<ConstantRange> GlobalValue::getAbsoluteSymbolRange() const {
445 auto *GO = dyn_cast<GlobalObject>(this);
446 if (!GO)
447 return std::nullopt;
448
449 MDNode *MD = GO->getMetadata(LLVMContext::MD_absolute_symbol);
450 if (!MD)
451 return std::nullopt;
452
454}
455
458 return false;
459
460 // We assume that anyone who sets global unnamed_addr on a non-constant
461 // knows what they're doing.
463 return true;
464
465 // If it is a non constant variable, it needs to be uniqued across shared
466 // objects.
467 if (auto *Var = dyn_cast<GlobalVariable>(this))
468 if (!Var->isConstant())
469 return false;
470
472}
473
474//===----------------------------------------------------------------------===//
475// GlobalVariable Implementation
476//===----------------------------------------------------------------------===//
477
479 Constant *InitVal, const Twine &Name,
480 ThreadLocalMode TLMode, unsigned AddressSpace,
482 : GlobalObject(Ty, Value::GlobalVariableVal, AllocMarker, Link, Name,
484 isConstantGlobal(constant),
485 isExternallyInitializedConstant(isExternallyInitialized) {
486 assert(!Ty->isFunctionTy() && PointerType::isValidElementType(Ty) &&
487 "invalid type for global variable");
488 setThreadLocalMode(TLMode);
489 if (InitVal) {
490 assert(InitVal->getType() == Ty &&
491 "Initializer should be the same type as the GlobalVariable!");
492 Op<0>() = InitVal;
493 } else {
494 setGlobalVariableNumOperands(0);
495 }
496}
497
499 LinkageTypes Link, Constant *InitVal,
500 const Twine &Name, GlobalVariable *Before,
501 ThreadLocalMode TLMode,
502 std::optional<unsigned> AddressSpace,
504 : GlobalVariable(Ty, constant, Link, InitVal, Name, TLMode,
506 ? *AddressSpace
507 : M.getDataLayout().getDefaultGlobalsAddressSpace(),
509 if (Before)
510 Before->getParent()->insertGlobalVariable(Before->getIterator(), this);
511 else
512 M.insertGlobalVariable(this);
513}
514
518
522
524 if (!InitVal) {
525 if (hasInitializer()) {
526 // Note, the num operands is used to compute the offset of the operand, so
527 // the order here matters. Clearing the operand then clearing the num
528 // operands ensures we have the correct offset to the operand.
529 Op<0>().set(nullptr);
530 setGlobalVariableNumOperands(0);
531 }
532 } else {
533 assert(InitVal->getType() == getValueType() &&
534 "Initializer type must match GlobalVariable type");
535 // Note, the num operands is used to compute the offset of the operand, so
536 // the order here matters. We need to set num operands to 1 first so that
537 // we get the correct offset to the first operand when we set it.
538 if (!hasInitializer())
539 setGlobalVariableNumOperands(1);
540 Op<0>().set(InitVal);
541 }
542}
543
545 assert(InitVal && "Can't compute type of null initializer");
546 ValueType = InitVal->getType();
547 setInitializer(InitVal);
548}
549
550/// Copy all additional attributes (those not needed to create a GlobalVariable)
551/// from the GlobalVariable Src to this one.
554 setExternallyInitialized(Src->isExternallyInitialized());
555 setAttributes(Src->getAttributes());
556 if (auto CM = Src->getCodeModel())
557 setCodeModel(*CM);
558}
559
564
566 unsigned CodeModelData = static_cast<unsigned>(CM) + 1;
567 unsigned OldData = getGlobalValueSubClassData();
568 unsigned NewData = (OldData & ~(CodeModelMask << CodeModelShift)) |
569 (CodeModelData << CodeModelShift);
571 assert(getCodeModel() == CM && "Code model representation error!");
572}
573
575 unsigned CodeModelData = 0;
576 unsigned OldData = getGlobalValueSubClassData();
577 unsigned NewData = (OldData & ~(CodeModelMask << CodeModelShift)) |
578 (CodeModelData << CodeModelShift);
580 assert(getCodeModel() == std::nullopt && "Code model representation error!");
581}
582
583//===----------------------------------------------------------------------===//
584// GlobalAlias Implementation
585//===----------------------------------------------------------------------===//
586
587GlobalAlias::GlobalAlias(Type *Ty, unsigned AddressSpace, LinkageTypes Link,
588 const Twine &Name, Constant *Aliasee,
589 Module *ParentModule)
590 : GlobalValue(Ty, Value::GlobalAliasVal, AllocMarker, Link, Name,
591 AddressSpace) {
592 setAliasee(Aliasee);
593 if (ParentModule)
594 ParentModule->insertAlias(this);
595}
596
597GlobalAlias *GlobalAlias::create(Type *Ty, unsigned AddressSpace,
598 LinkageTypes Link, const Twine &Name,
599 Constant *Aliasee, Module *ParentModule) {
600 return new GlobalAlias(Ty, AddressSpace, Link, Name, Aliasee, ParentModule);
601}
602
603GlobalAlias *GlobalAlias::create(Type *Ty, unsigned AddressSpace,
604 LinkageTypes Linkage, const Twine &Name,
605 Module *Parent) {
606 return create(Ty, AddressSpace, Linkage, Name, nullptr, Parent);
607}
608
609GlobalAlias *GlobalAlias::create(Type *Ty, unsigned AddressSpace,
610 LinkageTypes Linkage, const Twine &Name,
611 GlobalValue *Aliasee) {
612 return create(Ty, AddressSpace, Linkage, Name, Aliasee, Aliasee->getParent());
613}
614
615GlobalAlias *GlobalAlias::create(LinkageTypes Link, const Twine &Name,
616 GlobalValue *Aliasee) {
617 return create(Aliasee->getValueType(), Aliasee->getAddressSpace(), Link, Name,
618 Aliasee);
619}
620
621GlobalAlias *GlobalAlias::create(const Twine &Name, GlobalValue *Aliasee) {
622 return create(Aliasee->getLinkage(), Name, Aliasee);
623}
624
626
628
630 assert((!Aliasee || Aliasee->getType() == getType()) &&
631 "Alias and aliasee types should match!");
632 Op<0>().set(Aliasee);
633}
634
637 return findBaseObject(getOperand(0), Aliases, [](const GlobalValue &) {});
638}
639
640//===----------------------------------------------------------------------===//
641// GlobalIFunc Implementation
642//===----------------------------------------------------------------------===//
643
644GlobalIFunc::GlobalIFunc(Type *Ty, unsigned AddressSpace, LinkageTypes Link,
645 const Twine &Name, Constant *Resolver,
646 Module *ParentModule)
647 : GlobalObject(Ty, Value::GlobalIFuncVal, AllocMarker, Link, Name,
648 AddressSpace) {
649 setResolver(Resolver);
650 if (ParentModule)
651 ParentModule->insertIFunc(this);
652}
653
654GlobalIFunc *GlobalIFunc::create(Type *Ty, unsigned AddressSpace,
655 LinkageTypes Link, const Twine &Name,
656 Constant *Resolver, Module *ParentModule) {
657 return new GlobalIFunc(Ty, AddressSpace, Link, Name, Resolver, ParentModule);
658}
659
661
663
667
assert(UImm &&(UImm !=~static_cast< T >(0)) &&"Invalid immediate!")
This file contains the declarations for the subclasses of Constant, which represent the different fla...
GlobalValue::SanitizerMetadata SanitizerMetadata
Definition Globals.cpp:244
static const GlobalObject * findBaseObject(const Constant *C, DenseSet< const GlobalAlias * > &Aliases, const Operation &Op)
Definition Globals.cpp:393
Module.h This file contains the declarations for the Module class.
#define F(x, y, z)
Definition MD5.cpp:55
PowerPC Reduce CR logical Operation
Value * RHS
Value * LHS
@ NoDeduplicate
No deduplication is performed.
Definition Comdat.h:40
This is an important base class in LLVM.
Definition Constant.h:43
A parsed version of the target data layout string in and methods for querying it.
Definition DataLayout.h:63
bool erase(const KeyT &Val)
Definition DenseMap.h:303
Implements a dense probed hash-table based set.
Definition DenseSet.h:269
Lightweight error class with error context and mandatory checking.
Definition Error.h:159
LLVM_ABI void eraseFromParent()
eraseFromParent - This method unlinks 'this' from the containing module and deletes it.
Definition Globals.cpp:627
LLVM_ABI const GlobalObject * getAliaseeObject() const
Definition Globals.cpp:635
LLVM_ABI void setAliasee(Constant *Aliasee)
These methods retrieve and set alias target.
Definition Globals.cpp:629
static LLVM_ABI 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:597
LLVM_ABI void removeFromParent()
removeFromParent - This method unlinks 'this' from the containing module, but does not delete it.
Definition Globals.cpp:625
LLVM_ABI void applyAlongResolverPath(function_ref< void(const GlobalValue &)> Op) const
Definition Globals.cpp:668
LLVM_ABI const Function * getResolverFunction() const
Definition Globals.cpp:664
LLVM_ABI void removeFromParent()
This method unlinks 'this' from the containing module, but does not delete it.
Definition Globals.cpp:660
static LLVM_ABI GlobalIFunc * create(Type *Ty, unsigned AddressSpace, LinkageTypes Linkage, const Twine &Name, Constant *Resolver, Module *Parent)
If a parent module is specified, the ifunc is automatically inserted into the end of the specified mo...
Definition Globals.cpp:654
LLVM_ABI void eraseFromParent()
This method unlinks 'this' from the containing module and deletes it.
Definition Globals.cpp:662
const Constant * getResolver() const
Definition GlobalIFunc.h:73
MaybeAlign getAlign() const
Returns the alignment of the given variable or function.
LLVM_ABI bool setSectionPrefix(StringRef Prefix)
If existing prefix is different from Prefix, set it to Prefix.
Definition Globals.cpp:291
LLVM_ABI void setMetadata(unsigned KindID, MDNode *Node)
Set a particular kind of metadata attachment.
LLVM_ABI void setAlignment(Align Align)
Sets the alignment attribute of the GlobalObject.
Definition Globals.cpp:145
GlobalObject(Type *Ty, ValueTy VTy, AllocInfo AllocInfo, LinkageTypes Linkage, const Twine &Name, unsigned AddressSpace=0)
LLVM_ABI void setComdat(Comdat *C)
Definition Globals.cpp:214
LLVM_ABI void copyAttributesFrom(const GlobalObject *Src)
Definition Globals.cpp:155
LLVM_ABI void setSection(StringRef S)
Change the section for this global.
Definition Globals.cpp:275
LLVM_ABI ~GlobalObject()
Definition Globals.cpp:105
LLVM_ABI std::optional< StringRef > getSectionPrefix() const
Get the section prefix for this global object.
Definition Globals.cpp:309
LLVM_ABI void clearMetadata()
Erase all metadata attached to this Value.
bool hasSection() const
Check if this global has a custom object file section.
MDNode * getMetadata(unsigned KindID) const
Get the current metadata attachments for the given kind, if any.
Definition Value.h:576
LLVM_ABI bool canIncreaseAlignment() const
Returns true if the alignment of the value can be unilaterally increased.
Definition Globals.cpp:342
unsigned HasSanitizerMetadata
True if this symbol has sanitizer metadata available.
bool hasPartition() const
static LLVM_ABI GUID getGUIDAssumingExternalLinkage(StringRef GlobalName)
Return a 64-bit global unique ID constructed from the name of a global symbol.
Definition Globals.cpp:77
LLVM_ABI const SanitizerMetadata & getSanitizerMetadata() const
Definition Globals.cpp:245
bool isDSOLocal() const
unsigned HasPartition
True if this symbol has a partition name assigned (see https://lld.llvm.org/Partitions....
LLVM_ABI void removeSanitizerMetadata()
Definition Globals.cpp:256
static bool isLocalLinkage(LinkageTypes Linkage)
LLVM_ABI bool isDeclaration() const
Return true if the primary definition of this global value is outside of the current translation unit...
Definition Globals.cpp:328
LinkageTypes getLinkage() const
void setUnnamedAddr(UnnamedAddr Val)
uint64_t GUID
Declare a type to represent a global unique identifier for a global value.
bool hasDefaultVisibility() const
LLVM_ABI bool isAbsoluteSymbolRef() const
Returns whether this is a reference to an absolute symbol.
Definition Globals.cpp:436
bool isTagged() const
void setDLLStorageClass(DLLStorageClassTypes C)
LLVM_ABI const Comdat * getComdat() const
Definition Globals.cpp:201
void setThreadLocalMode(ThreadLocalMode Val)
friend class Constant
bool hasSanitizerMetadata() const
unsigned getAddressSpace() const
LLVM_ABI StringRef getSection() const
Definition Globals.cpp:191
LLVM_ABI StringRef getPartition() const
Definition Globals.cpp:222
Module * getParent()
Get the module that this global value is contained inside of...
LLVM_ABI const GlobalObject * getAliaseeObject() const
Definition Globals.cpp:431
void setDSOLocal(bool Local)
LLVM_ABI std::optional< ConstantRange > getAbsoluteSymbolRange() const
If this is an absolute symbol reference, returns the range of the symbol, otherwise returns std::null...
Definition Globals.cpp:444
LLVM_ABI void eraseFromParent()
This method unlinks 'this' from the containing module and deletes it.
Definition Globals.cpp:93
static bool isExternalLinkage(LinkageTypes Linkage)
bool isStrongDefinitionForLinker() const
Returns true if this global's definition will be the one chosen by the linker.
PointerType * getType() const
Global values are always pointers.
LLVM_ABI 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 LLVM_ABI std::string getGlobalIdentifier(StringRef Name, GlobalValue::LinkageTypes Linkage, StringRef FileName)
Return the modified name for a global value suitable to be used as the key for a global lookup (e....
Definition Globals.cpp:161
LLVM_ABI void setNoSanitizeMetadata()
Definition Globals.cpp:263
LLVM_ABI bool isInterposable() const
Return true if this global's definition can be substituted with an arbitrary definition at link time ...
Definition Globals.cpp:107
void setVisibility(VisibilityTypes V)
LLVM_ABI const DataLayout & getDataLayout() const
Get the data layout of the module this global belongs to.
Definition Globals.cpp:132
LLVM_ABI bool canBenefitFromLocalAlias() const
Definition Globals.cpp:114
static bool isInterposableLinkage(LinkageTypes Linkage)
Whether the definition of this global may be replaced by something non-equivalent at link time.
bool hasAtLeastLocalUnnamedAddr() const
Returns true if this value's address is not significant in this module.
unsigned getGlobalValueSubClassData() const
void setGlobalValueSubClassData(unsigned V)
LLVM_ABI bool isMaterializable() const
If this function's Module is being lazily streamed in functions from disk or some other source,...
Definition Globals.cpp:44
bool hasGlobalUnnamedAddr() const
LLVM_ABI Error materialize()
Make sure this GlobalValue is fully read.
Definition Globals.cpp:49
LLVM_ABI void setSanitizerMetadata(SanitizerMetadata Meta)
Definition Globals.cpp:251
bool hasLinkOnceODRLinkage() const
LLVM_ABI bool canBeOmittedFromSymbolTable() const
True if GV can be left out of the object symbol table.
Definition Globals.cpp:456
LLVM_ABI void removeFromParent()
This method unlinks 'this' from the containing module, but does not delete it.
Definition Globals.cpp:81
LinkageTypes
An enumeration for the kinds of linkage for global values.
Definition GlobalValue.h:52
Type * getValueType() const
GlobalValue(Type *Ty, ValueTy VTy, AllocInfo AllocInfo, LinkageTypes Linkage, const Twine &Name, unsigned AddressSpace)
Definition GlobalValue.h:81
LLVM_ABI void setPartition(StringRef Part)
Definition Globals.cpp:228
LLVM_ABI void setInitializer(Constant *InitVal)
setInitializer - Sets the initializer for this global variable, removing any existing initializer if ...
Definition Globals.cpp:523
bool isExternallyInitialized() const
bool hasInitializer() const
Definitions have initializers, declarations don't.
LLVM_ABI void removeFromParent()
removeFromParent - This method unlinks 'this' from the containing module, but does not delete it.
Definition Globals.cpp:515
std::optional< CodeModel::Model > getCodeModel() const
Get the custom code model of this global if it has one.
void setAttributes(AttributeSet A)
Set attribute list for this global.
LLVM_ABI void replaceInitializer(Constant *InitVal)
replaceInitializer - Sets the initializer for this global variable, and sets the value type of the gl...
Definition Globals.cpp:544
LLVM_ABI void clearCodeModel()
Remove the code model for this global.
Definition Globals.cpp:574
LLVM_ABI void copyAttributesFrom(const GlobalVariable *Src)
copyAttributesFrom - copy all additional attributes (those not needed to create a GlobalVariable) fro...
Definition Globals.cpp:552
LLVM_ABI void setCodeModel(CodeModel::Model CM)
Change the code model for this global.
Definition Globals.cpp:565
void setExternallyInitialized(bool Val)
LLVM_ABI void eraseFromParent()
eraseFromParent - This method unlinks 'this' from the containing module and deletes it.
Definition Globals.cpp:519
LLVM_ABI void dropAllReferences()
Drop all references in preparation to destroy the GlobalVariable.
Definition Globals.cpp:560
LLVM_ABI GlobalVariable(Type *Ty, bool isConstant, LinkageTypes Linkage, Constant *Initializer=nullptr, const Twine &Name="", ThreadLocalMode=NotThreadLocal, unsigned AddressSpace=0, bool isExternallyInitialized=false)
GlobalVariable ctor - If a parent module is specified, the global is automatically inserted into the ...
Definition Globals.cpp:478
DenseMap< const GlobalValue *, StringRef > GlobalValuePartitions
Collection of per-GlobalValue partitions used in this context.
DenseMap< const GlobalValue *, GlobalValue::SanitizerMetadata > GlobalValueSanitizerMetadata
DenseMap< const GlobalObject *, StringRef > GlobalObjectSections
Collection of per-GlobalObject sections used in this context.
UniqueStringSaver Saver
LLVMContextImpl *const pImpl
Definition LLVMContext.h:70
LLVM_ABI MDNode * createGlobalObjectSectionPrefix(StringRef Prefix)
Return metadata containing the section prefix for a global object.
Definition MDBuilder.cpp:91
Metadata node.
Definition Metadata.h:1077
A Module instance is used to store all the information related to an LLVM module.
Definition Module.h:67
void removeIFunc(GlobalIFunc *IFunc)
Detach IFunc from the list but don't delete it.
Definition Module.h:613
void insertIFunc(GlobalIFunc *IFunc)
Insert IFunc at the end of the alias list and take ownership.
Definition Module.h:617
llvm::Error materialize(GlobalValue *GV)
Make sure the GlobalValue is fully read.
Definition Module.cpp:467
bool getSemanticInterposition() const
Returns whether semantic interposition is to be respected.
Definition Module.cpp:694
void removeAlias(GlobalAlias *Alias)
Detach Alias from the list but don't delete it.
Definition Module.h:604
void eraseIFunc(GlobalIFunc *IFunc)
Remove IFunc from the list and delete it.
Definition Module.h:615
void eraseAlias(GlobalAlias *Alias)
Remove Alias from the list and delete it.
Definition Module.h:606
void eraseGlobalVariable(GlobalVariable *GV)
Remove global variable GV from the list and delete it.
Definition Module.h:565
void insertGlobalVariable(GlobalVariable *GV)
Insert global variable GV at the end of the global variable list and take ownership.
Definition Module.h:568
const DataLayout & getDataLayout() const
Get the data layout for the module's target platform.
Definition Module.h:278
void insertAlias(GlobalAlias *Alias)
Insert Alias at the end of the alias list and take ownership.
Definition Module.h:608
void removeGlobalVariable(GlobalVariable *GV)
Detach global variable GV from the list but don't delete it.
Definition Module.h:563
static LLVM_ABI bool isValidElementType(Type *ElemTy)
Return true if the specified type is valid as a element type.
Definition Type.cpp:876
Interface for looking up the initializer for a variable name, used by Init::resolveReferences.
Definition Record.h:2199
StringRef - Represent a constant reference to a string, i.e.
Definition StringRef.h:55
constexpr bool empty() const
empty - Check if the string is empty.
Definition StringRef.h:151
Twine - A lightweight data structure for efficiently representing the concatenation of temporary valu...
Definition Twine.h:82
The instances of the Type class are immutable: once they are created, they are never changed.
Definition Type.h:45
StringRef save(const char *S)
Definition StringSaver.h:53
void dropAllReferences()
Drop all references to operands.
Definition User.h:349
Value * getOperand(unsigned i) const
Definition User.h:232
LLVM Value Representation.
Definition Value.h:75
Type * getType() const
All values are typed, get the type of this value.
Definition Value.h:256
static constexpr uint64_t MaximumAlignment
Definition Value.h:830
LLVM_ABI const Value * stripPointerCastsAndAliases() const
Strip off pointer casts, all-zero GEPs, address space casts, and aliases.
Definition Value.cpp:705
unsigned getValueID() const
Return an ID for the concrete type of this object.
Definition Value.h:543
LLVM_ABI LLVMContext & getContext() const
All values hold a context through their type.
Definition Value.cpp:1101
LLVM_ABI StringRef getName() const
Return a constant reference to the value's name.
Definition Value.cpp:322
std::pair< iterator, bool > insert(const ValueT &V)
Definition DenseSet.h:194
An efficient, type-erasing, non-owning reference to a callable.
self_iterator getIterator()
Definition ilist_node.h:130
#define llvm_unreachable(msg)
Marks that the current location is not supposed to be reachable.
@ C
The default llvm calling convention, compatible with C.
Definition CallingConv.h:34
uint64_t MD5Hash(const FunctionId &Obj)
Definition FunctionId.h:167
This is an optimization pass for GlobalISel generic memory operations.
unsigned encode(MaybeAlign A)
Returns a representation of the alignment that encodes undefined as 0.
Definition Alignment.h:217
decltype(auto) dyn_cast(const From &Val)
dyn_cast<X> - Return the argument parameter cast to the specified type.
Definition Casting.h:649
LLVM_ABI ConstantRange getConstantRangeFromMetadata(const MDNode &RangeMD)
Parse out a conservative ConstantRange from !range metadata.
bool isa(const From &Val)
isa<X> - Return true if the parameter to the template is an instance of one of the template type argu...
Definition Casting.h:548
DWARFExpression::Operation Op
constexpr char GlobalIdentifierDelimiter
Definition GlobalValue.h:47
decltype(auto) cast(const From &Val)
cast<X> - Return the argument parameter cast to the specified type.
Definition Casting.h:565
PointerUnion< const Value *, const PseudoSourceValue * > ValueType
This struct is a compact representation of a valid (non-zero power of two) alignment.
Definition Alignment.h:39
This struct is a compact representation of a valid (power of two) or undefined (0) alignment.
Definition Alignment.h:117