1 //===-- llvm/Target/TargetLoweringObjectFile.cpp - Object File Info -------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements classes used to handle lowerings specific to common
11 // object file formats.
13 //===----------------------------------------------------------------------===//
15 #include "llvm/Target/TargetLoweringObjectFile.h"
16 #include "llvm/IR/Constants.h"
17 #include "llvm/IR/DataLayout.h"
18 #include "llvm/IR/DerivedTypes.h"
19 #include "llvm/IR/Function.h"
20 #include "llvm/IR/GlobalVariable.h"
21 #include "llvm/IR/Mangler.h"
22 #include "llvm/MC/MCAsmInfo.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"
27 #include "llvm/Support/Dwarf.h"
28 #include "llvm/Support/ErrorHandling.h"
29 #include "llvm/Support/raw_ostream.h"
30 #include "llvm/Target/TargetLowering.h"
31 #include "llvm/Target/TargetMachine.h"
32 #include "llvm/Target/TargetOptions.h"
33 #include "llvm/Target/TargetSubtargetInfo.h"
36 //===----------------------------------------------------------------------===//
38 //===----------------------------------------------------------------------===//
40 /// Initialize - this method must be called before any actual lowering is
41 /// done. This specifies the current context for codegen, and gives the
42 /// lowering implementations a chance to set up their default sections.
43 void TargetLoweringObjectFile::Initialize(MCContext &ctx,
44 const TargetMachine &TM) {
46 InitMCObjectFileInfo(TM.getTargetTriple(), TM.getRelocationModel(),
47 TM.getCodeModel(), *Ctx);
50 TargetLoweringObjectFile::~TargetLoweringObjectFile() {
53 static bool isSuitableForBSS(const GlobalVariable *GV, bool NoZerosInBSS) {
54 const Constant *C = GV->getInitializer();
56 // Must have zero initializer.
57 if (!C->isNullValue())
60 // Leave constant zeros in readonly constant sections, so they can be shared.
64 // If the global has an explicit section specified, don't put it in BSS.
68 // If -nozero-initialized-in-bss is specified, don't ever use BSS.
72 // Otherwise, put it in BSS!
76 /// IsNullTerminatedString - Return true if the specified constant (which is
77 /// known to have a type that is an array of 1/2/4 byte elements) ends with a
78 /// nul value and contains no other nuls in it. Note that this is more general
79 /// than ConstantDataSequential::isString because we allow 2 & 4 byte strings.
80 static bool IsNullTerminatedString(const Constant *C) {
81 // First check: is we have constant array terminated with zero
82 if (const ConstantDataSequential *CDS = dyn_cast<ConstantDataSequential>(C)) {
83 unsigned NumElts = CDS->getNumElements();
84 assert(NumElts != 0 && "Can't have an empty CDS");
86 if (CDS->getElementAsInteger(NumElts-1) != 0)
87 return false; // Not null terminated.
89 // Verify that the null doesn't occur anywhere else in the string.
90 for (unsigned i = 0; i != NumElts-1; ++i)
91 if (CDS->getElementAsInteger(i) == 0)
96 // Another possibility: [1 x i8] zeroinitializer
97 if (isa<ConstantAggregateZero>(C))
98 return cast<ArrayType>(C->getType())->getNumElements() == 1;
103 MCSymbol *TargetLoweringObjectFile::getSymbolWithGlobalValueBase(
104 const GlobalValue *GV, StringRef Suffix, Mangler &Mang,
105 const TargetMachine &TM) const {
106 assert(!Suffix.empty());
108 SmallString<60> NameStr;
109 NameStr += GV->getParent()->getDataLayout().getPrivateGlobalPrefix();
110 TM.getNameWithPrefix(NameStr, GV, Mang);
111 NameStr.append(Suffix.begin(), Suffix.end());
112 return Ctx->getOrCreateSymbol(NameStr);
115 MCSymbol *TargetLoweringObjectFile::getCFIPersonalitySymbol(
116 const GlobalValue *GV, Mangler &Mang, const TargetMachine &TM,
117 MachineModuleInfo *MMI) const {
118 return TM.getSymbol(GV, Mang);
121 void TargetLoweringObjectFile::emitPersonalityValue(MCStreamer &Streamer,
123 const MCSymbol *Sym) const {
127 /// getKindForGlobal - This is a top-level target-independent classifier for
128 /// a global variable. Given an global variable and information from TM, it
129 /// classifies the global in a variety of ways that make various target
130 /// implementations simpler. The target implementation is free to ignore this
131 /// extra info of course.
132 SectionKind TargetLoweringObjectFile::getKindForGlobal(const GlobalValue *GV,
133 const TargetMachine &TM){
134 assert(!GV->isDeclaration() && !GV->hasAvailableExternallyLinkage() &&
135 "Can only be used for global definitions");
137 Reloc::Model ReloModel = TM.getRelocationModel();
139 // Early exit - functions should be always in text sections.
140 const GlobalVariable *GVar = dyn_cast<GlobalVariable>(GV);
142 return SectionKind::getText();
144 // Handle thread-local data first.
145 if (GVar->isThreadLocal()) {
146 if (isSuitableForBSS(GVar, TM.Options.NoZerosInBSS))
147 return SectionKind::getThreadBSS();
148 return SectionKind::getThreadData();
151 // Variables with common linkage always get classified as common.
152 if (GVar->hasCommonLinkage())
153 return SectionKind::getCommon();
155 // Variable can be easily put to BSS section.
156 if (isSuitableForBSS(GVar, TM.Options.NoZerosInBSS)) {
157 if (GVar->hasLocalLinkage())
158 return SectionKind::getBSSLocal();
159 else if (GVar->hasExternalLinkage())
160 return SectionKind::getBSSExtern();
161 return SectionKind::getBSS();
164 const Constant *C = GVar->getInitializer();
166 // If the global is marked constant, we can put it into a mergable section,
167 // a mergable string section, or general .data if it contains relocations.
168 if (GVar->isConstant()) {
169 // If the initializer for the global contains something that requires a
170 // relocation, then we may have to drop this into a writable data section
171 // even though it is marked const.
172 switch (C->getRelocationInfo()) {
173 case Constant::NoRelocation:
174 // If the global is required to have a unique address, it can't be put
175 // into a mergable section: just drop it into the general read-only
177 if (!GVar->hasUnnamedAddr())
178 return SectionKind::getReadOnly();
180 // If initializer is a null-terminated string, put it in a "cstring"
181 // section of the right width.
182 if (ArrayType *ATy = dyn_cast<ArrayType>(C->getType())) {
183 if (IntegerType *ITy =
184 dyn_cast<IntegerType>(ATy->getElementType())) {
185 if ((ITy->getBitWidth() == 8 || ITy->getBitWidth() == 16 ||
186 ITy->getBitWidth() == 32) &&
187 IsNullTerminatedString(C)) {
188 if (ITy->getBitWidth() == 8)
189 return SectionKind::getMergeable1ByteCString();
190 if (ITy->getBitWidth() == 16)
191 return SectionKind::getMergeable2ByteCString();
193 assert(ITy->getBitWidth() == 32 && "Unknown width");
194 return SectionKind::getMergeable4ByteCString();
199 // Otherwise, just drop it into a mergable constant section. If we have
200 // a section for this size, use it, otherwise use the arbitrary sized
202 switch (GV->getParent()->getDataLayout().getTypeAllocSize(C->getType())) {
203 case 4: return SectionKind::getMergeableConst4();
204 case 8: return SectionKind::getMergeableConst8();
205 case 16: return SectionKind::getMergeableConst16();
207 return SectionKind::getReadOnly();
210 case Constant::LocalRelocation:
211 // In static relocation model, the linker will resolve all addresses, so
212 // the relocation entries will actually be constants by the time the app
213 // starts up. However, we can't put this into a mergable section, because
214 // the linker doesn't take relocations into consideration when it tries to
215 // merge entries in the section.
216 if (ReloModel == Reloc::Static)
217 return SectionKind::getReadOnly();
219 // Otherwise, the dynamic linker needs to fix it up, put it in the
220 // writable data.rel.local section.
221 return SectionKind::getReadOnlyWithRelLocal();
223 case Constant::GlobalRelocations:
224 // In static relocation model, the linker will resolve all addresses, so
225 // the relocation entries will actually be constants by the time the app
226 // starts up. However, we can't put this into a mergable section, because
227 // the linker doesn't take relocations into consideration when it tries to
228 // merge entries in the section.
229 if (ReloModel == Reloc::Static)
230 return SectionKind::getReadOnly();
232 // Otherwise, the dynamic linker needs to fix it up, put it in the
233 // writable data.rel section.
234 return SectionKind::getReadOnlyWithRel();
238 // Okay, this isn't a constant. If the initializer for the global is going
239 // to require a runtime relocation by the dynamic linker, put it into a more
240 // specific section to improve startup time of the app. This coalesces these
241 // globals together onto fewer pages, improving the locality of the dynamic
243 if (ReloModel == Reloc::Static)
244 return SectionKind::getDataNoRel();
246 switch (C->getRelocationInfo()) {
247 case Constant::NoRelocation:
248 return SectionKind::getDataNoRel();
249 case Constant::LocalRelocation:
250 return SectionKind::getDataRelLocal();
251 case Constant::GlobalRelocations:
252 return SectionKind::getDataRel();
254 llvm_unreachable("Invalid relocation");
257 /// This method computes the appropriate section to emit the specified global
258 /// variable or function definition. This should not be passed external (or
259 /// available externally) globals.
261 TargetLoweringObjectFile::SectionForGlobal(const GlobalValue *GV,
262 SectionKind Kind, Mangler &Mang,
263 const TargetMachine &TM) const {
264 // Select section name.
265 if (GV->hasSection())
266 return getExplicitSectionGlobal(GV, Kind, Mang, TM);
269 // Use default section depending on the 'type' of global
270 return SelectSectionForGlobal(GV, Kind, Mang, TM);
273 MCSection *TargetLoweringObjectFile::getSectionForJumpTable(
274 const Function &F, Mangler &Mang, const TargetMachine &TM) const {
275 return getSectionForConstant(F.getParent()->getDataLayout(),
276 SectionKind::getReadOnly(), /*C=*/nullptr);
279 bool TargetLoweringObjectFile::shouldPutJumpTableInFunctionSection(
280 bool UsesLabelDifference, const Function &F) const {
281 // In PIC mode, we need to emit the jump table to the same section as the
282 // function body itself, otherwise the label differences won't make sense.
283 // FIXME: Need a better predicate for this: what about custom entries?
284 if (UsesLabelDifference)
287 // We should also do if the section name is NULL or function is declared
288 // in discardable section
289 // FIXME: this isn't the right predicate, should be based on the MCSection
291 if (F.isWeakForLinker())
297 /// Given a mergable constant with the specified size and relocation
298 /// information, return a section that it should be placed in.
299 MCSection *TargetLoweringObjectFile::getSectionForConstant(
300 const DataLayout &DL, SectionKind Kind, const Constant *C) const {
301 if (Kind.isReadOnly() && ReadOnlySection != nullptr)
302 return ReadOnlySection;
307 /// getTTypeGlobalReference - Return an MCExpr to use for a
308 /// reference to the specified global variable from exception
309 /// handling information.
310 const MCExpr *TargetLoweringObjectFile::getTTypeGlobalReference(
311 const GlobalValue *GV, unsigned Encoding, Mangler &Mang,
312 const TargetMachine &TM, MachineModuleInfo *MMI,
313 MCStreamer &Streamer) const {
314 const MCSymbolRefExpr *Ref =
315 MCSymbolRefExpr::create(TM.getSymbol(GV, Mang), getContext());
317 return getTTypeReference(Ref, Encoding, Streamer);
320 const MCExpr *TargetLoweringObjectFile::
321 getTTypeReference(const MCSymbolRefExpr *Sym, unsigned Encoding,
322 MCStreamer &Streamer) const {
323 switch (Encoding & 0x70) {
325 report_fatal_error("We do not support this DWARF encoding yet!");
326 case dwarf::DW_EH_PE_absptr:
327 // Do nothing special
329 case dwarf::DW_EH_PE_pcrel: {
330 // Emit a label to the streamer for the current position. This gives us
332 MCSymbol *PCSym = getContext().createTempSymbol();
333 Streamer.EmitLabel(PCSym);
334 const MCExpr *PC = MCSymbolRefExpr::create(PCSym, getContext());
335 return MCBinaryExpr::createSub(Sym, PC, getContext());
340 const MCExpr *TargetLoweringObjectFile::getDebugThreadLocalSymbol(const MCSymbol *Sym) const {
341 // FIXME: It's not clear what, if any, default this should have - perhaps a
342 // null return could mean 'no location' & we should just do that here.
343 return MCSymbolRefExpr::create(Sym, *Ctx);
346 void TargetLoweringObjectFile::getNameWithPrefix(
347 SmallVectorImpl<char> &OutName, const GlobalValue *GV,
348 bool CannotUsePrivateLabel, Mangler &Mang, const TargetMachine &TM) const {
349 Mang.getNameWithPrefix(OutName, GV, CannotUsePrivateLabel);