1 //===- lib/MC/MCContext.cpp - Machine Code Context ------------------------===//
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 #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"
33 MCContext::MCContext(const MCAsmInfo *mai, const MCRegisterInfo *mri,
34 const MCObjectFileInfo *mofi, const SourceMgr *mgr,
36 : SrcMgr(mgr), MAI(mai), MRI(mri), MOFI(mofi), Allocator(),
37 Symbols(Allocator), UsedNames(Allocator), NextUniqueID(0),
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) {
43 std::error_code EC = llvm::sys::fs::current_path(CompilationDir);
45 CompilationDir.clear();
47 SecureLogFile = getenv("AS_SECURE_LOG_FILE");
49 SecureLogUsed = false;
51 if (SrcMgr && SrcMgr->getNumBuffers())
53 SrcMgr->getMemoryBuffer(SrcMgr->getMainFileID())->getBufferIdentifier();
56 MCContext::~MCContext() {
61 // NOTE: The symbols are all allocated out of a bump pointer allocator,
62 // we don't need to free them here.
64 // If the stream for the .secure_log_unique directive was created free it.
65 delete (raw_ostream*)SecureLog;
68 //===----------------------------------------------------------------------===//
69 // Module Lifetime Management
70 //===----------------------------------------------------------------------===//
72 void MCContext::reset() {
77 CompilationDir.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);
86 MachOUniquingMap.clear();
87 ELFUniquingMap.clear();
88 COFFUniquingMap.clear();
91 AllowTemporaryLabels = true;
93 GenDwarfForAssembly = false;
94 GenDwarfFileNumber = 0;
97 //===----------------------------------------------------------------------===//
98 // Symbol Manipulation
99 //===----------------------------------------------------------------------===//
101 MCSymbol *MCContext::GetOrCreateSymbol(StringRef Name) {
102 assert(!Name.empty() && "Normal symbols cannot be unnamed!");
104 MCSymbol *&Sym = Symbols[Name];
107 Sym = CreateSymbol(Name);
112 MCSymbol *MCContext::getOrCreateSectionSymbol(const MCSectionELF &Section) {
113 MCSymbol *&Sym = SectionSymbols[&Section];
117 StringRef Name = Section.getSectionName();
119 MCSymbol *&OldSym = Symbols[Name];
120 if (OldSym && OldSym->isUndefined()) {
125 auto NameIter = UsedNames.insert(std::make_pair(Name, true)).first;
126 Sym = new (*this) MCSymbol(NameIter->getKey(), /*isTemporary*/ false);
134 MCSymbol *MCContext::getOrCreateFrameAllocSymbol(StringRef FuncName,
136 return GetOrCreateSymbol(Twine(MAI->getPrivateGlobalPrefix()) + FuncName +
137 "$frame_escape_" + Twine(Idx));
140 MCSymbol *MCContext::CreateSymbol(StringRef Name) {
141 // Determine whether this is an assembler temporary or normal label, if used.
142 bool isTemporary = false;
143 if (AllowTemporaryLabels)
144 isTemporary = Name.startswith(MAI->getPrivateGlobalPrefix());
146 auto NameEntry = UsedNames.insert(std::make_pair(Name, true));
147 if (!NameEntry.second) {
148 assert(isTemporary && "Cannot rename non-temporary symbols");
149 SmallString<128> NewName = Name;
151 NewName.resize(Name.size());
152 raw_svector_ostream(NewName) << NextUniqueID++;
153 NameEntry = UsedNames.insert(std::make_pair(NewName, true));
154 } while (!NameEntry.second);
157 // Ok, the entry doesn't already exist. Have the MCSymbol object itself refer
158 // to the copy of the string that is embedded in the UsedNames entry.
160 new (*this) MCSymbol(NameEntry.first->getKey(), isTemporary);
165 MCSymbol *MCContext::createTempSymbol(const Twine &Name) {
166 SmallString<128> NameSV;
167 raw_svector_ostream(NameSV) << MAI->getPrivateGlobalPrefix() << Name;
168 return CreateSymbol(NameSV);
171 MCSymbol *MCContext::GetOrCreateSymbol(const Twine &Name) {
172 SmallString<128> NameSV;
173 return GetOrCreateSymbol(Name.toStringRef(NameSV));
176 MCSymbol *MCContext::CreateLinkerPrivateTempSymbol() {
177 SmallString<128> NameSV;
178 raw_svector_ostream(NameSV)
179 << MAI->getLinkerPrivateGlobalPrefix() << "tmp" << NextUniqueID++;
180 return CreateSymbol(NameSV);
183 MCSymbol *MCContext::CreateTempSymbol() {
184 SmallString<128> NameSV;
185 raw_svector_ostream(NameSV)
186 << MAI->getPrivateGlobalPrefix() << "tmp" << NextUniqueID++;
187 return CreateSymbol(NameSV);
190 unsigned MCContext::NextInstance(unsigned LocalLabelVal) {
191 MCLabel *&Label = Instances[LocalLabelVal];
193 Label = new (*this) MCLabel(0);
194 return Label->incInstance();
197 unsigned MCContext::GetInstance(unsigned LocalLabelVal) {
198 MCLabel *&Label = Instances[LocalLabelVal];
200 Label = new (*this) MCLabel(0);
201 return Label->getInstance();
204 MCSymbol *MCContext::getOrCreateDirectionalLocalSymbol(unsigned LocalLabelVal,
206 MCSymbol *&Sym = LocalSymbols[std::make_pair(LocalLabelVal, Instance)];
208 Sym = CreateTempSymbol();
212 MCSymbol *MCContext::CreateDirectionalLocalSymbol(unsigned LocalLabelVal) {
213 unsigned Instance = NextInstance(LocalLabelVal);
214 return getOrCreateDirectionalLocalSymbol(LocalLabelVal, Instance);
217 MCSymbol *MCContext::GetDirectionalLocalSymbol(unsigned LocalLabelVal,
219 unsigned Instance = GetInstance(LocalLabelVal);
222 return getOrCreateDirectionalLocalSymbol(LocalLabelVal, Instance);
225 MCSymbol *MCContext::LookupSymbol(StringRef Name) const {
226 return Symbols.lookup(Name);
229 MCSymbol *MCContext::LookupSymbol(const Twine &Name) const {
230 SmallString<128> NameSV;
231 Name.toVector(NameSV);
232 return LookupSymbol(NameSV.str());
235 //===----------------------------------------------------------------------===//
236 // Section Management
237 //===----------------------------------------------------------------------===//
239 const MCSectionMachO *
240 MCContext::getMachOSection(StringRef Segment, StringRef Section,
241 unsigned TypeAndAttributes, unsigned Reserved2,
242 SectionKind Kind, const char *BeginSymName) {
244 // We unique sections by their segment/section pair. The returned section
245 // may not have the same flags as the requested section, if so this should be
246 // diagnosed by the client as an error.
248 // Form the name to look up.
249 SmallString<64> Name;
254 // Do the lookup, if we have a hit, return it.
255 const MCSectionMachO *&Entry = MachOUniquingMap[Name.str()];
259 MCSymbol *Begin = nullptr;
261 Begin = createTempSymbol(BeginSymName);
263 // Otherwise, return a new section.
264 return Entry = new (*this) MCSectionMachO(Segment, Section, TypeAndAttributes,
265 Reserved2, Kind, Begin);
268 const MCSectionELF *MCContext::getELFSection(StringRef Section, unsigned Type,
270 const char *BeginSymName) {
271 return getELFSection(Section, Type, Flags, 0, "", BeginSymName);
274 void MCContext::renameELFSection(const MCSectionELF *Section, StringRef Name) {
276 if (const MCSymbol *Group = Section->getGroup())
277 GroupName = Group->getName();
279 ELFUniquingMap.erase(SectionGroupPair(Section->getSectionName(), GroupName));
281 ELFUniquingMap.insert(std::make_pair(SectionGroupPair(Name, GroupName),
283 StringRef CachedName = I->first.first;
284 const_cast<MCSectionELF*>(Section)->setSectionName(CachedName);
287 const MCSectionELF *MCContext::getELFSection(StringRef Section, unsigned Type,
288 unsigned Flags, unsigned EntrySize,
289 StringRef Group, bool Unique,
290 const char *BeginSymName) {
291 // Do the lookup, if we have a hit, return it.
292 auto IterBool = ELFUniquingMap.insert(
293 std::make_pair(SectionGroupPair(Section, Group), nullptr));
294 auto &Entry = *IterBool.first;
295 if (!IterBool.second && !Unique)
298 MCSymbol *GroupSym = nullptr;
300 GroupSym = GetOrCreateSymbol(Group);
302 StringRef CachedName = Entry.first.first;
305 if (Flags & ELF::SHF_EXECINSTR)
306 Kind = SectionKind::getText();
308 Kind = SectionKind::getReadOnly();
310 MCSymbol *Begin = nullptr;
312 Begin = createTempSymbol(BeginSymName);
314 MCSectionELF *Result = new (*this) MCSectionELF(
315 CachedName, Type, Flags, Kind, EntrySize, GroupSym, Unique, Begin);
317 Entry.second = Result;
321 const MCSectionELF *MCContext::getELFSection(StringRef Section, unsigned Type,
322 unsigned Flags, unsigned EntrySize,
324 const char *BeginSymName) {
325 return getELFSection(Section, Type, Flags, EntrySize, Group, false,
329 const MCSectionELF *MCContext::CreateELFGroupSection() {
330 MCSectionELF *Result = new (*this)
331 MCSectionELF(".group", ELF::SHT_GROUP, 0, SectionKind::getReadOnly(), 4,
332 nullptr, false, nullptr);
336 const MCSectionCOFF *
337 MCContext::getCOFFSection(StringRef Section, unsigned Characteristics,
338 SectionKind Kind, StringRef COMDATSymName,
339 int Selection, const char *BeginSymName) {
340 // Do the lookup, if we have a hit, return it.
342 SectionGroupTriple T(Section, COMDATSymName, Selection);
343 auto IterBool = COFFUniquingMap.insert(std::make_pair(T, nullptr));
344 auto Iter = IterBool.first;
345 if (!IterBool.second)
348 MCSymbol *COMDATSymbol = nullptr;
349 if (!COMDATSymName.empty())
350 COMDATSymbol = GetOrCreateSymbol(COMDATSymName);
352 MCSymbol *Begin = nullptr;
354 Begin = createTempSymbol(BeginSymName);
356 StringRef CachedName = std::get<0>(Iter->first);
357 MCSectionCOFF *Result = new (*this) MCSectionCOFF(
358 CachedName, Characteristics, COMDATSymbol, Selection, Kind, Begin);
360 Iter->second = Result;
364 const MCSectionCOFF *MCContext::getCOFFSection(StringRef Section,
365 unsigned Characteristics,
367 const char *BeginSymName) {
368 return getCOFFSection(Section, Characteristics, Kind, "", 0, BeginSymName);
371 const MCSectionCOFF *MCContext::getCOFFSection(StringRef Section) {
372 SectionGroupTriple T(Section, "", 0);
373 auto Iter = COFFUniquingMap.find(T);
374 if (Iter == COFFUniquingMap.end())
379 const MCSectionCOFF *
380 MCContext::getAssociativeCOFFSection(const MCSectionCOFF *Sec,
381 const MCSymbol *KeySym) {
382 // Return the normal section if we don't have to be associative.
386 // Make an associative section with the same name and kind as the normal
388 unsigned Characteristics =
389 Sec->getCharacteristics() | COFF::IMAGE_SCN_LNK_COMDAT;
390 return getCOFFSection(Sec->getSectionName(), Characteristics, Sec->getKind(),
392 COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE);
395 //===----------------------------------------------------------------------===//
397 //===----------------------------------------------------------------------===//
399 /// GetDwarfFile - takes a file name an number to place in the dwarf file and
400 /// directory tables. If the file number has already been allocated it is an
401 /// error and zero is returned and the client reports the error, else the
402 /// allocated file number is returned. The file numbers may be in any order.
403 unsigned MCContext::GetDwarfFile(StringRef Directory, StringRef FileName,
404 unsigned FileNumber, unsigned CUID) {
405 MCDwarfLineTable &Table = MCDwarfLineTablesCUMap[CUID];
406 return Table.getFile(Directory, FileName, FileNumber);
409 /// isValidDwarfFileNumber - takes a dwarf file number and returns true if it
410 /// currently is assigned and false otherwise.
411 bool MCContext::isValidDwarfFileNumber(unsigned FileNumber, unsigned CUID) {
412 const SmallVectorImpl<MCDwarfFile>& MCDwarfFiles = getMCDwarfFiles(CUID);
413 if(FileNumber == 0 || FileNumber >= MCDwarfFiles.size())
416 return !MCDwarfFiles[FileNumber].Name.empty();
419 /// finalizeDwarfSections - Emit end symbols for each non-empty code section.
420 /// Also remove empty sections from SectionStartEndSyms, to avoid generating
421 /// useless debug info for them.
422 void MCContext::finalizeDwarfSections(MCStreamer &MCOS) {
423 MCContext &context = MCOS.getContext();
425 auto sec = SectionStartEndSyms.begin();
426 while (sec != SectionStartEndSyms.end()) {
427 assert(sec->second.first && "Start symbol must be set by now");
428 MCOS.SwitchSection(sec->first);
429 if (MCOS.mayHaveInstructions()) {
430 MCSymbol *SectionEndSym = context.CreateTempSymbol();
431 MCOS.EmitLabel(SectionEndSym);
432 sec->second.second = SectionEndSym;
435 MapVector<const MCSection *, std::pair<MCSymbol *, MCSymbol *> >::iterator
437 sec = SectionStartEndSyms.erase(to_erase);
442 void MCContext::FatalError(SMLoc Loc, const Twine &Msg) const {
443 // If we have a source manager and a location, use it. Otherwise just
444 // use the generic report_fatal_error().
445 if (!SrcMgr || Loc == SMLoc())
446 report_fatal_error(Msg, false);
448 // Use the source manager to print the message.
449 SrcMgr->PrintMessage(Loc, SourceMgr::DK_Error, Msg);
451 // If we reached here, we are failing ungracefully. Run the interrupt handlers
452 // to make sure any special cleanups get done, in particular that we remove
453 // files registered with RemoveFileOnSignal.
454 sys::RunInterruptHandlers();