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/MC/MCAsmInfo.h"
  12 #include "llvm/MC/MCRegisterInfo.h"
  13 #include "llvm/MC/MCSectionMachO.h"
  14 #include "llvm/MC/MCSectionELF.h"
  15 #include "llvm/MC/MCSectionCOFF.h"
  16 #include "llvm/MC/MCSymbol.h"
  17 #include "llvm/MC/MCLabel.h"
  18 #include "llvm/MC/MCDwarf.h"
  19 #include "llvm/Target/TargetAsmInfo.h"
  20 #include "llvm/ADT/SmallString.h"
  21 #include "llvm/ADT/Twine.h"
  22 #include "llvm/Support/ELF.h"
  23 using namespace llvm;
  24
  25 typedef StringMap<const MCSectionMachO*> MachOUniqueMapTy;
  26 typedef StringMap<const MCSectionELF*> ELFUniqueMapTy;
  27 typedef StringMap<const MCSectionCOFF*> COFFUniqueMapTy;
  28
  29
  30 MCContext::MCContext(const MCAsmInfo &mai, const MCRegisterInfo &mri,
  31                      const TargetAsmInfo *tai) :
  32   MAI(mai), MRI(mri), TAI(tai),
  33   Allocator(), Symbols(Allocator), UsedNames(Allocator),
  34   NextUniqueID(0),
  35   CurrentDwarfLoc(0,0,0,DWARF2_FLAG_IS_STMT,0,0),
  36   AllowTemporaryLabels(true) {
  37   MachOUniquingMap = 0;
  38   ELFUniquingMap = 0;
  39   COFFUniquingMap = 0;
  40
  41   SecureLogFile = getenv("AS_SECURE_LOG_FILE");
  42   SecureLog = 0;
  43   SecureLogUsed = false;
  44
  45   DwarfLocSeen = false;
  46 }
  47
  48 MCContext::~MCContext() {
  49   // NOTE: The symbols are all allocated out of a bump pointer allocator,
  50   // we don't need to free them here.
  51
  52   // If we have the MachO uniquing map, free it.
  53   delete (MachOUniqueMapTy*)MachOUniquingMap;
  54   delete (ELFUniqueMapTy*)ELFUniquingMap;
  55   delete (COFFUniqueMapTy*)COFFUniquingMap;
  56
  57   // If the stream for the .secure_log_unique directive was created free it.
  58   delete (raw_ostream*)SecureLog;
  59
  60   delete TAI;
  61 }
  62
  63 //===----------------------------------------------------------------------===//
  64 // Symbol Manipulation
  65 //===----------------------------------------------------------------------===//
  66
  67 MCSymbol *MCContext::GetOrCreateSymbol(StringRef Name) {
  68   assert(!Name.empty() && "Normal symbols cannot be unnamed!");
  69
  70   // Do the lookup and get the entire StringMapEntry.  We want access to the
  71   // key if we are creating the entry.
  72   StringMapEntry<MCSymbol*> &Entry = Symbols.GetOrCreateValue(Name);
  73   MCSymbol *Sym = Entry.getValue();
  74
  75   if (Sym)
  76     return Sym;
  77
  78   Sym = CreateSymbol(Name);
  79   Entry.setValue(Sym);
  80   return Sym;
  81 }
  82
  83 MCSymbol *MCContext::CreateSymbol(StringRef Name) {
  84   // Determine whether this is an assembler temporary or normal label, if used.
  85   bool isTemporary = false;
  86   if (AllowTemporaryLabels)
  87     isTemporary = Name.startswith(MAI.getPrivateGlobalPrefix());
  88
  89   StringMapEntry<bool> *NameEntry = &UsedNames.GetOrCreateValue(Name);
  90   if (NameEntry->getValue()) {
  91     assert(isTemporary && "Cannot rename non temporary symbols");
  92     SmallString<128> NewName = Name;
  93     do {
  94       NewName.resize(Name.size());
  95       raw_svector_ostream(NewName) << NextUniqueID++;
  96       NameEntry = &UsedNames.GetOrCreateValue(NewName);
  97     } while (NameEntry->getValue());
  98   }
  99   NameEntry->setValue(true);
 100
 101   // Ok, the entry doesn't already exist.  Have the MCSymbol object itself refer
 102   // to the copy of the string that is embedded in the UsedNames entry.
 103   MCSymbol *Result = new (*this) MCSymbol(NameEntry->getKey(), isTemporary);
 104
 105   return Result;
 106 }
 107
 108 MCSymbol *MCContext::GetOrCreateSymbol(const Twine &Name) {
 109   SmallString<128> NameSV;
 110   Name.toVector(NameSV);
 111   return GetOrCreateSymbol(NameSV.str());
 112 }
 113
 114 MCSymbol *MCContext::CreateTempSymbol() {
 115   SmallString<128> NameSV;
 116   raw_svector_ostream(NameSV)
 117     << MAI.getPrivateGlobalPrefix() << "tmp" << NextUniqueID++;
 118   return CreateSymbol(NameSV);
 119 }
 120
 121 unsigned MCContext::NextInstance(int64_t LocalLabelVal) {
 122   MCLabel *&Label = Instances[LocalLabelVal];
 123   if (!Label)
 124     Label = new (*this) MCLabel(0);
 125   return Label->incInstance();
 126 }
 127
 128 unsigned MCContext::GetInstance(int64_t LocalLabelVal) {
 129   MCLabel *&Label = Instances[LocalLabelVal];
 130   if (!Label)
 131     Label = new (*this) MCLabel(0);
 132   return Label->getInstance();
 133 }
 134
 135 MCSymbol *MCContext::CreateDirectionalLocalSymbol(int64_t LocalLabelVal) {
 136   return GetOrCreateSymbol(Twine(MAI.getPrivateGlobalPrefix()) +
 137                            Twine(LocalLabelVal) +
 138                            "\2" +
 139                            Twine(NextInstance(LocalLabelVal)));
 140 }
 141 MCSymbol *MCContext::GetDirectionalLocalSymbol(int64_t LocalLabelVal,
 142                                                int bORf) {
 143   return GetOrCreateSymbol(Twine(MAI.getPrivateGlobalPrefix()) +
 144                            Twine(LocalLabelVal) +
 145                            "\2" +
 146                            Twine(GetInstance(LocalLabelVal) + bORf));
 147 }
 148
 149 MCSymbol *MCContext::LookupSymbol(StringRef Name) const {
 150   return Symbols.lookup(Name);
 151 }
 152
 153 //===----------------------------------------------------------------------===//
 154 // Section Management
 155 //===----------------------------------------------------------------------===//
 156
 157 const MCSectionMachO *MCContext::
 158 getMachOSection(StringRef Segment, StringRef Section,
 159                 unsigned TypeAndAttributes,
 160                 unsigned Reserved2, SectionKind Kind) {
 161
 162   // We unique sections by their segment/section pair.  The returned section
 163   // may not have the same flags as the requested section, if so this should be
 164   // diagnosed by the client as an error.
 165
 166   // Create the map if it doesn't already exist.
 167   if (MachOUniquingMap == 0)
 168     MachOUniquingMap = new MachOUniqueMapTy();
 169   MachOUniqueMapTy &Map = *(MachOUniqueMapTy*)MachOUniquingMap;
 170
 171   // Form the name to look up.
 172   SmallString<64> Name;
 173   Name += Segment;
 174   Name.push_back(',');
 175   Name += Section;
 176
 177   // Do the lookup, if we have a hit, return it.
 178   const MCSectionMachO *&Entry = Map[Name.str()];
 179   if (Entry) return Entry;
 180
 181   // Otherwise, return a new section.
 182   return Entry = new (*this) MCSectionMachO(Segment, Section, TypeAndAttributes,
 183                                             Reserved2, Kind);
 184 }
 185
 186 const MCSectionELF *MCContext::
 187 getELFSection(StringRef Section, unsigned Type, unsigned Flags,
 188               SectionKind Kind) {
 189   return getELFSection(Section, Type, Flags, Kind, 0, "");
 190 }
 191
 192 const MCSectionELF *MCContext::
 193 getELFSection(StringRef Section, unsigned Type, unsigned Flags,
 194               SectionKind Kind, unsigned EntrySize, StringRef Group) {
 195   if (ELFUniquingMap == 0)
 196     ELFUniquingMap = new ELFUniqueMapTy();
 197   ELFUniqueMapTy &Map = *(ELFUniqueMapTy*)ELFUniquingMap;
 198
 199   // Do the lookup, if we have a hit, return it.
 200   StringMapEntry<const MCSectionELF*> &Entry = Map.GetOrCreateValue(Section);
 201   if (Entry.getValue()) return Entry.getValue();
 202
 203   // Possibly refine the entry size first.
 204   if (!EntrySize) {
 205     EntrySize = MCSectionELF::DetermineEntrySize(Kind);
 206   }
 207
 208   MCSymbol *GroupSym = NULL;
 209   if (!Group.empty())
 210     GroupSym = GetOrCreateSymbol(Group);
 211
 212   MCSectionELF *Result = new (*this) MCSectionELF(Entry.getKey(), Type, Flags,
 213                                                   Kind, EntrySize, GroupSym);
 214   Entry.setValue(Result);
 215   return Result;
 216 }
 217
 218 const MCSectionELF *MCContext::CreateELFGroupSection() {
 219   MCSectionELF *Result =
 220     new (*this) MCSectionELF(".group", ELF::SHT_GROUP, 0,
 221                              SectionKind::getReadOnly(), 4, NULL);
 222   return Result;
 223 }
 224
 225 const MCSection *MCContext::getCOFFSection(StringRef Section,
 226                                            unsigned Characteristics,
 227                                            int Selection,
 228                                            SectionKind Kind) {
 229   if (COFFUniquingMap == 0)
 230     COFFUniquingMap = new COFFUniqueMapTy();
 231   COFFUniqueMapTy &Map = *(COFFUniqueMapTy*)COFFUniquingMap;
 232
 233   // Do the lookup, if we have a hit, return it.
 234   StringMapEntry<const MCSectionCOFF*> &Entry = Map.GetOrCreateValue(Section);
 235   if (Entry.getValue()) return Entry.getValue();
 236
 237   MCSectionCOFF *Result = new (*this) MCSectionCOFF(Entry.getKey(),
 238                                                     Characteristics,
 239                                                     Selection, Kind);
 240
 241   Entry.setValue(Result);
 242   return Result;
 243 }
 244
 245 //===----------------------------------------------------------------------===//
 246 // Dwarf Management
 247 //===----------------------------------------------------------------------===//
 248
 249 /// GetDwarfFile - takes a file name an number to place in the dwarf file and
 250 /// directory tables.  If the file number has already been allocated it is an
 251 /// error and zero is returned and the client reports the error, else the
 252 /// allocated file number is returned.  The file numbers may be in any order.
 253 unsigned MCContext::GetDwarfFile(StringRef FileName, unsigned FileNumber) {
 254   // TODO: a FileNumber of zero says to use the next available file number.
 255   // Note: in GenericAsmParser::ParseDirectiveFile() FileNumber was checked
 256   // to not be less than one.  This needs to be change to be not less than zero.
 257
 258   // Make space for this FileNumber in the MCDwarfFiles vector if needed.
 259   if (FileNumber >= MCDwarfFiles.size()) {
 260     MCDwarfFiles.resize(FileNumber + 1);
 261   } else {
 262     MCDwarfFile *&ExistingFile = MCDwarfFiles[FileNumber];
 263     if (ExistingFile)
 264       // It is an error to use see the same number more than once.
 265       return 0;
 266   }
 267
 268   // Get the new MCDwarfFile slot for this FileNumber.
 269   MCDwarfFile *&File = MCDwarfFiles[FileNumber];
 270
 271   // Separate the directory part from the basename of the FileName.
 272   std::pair<StringRef, StringRef> Slash = FileName.rsplit('/');
 273
 274   // Find or make a entry in the MCDwarfDirs vector for this Directory.
 275   StringRef Name;
 276   unsigned DirIndex;
 277   // Capture directory name.
 278   if (Slash.second.empty()) {
 279     Name = Slash.first;
 280     DirIndex = 0; // For FileNames with no directories a DirIndex of 0 is used.
 281   } else {
 282     StringRef Directory = Slash.first;
 283     Name = Slash.second;
 284     for (DirIndex = 0; DirIndex < MCDwarfDirs.size(); DirIndex++) {
 285       if (Directory == MCDwarfDirs[DirIndex])
 286         break;
 287     }
 288     if (DirIndex >= MCDwarfDirs.size()) {
 289       char *Buf = static_cast<char *>(Allocate(Directory.size()));
 290       memcpy(Buf, Directory.data(), Directory.size());
 291       MCDwarfDirs.push_back(StringRef(Buf, Directory.size()));
 292     }
 293     // The DirIndex is one based, as DirIndex of 0 is used for FileNames with
 294     // no directories.  MCDwarfDirs[] is unlike MCDwarfFiles[] in that the
 295     // directory names are stored at MCDwarfDirs[DirIndex-1] where FileNames are
 296     // stored at MCDwarfFiles[FileNumber].Name .
 297     DirIndex++;
 298   }
 299
 300   // Now make the MCDwarfFile entry and place it in the slot in the MCDwarfFiles
 301   // vector.
 302   char *Buf = static_cast<char *>(Allocate(Name.size()));
 303   memcpy(Buf, Name.data(), Name.size());
 304   File = new (*this) MCDwarfFile(StringRef(Buf, Name.size()), DirIndex);
 305
 306   // return the allocated FileNumber.
 307   return FileNumber;
 308 }
 309
 310 /// isValidDwarfFileNumber - takes a dwarf file number and returns true if it
 311 /// currently is assigned and false otherwise.
 312 bool MCContext::isValidDwarfFileNumber(unsigned FileNumber) {
 313   if(FileNumber == 0 || FileNumber >= MCDwarfFiles.size())
 314     return false;
 315
 316   return MCDwarfFiles[FileNumber] != 0;
 317 }