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