LLVM  8.0.0svn
TargetLoweringObjectFile.cpp
Go to the documentation of this file.
1 //===-- llvm/Target/TargetLoweringObjectFile.cpp - Object File Info -------===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file implements classes used to handle lowerings specific to common
11 // object file formats.
12 //
13 //===----------------------------------------------------------------------===//
14 
17 #include "llvm/IR/Constants.h"
18 #include "llvm/IR/DataLayout.h"
19 #include "llvm/IR/DerivedTypes.h"
20 #include "llvm/IR/Function.h"
21 #include "llvm/IR/GlobalVariable.h"
22 #include "llvm/IR/Mangler.h"
23 #include "llvm/MC/MCContext.h"
24 #include "llvm/MC/MCExpr.h"
25 #include "llvm/MC/MCStreamer.h"
26 #include "llvm/MC/MCSymbol.h"
31 using namespace llvm;
32 
33 //===----------------------------------------------------------------------===//
34 // Generic Code
35 //===----------------------------------------------------------------------===//
36 
37 /// Initialize - this method must be called before any actual lowering is
38 /// done. This specifies the current context for codegen, and gives the
39 /// lowering implementations a chance to set up their default sections.
41  const TargetMachine &TM) {
42  Ctx = &ctx;
43  // `Initialize` can be called more than once.
44  delete Mang;
45  Mang = new Mangler();
48 
49  // Reset various EH DWARF encodings.
51 }
52 
54  delete Mang;
55 }
56 
57 static bool isNullOrUndef(const Constant *C) {
58  // Check that the constant isn't all zeros or undefs.
59  if (C->isNullValue() || isa<UndefValue>(C))
60  return true;
61  if (!isa<ConstantAggregate>(C))
62  return false;
63  for (auto Operand : C->operand_values()) {
64  if (!isNullOrUndef(cast<Constant>(Operand)))
65  return false;
66  }
67  return true;
68 }
69 
70 static bool isSuitableForBSS(const GlobalVariable *GV) {
71  const Constant *C = GV->getInitializer();
72 
73  // Must have zero initializer.
74  if (!isNullOrUndef(C))
75  return false;
76 
77  // Leave constant zeros in readonly constant sections, so they can be shared.
78  if (GV->isConstant())
79  return false;
80 
81  // If the global has an explicit section specified, don't put it in BSS.
82  if (GV->hasSection())
83  return false;
84 
85  // Otherwise, put it in BSS!
86  return true;
87 }
88 
89 /// IsNullTerminatedString - Return true if the specified constant (which is
90 /// known to have a type that is an array of 1/2/4 byte elements) ends with a
91 /// nul value and contains no other nuls in it. Note that this is more general
92 /// than ConstantDataSequential::isString because we allow 2 & 4 byte strings.
93 static bool IsNullTerminatedString(const Constant *C) {
94  // First check: is we have constant array terminated with zero
95  if (const ConstantDataSequential *CDS = dyn_cast<ConstantDataSequential>(C)) {
96  unsigned NumElts = CDS->getNumElements();
97  assert(NumElts != 0 && "Can't have an empty CDS");
98 
99  if (CDS->getElementAsInteger(NumElts-1) != 0)
100  return false; // Not null terminated.
101 
102  // Verify that the null doesn't occur anywhere else in the string.
103  for (unsigned i = 0; i != NumElts-1; ++i)
104  if (CDS->getElementAsInteger(i) == 0)
105  return false;
106  return true;
107  }
108 
109  // Another possibility: [1 x i8] zeroinitializer
110  if (isa<ConstantAggregateZero>(C))
111  return cast<ArrayType>(C->getType())->getNumElements() == 1;
112 
113  return false;
114 }
115 
117  const GlobalValue *GV, StringRef Suffix, const TargetMachine &TM) const {
118  assert(!Suffix.empty());
119 
120  SmallString<60> NameStr;
121  NameStr += GV->getParent()->getDataLayout().getPrivateGlobalPrefix();
122  TM.getNameWithPrefix(NameStr, GV, *Mang);
123  NameStr.append(Suffix.begin(), Suffix.end());
124  return Ctx->getOrCreateSymbol(NameStr);
125 }
126 
128  const GlobalValue *GV, const TargetMachine &TM,
129  MachineModuleInfo *MMI) const {
130  return TM.getSymbol(GV);
131 }
132 
134  const DataLayout &,
135  const MCSymbol *Sym) const {
136 }
137 
138 
139 /// getKindForGlobal - This is a top-level target-independent classifier for
140 /// a global object. Given a global variable and information from the TM, this
141 /// function classifies the global in a target independent manner. This function
142 /// may be overridden by the target implementation.
144  const TargetMachine &TM){
146  "Can only be used for global definitions");
147 
148  // Functions are classified as text sections.
149  if (isa<Function>(GO))
150  return SectionKind::getText();
151 
152  // Global variables require more detailed analysis.
153  const auto *GVar = cast<GlobalVariable>(GO);
154 
155  // Handle thread-local data first.
156  if (GVar->isThreadLocal()) {
157  if (isSuitableForBSS(GVar) && !TM.Options.NoZerosInBSS)
158  return SectionKind::getThreadBSS();
160  }
161 
162  // Variables with common linkage always get classified as common.
163  if (GVar->hasCommonLinkage())
164  return SectionKind::getCommon();
165 
166  // Most non-mergeable zero data can be put in the BSS section unless otherwise
167  // specified.
168  if (isSuitableForBSS(GVar) && !TM.Options.NoZerosInBSS) {
169  if (GVar->hasLocalLinkage())
170  return SectionKind::getBSSLocal();
171  else if (GVar->hasExternalLinkage())
172  return SectionKind::getBSSExtern();
173  return SectionKind::getBSS();
174  }
175 
176  // If the global is marked constant, we can put it into a mergable section,
177  // a mergable string section, or general .data if it contains relocations.
178  if (GVar->isConstant()) {
179  // If the initializer for the global contains something that requires a
180  // relocation, then we may have to drop this into a writable data section
181  // even though it is marked const.
182  const Constant *C = GVar->getInitializer();
183  if (!C->needsRelocation()) {
184  // If the global is required to have a unique address, it can't be put
185  // into a mergable section: just drop it into the general read-only
186  // section instead.
187  if (!GVar->hasGlobalUnnamedAddr())
188  return SectionKind::getReadOnly();
189 
190  // If initializer is a null-terminated string, put it in a "cstring"
191  // section of the right width.
192  if (ArrayType *ATy = dyn_cast<ArrayType>(C->getType())) {
193  if (IntegerType *ITy =
194  dyn_cast<IntegerType>(ATy->getElementType())) {
195  if ((ITy->getBitWidth() == 8 || ITy->getBitWidth() == 16 ||
196  ITy->getBitWidth() == 32) &&
198  if (ITy->getBitWidth() == 8)
200  if (ITy->getBitWidth() == 16)
202 
203  assert(ITy->getBitWidth() == 32 && "Unknown width");
205  }
206  }
207  }
208 
209  // Otherwise, just drop it into a mergable constant section. If we have
210  // a section for this size, use it, otherwise use the arbitrary sized
211  // mergable section.
212  switch (
213  GVar->getParent()->getDataLayout().getTypeAllocSize(C->getType())) {
214  case 4: return SectionKind::getMergeableConst4();
215  case 8: return SectionKind::getMergeableConst8();
216  case 16: return SectionKind::getMergeableConst16();
217  case 32: return SectionKind::getMergeableConst32();
218  default:
219  return SectionKind::getReadOnly();
220  }
221 
222  } else {
223  // In static, ROPI and RWPI relocation models, the linker will resolve
224  // all addresses, so the relocation entries will actually be constants by
225  // the time the app starts up. However, we can't put this into a
226  // mergable section, because the linker doesn't take relocations into
227  // consideration when it tries to merge entries in the section.
228  Reloc::Model ReloModel = TM.getRelocationModel();
229  if (ReloModel == Reloc::Static || ReloModel == Reloc::ROPI ||
230  ReloModel == Reloc::RWPI || ReloModel == Reloc::ROPI_RWPI)
231  return SectionKind::getReadOnly();
232 
233  // Otherwise, the dynamic linker needs to fix it up, put it in the
234  // writable data.rel section.
236  }
237  }
238 
239  // Okay, this isn't a constant.
240  return SectionKind::getData();
241 }
242 
243 /// This method computes the appropriate section to emit the specified global
244 /// variable or function definition. This should not be passed external (or
245 /// available externally) globals.
247  const GlobalObject *GO, SectionKind Kind, const TargetMachine &TM) const {
248  // Select section name.
249  if (GO->hasSection())
250  return getExplicitSectionGlobal(GO, Kind, TM);
251 
252  if (auto *GVar = dyn_cast<GlobalVariable>(GO)) {
253  auto Attrs = GVar->getAttributes();
254  if ((Attrs.hasAttribute("bss-section") && Kind.isBSS()) ||
255  (Attrs.hasAttribute("data-section") && Kind.isData()) ||
256  (Attrs.hasAttribute("rodata-section") && Kind.isReadOnly())) {
257  return getExplicitSectionGlobal(GO, Kind, TM);
258  }
259  }
260 
261  if (auto *F = dyn_cast<Function>(GO)) {
262  if (F->hasFnAttribute("implicit-section-name"))
263  return getExplicitSectionGlobal(GO, Kind, TM);
264  }
265 
266  // Use default section depending on the 'type' of global
267  return SelectSectionForGlobal(GO, Kind, TM);
268 }
269 
271  const Function &F, const TargetMachine &TM) const {
272  unsigned Align = 0;
274  SectionKind::getReadOnly(), /*C=*/nullptr,
275  Align);
276 }
277 
279  bool UsesLabelDifference, const Function &F) const {
280  // In PIC mode, we need to emit the jump table to the same section as the
281  // function body itself, otherwise the label differences won't make sense.
282  // FIXME: Need a better predicate for this: what about custom entries?
283  if (UsesLabelDifference)
284  return true;
285 
286  // We should also do if the section name is NULL or function is declared
287  // in discardable section
288  // FIXME: this isn't the right predicate, should be based on the MCSection
289  // for the function.
290  return F.isWeakForLinker();
291 }
292 
293 /// Given a mergable constant with the specified size and relocation
294 /// information, return a section that it should be placed in.
296  const DataLayout &DL, SectionKind Kind, const Constant *C,
297  unsigned &Align) const {
298  if (Kind.isReadOnly() && ReadOnlySection != nullptr)
299  return ReadOnlySection;
300 
301  return DataSection;
302 }
303 
304 /// getTTypeGlobalReference - Return an MCExpr to use for a
305 /// reference to the specified global variable from exception
306 /// handling information.
308  const GlobalValue *GV, unsigned Encoding, const TargetMachine &TM,
309  MachineModuleInfo *MMI, MCStreamer &Streamer) const {
310  const MCSymbolRefExpr *Ref =
312 
313  return getTTypeReference(Ref, Encoding, Streamer);
314 }
315 
317 getTTypeReference(const MCSymbolRefExpr *Sym, unsigned Encoding,
318  MCStreamer &Streamer) const {
319  switch (Encoding & 0x70) {
320  default:
321  report_fatal_error("We do not support this DWARF encoding yet!");
323  // Do nothing special
324  return Sym;
325  case dwarf::DW_EH_PE_pcrel: {
326  // Emit a label to the streamer for the current position. This gives us
327  // .-foo addressing.
328  MCSymbol *PCSym = getContext().createTempSymbol();
329  Streamer.EmitLabel(PCSym);
330  const MCExpr *PC = MCSymbolRefExpr::create(PCSym, getContext());
331  return MCBinaryExpr::createSub(Sym, PC, getContext());
332  }
333  }
334 }
335 
337  // FIXME: It's not clear what, if any, default this should have - perhaps a
338  // null return could mean 'no location' & we should just do that here.
339  return MCSymbolRefExpr::create(Sym, *Ctx);
340 }
341 
343  SmallVectorImpl<char> &OutName, const GlobalValue *GV,
344  const TargetMachine &TM) const {
345  Mang->getNameWithPrefix(OutName, GV, /*CannotUsePrivateLabel=*/false);
346 }
uint64_t CallInst * C
Instances of this class represent a uniqued identifier for a section in the current translation unit...
Definition: MCSection.h:39
A parsed version of the target data layout string in and methods for querying it. ...
Definition: DataLayout.h:111
constexpr char Align[]
Key for Kernel::Arg::Metadata::mAlign.
static SectionKind getData()
Definition: SectionKind.h:202
static bool isNullOrUndef(const Constant *C)
static const MCSymbolRefExpr * create(const MCSymbol *Symbol, MCContext &Ctx)
Definition: MCExpr.h:323
static SectionKind getMergeableConst32()
Definition: SectionKind.h:195
const Constant * getInitializer() const
getInitializer - Return the initializer for this global variable.
LLVM_ATTRIBUTE_NORETURN void report_fatal_error(Error Err, bool gen_crash_diag=true)
Report a serious error, calling any installed error handler.
Definition: Error.cpp:139
This class represents lattice values for constants.
Definition: AllocatorList.h:24
virtual void emitPersonalityValue(MCStreamer &Streamer, const DataLayout &TM, const MCSymbol *Sym) const
MCSection * SectionForGlobal(const GlobalObject *GO, SectionKind Kind, const TargetMachine &TM) const
This method computes the appropriate section to emit the specified global variable or function defini...
StringRef getPrivateGlobalPrefix() const
Definition: DataLayout.h:294
MCSymbol - Instances of this class represent a symbol name in the MC file, and MCSymbols are created ...
Definition: MCSymbol.h:42
bool needsRelocation() const
This method classifies the entry according to whether or not it may generate a relocation entry...
Definition: Constants.cpp:485
bool hasAvailableExternallyLinkage() const
Definition: GlobalValue.h:423
static SectionKind getMergeableConst8()
Definition: SectionKind.h:193
static SectionKind getMergeableConst16()
Definition: SectionKind.h:194
static SectionKind getMergeable1ByteCString()
Definition: SectionKind.h:183
const MCExpr * getTTypeReference(const MCSymbolRefExpr *Sym, unsigned Encoding, MCStreamer &Streamer) const
static SectionKind getCommon()
Definition: SectionKind.h:201
F(f)
static SectionKind getMergeableConst4()
Definition: SectionKind.h:192
unsigned PersonalityEncoding
PersonalityEncoding, LSDAEncoding, TTypeEncoding - Some encoding values for EH.
static SectionKind getBSS()
Definition: SectionKind.h:198
static SectionKind getMergeable4ByteCString()
Definition: SectionKind.h:189
const DataLayout & getDataLayout() const
Get the data layout for the module&#39;s target platform.
Definition: Module.cpp:364
virtual void Initialize(MCContext &ctx, const TargetMachine &TM)
This method must be called before any actual lowering is done.
bool isConstant() const
If the value is a global constant, its value is immutable throughout the runtime execution of the pro...
Base class for the full range of assembler expressions which are needed for parsing.
Definition: MCExpr.h:36
The access may reference the value stored in memory.
Represent a reference to a symbol from inside an expression.
Definition: MCExpr.h:166
void getNameWithPrefix(SmallVectorImpl< char > &Name, const GlobalValue *GV, Mangler &Mang, bool MayAlwaysUsePrivate=false) const
Context object for machine code objects.
Definition: MCContext.h:63
bool isNullValue() const
Return true if this is the value that would be returned by getNullValue.
Definition: Constants.cpp:85
Type * getType() const
All values are typed, get the type of this value.
Definition: Value.h:245
static const MCBinaryExpr * createSub(const MCExpr *LHS, const MCExpr *RHS, MCContext &Ctx)
Definition: MCExpr.h:546
ConstantDataSequential - A vector or array constant whose element type is a simple 1/2/4/8-byte integ...
Definition: Constants.h:570
Class to represent array types.
Definition: DerivedTypes.h:369
LLVM_NODISCARD LLVM_ATTRIBUTE_ALWAYS_INLINE bool empty() const
empty - Check if the string is empty.
Definition: StringRef.h:133
SmallString - A SmallString is just a SmallVector with methods and accessors that make it work better...
Definition: SmallString.h:26
Reloc::Model getRelocationModel() const
Returns the code generation relocation model.
static SectionKind getThreadData()
Definition: SectionKind.h:197
constexpr char Attrs[]
Key for Kernel::Metadata::mAttrs.
MCSection * DataSection
Section directive for standard data.
static bool isWeakForLinker(LinkageTypes Linkage)
Whether the definition of this global may be replaced at link time.
Definition: GlobalValue.h:370
static SectionKind getBSSLocal()
Definition: SectionKind.h:199
Streaming machine code generation interface.
Definition: MCStreamer.h:188
MCSymbol * createTempSymbol(bool CanBeUnnamed=true)
Create and return a new assembler temporary symbol with a unique but unspecified name.
Definition: MCContext.cpp:217
virtual bool shouldPutJumpTableInFunctionSection(bool UsesLabelDifference, const Function &F) const
This is an important base class in LLVM.
Definition: Constant.h:42
This file contains the declarations for the subclasses of Constant, which represent the different fla...
virtual MCSection * getSectionForConstant(const DataLayout &DL, SectionKind Kind, const Constant *C, unsigned &Align) const
Given a constant with the SectionKind, return a section that it should be placed in.
MCSymbol * getSymbol(const GlobalValue *GV) const
MCSymbol * getSymbolWithGlobalValueBase(const GlobalValue *GV, StringRef Suffix, const TargetMachine &TM) const
Return the MCSymbol for a private symbol with global value name as its base, with the specified suffi...
SectionKind - This is a simple POD value that classifies the properties of a section.
Definition: SectionKind.h:23
const Triple & getTargetTriple() const
virtual const MCExpr * getTTypeGlobalReference(const GlobalValue *GV, unsigned Encoding, const TargetMachine &TM, MachineModuleInfo *MMI, MCStreamer &Streamer) const
Return an MCExpr to use for a reference to the specified global variable from exception handling info...
Class to represent integer types.
Definition: DerivedTypes.h:40
unsigned NoZerosInBSS
NoZerosInBSS - By default some codegens place zero-initialized data to .bss section.
bool isBSS() const
Definition: SectionKind.h:160
static SectionKind getThreadBSS()
Definition: SectionKind.h:196
bool hasSection() const
Check if this global has a custom object file section.
Definition: GlobalObject.h:82
static SectionKind getReadOnlyWithRel()
Definition: SectionKind.h:203
static bool isSuitableForBSS(const GlobalVariable *GV)
This file contains constants used for implementing Dwarf debug support.
CodeModel::Model getCodeModel() const
Returns the code model.
iterator begin() const
Definition: StringRef.h:106
static bool IsNullTerminatedString(const Constant *C)
IsNullTerminatedString - Return true if the specified constant (which is known to have a type that is...
bool isReadOnly() const
Definition: SectionKind.h:123
static SectionKind getMergeable2ByteCString()
Definition: SectionKind.h:186
void InitMCObjectFileInfo(const Triple &TT, bool PIC, MCContext &ctx, bool LargeCodeModel=false)
MCSymbol * getOrCreateSymbol(const Twine &Name)
Lookup the symbol inside with the specified Name.
Definition: MCContext.cpp:123
bool isPositionIndependent() const
TargetOptions Options
Definition: TargetMachine.h:97
iterator_range< value_op_iterator > operand_values()
Definition: User.h:262
static SectionKind getBSSExtern()
Definition: SectionKind.h:200
virtual void getNameWithPrefix(SmallVectorImpl< char > &OutName, const GlobalValue *GV, const TargetMachine &TM) const
virtual MCSection * getExplicitSectionGlobal(const GlobalObject *GO, SectionKind Kind, const TargetMachine &TM) const =0
Targets should implement this method to assign a section to globals with an explicit section specfied...
bool isDeclaration() const
Return true if the primary definition of this global value is outside of the current translation unit...
Definition: Globals.cpp:206
const unsigned Kind
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
Module * getParent()
Get the module that this global value is contained inside of...
Definition: GlobalValue.h:566
bool isData() const
Definition: SectionKind.h:166
virtual MCSection * SelectSectionForGlobal(const GlobalObject *GO, SectionKind Kind, const TargetMachine &TM) const =0
virtual void EmitLabel(MCSymbol *Symbol, SMLoc Loc=SMLoc())
Emit a label for Symbol into the current section.
Definition: MCStreamer.cpp:340
Primary interface to the complete machine description for the target machine.
Definition: TargetMachine.h:59
void getNameWithPrefix(raw_ostream &OS, const GlobalValue *GV, bool CannotUsePrivateLabel) const
Print the appropriate prefix and the specified global variable&#39;s name.
Definition: Mangler.cpp:112
virtual MCSection * getSectionForJumpTable(const Function &F, const TargetMachine &TM) const
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:49
MCSection * ReadOnlySection
Section that is readonly and can contain arbitrary initialized data.
static SectionKind getKindForGlobal(const GlobalObject *GO, const TargetMachine &TM)
Classify the specified global variable into a set of target independent categories embodied in Sectio...
virtual MCSymbol * getCFIPersonalitySymbol(const GlobalValue *GV, const TargetMachine &TM, MachineModuleInfo *MMI) const
virtual const MCExpr * getDebugThreadLocalSymbol(const MCSymbol *Sym) const
Create a symbol reference to describe the given TLS variable when emitting the address in debug info...
iterator end() const
Definition: StringRef.h:108
static SectionKind getReadOnly()
Definition: SectionKind.h:182
This class contains meta information specific to a module.
static SectionKind getText()
Definition: SectionKind.h:180