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