lib/Target/ARM/MCTargetDesc/ARMELFStreamer.cpp

   1 //===- lib/MC/ARMELFStreamer.cpp - ELF Object Output for ARM --------------===//
   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 assembles .s files and emits ARM ELF .o object files. Different
  11 // from generic ELF streamer in emitting mapping symbols ($a, $t and $d) to
  12 // delimit regions of data and code.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #include "ARMRegisterInfo.h"
  17 #include "ARMUnwindOpAsm.h"
  18 #include "llvm/ADT/StringExtras.h"
  19 #include "llvm/ADT/Twine.h"
  20 #include "llvm/MC/MCAsmBackend.h"
  21 #include "llvm/MC/MCAsmInfo.h"
  22 #include "llvm/MC/MCAssembler.h"
  23 #include "llvm/MC/MCCodeEmitter.h"
  24 #include "llvm/MC/MCContext.h"
  25 #include "llvm/MC/MCELFStreamer.h"
  26 #include "llvm/MC/MCExpr.h"
  27 #include "llvm/MC/MCInst.h"
  28 #include "llvm/MC/MCInstPrinter.h"
  29 #include "llvm/MC/MCObjectFileInfo.h"
  30 #include "llvm/MC/MCObjectStreamer.h"
  31 #include "llvm/MC/MCRegisterInfo.h"
  32 #include "llvm/MC/MCSection.h"
  33 #include "llvm/MC/MCSectionELF.h"
  34 #include "llvm/MC/MCStreamer.h"
  35 #include "llvm/MC/MCSymbolELF.h"
  36 #include "llvm/MC/MCValue.h"
  37 #include "llvm/Support/ARMBuildAttributes.h"
  38 #include "llvm/Support/ARMEHABI.h"
  39 #include "llvm/Support/TargetParser.h"
  40 #include "llvm/Support/Debug.h"
  41 #include "llvm/Support/ELF.h"
  42 #include "llvm/Support/FormattedStream.h"
  43 #include "llvm/Support/LEB128.h"
  44 #include "llvm/Support/raw_ostream.h"
  45 #include <algorithm>
  46
  47 using namespace llvm;
  48
  49 static std::string GetAEABIUnwindPersonalityName(unsigned Index) {
  50   assert(Index < ARM::EHABI::NUM_PERSONALITY_INDEX &&
  51          "Invalid personality index");
  52   return (Twine("__aeabi_unwind_cpp_pr") + Twine(Index)).str();
  53 }
  54
  55 namespace {
  56
  57 class ARMELFStreamer;
  58
  59 class ARMTargetAsmStreamer : public ARMTargetStreamer {
  60   formatted_raw_ostream &OS;
  61   MCInstPrinter &InstPrinter;
  62   bool IsVerboseAsm;
  63
  64   void emitFnStart() override;
  65   void emitFnEnd() override;
  66   void emitCantUnwind() override;
  67   void emitPersonality(const MCSymbol *Personality) override;
  68   void emitPersonalityIndex(unsigned Index) override;
  69   void emitHandlerData() override;
  70   void emitSetFP(unsigned FpReg, unsigned SpReg, int64_t Offset = 0) override;
  71   void emitMovSP(unsigned Reg, int64_t Offset = 0) override;
  72   void emitPad(int64_t Offset) override;
  73   void emitRegSave(const SmallVectorImpl<unsigned> &RegList,
  74                    bool isVector) override;
  75   void emitUnwindRaw(int64_t Offset,
  76                      const SmallVectorImpl<uint8_t> &Opcodes) override;
  77
  78   void switchVendor(StringRef Vendor) override;
  79   void emitAttribute(unsigned Attribute, unsigned Value) override;
  80   void emitTextAttribute(unsigned Attribute, StringRef String) override;
  81   void emitIntTextAttribute(unsigned Attribute, unsigned IntValue,
  82                             StringRef StrinValue) override;
  83   void emitArch(unsigned Arch) override;
  84   void emitArchExtension(unsigned ArchExt) override;
  85   void emitObjectArch(unsigned Arch) override;
  86   void emitFPU(unsigned FPU) override;
  87   void emitInst(uint32_t Inst, char Suffix = '\0') override;
  88   void finishAttributeSection() override;
  89
  90   void AnnotateTLSDescriptorSequence(const MCSymbolRefExpr *SRE) override;
  91   void emitThumbSet(MCSymbol *Symbol, const MCExpr *Value) override;
  92
  93 public:
  94   ARMTargetAsmStreamer(MCStreamer &S, formatted_raw_ostream &OS,
  95                        MCInstPrinter &InstPrinter, bool VerboseAsm);
  96 };
  97
  98 ARMTargetAsmStreamer::ARMTargetAsmStreamer(MCStreamer &S,
  99                                            formatted_raw_ostream &OS,
 100                                            MCInstPrinter &InstPrinter,
 101                                            bool VerboseAsm)
 102     : ARMTargetStreamer(S), OS(OS), InstPrinter(InstPrinter),
 103       IsVerboseAsm(VerboseAsm) {}
 104 void ARMTargetAsmStreamer::emitFnStart() { OS << "\t.fnstart\n"; }
 105 void ARMTargetAsmStreamer::emitFnEnd() { OS << "\t.fnend\n"; }
 106 void ARMTargetAsmStreamer::emitCantUnwind() { OS << "\t.cantunwind\n"; }
 107 void ARMTargetAsmStreamer::emitPersonality(const MCSymbol *Personality) {
 108   OS << "\t.personality " << Personality->getName() << '\n';
 109 }
 110 void ARMTargetAsmStreamer::emitPersonalityIndex(unsigned Index) {
 111   OS << "\t.personalityindex " << Index << '\n';
 112 }
 113 void ARMTargetAsmStreamer::emitHandlerData() { OS << "\t.handlerdata\n"; }
 114 void ARMTargetAsmStreamer::emitSetFP(unsigned FpReg, unsigned SpReg,
 115                                      int64_t Offset) {
 116   OS << "\t.setfp\t";
 117   InstPrinter.printRegName(OS, FpReg);
 118   OS << ", ";
 119   InstPrinter.printRegName(OS, SpReg);
 120   if (Offset)
 121     OS << ", #" << Offset;
 122   OS << '\n';
 123 }
 124 void ARMTargetAsmStreamer::emitMovSP(unsigned Reg, int64_t Offset) {
 125   assert((Reg != ARM::SP && Reg != ARM::PC) &&
 126          "the operand of .movsp cannot be either sp or pc");
 127
 128   OS << "\t.movsp\t";
 129   InstPrinter.printRegName(OS, Reg);
 130   if (Offset)
 131     OS << ", #" << Offset;
 132   OS << '\n';
 133 }
 134 void ARMTargetAsmStreamer::emitPad(int64_t Offset) {
 135   OS << "\t.pad\t#" << Offset << '\n';
 136 }
 137 void ARMTargetAsmStreamer::emitRegSave(const SmallVectorImpl<unsigned> &RegList,
 138                                        bool isVector) {
 139   assert(RegList.size() && "RegList should not be empty");
 140   if (isVector)
 141     OS << "\t.vsave\t{";
 142   else
 143     OS << "\t.save\t{";
 144
 145   InstPrinter.printRegName(OS, RegList[0]);
 146
 147   for (unsigned i = 1, e = RegList.size(); i != e; ++i) {
 148     OS << ", ";
 149     InstPrinter.printRegName(OS, RegList[i]);
 150   }
 151
 152   OS << "}\n";
 153 }
 154 void ARMTargetAsmStreamer::switchVendor(StringRef Vendor) {
 155 }
 156 void ARMTargetAsmStreamer::emitAttribute(unsigned Attribute, unsigned Value) {
 157   OS << "\t.eabi_attribute\t" << Attribute << ", " << Twine(Value);
 158   if (IsVerboseAsm) {
 159     StringRef Name = ARMBuildAttrs::AttrTypeAsString(Attribute);
 160     if (!Name.empty())
 161       OS << "\t@ " << Name;
 162   }
 163   OS << "\n";
 164 }
 165 void ARMTargetAsmStreamer::emitTextAttribute(unsigned Attribute,
 166                                              StringRef String) {
 167   switch (Attribute) {
 168   case ARMBuildAttrs::CPU_name:
 169     OS << "\t.cpu\t" << String.lower();
 170     break;
 171   default:
 172     OS << "\t.eabi_attribute\t" << Attribute << ", \"" << String << "\"";
 173     if (IsVerboseAsm) {
 174       StringRef Name = ARMBuildAttrs::AttrTypeAsString(Attribute);
 175       if (!Name.empty())
 176         OS << "\t@ " << Name;
 177     }
 178     break;
 179   }
 180   OS << "\n";
 181 }
 182 void ARMTargetAsmStreamer::emitIntTextAttribute(unsigned Attribute,
 183                                                 unsigned IntValue,
 184                                                 StringRef StringValue) {
 185   switch (Attribute) {
 186   default: llvm_unreachable("unsupported multi-value attribute in asm mode");
 187   case ARMBuildAttrs::compatibility:
 188     OS << "\t.eabi_attribute\t" << Attribute << ", " << IntValue;
 189     if (!StringValue.empty())
 190       OS << ", \"" << StringValue << "\"";
 191     if (IsVerboseAsm)
 192       OS << "\t@ " << ARMBuildAttrs::AttrTypeAsString(Attribute);
 193     break;
 194   }
 195   OS << "\n";
 196 }
 197 void ARMTargetAsmStreamer::emitArch(unsigned Arch) {
 198   OS << "\t.arch\t" << ARM::getArchName(Arch) << "\n";
 199 }
 200 void ARMTargetAsmStreamer::emitArchExtension(unsigned ArchExt) {
 201   OS << "\t.arch_extension\t" << ARM::getArchExtName(ArchExt) << "\n";
 202 }
 203 void ARMTargetAsmStreamer::emitObjectArch(unsigned Arch) {
 204   OS << "\t.object_arch\t" << ARM::getArchName(Arch) << '\n';
 205 }
 206 void ARMTargetAsmStreamer::emitFPU(unsigned FPU) {
 207   OS << "\t.fpu\t" << ARM::getFPUName(FPU) << "\n";
 208 }
 209 void ARMTargetAsmStreamer::finishAttributeSection() {
 210 }
 211 void
 212 ARMTargetAsmStreamer::AnnotateTLSDescriptorSequence(const MCSymbolRefExpr *S) {
 213   OS << "\t.tlsdescseq\t" << S->getSymbol().getName();
 214 }
 215
 216 void ARMTargetAsmStreamer::emitThumbSet(MCSymbol *Symbol, const MCExpr *Value) {
 217   const MCAsmInfo *MAI = Streamer.getContext().getAsmInfo();
 218
 219   OS << "\t.thumb_set\t";
 220   Symbol->print(OS, MAI);
 221   OS << ", ";
 222   Value->print(OS, MAI);
 223   OS << '\n';
 224 }
 225
 226 void ARMTargetAsmStreamer::emitInst(uint32_t Inst, char Suffix) {
 227   OS << "\t.inst";
 228   if (Suffix)
 229     OS << "." << Suffix;
 230   OS << "\t0x" << Twine::utohexstr(Inst) << "\n";
 231 }
 232
 233 void ARMTargetAsmStreamer::emitUnwindRaw(int64_t Offset,
 234                                       const SmallVectorImpl<uint8_t> &Opcodes) {
 235   OS << "\t.unwind_raw " << Offset;
 236   for (SmallVectorImpl<uint8_t>::const_iterator OCI = Opcodes.begin(),
 237                                                 OCE = Opcodes.end();
 238        OCI != OCE; ++OCI)
 239     OS << ", 0x" << Twine::utohexstr(*OCI);
 240   OS << '\n';
 241 }
 242
 243 class ARMTargetELFStreamer : public ARMTargetStreamer {
 244 private:
 245   // This structure holds all attributes, accounting for
 246   // their string/numeric value, so we can later emmit them
 247   // in declaration order, keeping all in the same vector
 248   struct AttributeItem {
 249     enum {
 250       HiddenAttribute = 0,
 251       NumericAttribute,
 252       TextAttribute,
 253       NumericAndTextAttributes
 254     } Type;
 255     unsigned Tag;
 256     unsigned IntValue;
 257     StringRef StringValue;
 258
 259     static bool LessTag(const AttributeItem &LHS, const AttributeItem &RHS) {
 260       // The conformance tag must be emitted first when serialised
 261       // into an object file. Specifically, the addenda to the ARM ABI
 262       // states that (2.3.7.4):
 263       //
 264       // "To simplify recognition by consumers in the common case of
 265       // claiming conformity for the whole file, this tag should be
 266       // emitted first in a file-scope sub-subsection of the first
 267       // public subsection of the attributes section."
 268       //
 269       // So it is special-cased in this comparison predicate when the
 270       // attributes are sorted in finishAttributeSection().
 271       return (RHS.Tag != ARMBuildAttrs::conformance) &&
 272              ((LHS.Tag == ARMBuildAttrs::conformance) || (LHS.Tag < RHS.Tag));
 273     }
 274   };
 275
 276   StringRef CurrentVendor;
 277   unsigned FPU;
 278   unsigned Arch;
 279   unsigned EmittedArch;
 280   SmallVector<AttributeItem, 64> Contents;
 281
 282   MCSection *AttributeSection;
 283
 284   AttributeItem *getAttributeItem(unsigned Attribute) {
 285     for (size_t i = 0; i < Contents.size(); ++i)
 286       if (Contents[i].Tag == Attribute)
 287         return &Contents[i];
 288     return nullptr;
 289   }
 290
 291   void setAttributeItem(unsigned Attribute, unsigned Value,
 292                         bool OverwriteExisting) {
 293     // Look for existing attribute item
 294     if (AttributeItem *Item = getAttributeItem(Attribute)) {
 295       if (!OverwriteExisting)
 296         return;
 297       Item->Type = AttributeItem::NumericAttribute;
 298       Item->IntValue = Value;
 299       return;
 300     }
 301
 302     // Create new attribute item
 303     AttributeItem Item = {
 304       AttributeItem::NumericAttribute,
 305       Attribute,
 306       Value,
 307       StringRef("")
 308     };
 309     Contents.push_back(Item);
 310   }
 311
 312   void setAttributeItem(unsigned Attribute, StringRef Value,
 313                         bool OverwriteExisting) {
 314     // Look for existing attribute item
 315     if (AttributeItem *Item = getAttributeItem(Attribute)) {
 316       if (!OverwriteExisting)
 317         return;
 318       Item->Type = AttributeItem::TextAttribute;
 319       Item->StringValue = Value;
 320       return;
 321     }
 322
 323     // Create new attribute item
 324     AttributeItem Item = {
 325       AttributeItem::TextAttribute,
 326       Attribute,
 327       0,
 328       Value
 329     };
 330     Contents.push_back(Item);
 331   }
 332
 333   void setAttributeItems(unsigned Attribute, unsigned IntValue,
 334                          StringRef StringValue, bool OverwriteExisting) {
 335     // Look for existing attribute item
 336     if (AttributeItem *Item = getAttributeItem(Attribute)) {
 337       if (!OverwriteExisting)
 338         return;
 339       Item->Type = AttributeItem::NumericAndTextAttributes;
 340       Item->IntValue = IntValue;
 341       Item->StringValue = StringValue;
 342       return;
 343     }
 344
 345     // Create new attribute item
 346     AttributeItem Item = {
 347       AttributeItem::NumericAndTextAttributes,
 348       Attribute,
 349       IntValue,
 350       StringValue
 351     };
 352     Contents.push_back(Item);
 353   }
 354
 355   void emitArchDefaultAttributes();
 356   void emitFPUDefaultAttributes();
 357
 358   ARMELFStreamer &getStreamer();
 359
 360   void emitFnStart() override;
 361   void emitFnEnd() override;
 362   void emitCantUnwind() override;
 363   void emitPersonality(const MCSymbol *Personality) override;
 364   void emitPersonalityIndex(unsigned Index) override;
 365   void emitHandlerData() override;
 366   void emitSetFP(unsigned FpReg, unsigned SpReg, int64_t Offset = 0) override;
 367   void emitMovSP(unsigned Reg, int64_t Offset = 0) override;
 368   void emitPad(int64_t Offset) override;
 369   void emitRegSave(const SmallVectorImpl<unsigned> &RegList,
 370                    bool isVector) override;
 371   void emitUnwindRaw(int64_t Offset,
 372                      const SmallVectorImpl<uint8_t> &Opcodes) override;
 373
 374   void switchVendor(StringRef Vendor) override;
 375   void emitAttribute(unsigned Attribute, unsigned Value) override;
 376   void emitTextAttribute(unsigned Attribute, StringRef String) override;
 377   void emitIntTextAttribute(unsigned Attribute, unsigned IntValue,
 378                             StringRef StringValue) override;
 379   void emitArch(unsigned Arch) override;
 380   void emitObjectArch(unsigned Arch) override;
 381   void emitFPU(unsigned FPU) override;
 382   void emitInst(uint32_t Inst, char Suffix = '\0') override;
 383   void finishAttributeSection() override;
 384   void emitLabel(MCSymbol *Symbol) override;
 385
 386   void AnnotateTLSDescriptorSequence(const MCSymbolRefExpr *SRE) override;
 387   void emitThumbSet(MCSymbol *Symbol, const MCExpr *Value) override;
 388
 389   size_t calculateContentSize() const;
 390
 391 public:
 392   ARMTargetELFStreamer(MCStreamer &S)
 393     : ARMTargetStreamer(S), CurrentVendor("aeabi"), FPU(ARM::FK_INVALID),
 394       Arch(ARM::AK_INVALID), EmittedArch(ARM::AK_INVALID),
 395       AttributeSection(nullptr) {}
 396 };
 397
 398 /// Extend the generic ELFStreamer class so that it can emit mapping symbols at
 399 /// the appropriate points in the object files. These symbols are defined in the
 400 /// ARM ELF ABI: infocenter.arm.com/help/topic/com.arm.../IHI0044D_aaelf.pdf.
 401 ///
 402 /// In brief: $a, $t or $d should be emitted at the start of each contiguous
 403 /// region of ARM code, Thumb code or data in a section. In practice, this
 404 /// emission does not rely on explicit assembler directives but on inherent
 405 /// properties of the directives doing the emission (e.g. ".byte" is data, "add
 406 /// r0, r0, r0" an instruction).
 407 ///
 408 /// As a result this system is orthogonal to the DataRegion infrastructure used
 409 /// by MachO. Beware!
 410 class ARMELFStreamer : public MCELFStreamer {
 411 public:
 412   friend class ARMTargetELFStreamer;
 413
 414   ARMELFStreamer(MCContext &Context, MCAsmBackend &TAB, raw_pwrite_stream &OS,
 415                  MCCodeEmitter *Emitter, bool IsThumb)
 416       : MCELFStreamer(Context, TAB, OS, Emitter), IsThumb(IsThumb),
 417         MappingSymbolCounter(0), LastEMS(EMS_None) {
 418     Reset();
 419   }
 420
 421   ~ARMELFStreamer() {}
 422
 423   void FinishImpl() override;
 424
 425   // ARM exception handling directives
 426   void emitFnStart();
 427   void emitFnEnd();
 428   void emitCantUnwind();
 429   void emitPersonality(const MCSymbol *Per);
 430   void emitPersonalityIndex(unsigned index);
 431   void emitHandlerData();
 432   void emitSetFP(unsigned NewFpReg, unsigned NewSpReg, int64_t Offset = 0);
 433   void emitMovSP(unsigned Reg, int64_t Offset = 0);
 434   void emitPad(int64_t Offset);
 435   void emitRegSave(const SmallVectorImpl<unsigned> &RegList, bool isVector);
 436   void emitUnwindRaw(int64_t Offset, const SmallVectorImpl<uint8_t> &Opcodes);
 437
 438   void ChangeSection(MCSection *Section, const MCExpr *Subsection) override {
 439     // We have to keep track of the mapping symbol state of any sections we
 440     // use. Each one should start off as EMS_None, which is provided as the
 441     // default constructor by DenseMap::lookup.
 442     LastMappingSymbols[getPreviousSection().first] = LastEMS;
 443     LastEMS = LastMappingSymbols.lookup(Section);
 444
 445     MCELFStreamer::ChangeSection(Section, Subsection);
 446   }
 447
 448   /// This function is the one used to emit instruction data into the ELF
 449   /// streamer. We override it to add the appropriate mapping symbol if
 450   /// necessary.
 451   void EmitInstruction(const MCInst& Inst,
 452                        const MCSubtargetInfo &STI) override {
 453     if (IsThumb)
 454       EmitThumbMappingSymbol();
 455     else
 456       EmitARMMappingSymbol();
 457
 458     MCELFStreamer::EmitInstruction(Inst, STI);
 459   }
 460
 461   void emitInst(uint32_t Inst, char Suffix) {
 462     unsigned Size;
 463     char Buffer[4];
 464     const bool LittleEndian = getContext().getAsmInfo()->isLittleEndian();
 465
 466     switch (Suffix) {
 467     case '\0':
 468       Size = 4;
 469
 470       assert(!IsThumb);
 471       EmitARMMappingSymbol();
 472       for (unsigned II = 0, IE = Size; II != IE; II++) {
 473         const unsigned I = LittleEndian ? (Size - II - 1) : II;
 474         Buffer[Size - II - 1] = uint8_t(Inst >> I * CHAR_BIT);
 475       }
 476
 477       break;
 478     case 'n':
 479     case 'w':
 480       Size = (Suffix == 'n' ? 2 : 4);
 481
 482       assert(IsThumb);
 483       EmitThumbMappingSymbol();
 484       for (unsigned II = 0, IE = Size; II != IE; II = II + 2) {
 485         const unsigned I0 = LittleEndian ? II + 0 : (Size - II - 1);
 486         const unsigned I1 = LittleEndian ? II + 1 : (Size - II - 2);
 487         Buffer[Size - II - 2] = uint8_t(Inst >> I0 * CHAR_BIT);
 488         Buffer[Size - II - 1] = uint8_t(Inst >> I1 * CHAR_BIT);
 489       }
 490
 491       break;
 492     default:
 493       llvm_unreachable("Invalid Suffix");
 494     }
 495
 496     MCELFStreamer::EmitBytes(StringRef(Buffer, Size));
 497   }
 498
 499   /// This is one of the functions used to emit data into an ELF section, so the
 500   /// ARM streamer overrides it to add the appropriate mapping symbol ($d) if
 501   /// necessary.
 502   void EmitBytes(StringRef Data) override {
 503     EmitDataMappingSymbol();
 504     MCELFStreamer::EmitBytes(Data);
 505   }
 506
 507   /// This is one of the functions used to emit data into an ELF section, so the
 508   /// ARM streamer overrides it to add the appropriate mapping symbol ($d) if
 509   /// necessary.
 510   void EmitValueImpl(const MCExpr *Value, unsigned Size, SMLoc Loc) override {
 511     if (const MCSymbolRefExpr *SRE = dyn_cast_or_null<MCSymbolRefExpr>(Value))
 512       if (SRE->getKind() == MCSymbolRefExpr::VK_ARM_SBREL && !(Size == 4))
 513         getContext().reportFatalError(Loc, "relocated expression must be 32-bit");
 514
 515     EmitDataMappingSymbol();
 516     MCELFStreamer::EmitValueImpl(Value, Size);
 517   }
 518
 519   void EmitAssemblerFlag(MCAssemblerFlag Flag) override {
 520     MCELFStreamer::EmitAssemblerFlag(Flag);
 521
 522     switch (Flag) {
 523     case MCAF_SyntaxUnified:
 524       return; // no-op here.
 525     case MCAF_Code16:
 526       IsThumb = true;
 527       return; // Change to Thumb mode
 528     case MCAF_Code32:
 529       IsThumb = false;
 530       return; // Change to ARM mode
 531     case MCAF_Code64:
 532       return;
 533     case MCAF_SubsectionsViaSymbols:
 534       return;
 535     }
 536   }
 537
 538 private:
 539   enum ElfMappingSymbol {
 540     EMS_None,
 541     EMS_ARM,
 542     EMS_Thumb,
 543     EMS_Data
 544   };
 545
 546   void EmitDataMappingSymbol() {
 547     if (LastEMS == EMS_Data) return;
 548     EmitMappingSymbol("$d");
 549     LastEMS = EMS_Data;
 550   }
 551
 552   void EmitThumbMappingSymbol() {
 553     if (LastEMS == EMS_Thumb) return;
 554     EmitMappingSymbol("$t");
 555     LastEMS = EMS_Thumb;
 556   }
 557
 558   void EmitARMMappingSymbol() {
 559     if (LastEMS == EMS_ARM) return;
 560     EmitMappingSymbol("$a");
 561     LastEMS = EMS_ARM;
 562   }
 563
 564   void EmitMappingSymbol(StringRef Name) {
 565     auto *Symbol = cast<MCSymbolELF>(getContext().getOrCreateSymbol(
 566         Name + "." + Twine(MappingSymbolCounter++)));
 567     EmitLabel(Symbol);
 568
 569     Symbol->setType(ELF::STT_NOTYPE);
 570     Symbol->setBinding(ELF::STB_LOCAL);
 571     Symbol->setExternal(false);
 572   }
 573
 574   void EmitThumbFunc(MCSymbol *Func) override {
 575     getAssembler().setIsThumbFunc(Func);
 576     EmitSymbolAttribute(Func, MCSA_ELF_TypeFunction);
 577   }
 578
 579   // Helper functions for ARM exception handling directives
 580   void Reset();
 581
 582   void EmitPersonalityFixup(StringRef Name);
 583   void FlushPendingOffset();
 584   void FlushUnwindOpcodes(bool NoHandlerData);
 585
 586   void SwitchToEHSection(const char *Prefix, unsigned Type, unsigned Flags,
 587                          SectionKind Kind, const MCSymbol &Fn);
 588   void SwitchToExTabSection(const MCSymbol &FnStart);
 589   void SwitchToExIdxSection(const MCSymbol &FnStart);
 590
 591   void EmitFixup(const MCExpr *Expr, MCFixupKind Kind);
 592
 593   bool IsThumb;
 594   int64_t MappingSymbolCounter;
 595
 596   DenseMap<const MCSection *, ElfMappingSymbol> LastMappingSymbols;
 597   ElfMappingSymbol LastEMS;
 598
 599   // ARM Exception Handling Frame Information
 600   MCSymbol *ExTab;
 601   MCSymbol *FnStart;
 602   const MCSymbol *Personality;
 603   unsigned PersonalityIndex;
 604   unsigned FPReg; // Frame pointer register
 605   int64_t FPOffset; // Offset: (final frame pointer) - (initial $sp)
 606   int64_t SPOffset; // Offset: (final $sp) - (initial $sp)
 607   int64_t PendingOffset; // Offset: (final $sp) - (emitted $sp)
 608   bool UsedFP;
 609   bool CantUnwind;
 610   SmallVector<uint8_t, 64> Opcodes;
 611   UnwindOpcodeAssembler UnwindOpAsm;
 612 };
 613 } // end anonymous namespace
 614
 615 ARMELFStreamer &ARMTargetELFStreamer::getStreamer() {
 616   return static_cast<ARMELFStreamer &>(Streamer);
 617 }
 618
 619 void ARMTargetELFStreamer::emitFnStart() { getStreamer().emitFnStart(); }
 620 void ARMTargetELFStreamer::emitFnEnd() { getStreamer().emitFnEnd(); }
 621 void ARMTargetELFStreamer::emitCantUnwind() { getStreamer().emitCantUnwind(); }
 622 void ARMTargetELFStreamer::emitPersonality(const MCSymbol *Personality) {
 623   getStreamer().emitPersonality(Personality);
 624 }
 625 void ARMTargetELFStreamer::emitPersonalityIndex(unsigned Index) {
 626   getStreamer().emitPersonalityIndex(Index);
 627 }
 628 void ARMTargetELFStreamer::emitHandlerData() {
 629   getStreamer().emitHandlerData();
 630 }
 631 void ARMTargetELFStreamer::emitSetFP(unsigned FpReg, unsigned SpReg,
 632                                      int64_t Offset) {
 633   getStreamer().emitSetFP(FpReg, SpReg, Offset);
 634 }
 635 void ARMTargetELFStreamer::emitMovSP(unsigned Reg, int64_t Offset) {
 636   getStreamer().emitMovSP(Reg, Offset);
 637 }
 638 void ARMTargetELFStreamer::emitPad(int64_t Offset) {
 639   getStreamer().emitPad(Offset);
 640 }
 641 void ARMTargetELFStreamer::emitRegSave(const SmallVectorImpl<unsigned> &RegList,
 642                                        bool isVector) {
 643   getStreamer().emitRegSave(RegList, isVector);
 644 }
 645 void ARMTargetELFStreamer::emitUnwindRaw(int64_t Offset,
 646                                       const SmallVectorImpl<uint8_t> &Opcodes) {
 647   getStreamer().emitUnwindRaw(Offset, Opcodes);
 648 }
 649 void ARMTargetELFStreamer::switchVendor(StringRef Vendor) {
 650   assert(!Vendor.empty() && "Vendor cannot be empty.");
 651
 652   if (CurrentVendor == Vendor)
 653     return;
 654
 655   if (!CurrentVendor.empty())
 656     finishAttributeSection();
 657
 658   assert(Contents.empty() &&
 659          ".ARM.attributes should be flushed before changing vendor");
 660   CurrentVendor = Vendor;
 661
 662 }
 663 void ARMTargetELFStreamer::emitAttribute(unsigned Attribute, unsigned Value) {
 664   setAttributeItem(Attribute, Value, /* OverwriteExisting= */ true);
 665 }
 666 void ARMTargetELFStreamer::emitTextAttribute(unsigned Attribute,
 667                                              StringRef Value) {
 668   setAttributeItem(Attribute, Value, /* OverwriteExisting= */ true);
 669 }
 670 void ARMTargetELFStreamer::emitIntTextAttribute(unsigned Attribute,
 671                                                 unsigned IntValue,
 672                                                 StringRef StringValue) {
 673   setAttributeItems(Attribute, IntValue, StringValue,
 674                     /* OverwriteExisting= */ true);
 675 }
 676 void ARMTargetELFStreamer::emitArch(unsigned Value) {
 677   Arch = Value;
 678 }
 679 void ARMTargetELFStreamer::emitObjectArch(unsigned Value) {
 680   EmittedArch = Value;
 681 }
 682 void ARMTargetELFStreamer::emitArchDefaultAttributes() {
 683   using namespace ARMBuildAttrs;
 684
 685   setAttributeItem(CPU_name,
 686                    ARM::getCPUAttr(Arch),
 687                    false);
 688
 689   if (EmittedArch == ARM::AK_INVALID)
 690     setAttributeItem(CPU_arch,
 691                      ARM::getArchAttr(Arch),
 692                      false);
 693   else
 694     setAttributeItem(CPU_arch,
 695                      ARM::getArchAttr(EmittedArch),
 696                      false);
 697
 698   switch (Arch) {
 699   case ARM::AK_ARMV2:
 700   case ARM::AK_ARMV2A:
 701   case ARM::AK_ARMV3:
 702   case ARM::AK_ARMV3M:
 703   case ARM::AK_ARMV4:
 704   case ARM::AK_ARMV5:
 705     setAttributeItem(ARM_ISA_use, Allowed, false);
 706     break;
 707
 708   case ARM::AK_ARMV4T:
 709   case ARM::AK_ARMV5T:
 710   case ARM::AK_ARMV5TE:
 711   case ARM::AK_ARMV6:
 712   case ARM::AK_ARMV6J:
 713     setAttributeItem(ARM_ISA_use, Allowed, false);
 714     setAttributeItem(THUMB_ISA_use, Allowed, false);
 715     break;
 716
 717   case ARM::AK_ARMV6T2:
 718     setAttributeItem(ARM_ISA_use, Allowed, false);
 719     setAttributeItem(THUMB_ISA_use, AllowThumb32, false);
 720     break;
 721
 722   case ARM::AK_ARMV6K:
 723   case ARM::AK_ARMV6Z:
 724   case ARM::AK_ARMV6ZK:
 725     setAttributeItem(ARM_ISA_use, Allowed, false);
 726     setAttributeItem(THUMB_ISA_use, Allowed, false);
 727     setAttributeItem(Virtualization_use, AllowTZ, false);
 728     break;
 729
 730   case ARM::AK_ARMV6M:
 731     setAttributeItem(THUMB_ISA_use, Allowed, false);
 732     break;
 733
 734   case ARM::AK_ARMV7:
 735     setAttributeItem(THUMB_ISA_use, AllowThumb32, false);
 736     break;
 737
 738   case ARM::AK_ARMV7A:
 739     setAttributeItem(CPU_arch_profile, ApplicationProfile, false);
 740     setAttributeItem(ARM_ISA_use, Allowed, false);
 741     setAttributeItem(THUMB_ISA_use, AllowThumb32, false);
 742     break;
 743
 744   case ARM::AK_ARMV7R:
 745     setAttributeItem(CPU_arch_profile, RealTimeProfile, false);
 746     setAttributeItem(ARM_ISA_use, Allowed, false);
 747     setAttributeItem(THUMB_ISA_use, AllowThumb32, false);
 748     break;
 749
 750   case ARM::AK_ARMV7M:
 751     setAttributeItem(CPU_arch_profile, MicroControllerProfile, false);
 752     setAttributeItem(THUMB_ISA_use, AllowThumb32, false);
 753     break;
 754
 755   case ARM::AK_ARMV8A:
 756   case ARM::AK_ARMV8_1A:
 757     setAttributeItem(CPU_arch_profile, ApplicationProfile, false);
 758     setAttributeItem(ARM_ISA_use, Allowed, false);
 759     setAttributeItem(THUMB_ISA_use, AllowThumb32, false);
 760     setAttributeItem(MPextension_use, Allowed, false);
 761     setAttributeItem(Virtualization_use, AllowTZVirtualization, false);
 762     break;
 763
 764   case ARM::AK_IWMMXT:
 765     setAttributeItem(ARM_ISA_use, Allowed, false);
 766     setAttributeItem(THUMB_ISA_use, Allowed, false);
 767     setAttributeItem(WMMX_arch, AllowWMMXv1, false);
 768     break;
 769
 770   case ARM::AK_IWMMXT2:
 771     setAttributeItem(ARM_ISA_use, Allowed, false);
 772     setAttributeItem(THUMB_ISA_use, Allowed, false);
 773     setAttributeItem(WMMX_arch, AllowWMMXv2, false);
 774     break;
 775
 776   default:
 777     report_fatal_error("Unknown Arch: " + Twine(Arch));
 778     break;
 779   }
 780 }
 781 void ARMTargetELFStreamer::emitFPU(unsigned Value) {
 782   FPU = Value;
 783 }
 784 void ARMTargetELFStreamer::emitFPUDefaultAttributes() {
 785   switch (FPU) {
 786   case ARM::FK_VFP:
 787   case ARM::FK_VFPV2:
 788     setAttributeItem(ARMBuildAttrs::FP_arch,
 789                      ARMBuildAttrs::AllowFPv2,
 790                      /* OverwriteExisting= */ false);
 791     break;
 792
 793   case ARM::FK_VFPV3:
 794     setAttributeItem(ARMBuildAttrs::FP_arch,
 795                      ARMBuildAttrs::AllowFPv3A,
 796                      /* OverwriteExisting= */ false);
 797     break;
 798
 799   case ARM::FK_VFPV3_FP16:
 800     setAttributeItem(ARMBuildAttrs::FP_arch,
 801                      ARMBuildAttrs::AllowFPv3A,
 802                      /* OverwriteExisting= */ false);
 803     setAttributeItem(ARMBuildAttrs::FP_HP_extension,
 804                      ARMBuildAttrs::AllowHPFP,
 805                      /* OverwriteExisting= */ false);
 806     break;
 807
 808   case ARM::FK_VFPV3_D16:
 809     setAttributeItem(ARMBuildAttrs::FP_arch,
 810                      ARMBuildAttrs::AllowFPv3B,
 811                      /* OverwriteExisting= */ false);
 812     break;
 813
 814   case ARM::FK_VFPV3_D16_FP16:
 815     setAttributeItem(ARMBuildAttrs::FP_arch,
 816                      ARMBuildAttrs::AllowFPv3B,
 817                      /* OverwriteExisting= */ false);
 818     setAttributeItem(ARMBuildAttrs::FP_HP_extension,
 819                      ARMBuildAttrs::AllowHPFP,
 820                      /* OverwriteExisting= */ false);
 821     break;
 822
 823   case ARM::FK_VFPV3XD:
 824     setAttributeItem(ARMBuildAttrs::FP_arch,
 825                      ARMBuildAttrs::AllowFPv3B,
 826                      /* OverwriteExisting= */ false);
 827     break;
 828   case ARM::FK_VFPV3XD_FP16:
 829     setAttributeItem(ARMBuildAttrs::FP_arch,
 830                      ARMBuildAttrs::AllowFPv3B,
 831                      /* OverwriteExisting= */ false);
 832     setAttributeItem(ARMBuildAttrs::FP_HP_extension,
 833                      ARMBuildAttrs::AllowHPFP,
 834                      /* OverwriteExisting= */ false);
 835     break;
 836
 837   case ARM::FK_VFPV4:
 838     setAttributeItem(ARMBuildAttrs::FP_arch,
 839                      ARMBuildAttrs::AllowFPv4A,
 840                      /* OverwriteExisting= */ false);
 841     break;
 842
 843   // ABI_HardFP_use is handled in ARMAsmPrinter, so _SP_D16 is treated the same
 844   // as _D16 here.
 845   case ARM::FK_FPV4_SP_D16:
 846   case ARM::FK_VFPV4_D16:
 847     setAttributeItem(ARMBuildAttrs::FP_arch,
 848                      ARMBuildAttrs::AllowFPv4B,
 849                      /* OverwriteExisting= */ false);
 850     break;
 851
 852   case ARM::FK_FP_ARMV8:
 853     setAttributeItem(ARMBuildAttrs::FP_arch,
 854                      ARMBuildAttrs::AllowFPARMv8A,
 855                      /* OverwriteExisting= */ false);
 856     break;
 857
 858   // FPV5_D16 is identical to FP_ARMV8 except for the number of D registers, so
 859   // uses the FP_ARMV8_D16 build attribute.
 860   case ARM::FK_FPV5_SP_D16:
 861   case ARM::FK_FPV5_D16:
 862     setAttributeItem(ARMBuildAttrs::FP_arch,
 863                      ARMBuildAttrs::AllowFPARMv8B,
 864                      /* OverwriteExisting= */ false);
 865     break;
 866
 867   case ARM::FK_NEON:
 868     setAttributeItem(ARMBuildAttrs::FP_arch,
 869                      ARMBuildAttrs::AllowFPv3A,
 870                      /* OverwriteExisting= */ false);
 871     setAttributeItem(ARMBuildAttrs::Advanced_SIMD_arch,
 872                      ARMBuildAttrs::AllowNeon,
 873                      /* OverwriteExisting= */ false);
 874     break;
 875
 876   case ARM::FK_NEON_FP16:
 877     setAttributeItem(ARMBuildAttrs::FP_arch,
 878                      ARMBuildAttrs::AllowFPv3A,
 879                      /* OverwriteExisting= */ false);
 880     setAttributeItem(ARMBuildAttrs::Advanced_SIMD_arch,
 881                      ARMBuildAttrs::AllowNeon,
 882                      /* OverwriteExisting= */ false);
 883     setAttributeItem(ARMBuildAttrs::FP_HP_extension,
 884                      ARMBuildAttrs::AllowHPFP,
 885                      /* OverwriteExisting= */ false);
 886     break;
 887
 888   case ARM::FK_NEON_VFPV4:
 889     setAttributeItem(ARMBuildAttrs::FP_arch,
 890                      ARMBuildAttrs::AllowFPv4A,
 891                      /* OverwriteExisting= */ false);
 892     setAttributeItem(ARMBuildAttrs::Advanced_SIMD_arch,
 893                      ARMBuildAttrs::AllowNeon2,
 894                      /* OverwriteExisting= */ false);
 895     break;
 896
 897   case ARM::FK_NEON_FP_ARMV8:
 898   case ARM::FK_CRYPTO_NEON_FP_ARMV8:
 899     setAttributeItem(ARMBuildAttrs::FP_arch,
 900                      ARMBuildAttrs::AllowFPARMv8A,
 901                      /* OverwriteExisting= */ false);
 902     // 'Advanced_SIMD_arch' must be emitted not here, but within
 903     // ARMAsmPrinter::emitAttributes(), depending on hasV8Ops() and hasV8_1a()
 904     break;
 905
 906   case ARM::FK_SOFTVFP:
 907   case ARM::FK_NONE:
 908     break;
 909
 910   default:
 911     report_fatal_error("Unknown FPU: " + Twine(FPU));
 912     break;
 913   }
 914 }
 915 size_t ARMTargetELFStreamer::calculateContentSize() const {
 916   size_t Result = 0;
 917   for (size_t i = 0; i < Contents.size(); ++i) {
 918     AttributeItem item = Contents[i];
 919     switch (item.Type) {
 920     case AttributeItem::HiddenAttribute:
 921       break;
 922     case AttributeItem::NumericAttribute:
 923       Result += getULEB128Size(item.Tag);
 924       Result += getULEB128Size(item.IntValue);
 925       break;
 926     case AttributeItem::TextAttribute:
 927       Result += getULEB128Size(item.Tag);
 928       Result += item.StringValue.size() + 1; // string + '\0'
 929       break;
 930     case AttributeItem::NumericAndTextAttributes:
 931       Result += getULEB128Size(item.Tag);
 932       Result += getULEB128Size(item.IntValue);
 933       Result += item.StringValue.size() + 1; // string + '\0';
 934       break;
 935     }
 936   }
 937   return Result;
 938 }
 939 void ARMTargetELFStreamer::finishAttributeSection() {
 940   // <format-version>
 941   // [ <section-length> "vendor-name"
 942   // [ <file-tag> <size> <attribute>*
 943   //   | <section-tag> <size> <section-number>* 0 <attribute>*
 944   //   | <symbol-tag> <size> <symbol-number>* 0 <attribute>*
 945   //   ]+
 946   // ]*
 947
 948   if (FPU != ARM::FK_INVALID)
 949     emitFPUDefaultAttributes();
 950
 951   if (Arch != ARM::AK_INVALID)
 952     emitArchDefaultAttributes();
 953
 954   if (Contents.empty())
 955     return;
 956
 957   std::sort(Contents.begin(), Contents.end(), AttributeItem::LessTag);
 958
 959   ARMELFStreamer &Streamer = getStreamer();
 960
 961   // Switch to .ARM.attributes section
 962   if (AttributeSection) {
 963     Streamer.SwitchSection(AttributeSection);
 964   } else {
 965     AttributeSection = Streamer.getContext().getELFSection(
 966         ".ARM.attributes", ELF::SHT_ARM_ATTRIBUTES, 0);
 967     Streamer.SwitchSection(AttributeSection);
 968
 969     // Format version
 970     Streamer.EmitIntValue(0x41, 1);
 971   }
 972
 973   // Vendor size + Vendor name + '\0'
 974   const size_t VendorHeaderSize = 4 + CurrentVendor.size() + 1;
 975
 976   // Tag + Tag Size
 977   const size_t TagHeaderSize = 1 + 4;
 978
 979   const size_t ContentsSize = calculateContentSize();
 980
 981   Streamer.EmitIntValue(VendorHeaderSize + TagHeaderSize + ContentsSize, 4);
 982   Streamer.EmitBytes(CurrentVendor);
 983   Streamer.EmitIntValue(0, 1); // '\0'
 984
 985   Streamer.EmitIntValue(ARMBuildAttrs::File, 1);
 986   Streamer.EmitIntValue(TagHeaderSize + ContentsSize, 4);
 987
 988   // Size should have been accounted for already, now
 989   // emit each field as its type (ULEB or String)
 990   for (size_t i = 0; i < Contents.size(); ++i) {
 991     AttributeItem item = Contents[i];
 992     Streamer.EmitULEB128IntValue(item.Tag);
 993     switch (item.Type) {
 994     default: llvm_unreachable("Invalid attribute type");
 995     case AttributeItem::NumericAttribute:
 996       Streamer.EmitULEB128IntValue(item.IntValue);
 997       break;
 998     case AttributeItem::TextAttribute:
 999       Streamer.EmitBytes(item.StringValue);
1000       Streamer.EmitIntValue(0, 1); // '\0'
1001       break;
1002     case AttributeItem::NumericAndTextAttributes:
1003       Streamer.EmitULEB128IntValue(item.IntValue);
1004       Streamer.EmitBytes(item.StringValue);
1005       Streamer.EmitIntValue(0, 1); // '\0'
1006       break;
1007     }
1008   }
1009
1010   Contents.clear();
1011   FPU = ARM::FK_INVALID;
1012 }
1013
1014 void ARMTargetELFStreamer::emitLabel(MCSymbol *Symbol) {
1015   ARMELFStreamer &Streamer = getStreamer();
1016   if (!Streamer.IsThumb)
1017     return;
1018
1019   Streamer.getAssembler().registerSymbol(*Symbol);
1020   unsigned Type = cast<MCSymbolELF>(Symbol)->getType();
1021   if (Type == ELF::STT_FUNC || Type == ELF::STT_GNU_IFUNC)
1022     Streamer.EmitThumbFunc(Symbol);
1023 }
1024
1025 void
1026 ARMTargetELFStreamer::AnnotateTLSDescriptorSequence(const MCSymbolRefExpr *S) {
1027   getStreamer().EmitFixup(S, FK_Data_4);
1028 }
1029
1030 void ARMTargetELFStreamer::emitThumbSet(MCSymbol *Symbol, const MCExpr *Value) {
1031   if (const MCSymbolRefExpr *SRE = dyn_cast<MCSymbolRefExpr>(Value)) {
1032     const MCSymbol &Sym = SRE->getSymbol();
1033     if (!Sym.isDefined()) {
1034       getStreamer().EmitAssignment(Symbol, Value);
1035       return;
1036     }
1037   }
1038
1039   getStreamer().EmitThumbFunc(Symbol);
1040   getStreamer().EmitAssignment(Symbol, Value);
1041 }
1042
1043 void ARMTargetELFStreamer::emitInst(uint32_t Inst, char Suffix) {
1044   getStreamer().emitInst(Inst, Suffix);
1045 }
1046
1047 void ARMELFStreamer::FinishImpl() {
1048   MCTargetStreamer &TS = *getTargetStreamer();
1049   ARMTargetStreamer &ATS = static_cast<ARMTargetStreamer &>(TS);
1050   ATS.finishAttributeSection();
1051
1052   MCELFStreamer::FinishImpl();
1053 }
1054
1055 inline void ARMELFStreamer::SwitchToEHSection(const char *Prefix,
1056                                               unsigned Type,
1057                                               unsigned Flags,
1058                                               SectionKind Kind,
1059                                               const MCSymbol &Fn) {
1060   const MCSectionELF &FnSection =
1061     static_cast<const MCSectionELF &>(Fn.getSection());
1062
1063   // Create the name for new section
1064   StringRef FnSecName(FnSection.getSectionName());
1065   SmallString<128> EHSecName(Prefix);
1066   if (FnSecName != ".text") {
1067     EHSecName += FnSecName;
1068   }
1069
1070   // Get .ARM.extab or .ARM.exidx section
1071   const MCSymbolELF *Group = FnSection.getGroup();
1072   if (Group)
1073     Flags |= ELF::SHF_GROUP;
1074   MCSectionELF *EHSection =
1075       getContext().getELFSection(EHSecName, Type, Flags, 0, Group,
1076                                  FnSection.getUniqueID(), nullptr, &FnSection);
1077
1078   assert(EHSection && "Failed to get the required EH section");
1079
1080   // Switch to .ARM.extab or .ARM.exidx section
1081   SwitchSection(EHSection);
1082   EmitCodeAlignment(4);
1083 }
1084
1085 inline void ARMELFStreamer::SwitchToExTabSection(const MCSymbol &FnStart) {
1086   SwitchToEHSection(".ARM.extab",
1087                     ELF::SHT_PROGBITS,
1088                     ELF::SHF_ALLOC,
1089                     SectionKind::getDataRel(),
1090                     FnStart);
1091 }
1092
1093 inline void ARMELFStreamer::SwitchToExIdxSection(const MCSymbol &FnStart) {
1094   SwitchToEHSection(".ARM.exidx",
1095                     ELF::SHT_ARM_EXIDX,
1096                     ELF::SHF_ALLOC | ELF::SHF_LINK_ORDER,
1097                     SectionKind::getDataRel(),
1098                     FnStart);
1099 }
1100 void ARMELFStreamer::EmitFixup(const MCExpr *Expr, MCFixupKind Kind) {
1101   MCDataFragment *Frag = getOrCreateDataFragment();
1102   Frag->getFixups().push_back(MCFixup::create(Frag->getContents().size(), Expr,
1103                                               Kind));
1104 }
1105
1106 void ARMELFStreamer::Reset() {
1107   ExTab = nullptr;
1108   FnStart = nullptr;
1109   Personality = nullptr;
1110   PersonalityIndex = ARM::EHABI::NUM_PERSONALITY_INDEX;
1111   FPReg = ARM::SP;
1112   FPOffset = 0;
1113   SPOffset = 0;
1114   PendingOffset = 0;
1115   UsedFP = false;
1116   CantUnwind = false;
1117
1118   Opcodes.clear();
1119   UnwindOpAsm.Reset();
1120 }
1121
1122 void ARMELFStreamer::emitFnStart() {
1123   assert(FnStart == nullptr);
1124   FnStart = getContext().createTempSymbol();
1125   EmitLabel(FnStart);
1126 }
1127
1128 void ARMELFStreamer::emitFnEnd() {
1129   assert(FnStart && ".fnstart must precedes .fnend");
1130
1131   // Emit unwind opcodes if there is no .handlerdata directive
1132   if (!ExTab && !CantUnwind)
1133     FlushUnwindOpcodes(true);
1134
1135   // Emit the exception index table entry
1136   SwitchToExIdxSection(*FnStart);
1137
1138   if (PersonalityIndex < ARM::EHABI::NUM_PERSONALITY_INDEX)
1139     EmitPersonalityFixup(GetAEABIUnwindPersonalityName(PersonalityIndex));
1140
1141   const MCSymbolRefExpr *FnStartRef =
1142     MCSymbolRefExpr::create(FnStart,
1143                             MCSymbolRefExpr::VK_ARM_PREL31,
1144                             getContext());
1145
1146   EmitValue(FnStartRef, 4);
1147
1148   if (CantUnwind) {
1149     EmitIntValue(ARM::EHABI::EXIDX_CANTUNWIND, 4);
1150   } else if (ExTab) {
1151     // Emit a reference to the unwind opcodes in the ".ARM.extab" section.
1152     const MCSymbolRefExpr *ExTabEntryRef =
1153       MCSymbolRefExpr::create(ExTab,
1154                               MCSymbolRefExpr::VK_ARM_PREL31,
1155                               getContext());
1156     EmitValue(ExTabEntryRef, 4);
1157   } else {
1158     // For the __aeabi_unwind_cpp_pr0, we have to emit the unwind opcodes in
1159     // the second word of exception index table entry.  The size of the unwind
1160     // opcodes should always be 4 bytes.
1161     assert(PersonalityIndex == ARM::EHABI::AEABI_UNWIND_CPP_PR0 &&
1162            "Compact model must use __aeabi_unwind_cpp_pr0 as personality");
1163     assert(Opcodes.size() == 4u &&
1164            "Unwind opcode size for __aeabi_unwind_cpp_pr0 must be equal to 4");
1165     uint64_t Intval = Opcodes[0] |
1166                       Opcodes[1] << 8 |
1167                       Opcodes[2] << 16 |
1168                       Opcodes[3] << 24;
1169     EmitIntValue(Intval, Opcodes.size());
1170   }
1171
1172   // Switch to the section containing FnStart
1173   SwitchSection(&FnStart->getSection());
1174
1175   // Clean exception handling frame information
1176   Reset();
1177 }
1178
1179 void ARMELFStreamer::emitCantUnwind() { CantUnwind = true; }
1180
1181 // Add the R_ARM_NONE fixup at the same position
1182 void ARMELFStreamer::EmitPersonalityFixup(StringRef Name) {
1183   const MCSymbol *PersonalitySym = getContext().getOrCreateSymbol(Name);
1184
1185   const MCSymbolRefExpr *PersonalityRef = MCSymbolRefExpr::create(
1186       PersonalitySym, MCSymbolRefExpr::VK_ARM_NONE, getContext());
1187
1188   visitUsedExpr(*PersonalityRef);
1189   MCDataFragment *DF = getOrCreateDataFragment();
1190   DF->getFixups().push_back(MCFixup::create(DF->getContents().size(),
1191                                             PersonalityRef,
1192                                             MCFixup::getKindForSize(4, false)));
1193 }
1194
1195 void ARMELFStreamer::FlushPendingOffset() {
1196   if (PendingOffset != 0) {
1197     UnwindOpAsm.EmitSPOffset(-PendingOffset);
1198     PendingOffset = 0;
1199   }
1200 }
1201
1202 void ARMELFStreamer::FlushUnwindOpcodes(bool NoHandlerData) {
1203   // Emit the unwind opcode to restore $sp.
1204   if (UsedFP) {
1205     const MCRegisterInfo *MRI = getContext().getRegisterInfo();
1206     int64_t LastRegSaveSPOffset = SPOffset - PendingOffset;
1207     UnwindOpAsm.EmitSPOffset(LastRegSaveSPOffset - FPOffset);
1208     UnwindOpAsm.EmitSetSP(MRI->getEncodingValue(FPReg));
1209   } else {
1210     FlushPendingOffset();
1211   }
1212
1213   // Finalize the unwind opcode sequence
1214   UnwindOpAsm.Finalize(PersonalityIndex, Opcodes);
1215
1216   // For compact model 0, we have to emit the unwind opcodes in the .ARM.exidx
1217   // section.  Thus, we don't have to create an entry in the .ARM.extab
1218   // section.
1219   if (NoHandlerData && PersonalityIndex == ARM::EHABI::AEABI_UNWIND_CPP_PR0)
1220     return;
1221
1222   // Switch to .ARM.extab section.
1223   SwitchToExTabSection(*FnStart);
1224
1225   // Create .ARM.extab label for offset in .ARM.exidx
1226   assert(!ExTab);
1227   ExTab = getContext().createTempSymbol();
1228   EmitLabel(ExTab);
1229
1230   // Emit personality
1231   if (Personality) {
1232     const MCSymbolRefExpr *PersonalityRef =
1233       MCSymbolRefExpr::create(Personality,
1234                               MCSymbolRefExpr::VK_ARM_PREL31,
1235                               getContext());
1236
1237     EmitValue(PersonalityRef, 4);
1238   }
1239
1240   // Emit unwind opcodes
1241   assert((Opcodes.size() % 4) == 0 &&
1242          "Unwind opcode size for __aeabi_cpp_unwind_pr0 must be multiple of 4");
1243   for (unsigned I = 0; I != Opcodes.size(); I += 4) {
1244     uint64_t Intval = Opcodes[I] |
1245                       Opcodes[I + 1] << 8 |
1246                       Opcodes[I + 2] << 16 |
1247                       Opcodes[I + 3] << 24;
1248     EmitIntValue(Intval, 4);
1249   }
1250
1251   // According to ARM EHABI section 9.2, if the __aeabi_unwind_cpp_pr1() or
1252   // __aeabi_unwind_cpp_pr2() is used, then the handler data must be emitted
1253   // after the unwind opcodes.  The handler data consists of several 32-bit
1254   // words, and should be terminated by zero.
1255   //
1256   // In case that the .handlerdata directive is not specified by the
1257   // programmer, we should emit zero to terminate the handler data.
1258   if (NoHandlerData && !Personality)
1259     EmitIntValue(0, 4);
1260 }
1261
1262 void ARMELFStreamer::emitHandlerData() { FlushUnwindOpcodes(false); }
1263
1264 void ARMELFStreamer::emitPersonality(const MCSymbol *Per) {
1265   Personality = Per;
1266   UnwindOpAsm.setPersonality(Per);
1267 }
1268
1269 void ARMELFStreamer::emitPersonalityIndex(unsigned Index) {
1270   assert(Index < ARM::EHABI::NUM_PERSONALITY_INDEX && "invalid index");
1271   PersonalityIndex = Index;
1272 }
1273
1274 void ARMELFStreamer::emitSetFP(unsigned NewFPReg, unsigned NewSPReg,
1275                                int64_t Offset) {
1276   assert((NewSPReg == ARM::SP || NewSPReg == FPReg) &&
1277          "the operand of .setfp directive should be either $sp or $fp");
1278
1279   UsedFP = true;
1280   FPReg = NewFPReg;
1281
1282   if (NewSPReg == ARM::SP)
1283     FPOffset = SPOffset + Offset;
1284   else
1285     FPOffset += Offset;
1286 }
1287
1288 void ARMELFStreamer::emitMovSP(unsigned Reg, int64_t Offset) {
1289   assert((Reg != ARM::SP && Reg != ARM::PC) &&
1290          "the operand of .movsp cannot be either sp or pc");
1291   assert(FPReg == ARM::SP && "current FP must be SP");
1292
1293   FlushPendingOffset();
1294
1295   FPReg = Reg;
1296   FPOffset = SPOffset + Offset;
1297
1298   const MCRegisterInfo *MRI = getContext().getRegisterInfo();
1299   UnwindOpAsm.EmitSetSP(MRI->getEncodingValue(FPReg));
1300 }
1301
1302 void ARMELFStreamer::emitPad(int64_t Offset) {
1303   // Track the change of the $sp offset
1304   SPOffset -= Offset;
1305
1306   // To squash multiple .pad directives, we should delay the unwind opcode
1307   // until the .save, .vsave, .handlerdata, or .fnend directives.
1308   PendingOffset -= Offset;
1309 }
1310
1311 void ARMELFStreamer::emitRegSave(const SmallVectorImpl<unsigned> &RegList,
1312                                  bool IsVector) {
1313   // Collect the registers in the register list
1314   unsigned Count = 0;
1315   uint32_t Mask = 0;
1316   const MCRegisterInfo *MRI = getContext().getRegisterInfo();
1317   for (size_t i = 0; i < RegList.size(); ++i) {
1318     unsigned Reg = MRI->getEncodingValue(RegList[i]);
1319     assert(Reg < (IsVector ? 32U : 16U) && "Register out of range");
1320     unsigned Bit = (1u << Reg);
1321     if ((Mask & Bit) == 0) {
1322       Mask |= Bit;
1323       ++Count;
1324     }
1325   }
1326
1327   // Track the change the $sp offset: For the .save directive, the
1328   // corresponding push instruction will decrease the $sp by (4 * Count).
1329   // For the .vsave directive, the corresponding vpush instruction will
1330   // decrease $sp by (8 * Count).
1331   SPOffset -= Count * (IsVector ? 8 : 4);
1332
1333   // Emit the opcode
1334   FlushPendingOffset();
1335   if (IsVector)
1336     UnwindOpAsm.EmitVFPRegSave(Mask);
1337   else
1338     UnwindOpAsm.EmitRegSave(Mask);
1339 }
1340
1341 void ARMELFStreamer::emitUnwindRaw(int64_t Offset,
1342                                    const SmallVectorImpl<uint8_t> &Opcodes) {
1343   FlushPendingOffset();
1344   SPOffset = SPOffset - Offset;
1345   UnwindOpAsm.EmitRaw(Opcodes);
1346 }
1347
1348 namespace llvm {
1349
1350 MCTargetStreamer *createARMTargetAsmStreamer(MCStreamer &S,
1351                                              formatted_raw_ostream &OS,
1352                                              MCInstPrinter *InstPrint,
1353                                              bool isVerboseAsm) {
1354   return new ARMTargetAsmStreamer(S, OS, *InstPrint, isVerboseAsm);
1355 }
1356
1357 MCTargetStreamer *createARMNullTargetStreamer(MCStreamer &S) {
1358   return new ARMTargetStreamer(S);
1359 }
1360
1361 MCTargetStreamer *createARMObjectTargetStreamer(MCStreamer &S,
1362                                                 const MCSubtargetInfo &STI) {
1363   const Triple &TT = STI.getTargetTriple();
1364   if (TT.isOSBinFormatELF())
1365     return new ARMTargetELFStreamer(S);
1366   return new ARMTargetStreamer(S);
1367 }
1368
1369 MCELFStreamer *createARMELFStreamer(MCContext &Context, MCAsmBackend &TAB,
1370                                     raw_pwrite_stream &OS,
1371                                     MCCodeEmitter *Emitter, bool RelaxAll,
1372                                     bool IsThumb) {
1373     ARMELFStreamer *S = new ARMELFStreamer(Context, TAB, OS, Emitter, IsThumb);
1374     // FIXME: This should eventually end up somewhere else where more
1375     // intelligent flag decisions can be made. For now we are just maintaining
1376     // the status quo for ARM and setting EF_ARM_EABI_VER5 as the default.
1377     S->getAssembler().setELFHeaderEFlags(ELF::EF_ARM_EABI_VER5);
1378
1379     if (RelaxAll)
1380       S->getAssembler().setRelaxAll(true);
1381     return S;
1382   }
1383
1384 }
1385
1386