lib/Target/TargetAsmInfo.cpp

   1 //===-- TargetAsmInfo.cpp - Asm Info ---------------------------------------==//
   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 // This file defines target asm properties related what form asm statements
  11 // should take.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "llvm/Constants.h"
  16 #include "llvm/GlobalVariable.h"
  17 #include "llvm/Function.h"
  18 #include "llvm/Module.h"
  19 #include "llvm/Type.h"
  20 #include "llvm/Target/TargetAsmInfo.h"
  21 #include "llvm/Target/TargetOptions.h"
  22 #include "llvm/Support/Dwarf.h"
  23 #include <cctype>
  24 #include <cstring>
  25
  26 using namespace llvm;
  27
  28 void TargetAsmInfo::fillDefaultValues() {
  29   BSSSection = "\t.bss";
  30   BSSSection_ = 0;
  31   ReadOnlySection = 0;
  32   SmallDataSection = 0;
  33   SmallBSSSection = 0;
  34   SmallRODataSection = 0;
  35   TLSDataSection = 0;
  36   TLSBSSSection = 0;
  37   ZeroFillDirective = 0;
  38   NonexecutableStackDirective = 0;
  39   NeedsSet = false;
  40   MaxInstLength = 4;
  41   PCSymbol = "$";
  42   SeparatorChar = ';';
  43   CommentString = "#";
  44   GlobalPrefix = "";
  45   PrivateGlobalPrefix = ".";
  46   LessPrivateGlobalPrefix = "";
  47   JumpTableSpecialLabelPrefix = 0;
  48   GlobalVarAddrPrefix = "";
  49   GlobalVarAddrSuffix = "";
  50   FunctionAddrPrefix = "";
  51   FunctionAddrSuffix = "";
  52   PersonalityPrefix = "";
  53   PersonalitySuffix = "";
  54   NeedsIndirectEncoding = false;
  55   InlineAsmStart = "#APP";
  56   InlineAsmEnd = "#NO_APP";
  57   AssemblerDialect = 0;
  58   StringConstantPrefix = ".str";
  59   ZeroDirective = "\t.zero\t";
  60   ZeroDirectiveSuffix = 0;
  61   AsciiDirective = "\t.ascii\t";
  62   AscizDirective = "\t.asciz\t";
  63   Data8bitsDirective = "\t.byte\t";
  64   Data16bitsDirective = "\t.short\t";
  65   Data32bitsDirective = "\t.long\t";
  66   Data64bitsDirective = "\t.quad\t";
  67   AlignDirective = "\t.align\t";
  68   AlignmentIsInBytes = true;
  69   TextAlignFillValue = 0;
  70   SwitchToSectionDirective = "\t.section\t";
  71   TextSectionStartSuffix = "";
  72   DataSectionStartSuffix = "";
  73   SectionEndDirectiveSuffix = 0;
  74   ConstantPoolSection = "\t.section .rodata";
  75   JumpTableDataSection = "\t.section .rodata";
  76   JumpTableDirective = 0;
  77   CStringSection = 0;
  78   CStringSection_ = 0;
  79   // FIXME: Flags are ELFish - replace with normal section stuff.
  80   StaticCtorsSection = "\t.section .ctors,\"aw\",@progbits";
  81   StaticDtorsSection = "\t.section .dtors,\"aw\",@progbits";
  82   GlobalDirective = "\t.globl\t";
  83   SetDirective = 0;
  84   LCOMMDirective = 0;
  85   COMMDirective = "\t.comm\t";
  86   COMMDirectiveTakesAlignment = true;
  87   HasDotTypeDotSizeDirective = true;
  88   UsedDirective = 0;
  89   WeakRefDirective = 0;
  90   WeakDefDirective = 0;
  91   // FIXME: These are ELFish - move to ELFTAI.
  92   HiddenDirective = "\t.hidden\t";
  93   ProtectedDirective = "\t.protected\t";
  94   AbsoluteDebugSectionOffsets = false;
  95   AbsoluteEHSectionOffsets = false;
  96   HasLEB128 = false;
  97   HasDotLocAndDotFile = false;
  98   SupportsDebugInformation = false;
  99   SupportsExceptionHandling = false;
 100   DwarfRequiresFrameSection = true;
 101   GlobalEHDirective = 0;
 102   SupportsWeakOmittedEHFrame = true;
 103   DwarfSectionOffsetDirective = 0;
 104   DwarfAbbrevSection = ".debug_abbrev";
 105   DwarfInfoSection = ".debug_info";
 106   DwarfLineSection = ".debug_line";
 107   DwarfFrameSection = ".debug_frame";
 108   DwarfPubNamesSection = ".debug_pubnames";
 109   DwarfPubTypesSection = ".debug_pubtypes";
 110   DwarfStrSection = ".debug_str";
 111   DwarfLocSection = ".debug_loc";
 112   DwarfARangesSection = ".debug_aranges";
 113   DwarfRangesSection = ".debug_ranges";
 114   DwarfMacInfoSection = ".debug_macinfo";
 115   DwarfEHFrameSection = ".eh_frame";
 116   DwarfExceptionSection = ".gcc_except_table";
 117   AsmTransCBE = 0;
 118   TextSection = getUnnamedSection("\t.text", SectionFlags::Code);
 119   DataSection = getUnnamedSection("\t.data", SectionFlags::Writeable);
 120 }
 121
 122 TargetAsmInfo::TargetAsmInfo() {
 123   fillDefaultValues();
 124 }
 125
 126 TargetAsmInfo::TargetAsmInfo(const TargetMachine &TM) {
 127   fillDefaultValues();
 128 }
 129
 130 TargetAsmInfo::~TargetAsmInfo() {
 131 }
 132
 133 /// Measure the specified inline asm to determine an approximation of its
 134 /// length.
 135 /// Comments (which run till the next SeparatorChar or newline) do not
 136 /// count as an instruction.
 137 /// Any other non-whitespace text is considered an instruction, with
 138 /// multiple instructions separated by SeparatorChar or newlines.
 139 /// Variable-length instructions are not handled here; this function
 140 /// may be overloaded in the target code to do that.
 141 unsigned TargetAsmInfo::getInlineAsmLength(const char *Str) const {
 142   // Count the number of instructions in the asm.
 143   bool atInsnStart = true;
 144   unsigned Length = 0;
 145   for (; *Str; ++Str) {
 146     if (*Str == '\n' || *Str == SeparatorChar)
 147       atInsnStart = true;
 148     if (atInsnStart && !isspace(*Str)) {
 149       Length += MaxInstLength;
 150       atInsnStart = false;
 151     }
 152     if (atInsnStart && strncmp(Str, CommentString, strlen(CommentString))==0)
 153       atInsnStart = false;
 154   }
 155
 156   return Length;
 157 }
 158
 159 unsigned TargetAsmInfo::PreferredEHDataFormat(DwarfEncoding::Target Reason,
 160                                               bool Global) const {
 161   return dwarf::DW_EH_PE_absptr;
 162 }
 163
 164 static bool isSuitableForBSS(const GlobalVariable *GV) {
 165   if (!GV->hasInitializer())
 166     return true;
 167
 168   // Leave constant zeros in readonly constant sections, so they can be shared
 169   Constant *C = GV->getInitializer();
 170   return (C->isNullValue() && !GV->isConstant() && !NoZerosInBSS);
 171 }
 172
 173 SectionKind::Kind
 174 TargetAsmInfo::SectionKindForGlobal(const GlobalValue *GV) const {
 175   // Early exit - functions should be always in text sections.
 176   if (isa<Function>(GV))
 177     return SectionKind::Text;
 178
 179   const GlobalVariable* GVar = dyn_cast<GlobalVariable>(GV);
 180   bool isThreadLocal = GVar->isThreadLocal();
 181   assert(GVar && "Invalid global value for section selection");
 182
 183   if (isSuitableForBSS(GVar)) {
 184     // Variable can be easily put to BSS section.
 185     return (isThreadLocal ? SectionKind::ThreadBSS : SectionKind::BSS);
 186   } else if (GVar->isConstant() && !isThreadLocal) {
 187     // Now we know, that varible has initializer and it is constant. We need to
 188     // check its initializer to decide, which section to output it into. Also
 189     // note, there is no thread-local r/o section.
 190     Constant *C = GVar->getInitializer();
 191     if (C->ContainsRelocations())
 192       return SectionKind::ROData;
 193     else {
 194       const ConstantArray *CVA = dyn_cast<ConstantArray>(C);
 195       // Check, if initializer is a null-terminated string
 196       if (CVA && CVA->isCString())
 197         return SectionKind::RODataMergeStr;
 198       else
 199         return SectionKind::RODataMergeConst;
 200     }
 201   }
 202
 203   // Variable is not constant or thread-local - emit to generic data section.
 204   return (isThreadLocal ? SectionKind::ThreadData : SectionKind::Data);
 205 }
 206
 207 unsigned
 208 TargetAsmInfo::SectionFlagsForGlobal(const GlobalValue *GV,
 209                                      const char* Name) const {
 210   unsigned Flags = SectionFlags::None;
 211
 212   // Decode flags from global itself.
 213   if (GV) {
 214     SectionKind::Kind Kind = SectionKindForGlobal(GV);
 215     switch (Kind) {
 216      case SectionKind::Text:
 217       Flags |= SectionFlags::Code;
 218       break;
 219      case SectionKind::ThreadData:
 220      case SectionKind::ThreadBSS:
 221       Flags |= SectionFlags::TLS;
 222       // FALLS THROUGH
 223      case SectionKind::Data:
 224      case SectionKind::BSS:
 225       Flags |= SectionFlags::Writeable;
 226       break;
 227      case SectionKind::ROData:
 228      case SectionKind::RODataMergeStr:
 229      case SectionKind::RODataMergeConst:
 230       // No additional flags here
 231       break;
 232      case SectionKind::SmallData:
 233      case SectionKind::SmallBSS:
 234       Flags |= SectionFlags::Writeable;
 235       // FALLS THROUGH
 236      case SectionKind::SmallROData:
 237       Flags |= SectionFlags::Small;
 238       break;
 239      default:
 240       assert(0 && "Unexpected section kind!");
 241     }
 242
 243     if (GV->mayBeOverridden())
 244       Flags |= SectionFlags::Linkonce;
 245   }
 246
 247   // Add flags from sections, if any.
 248   if (Name && *Name) {
 249     Flags |= SectionFlags::Named;
 250
 251     // Some lame default implementation based on some magic section names.
 252     if (strncmp(Name, ".gnu.linkonce.b.", 16) == 0 ||
 253         strncmp(Name, ".llvm.linkonce.b.", 17) == 0 ||
 254         strncmp(Name, ".gnu.linkonce.sb.", 17) == 0 ||
 255         strncmp(Name, ".llvm.linkonce.sb.", 18) == 0)
 256       Flags |= SectionFlags::BSS;
 257     else if (strcmp(Name, ".tdata") == 0 ||
 258              strncmp(Name, ".tdata.", 7) == 0 ||
 259              strncmp(Name, ".gnu.linkonce.td.", 17) == 0 ||
 260              strncmp(Name, ".llvm.linkonce.td.", 18) == 0)
 261       Flags |= SectionFlags::TLS;
 262     else if (strcmp(Name, ".tbss") == 0 ||
 263              strncmp(Name, ".tbss.", 6) == 0 ||
 264              strncmp(Name, ".gnu.linkonce.tb.", 17) == 0 ||
 265              strncmp(Name, ".llvm.linkonce.tb.", 18) == 0)
 266       Flags |= SectionFlags::BSS | SectionFlags::TLS;
 267   }
 268
 269   return Flags;
 270 }
 271
 272 const Section*
 273 TargetAsmInfo::SectionForGlobal(const GlobalValue *GV) const {
 274   const Section* S;
 275   // Select section name
 276   if (GV->hasSection()) {
 277     // Honour section already set, if any
 278     unsigned Flags = SectionFlagsForGlobal(GV,
 279                                            GV->getSection().c_str());
 280     S = getNamedSection(GV->getSection().c_str(), Flags);
 281   } else {
 282     // Use default section depending on the 'type' of global
 283     S = SelectSectionForGlobal(GV);
 284   }
 285
 286   return S;
 287 }
 288
 289 // Lame default implementation. Calculate the section name for global.
 290 const Section*
 291 TargetAsmInfo::SelectSectionForGlobal(const GlobalValue *GV) const {
 292   SectionKind::Kind Kind = SectionKindForGlobal(GV);
 293
 294   if (GV->mayBeOverridden()) {
 295     std::string Name = UniqueSectionForGlobal(GV, Kind);
 296     unsigned Flags = SectionFlagsForGlobal(GV, Name.c_str());
 297     return getNamedSection(Name.c_str(), Flags);
 298   } else {
 299     if (Kind == SectionKind::Text)
 300       return getTextSection();
 301     else if (isBSS(Kind) && getBSSSection_())
 302       return getBSSSection_();
 303     else if (getReadOnlySection() && SectionKind::isReadOnly(Kind))
 304       return getReadOnlySection();
 305   }
 306
 307   return getDataSection();
 308 }
 309
 310 // Lame default implementation. Calculate the section name for machine const.
 311 const Section*
 312 TargetAsmInfo::SelectSectionForMachineConst(const Type *Ty) const {
 313   // FIXME: Support data.rel stuff someday
 314   return getDataSection();
 315 }
 316
 317 std::string
 318 TargetAsmInfo::UniqueSectionForGlobal(const GlobalValue* GV,
 319                                       SectionKind::Kind Kind) const {
 320   switch (Kind) {
 321    case SectionKind::Text:
 322     return ".gnu.linkonce.t." + GV->getName();
 323    case SectionKind::Data:
 324     return ".gnu.linkonce.d." + GV->getName();
 325    case SectionKind::SmallData:
 326     return ".gnu.linkonce.s." + GV->getName();
 327    case SectionKind::BSS:
 328     return ".gnu.linkonce.b." + GV->getName();
 329    case SectionKind::SmallBSS:
 330     return ".gnu.linkonce.sb." + GV->getName();
 331    case SectionKind::ROData:
 332    case SectionKind::RODataMergeConst:
 333    case SectionKind::RODataMergeStr:
 334     return ".gnu.linkonce.r." + GV->getName();
 335    case SectionKind::SmallROData:
 336     return ".gnu.linkonce.s2." + GV->getName();
 337    case SectionKind::ThreadData:
 338     return ".gnu.linkonce.td." + GV->getName();
 339    case SectionKind::ThreadBSS:
 340     return ".gnu.linkonce.tb." + GV->getName();
 341    default:
 342     assert(0 && "Unknown section kind");
 343   }
 344 }
 345
 346 const Section*
 347 TargetAsmInfo::getNamedSection(const char *Name, unsigned Flags,
 348                                bool Override) const {
 349   Section& S = Sections[Name];
 350
 351   // This is newly-created section, set it up properly.
 352   if (S.Flags == SectionFlags::Invalid || Override) {
 353     S.Flags = Flags | SectionFlags::Named;
 354     S.Name = Name;
 355   }
 356
 357   return &S;
 358 }
 359
 360 const Section*
 361 TargetAsmInfo::getUnnamedSection(const char *Directive, unsigned Flags,
 362                                  bool Override) const {
 363   Section& S = Sections[Directive];
 364
 365   // This is newly-created section, set it up properly.
 366   if (S.Flags == SectionFlags::Invalid || Override) {
 367     S.Flags = Flags & ~SectionFlags::Named;
 368     S.Name = Directive;
 369   }
 370
 371   return &S;
 372 }
 373
 374 const std::string&
 375 TargetAsmInfo::getSectionFlags(unsigned Flags) const {
 376   SectionFlags::FlagsStringsMapType::iterator I = FlagsStrings.find(Flags);
 377
 378   // We didn't print these flags yet, print and save them to map. This reduces
 379   // amount of heap trashing due to std::string construction / concatenation.
 380   if (I == FlagsStrings.end())
 381     I = FlagsStrings.insert(std::make_pair(Flags,
 382                                            printSectionFlags(Flags))).first;
 383
 384   return I->second;
 385 }
 386
 387 unsigned TargetAsmInfo::getULEB128Size(unsigned Value) {
 388   unsigned Size = 0;
 389   do {
 390     Value >>= 7;
 391     Size += sizeof(int8_t);
 392   } while (Value);
 393   return Size;
 394 }
 395
 396 unsigned TargetAsmInfo::getSLEB128Size(int Value) {
 397   unsigned Size = 0;
 398   int Sign = Value >> (8 * sizeof(Value) - 1);
 399   bool IsMore;
 400
 401   do {
 402     unsigned Byte = Value & 0x7f;
 403     Value >>= 7;
 404     IsMore = Value != Sign || ((Byte ^ Sign) & 0x40) != 0;
 405     Size += sizeof(int8_t);
 406   } while (IsMore);
 407   return Size;
 408 }