lib/CodeGen/TargetLoweringObjectFileImpl.cpp

   1 //===-- llvm/CodeGen/TargetLoweringObjectFileImpl.cpp - Object File 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 implements classes used to handle lowerings specific to common
  11 // object file formats.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "llvm/CodeGen/TargetLoweringObjectFileImpl.h"
  16 #include "llvm/ADT/SmallString.h"
  17 #include "llvm/ADT/StringExtras.h"
  18 #include "llvm/ADT/Triple.h"
  19 #include "llvm/CodeGen/MachineModuleInfoImpls.h"
  20 #include "llvm/IR/Constants.h"
  21 #include "llvm/IR/DataLayout.h"
  22 #include "llvm/IR/DerivedTypes.h"
  23 #include "llvm/IR/Function.h"
  24 #include "llvm/IR/GlobalVariable.h"
  25 #include "llvm/IR/Mangler.h"
  26 #include "llvm/IR/Module.h"
  27 #include "llvm/MC/MCContext.h"
  28 #include "llvm/MC/MCExpr.h"
  29 #include "llvm/MC/MCSectionCOFF.h"
  30 #include "llvm/MC/MCSectionELF.h"
  31 #include "llvm/MC/MCSectionMachO.h"
  32 #include "llvm/MC/MCStreamer.h"
  33 #include "llvm/MC/MCSymbolELF.h"
  34 #include "llvm/MC/MCValue.h"
  35 #include "llvm/Support/COFF.h"
  36 #include "llvm/Support/Dwarf.h"
  37 #include "llvm/Support/ELF.h"
  38 #include "llvm/Support/ErrorHandling.h"
  39 #include "llvm/Support/raw_ostream.h"
  40 #include "llvm/Target/TargetLowering.h"
  41 #include "llvm/Target/TargetMachine.h"
  42 #include "llvm/Target/TargetSubtargetInfo.h"
  43 using namespace llvm;
  44 using namespace dwarf;
  45
  46 //===----------------------------------------------------------------------===//
  47 //                                  ELF
  48 //===----------------------------------------------------------------------===//
  49
  50 MCSymbol *TargetLoweringObjectFileELF::getCFIPersonalitySymbol(
  51     const GlobalValue *GV, Mangler &Mang, const TargetMachine &TM,
  52     MachineModuleInfo *MMI) const {
  53   unsigned Encoding = getPersonalityEncoding();
  54   if ((Encoding & 0x80) == dwarf::DW_EH_PE_indirect)
  55     return getContext().getOrCreateSymbol(StringRef("DW.ref.") +
  56                                           TM.getSymbol(GV, Mang)->getName());
  57   if ((Encoding & 0x70) == dwarf::DW_EH_PE_absptr)
  58     return TM.getSymbol(GV, Mang);
  59   report_fatal_error("We do not support this DWARF encoding yet!");
  60 }
  61
  62 void TargetLoweringObjectFileELF::emitPersonalityValue(
  63     MCStreamer &Streamer, const DataLayout &DL, const MCSymbol *Sym) const {
  64   SmallString<64> NameData("DW.ref.");
  65   NameData += Sym->getName();
  66   MCSymbolELF *Label =
  67       cast<MCSymbolELF>(getContext().getOrCreateSymbol(NameData));
  68   Streamer.EmitSymbolAttribute(Label, MCSA_Hidden);
  69   Streamer.EmitSymbolAttribute(Label, MCSA_Weak);
  70   StringRef Prefix = ".data.";
  71   NameData.insert(NameData.begin(), Prefix.begin(), Prefix.end());
  72   unsigned Flags = ELF::SHF_ALLOC | ELF::SHF_WRITE | ELF::SHF_GROUP;
  73   MCSection *Sec = getContext().getELFSection(NameData, ELF::SHT_PROGBITS,
  74                                               Flags, 0, Label->getName());
  75   unsigned Size = DL.getPointerSize();
  76   Streamer.SwitchSection(Sec);
  77   Streamer.EmitValueToAlignment(DL.getPointerABIAlignment());
  78   Streamer.EmitSymbolAttribute(Label, MCSA_ELF_TypeObject);
  79   const MCExpr *E = MCConstantExpr::create(Size, getContext());
  80   Streamer.emitELFSize(Label, E);
  81   Streamer.EmitLabel(Label);
  82
  83   Streamer.EmitSymbolValue(Sym, Size);
  84 }
  85
  86 const MCExpr *TargetLoweringObjectFileELF::getTTypeGlobalReference(
  87     const GlobalValue *GV, unsigned Encoding, Mangler &Mang,
  88     const TargetMachine &TM, MachineModuleInfo *MMI,
  89     MCStreamer &Streamer) const {
  90
  91   if (Encoding & dwarf::DW_EH_PE_indirect) {
  92     MachineModuleInfoELF &ELFMMI = MMI->getObjFileInfo<MachineModuleInfoELF>();
  93
  94     MCSymbol *SSym = getSymbolWithGlobalValueBase(GV, ".DW.stub", Mang, TM);
  95
  96     // Add information about the stub reference to ELFMMI so that the stub
  97     // gets emitted by the asmprinter.
  98     MachineModuleInfoImpl::StubValueTy &StubSym = ELFMMI.getGVStubEntry(SSym);
  99     if (!StubSym.getPointer()) {
 100       MCSymbol *Sym = TM.getSymbol(GV, Mang);
 101       StubSym = MachineModuleInfoImpl::StubValueTy(Sym, !GV->hasLocalLinkage());
 102     }
 103
 104     return TargetLoweringObjectFile::
 105       getTTypeReference(MCSymbolRefExpr::create(SSym, getContext()),
 106                         Encoding & ~dwarf::DW_EH_PE_indirect, Streamer);
 107   }
 108
 109   return TargetLoweringObjectFile::
 110     getTTypeGlobalReference(GV, Encoding, Mang, TM, MMI, Streamer);
 111 }
 112
 113 static SectionKind
 114 getELFKindForNamedSection(StringRef Name, SectionKind K) {
 115   // N.B.: The defaults used in here are no the same ones used in MC.
 116   // We follow gcc, MC follows gas. For example, given ".section .eh_frame",
 117   // both gas and MC will produce a section with no flags. Given
 118   // section(".eh_frame") gcc will produce:
 119   //
 120   //   .section   .eh_frame,"a",@progbits
 121   if (Name.empty() || Name[0] != '.') return K;
 122
 123   // Some lame default implementation based on some magic section names.
 124   if (Name == ".bss" ||
 125       Name.startswith(".bss.") ||
 126       Name.startswith(".gnu.linkonce.b.") ||
 127       Name.startswith(".llvm.linkonce.b.") ||
 128       Name == ".sbss" ||
 129       Name.startswith(".sbss.") ||
 130       Name.startswith(".gnu.linkonce.sb.") ||
 131       Name.startswith(".llvm.linkonce.sb."))
 132     return SectionKind::getBSS();
 133
 134   if (Name == ".tdata" ||
 135       Name.startswith(".tdata.") ||
 136       Name.startswith(".gnu.linkonce.td.") ||
 137       Name.startswith(".llvm.linkonce.td."))
 138     return SectionKind::getThreadData();
 139
 140   if (Name == ".tbss" ||
 141       Name.startswith(".tbss.") ||
 142       Name.startswith(".gnu.linkonce.tb.") ||
 143       Name.startswith(".llvm.linkonce.tb."))
 144     return SectionKind::getThreadBSS();
 145
 146   return K;
 147 }
 148
 149
 150 static unsigned getELFSectionType(StringRef Name, SectionKind K) {
 151
 152   if (Name == ".init_array")
 153     return ELF::SHT_INIT_ARRAY;
 154
 155   if (Name == ".fini_array")
 156     return ELF::SHT_FINI_ARRAY;
 157
 158   if (Name == ".preinit_array")
 159     return ELF::SHT_PREINIT_ARRAY;
 160
 161   if (K.isBSS() || K.isThreadBSS())
 162     return ELF::SHT_NOBITS;
 163
 164   return ELF::SHT_PROGBITS;
 165 }
 166
 167 static unsigned getELFSectionFlags(SectionKind K) {
 168   unsigned Flags = 0;
 169
 170   if (!K.isMetadata())
 171     Flags |= ELF::SHF_ALLOC;
 172
 173   if (K.isText())
 174     Flags |= ELF::SHF_EXECINSTR;
 175
 176   if (K.isWriteable())
 177     Flags |= ELF::SHF_WRITE;
 178
 179   if (K.isThreadLocal())
 180     Flags |= ELF::SHF_TLS;
 181
 182   if (K.isMergeableCString() || K.isMergeableConst())
 183     Flags |= ELF::SHF_MERGE;
 184
 185   if (K.isMergeableCString())
 186     Flags |= ELF::SHF_STRINGS;
 187
 188   return Flags;
 189 }
 190
 191 static const Comdat *getELFComdat(const GlobalValue *GV) {
 192   const Comdat *C = GV->getComdat();
 193   if (!C)
 194     return nullptr;
 195
 196   if (C->getSelectionKind() != Comdat::Any)
 197     report_fatal_error("ELF COMDATs only support SelectionKind::Any, '" +
 198                        C->getName() + "' cannot be lowered.");
 199
 200   return C;
 201 }
 202
 203 MCSection *TargetLoweringObjectFileELF::getExplicitSectionGlobal(
 204     const GlobalValue *GV, SectionKind Kind, Mangler &Mang,
 205     const TargetMachine &TM) const {
 206   StringRef SectionName = GV->getSection();
 207
 208   // Infer section flags from the section name if we can.
 209   Kind = getELFKindForNamedSection(SectionName, Kind);
 210
 211   StringRef Group = "";
 212   unsigned Flags = getELFSectionFlags(Kind);
 213   if (const Comdat *C = getELFComdat(GV)) {
 214     Group = C->getName();
 215     Flags |= ELF::SHF_GROUP;
 216   }
 217   return getContext().getELFSection(SectionName,
 218                                     getELFSectionType(SectionName, Kind), Flags,
 219                                     /*EntrySize=*/0, Group);
 220 }
 221
 222 /// Return the section prefix name used by options FunctionsSections and
 223 /// DataSections.
 224 static StringRef getSectionPrefixForGlobal(SectionKind Kind) {
 225   if (Kind.isText())
 226     return ".text";
 227   if (Kind.isReadOnly())
 228     return ".rodata";
 229   if (Kind.isBSS())
 230     return ".bss";
 231   if (Kind.isThreadData())
 232     return ".tdata";
 233   if (Kind.isThreadBSS())
 234     return ".tbss";
 235   if (Kind.isDataNoRel())
 236     return ".data";
 237   if (Kind.isDataRelLocal())
 238     return ".data.rel.local";
 239   if (Kind.isDataRel())
 240     return ".data.rel";
 241   if (Kind.isReadOnlyWithRelLocal())
 242     return ".data.rel.ro.local";
 243   assert(Kind.isReadOnlyWithRel() && "Unknown section kind");
 244   return ".data.rel.ro";
 245 }
 246
 247 static MCSectionELF *
 248 selectELFSectionForGlobal(MCContext &Ctx, const GlobalValue *GV,
 249                           SectionKind Kind, Mangler &Mang,
 250                           const TargetMachine &TM, bool EmitUniqueSection,
 251                           unsigned Flags, unsigned *NextUniqueID) {
 252   unsigned EntrySize = 0;
 253   if (Kind.isMergeableCString()) {
 254     if (Kind.isMergeable2ByteCString()) {
 255       EntrySize = 2;
 256     } else if (Kind.isMergeable4ByteCString()) {
 257       EntrySize = 4;
 258     } else {
 259       EntrySize = 1;
 260       assert(Kind.isMergeable1ByteCString() && "unknown string width");
 261     }
 262   } else if (Kind.isMergeableConst()) {
 263     if (Kind.isMergeableConst4()) {
 264       EntrySize = 4;
 265     } else if (Kind.isMergeableConst8()) {
 266       EntrySize = 8;
 267     } else {
 268       assert(Kind.isMergeableConst16() && "unknown data width");
 269       EntrySize = 16;
 270     }
 271   }
 272
 273   StringRef Group = "";
 274   if (const Comdat *C = getELFComdat(GV)) {
 275     Flags |= ELF::SHF_GROUP;
 276     Group = C->getName();
 277   }
 278
 279   bool UniqueSectionNames = TM.getUniqueSectionNames();
 280   SmallString<128> Name;
 281   if (Kind.isMergeableCString()) {
 282     // We also need alignment here.
 283     // FIXME: this is getting the alignment of the character, not the
 284     // alignment of the global!
 285     unsigned Align = GV->getParent()->getDataLayout().getPreferredAlignment(
 286         cast<GlobalVariable>(GV));
 287
 288     std::string SizeSpec = ".rodata.str" + utostr(EntrySize) + ".";
 289     Name = SizeSpec + utostr(Align);
 290   } else if (Kind.isMergeableConst()) {
 291     Name = ".rodata.cst";
 292     Name += utostr(EntrySize);
 293   } else {
 294     Name = getSectionPrefixForGlobal(Kind);
 295   }
 296
 297   if (EmitUniqueSection && UniqueSectionNames) {
 298     Name.push_back('.');
 299     TM.getNameWithPrefix(Name, GV, Mang, true);
 300   }
 301   unsigned UniqueID = ~0;
 302   if (EmitUniqueSection && !UniqueSectionNames) {
 303     UniqueID = *NextUniqueID;
 304     (*NextUniqueID)++;
 305   }
 306   return Ctx.getELFSection(Name, getELFSectionType(Name, Kind), Flags,
 307                            EntrySize, Group, UniqueID);
 308 }
 309
 310 MCSection *TargetLoweringObjectFileELF::SelectSectionForGlobal(
 311     const GlobalValue *GV, SectionKind Kind, Mangler &Mang,
 312     const TargetMachine &TM) const {
 313   unsigned Flags = getELFSectionFlags(Kind);
 314
 315   // If we have -ffunction-section or -fdata-section then we should emit the
 316   // global value to a uniqued section specifically for it.
 317   bool EmitUniqueSection = false;
 318   if (!(Flags & ELF::SHF_MERGE) && !Kind.isCommon()) {
 319     if (Kind.isText())
 320       EmitUniqueSection = TM.getFunctionSections();
 321     else
 322       EmitUniqueSection = TM.getDataSections();
 323   }
 324   EmitUniqueSection |= GV->hasComdat();
 325
 326   return selectELFSectionForGlobal(getContext(), GV, Kind, Mang, TM,
 327                                    EmitUniqueSection, Flags, &NextUniqueID);
 328 }
 329
 330 MCSection *TargetLoweringObjectFileELF::getSectionForJumpTable(
 331     const Function &F, Mangler &Mang, const TargetMachine &TM) const {
 332   // If the function can be removed, produce a unique section so that
 333   // the table doesn't prevent the removal.
 334   const Comdat *C = F.getComdat();
 335   bool EmitUniqueSection = TM.getFunctionSections() || C;
 336   if (!EmitUniqueSection)
 337     return ReadOnlySection;
 338
 339   return selectELFSectionForGlobal(getContext(), &F, SectionKind::getReadOnly(),
 340                                    Mang, TM, EmitUniqueSection, ELF::SHF_ALLOC,
 341                                    &NextUniqueID);
 342 }
 343
 344 bool TargetLoweringObjectFileELF::shouldPutJumpTableInFunctionSection(
 345     bool UsesLabelDifference, const Function &F) const {
 346   // We can always create relative relocations, so use another section
 347   // that can be marked non-executable.
 348   return false;
 349 }
 350
 351 /// Given a mergeable constant with the specified size and relocation
 352 /// information, return a section that it should be placed in.
 353 MCSection *TargetLoweringObjectFileELF::getSectionForConstant(
 354     const DataLayout &DL, SectionKind Kind, const Constant *C) const {
 355   if (Kind.isMergeableConst4() && MergeableConst4Section)
 356     return MergeableConst4Section;
 357   if (Kind.isMergeableConst8() && MergeableConst8Section)
 358     return MergeableConst8Section;
 359   if (Kind.isMergeableConst16() && MergeableConst16Section)
 360     return MergeableConst16Section;
 361   if (Kind.isReadOnly())
 362     return ReadOnlySection;
 363
 364   if (Kind.isReadOnlyWithRelLocal()) return DataRelROLocalSection;
 365   assert(Kind.isReadOnlyWithRel() && "Unknown section kind");
 366   return DataRelROSection;
 367 }
 368
 369 static MCSectionELF *getStaticStructorSection(MCContext &Ctx, bool UseInitArray,
 370                                               bool IsCtor, unsigned Priority,
 371                                               const MCSymbol *KeySym) {
 372   std::string Name;
 373   unsigned Type;
 374   unsigned Flags = ELF::SHF_ALLOC | ELF::SHF_WRITE;
 375   StringRef COMDAT = KeySym ? KeySym->getName() : "";
 376
 377   if (KeySym)
 378     Flags |= ELF::SHF_GROUP;
 379
 380   if (UseInitArray) {
 381     if (IsCtor) {
 382       Type = ELF::SHT_INIT_ARRAY;
 383       Name = ".init_array";
 384     } else {
 385       Type = ELF::SHT_FINI_ARRAY;
 386       Name = ".fini_array";
 387     }
 388     if (Priority != 65535) {
 389       Name += '.';
 390       Name += utostr(Priority);
 391     }
 392   } else {
 393     // The default scheme is .ctor / .dtor, so we have to invert the priority
 394     // numbering.
 395     if (IsCtor)
 396       Name = ".ctors";
 397     else
 398       Name = ".dtors";
 399     if (Priority != 65535) {
 400       Name += '.';
 401       Name += utostr(65535 - Priority);
 402     }
 403     Type = ELF::SHT_PROGBITS;
 404   }
 405
 406   return Ctx.getELFSection(Name, Type, Flags, 0, COMDAT);
 407 }
 408
 409 MCSection *TargetLoweringObjectFileELF::getStaticCtorSection(
 410     unsigned Priority, const MCSymbol *KeySym) const {
 411   return getStaticStructorSection(getContext(), UseInitArray, true, Priority,
 412                                   KeySym);
 413 }
 414
 415 MCSection *TargetLoweringObjectFileELF::getStaticDtorSection(
 416     unsigned Priority, const MCSymbol *KeySym) const {
 417   return getStaticStructorSection(getContext(), UseInitArray, false, Priority,
 418                                   KeySym);
 419 }
 420
 421 void
 422 TargetLoweringObjectFileELF::InitializeELF(bool UseInitArray_) {
 423   UseInitArray = UseInitArray_;
 424   if (!UseInitArray)
 425     return;
 426
 427   StaticCtorSection = getContext().getELFSection(
 428       ".init_array", ELF::SHT_INIT_ARRAY, ELF::SHF_WRITE | ELF::SHF_ALLOC);
 429   StaticDtorSection = getContext().getELFSection(
 430       ".fini_array", ELF::SHT_FINI_ARRAY, ELF::SHF_WRITE | ELF::SHF_ALLOC);
 431 }
 432
 433 //===----------------------------------------------------------------------===//
 434 //                                 MachO
 435 //===----------------------------------------------------------------------===//
 436
 437 TargetLoweringObjectFileMachO::TargetLoweringObjectFileMachO()
 438   : TargetLoweringObjectFile() {
 439   SupportIndirectSymViaGOTPCRel = true;
 440 }
 441
 442 /// emitModuleFlags - Perform code emission for module flags.
 443 void TargetLoweringObjectFileMachO::
 444 emitModuleFlags(MCStreamer &Streamer,
 445                 ArrayRef<Module::ModuleFlagEntry> ModuleFlags,
 446                 Mangler &Mang, const TargetMachine &TM) const {
 447   unsigned VersionVal = 0;
 448   unsigned ImageInfoFlags = 0;
 449   MDNode *LinkerOptions = nullptr;
 450   StringRef SectionVal;
 451
 452   for (ArrayRef<Module::ModuleFlagEntry>::iterator
 453          i = ModuleFlags.begin(), e = ModuleFlags.end(); i != e; ++i) {
 454     const Module::ModuleFlagEntry &MFE = *i;
 455
 456     // Ignore flags with 'Require' behavior.
 457     if (MFE.Behavior == Module::Require)
 458       continue;
 459
 460     StringRef Key = MFE.Key->getString();
 461     Metadata *Val = MFE.Val;
 462
 463     if (Key == "Objective-C Image Info Version") {
 464       VersionVal = mdconst::extract<ConstantInt>(Val)->getZExtValue();
 465     } else if (Key == "Objective-C Garbage Collection" ||
 466                Key == "Objective-C GC Only" ||
 467                Key == "Objective-C Is Simulated" ||
 468                Key == "Objective-C Image Swift Version") {
 469       ImageInfoFlags |= mdconst::extract<ConstantInt>(Val)->getZExtValue();
 470     } else if (Key == "Objective-C Image Info Section") {
 471       SectionVal = cast<MDString>(Val)->getString();
 472     } else if (Key == "Linker Options") {
 473       LinkerOptions = cast<MDNode>(Val);
 474     }
 475   }
 476
 477   // Emit the linker options if present.
 478   if (LinkerOptions) {
 479     for (unsigned i = 0, e = LinkerOptions->getNumOperands(); i != e; ++i) {
 480       MDNode *MDOptions = cast<MDNode>(LinkerOptions->getOperand(i));
 481       SmallVector<std::string, 4> StrOptions;
 482
 483       // Convert to strings.
 484       for (unsigned ii = 0, ie = MDOptions->getNumOperands(); ii != ie; ++ii) {
 485         MDString *MDOption = cast<MDString>(MDOptions->getOperand(ii));
 486         StrOptions.push_back(MDOption->getString());
 487       }
 488
 489       Streamer.EmitLinkerOptions(StrOptions);
 490     }
 491   }
 492
 493   // The section is mandatory. If we don't have it, then we don't have GC info.
 494   if (SectionVal.empty()) return;
 495
 496   StringRef Segment, Section;
 497   unsigned TAA = 0, StubSize = 0;
 498   bool TAAParsed;
 499   std::string ErrorCode =
 500     MCSectionMachO::ParseSectionSpecifier(SectionVal, Segment, Section,
 501                                           TAA, TAAParsed, StubSize);
 502   if (!ErrorCode.empty())
 503     // If invalid, report the error with report_fatal_error.
 504     report_fatal_error("Invalid section specifier '" + Section + "': " +
 505                        ErrorCode + ".");
 506
 507   // Get the section.
 508   MCSectionMachO *S = getContext().getMachOSection(
 509       Segment, Section, TAA, StubSize, SectionKind::getDataNoRel());
 510   Streamer.SwitchSection(S);
 511   Streamer.EmitLabel(getContext().
 512                      getOrCreateSymbol(StringRef("L_OBJC_IMAGE_INFO")));
 513   Streamer.EmitIntValue(VersionVal, 4);
 514   Streamer.EmitIntValue(ImageInfoFlags, 4);
 515   Streamer.AddBlankLine();
 516 }
 517
 518 static void checkMachOComdat(const GlobalValue *GV) {
 519   const Comdat *C = GV->getComdat();
 520   if (!C)
 521     return;
 522
 523   report_fatal_error("MachO doesn't support COMDATs, '" + C->getName() +
 524                      "' cannot be lowered.");
 525 }
 526
 527 MCSection *TargetLoweringObjectFileMachO::getExplicitSectionGlobal(
 528     const GlobalValue *GV, SectionKind Kind, Mangler &Mang,
 529     const TargetMachine &TM) const {
 530   // Parse the section specifier and create it if valid.
 531   StringRef Segment, Section;
 532   unsigned TAA = 0, StubSize = 0;
 533   bool TAAParsed;
 534
 535   checkMachOComdat(GV);
 536
 537   std::string ErrorCode =
 538     MCSectionMachO::ParseSectionSpecifier(GV->getSection(), Segment, Section,
 539                                           TAA, TAAParsed, StubSize);
 540   if (!ErrorCode.empty()) {
 541     // If invalid, report the error with report_fatal_error.
 542     report_fatal_error("Global variable '" + GV->getName() +
 543                        "' has an invalid section specifier '" +
 544                        GV->getSection() + "': " + ErrorCode + ".");
 545   }
 546
 547   // Get the section.
 548   MCSectionMachO *S =
 549       getContext().getMachOSection(Segment, Section, TAA, StubSize, Kind);
 550
 551   // If TAA wasn't set by ParseSectionSpecifier() above,
 552   // use the value returned by getMachOSection() as a default.
 553   if (!TAAParsed)
 554     TAA = S->getTypeAndAttributes();
 555
 556   // Okay, now that we got the section, verify that the TAA & StubSize agree.
 557   // If the user declared multiple globals with different section flags, we need
 558   // to reject it here.
 559   if (S->getTypeAndAttributes() != TAA || S->getStubSize() != StubSize) {
 560     // If invalid, report the error with report_fatal_error.
 561     report_fatal_error("Global variable '" + GV->getName() +
 562                        "' section type or attributes does not match previous"
 563                        " section specifier");
 564   }
 565
 566   return S;
 567 }
 568
 569 MCSection *TargetLoweringObjectFileMachO::SelectSectionForGlobal(
 570     const GlobalValue *GV, SectionKind Kind, Mangler &Mang,
 571     const TargetMachine &TM) const {
 572   checkMachOComdat(GV);
 573
 574   // Handle thread local data.
 575   if (Kind.isThreadBSS()) return TLSBSSSection;
 576   if (Kind.isThreadData()) return TLSDataSection;
 577
 578   if (Kind.isText())
 579     return GV->isWeakForLinker() ? TextCoalSection : TextSection;
 580
 581   // If this is weak/linkonce, put this in a coalescable section, either in text
 582   // or data depending on if it is writable.
 583   if (GV->isWeakForLinker()) {
 584     if (Kind.isReadOnly())
 585       return ConstTextCoalSection;
 586     return DataCoalSection;
 587   }
 588
 589   // FIXME: Alignment check should be handled by section classifier.
 590   if (Kind.isMergeable1ByteCString() &&
 591       GV->getParent()->getDataLayout().getPreferredAlignment(
 592           cast<GlobalVariable>(GV)) < 32)
 593     return CStringSection;
 594
 595   // Do not put 16-bit arrays in the UString section if they have an
 596   // externally visible label, this runs into issues with certain linker
 597   // versions.
 598   if (Kind.isMergeable2ByteCString() && !GV->hasExternalLinkage() &&
 599       GV->getParent()->getDataLayout().getPreferredAlignment(
 600           cast<GlobalVariable>(GV)) < 32)
 601     return UStringSection;
 602
 603   // With MachO only variables whose corresponding symbol starts with 'l' or
 604   // 'L' can be merged, so we only try merging GVs with private linkage.
 605   if (GV->hasPrivateLinkage() && Kind.isMergeableConst()) {
 606     if (Kind.isMergeableConst4())
 607       return FourByteConstantSection;
 608     if (Kind.isMergeableConst8())
 609       return EightByteConstantSection;
 610     if (Kind.isMergeableConst16())
 611       return SixteenByteConstantSection;
 612   }
 613
 614   // Otherwise, if it is readonly, but not something we can specially optimize,
 615   // just drop it in .const.
 616   if (Kind.isReadOnly())
 617     return ReadOnlySection;
 618
 619   // If this is marked const, put it into a const section.  But if the dynamic
 620   // linker needs to write to it, put it in the data segment.
 621   if (Kind.isReadOnlyWithRel())
 622     return ConstDataSection;
 623
 624   // Put zero initialized globals with strong external linkage in the
 625   // DATA, __common section with the .zerofill directive.
 626   if (Kind.isBSSExtern())
 627     return DataCommonSection;
 628
 629   // Put zero initialized globals with local linkage in __DATA,__bss directive
 630   // with the .zerofill directive (aka .lcomm).
 631   if (Kind.isBSSLocal())
 632     return DataBSSSection;
 633
 634   // Otherwise, just drop the variable in the normal data section.
 635   return DataSection;
 636 }
 637
 638 MCSection *TargetLoweringObjectFileMachO::getSectionForConstant(
 639     const DataLayout &DL, SectionKind Kind, const Constant *C) const {
 640   // If this constant requires a relocation, we have to put it in the data
 641   // segment, not in the text segment.
 642   if (Kind.isDataRel() || Kind.isReadOnlyWithRel())
 643     return ConstDataSection;
 644
 645   if (Kind.isMergeableConst4())
 646     return FourByteConstantSection;
 647   if (Kind.isMergeableConst8())
 648     return EightByteConstantSection;
 649   if (Kind.isMergeableConst16())
 650     return SixteenByteConstantSection;
 651   return ReadOnlySection;  // .const
 652 }
 653
 654 const MCExpr *TargetLoweringObjectFileMachO::getTTypeGlobalReference(
 655     const GlobalValue *GV, unsigned Encoding, Mangler &Mang,
 656     const TargetMachine &TM, MachineModuleInfo *MMI,
 657     MCStreamer &Streamer) const {
 658   // The mach-o version of this method defaults to returning a stub reference.
 659
 660   if (Encoding & DW_EH_PE_indirect) {
 661     MachineModuleInfoMachO &MachOMMI =
 662       MMI->getObjFileInfo<MachineModuleInfoMachO>();
 663
 664     MCSymbol *SSym =
 665         getSymbolWithGlobalValueBase(GV, "$non_lazy_ptr", Mang, TM);
 666
 667     // Add information about the stub reference to MachOMMI so that the stub
 668     // gets emitted by the asmprinter.
 669     MachineModuleInfoImpl::StubValueTy &StubSym =
 670       GV->hasHiddenVisibility() ? MachOMMI.getHiddenGVStubEntry(SSym) :
 671                                   MachOMMI.getGVStubEntry(SSym);
 672     if (!StubSym.getPointer()) {
 673       MCSymbol *Sym = TM.getSymbol(GV, Mang);
 674       StubSym = MachineModuleInfoImpl::StubValueTy(Sym, !GV->hasLocalLinkage());
 675     }
 676
 677     return TargetLoweringObjectFile::
 678       getTTypeReference(MCSymbolRefExpr::create(SSym, getContext()),
 679                         Encoding & ~dwarf::DW_EH_PE_indirect, Streamer);
 680   }
 681
 682   return TargetLoweringObjectFile::getTTypeGlobalReference(GV, Encoding, Mang,
 683                                                            TM, MMI, Streamer);
 684 }
 685
 686 MCSymbol *TargetLoweringObjectFileMachO::getCFIPersonalitySymbol(
 687     const GlobalValue *GV, Mangler &Mang, const TargetMachine &TM,
 688     MachineModuleInfo *MMI) const {
 689   // The mach-o version of this method defaults to returning a stub reference.
 690   MachineModuleInfoMachO &MachOMMI =
 691     MMI->getObjFileInfo<MachineModuleInfoMachO>();
 692
 693   MCSymbol *SSym = getSymbolWithGlobalValueBase(GV, "$non_lazy_ptr", Mang, TM);
 694
 695   // Add information about the stub reference to MachOMMI so that the stub
 696   // gets emitted by the asmprinter.
 697   MachineModuleInfoImpl::StubValueTy &StubSym = MachOMMI.getGVStubEntry(SSym);
 698   if (!StubSym.getPointer()) {
 699     MCSymbol *Sym = TM.getSymbol(GV, Mang);
 700     StubSym = MachineModuleInfoImpl::StubValueTy(Sym, !GV->hasLocalLinkage());
 701   }
 702
 703   return SSym;
 704 }
 705
 706 const MCExpr *TargetLoweringObjectFileMachO::getIndirectSymViaGOTPCRel(
 707     const MCSymbol *Sym, const MCValue &MV, int64_t Offset,
 708     MachineModuleInfo *MMI, MCStreamer &Streamer) const {
 709   // Although MachO 32-bit targets do not explicitly have a GOTPCREL relocation
 710   // as 64-bit do, we replace the GOT equivalent by accessing the final symbol
 711   // through a non_lazy_ptr stub instead. One advantage is that it allows the
 712   // computation of deltas to final external symbols. Example:
 713   //
 714   //    _extgotequiv:
 715   //       .long   _extfoo
 716   //
 717   //    _delta:
 718   //       .long   _extgotequiv-_delta
 719   //
 720   // is transformed to:
 721   //
 722   //    _delta:
 723   //       .long   L_extfoo$non_lazy_ptr-(_delta+0)
 724   //
 725   //       .section        __IMPORT,__pointers,non_lazy_symbol_pointers
 726   //    L_extfoo$non_lazy_ptr:
 727   //       .indirect_symbol        _extfoo
 728   //       .long   0
 729   //
 730   MachineModuleInfoMachO &MachOMMI =
 731     MMI->getObjFileInfo<MachineModuleInfoMachO>();
 732   MCContext &Ctx = getContext();
 733
 734   // The offset must consider the original displacement from the base symbol
 735   // since 32-bit targets don't have a GOTPCREL to fold the PC displacement.
 736   Offset = -MV.getConstant();
 737   const MCSymbol *BaseSym = &MV.getSymB()->getSymbol();
 738
 739   // Access the final symbol via sym$non_lazy_ptr and generate the appropriated
 740   // non_lazy_ptr stubs.
 741   SmallString<128> Name;
 742   StringRef Suffix = "$non_lazy_ptr";
 743   Name += MMI->getModule()->getDataLayout().getPrivateGlobalPrefix();
 744   Name += Sym->getName();
 745   Name += Suffix;
 746   MCSymbol *Stub = Ctx.getOrCreateSymbol(Name);
 747
 748   MachineModuleInfoImpl::StubValueTy &StubSym = MachOMMI.getGVStubEntry(Stub);
 749   if (!StubSym.getPointer())
 750     StubSym = MachineModuleInfoImpl::
 751       StubValueTy(const_cast<MCSymbol *>(Sym), true /* access indirectly */);
 752
 753   const MCExpr *BSymExpr =
 754     MCSymbolRefExpr::create(BaseSym, MCSymbolRefExpr::VK_None, Ctx);
 755   const MCExpr *LHS =
 756     MCSymbolRefExpr::create(Stub, MCSymbolRefExpr::VK_None, Ctx);
 757
 758   if (!Offset)
 759     return MCBinaryExpr::createSub(LHS, BSymExpr, Ctx);
 760
 761   const MCExpr *RHS =
 762     MCBinaryExpr::createAdd(BSymExpr, MCConstantExpr::create(Offset, Ctx), Ctx);
 763   return MCBinaryExpr::createSub(LHS, RHS, Ctx);
 764 }
 765
 766 //===----------------------------------------------------------------------===//
 767 //                                  COFF
 768 //===----------------------------------------------------------------------===//
 769
 770 static unsigned
 771 getCOFFSectionFlags(SectionKind K) {
 772   unsigned Flags = 0;
 773
 774   if (K.isMetadata())
 775     Flags |=
 776       COFF::IMAGE_SCN_MEM_DISCARDABLE;
 777   else if (K.isText())
 778     Flags |=
 779       COFF::IMAGE_SCN_MEM_EXECUTE |
 780       COFF::IMAGE_SCN_MEM_READ |
 781       COFF::IMAGE_SCN_CNT_CODE;
 782   else if (K.isBSS())
 783     Flags |=
 784       COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA |
 785       COFF::IMAGE_SCN_MEM_READ |
 786       COFF::IMAGE_SCN_MEM_WRITE;
 787   else if (K.isThreadLocal())
 788     Flags |=
 789       COFF::IMAGE_SCN_CNT_INITIALIZED_DATA |
 790       COFF::IMAGE_SCN_MEM_READ |
 791       COFF::IMAGE_SCN_MEM_WRITE;
 792   else if (K.isReadOnly() || K.isReadOnlyWithRel())
 793     Flags |=
 794       COFF::IMAGE_SCN_CNT_INITIALIZED_DATA |
 795       COFF::IMAGE_SCN_MEM_READ;
 796   else if (K.isWriteable())
 797     Flags |=
 798       COFF::IMAGE_SCN_CNT_INITIALIZED_DATA |
 799       COFF::IMAGE_SCN_MEM_READ |
 800       COFF::IMAGE_SCN_MEM_WRITE;
 801
 802   return Flags;
 803 }
 804
 805 static const GlobalValue *getComdatGVForCOFF(const GlobalValue *GV) {
 806   const Comdat *C = GV->getComdat();
 807   assert(C && "expected GV to have a Comdat!");
 808
 809   StringRef ComdatGVName = C->getName();
 810   const GlobalValue *ComdatGV = GV->getParent()->getNamedValue(ComdatGVName);
 811   if (!ComdatGV)
 812     report_fatal_error("Associative COMDAT symbol '" + ComdatGVName +
 813                        "' does not exist.");
 814
 815   if (ComdatGV->getComdat() != C)
 816     report_fatal_error("Associative COMDAT symbol '" + ComdatGVName +
 817                        "' is not a key for its COMDAT.");
 818
 819   return ComdatGV;
 820 }
 821
 822 static int getSelectionForCOFF(const GlobalValue *GV) {
 823   if (const Comdat *C = GV->getComdat()) {
 824     const GlobalValue *ComdatKey = getComdatGVForCOFF(GV);
 825     if (const auto *GA = dyn_cast<GlobalAlias>(ComdatKey))
 826       ComdatKey = GA->getBaseObject();
 827     if (ComdatKey == GV) {
 828       switch (C->getSelectionKind()) {
 829       case Comdat::Any:
 830         return COFF::IMAGE_COMDAT_SELECT_ANY;
 831       case Comdat::ExactMatch:
 832         return COFF::IMAGE_COMDAT_SELECT_EXACT_MATCH;
 833       case Comdat::Largest:
 834         return COFF::IMAGE_COMDAT_SELECT_LARGEST;
 835       case Comdat::NoDuplicates:
 836         return COFF::IMAGE_COMDAT_SELECT_NODUPLICATES;
 837       case Comdat::SameSize:
 838         return COFF::IMAGE_COMDAT_SELECT_SAME_SIZE;
 839       }
 840     } else {
 841       return COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE;
 842     }
 843   }
 844   return 0;
 845 }
 846
 847 MCSection *TargetLoweringObjectFileCOFF::getExplicitSectionGlobal(
 848     const GlobalValue *GV, SectionKind Kind, Mangler &Mang,
 849     const TargetMachine &TM) const {
 850   int Selection = 0;
 851   unsigned Characteristics = getCOFFSectionFlags(Kind);
 852   StringRef Name = GV->getSection();
 853   StringRef COMDATSymName = "";
 854   if (GV->hasComdat()) {
 855     Selection = getSelectionForCOFF(GV);
 856     const GlobalValue *ComdatGV;
 857     if (Selection == COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE)
 858       ComdatGV = getComdatGVForCOFF(GV);
 859     else
 860       ComdatGV = GV;
 861
 862     if (!ComdatGV->hasPrivateLinkage()) {
 863       MCSymbol *Sym = TM.getSymbol(ComdatGV, Mang);
 864       COMDATSymName = Sym->getName();
 865       Characteristics |= COFF::IMAGE_SCN_LNK_COMDAT;
 866     } else {
 867       Selection = 0;
 868     }
 869   }
 870   return getContext().getCOFFSection(Name,
 871                                      Characteristics,
 872                                      Kind,
 873                                      COMDATSymName,
 874                                      Selection);
 875 }
 876
 877 static const char *getCOFFSectionNameForUniqueGlobal(SectionKind Kind) {
 878   if (Kind.isText())
 879     return ".text";
 880   if (Kind.isBSS())
 881     return ".bss";
 882   if (Kind.isThreadLocal())
 883     return ".tls$";
 884   if (Kind.isReadOnly() || Kind.isReadOnlyWithRel())
 885     return ".rdata";
 886   return ".data";
 887 }
 888
 889 MCSection *TargetLoweringObjectFileCOFF::SelectSectionForGlobal(
 890     const GlobalValue *GV, SectionKind Kind, Mangler &Mang,
 891     const TargetMachine &TM) const {
 892   // If we have -ffunction-sections then we should emit the global value to a
 893   // uniqued section specifically for it.
 894   bool EmitUniquedSection;
 895   if (Kind.isText())
 896     EmitUniquedSection = TM.getFunctionSections();
 897   else
 898     EmitUniquedSection = TM.getDataSections();
 899
 900   if ((EmitUniquedSection && !Kind.isCommon()) || GV->hasComdat()) {
 901     const char *Name = getCOFFSectionNameForUniqueGlobal(Kind);
 902     unsigned Characteristics = getCOFFSectionFlags(Kind);
 903
 904     Characteristics |= COFF::IMAGE_SCN_LNK_COMDAT;
 905     int Selection = getSelectionForCOFF(GV);
 906     if (!Selection)
 907       Selection = COFF::IMAGE_COMDAT_SELECT_NODUPLICATES;
 908     const GlobalValue *ComdatGV;
 909     if (GV->hasComdat())
 910       ComdatGV = getComdatGVForCOFF(GV);
 911     else
 912       ComdatGV = GV;
 913
 914     if (!ComdatGV->hasPrivateLinkage()) {
 915       MCSymbol *Sym = TM.getSymbol(ComdatGV, Mang);
 916       StringRef COMDATSymName = Sym->getName();
 917       return getContext().getCOFFSection(Name, Characteristics, Kind,
 918                                          COMDATSymName, Selection);
 919     } else {
 920       SmallString<256> TmpData;
 921       getNameWithPrefix(TmpData, GV, /*CannotUsePrivateLabel=*/true, Mang, TM);
 922       return getContext().getCOFFSection(Name, Characteristics, Kind, TmpData,
 923                                          Selection);
 924     }
 925   }
 926
 927   if (Kind.isText())
 928     return TextSection;
 929
 930   if (Kind.isThreadLocal())
 931     return TLSDataSection;
 932
 933   if (Kind.isReadOnly() || Kind.isReadOnlyWithRel())
 934     return ReadOnlySection;
 935
 936   // Note: we claim that common symbols are put in BSSSection, but they are
 937   // really emitted with the magic .comm directive, which creates a symbol table
 938   // entry but not a section.
 939   if (Kind.isBSS() || Kind.isCommon())
 940     return BSSSection;
 941
 942   return DataSection;
 943 }
 944
 945 void TargetLoweringObjectFileCOFF::getNameWithPrefix(
 946     SmallVectorImpl<char> &OutName, const GlobalValue *GV,
 947     bool CannotUsePrivateLabel, Mangler &Mang, const TargetMachine &TM) const {
 948   if (GV->hasPrivateLinkage() &&
 949       ((isa<Function>(GV) && TM.getFunctionSections()) ||
 950        (isa<GlobalVariable>(GV) && TM.getDataSections())))
 951     CannotUsePrivateLabel = true;
 952
 953   Mang.getNameWithPrefix(OutName, GV, CannotUsePrivateLabel);
 954 }
 955
 956 MCSection *TargetLoweringObjectFileCOFF::getSectionForJumpTable(
 957     const Function &F, Mangler &Mang, const TargetMachine &TM) const {
 958   // If the function can be removed, produce a unique section so that
 959   // the table doesn't prevent the removal.
 960   const Comdat *C = F.getComdat();
 961   bool EmitUniqueSection = TM.getFunctionSections() || C;
 962   if (!EmitUniqueSection)
 963     return ReadOnlySection;
 964
 965   // FIXME: we should produce a symbol for F instead.
 966   if (F.hasPrivateLinkage())
 967     return ReadOnlySection;
 968
 969   MCSymbol *Sym = TM.getSymbol(&F, Mang);
 970   StringRef COMDATSymName = Sym->getName();
 971
 972   SectionKind Kind = SectionKind::getReadOnly();
 973   const char *Name = getCOFFSectionNameForUniqueGlobal(Kind);
 974   unsigned Characteristics = getCOFFSectionFlags(Kind);
 975   Characteristics |= COFF::IMAGE_SCN_LNK_COMDAT;
 976
 977   return getContext().getCOFFSection(Name, Characteristics, Kind, COMDATSymName,
 978                                      COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE);
 979 }
 980
 981 void TargetLoweringObjectFileCOFF::
 982 emitModuleFlags(MCStreamer &Streamer,
 983                 ArrayRef<Module::ModuleFlagEntry> ModuleFlags,
 984                 Mangler &Mang, const TargetMachine &TM) const {
 985   MDNode *LinkerOptions = nullptr;
 986
 987   // Look for the "Linker Options" flag, since it's the only one we support.
 988   for (ArrayRef<Module::ModuleFlagEntry>::iterator
 989        i = ModuleFlags.begin(), e = ModuleFlags.end(); i != e; ++i) {
 990     const Module::ModuleFlagEntry &MFE = *i;
 991     StringRef Key = MFE.Key->getString();
 992     Metadata *Val = MFE.Val;
 993     if (Key == "Linker Options") {
 994       LinkerOptions = cast<MDNode>(Val);
 995       break;
 996     }
 997   }
 998   if (!LinkerOptions)
 999     return;
1000
1001   // Emit the linker options to the linker .drectve section.  According to the
1002   // spec, this section is a space-separated string containing flags for linker.
1003   MCSection *Sec = getDrectveSection();
1004   Streamer.SwitchSection(Sec);
1005   for (unsigned i = 0, e = LinkerOptions->getNumOperands(); i != e; ++i) {
1006     MDNode *MDOptions = cast<MDNode>(LinkerOptions->getOperand(i));
1007     for (unsigned ii = 0, ie = MDOptions->getNumOperands(); ii != ie; ++ii) {
1008       MDString *MDOption = cast<MDString>(MDOptions->getOperand(ii));
1009       // Lead with a space for consistency with our dllexport implementation.
1010       std::string Directive(" ");
1011       Directive.append(MDOption->getString());
1012       Streamer.EmitBytes(Directive);
1013     }
1014   }
1015 }
1016
1017 MCSection *TargetLoweringObjectFileCOFF::getStaticCtorSection(
1018     unsigned Priority, const MCSymbol *KeySym) const {
1019   return getContext().getAssociativeCOFFSection(
1020       cast<MCSectionCOFF>(StaticCtorSection), KeySym);
1021 }
1022
1023 MCSection *TargetLoweringObjectFileCOFF::getStaticDtorSection(
1024     unsigned Priority, const MCSymbol *KeySym) const {
1025   return getContext().getAssociativeCOFFSection(
1026       cast<MCSectionCOFF>(StaticDtorSection), KeySym);
1027 }
1028
1029 void TargetLoweringObjectFileCOFF::emitLinkerFlagsForGlobal(
1030     raw_ostream &OS, const GlobalValue *GV, const Mangler &Mang) const {
1031   if (!GV->hasDLLExportStorageClass() || GV->isDeclaration())
1032     return;
1033
1034   const Triple &TT = getTargetTriple();
1035
1036   if (TT.isKnownWindowsMSVCEnvironment())
1037     OS << " /EXPORT:";
1038   else
1039     OS << " -export:";
1040
1041   if (TT.isWindowsGNUEnvironment() || TT.isWindowsCygwinEnvironment()) {
1042     std::string Flag;
1043     raw_string_ostream FlagOS(Flag);
1044     Mang.getNameWithPrefix(FlagOS, GV, false);
1045     FlagOS.flush();
1046     if (Flag[0] == GV->getParent()->getDataLayout().getGlobalPrefix())
1047       OS << Flag.substr(1);
1048     else
1049       OS << Flag;
1050   } else {
1051     Mang.getNameWithPrefix(OS, GV, false);
1052   }
1053
1054   if (!GV->getValueType()->isFunctionTy()) {
1055     if (TT.isKnownWindowsMSVCEnvironment())
1056       OS << ",DATA";
1057     else
1058       OS << ",data";
1059   }
1060 }