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/MCSymbol.h"
  22 #include "llvm/Support/ELF.h"
  23 #include "llvm/Support/ErrorHandling.h"
  24 #include "llvm/Support/FileSystem.h"
  25 #include "llvm/Support/MemoryBuffer.h"
  26 #include "llvm/Support/Signals.h"
  27 #include "llvm/Support/SourceMgr.h"
  28 #include <map>
  29
  30 using namespace llvm;
  31
  32 typedef std::pair<std::string, std::string> SectionGroupPair;
  33
  34 typedef StringMap<const MCSectionMachO*> MachOUniqueMapTy;
  35 typedef std::map<SectionGroupPair, const MCSectionELF *> ELFUniqueMapTy;
  36 typedef std::map<SectionGroupPair, const MCSectionCOFF *> COFFUniqueMapTy;
  37
  38 MCContext::MCContext(const MCAsmInfo *mai, const MCRegisterInfo *mri,
  39                      const MCObjectFileInfo *mofi, const SourceMgr *mgr,
  40                      bool DoAutoReset)
  41     : SrcMgr(mgr), MAI(mai), MRI(mri), MOFI(mofi), Allocator(),
  42       Symbols(Allocator), UsedNames(Allocator), NextUniqueID(0),
  43       CurrentDwarfLoc(0, 0, 0, DWARF2_FLAG_IS_STMT, 0, 0), DwarfLocSeen(false),
  44       GenDwarfForAssembly(false), GenDwarfFileNumber(0),
  45       AllowTemporaryLabels(true), DwarfCompileUnitID(0),
  46       AutoReset(DoAutoReset) {
  47
  48   error_code EC = llvm::sys::fs::current_path(CompilationDir);
  49   if (EC)
  50     CompilationDir.clear();
  51
  52   MachOUniquingMap = 0;
  53   ELFUniquingMap = 0;
  54   COFFUniquingMap = 0;
  55
  56   SecureLogFile = getenv("AS_SECURE_LOG_FILE");
  57   SecureLog = 0;
  58   SecureLogUsed = false;
  59
  60   if (SrcMgr && SrcMgr->getNumBuffers() > 0)
  61     MainFileName = SrcMgr->getMemoryBuffer(0)->getBufferIdentifier();
  62 }
  63
  64 MCContext::~MCContext() {
  65
  66   if (AutoReset)
  67     reset();
  68
  69   // NOTE: The symbols are all allocated out of a bump pointer allocator,
  70   // we don't need to free them here.
  71
  72   // If the stream for the .secure_log_unique directive was created free it.
  73   delete (raw_ostream*)SecureLog;
  74 }
  75
  76 //===----------------------------------------------------------------------===//
  77 // Module Lifetime Management
  78 //===----------------------------------------------------------------------===//
  79
  80 void MCContext::reset() {
  81   UsedNames.clear();
  82   Symbols.clear();
  83   Allocator.Reset();
  84   Instances.clear();
  85   MCDwarfLineTablesCUMap.clear();
  86   MCGenDwarfLabelEntries.clear();
  87   DwarfDebugFlags = StringRef();
  88   DwarfCompileUnitID = 0;
  89   CurrentDwarfLoc = MCDwarfLoc(0,0,0,DWARF2_FLAG_IS_STMT,0,0);
  90
  91   // If we have the MachO uniquing map, free it.
  92   delete (MachOUniqueMapTy*)MachOUniquingMap;
  93   delete (ELFUniqueMapTy*)ELFUniquingMap;
  94   delete (COFFUniqueMapTy*)COFFUniquingMap;
  95   MachOUniquingMap = 0;
  96   ELFUniquingMap = 0;
  97   COFFUniquingMap = 0;
  98
  99   NextUniqueID = 0;
 100   AllowTemporaryLabels = true;
 101   DwarfLocSeen = false;
 102   GenDwarfForAssembly = false;
 103   GenDwarfFileNumber = 0;
 104 }
 105
 106 //===----------------------------------------------------------------------===//
 107 // Symbol Manipulation
 108 //===----------------------------------------------------------------------===//
 109
 110 MCSymbol *MCContext::GetOrCreateSymbol(StringRef Name) {
 111   assert(!Name.empty() && "Normal symbols cannot be unnamed!");
 112
 113   // Do the lookup and get the entire StringMapEntry.  We want access to the
 114   // key if we are creating the entry.
 115   StringMapEntry<MCSymbol*> &Entry = Symbols.GetOrCreateValue(Name);
 116   MCSymbol *Sym = Entry.getValue();
 117
 118   if (Sym)
 119     return Sym;
 120
 121   Sym = CreateSymbol(Name);
 122   Entry.setValue(Sym);
 123   return Sym;
 124 }
 125
 126 MCSymbol *MCContext::CreateSymbol(StringRef Name) {
 127   // Determine whether this is an assembler temporary or normal label, if used.
 128   bool isTemporary = false;
 129   if (AllowTemporaryLabels)
 130     isTemporary = Name.startswith(MAI->getPrivateGlobalPrefix());
 131
 132   StringMapEntry<bool> *NameEntry = &UsedNames.GetOrCreateValue(Name);
 133   if (NameEntry->getValue()) {
 134     assert(isTemporary && "Cannot rename non-temporary symbols");
 135     SmallString<128> NewName = Name;
 136     do {
 137       NewName.resize(Name.size());
 138       raw_svector_ostream(NewName) << NextUniqueID++;
 139       NameEntry = &UsedNames.GetOrCreateValue(NewName);
 140     } while (NameEntry->getValue());
 141   }
 142   NameEntry->setValue(true);
 143
 144   // Ok, the entry doesn't already exist.  Have the MCSymbol object itself refer
 145   // to the copy of the string that is embedded in the UsedNames entry.
 146   MCSymbol *Result = new (*this) MCSymbol(NameEntry->getKey(), isTemporary);
 147
 148   return Result;
 149 }
 150
 151 MCSymbol *MCContext::GetOrCreateSymbol(const Twine &Name) {
 152   SmallString<128> NameSV;
 153   return GetOrCreateSymbol(Name.toStringRef(NameSV));
 154 }
 155
 156 MCSymbol *MCContext::CreateTempSymbol() {
 157   SmallString<128> NameSV;
 158   raw_svector_ostream(NameSV)
 159     << MAI->getPrivateGlobalPrefix() << "tmp" << NextUniqueID++;
 160   return CreateSymbol(NameSV);
 161 }
 162
 163 unsigned MCContext::NextInstance(unsigned LocalLabelVal) {
 164   MCLabel *&Label = Instances[LocalLabelVal];
 165   if (!Label)
 166     Label = new (*this) MCLabel(0);
 167   return Label->incInstance();
 168 }
 169
 170 unsigned MCContext::GetInstance(unsigned LocalLabelVal) {
 171   MCLabel *&Label = Instances[LocalLabelVal];
 172   if (!Label)
 173     Label = new (*this) MCLabel(0);
 174   return Label->getInstance();
 175 }
 176
 177 MCSymbol *MCContext::getOrCreateDirectionalLocalSymbol(unsigned LocalLabelVal,
 178                                                        unsigned Instance) {
 179   MCSymbol *&Sym = LocalSymbols[std::make_pair(LocalLabelVal, Instance)];
 180   if (!Sym)
 181     Sym = CreateTempSymbol();
 182   return Sym;
 183 }
 184
 185 MCSymbol *MCContext::CreateDirectionalLocalSymbol(unsigned LocalLabelVal) {
 186   unsigned Instance = NextInstance(LocalLabelVal);
 187   return getOrCreateDirectionalLocalSymbol(LocalLabelVal, Instance);
 188 }
 189
 190 MCSymbol *MCContext::GetDirectionalLocalSymbol(unsigned LocalLabelVal,
 191                                                bool Before) {
 192   unsigned Instance = GetInstance(LocalLabelVal);
 193   if (!Before)
 194     ++Instance;
 195   return getOrCreateDirectionalLocalSymbol(LocalLabelVal, Instance);
 196 }
 197
 198 MCSymbol *MCContext::LookupSymbol(StringRef Name) const {
 199   return Symbols.lookup(Name);
 200 }
 201
 202 MCSymbol *MCContext::LookupSymbol(const Twine &Name) const {
 203   SmallString<128> NameSV;
 204   Name.toVector(NameSV);
 205   return LookupSymbol(NameSV.str());
 206 }
 207
 208 //===----------------------------------------------------------------------===//
 209 // Section Management
 210 //===----------------------------------------------------------------------===//
 211
 212 const MCSectionMachO *MCContext::
 213 getMachOSection(StringRef Segment, StringRef Section,
 214                 unsigned TypeAndAttributes,
 215                 unsigned Reserved2, SectionKind Kind) {
 216
 217   // We unique sections by their segment/section pair.  The returned section
 218   // may not have the same flags as the requested section, if so this should be
 219   // diagnosed by the client as an error.
 220
 221   // Create the map if it doesn't already exist.
 222   if (MachOUniquingMap == 0)
 223     MachOUniquingMap = new MachOUniqueMapTy();
 224   MachOUniqueMapTy &Map = *(MachOUniqueMapTy*)MachOUniquingMap;
 225
 226   // Form the name to look up.
 227   SmallString<64> Name;
 228   Name += Segment;
 229   Name.push_back(',');
 230   Name += Section;
 231
 232   // Do the lookup, if we have a hit, return it.
 233   const MCSectionMachO *&Entry = Map[Name.str()];
 234   if (Entry) return Entry;
 235
 236   // Otherwise, return a new section.
 237   return Entry = new (*this) MCSectionMachO(Segment, Section, TypeAndAttributes,
 238                                             Reserved2, Kind);
 239 }
 240
 241 const MCSectionELF *MCContext::
 242 getELFSection(StringRef Section, unsigned Type, unsigned Flags,
 243               SectionKind Kind) {
 244   return getELFSection(Section, Type, Flags, Kind, 0, "");
 245 }
 246
 247 const MCSectionELF *MCContext::
 248 getELFSection(StringRef Section, unsigned Type, unsigned Flags,
 249               SectionKind Kind, unsigned EntrySize, StringRef Group) {
 250   if (ELFUniquingMap == 0)
 251     ELFUniquingMap = new ELFUniqueMapTy();
 252   ELFUniqueMapTy &Map = *(ELFUniqueMapTy*)ELFUniquingMap;
 253
 254   SmallString<32> ZDebugName;
 255   if (MAI->compressDebugSections() && Section.startswith(".debug_") &&
 256       Section != ".debug_frame")
 257     Section = (".z" + Section.drop_front(1)).toStringRef(ZDebugName);
 258
 259   // Do the lookup, if we have a hit, return it.
 260   std::pair<ELFUniqueMapTy::iterator, bool> Entry = Map.insert(
 261       std::make_pair(SectionGroupPair(Section, Group), (MCSectionELF *)0));
 262   if (!Entry.second) return Entry.first->second;
 263
 264   // Possibly refine the entry size first.
 265   if (!EntrySize) {
 266     EntrySize = MCSectionELF::DetermineEntrySize(Kind);
 267   }
 268
 269   MCSymbol *GroupSym = NULL;
 270   if (!Group.empty())
 271     GroupSym = GetOrCreateSymbol(Group);
 272
 273   MCSectionELF *Result = new (*this) MCSectionELF(
 274       Entry.first->first.first, Type, Flags, Kind, EntrySize, GroupSym);
 275   Entry.first->second = Result;
 276   return Result;
 277 }
 278
 279 const MCSectionELF *MCContext::CreateELFGroupSection() {
 280   MCSectionELF *Result =
 281     new (*this) MCSectionELF(".group", ELF::SHT_GROUP, 0,
 282                              SectionKind::getReadOnly(), 4, NULL);
 283   return Result;
 284 }
 285
 286 const MCSectionCOFF *
 287 MCContext::getCOFFSection(StringRef Section, unsigned Characteristics,
 288                           SectionKind Kind, StringRef COMDATSymName,
 289                           int Selection, const MCSectionCOFF *Assoc) {
 290   if (COFFUniquingMap == 0)
 291     COFFUniquingMap = new COFFUniqueMapTy();
 292   COFFUniqueMapTy &Map = *(COFFUniqueMapTy*)COFFUniquingMap;
 293
 294   // Do the lookup, if we have a hit, return it.
 295
 296   SectionGroupPair P(Section, COMDATSymName);
 297   std::pair<COFFUniqueMapTy::iterator, bool> Entry =
 298       Map.insert(std::make_pair(P, (MCSectionCOFF *)0));
 299   COFFUniqueMapTy::iterator Iter = Entry.first;
 300   if (!Entry.second)
 301     return Iter->second;
 302
 303   const MCSymbol *COMDATSymbol = NULL;
 304   if (!COMDATSymName.empty())
 305     COMDATSymbol = GetOrCreateSymbol(COMDATSymName);
 306
 307   MCSectionCOFF *Result =
 308       new (*this) MCSectionCOFF(Iter->first.first, Characteristics,
 309                                 COMDATSymbol, Selection, Assoc, Kind);
 310
 311   Iter->second = Result;
 312   return Result;
 313 }
 314
 315 const MCSectionCOFF *
 316 MCContext::getCOFFSection(StringRef Section, unsigned Characteristics,
 317                           SectionKind Kind) {
 318   return getCOFFSection(Section, Characteristics, Kind, "", 0);
 319 }
 320
 321 const MCSectionCOFF *MCContext::getCOFFSection(StringRef Section) {
 322   if (COFFUniquingMap == 0)
 323     COFFUniquingMap = new COFFUniqueMapTy();
 324   COFFUniqueMapTy &Map = *(COFFUniqueMapTy*)COFFUniquingMap;
 325
 326   SectionGroupPair P(Section, "");
 327   COFFUniqueMapTy::iterator Iter = Map.find(P);
 328   if (Iter == Map.end())
 329     return 0;
 330   return Iter->second;
 331 }
 332
 333 //===----------------------------------------------------------------------===//
 334 // Dwarf Management
 335 //===----------------------------------------------------------------------===//
 336
 337 /// GetDwarfFile - takes a file name an number to place in the dwarf file and
 338 /// directory tables.  If the file number has already been allocated it is an
 339 /// error and zero is returned and the client reports the error, else the
 340 /// allocated file number is returned.  The file numbers may be in any order.
 341 unsigned MCContext::GetDwarfFile(StringRef Directory, StringRef FileName,
 342                                  unsigned FileNumber, unsigned CUID) {
 343   MCDwarfLineTable &Table = MCDwarfLineTablesCUMap[CUID];
 344   return Table.getFile(Directory, FileName, FileNumber);
 345 }
 346
 347 /// isValidDwarfFileNumber - takes a dwarf file number and returns true if it
 348 /// currently is assigned and false otherwise.
 349 bool MCContext::isValidDwarfFileNumber(unsigned FileNumber, unsigned CUID) {
 350   const SmallVectorImpl<MCDwarfFile>& MCDwarfFiles = getMCDwarfFiles(CUID);
 351   if(FileNumber == 0 || FileNumber >= MCDwarfFiles.size())
 352     return false;
 353
 354   return !MCDwarfFiles[FileNumber].Name.empty();
 355 }
 356
 357 void MCContext::FatalError(SMLoc Loc, const Twine &Msg) {
 358   // If we have a source manager and a location, use it. Otherwise just
 359   // use the generic report_fatal_error().
 360   if (!SrcMgr || Loc == SMLoc())
 361     report_fatal_error(Msg, false);
 362
 363   // Use the source manager to print the message.
 364   SrcMgr->PrintMessage(Loc, SourceMgr::DK_Error, Msg);
 365
 366   // If we reached here, we are failing ungracefully. Run the interrupt handlers
 367   // to make sure any special cleanups get done, in particular that we remove
 368   // files registered with RemoveFileOnSignal.
 369   sys::RunInterruptHandlers();
 370   exit(1);
 371 }