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