10b57cec5SDimitry Andric //===- lib/MC/MCXCOFFStreamer.cpp - XCOFF Object Output -------------------===//
20b57cec5SDimitry Andric //
30b57cec5SDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
40b57cec5SDimitry Andric // See https://llvm.org/LICENSE.txt for license information.
50b57cec5SDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
60b57cec5SDimitry Andric //
70b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
80b57cec5SDimitry Andric //
90b57cec5SDimitry Andric // This file assembles .s files and emits XCOFF .o object files.
100b57cec5SDimitry Andric //
110b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
120b57cec5SDimitry Andric
135ffd83dbSDimitry Andric #include "llvm/MC/MCXCOFFStreamer.h"
148bcb0991SDimitry Andric #include "llvm/BinaryFormat/XCOFF.h"
150b57cec5SDimitry Andric #include "llvm/MC/MCAsmBackend.h"
1681ad6265SDimitry Andric #include "llvm/MC/MCAssembler.h"
170b57cec5SDimitry Andric #include "llvm/MC/MCCodeEmitter.h"
185ffd83dbSDimitry Andric #include "llvm/MC/MCDirectives.h"
190b57cec5SDimitry Andric #include "llvm/MC/MCObjectWriter.h"
205ffd83dbSDimitry Andric #include "llvm/MC/MCSectionXCOFF.h"
218bcb0991SDimitry Andric #include "llvm/MC/MCSymbolXCOFF.h"
22349cc55cSDimitry Andric #include "llvm/MC/TargetRegistry.h"
2381ad6265SDimitry Andric #include "llvm/Support/Casting.h"
240b57cec5SDimitry Andric
250b57cec5SDimitry Andric using namespace llvm;
260b57cec5SDimitry Andric
MCXCOFFStreamer(MCContext & Context,std::unique_ptr<MCAsmBackend> MAB,std::unique_ptr<MCObjectWriter> OW,std::unique_ptr<MCCodeEmitter> Emitter)270b57cec5SDimitry Andric MCXCOFFStreamer::MCXCOFFStreamer(MCContext &Context,
280b57cec5SDimitry Andric std::unique_ptr<MCAsmBackend> MAB,
290b57cec5SDimitry Andric std::unique_ptr<MCObjectWriter> OW,
300b57cec5SDimitry Andric std::unique_ptr<MCCodeEmitter> Emitter)
310b57cec5SDimitry Andric : MCObjectStreamer(Context, std::move(MAB), std::move(OW),
320b57cec5SDimitry Andric std::move(Emitter)) {}
330b57cec5SDimitry Andric
emitSymbolAttribute(MCSymbol * Sym,MCSymbolAttr Attribute)345ffd83dbSDimitry Andric bool MCXCOFFStreamer::emitSymbolAttribute(MCSymbol *Sym,
350b57cec5SDimitry Andric MCSymbolAttr Attribute) {
368bcb0991SDimitry Andric auto *Symbol = cast<MCSymbolXCOFF>(Sym);
378bcb0991SDimitry Andric getAssembler().registerSymbol(*Symbol);
388bcb0991SDimitry Andric
398bcb0991SDimitry Andric switch (Attribute) {
40bdd1243dSDimitry Andric // XCOFF doesn't support the cold feature.
41bdd1243dSDimitry Andric case MCSA_Cold:
42bdd1243dSDimitry Andric return false;
43bdd1243dSDimitry Andric
448bcb0991SDimitry Andric case MCSA_Global:
455ffd83dbSDimitry Andric case MCSA_Extern:
468bcb0991SDimitry Andric Symbol->setStorageClass(XCOFF::C_EXT);
478bcb0991SDimitry Andric Symbol->setExternal(true);
488bcb0991SDimitry Andric break;
495ffd83dbSDimitry Andric case MCSA_LGlobal:
505ffd83dbSDimitry Andric Symbol->setStorageClass(XCOFF::C_HIDEXT);
515ffd83dbSDimitry Andric Symbol->setExternal(true);
525ffd83dbSDimitry Andric break;
535ffd83dbSDimitry Andric case llvm::MCSA_Weak:
545ffd83dbSDimitry Andric Symbol->setStorageClass(XCOFF::C_WEAKEXT);
555ffd83dbSDimitry Andric Symbol->setExternal(true);
565ffd83dbSDimitry Andric break;
575ffd83dbSDimitry Andric case llvm::MCSA_Hidden:
585ffd83dbSDimitry Andric Symbol->setVisibilityType(XCOFF::SYM_V_HIDDEN);
595ffd83dbSDimitry Andric break;
605ffd83dbSDimitry Andric case llvm::MCSA_Protected:
615ffd83dbSDimitry Andric Symbol->setVisibilityType(XCOFF::SYM_V_PROTECTED);
625ffd83dbSDimitry Andric break;
6381ad6265SDimitry Andric case llvm::MCSA_Exported:
6481ad6265SDimitry Andric Symbol->setVisibilityType(XCOFF::SYM_V_EXPORTED);
6581ad6265SDimitry Andric break;
668bcb0991SDimitry Andric default:
678bcb0991SDimitry Andric report_fatal_error("Not implemented yet.");
688bcb0991SDimitry Andric }
698bcb0991SDimitry Andric return true;
700b57cec5SDimitry Andric }
710b57cec5SDimitry Andric
emitXCOFFSymbolLinkageWithVisibility(MCSymbol * Symbol,MCSymbolAttr Linkage,MCSymbolAttr Visibility)725ffd83dbSDimitry Andric void MCXCOFFStreamer::emitXCOFFSymbolLinkageWithVisibility(
735ffd83dbSDimitry Andric MCSymbol *Symbol, MCSymbolAttr Linkage, MCSymbolAttr Visibility) {
745ffd83dbSDimitry Andric
755ffd83dbSDimitry Andric emitSymbolAttribute(Symbol, Linkage);
765ffd83dbSDimitry Andric
775ffd83dbSDimitry Andric // When the caller passes `MCSA_Invalid` for the visibility, do not emit one.
785ffd83dbSDimitry Andric if (Visibility == MCSA_Invalid)
795ffd83dbSDimitry Andric return;
805ffd83dbSDimitry Andric
815ffd83dbSDimitry Andric emitSymbolAttribute(Symbol, Visibility);
825ffd83dbSDimitry Andric }
835ffd83dbSDimitry Andric
emitXCOFFRefDirective(const MCSymbol * Symbol)8406c3fb27SDimitry Andric void MCXCOFFStreamer::emitXCOFFRefDirective(const MCSymbol *Symbol) {
8506c3fb27SDimitry Andric // Add a Fixup here to later record a relocation of type R_REF to prevent the
8606c3fb27SDimitry Andric // ref symbol from being garbage collected (by the binder).
8706c3fb27SDimitry Andric MCDataFragment *DF = getOrCreateDataFragment();
8806c3fb27SDimitry Andric const MCSymbolRefExpr *SRE = MCSymbolRefExpr::create(Symbol, getContext());
8906c3fb27SDimitry Andric std::optional<MCFixupKind> MaybeKind =
9006c3fb27SDimitry Andric getAssembler().getBackend().getFixupKind("R_REF");
9106c3fb27SDimitry Andric if (!MaybeKind)
9206c3fb27SDimitry Andric report_fatal_error("failed to get fixup kind for R_REF relocation");
9306c3fb27SDimitry Andric
9406c3fb27SDimitry Andric MCFixupKind Kind = *MaybeKind;
9506c3fb27SDimitry Andric MCFixup Fixup = MCFixup::create(DF->getContents().size(), SRE, Kind);
9606c3fb27SDimitry Andric DF->getFixups().push_back(Fixup);
9706c3fb27SDimitry Andric }
9806c3fb27SDimitry Andric
emitXCOFFRenameDirective(const MCSymbol * Name,StringRef Rename)995f757f3fSDimitry Andric void MCXCOFFStreamer::emitXCOFFRenameDirective(const MCSymbol *Name,
1005f757f3fSDimitry Andric StringRef Rename) {
1015f757f3fSDimitry Andric const MCSymbolXCOFF *Symbol = cast<const MCSymbolXCOFF>(Name);
1025f757f3fSDimitry Andric if (!Symbol->hasRename())
1035f757f3fSDimitry Andric report_fatal_error("Only explicit .rename is supported for XCOFF.");
1045f757f3fSDimitry Andric }
1055f757f3fSDimitry Andric
emitXCOFFExceptDirective(const MCSymbol * Symbol,const MCSymbol * Trap,unsigned Lang,unsigned Reason,unsigned FunctionSize,bool hasDebug)106bdd1243dSDimitry Andric void MCXCOFFStreamer::emitXCOFFExceptDirective(const MCSymbol *Symbol,
107bdd1243dSDimitry Andric const MCSymbol *Trap,
108bdd1243dSDimitry Andric unsigned Lang, unsigned Reason,
109bdd1243dSDimitry Andric unsigned FunctionSize,
110bdd1243dSDimitry Andric bool hasDebug) {
111bdd1243dSDimitry Andric getAssembler().getWriter().addExceptionEntry(Symbol, Trap, Lang, Reason,
112bdd1243dSDimitry Andric FunctionSize, hasDebug);
113bdd1243dSDimitry Andric }
114bdd1243dSDimitry Andric
emitXCOFFCInfoSym(StringRef Name,StringRef Metadata)11506c3fb27SDimitry Andric void MCXCOFFStreamer::emitXCOFFCInfoSym(StringRef Name, StringRef Metadata) {
11606c3fb27SDimitry Andric getAssembler().getWriter().addCInfoSymEntry(Name, Metadata);
11706c3fb27SDimitry Andric }
11806c3fb27SDimitry Andric
emitCommonSymbol(MCSymbol * Symbol,uint64_t Size,Align ByteAlignment)1195ffd83dbSDimitry Andric void MCXCOFFStreamer::emitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
120bdd1243dSDimitry Andric Align ByteAlignment) {
1218bcb0991SDimitry Andric getAssembler().registerSymbol(*Symbol);
1228bcb0991SDimitry Andric Symbol->setExternal(cast<MCSymbolXCOFF>(Symbol)->getStorageClass() !=
1238bcb0991SDimitry Andric XCOFF::C_HIDEXT);
1248bcb0991SDimitry Andric Symbol->setCommon(Size, ByteAlignment);
1258bcb0991SDimitry Andric
1265ffd83dbSDimitry Andric // Default csect align is 4, but common symbols have explicit alignment values
1275ffd83dbSDimitry Andric // and we should honor it.
1285ffd83dbSDimitry Andric cast<MCSymbolXCOFF>(Symbol)->getRepresentedCsect()->setAlignment(
129bdd1243dSDimitry Andric ByteAlignment);
1305ffd83dbSDimitry Andric
1318bcb0991SDimitry Andric // Emit the alignment and storage for the variable to the section.
1325ffd83dbSDimitry Andric emitValueToAlignment(ByteAlignment);
1335ffd83dbSDimitry Andric emitZeros(Size);
1340b57cec5SDimitry Andric }
1350b57cec5SDimitry Andric
emitZerofill(MCSection * Section,MCSymbol * Symbol,uint64_t Size,Align ByteAlignment,SMLoc Loc)1365ffd83dbSDimitry Andric void MCXCOFFStreamer::emitZerofill(MCSection *Section, MCSymbol *Symbol,
137bdd1243dSDimitry Andric uint64_t Size, Align ByteAlignment,
1380b57cec5SDimitry Andric SMLoc Loc) {
1390b57cec5SDimitry Andric report_fatal_error("Zero fill not implemented for XCOFF.");
1400b57cec5SDimitry Andric }
1410b57cec5SDimitry Andric
emitInstToData(const MCInst & Inst,const MCSubtargetInfo & STI)1425ffd83dbSDimitry Andric void MCXCOFFStreamer::emitInstToData(const MCInst &Inst,
1438bcb0991SDimitry Andric const MCSubtargetInfo &STI) {
1448bcb0991SDimitry Andric MCAssembler &Assembler = getAssembler();
1458bcb0991SDimitry Andric SmallVector<MCFixup, 4> Fixups;
1468bcb0991SDimitry Andric SmallString<256> Code;
14706c3fb27SDimitry Andric Assembler.getEmitter().encodeInstruction(Inst, Code, Fixups, STI);
1488bcb0991SDimitry Andric
1495ffd83dbSDimitry Andric // Add the fixups and data.
1508bcb0991SDimitry Andric MCDataFragment *DF = getOrCreateDataFragment(&STI);
1515ffd83dbSDimitry Andric const size_t ContentsSize = DF->getContents().size();
1525ffd83dbSDimitry Andric auto &DataFragmentFixups = DF->getFixups();
1535ffd83dbSDimitry Andric for (auto &Fixup : Fixups) {
1545ffd83dbSDimitry Andric Fixup.setOffset(Fixup.getOffset() + ContentsSize);
1555ffd83dbSDimitry Andric DataFragmentFixups.push_back(Fixup);
1565ffd83dbSDimitry Andric }
1575ffd83dbSDimitry Andric
1588bcb0991SDimitry Andric DF->setHasInstructions(STI);
1598bcb0991SDimitry Andric DF->getContents().append(Code.begin(), Code.end());
1600b57cec5SDimitry Andric }
1610b57cec5SDimitry Andric
createXCOFFStreamer(MCContext & Context,std::unique_ptr<MCAsmBackend> && MAB,std::unique_ptr<MCObjectWriter> && OW,std::unique_ptr<MCCodeEmitter> && CE,bool RelaxAll)1620b57cec5SDimitry Andric MCStreamer *llvm::createXCOFFStreamer(MCContext &Context,
1630b57cec5SDimitry Andric std::unique_ptr<MCAsmBackend> &&MAB,
1640b57cec5SDimitry Andric std::unique_ptr<MCObjectWriter> &&OW,
1650b57cec5SDimitry Andric std::unique_ptr<MCCodeEmitter> &&CE,
1660b57cec5SDimitry Andric bool RelaxAll) {
1670b57cec5SDimitry Andric MCXCOFFStreamer *S = new MCXCOFFStreamer(Context, std::move(MAB),
1680b57cec5SDimitry Andric std::move(OW), std::move(CE));
1690b57cec5SDimitry Andric if (RelaxAll)
1700b57cec5SDimitry Andric S->getAssembler().setRelaxAll(true);
1710b57cec5SDimitry Andric return S;
1720b57cec5SDimitry Andric }
1738bcb0991SDimitry Andric
emitXCOFFLocalCommonSymbol(MCSymbol * LabelSym,uint64_t Size,MCSymbol * CsectSym,Align Alignment)1745ffd83dbSDimitry Andric void MCXCOFFStreamer::emitXCOFFLocalCommonSymbol(MCSymbol *LabelSym,
1758bcb0991SDimitry Andric uint64_t Size,
176480093f4SDimitry Andric MCSymbol *CsectSym,
177bdd1243dSDimitry Andric Align Alignment) {
178bdd1243dSDimitry Andric emitCommonSymbol(CsectSym, Size, Alignment);
1798bcb0991SDimitry Andric }
180