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),
  42   Allocator(), Symbols(Allocator), UsedNames(Allocator),
  43   NextUniqueID(0),
  44   CurrentDwarfLoc(0,0,0,DWARF2_FLAG_IS_STMT,0,0),
  45   DwarfLocSeen(false), GenDwarfForAssembly(false), GenDwarfFileNumber(0),
  46   AllowTemporaryLabels(true), DwarfCompileUnitID(0), 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   else
  63     MainFileName = "";
  64 }
  65
  66 MCContext::~MCContext() {
  67
  68   if (AutoReset)
  69     reset();
  70
  71   // NOTE: The symbols are all allocated out of a bump pointer allocator,
  72   // we don't need to free them here.
  73
  74   // If the stream for the .secure_log_unique directive was created free it.
  75   delete (raw_ostream*)SecureLog;
  76 }
  77
  78 //===----------------------------------------------------------------------===//
  79 // Module Lifetime Management
  80 //===----------------------------------------------------------------------===//
  81
  82 void MCContext::reset() {
  83   UsedNames.clear();
  84   Symbols.clear();
  85   Allocator.Reset();
  86   Instances.clear();
  87   MCDwarfFileTablesCUMap.clear();
  88   MCGenDwarfLabelEntries.clear();
  89   DwarfDebugFlags = StringRef();
  90   DwarfCompileUnitID = 0;
  91   CurrentDwarfLoc = MCDwarfLoc(0,0,0,DWARF2_FLAG_IS_STMT,0,0);
  92
  93   // If we have the MachO uniquing map, free it.
  94   delete (MachOUniqueMapTy*)MachOUniquingMap;
  95   delete (ELFUniqueMapTy*)ELFUniquingMap;
  96   delete (COFFUniqueMapTy*)COFFUniquingMap;
  97   MachOUniquingMap = 0;
  98   ELFUniquingMap = 0;
  99   COFFUniquingMap = 0;
 100
 101   NextUniqueID = 0;
 102   AllowTemporaryLabels = true;
 103   DwarfLocSeen = false;
 104   GenDwarfForAssembly = false;
 105   GenDwarfFileNumber = 0;
 106 }
 107
 108 //===----------------------------------------------------------------------===//
 109 // Symbol Manipulation
 110 //===----------------------------------------------------------------------===//
 111
 112 MCSymbol *MCContext::GetOrCreateSymbol(StringRef Name) {
 113   assert(!Name.empty() && "Normal symbols cannot be unnamed!");
 114
 115   // Do the lookup and get the entire StringMapEntry.  We want access to the
 116   // key if we are creating the entry.
 117   StringMapEntry<MCSymbol*> &Entry = Symbols.GetOrCreateValue(Name);
 118   MCSymbol *Sym = Entry.getValue();
 119
 120   if (Sym)
 121     return Sym;
 122
 123   Sym = CreateSymbol(Name);
 124   Entry.setValue(Sym);
 125   return Sym;
 126 }
 127
 128 MCSymbol *MCContext::CreateSymbol(StringRef Name) {
 129   // Determine whether this is an assembler temporary or normal label, if used.
 130   bool isTemporary = false;
 131   if (AllowTemporaryLabels)
 132     isTemporary = Name.startswith(MAI->getPrivateGlobalPrefix());
 133
 134   StringMapEntry<bool> *NameEntry = &UsedNames.GetOrCreateValue(Name);
 135   if (NameEntry->getValue()) {
 136     assert(isTemporary && "Cannot rename non-temporary symbols");
 137     SmallString<128> NewName = Name;
 138     do {
 139       NewName.resize(Name.size());
 140       raw_svector_ostream(NewName) << NextUniqueID++;
 141       NameEntry = &UsedNames.GetOrCreateValue(NewName);
 142     } while (NameEntry->getValue());
 143   }
 144   NameEntry->setValue(true);
 145
 146   // Ok, the entry doesn't already exist.  Have the MCSymbol object itself refer
 147   // to the copy of the string that is embedded in the UsedNames entry.
 148   MCSymbol *Result = new (*this) MCSymbol(NameEntry->getKey(), isTemporary);
 149
 150   return Result;
 151 }
 152
 153 MCSymbol *MCContext::GetOrCreateSymbol(const Twine &Name) {
 154   SmallString<128> NameSV;
 155   return GetOrCreateSymbol(Name.toStringRef(NameSV));
 156 }
 157
 158 MCSymbol *MCContext::CreateTempSymbol() {
 159   SmallString<128> NameSV;
 160   raw_svector_ostream(NameSV)
 161     << MAI->getPrivateGlobalPrefix() << "tmp" << NextUniqueID++;
 162   return CreateSymbol(NameSV);
 163 }
 164
 165 unsigned MCContext::NextInstance(unsigned LocalLabelVal) {
 166   MCLabel *&Label = Instances[LocalLabelVal];
 167   if (!Label)
 168     Label = new (*this) MCLabel(0);
 169   return Label->incInstance();
 170 }
 171
 172 unsigned MCContext::GetInstance(unsigned LocalLabelVal) {
 173   MCLabel *&Label = Instances[LocalLabelVal];
 174   if (!Label)
 175     Label = new (*this) MCLabel(0);
 176   return Label->getInstance();
 177 }
 178
 179 MCSymbol *MCContext::getOrCreateDirectionalLocalSymbol(unsigned LocalLabelVal,
 180                                                        unsigned Instance) {
 181   MCSymbol *&Sym = LocalSymbols[std::make_pair(LocalLabelVal, Instance)];
 182   if (!Sym)
 183     Sym = CreateTempSymbol();
 184   return Sym;
 185 }
 186
 187 MCSymbol *MCContext::CreateDirectionalLocalSymbol(unsigned LocalLabelVal) {
 188   unsigned Instance = NextInstance(LocalLabelVal);
 189   return getOrCreateDirectionalLocalSymbol(LocalLabelVal, Instance);
 190 }
 191
 192 MCSymbol *MCContext::GetDirectionalLocalSymbol(unsigned LocalLabelVal,
 193                                                bool Before) {
 194   unsigned Instance = GetInstance(LocalLabelVal);
 195   if (!Before)
 196     ++Instance;
 197   return getOrCreateDirectionalLocalSymbol(LocalLabelVal, Instance);
 198 }
 199
 200 MCSymbol *MCContext::LookupSymbol(StringRef Name) const {
 201   return Symbols.lookup(Name);
 202 }
 203
 204 MCSymbol *MCContext::LookupSymbol(const Twine &Name) const {
 205   SmallString<128> NameSV;
 206   Name.toVector(NameSV);
 207   return LookupSymbol(NameSV.str());
 208 }
 209
 210 //===----------------------------------------------------------------------===//
 211 // Section Management
 212 //===----------------------------------------------------------------------===//
 213
 214 const MCSectionMachO *MCContext::
 215 getMachOSection(StringRef Segment, StringRef Section,
 216                 unsigned TypeAndAttributes,
 217                 unsigned Reserved2, SectionKind Kind) {
 218
 219   // We unique sections by their segment/section pair.  The returned section
 220   // may not have the same flags as the requested section, if so this should be
 221   // diagnosed by the client as an error.
 222
 223   // Create the map if it doesn't already exist.
 224   if (MachOUniquingMap == 0)
 225     MachOUniquingMap = new MachOUniqueMapTy();
 226   MachOUniqueMapTy &Map = *(MachOUniqueMapTy*)MachOUniquingMap;
 227
 228   // Form the name to look up.
 229   SmallString<64> Name;
 230   Name += Segment;
 231   Name.push_back(',');
 232   Name += Section;
 233
 234   // Do the lookup, if we have a hit, return it.
 235   const MCSectionMachO *&Entry = Map[Name.str()];
 236   if (Entry) return Entry;
 237
 238   // Otherwise, return a new section.
 239   return Entry = new (*this) MCSectionMachO(Segment, Section, TypeAndAttributes,
 240                                             Reserved2, Kind);
 241 }
 242
 243 const MCSectionELF *MCContext::
 244 getELFSection(StringRef Section, unsigned Type, unsigned Flags,
 245               SectionKind Kind) {
 246   return getELFSection(Section, Type, Flags, Kind, 0, "");
 247 }
 248
 249 const MCSectionELF *MCContext::
 250 getELFSection(StringRef Section, unsigned Type, unsigned Flags,
 251               SectionKind Kind, unsigned EntrySize, StringRef Group) {
 252   if (ELFUniquingMap == 0)
 253     ELFUniquingMap = new ELFUniqueMapTy();
 254   ELFUniqueMapTy &Map = *(ELFUniqueMapTy*)ELFUniquingMap;
 255
 256   // Do the lookup, if we have a hit, return it.
 257   std::pair<ELFUniqueMapTy::iterator, bool> Entry = Map.insert(
 258       std::make_pair(SectionGroupPair(Section, Group), (MCSectionELF *)0));
 259   if (!Entry.second) return Entry.first->second;
 260
 261   // Possibly refine the entry size first.
 262   if (!EntrySize) {
 263     EntrySize = MCSectionELF::DetermineEntrySize(Kind);
 264   }
 265
 266   MCSymbol *GroupSym = NULL;
 267   if (!Group.empty())
 268     GroupSym = GetOrCreateSymbol(Group);
 269
 270   MCSectionELF *Result = new (*this) MCSectionELF(
 271       Entry.first->first.first, Type, Flags, Kind, EntrySize, GroupSym);
 272   Entry.first->second = Result;
 273   return Result;
 274 }
 275
 276 const MCSectionELF *MCContext::CreateELFGroupSection() {
 277   MCSectionELF *Result =
 278     new (*this) MCSectionELF(".group", ELF::SHT_GROUP, 0,
 279                              SectionKind::getReadOnly(), 4, NULL);
 280   return Result;
 281 }
 282
 283 const MCSectionCOFF *
 284 MCContext::getCOFFSection(StringRef Section, unsigned Characteristics,
 285                           SectionKind Kind, StringRef COMDATSymName,
 286                           int Selection, const MCSectionCOFF *Assoc) {
 287   if (COFFUniquingMap == 0)
 288     COFFUniquingMap = new COFFUniqueMapTy();
 289   COFFUniqueMapTy &Map = *(COFFUniqueMapTy*)COFFUniquingMap;
 290
 291   // Do the lookup, if we have a hit, return it.
 292
 293   SectionGroupPair P(Section, COMDATSymName);
 294   std::pair<COFFUniqueMapTy::iterator, bool> Entry =
 295       Map.insert(std::make_pair(P, (MCSectionCOFF *)0));
 296   COFFUniqueMapTy::iterator Iter = Entry.first;
 297   if (!Entry.second)
 298     return Iter->second;
 299
 300   const MCSymbol *COMDATSymbol = NULL;
 301   if (!COMDATSymName.empty())
 302     COMDATSymbol = GetOrCreateSymbol(COMDATSymName);
 303
 304   MCSectionCOFF *Result =
 305       new (*this) MCSectionCOFF(Iter->first.first, Characteristics,
 306                                 COMDATSymbol, Selection, Assoc, Kind);
 307
 308   Iter->second = Result;
 309   return Result;
 310 }
 311
 312 const MCSectionCOFF *
 313 MCContext::getCOFFSection(StringRef Section, unsigned Characteristics,
 314                           SectionKind Kind) {
 315   return getCOFFSection(Section, Characteristics, Kind, "", 0);
 316 }
 317
 318 const MCSectionCOFF *MCContext::getCOFFSection(StringRef Section) {
 319   if (COFFUniquingMap == 0)
 320     COFFUniquingMap = new COFFUniqueMapTy();
 321   COFFUniqueMapTy &Map = *(COFFUniqueMapTy*)COFFUniquingMap;
 322
 323   SectionGroupPair P(Section, "");
 324   COFFUniqueMapTy::iterator Iter = Map.find(P);
 325   if (Iter == Map.end())
 326     return 0;
 327   return Iter->second;
 328 }
 329
 330 //===----------------------------------------------------------------------===//
 331 // Dwarf Management
 332 //===----------------------------------------------------------------------===//
 333
 334 /// GetDwarfFile - takes a file name an number to place in the dwarf file and
 335 /// directory tables.  If the file number has already been allocated it is an
 336 /// error and zero is returned and the client reports the error, else the
 337 /// allocated file number is returned.  The file numbers may be in any order.
 338 unsigned MCContext::GetDwarfFile(StringRef Directory, StringRef FileName,
 339                                  unsigned FileNumber, unsigned CUID) {
 340   MCDwarfFileTable &Table = MCDwarfFileTablesCUMap[CUID];
 341   SmallVectorImpl<MCDwarfFile *>& MCDwarfFiles = Table.getMCDwarfFiles();
 342   SmallVectorImpl<StringRef>& MCDwarfDirs = Table.getMCDwarfDirs();
 343   // Make space for this FileNumber in the MCDwarfFiles vector if needed.
 344   if (FileNumber >= MCDwarfFiles.size()) {
 345     MCDwarfFiles.resize(FileNumber + 1);
 346   } else {
 347     MCDwarfFile *&ExistingFile = MCDwarfFiles[FileNumber];
 348     if (ExistingFile)
 349       // It is an error to use see the same number more than once.
 350       return 0;
 351   }
 352
 353   // Get the new MCDwarfFile slot for this FileNumber.
 354   MCDwarfFile *&File = MCDwarfFiles[FileNumber];
 355
 356   if (Directory.empty()) {
 357     // Separate the directory part from the basename of the FileName.
 358     StringRef tFileName = sys::path::filename(FileName);
 359     if (!tFileName.empty()) {
 360       Directory = sys::path::parent_path(FileName);
 361       if (!Directory.empty())
 362         FileName = tFileName;
 363     }
 364   }
 365
 366   // Find or make an entry in the MCDwarfDirs vector for this Directory.
 367   // Capture directory name.
 368   unsigned DirIndex;
 369   if (Directory.empty()) {
 370     // For FileNames with no directories a DirIndex of 0 is used.
 371     DirIndex = 0;
 372   } else {
 373     DirIndex = 0;
 374     for (unsigned End = MCDwarfDirs.size(); DirIndex < End; DirIndex++) {
 375       if (Directory == MCDwarfDirs[DirIndex])
 376         break;
 377     }
 378     if (DirIndex >= MCDwarfDirs.size()) {
 379       char *Buf = static_cast<char *>(Allocate(Directory.size()));
 380       memcpy(Buf, Directory.data(), Directory.size());
 381       MCDwarfDirs.push_back(StringRef(Buf, Directory.size()));
 382     }
 383     // The DirIndex is one based, as DirIndex of 0 is used for FileNames with
 384     // no directories.  MCDwarfDirs[] is unlike MCDwarfFiles[] in that the
 385     // directory names are stored at MCDwarfDirs[DirIndex-1] where FileNames
 386     // are stored at MCDwarfFiles[FileNumber].Name .
 387     DirIndex++;
 388   }
 389
 390   // Now make the MCDwarfFile entry and place it in the slot in the MCDwarfFiles
 391   // vector.
 392   char *Buf = static_cast<char *>(Allocate(FileName.size()));
 393   memcpy(Buf, FileName.data(), FileName.size());
 394   File = new (*this) MCDwarfFile;
 395   File->Name = StringRef(Buf, FileName.size());
 396   File->DirIndex = DirIndex;
 397
 398   // return the allocated FileNumber.
 399   return FileNumber;
 400 }
 401
 402 /// isValidDwarfFileNumber - takes a dwarf file number and returns true if it
 403 /// currently is assigned and false otherwise.
 404 bool MCContext::isValidDwarfFileNumber(unsigned FileNumber, unsigned CUID) {
 405   const SmallVectorImpl<MCDwarfFile *>& MCDwarfFiles = getMCDwarfFiles(CUID);
 406   if(FileNumber == 0 || FileNumber >= MCDwarfFiles.size())
 407     return false;
 408
 409   return MCDwarfFiles[FileNumber] != 0;
 410 }
 411
 412 void MCContext::FatalError(SMLoc Loc, const Twine &Msg) {
 413   // If we have a source manager and a location, use it. Otherwise just
 414   // use the generic report_fatal_error().
 415   if (!SrcMgr || Loc == SMLoc())
 416     report_fatal_error(Msg);
 417
 418   // Use the source manager to print the message.
 419   SrcMgr->PrintMessage(Loc, SourceMgr::DK_Error, Msg);
 420
 421   // If we reached here, we are failing ungracefully. Run the interrupt handlers
 422   // to make sure any special cleanups get done, in particular that we remove
 423   // files registered with RemoveFileOnSignal.
 424   sys::RunInterruptHandlers();
 425   exit(1);
 426 }