Fix subprogram-linkonce-weak.ll and subprogram-linkonce-weak-odr.ll for Windows.
[oota-llvm.git] / lib / MC / MCContext.cpp
1 //===- lib/MC/MCContext.cpp - Machine Code Context ------------------------===//
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 #include "llvm/MC/MCContext.h"
11 #include "llvm/ADT/SmallString.h"
12 #include "llvm/ADT/Twine.h"
13 #include "llvm/MC/MCAsmInfo.h"
14 #include "llvm/MC/MCDwarf.h"
15 #include "llvm/MC/MCLabel.h"
16 #include "llvm/MC/MCObjectFileInfo.h"
17 #include "llvm/MC/MCRegisterInfo.h"
18 #include "llvm/MC/MCSectionCOFF.h"
19 #include "llvm/MC/MCSectionELF.h"
20 #include "llvm/MC/MCSectionMachO.h"
21 #include "llvm/MC/MCStreamer.h"
22 #include "llvm/MC/MCSymbol.h"
23 #include "llvm/Support/ELF.h"
24 #include "llvm/Support/ErrorHandling.h"
25 #include "llvm/Support/FileSystem.h"
26 #include "llvm/Support/MemoryBuffer.h"
27 #include "llvm/Support/Signals.h"
28 #include "llvm/Support/SourceMgr.h"
29 #include <map>
30
31 using namespace llvm;
32
33 MCContext::MCContext(const MCAsmInfo *mai, const MCRegisterInfo *mri,
34                      const MCObjectFileInfo *mofi, const SourceMgr *mgr,
35                      bool DoAutoReset)
36     : SrcMgr(mgr), MAI(mai), MRI(mri), MOFI(mofi), Allocator(),
37       Symbols(Allocator), UsedNames(Allocator),
38       CurrentDwarfLoc(0, 0, 0, DWARF2_FLAG_IS_STMT, 0, 0), DwarfLocSeen(false),
39       GenDwarfForAssembly(false), GenDwarfFileNumber(0), DwarfVersion(4),
40       AllowTemporaryLabels(true), DwarfCompileUnitID(0),
41       AutoReset(DoAutoReset) {
42
43   std::error_code EC = llvm::sys::fs::current_path(CompilationDir);
44   if (EC)
45     CompilationDir.clear();
46
47   SecureLogFile = getenv("AS_SECURE_LOG_FILE");
48   SecureLog = nullptr;
49   SecureLogUsed = false;
50
51   if (SrcMgr && SrcMgr->getNumBuffers())
52     MainFileName =
53         SrcMgr->getMemoryBuffer(SrcMgr->getMainFileID())->getBufferIdentifier();
54 }
55
56 MCContext::~MCContext() {
57
58   if (AutoReset)
59     reset();
60
61   // NOTE: The symbols are all allocated out of a bump pointer allocator,
62   // we don't need to free them here.
63
64   // If the stream for the .secure_log_unique directive was created free it.
65   delete (raw_ostream*)SecureLog;
66 }
67
68 //===----------------------------------------------------------------------===//
69 // Module Lifetime Management
70 //===----------------------------------------------------------------------===//
71
72 void MCContext::reset() {
73   UsedNames.clear();
74   Symbols.clear();
75   Allocator.Reset();
76   Instances.clear();
77   CompilationDir.clear();
78   MainFileName.clear();
79   MCDwarfLineTablesCUMap.clear();
80   SectionStartEndSyms.clear();
81   MCGenDwarfLabelEntries.clear();
82   DwarfDebugFlags = StringRef();
83   DwarfCompileUnitID = 0;
84   CurrentDwarfLoc = MCDwarfLoc(0,0,0,DWARF2_FLAG_IS_STMT,0,0);
85
86   MachOUniquingMap.clear();
87   ELFUniquingMap.clear();
88   COFFUniquingMap.clear();
89
90   NextID.clear();
91   AllowTemporaryLabels = true;
92   DwarfLocSeen = false;
93   GenDwarfForAssembly = false;
94   GenDwarfFileNumber = 0;
95 }
96
97 //===----------------------------------------------------------------------===//
98 // Symbol Manipulation
99 //===----------------------------------------------------------------------===//
100
101 MCSymbol *MCContext::GetOrCreateSymbol(const Twine &Name) {
102   SmallString<128> NameSV;
103   StringRef NameRef = Name.toStringRef(NameSV);
104
105   assert(!NameRef.empty() && "Normal symbols cannot be unnamed!");
106
107   MCSymbol *&Sym = Symbols[NameRef];
108   if (!Sym)
109     Sym = CreateSymbol(NameRef, false);
110
111   return Sym;
112 }
113
114 MCSymbol *MCContext::getOrCreateSectionSymbol(const MCSectionELF &Section) {
115   MCSymbol *&Sym = SectionSymbols[&Section];
116   if (Sym)
117     return Sym;
118
119   StringRef Name = Section.getSectionName();
120
121   MCSymbol *&OldSym = Symbols[Name];
122   if (OldSym && OldSym->isUndefined()) {
123     Sym = OldSym;
124     return OldSym;
125   }
126
127   auto NameIter = UsedNames.insert(std::make_pair(Name, true)).first;
128   Sym = new (*this) MCSymbol(NameIter->getKey(), /*isTemporary*/ false);
129
130   if (!OldSym)
131     OldSym = Sym;
132
133   return Sym;
134 }
135
136 MCSymbol *MCContext::getOrCreateFrameAllocSymbol(StringRef FuncName,
137                                                  unsigned Idx) {
138   return GetOrCreateSymbol(Twine(MAI->getPrivateGlobalPrefix()) + FuncName +
139                            "$frame_escape_" + Twine(Idx));
140 }
141
142 MCSymbol *MCContext::CreateSymbol(StringRef Name, bool AlwaysAddSuffix) {
143   // Determine whether this is an assembler temporary or normal label, if used.
144   bool IsTemporary = false;
145   if (AllowTemporaryLabels)
146     IsTemporary = Name.startswith(MAI->getPrivateGlobalPrefix());
147
148   SmallString<128> NewName = Name;
149   bool AddSuffix = AlwaysAddSuffix;
150   unsigned &NextUniqueID = NextID[Name];
151   for (;;) {
152     if (AddSuffix) {
153       NewName.resize(Name.size());
154       raw_svector_ostream(NewName) << NextUniqueID++;
155     }
156     auto NameEntry = UsedNames.insert(std::make_pair(NewName, true));
157     if (NameEntry.second) {
158       // Ok, we found a name. Have the MCSymbol object itself refer to the copy
159       // of the string that is embedded in the UsedNames entry.
160       MCSymbol *Result =
161           new (*this) MCSymbol(NameEntry.first->getKey(), IsTemporary);
162       return Result;
163     }
164     assert(IsTemporary && "Cannot rename non-temporary symbols");
165     AddSuffix = true;
166   }
167   llvm_unreachable("Infinite loop");
168 }
169
170 MCSymbol *MCContext::createTempSymbol(const Twine &Name, bool AlwaysAddSuffix) {
171   SmallString<128> NameSV;
172   raw_svector_ostream(NameSV) << MAI->getPrivateGlobalPrefix() << Name;
173   return CreateSymbol(NameSV, AlwaysAddSuffix);
174 }
175
176 MCSymbol *MCContext::CreateLinkerPrivateTempSymbol() {
177   SmallString<128> NameSV;
178   raw_svector_ostream(NameSV) << MAI->getLinkerPrivateGlobalPrefix() << "tmp";
179   return CreateSymbol(NameSV, true);
180 }
181
182 MCSymbol *MCContext::CreateTempSymbol() {
183   return createTempSymbol("tmp", true);
184 }
185
186 unsigned MCContext::NextInstance(unsigned LocalLabelVal) {
187   MCLabel *&Label = Instances[LocalLabelVal];
188   if (!Label)
189     Label = new (*this) MCLabel(0);
190   return Label->incInstance();
191 }
192
193 unsigned MCContext::GetInstance(unsigned LocalLabelVal) {
194   MCLabel *&Label = Instances[LocalLabelVal];
195   if (!Label)
196     Label = new (*this) MCLabel(0);
197   return Label->getInstance();
198 }
199
200 MCSymbol *MCContext::getOrCreateDirectionalLocalSymbol(unsigned LocalLabelVal,
201                                                        unsigned Instance) {
202   MCSymbol *&Sym = LocalSymbols[std::make_pair(LocalLabelVal, Instance)];
203   if (!Sym)
204     Sym = CreateTempSymbol();
205   return Sym;
206 }
207
208 MCSymbol *MCContext::CreateDirectionalLocalSymbol(unsigned LocalLabelVal) {
209   unsigned Instance = NextInstance(LocalLabelVal);
210   return getOrCreateDirectionalLocalSymbol(LocalLabelVal, Instance);
211 }
212
213 MCSymbol *MCContext::GetDirectionalLocalSymbol(unsigned LocalLabelVal,
214                                                bool Before) {
215   unsigned Instance = GetInstance(LocalLabelVal);
216   if (!Before)
217     ++Instance;
218   return getOrCreateDirectionalLocalSymbol(LocalLabelVal, Instance);
219 }
220
221 MCSymbol *MCContext::LookupSymbol(const Twine &Name) const {
222   SmallString<128> NameSV;
223   StringRef NameRef = Name.toStringRef(NameSV);
224   return Symbols.lookup(NameRef);
225 }
226
227 //===----------------------------------------------------------------------===//
228 // Section Management
229 //===----------------------------------------------------------------------===//
230
231 const MCSectionMachO *
232 MCContext::getMachOSection(StringRef Segment, StringRef Section,
233                            unsigned TypeAndAttributes, unsigned Reserved2,
234                            SectionKind Kind, const char *BeginSymName) {
235
236   // We unique sections by their segment/section pair.  The returned section
237   // may not have the same flags as the requested section, if so this should be
238   // diagnosed by the client as an error.
239
240   // Form the name to look up.
241   SmallString<64> Name;
242   Name += Segment;
243   Name.push_back(',');
244   Name += Section;
245
246   // Do the lookup, if we have a hit, return it.
247   const MCSectionMachO *&Entry = MachOUniquingMap[Name];
248   if (Entry)
249     return Entry;
250
251   MCSymbol *Begin = nullptr;
252   if (BeginSymName)
253     Begin = createTempSymbol(BeginSymName, false);
254
255   // Otherwise, return a new section.
256   return Entry = new (*this) MCSectionMachO(Segment, Section, TypeAndAttributes,
257                                             Reserved2, Kind, Begin);
258 }
259
260 const MCSectionELF *MCContext::getELFSection(StringRef Section, unsigned Type,
261                                              unsigned Flags,
262                                              const char *BeginSymName) {
263   return getELFSection(Section, Type, Flags, 0, "", BeginSymName);
264 }
265
266 void MCContext::renameELFSection(const MCSectionELF *Section, StringRef Name) {
267   StringRef GroupName;
268   if (const MCSymbol *Group = Section->getGroup())
269     GroupName = Group->getName();
270
271   ELFUniquingMap.erase(SectionGroupPair(Section->getSectionName(), GroupName));
272   auto I =
273       ELFUniquingMap.insert(std::make_pair(SectionGroupPair(Name, GroupName),
274                                            Section)).first;
275   StringRef CachedName = I->first.first;
276   const_cast<MCSectionELF*>(Section)->setSectionName(CachedName);
277 }
278
279 const MCSectionELF *MCContext::getELFSection(StringRef Section, unsigned Type,
280                                              unsigned Flags, unsigned EntrySize,
281                                              StringRef Group, bool Unique,
282                                              const char *BeginSymName) {
283   // Do the lookup, if we have a hit, return it.
284   auto IterBool = ELFUniquingMap.insert(
285       std::make_pair(SectionGroupPair(Section, Group), nullptr));
286   auto &Entry = *IterBool.first;
287   if (!IterBool.second && !Unique)
288     return Entry.second;
289
290   MCSymbol *GroupSym = nullptr;
291   if (!Group.empty())
292     GroupSym = GetOrCreateSymbol(Group);
293
294   StringRef CachedName = Entry.first.first;
295
296   SectionKind Kind;
297   if (Flags & ELF::SHF_EXECINSTR)
298     Kind = SectionKind::getText();
299   else
300     Kind = SectionKind::getReadOnly();
301
302   MCSymbol *Begin = nullptr;
303   if (BeginSymName)
304     Begin = createTempSymbol(BeginSymName, false);
305
306   MCSectionELF *Result = new (*this) MCSectionELF(
307       CachedName, Type, Flags, Kind, EntrySize, GroupSym, Unique, Begin);
308   if (!Unique)
309     Entry.second = Result;
310   return Result;
311 }
312
313 const MCSectionELF *MCContext::getELFSection(StringRef Section, unsigned Type,
314                                              unsigned Flags, unsigned EntrySize,
315                                              StringRef Group,
316                                              const char *BeginSymName) {
317   return getELFSection(Section, Type, Flags, EntrySize, Group, false,
318                        BeginSymName);
319 }
320
321 const MCSectionELF *MCContext::CreateELFGroupSection() {
322   MCSectionELF *Result = new (*this)
323       MCSectionELF(".group", ELF::SHT_GROUP, 0, SectionKind::getReadOnly(), 4,
324                    nullptr, false, nullptr);
325   return Result;
326 }
327
328 const MCSectionCOFF *
329 MCContext::getCOFFSection(StringRef Section, unsigned Characteristics,
330                           SectionKind Kind, StringRef COMDATSymName,
331                           int Selection, const char *BeginSymName) {
332   // Do the lookup, if we have a hit, return it.
333
334   SectionGroupTriple T(Section, COMDATSymName, Selection);
335   auto IterBool = COFFUniquingMap.insert(std::make_pair(T, nullptr));
336   auto Iter = IterBool.first;
337   if (!IterBool.second)
338     return Iter->second;
339
340   MCSymbol *COMDATSymbol = nullptr;
341   if (!COMDATSymName.empty())
342     COMDATSymbol = GetOrCreateSymbol(COMDATSymName);
343
344   MCSymbol *Begin = nullptr;
345   if (BeginSymName)
346     Begin = createTempSymbol(BeginSymName, false);
347
348   StringRef CachedName = std::get<0>(Iter->first);
349   MCSectionCOFF *Result = new (*this) MCSectionCOFF(
350       CachedName, Characteristics, COMDATSymbol, Selection, Kind, Begin);
351
352   Iter->second = Result;
353   return Result;
354 }
355
356 const MCSectionCOFF *MCContext::getCOFFSection(StringRef Section,
357                                                unsigned Characteristics,
358                                                SectionKind Kind,
359                                                const char *BeginSymName) {
360   return getCOFFSection(Section, Characteristics, Kind, "", 0, BeginSymName);
361 }
362
363 const MCSectionCOFF *MCContext::getCOFFSection(StringRef Section) {
364   SectionGroupTriple T(Section, "", 0);
365   auto Iter = COFFUniquingMap.find(T);
366   if (Iter == COFFUniquingMap.end())
367     return nullptr;
368   return Iter->second;
369 }
370
371 const MCSectionCOFF *
372 MCContext::getAssociativeCOFFSection(const MCSectionCOFF *Sec,
373                                      const MCSymbol *KeySym) {
374   // Return the normal section if we don't have to be associative.
375   if (!KeySym)
376     return Sec;
377
378   // Make an associative section with the same name and kind as the normal
379   // section.
380   unsigned Characteristics =
381       Sec->getCharacteristics() | COFF::IMAGE_SCN_LNK_COMDAT;
382   return getCOFFSection(Sec->getSectionName(), Characteristics, Sec->getKind(),
383                         KeySym->getName(),
384                         COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE);
385 }
386
387 //===----------------------------------------------------------------------===//
388 // Dwarf Management
389 //===----------------------------------------------------------------------===//
390
391 /// GetDwarfFile - takes a file name an number to place in the dwarf file and
392 /// directory tables.  If the file number has already been allocated it is an
393 /// error and zero is returned and the client reports the error, else the
394 /// allocated file number is returned.  The file numbers may be in any order.
395 unsigned MCContext::GetDwarfFile(StringRef Directory, StringRef FileName,
396                                  unsigned FileNumber, unsigned CUID) {
397   MCDwarfLineTable &Table = MCDwarfLineTablesCUMap[CUID];
398   return Table.getFile(Directory, FileName, FileNumber);
399 }
400
401 /// isValidDwarfFileNumber - takes a dwarf file number and returns true if it
402 /// currently is assigned and false otherwise.
403 bool MCContext::isValidDwarfFileNumber(unsigned FileNumber, unsigned CUID) {
404   const SmallVectorImpl<MCDwarfFile>& MCDwarfFiles = getMCDwarfFiles(CUID);
405   if(FileNumber == 0 || FileNumber >= MCDwarfFiles.size())
406     return false;
407
408   return !MCDwarfFiles[FileNumber].Name.empty();
409 }
410
411 /// finalizeDwarfSections - Emit end symbols for each non-empty code section.
412 /// Also remove empty sections from SectionStartEndSyms, to avoid generating
413 /// useless debug info for them.
414 void MCContext::finalizeDwarfSections(MCStreamer &MCOS) {
415   MCContext &context = MCOS.getContext();
416
417   auto sec = SectionStartEndSyms.begin();
418   while (sec != SectionStartEndSyms.end()) {
419     assert(sec->second.first && "Start symbol must be set by now");
420     MCOS.SwitchSection(sec->first);
421     if (MCOS.mayHaveInstructions()) {
422       MCSymbol *SectionEndSym = context.CreateTempSymbol();
423       MCOS.EmitLabel(SectionEndSym);
424       sec->second.second = SectionEndSym;
425       ++sec;
426     } else {
427       MapVector<const MCSection *, std::pair<MCSymbol *, MCSymbol *> >::iterator
428         to_erase = sec;
429       sec = SectionStartEndSyms.erase(to_erase);
430     }
431   }
432 }
433
434 void MCContext::FatalError(SMLoc Loc, const Twine &Msg) const {
435   // If we have a source manager and a location, use it. Otherwise just
436   // use the generic report_fatal_error().
437   if (!SrcMgr || Loc == SMLoc())
438     report_fatal_error(Msg, false);
439
440   // Use the source manager to print the message.
441   SrcMgr->PrintMessage(Loc, SourceMgr::DK_Error, Msg);
442
443   // If we reached here, we are failing ungracefully. Run the interrupt handlers
444   // to make sure any special cleanups get done, in particular that we remove
445   // files registered with RemoveFileOnSignal.
446   sys::RunInterruptHandlers();
447   exit(1);
448 }