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.
42static_assert(sizeof(GlobalObject) == sizeof(GlobalValue) + sizeof(void *),
43 "unexpected GlobalObject size growth");
44
46 if (const Function *F = dyn_cast<Function>(this))
47 return F->isMaterializable();
48 return false;
49}
51
52/// Override destroyConstantImpl to make sure it doesn't get called on
53/// GlobalValue's because they shouldn't be treated like other constants.
54void GlobalValue::destroyConstantImpl() {
55 llvm_unreachable("You can't GV->destroyConstantImpl()!");
56}
57
58Value *GlobalValue::handleOperandChangeImpl(Value *From, Value *To) {
59 llvm_unreachable("Unsupported class for handleOperandChange()!");
60}
61
62/// copyAttributesFrom - copy all additional attributes (those not needed to
63/// create a GlobalValue) from the GlobalValue Src to this one.
65 setVisibility(Src->getVisibility());
66 setUnnamedAddr(Src->getUnnamedAddr());
67 setThreadLocalMode(Src->getThreadLocalMode());
68 setDLLStorageClass(Src->getDLLStorageClass());
69 setDSOLocal(Src->isDSOLocal());
70 setPartition(Src->getPartition());
71 if (Src->hasSanitizerMetadata())
72 setSanitizerMetadata(Src->getSanitizerMetadata());
73 else
75}
76
79 return MD5Hash(GlobalIdentifier);
80}
81
83 switch (getValueID()) {
84#define HANDLE_GLOBAL_VALUE(NAME) \
85 case Value::NAME##Val: \
86 return static_cast<NAME *>(this)->removeFromParent();
87#include "llvm/IR/Value.def"
88 default:
89 break;
90 }
91 llvm_unreachable("not a global");
92}
93
95 switch (getValueID()) {
96#define HANDLE_GLOBAL_VALUE(NAME) \
97 case Value::NAME##Val: \
98 return static_cast<NAME *>(this)->eraseFromParent();
99#include "llvm/IR/Value.def"
100 default:
101 break;
102 }
103 llvm_unreachable("not a global");
104}
105
107
110 return true;
112 !isDSOLocal();
113}
114
116 if (isTagged()) {
117 // Cannot create local aliases to MTE tagged globals. The address of a
118 // tagged global includes a tag that is assigned by the loader in the
119 // GOT.
120 return false;
121 }
122 // See AsmPrinter::getSymbolPreferLocal(). For a deduplicate comdat kind,
123 // references to a discarded local symbol from outside the group are not
124 // allowed, so avoid the local alias.
125 auto isDeduplicateComdat = [](const Comdat *C) {
126 return C && C->getSelectionKind() != Comdat::NoDeduplicate;
127 };
128 return hasDefaultVisibility() &&
130 !isa<GlobalIFunc>(this) && !isDeduplicateComdat(getComdat());
131}
132
134 return getParent()->getDataLayout();
135}
136
139 "Alignment is greater than MaximumAlignment!");
140 unsigned AlignmentData = encode(Align);
141 unsigned OldData = getGlobalValueSubClassData();
142 setGlobalValueSubClassData((OldData & ~AlignmentMask) | AlignmentData);
143 assert(getAlign() == Align && "Alignment representation error!");
144}
145
148 "Alignment is greater than MaximumAlignment!");
149 unsigned AlignmentData = encode(Align);
150 unsigned OldData = getGlobalValueSubClassData();
151 setGlobalValueSubClassData((OldData & ~AlignmentMask) | AlignmentData);
152 assert(getAlign() && *getAlign() == Align &&
153 "Alignment representation error!");
154}
155
158 setAlignment(Src->getAlign());
159 setSection(Src->getSection());
160}
161
164 StringRef FileName) {
165 // Value names may be prefixed with a binary '1' to indicate
166 // that the backend should not modify the symbols due to any platform
167 // naming convention. Do not include that '1' in the PGO profile name.
168 Name.consume_front("\1");
169
170 std::string GlobalName;
172 // For local symbols, prepend the main file name to distinguish them.
173 // Do not include the full path in the file name since there's no guarantee
174 // that it will stay the same, e.g., if the files are checked out from
175 // version control in different locations.
176 if (FileName.empty())
177 GlobalName += "<unknown>";
178 else
179 GlobalName += FileName;
180
181 GlobalName += GlobalIdentifierDelimiter;
182 }
183 GlobalName += Name;
184 return GlobalName;
185}
186
187std::string GlobalValue::getGlobalIdentifier() const {
189 getParent()->getSourceFileName());
190}
191
193 if (auto *GA = dyn_cast<GlobalAlias>(this)) {
194 // In general we cannot compute this at the IR level, but we try.
195 if (const GlobalObject *GO = GA->getAliaseeObject())
196 return GO->getSection();
197 return "";
198 }
199 return cast<GlobalObject>(this)->getSection();
200}
201
203 if (auto *GA = dyn_cast<GlobalAlias>(this)) {
204 // In general we cannot compute this at the IR level, but we try.
205 if (const GlobalObject *GO = GA->getAliaseeObject())
206 return const_cast<GlobalObject *>(GO)->getComdat();
207 return nullptr;
208 }
209 // ifunc and its resolver are separate things so don't use resolver comdat.
210 if (isa<GlobalIFunc>(this))
211 return nullptr;
212 return cast<GlobalObject>(this)->getComdat();
213}
214
216 if (ObjComdat)
217 ObjComdat->removeUser(this);
218 ObjComdat = C;
219 if (C)
220 C->addUser(this);
221}
222
224 if (!hasPartition())
225 return "";
226 return getContext().pImpl->GlobalValuePartitions[this];
227}
228
230 // Do nothing if we're clearing the partition and it is already empty.
231 if (!hasPartition() && S.empty())
232 return;
233
234 // Get or create a stable partition name string and put it in the table in the
235 // context.
236 if (!S.empty())
237 S = getContext().pImpl->Saver.save(S);
239
240 // Update the HasPartition field. Setting the partition to the empty string
241 // means this global no longer has a partition.
242 HasPartition = !S.empty();
243}
244
248 assert(getContext().pImpl->GlobalValueSanitizerMetadata.count(this));
250}
251
256
263
266 Meta.NoAddress = true;
267 Meta.NoHWAddress = true;
269}
270
271StringRef GlobalObject::getSectionImpl() const {
273 return getContext().pImpl->GlobalObjectSections[this];
274}
275
277 // Do nothing if we're clearing the section and it is already empty.
278 if (!hasSection() && S.empty())
279 return;
280
281 // Get or create a stable section name string and put it in the table in the
282 // context.
283 if (!S.empty())
284 S = getContext().pImpl->Saver.save(S);
286
287 // Update the HasSectionHashEntryBit. Setting the section to the empty string
288 // means this global no longer has a section.
289 setGlobalObjectFlag(HasSectionHashEntryBit, !S.empty());
290}
291
293 StringRef ExistingPrefix;
294 if (std::optional<StringRef> MaybePrefix = getSectionPrefix())
295 ExistingPrefix = *MaybePrefix;
296
297 if (ExistingPrefix == Prefix)
298 return false;
299
300 if (Prefix.empty()) {
301 setMetadata(LLVMContext::MD_section_prefix, nullptr);
302 return true;
303 }
304 MDBuilder MDB(getContext());
305 setMetadata(LLVMContext::MD_section_prefix,
307 return true;
308}
309
310std::optional<StringRef> GlobalObject::getSectionPrefix() const {
311 if (MDNode *MD = getMetadata(LLVMContext::MD_section_prefix)) {
312 [[maybe_unused]] StringRef MDName =
313 cast<MDString>(MD->getOperand(0))->getString();
314 assert((MDName == "section_prefix" ||
315 (isa<Function>(this) && MDName == "function_section_prefix")) &&
316 "Metadata not match");
317 return cast<MDString>(MD->getOperand(1))->getString();
318 }
319 return std::nullopt;
320}
321
322bool GlobalValue::isNobuiltinFnDef() const {
323 const Function *F = dyn_cast<Function>(this);
324 if (!F || F->empty())
325 return false;
326 return F->hasFnAttribute(Attribute::NoBuiltin);
327}
328
330 // Globals are definitions if they have an initializer.
331 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(this))
332 return GV->getNumOperands() == 0;
333
334 // Functions are definitions if they have a body.
335 if (const Function *F = dyn_cast<Function>(this))
336 return F->empty() && !F->isMaterializable();
337
338 // Aliases and ifuncs are always definitions.
340 return false;
341}
342
344 // Firstly, can only increase the alignment of a global if it
345 // is a strong definition.
347 return false;
348
349 // It also has to either not have a section defined, or, not have
350 // alignment specified. (If it is assigned a section, the global
351 // could be densely packed with other objects in the section, and
352 // increasing the alignment could cause padding issues.)
353 if (hasSection() && getAlign())
354 return false;
355
356 // On ELF platforms, we're further restricted in that we can't
357 // increase the alignment of any variable which might be emitted
358 // into a shared library, and which is exported. If the main
359 // executable accesses a variable found in a shared-lib, the main
360 // exe actually allocates memory for and exports the symbol ITSELF,
361 // overriding the symbol found in the library. That is, at link
362 // time, the observed alignment of the variable is copied into the
363 // executable binary. (A COPY relocation is also generated, to copy
364 // the initial data from the shadowed variable in the shared-lib
365 // into the location in the main binary, before running code.)
366 //
367 // And thus, even though you might think you are defining the
368 // global, and allocating the memory for the global in your object
369 // file, and thus should be able to set the alignment arbitrarily,
370 // that's not actually true. Doing so can cause an ABI breakage; an
371 // executable might have already been built with the previous
372 // alignment of the variable, and then assuming an increased
373 // alignment will be incorrect.
374
375 // Conservatively assume ELF if there's no parent pointer.
376 bool isELF = (!Parent || Parent->getTargetTriple().isOSBinFormatELF());
377 if (isELF && !isDSOLocal())
378 return false;
379
380 // GV with toc-data attribute is defined in a TOC entry. To mitigate TOC
381 // overflow, the alignment of such symbol should not be increased. Otherwise,
382 // padding is needed thus more TOC entries are wasted.
383 bool isXCOFF = (!Parent || Parent->getTargetTriple().isOSBinFormatXCOFF());
384 if (isXCOFF)
385 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(this))
386 if (GV->hasAttribute("toc-data"))
387 return false;
388
389 return true;
390}
391
394 getAllMetadata(MDs);
395 for (const auto &V : MDs)
396 if (V.first != LLVMContext::MD_dbg)
397 return true;
398 return false;
399}
400
401template <typename Operation>
402static const GlobalObject *
404 const Operation &Op) {
405 if (auto *GO = dyn_cast<GlobalObject>(C)) {
406 Op(*GO);
407 return GO;
408 }
409 if (auto *GA = dyn_cast<GlobalAlias>(C)) {
410 Op(*GA);
411 if (Aliases.insert(GA).second)
412 return findBaseObject(GA->getOperand(0), Aliases, Op);
413 }
414 if (auto *CE = dyn_cast<ConstantExpr>(C)) {
415 switch (CE->getOpcode()) {
416 case Instruction::Add: {
417 auto *LHS = findBaseObject(CE->getOperand(0), Aliases, Op);
418 auto *RHS = findBaseObject(CE->getOperand(1), Aliases, Op);
419 if (LHS && RHS)
420 return nullptr;
421 return LHS ? LHS : RHS;
422 }
423 case Instruction::Sub: {
424 if (findBaseObject(CE->getOperand(1), Aliases, Op))
425 return nullptr;
426 return findBaseObject(CE->getOperand(0), Aliases, Op);
427 }
428 case Instruction::IntToPtr:
429 case Instruction::PtrToAddr:
430 case Instruction::PtrToInt:
431 case Instruction::BitCast:
432 case Instruction::AddrSpaceCast:
433 case Instruction::GetElementPtr:
434 return findBaseObject(CE->getOperand(0), Aliases, Op);
435 default:
436 break;
437 }
438 }
439 return nullptr;
440}
441
444 return findBaseObject(this, Aliases, [](const GlobalValue &) {});
445}
446
448 auto *GO = dyn_cast<GlobalObject>(this);
449 if (!GO)
450 return false;
451
452 return GO->getMetadata(LLVMContext::MD_absolute_symbol);
453}
454
455std::optional<ConstantRange> GlobalValue::getAbsoluteSymbolRange() const {
456 auto *GO = dyn_cast<GlobalObject>(this);
457 if (!GO)
458 return std::nullopt;
459
460 MDNode *MD = GO->getMetadata(LLVMContext::MD_absolute_symbol);
461 if (!MD)
462 return std::nullopt;
463
465}
466
469 return false;
470
471 // We assume that anyone who sets global unnamed_addr on a non-constant
472 // knows what they're doing.
474 return true;
475
476 // If it is a non constant variable, it needs to be uniqued across shared
477 // objects.
478 if (auto *Var = dyn_cast<GlobalVariable>(this))
479 if (!Var->isConstant())
480 return false;
481
483}
484
485//===----------------------------------------------------------------------===//
486// GlobalVariable Implementation
487//===----------------------------------------------------------------------===//
488
490 Constant *InitVal, const Twine &Name,
491 ThreadLocalMode TLMode, unsigned AddressSpace,
493 : GlobalObject(Ty, Value::GlobalVariableVal, AllocMarker, Link, Name,
495 isConstantGlobal(constant),
496 isExternallyInitializedConstant(isExternallyInitialized) {
497 assert(!Ty->isFunctionTy() && PointerType::isValidElementType(Ty) &&
498 "invalid type for global variable");
499 setThreadLocalMode(TLMode);
500 if (InitVal) {
501 assert(InitVal->getType() == Ty &&
502 "Initializer should be the same type as the GlobalVariable!");
503 Op<0>() = InitVal;
504 } else {
505 setGlobalVariableNumOperands(0);
506 }
507}
508
510 LinkageTypes Link, Constant *InitVal,
511 const Twine &Name, GlobalVariable *Before,
512 ThreadLocalMode TLMode,
513 std::optional<unsigned> AddressSpace,
515 : GlobalVariable(Ty, constant, Link, InitVal, Name, TLMode,
517 ? *AddressSpace
518 : M.getDataLayout().getDefaultGlobalsAddressSpace(),
520 if (Before)
521 Before->getParent()->insertGlobalVariable(Before->getIterator(), this);
522 else
523 M.insertGlobalVariable(this);
524}
525
529
533
535 if (!InitVal) {
536 if (hasInitializer()) {
537 // Note, the num operands is used to compute the offset of the operand, so
538 // the order here matters. Clearing the operand then clearing the num
539 // operands ensures we have the correct offset to the operand.
540 Op<0>().set(nullptr);
541 setGlobalVariableNumOperands(0);
542 }
543 } else {
544 assert(InitVal->getType() == getValueType() &&
545 "Initializer type must match GlobalVariable type");
546 // Note, the num operands is used to compute the offset of the operand, so
547 // the order here matters. We need to set num operands to 1 first so that
548 // we get the correct offset to the first operand when we set it.
549 if (!hasInitializer())
550 setGlobalVariableNumOperands(1);
551 Op<0>().set(InitVal);
552 }
553}
554
556 assert(InitVal && "Can't compute type of null initializer");
557 ValueType = InitVal->getType();
558 setInitializer(InitVal);
559}
560
562 // We don't support scalable global variables.
563 return DL.getTypeAllocSize(getValueType()).getFixedValue();
564}
565
566/// Copy all additional attributes (those not needed to create a GlobalVariable)
567/// from the GlobalVariable Src to this one.
570 setExternallyInitialized(Src->isExternallyInitialized());
571 setAttributes(Src->getAttributes());
572 if (auto CM = Src->getCodeModel())
573 setCodeModel(*CM);
574}
575
580
582 unsigned CodeModelData = static_cast<unsigned>(CM) + 1;
583 unsigned OldData = getGlobalValueSubClassData();
584 unsigned NewData = (OldData & ~(CodeModelMask << CodeModelShift)) |
585 (CodeModelData << CodeModelShift);
587 assert(getCodeModel() == CM && "Code model representation error!");
588}
589
591 unsigned CodeModelData = 0;
592 unsigned OldData = getGlobalValueSubClassData();
593 unsigned NewData = (OldData & ~(CodeModelMask << CodeModelShift)) |
594 (CodeModelData << CodeModelShift);
596 assert(getCodeModel() == std::nullopt && "Code model representation error!");
597}
598
599//===----------------------------------------------------------------------===//
600// GlobalAlias Implementation
601//===----------------------------------------------------------------------===//
602
603GlobalAlias::GlobalAlias(Type *Ty, unsigned AddressSpace, LinkageTypes Link,
604 const Twine &Name, Constant *Aliasee,
605 Module *ParentModule)
606 : GlobalValue(Ty, Value::GlobalAliasVal, AllocMarker, Link, Name,
607 AddressSpace) {
608 setAliasee(Aliasee);
609 if (ParentModule)
610 ParentModule->insertAlias(this);
611}
612
613GlobalAlias *GlobalAlias::create(Type *Ty, unsigned AddressSpace,
614 LinkageTypes Link, const Twine &Name,
615 Constant *Aliasee, Module *ParentModule) {
616 return new GlobalAlias(Ty, AddressSpace, Link, Name, Aliasee, ParentModule);
617}
618
619GlobalAlias *GlobalAlias::create(Type *Ty, unsigned AddressSpace,
620 LinkageTypes Linkage, const Twine &Name,
621 Module *Parent) {
622 return create(Ty, AddressSpace, Linkage, Name, nullptr, Parent);
623}
624
625GlobalAlias *GlobalAlias::create(Type *Ty, unsigned AddressSpace,
626 LinkageTypes Linkage, const Twine &Name,
627 GlobalValue *Aliasee) {
628 return create(Ty, AddressSpace, Linkage, Name, Aliasee, Aliasee->getParent());
629}
630
631GlobalAlias *GlobalAlias::create(LinkageTypes Link, const Twine &Name,
632 GlobalValue *Aliasee) {
633 return create(Aliasee->getValueType(), Aliasee->getAddressSpace(), Link, Name,
634 Aliasee);
635}
636
637GlobalAlias *GlobalAlias::create(const Twine &Name, GlobalValue *Aliasee) {
638 return create(Aliasee->getLinkage(), Name, Aliasee);
639}
640
642
644
646 assert((!Aliasee || Aliasee->getType() == getType()) &&
647 "Alias and aliasee types should match!");
648 Op<0>().set(Aliasee);
649}
650
653 return findBaseObject(getOperand(0), Aliases, [](const GlobalValue &) {});
654}
655
656//===----------------------------------------------------------------------===//
657// GlobalIFunc Implementation
658//===----------------------------------------------------------------------===//
659
660GlobalIFunc::GlobalIFunc(Type *Ty, unsigned AddressSpace, LinkageTypes Link,
661 const Twine &Name, Constant *Resolver,
662 Module *ParentModule)
663 : GlobalObject(Ty, Value::GlobalIFuncVal, AllocMarker, Link, Name,
664 AddressSpace) {
665 setResolver(Resolver);
666 if (ParentModule)
667 ParentModule->insertIFunc(this);
668}
669
670GlobalIFunc *GlobalIFunc::create(Type *Ty, unsigned AddressSpace,
671 LinkageTypes Link, const Twine &Name,
672 Constant *Resolver, Module *ParentModule) {
673 return new GlobalIFunc(Ty, AddressSpace, Link, Name, Resolver, ParentModule);
674}
675
677
679
683
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:245
static const GlobalObject * findBaseObject(const Constant *C, DenseSet< const GlobalAlias * > &Aliases, const Operation &Op)
Definition Globals.cpp:403
Module.h This file contains the declarations for the Module class.
#define F(x, y, z)
Definition MD5.cpp:54
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:64
bool erase(const KeyT &Val)
Definition DenseMap.h:330
Implements a dense probed hash-table based set.
Definition DenseSet.h:279
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:643
LLVM_ABI const GlobalObject * getAliaseeObject() const
Definition Globals.cpp:651
LLVM_ABI void setAliasee(Constant *Aliasee)
These methods retrieve and set alias target.
Definition Globals.cpp:645
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:613
LLVM_ABI void removeFromParent()
removeFromParent - This method unlinks 'this' from the containing module, but does not delete it.
Definition Globals.cpp:641
LLVM_ABI void applyAlongResolverPath(function_ref< void(const GlobalValue &)> Op) const
Definition Globals.cpp:684
LLVM_ABI const Function * getResolverFunction() const
Definition Globals.cpp:680
LLVM_ABI void removeFromParent()
This method unlinks 'this' from the containing module, but does not delete it.
Definition Globals.cpp:676
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:670
LLVM_ABI void eraseFromParent()
This method unlinks 'this' from the containing module and deletes it.
Definition Globals.cpp:678
const Constant * getResolver() const
Definition GlobalIFunc.h:73
LLVM_ABI bool hasMetadataOtherThanDebugLoc() const
Definition Globals.cpp:392
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:292
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.
LLVM_ABI void setAlignment(Align Align)
Sets the alignment attribute of the GlobalObject.
Definition Globals.cpp:146
GlobalObject(Type *Ty, ValueTy VTy, AllocInfo AllocInfo, LinkageTypes Linkage, const Twine &Name, unsigned AddressSpace=0)
LLVM_ABI void setComdat(Comdat *C)
Definition Globals.cpp:215
LLVM_ABI void copyAttributesFrom(const GlobalObject *Src)
Definition Globals.cpp:156
LLVM_ABI void setSection(StringRef S)
Change the section for this global.
Definition Globals.cpp:276
LLVM_ABI ~GlobalObject()
Definition Globals.cpp:106
LLVM_ABI std::optional< StringRef > getSectionPrefix() const
Get the section prefix for this global object.
Definition Globals.cpp:310
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:343
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:78
LLVM_ABI const SanitizerMetadata & getSanitizerMetadata() const
Definition Globals.cpp:246
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:257
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:329
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:447
bool isTagged() const
void setDLLStorageClass(DLLStorageClassTypes C)
LLVM_ABI const Comdat * getComdat() const
Definition Globals.cpp:202
void setThreadLocalMode(ThreadLocalMode Val)
friend class Constant
bool hasSanitizerMetadata() const
unsigned getAddressSpace() const
LLVM_ABI StringRef getSection() const
Definition Globals.cpp:192
LLVM_ABI StringRef getPartition() const
Definition Globals.cpp:223
Module * getParent()
Get the module that this global value is contained inside of...
LLVM_ABI const GlobalObject * getAliaseeObject() const
Definition Globals.cpp:442
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:455
LLVM_ABI void eraseFromParent()
This method unlinks 'this' from the containing module and deletes it.
Definition Globals.cpp:94
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:64
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:162
LLVM_ABI void setNoSanitizeMetadata()
Definition Globals.cpp:264
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:108
void setVisibility(VisibilityTypes V)
LLVM_ABI const DataLayout & getDataLayout() const
Get the data layout of the module this global belongs to.
Definition Globals.cpp:133
LLVM_ABI bool canBenefitFromLocalAlias() const
Definition Globals.cpp:115
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:45
bool hasGlobalUnnamedAddr() const
LLVM_ABI Error materialize()
Make sure this GlobalValue is fully read.
Definition Globals.cpp:50
LLVM_ABI void setSanitizerMetadata(SanitizerMetadata Meta)
Definition Globals.cpp:252
bool hasLinkOnceODRLinkage() const
LLVM_ABI bool canBeOmittedFromSymbolTable() const
True if GV can be left out of the object symbol table.
Definition Globals.cpp:467
LLVM_ABI void removeFromParent()
This method unlinks 'this' from the containing module, but does not delete it.
Definition Globals.cpp:82
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:229
LLVM_ABI void setInitializer(Constant *InitVal)
setInitializer - Sets the initializer for this global variable, removing any existing initializer if ...
Definition Globals.cpp:534
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:526
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:555
LLVM_ABI void clearCodeModel()
Remove the code model for this global.
Definition Globals.cpp:590
LLVM_ABI void copyAttributesFrom(const GlobalVariable *Src)
copyAttributesFrom - copy all additional attributes (those not needed to create a GlobalVariable) fro...
Definition Globals.cpp:568
LLVM_ABI uint64_t getGlobalSize(const DataLayout &DL) const
Get the size of this global variable in bytes.
Definition Globals.cpp:561
LLVM_ABI void setCodeModel(CodeModel::Model CM)
Change the code model for this global.
Definition Globals.cpp:581
void setExternallyInitialized(bool Val)
LLVM_ABI void eraseFromParent()
eraseFromParent - This method unlinks 'this' from the containing module and deletes it.
Definition Globals.cpp:530
LLVM_ABI void dropAllReferences()
Drop all references in preparation to destroy the GlobalVariable.
Definition Globals.cpp:576
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:489
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:1080
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: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: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:875
Interface for looking up the initializer for a variable name, used by Init::resolveReferences.
Definition Record.h:2199
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
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:143
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: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: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:712
LLVMContext & getContext() const
All values hold a context through their type.
Definition Value.h:259
unsigned getValueID() const
Return an ID for the concrete type of this object.
Definition Value.h:543
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:202
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.
Definition Types.h:26
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.
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