LLVM 23.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"
17#include "llvm/IR/DataLayout.h"
19#include "llvm/IR/GlobalAlias.h"
20#include "llvm/IR/GlobalValue.h"
22#include "llvm/IR/MDBuilder.h"
23#include "llvm/IR/Module.h"
24#include "llvm/Support/Error.h"
26#include "llvm/Support/MD5.h"
28using namespace llvm;
29
30//===----------------------------------------------------------------------===//
31// GlobalValue Class
32//===----------------------------------------------------------------------===//
33
34// GlobalValue should be a Constant, plus a type, a module, some flags, and an
35// intrinsic ID. Add an assert to prevent people from accidentally growing
36// GlobalValue while adding flags.
37static_assert(sizeof(GlobalValue) ==
38 sizeof(Constant) + 2 * sizeof(void *) + 2 * sizeof(unsigned),
39 "unexpected GlobalValue size growth");
40
41// GlobalObject adds a comdat and metadata index.
42static_assert(sizeof(GlobalObject) ==
43 sizeof(GlobalValue) + sizeof(void *) +
44 alignTo(sizeof(unsigned), alignof(void *)),
45 "unexpected GlobalObject size growth");
46
48 if (const Function *F = dyn_cast<Function>(this))
49 return F->isMaterializable();
50 return false;
51}
53
54/// Override destroyConstantImpl to make sure it doesn't get called on
55/// GlobalValue's because they shouldn't be treated like other constants.
56void GlobalValue::destroyConstantImpl() {
57 llvm_unreachable("You can't GV->destroyConstantImpl()!");
58}
59
60Value *GlobalValue::handleOperandChangeImpl(Value *From, Value *To) {
61 llvm_unreachable("Unsupported class for handleOperandChange()!");
62}
63
64/// copyAttributesFrom - copy all additional attributes (those not needed to
65/// create a GlobalValue) from the GlobalValue Src to this one.
67 setVisibility(Src->getVisibility());
68 setUnnamedAddr(Src->getUnnamedAddr());
69 setThreadLocalMode(Src->getThreadLocalMode());
70 setDLLStorageClass(Src->getDLLStorageClass());
71 setDSOLocal(Src->isDSOLocal());
72 setPartition(Src->getPartition());
73 if (Src->hasSanitizerMetadata())
74 setSanitizerMetadata(Src->getSanitizerMetadata());
75 else
77}
78
81 return MD5Hash(GlobalIdentifier);
82}
83
84void GlobalValue::assignGUID() {
85 if (getGUIDMetadata() != nullptr)
86 return;
87
88 const GUID G =
91 LLVMContext::MD_unique_id,
94}
95
97 if (!getGUIDMetadata())
98 return;
99 eraseMetadata(LLVMContext::MD_unique_id);
100 assignGUID();
101}
102
104 auto MaybeGUID = getGUIDIfAssigned();
105 assert(MaybeGUID.has_value() &&
106 "GUID was not assigned before calling GetGUID()");
107 return *MaybeGUID;
108}
109
111 if (auto MaybeGUID = getGUIDIfAssigned(); MaybeGUID)
112 return *MaybeGUID;
114}
115
116std::optional<GlobalValue::GUID> GlobalValue::getGUIDIfAssigned() const {
117 // First check the metadata.
118 auto *MD = getGUIDMetadata();
119 if (MD != nullptr)
120 return cast<ConstantInt>(cast<ConstantAsMetadata>(MD->getOperand(0))
121 ->getValue()
122 ->stripPointerCasts())
123 ->getZExtValue();
124
125 // Handle a few special cases where we just want to compute it based on the
126 // current properties.
127 // TODO: Maybe we should use a more robust check for intrinsics than just
128 // matching on the name?
129 if (isDeclaration() || isa<GlobalAlias>(this) ||
130 getName().starts_with("llvm.")) {
132 }
133
134 // Otherwise we try to look it up in the module, for cases where we've read
135 // the GUID table but not the metadata. This happens when lazy-loading a
136 // module.
137 return getParent()->getGUID(this);
138}
139
140MDNode *GlobalValue::getGUIDMetadata() const {
141 if (auto *GO = dyn_cast<GlobalObject>(this))
142 return GO->getMetadata(LLVMContext::MD_unique_id);
143 return nullptr;
144}
145
147 switch (getValueID()) {
148#define HANDLE_GLOBAL_VALUE(NAME) \
149 case Value::NAME##Val: \
150 return static_cast<NAME *>(this)->removeFromParent();
151#include "llvm/IR/Value.def"
152 default:
153 break;
154 }
155 llvm_unreachable("not a global");
156}
157
159 switch (getValueID()) {
160#define HANDLE_GLOBAL_VALUE(NAME) \
161 case Value::NAME##Val: \
162 return static_cast<NAME *>(this)->eraseFromParent();
163#include "llvm/IR/Value.def"
164 default:
165 break;
166 }
167 llvm_unreachable("not a global");
168}
169
171 // Remove associated metadata from context.
172 if (hasMetadata())
174
175 setComdat(nullptr);
176}
177
178bool GlobalValue::isInterposable(bool CheckNoIPA) const {
179 if (CheckNoIPA && isNoipaFnDef())
180 return true;
182 return true;
183 return !isDSOLocal() && getParent() &&
185}
186
188 if (isTagged()) {
189 // Cannot create local aliases to MTE tagged globals. The address of a
190 // tagged global includes a tag that is assigned by the loader in the
191 // GOT.
192 return false;
193 }
194 // See AsmPrinter::getSymbolPreferLocal(). For a deduplicate comdat kind,
195 // references to a discarded local symbol from outside the group are not
196 // allowed, so avoid the local alias.
197 auto isDeduplicateComdat = [](const Comdat *C) {
198 return C && C->getSelectionKind() != Comdat::NoDeduplicate;
199 };
200 return hasDefaultVisibility() &&
202 !isa<GlobalIFunc>(this) && !isDeduplicateComdat(getComdat());
203}
204
206 return getParent()->getDataLayout();
207}
208
211 "Alignment is greater than MaximumAlignment!");
212 unsigned AlignmentData = encode(Align);
213 unsigned OldData = getGlobalValueSubClassData();
214 setGlobalValueSubClassData((OldData & ~AlignmentMask) | AlignmentData);
215 assert(getAlign() == Align && "Alignment representation error!");
216}
217
220 "Alignment is greater than MaximumAlignment!");
221 unsigned AlignmentData = encode(Align);
222 unsigned OldData = getGlobalValueSubClassData();
223 setGlobalValueSubClassData((OldData & ~AlignmentMask) | AlignmentData);
224 assert(getAlign() && *getAlign() == Align &&
225 "Alignment representation error!");
226}
227
230 setAlignment(Src->getAlign());
231 setSection(Src->getSection());
232}
233
236 StringRef FileName) {
237 // Value names may be prefixed with a binary '1' to indicate
238 // that the backend should not modify the symbols due to any platform
239 // naming convention. Do not include that '1' in the PGO profile name.
240 Name.consume_front("\1");
241
242 std::string GlobalName;
244 // For local symbols, prepend the main file name to distinguish them.
245 // Do not include the full path in the file name since there's no guarantee
246 // that it will stay the same, e.g., if the files are checked out from
247 // version control in different locations.
248 if (FileName.empty())
249 GlobalName += "<unknown>";
250 else
251 GlobalName += FileName;
252
253 GlobalName += GlobalIdentifierDelimiter;
254 }
255 GlobalName += Name;
256 return GlobalName;
257}
258
259std::string GlobalValue::getGlobalIdentifier() const {
261 getParent()->getSourceFileName());
262}
263
265 if (auto *GA = dyn_cast<GlobalAlias>(this)) {
266 // In general we cannot compute this at the IR level, but we try.
267 if (const GlobalObject *GO = GA->getAliaseeObject())
268 return GO->getSection();
269 return "";
270 }
271 return cast<GlobalObject>(this)->getSection();
272}
273
275 if (auto *GA = dyn_cast<GlobalAlias>(this)) {
276 // In general we cannot compute this at the IR level, but we try.
277 if (const GlobalObject *GO = GA->getAliaseeObject())
278 return const_cast<GlobalObject *>(GO)->getComdat();
279 return nullptr;
280 }
281 // ifunc and its resolver are separate things so don't use resolver comdat.
282 if (isa<GlobalIFunc>(this))
283 return nullptr;
284 return cast<GlobalObject>(this)->getComdat();
285}
286
288 if (ObjComdat)
289 ObjComdat->removeUser(this);
290 ObjComdat = C;
291 if (C)
292 C->addUser(this);
293}
294
296 if (!hasPartition())
297 return "";
298 return getContext().pImpl->GlobalValuePartitions[this];
299}
300
302 // Do nothing if we're clearing the partition and it is already empty.
303 if (!hasPartition() && S.empty())
304 return;
305
306 // Get or create a stable partition name string and put it in the table in the
307 // context.
308 if (!S.empty())
309 S = getContext().pImpl->Saver.save(S);
311
312 // Update the HasPartition field. Setting the partition to the empty string
313 // means this global no longer has a partition.
314 HasPartition = !S.empty();
315}
316
320 assert(getContext().pImpl->GlobalValueSanitizerMetadata.count(this));
322}
323
328
335
338 Meta.NoAddress = true;
339 Meta.NoHWAddress = true;
341}
342
343StringRef GlobalObject::getSectionImpl() const {
345 return getContext().pImpl->GlobalObjectSections[this];
346}
347
349 // Do nothing if we're clearing the section and it is already empty.
350 if (!hasSection() && S.empty())
351 return;
352
353 // Get or create a stable section name string and put it in the table in the
354 // context.
355 if (!S.empty())
356 S = getContext().pImpl->Saver.save(S);
358
359 // Update the HasSectionHashEntryBit. Setting the section to the empty string
360 // means this global no longer has a section.
361 setGlobalObjectFlag(HasSectionHashEntryBit, !S.empty());
362}
363
365 StringRef ExistingPrefix;
366 if (std::optional<StringRef> MaybePrefix = getSectionPrefix())
367 ExistingPrefix = *MaybePrefix;
368
369 if (ExistingPrefix == Prefix)
370 return false;
371
372 if (Prefix.empty()) {
373 setMetadata(LLVMContext::MD_section_prefix, nullptr);
374 return true;
375 }
376 MDBuilder MDB(getContext());
377 setMetadata(LLVMContext::MD_section_prefix,
379 return true;
380}
381
382std::optional<StringRef> GlobalObject::getSectionPrefix() const {
383 if (MDNode *MD = getMetadata(LLVMContext::MD_section_prefix)) {
384 [[maybe_unused]] StringRef MDName =
385 cast<MDString>(MD->getOperand(0))->getString();
386 assert((MDName == "section_prefix" ||
387 (isa<Function>(this) && MDName == "function_section_prefix")) &&
388 "Metadata not match");
389 return cast<MDString>(MD->getOperand(1))->getString();
390 }
391 return std::nullopt;
392}
393
394bool GlobalValue::isNobuiltinFnDef() const {
395 const Function *F = dyn_cast<Function>(this);
396 if (!F || F->empty())
397 return false;
398 return F->hasFnAttribute(Attribute::NoBuiltin);
399}
400
401bool GlobalValue::isNoipaFnDef() const {
402 const Function *F = dyn_cast<Function>(this);
403 if (!F || F->isDeclaration())
404 return false;
405 return F->hasFnAttribute(Attribute::NoIPA);
406}
407
409 // Globals are definitions if they have an initializer.
410 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(this))
411 return GV->getNumOperands() == 0;
412
413 // Functions are definitions if they have a body.
414 if (const Function *F = dyn_cast<Function>(this))
415 return F->empty() && !F->isMaterializable();
416
417 // Aliases and ifuncs are always definitions.
419 return false;
420}
421
423 // Firstly, can only increase the alignment of a global if it
424 // is a strong definition.
426 return false;
427
428 // It also has to either not have a section defined, or, not have
429 // alignment specified. (If it is assigned a section, the global
430 // could be densely packed with other objects in the section, and
431 // increasing the alignment could cause padding issues.)
432 if (hasSection() && getAlign())
433 return false;
434
435 // On ELF platforms, we're further restricted in that we can't
436 // increase the alignment of any variable which might be emitted
437 // into a shared library, and which is exported. If the main
438 // executable accesses a variable found in a shared-lib, the main
439 // exe actually allocates memory for and exports the symbol ITSELF,
440 // overriding the symbol found in the library. That is, at link
441 // time, the observed alignment of the variable is copied into the
442 // executable binary. (A COPY relocation is also generated, to copy
443 // the initial data from the shadowed variable in the shared-lib
444 // into the location in the main binary, before running code.)
445 //
446 // And thus, even though you might think you are defining the
447 // global, and allocating the memory for the global in your object
448 // file, and thus should be able to set the alignment arbitrarily,
449 // that's not actually true. Doing so can cause an ABI breakage; an
450 // executable might have already been built with the previous
451 // alignment of the variable, and then assuming an increased
452 // alignment will be incorrect.
453
454 // Conservatively assume ELF if there's no parent pointer.
455 bool isELF = (!Parent || Parent->getTargetTriple().isOSBinFormatELF());
456 if (isELF && !isDSOLocal())
457 return false;
458
459 // GV with toc-data attribute is defined in a TOC entry. To mitigate TOC
460 // overflow, the alignment of such symbol should not be increased. Otherwise,
461 // padding is needed thus more TOC entries are wasted.
462 bool isXCOFF = (!Parent || Parent->getTargetTriple().isOSBinFormatXCOFF());
463 if (isXCOFF)
464 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(this))
465 if (GV->hasAttribute("toc-data"))
466 return false;
467
468 return true;
469}
470
473 getAllMetadata(MDs);
474 for (const auto &V : MDs)
475 if (V.first != LLVMContext::MD_dbg && V.first != LLVMContext::MD_unique_id)
476 return true;
477 return false;
478}
479
480template <typename Operation>
481static const GlobalObject *
483 const Operation &Op) {
484 if (auto *GO = dyn_cast<GlobalObject>(C)) {
485 Op(*GO);
486 return GO;
487 }
488 if (auto *GA = dyn_cast<GlobalAlias>(C)) {
489 Op(*GA);
490 if (Aliases.insert(GA).second)
491 return findBaseObject(GA->getOperand(0), Aliases, Op);
492 }
493 if (auto *CE = dyn_cast<ConstantExpr>(C)) {
494 switch (CE->getOpcode()) {
495 case Instruction::Add: {
496 auto *LHS = findBaseObject(CE->getOperand(0), Aliases, Op);
497 auto *RHS = findBaseObject(CE->getOperand(1), Aliases, Op);
498 if (LHS && RHS)
499 return nullptr;
500 return LHS ? LHS : RHS;
501 }
502 case Instruction::Sub: {
503 if (findBaseObject(CE->getOperand(1), Aliases, Op))
504 return nullptr;
505 return findBaseObject(CE->getOperand(0), Aliases, Op);
506 }
507 case Instruction::IntToPtr:
508 case Instruction::PtrToAddr:
509 case Instruction::PtrToInt:
510 case Instruction::BitCast:
511 case Instruction::AddrSpaceCast:
512 case Instruction::GetElementPtr:
513 return findBaseObject(CE->getOperand(0), Aliases, Op);
514 default:
515 break;
516 }
517 }
518 return nullptr;
519}
520
523 return findBaseObject(this, Aliases, [](const GlobalValue &) {});
524}
525
527 auto *GO = dyn_cast<GlobalObject>(this);
528 if (!GO)
529 return false;
530
531 return GO->getMetadata(LLVMContext::MD_absolute_symbol);
532}
533
534std::optional<ConstantRange> GlobalValue::getAbsoluteSymbolRange() const {
535 auto *GO = dyn_cast<GlobalObject>(this);
536 if (!GO)
537 return std::nullopt;
538
539 MDNode *MD = GO->getMetadata(LLVMContext::MD_absolute_symbol);
540 if (!MD)
541 return std::nullopt;
542
544}
545
548 return false;
549
550 // We assume that anyone who sets global unnamed_addr on a non-constant
551 // knows what they're doing.
553 return true;
554
555 // If it is a non constant variable, it needs to be uniqued across shared
556 // objects.
557 if (auto *Var = dyn_cast<GlobalVariable>(this))
558 if (!Var->isConstant())
559 return false;
560
562}
563
564//===----------------------------------------------------------------------===//
565// GlobalVariable Implementation
566//===----------------------------------------------------------------------===//
567
569 Constant *InitVal, const Twine &Name,
570 ThreadLocalMode TLMode, unsigned AddressSpace,
572 : GlobalObject(Ty, Value::GlobalVariableVal, AllocMarker, Link, Name,
574 isConstantGlobal(constant),
575 isExternallyInitializedConstant(isExternallyInitialized) {
576 assert(!Ty->isFunctionTy() && PointerType::isValidElementType(Ty) &&
577 "invalid type for global variable");
578 setThreadLocalMode(TLMode);
579 if (InitVal) {
580 assert(InitVal->getType() == Ty &&
581 "Initializer should be the same type as the GlobalVariable!");
582 Op<0>() = InitVal;
583 } else {
584 setGlobalVariableNumOperands(0);
585 }
586}
587
589 LinkageTypes Link, Constant *InitVal,
590 const Twine &Name, GlobalVariable *Before,
591 ThreadLocalMode TLMode,
592 std::optional<unsigned> AddressSpace,
594 : GlobalVariable(Ty, constant, Link, InitVal, Name, TLMode,
596 ? *AddressSpace
597 : M.getDataLayout().getDefaultGlobalsAddressSpace(),
599 if (Before)
600 Before->getParent()->insertGlobalVariable(Before->getIterator(), this);
601 else
602 M.insertGlobalVariable(this);
603}
604
608
612
614 if (!InitVal) {
615 if (hasInitializer()) {
616 // Note, the num operands is used to compute the offset of the operand, so
617 // the order here matters. Clearing the operand then clearing the num
618 // operands ensures we have the correct offset to the operand.
619 Op<0>().set(nullptr);
620 setGlobalVariableNumOperands(0);
621 }
622 } else {
623 assert(InitVal->getType() == getValueType() &&
624 "Initializer type must match GlobalVariable type");
625 // Note, the num operands is used to compute the offset of the operand, so
626 // the order here matters. We need to set num operands to 1 first so that
627 // we get the correct offset to the first operand when we set it.
628 if (!hasInitializer())
629 setGlobalVariableNumOperands(1);
630 Op<0>().set(InitVal);
631 }
632}
633
635 assert(InitVal && "Can't compute type of null initializer");
636 ValueType = InitVal->getType();
637 setInitializer(InitVal);
638}
639
641 // We don't support scalable global variables.
642 return DL.getTypeAllocSize(getValueType()).getFixedValue();
643}
644
645/// Copy all additional attributes (those not needed to create a GlobalVariable)
646/// from the GlobalVariable Src to this one.
649 setExternallyInitialized(Src->isExternallyInitialized());
650 setAttributes(Src->getAttributes());
651 if (auto CM = Src->getCodeModel())
652 setCodeModel(*CM);
653}
654
659
661 unsigned CodeModelData = static_cast<unsigned>(CM) + 1;
662 unsigned OldData = getGlobalValueSubClassData();
663 unsigned NewData = (OldData & ~(CodeModelMask << CodeModelShift)) |
664 (CodeModelData << CodeModelShift);
666 assert(getCodeModel() == CM && "Code model representation error!");
667}
668
670 unsigned CodeModelData = 0;
671 unsigned OldData = getGlobalValueSubClassData();
672 unsigned NewData = (OldData & ~(CodeModelMask << CodeModelShift)) |
673 (CodeModelData << CodeModelShift);
675 assert(getCodeModel() == std::nullopt && "Code model representation error!");
676}
677
678//===----------------------------------------------------------------------===//
679// GlobalAlias Implementation
680//===----------------------------------------------------------------------===//
681
682GlobalAlias::GlobalAlias(Type *Ty, unsigned AddressSpace, LinkageTypes Link,
683 const Twine &Name, Constant *Aliasee,
684 Module *ParentModule)
685 : GlobalValue(Ty, Value::GlobalAliasVal, AllocMarker, Link, Name,
686 AddressSpace) {
687 setAliasee(Aliasee);
688 if (ParentModule)
689 ParentModule->insertAlias(this);
690}
691
692GlobalAlias *GlobalAlias::create(Type *Ty, unsigned AddressSpace,
693 LinkageTypes Link, const Twine &Name,
694 Constant *Aliasee, Module *ParentModule) {
695 return new GlobalAlias(Ty, AddressSpace, Link, Name, Aliasee, ParentModule);
696}
697
698GlobalAlias *GlobalAlias::create(Type *Ty, unsigned AddressSpace,
699 LinkageTypes Linkage, const Twine &Name,
700 Module *Parent) {
701 return create(Ty, AddressSpace, Linkage, Name, nullptr, Parent);
702}
703
704GlobalAlias *GlobalAlias::create(Type *Ty, unsigned AddressSpace,
705 LinkageTypes Linkage, const Twine &Name,
706 GlobalValue *Aliasee) {
707 return create(Ty, AddressSpace, Linkage, Name, Aliasee, Aliasee->getParent());
708}
709
710GlobalAlias *GlobalAlias::create(LinkageTypes Link, const Twine &Name,
711 GlobalValue *Aliasee) {
712 return create(Aliasee->getValueType(), Aliasee->getAddressSpace(), Link, Name,
713 Aliasee);
714}
715
716GlobalAlias *GlobalAlias::create(const Twine &Name, GlobalValue *Aliasee) {
717 return create(Aliasee->getLinkage(), Name, Aliasee);
718}
719
721
723
725 assert((!Aliasee || Aliasee->getType() == getType()) &&
726 "Alias and aliasee types should match!");
727 Op<0>().set(Aliasee);
728}
729
732 return findBaseObject(getOperand(0), Aliases, [](const GlobalValue &) {});
733}
734
735//===----------------------------------------------------------------------===//
736// GlobalIFunc Implementation
737//===----------------------------------------------------------------------===//
738
739GlobalIFunc::GlobalIFunc(Type *Ty, unsigned AddressSpace, LinkageTypes Link,
740 const Twine &Name, Constant *Resolver,
741 Module *ParentModule)
742 : GlobalObject(Ty, Value::GlobalIFuncVal, AllocMarker, Link, Name,
743 AddressSpace) {
744 setResolver(Resolver);
745 if (ParentModule)
746 ParentModule->insertIFunc(this);
747}
748
749GlobalIFunc *GlobalIFunc::create(Type *Ty, unsigned AddressSpace,
750 LinkageTypes Link, const Twine &Name,
751 Constant *Resolver, Module *ParentModule) {
752 return new GlobalIFunc(Ty, AddressSpace, Link, Name, Resolver, ParentModule);
753}
754
756
758
762
assert(UImm &&(UImm !=~static_cast< T >(0)) &&"Invalid immediate!")
MachineBasicBlock MachineBasicBlock::iterator DebugLoc DL
This file contains the declarations for the subclasses of Constant, which represent the different fla...
GlobalValue::SanitizerMetadata SanitizerMetadata
Definition Globals.cpp:317
static const GlobalObject * findBaseObject(const Constant *C, DenseSet< const GlobalAlias * > &Aliases, const Operation &Op)
Definition Globals.cpp:482
Module.h This file contains the declarations for the Module class.
#define F(x, y, z)
Definition MD5.cpp:54
#define G(x, y, z)
Definition MD5.cpp:55
PowerPC Reduce CR logical Operation
DEMANGLE_NAMESPACE_BEGIN bool starts_with(std::string_view self, char C) noexcept
Value * RHS
Value * LHS
@ NoDeduplicate
No deduplication is performed.
Definition Comdat.h:40
static ConstantAsMetadata * get(Constant *C)
Definition Metadata.h:537
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:64
bool erase(const KeyT &Val)
Definition DenseMap.h:377
Implements a dense probed hash-table based set.
Definition DenseSet.h:281
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:722
LLVM_ABI const GlobalObject * getAliaseeObject() const
Definition Globals.cpp:730
LLVM_ABI void setAliasee(Constant *Aliasee)
These methods retrieve and set alias target.
Definition Globals.cpp:724
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:692
LLVM_ABI void removeFromParent()
removeFromParent - This method unlinks 'this' from the containing module, but does not delete it.
Definition Globals.cpp:720
LLVM_ABI void applyAlongResolverPath(function_ref< void(const GlobalValue &)> Op) const
Definition Globals.cpp:763
LLVM_ABI const Function * getResolverFunction() const
Definition Globals.cpp:759
LLVM_ABI void removeFromParent()
This method unlinks 'this' from the containing module, but does not delete it.
Definition Globals.cpp:755
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:749
LLVM_ABI void eraseFromParent()
This method unlinks 'this' from the containing module and deletes it.
Definition Globals.cpp:757
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:364
LLVM_ABI void setMetadata(unsigned KindID, MDNode *Node)
Set a particular kind of metadata attachment.
LLVM_ABI void getAllMetadata(SmallVectorImpl< std::pair< unsigned, MDNode * > > &MDs) const
Appends all metadata attached to this value to MDs, sorting by KindID.
bool hasMetadata() const
Return true if this GlobalObject has any metadata attached to it.
LLVM_ABI void setAlignment(Align Align)
Sets the alignment attribute of the GlobalObject.
Definition Globals.cpp:218
GlobalObject(Type *Ty, ValueTy VTy, AllocInfo AllocInfo, LinkageTypes Linkage, const Twine &Name, unsigned AddressSpace=0)
LLVM_ABI void setComdat(Comdat *C)
Definition Globals.cpp:287
LLVM_ABI void copyAttributesFrom(const GlobalObject *Src)
Definition Globals.cpp:228
LLVM_ABI void setSection(StringRef S)
Change the section for this global.
Definition Globals.cpp:348
LLVM_ABI bool hasMetadataOtherThanDebugLocAndGuid() const
Definition Globals.cpp:471
MDNode * getMetadata(unsigned KindID) const
Get the metadata of given kind attached to this GlobalObject.
LLVM_ABI ~GlobalObject()
Definition Globals.cpp:170
LLVM_ABI std::optional< StringRef > getSectionPrefix() const
Get the section prefix for this global object.
Definition Globals.cpp:382
LLVM_ABI void clearMetadata()
Erase all metadata attached to this Value.
bool hasSection() const
Check if this global has a custom object file section.
friend class Value
LLVM_ABI bool canIncreaseAlignment() const
Returns true if the alignment of the value can be unilaterally increased.
Definition Globals.cpp:422
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:80
LLVM_ABI const SanitizerMetadata & getSanitizerMetadata() const
Definition Globals.cpp:318
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:329
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:408
LinkageTypes getLinkage() const
void setUnnamedAddr(UnnamedAddr Val)
uint64_t GUID
Declare a type to represent a global unique identifier for a global value.
LLVM_ABI GUID getGUIDOrFallback() const
Return the GUID for this value if it has been assigned, otherwise fall back to computing it based on ...
Definition Globals.cpp:110
bool hasDefaultVisibility() const
LLVM_ABI bool isAbsoluteSymbolRef() const
Returns whether this is a reference to an absolute symbol.
Definition Globals.cpp:526
bool isTagged() const
void setDLLStorageClass(DLLStorageClassTypes C)
LLVM_ABI const Comdat * getComdat() const
Definition Globals.cpp:274
void setThreadLocalMode(ThreadLocalMode Val)
friend class Constant
bool hasSanitizerMetadata() const
unsigned getAddressSpace() const
LLVM_ABI StringRef getSection() const
Definition Globals.cpp:264
LLVM_ABI StringRef getPartition() const
Definition Globals.cpp:295
Module * getParent()
Get the module that this global value is contained inside of...
LLVM_ABI const GlobalObject * getAliaseeObject() const
Definition Globals.cpp:521
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:534
LLVM_ABI void eraseFromParent()
This method unlinks 'this' from the containing module and deletes it.
Definition Globals.cpp:158
LLVM_ABI GUID getGUID() const
Return a 64-bit global unique ID for this value.
Definition Globals.cpp:103
static bool isExternalLinkage(LinkageTypes Linkage)
LLVM_ABI std::optional< GUID > getGUIDIfAssigned() const
Return the GUID for this value if it has been assigned, nullopt otherwise.
Definition Globals.cpp:116
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:66
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:234
LLVM_ABI void setNoSanitizeMetadata()
Definition Globals.cpp:336
void setVisibility(VisibilityTypes V)
LLVM_ABI const DataLayout & getDataLayout() const
Get the data layout of the module this global belongs to.
Definition Globals.cpp:205
LLVM_ABI bool canBenefitFromLocalAlias() const
Definition Globals.cpp:187
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:47
bool hasGlobalUnnamedAddr() const
LLVM_ABI Error materialize()
Make sure this GlobalValue is fully read.
Definition Globals.cpp:52
LLVM_ABI void setSanitizerMetadata(SanitizerMetadata Meta)
Definition Globals.cpp:324
bool hasLinkOnceODRLinkage() const
LLVM_ABI bool canBeOmittedFromSymbolTable() const
True if GV can be left out of the object symbol table.
Definition Globals.cpp:546
LLVM_ABI void reassignGUID()
Recompute and assign a GUID to this value, replacing the existing GUID.
Definition Globals.cpp:96
LLVM_ABI void removeFromParent()
This method unlinks 'this' from the containing module, but does not delete it.
Definition Globals.cpp:146
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 bool isInterposable(bool CheckNoIPA=true) const
Return true if this global's definition can be substituted with an arbitrary definition at link time ...
Definition Globals.cpp:178
LLVM_ABI void setPartition(StringRef Part)
Definition Globals.cpp:301
LLVM_ABI void setInitializer(Constant *InitVal)
setInitializer - Sets the initializer for this global variable, removing any existing initializer if ...
Definition Globals.cpp:613
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:605
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:634
LLVM_ABI void clearCodeModel()
Remove the code model for this global.
Definition Globals.cpp:669
LLVM_ABI void copyAttributesFrom(const GlobalVariable *Src)
copyAttributesFrom - copy all additional attributes (those not needed to create a GlobalVariable) fro...
Definition Globals.cpp:647
LLVM_ABI uint64_t getGlobalSize(const DataLayout &DL) const
Get the size of this global variable in bytes.
Definition Globals.cpp:640
LLVM_ABI void setCodeModel(CodeModel::Model CM)
Change the code model for this global.
Definition Globals.cpp:660
void setExternallyInitialized(bool Val)
LLVM_ABI void eraseFromParent()
eraseFromParent - This method unlinks 'this' from the containing module and deletes it.
Definition Globals.cpp:609
LLVM_ABI void dropAllReferences()
Drop all references in preparation to destroy the GlobalVariable.
Definition Globals.cpp:655
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:568
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:1069
static MDTuple * get(LLVMContext &Context, ArrayRef< Metadata * > MDs)
Definition Metadata.h:1565
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:713
void insertIFunc(GlobalIFunc *IFunc)
Insert IFunc at the end of the alias list and take ownership.
Definition Module.h:717
llvm::Error materialize(GlobalValue *GV)
Make sure the GlobalValue is fully read.
Definition Module.cpp:477
bool getSemanticInterposition() const
Returns whether semantic interposition is to be respected.
Definition Module.cpp:704
void removeAlias(GlobalAlias *Alias)
Detach Alias from the list but don't delete it.
Definition Module.h:704
void eraseIFunc(GlobalIFunc *IFunc)
Remove IFunc from the list and delete it.
Definition Module.h:715
void eraseAlias(GlobalAlias *Alias)
Remove Alias from the list and delete it.
Definition Module.h:706
void eraseGlobalVariable(GlobalVariable *GV)
Remove global variable GV from the list and delete it.
Definition Module.h:641
std::optional< GlobalValue::GUID > getGUID(const Value *V) const
Definition Module.h:655
void insertGlobalVariable(GlobalVariable *GV)
Insert global variable GV at the end of the global variable list and take ownership.
Definition Module.h:644
const DataLayout & getDataLayout() const
Get the data layout for the module's target platform.
Definition Module.h:320
void insertAlias(GlobalAlias *Alias)
Insert Alias at the end of the alias list and take ownership.
Definition Module.h:708
void removeGlobalVariable(GlobalVariable *GV)
Detach global variable GV from the list but don't delete it.
Definition Module.h:639
static LLVM_ABI bool isValidElementType(Type *ElemTy)
Return true if the specified type is valid as a element type.
Definition Type.cpp:940
Interface for looking up the initializer for a variable name, used by Init::resolveReferences.
Definition Record.h:2202
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
Represent a constant reference to a string, i.e.
Definition StringRef.h:56
constexpr bool empty() const
Check if the string is empty.
Definition StringRef.h:141
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:46
static LLVM_ABI IntegerType * getInt64Ty(LLVMContext &C)
Definition Type.cpp:310
StringRef save(const char *S)
Definition StringSaver.h:53
void dropAllReferences()
Drop all references to operands.
Definition User.h:324
Value * getOperand(unsigned i) const
Definition User.h:207
LLVM Value Representation.
Definition Value.h:75
Type * getType() const
All values are typed, get the type of this value.
Definition Value.h:255
static constexpr uint64_t MaximumAlignment
Definition Value.h:799
LLVM_ABI const Value * stripPointerCastsAndAliases() const
Strip off pointer casts, all-zero GEPs, address space casts, and aliases.
Definition Value.cpp:717
LLVM_ABI void setMetadata(unsigned KindID, MDNode *Node)
Set a particular kind of metadata attachment.
LLVMContext & getContext() const
All values hold a context through their type.
Definition Value.h:258
unsigned getValueID() const
Return an ID for the concrete type of this object.
Definition Value.h:543
LLVM_ABI bool eraseMetadata(unsigned KindID)
Erase all metadata attachments with the given kind.
LLVM_ABI StringRef getName() const
Return a constant reference to the value's name.
Definition Value.cpp:319
std::pair< iterator, bool > insert(const ValueT &V)
Definition DenseSet.h:209
An efficient, type-erasing, non-owning reference to a callable.
self_iterator getIterator()
Definition ilist_node.h:123
#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:206
decltype(auto) dyn_cast(const From &Val)
dyn_cast<X> - Return the argument parameter cast to the specified type.
Definition Casting.h:643
LLVM_ABI ConstantRange getConstantRangeFromMetadata(const MDNode &RangeMD)
Parse out a conservative ConstantRange from !range metadata.
constexpr uint64_t alignTo(uint64_t Size, Align A)
Returns a multiple of A needed to store Size bytes.
Definition Alignment.h:144
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:547
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:559
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:106