LLVM 23.0.0git
MCObjectStreamer.cpp
Go to the documentation of this file.
1//===- lib/MC/MCObjectStreamer.cpp - Object File MCStreamer Interface -----===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
11#include "llvm/MC/MCAsmInfo.h"
12#include "llvm/MC/MCAssembler.h"
14#include "llvm/MC/MCCodeView.h"
15#include "llvm/MC/MCContext.h"
16#include "llvm/MC/MCDwarf.h"
17#include "llvm/MC/MCExpr.h"
21#include "llvm/MC/MCSFrame.h"
22#include "llvm/MC/MCSection.h"
23#include "llvm/MC/MCSymbol.h"
26using namespace llvm;
27
29 std::unique_ptr<MCAsmBackend> TAB,
30 std::unique_ptr<MCObjectWriter> OW,
31 std::unique_ptr<MCCodeEmitter> Emitter)
32 : MCStreamer(Context),
33 Assembler(std::make_unique<MCAssembler>(
34 Context, std::move(TAB), std::move(Emitter), std::move(OW))),
35 EmitEHFrame(true), EmitDebugFrame(false), EmitSFrame(false) {
36 assert(Assembler->getBackendPtr() && Assembler->getEmitterPtr());
37 IsObj = true;
38 setAllowAutoPadding(Assembler->getBackend().allowAutoPadding());
39 if (Context.getTargetOptions() && Context.getTargetOptions()->MCRelaxAll)
40 Assembler->setRelaxAll(true);
41}
42
44
47 return Assembler.get();
48 return nullptr;
49}
50
51constexpr size_t FragBlockSize = 16384;
52// Ensure the new fragment can at least store a few bytes.
53constexpr size_t NewFragHeadroom = 8;
54
55static_assert(NewFragHeadroom >= alignof(MCFragment));
56static_assert(FragBlockSize >= sizeof(MCFragment) + NewFragHeadroom);
57
59 auto Size = std::max(FragBlockSize, sizeof(MCFragment) + Headroom);
60 FragSpace = Size - sizeof(MCFragment);
61 auto Block = std::unique_ptr<uint8_t[]>(new uint8_t[Size]);
62 auto *F = reinterpret_cast<MCFragment *>(Block.get());
63 FragStorage.push_back(std::move(Block));
64 return F;
65}
66
69 if (LLVM_LIKELY(sizeof(MCFragment) + NewFragHeadroom <= FragSpace)) {
70 auto End = reinterpret_cast<size_t>(getCurFragEnd());
71 F = reinterpret_cast<MCFragment *>(
72 alignToPowerOf2(End, alignof(MCFragment)));
73 FragSpace -= size_t(F) - End + sizeof(MCFragment);
74 } else {
75 F = allocFragSpace(0);
76 }
77 new (F) MCFragment();
79}
80
81void MCObjectStreamer::ensureHeadroom(size_t Headroom) {
82 if (Headroom <= FragSpace)
83 return;
84 auto *F = allocFragSpace(Headroom);
85 new (F) MCFragment();
87}
88
89void MCObjectStreamer::addSpecialFragment(MCFragment *Frag) {
91 "Frag should have a variable-size tail");
92 // Frag is not connected to FragSpace. Before modifying CurFrag with
93 // addFragment(Frag), allocate an empty fragment to maintain FragSpace
94 // connectivity, potentially reusing CurFrag's associated space.
96 if (LLVM_LIKELY(sizeof(MCFragment) + NewFragHeadroom <= FragSpace)) {
97 auto End = reinterpret_cast<size_t>(getCurFragEnd());
98 F = reinterpret_cast<MCFragment *>(
99 alignToPowerOf2(End, alignof(MCFragment)));
100 FragSpace -= size_t(F) - End + sizeof(MCFragment);
101 } else {
102 F = allocFragSpace(0);
103 }
104 new (F) MCFragment();
105
106 addFragment(Frag);
107 addFragment(F);
108}
109
111 ensureHeadroom(Contents.size());
112 assert(FragSpace >= Contents.size());
113 // As this is performance-sensitive code, explicitly use std::memcpy.
114 // Optimization of std::copy to memmove is unreliable.
115 if (!Contents.empty())
116 std::memcpy(getCurFragEnd(), Contents.begin(), Contents.size());
117 CurFrag->FixedSize += Contents.size();
118 FragSpace -= Contents.size();
119}
120
122 ensureHeadroom(Num);
124 llvm::fill(Data, Elt);
125 CurFrag->FixedSize += Num;
126 FragSpace -= Num;
127}
128
132
133// As a compile-time optimization, avoid allocating and evaluating an MCExpr
134// tree for (Hi - Lo) when Hi and Lo are offsets into the same fragment's fixed
135// part.
136static std::optional<uint64_t> absoluteSymbolDiff(const MCSymbol *Hi,
137 const MCSymbol *Lo) {
138 assert(Hi && Lo);
139 if (Lo == Hi)
140 return 0;
141 if (Hi->isVariable() || Lo->isVariable())
142 return std::nullopt;
143 auto *LoF = Lo->getFragment();
144 if (!LoF || Hi->getFragment() != LoF || LoF->isLinkerRelaxable())
145 return std::nullopt;
146 // If either symbol resides in the variable part, bail out.
147 auto Fixed = LoF->getFixedSize();
148 if (Lo->getOffset() > Fixed || Hi->getOffset() > Fixed)
149 return std::nullopt;
150
151 return Hi->getOffset() - Lo->getOffset();
152}
153
155 const MCSymbol *Lo,
156 unsigned Size) {
157 if (std::optional<uint64_t> Diff = absoluteSymbolDiff(Hi, Lo))
158 emitIntValue(*Diff, Size);
159 else
161}
162
164 const MCSymbol *Lo) {
165 if (std::optional<uint64_t> Diff = absoluteSymbolDiff(Hi, Lo))
166 emitULEB128IntValue(*Diff);
167 else
169}
170
172 if (Assembler) {
173 Assembler->reset();
174 if (getContext().getTargetOptions())
175 Assembler->setRelaxAll(getContext().getTargetOptions()->MCRelaxAll);
176 }
177 EmitEHFrame = true;
178 EmitDebugFrame = false;
179 FragStorage.clear();
180 FragSpace = 0;
181 SpecialFragAllocator.Reset();
183}
184
186 auto &Backend = getAssembler().getBackend();
187 for (auto &FI : DwarfFrameInfos)
188 FI.CompactUnwindEncoding =
190}
191
193 if (!getNumFrameInfos())
194 return;
195
196 if (EmitEHFrame)
197 MCDwarfFrameEmitter::emit(*this, true);
198 if (EmitDebugFrame)
199 MCDwarfFrameEmitter::emit(*this, false);
200
201 if (EmitSFrame || (getContext().getTargetOptions() &&
202 getContext().getTargetOptions()->EmitSFrameUnwind))
204}
205
207 Assembler->registerSymbol(Sym);
208}
209
210void MCObjectStreamer::emitCFISections(bool EH, bool Debug, bool SFrame) {
212 EmitEHFrame = EH;
213 EmitDebugFrame = Debug;
214 EmitSFrame = SFrame;
215}
216
218 SMLoc Loc) {
220
222
223 // Avoid fixups when possible.
224 int64_t AbsValue;
225 if (Value->evaluateAsAbsolute(AbsValue, getAssemblerPtr())) {
226 if (!isUIntN(8 * Size, AbsValue) && !isIntN(8 * Size, AbsValue)) {
228 Loc, "value evaluated as " + Twine(AbsValue) + " is out of range.");
229 return;
230 }
231 emitIntValue(AbsValue, Size);
232 return;
233 }
237}
238
240 MCSymbol *Label = getContext().createTempSymbol("cfi");
241 emitLabel(Label);
242 return Label;
243}
244
245void MCObjectStreamer::emitCFIStartProcImpl(MCDwarfFrameInfo &Frame) {
246 // We need to create a local symbol to avoid relocations.
248 emitLabel(Frame.Begin);
249}
250
251void MCObjectStreamer::emitCFIEndProcImpl(MCDwarfFrameInfo &Frame) {
252 Frame.End = getContext().createTempSymbol();
253 emitLabel(Frame.End);
254}
255
257 MCStreamer::emitLabel(Symbol, Loc);
258 // If Symbol is a non-redefiniable variable, emitLabel has reported an error.
259 // Bail out.
260 if (Symbol->isVariable())
261 return;
262
263 getAssembler().registerSymbol(*Symbol);
264
265 // Set the fragment and offset. This function might be called by
266 // changeSection, when the section stack top hasn't been changed to the new
267 // section.
269 Symbol->setFragment(F);
270 Symbol->setOffset(F->getFixedSize());
271
273}
274
276 auto Assignments = pendingAssignments.find(Symbol);
277 if (Assignments != pendingAssignments.end()) {
278 for (const PendingAssignment &A : Assignments->second)
279 emitAssignment(A.Symbol, A.Value);
280
281 pendingAssignments.erase(Assignments);
282 }
283}
284
285// Emit a label at a previously emitted fragment/offset position. This must be
286// within the currently-active section.
289 assert(F.getParent() == getCurrentSectionOnly());
290 MCStreamer::emitLabel(Symbol, Loc);
291 getAssembler().registerSymbol(*Symbol);
292 Symbol->setFragment(&F);
293 Symbol->setOffset(Offset);
294}
295
297 int64_t IntValue;
298 if (Value->evaluateAsAbsolute(IntValue, getAssembler())) {
299 emitULEB128IntValue(IntValue);
300 return;
301 }
302 auto *F = getCurrentFragment();
303 F->makeLEB(false, Value);
304 newFragment();
305}
306
308 int64_t IntValue;
309 if (Value->evaluateAsAbsolute(IntValue, getAssembler())) {
310 emitSLEB128IntValue(IntValue);
311 return;
312 }
313 auto *F = getCurrentFragment();
314 F->makeLEB(true, Value);
315 newFragment();
316}
317
319 const MCSymbol *Target) {
320 reportFatalUsageError("this file format doesn't support weak aliases");
321}
322
324 assert(Section && "Cannot switch to a null section!");
326
327 // Register the section and create an initial fragment for subsection 0
328 // if `Subsection` is non-zero.
329 bool NewSec = getAssembler().registerSection(*Section);
330 MCFragment *F0 = nullptr;
331 if (NewSec && Subsection) {
332 changeSection(Section, 0);
333 F0 = CurFrag;
334 }
335
336 // To maintain connectivity between CurFrag and FragSpace when CurFrag is
337 // modified, allocate an empty fragment and append it to the fragment list.
338 // (Subsections[I].second.Tail is not connected to FragSpace.)
339 MCFragment *F;
340 if (LLVM_LIKELY(sizeof(MCFragment) + NewFragHeadroom <= FragSpace)) {
341 auto End = reinterpret_cast<size_t>(getCurFragEnd());
342 F = reinterpret_cast<MCFragment *>(
343 alignToPowerOf2(End, alignof(MCFragment)));
344 FragSpace -= size_t(F) - End + sizeof(MCFragment);
345 } else {
346 F = allocFragSpace(0);
347 }
348 new (F) MCFragment();
349 F->setParent(Section);
350
351 auto &Subsections = Section->Subsections;
352 size_t I = 0, E = Subsections.size();
353 while (I != E && Subsections[I].first < Subsection)
354 ++I;
355 // If the subsection number is not in the sorted Subsections list, create a
356 // new fragment list.
357 if (I == E || Subsections[I].first != Subsection) {
358 Subsections.insert(Subsections.begin() + I,
359 {Subsection, MCSection::FragList{F, F}});
360 Section->CurFragList = &Subsections[I].second;
361 CurFrag = F;
362 } else {
363 Section->CurFragList = &Subsections[I].second;
364 CurFrag = Subsections[I].second.Tail;
365 // Ensure CurFrag is associated with FragSpace.
366 addFragment(F);
367 }
368
369 // Define the section symbol at subsection 0's initial fragment if required.
370 if (!NewSec)
371 return;
372 if (auto *Sym = Section->getBeginSymbol()) {
373 Sym->setFragment(Subsection ? F0 : CurFrag);
374 getAssembler().registerSymbol(*Sym);
375 }
376}
377
383
385 const MCExpr *Value) {
386 const MCSymbol *Target = &cast<MCSymbolRefExpr>(*Value).getSymbol();
387
388 // If the symbol already exists, emit the assignment. Otherwise, emit it
389 // later only if the symbol is also emitted.
390 if (Target->isRegistered())
391 emitAssignment(Symbol, Value);
392 else
393 pendingAssignments[Target].push_back({Symbol, Value});
394}
395
397 return Sec.hasInstructions();
398}
399
401 const MCSubtargetInfo &STI) {
402 if (LFIRewriter && LFIRewriter->rewriteInst(Inst, *this, STI))
403 return;
404
406
408 Sec->setHasInstructions(true);
409
410 // Now that a machine instruction has been assembled into this section, make
411 // a line entry for any .loc directive that has been seen.
413
414 // If this instruction doesn't need relaxation, just emit it as data.
415 MCAssembler &Assembler = getAssembler();
416 MCAsmBackend &Backend = Assembler.getBackend();
417 if (!(Backend.mayNeedRelaxation(Inst.getOpcode(), Inst.getOperands(), STI) ||
418 Backend.allowEnhancedRelaxation())) {
419 emitInstToData(Inst, STI);
420 return;
421 }
422
423 // Otherwise, relax and emit it as data if RelaxAll is specified.
424 if (Assembler.getRelaxAll()) {
425 MCInst Relaxed = Inst;
426 while (Backend.mayNeedRelaxation(Relaxed.getOpcode(), Relaxed.getOperands(),
427 STI))
428 Backend.relaxInstruction(Relaxed, STI);
429 emitInstToData(Relaxed, STI);
430 return;
431 }
432
433 emitInstToFragment(Inst, STI);
434}
435
436void MCObjectStreamer::emitInstToData(const MCInst &Inst,
437 const MCSubtargetInfo &STI) {
439
440 // Append the instruction to the data fragment.
441 size_t CodeOffset = getCurFragSize();
442 SmallString<16> Content;
444 getAssembler().getEmitter().encodeInstruction(Inst, Content, Fixups, STI);
445 appendContents(Content);
446 if (CurFrag != F) {
447 F = CurFrag;
448 CodeOffset = 0;
449 }
450 F->setHasInstructions(STI);
451
452 if (Fixups.empty())
453 return;
454 bool MarkedLinkerRelaxable = false;
455 for (auto &Fixup : Fixups) {
456 Fixup.setOffset(Fixup.getOffset() + CodeOffset);
457 if (!Fixup.isLinkerRelaxable() || MarkedLinkerRelaxable)
458 continue;
459 MarkedLinkerRelaxable = true;
460 // Set the fragment's order within the subsection for use by
461 // MCAssembler::relaxAlign.
462 auto *Sec = F->getParent();
463 if (!Sec->isLinkerRelaxable())
464 Sec->setFirstLinkerRelaxable(F->getLayoutOrder());
465 // Do not add data after a linker-relaxable instruction. The difference
466 // between a new label and a label at or before the linker-relaxable
467 // instruction cannot be resolved at assemble-time.
468 F->setLinkerRelaxable();
469 newFragment();
470 }
471 F->appendFixups(Fixups);
472}
473
475 const MCSubtargetInfo &STI) {
476 auto *F = getCurrentFragment();
479 getAssembler().getEmitter().encodeInstruction(Inst, Data, Fixups, STI);
480
482 F->setHasInstructions(STI);
483
484 F->setVarContents(Data);
485 F->setInst(Inst);
486
487 bool MarkedLinkerRelaxable = false;
488 for (auto &Fixup : Fixups) {
489 if (!Fixup.isLinkerRelaxable() || MarkedLinkerRelaxable)
490 continue;
491 MarkedLinkerRelaxable = true;
492 auto *Sec = F->getParent();
493 if (!Sec->isLinkerRelaxable())
494 Sec->setFirstLinkerRelaxable(F->getLayoutOrder());
495 F->setLinkerRelaxable();
496 }
497 F->setVarFixups(Fixups);
498
499 newFragment();
500}
501
502void MCObjectStreamer::emitDwarfLocDirective(unsigned FileNo, unsigned Line,
503 unsigned Column, unsigned Flags,
504 unsigned Isa,
505 unsigned Discriminator,
506 StringRef FileName,
507 StringRef Comment) {
508 // In case we see two .loc directives in a row, make sure the
509 // first one gets a line entry.
511
512 this->MCStreamer::emitDwarfLocDirective(FileNo, Line, Column, Flags, Isa,
513 Discriminator, FileName, Comment);
514}
515
517 const MCSymbol *B, SMLoc Loc) {
518 MCContext &Context = OS.getContext();
519 const MCExpr *ARef = MCSymbolRefExpr::create(A, Context);
520 const MCExpr *BRef = MCSymbolRefExpr::create(B, Context);
521 const MCExpr *AddrDelta =
522 MCBinaryExpr::create(MCBinaryExpr::Sub, ARef, BRef, Context, Loc);
523 return AddrDelta;
524}
525
528 int64_t LineDelta, const MCSymbol *Label,
529 int PointerSize) {
530 // emit the sequence to set the address
531 OS.emitIntValue(dwarf::DW_LNS_extended_op, 1);
532 OS.emitULEB128IntValue(PointerSize + 1);
533 OS.emitIntValue(dwarf::DW_LNE_set_address, 1);
534 OS.emitSymbolValue(Label, PointerSize);
535
536 // emit the sequence for the LineDelta (from 1) and a zero address delta.
537 MCDwarfLineAddr::Emit(&OS, Params, LineDelta, 0);
538}
539
541 const MCSymbol *LastLabel,
542 const MCSymbol *Label,
543 unsigned PointerSize) {
544 if (!LastLabel) {
545 emitDwarfSetLineAddr(*this, Assembler->getDWARFLinetableParams(), LineDelta,
546 Label, PointerSize);
547 return;
548 }
549
550 // If the two labels are within the same fragment, then the address-offset is
551 // already a fixed constant and is not relaxable. Emit the advance-line-addr
552 // data immediately to save time and memory.
553 if (auto OptAddrDelta = absoluteSymbolDiff(Label, LastLabel)) {
554 SmallString<16> Tmp;
555 MCDwarfLineAddr::encode(getContext(), Assembler->getDWARFLinetableParams(),
556 LineDelta, *OptAddrDelta, Tmp);
557 emitBytes(Tmp);
558 return;
559 }
560
561 auto *F = getCurrentFragment();
562 F->Kind = MCFragment::FT_Dwarf;
563 F->setDwarfAddrDelta(buildSymbolDiff(*this, Label, LastLabel, SMLoc()));
564 F->setDwarfLineDelta(LineDelta);
565 newFragment();
566}
567
569 MCSymbol *LastLabel,
570 MCSymbol *EndLabel) {
571 // Emit a DW_LNE_end_sequence into the line table. When EndLabel is null, it
572 // means we should emit the entry for the end of the section and therefore we
573 // use the section end label for the reference label. After having the
574 // appropriate reference label, we emit the address delta and use INT64_MAX as
575 // the line delta which is the signal that this is actually a
576 // DW_LNE_end_sequence.
577 if (!EndLabel)
578 EndLabel = endSection(Section);
579
580 // Switch back the dwarf line section, in case endSection had to switch the
581 // section.
582 MCContext &Ctx = getContext();
583 switchSection(Ctx.getObjectFileInfo()->getDwarfLineSection());
584
585 const MCAsmInfo *AsmInfo = Ctx.getAsmInfo();
586 emitDwarfAdvanceLineAddr(INT64_MAX, LastLabel, EndLabel,
587 AsmInfo->getCodePointerSize());
588}
589
591 const MCSymbol *Label,
592 SMLoc Loc) {
593 auto *F = getCurrentFragment();
595 F->setDwarfAddrDelta(buildSymbolDiff(*this, Label, LastLabel, Loc));
596 newFragment();
597}
598
600 const MCSymbol *FREBegin,
601 MCFragment *FDEFrag,
602 SMLoc Loc) {
603 assert(FuncBase && "No function base address");
604 assert(FREBegin && "FRE doesn't describe a location");
605 auto *F = getCurrentFragment();
606 F->Kind = MCFragment::FT_SFrame;
607 F->setSFrameAddrDelta(buildSymbolDiff(*this, FREBegin, FuncBase, Loc));
608 F->setSFrameFDE(FDEFrag);
609 newFragment();
610}
611
613 unsigned Line, unsigned Column,
614 bool PrologueEnd, bool IsStmt,
615 StringRef FileName, SMLoc Loc) {
616 // Validate the directive.
617 if (!checkCVLocSection(FunctionId, FileNo, Loc))
618 return;
619
620 // Emit a label at the current position and record it in the CodeViewContext.
621 MCSymbol *LineSym = getContext().createTempSymbol();
622 emitLabel(LineSym);
624 FileNo, Line, Column, PrologueEnd,
625 IsStmt);
626}
627
629 const MCSymbol *Begin,
630 const MCSymbol *End) {
632 End);
633 this->MCStreamer::emitCVLinetableDirective(FunctionId, Begin, End);
634}
635
637 unsigned PrimaryFunctionId, unsigned SourceFileId, unsigned SourceLineNum,
638 const MCSymbol *FnStartSym, const MCSymbol *FnEndSym) {
640 *this, PrimaryFunctionId, SourceFileId, SourceLineNum, FnStartSym,
641 FnEndSym);
643 PrimaryFunctionId, SourceFileId, SourceLineNum, FnStartSym, FnEndSym);
644}
645
647 ArrayRef<std::pair<const MCSymbol *, const MCSymbol *>> Ranges,
648 StringRef FixedSizePortion) {
649 getContext().getCVContext().emitDefRange(*this, Ranges, FixedSizePortion);
650 // Attach labels that were pending before we created the defrange fragment to
651 // the beginning of the new fragment.
652 this->MCStreamer::emitCVDefRangeDirective(Ranges, FixedSizePortion);
653}
654
661
665
670
672 uint8_t FillLen,
673 unsigned MaxBytesToEmit) {
674 if (MaxBytesToEmit == 0)
675 MaxBytesToEmit = Alignment.value();
677 F->makeAlign(Alignment, Fill, FillLen, MaxBytesToEmit);
678 newFragment();
679
680 // Update the maximum alignment on the current section if necessary.
681 F->getParent()->ensureMinAlignment(Alignment);
682}
683
685 const MCSubtargetInfo *STI,
686 unsigned MaxBytesToEmit) {
687 auto *F = getCurrentFragment();
688 emitValueToAlignment(Alignment, 0, 1, MaxBytesToEmit);
689 F->u.align.EmitNops = true;
690 F->STI = STI;
691}
692
696
702
704 const MCExpr *Expr, SMLoc Loc) {
705 std::optional<MCFixupKind> MaybeKind =
706 Assembler->getBackend().getFixupKind(Name);
707 if (!MaybeKind) {
708 getContext().reportError(Loc, "unknown relocation name");
709 return;
710 }
711
712 MCFixupKind Kind = *MaybeKind;
713 if (Expr)
714 visitUsedExpr(*Expr);
715 else
716 Expr =
717 MCSymbolRefExpr::create(getContext().createTempSymbol(), getContext());
718
719 auto *O = &Offset;
720 int64_t Val;
721 if (Offset.evaluateAsAbsolute(Val, nullptr)) {
722 auto *SecSym = getCurrentSectionOnly()->getBeginSymbol();
724 O, getContext(), Loc);
725 }
726 getAssembler().addRelocDirective({*O, Expr, Kind});
727}
728
729void MCObjectStreamer::emitFill(const MCExpr &NumBytes, uint64_t FillValue,
730 SMLoc Loc) {
731 assert(getCurrentSectionOnly() && "need a section");
732 newSpecialFragment<MCFillFragment>(FillValue, 1, NumBytes, Loc);
733}
734
735void MCObjectStreamer::emitFill(const MCExpr &NumValues, int64_t Size,
736 int64_t Expr, SMLoc Loc) {
737 int64_t IntNumValues;
738 // Do additional checking now if we can resolve the value.
739 if (NumValues.evaluateAsAbsolute(IntNumValues, getAssembler())) {
740 if (IntNumValues < 0) {
743 "'.fill' directive with negative repeat count has no effect");
744 return;
745 }
746 // Emit now if we can for better errors.
747 int64_t NonZeroSize = Size > 4 ? 4 : Size;
748 Expr &= ~0ULL >> (64 - NonZeroSize * 8);
749 for (uint64_t i = 0, e = IntNumValues; i != e; ++i) {
750 emitIntValue(Expr, NonZeroSize);
751 if (NonZeroSize < Size)
752 emitIntValue(0, Size - NonZeroSize);
753 }
754 return;
755 }
756
757 // Otherwise emit as fragment.
758 assert(getCurrentSectionOnly() && "need a section");
760}
761
762void MCObjectStreamer::emitNops(int64_t NumBytes, int64_t ControlledNopLength,
763 SMLoc Loc, const MCSubtargetInfo &STI) {
764 assert(getCurrentSectionOnly() && "need a section");
765 newSpecialFragment<MCNopsFragment>(NumBytes, ControlledNopLength, Loc, STI);
766}
767
769 MCAssembler &Asm = getAssembler();
770 Asm.getWriter().addFileName(Filename);
771}
772
774 StringRef CompilerVersion,
775 StringRef TimeStamp,
776 StringRef Description) {
778 W.addFileName(Filename);
779 if (CompilerVersion.size())
780 W.setCompilerVersion(CompilerVersion);
781 // TODO: add TimeStamp and Description to .file symbol table entry
782 // with the integrated assembler.
783}
784
788
792
795
796 // If we are generating dwarf for assembly source files dump out the sections.
797 if (getContext().getGenDwarfForAssembly())
799
800 // Dump out the dwarf file & directory tables and line tables.
801 MCDwarfLineTable::emit(this, getAssembler().getDWARFLinetableParams());
802
803 // Emit pseudo probes for the current module.
805
807}
assert(UImm &&(UImm !=~static_cast< T >(0)) &&"Invalid immediate!")
static GCRegistry::Add< ErlangGC > A("erlang", "erlang-compatible garbage collector")
static GCRegistry::Add< OcamlGC > B("ocaml", "ocaml 3.10-compatible GC")
#define LLVM_LIKELY(EXPR)
Definition Compiler.h:335
dxil DXContainer Global Emitter
This file declares the MCLFIRewriter class, an abstract class that encapsulates the rewriting logic f...
static const MCExpr * buildSymbolDiff(MCObjectStreamer &OS, const MCSymbol *A, const MCSymbol *B, SMLoc Loc)
constexpr size_t FragBlockSize
static void emitDwarfSetLineAddr(MCObjectStreamer &OS, MCDwarfLineTableParams Params, int64_t LineDelta, const MCSymbol *Label, int PointerSize)
static std::optional< uint64_t > absoluteSymbolDiff(const MCSymbol *Hi, const MCSymbol *Lo)
constexpr size_t NewFragHeadroom
#define F(x, y, z)
Definition MD5.cpp:54
#define I(x, y, z)
Definition MD5.cpp:57
static constexpr StringLiteral Filename
PowerPC TLS Dynamic Call Fixup
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory),...
Definition ArrayRef.h:40
size_t size() const
size - Get the array size.
Definition ArrayRef.h:142
iterator begin() const
Definition ArrayRef.h:130
bool empty() const
empty - Check if the array is empty.
Definition ArrayRef.h:137
void emitLineTableForFunction(MCObjectStreamer &OS, unsigned FuncId, const MCSymbol *FuncBegin, const MCSymbol *FuncEnd)
Emits a line table substream.
void emitFileChecksums(MCObjectStreamer &OS)
Emits the file checksum substream.
void recordCVLoc(MCContext &Ctx, const MCSymbol *Label, unsigned FunctionId, unsigned FileNo, unsigned Line, unsigned Column, bool PrologueEnd, bool IsStmt)
Saves the information from the currently parsed .cv_loc directive and sets CVLocSeen.
void emitDefRange(MCObjectStreamer &OS, ArrayRef< std::pair< const MCSymbol *, const MCSymbol * > > Ranges, StringRef FixedSizePortion)
void emitFileChecksumOffset(MCObjectStreamer &OS, unsigned FileNo)
Emits the offset into the checksum table of the given file number.
void emitInlineLineTableForFunction(MCObjectStreamer &OS, unsigned PrimaryFunctionId, unsigned SourceFileId, unsigned SourceLineNum, const MCSymbol *FnStartSym, const MCSymbol *FnEndSym)
void emitStringTable(MCObjectStreamer &OS)
Emits the string table substream.
Generic interface to target specific assembler backends.
bool allowEnhancedRelaxation() const
Return true if this target allows an unrelaxable instruction to be emitted into RelaxableFragment and...
virtual void relaxInstruction(MCInst &Inst, const MCSubtargetInfo &STI) const
Relax the instruction in the given fragment to the next wider instruction.
virtual bool mayNeedRelaxation(unsigned Opcode, ArrayRef< MCOperand > Operands, const MCSubtargetInfo &STI) const
Check whether the given instruction (encoded as Opcode+Operands) may need relaxation.
virtual uint64_t generateCompactUnwindEncoding(const MCDwarfFrameInfo *FI, const MCContext *Ctxt) const
Generate the compact unwind encoding for the CFI instructions.
This class is intended to be used as a base class for asm properties and features specific to the tar...
Definition MCAsmInfo.h:64
unsigned getCodePointerSize() const
Get the code pointer size in bytes.
Definition MCAsmInfo.h:445
LLVM_ABI void Finish()
Finish - Do final processing and write the object to the output stream.
MCObjectWriter & getWriter() const
LLVM_ABI void addRelocDirective(RelocDirective RD)
MCCodeEmitter & getEmitter() const
MCAsmBackend & getBackend() const
LLVM_ABI bool registerSection(MCSection &Section)
LLVM_ABI bool registerSymbol(const MCSymbol &Symbol)
static const MCBinaryExpr * createAdd(const MCExpr *LHS, const MCExpr *RHS, MCContext &Ctx, SMLoc Loc=SMLoc())
Definition MCExpr.h:343
static LLVM_ABI const MCBinaryExpr * create(Opcode Op, const MCExpr *LHS, const MCExpr *RHS, MCContext &Ctx, SMLoc Loc=SMLoc())
Definition MCExpr.cpp:201
@ Sub
Subtraction.
Definition MCExpr.h:324
virtual void encodeInstruction(const MCInst &Inst, SmallVectorImpl< char > &CB, SmallVectorImpl< MCFixup > &Fixups, const MCSubtargetInfo &STI) const =0
Encode the given Inst to bytes and append to CB.
Context object for machine code objects.
Definition MCContext.h:83
LLVM_ABI MCSymbol * createTempSymbol()
Create a temporary symbol with a unique name.
LLVM_ABI void RemapDebugPaths()
void clearDwarfLocSeen()
Definition MCContext.h:770
LLVM_ABI CodeViewContext & getCVContext()
const SourceMgr * getSourceManager() const
Definition MCContext.h:401
LLVM_ABI void reportError(SMLoc L, const Twine &Msg)
static LLVM_ABI void emit(MCObjectStreamer &streamer, bool isEH)
Definition MCDwarf.cpp:1905
static LLVM_ABI void Emit(MCStreamer *MCOS, MCDwarfLineTableParams Params, int64_t LineDelta, uint64_t AddrDelta)
Utility function to emit the encoding to a streamer.
Definition MCDwarf.cpp:730
static LLVM_ABI void encode(MCContext &Context, MCDwarfLineTableParams Params, int64_t LineDelta, uint64_t AddrDelta, SmallVectorImpl< char > &OS)
Utility function to encode a Dwarf pair of LineDelta and AddrDeltas.
Definition MCDwarf.cpp:745
static LLVM_ABI void make(MCStreamer *MCOS, MCSection *Section)
Definition MCDwarf.cpp:91
static LLVM_ABI void emit(MCStreamer *MCOS, MCDwarfLineTableParams Params)
Definition MCDwarf.cpp:308
Base class for the full range of assembler expressions which are needed for parsing.
Definition MCExpr.h:34
static MCFixupKind getDataKindForSize(unsigned Size)
Return the generic fixup kind for a value with the given size.
Definition MCFixup.h:110
static MCFixup create(uint32_t Offset, const MCExpr *Value, MCFixupKind Kind, bool PCRel=false)
Consider bit fields if we need more flags.
Definition MCFixup.h:86
FragmentType getKind() const
Definition MCSection.h:165
static LLVM_ABI void Emit(MCStreamer *MCOS)
Definition MCDwarf.cpp:1194
Instances of this class represent a single low-level machine instruction.
Definition MCInst.h:188
unsigned getOpcode() const
Definition MCInst.h:202
ArrayRef< MCOperand > getOperands() const
Definition MCInst.h:214
Streaming object file generation interface.
void reset() override
state management
void emitFill(const MCExpr &NumBytes, uint64_t FillValue, SMLoc Loc=SMLoc()) override
Emit Size bytes worth of the value specified by FillValue.
FT * newSpecialFragment(Args &&...args)
void emitValueToAlignment(Align Alignment, int64_t Fill=0, uint8_t FillLen=1, unsigned MaxBytesToEmit=0) override
Emit some number of copies of Value until the byte alignment ByteAlignment is reached.
void emitAssignment(MCSymbol *Symbol, const MCExpr *Value) override
Emit an assignment of Value to Symbol.
void emitCFISections(bool EH, bool Debug, bool SFrame) override
void emitULEB128Value(const MCExpr *Value) override
void emitSLEB128Value(const MCExpr *Value) override
void emitNops(int64_t NumBytes, int64_t ControlledNopLength, SMLoc Loc, const MCSubtargetInfo &STI) override
void emitCVInlineLinetableDirective(unsigned PrimaryFunctionId, unsigned SourceFileId, unsigned SourceLineNum, const MCSymbol *FnStartSym, const MCSymbol *FnEndSym) override
This implements the CodeView '.cv_inline_linetable' assembler directive.
void emitCVStringTableDirective() override
This implements the CodeView '.cv_stringtable' assembler directive.
MCAssembler & getAssembler()
void emitDwarfAdvanceLineAddr(int64_t LineDelta, const MCSymbol *LastLabel, const MCSymbol *Label, unsigned PointerSize) override
If targets does not support representing debug line section by .loc/.file directives in assembly outp...
void emitWeakReference(MCSymbol *Alias, const MCSymbol *Target) override
Emit an weak reference from Alias to Symbol.
void appendContents(ArrayRef< char > Contents)
void emitCVLocDirective(unsigned FunctionId, unsigned FileNo, unsigned Line, unsigned Column, bool PrologueEnd, bool IsStmt, StringRef FileName, SMLoc Loc) override
This implements the CodeView '.cv_loc' assembler directive.
void emitRelocDirective(const MCExpr &Offset, StringRef Name, const MCExpr *Expr, SMLoc Loc={}) override
Record a relocation described by the .reloc directive.
void emitBytes(StringRef Data) override
Emit the bytes in Data into the output.
void emitPendingAssignments(MCSymbol *Symbol)
Emits pending conditional assignments that depend on Symbol being emitted.
void addFixup(const MCExpr *Value, MCFixupKind Kind)
void emitFileDirective(StringRef Filename) override
Switch to a new logical file.
void emitSFrameCalculateFuncOffset(const MCSymbol *FunCabsel, const MCSymbol *FREBegin, MCFragment *FDEFrag, SMLoc Loc)
void emitDwarfLocDirective(unsigned FileNo, unsigned Line, unsigned Column, unsigned Flags, unsigned Isa, unsigned Discriminator, StringRef FileName, StringRef Comment={}) override
This implements the DWARF2 '.loc fileno lineno ...' assembler directive.
MCSymbol * emitCFILabel() override
When emitting an object file, create and emit a real label.
void emitCVDefRangeDirective(ArrayRef< std::pair< const MCSymbol *, const MCSymbol * > > Ranges, StringRef FixedSizePortion) override
This implements the CodeView '.cv_def_range' assembler directive.
MCAssembler * getAssemblerPtr() override
void emitAddrsigSym(const MCSymbol *Sym) override
void emitDwarfLineEndEntry(MCSection *Section, MCSymbol *LastLabel, MCSymbol *EndLabel=nullptr) override
Emit the debug line end entry.
void emitInstruction(const MCInst &Inst, const MCSubtargetInfo &STI) override
Emit the given Instruction into the current section.
void visitUsedSymbol(const MCSymbol &Sym) override
void emitInstToFragment(const MCInst &Inst, const MCSubtargetInfo &)
Emit an instruction to a special fragment, because this instruction can change its size during relaxa...
virtual void emitLabelAtPos(MCSymbol *Symbol, SMLoc Loc, MCFragment &F, uint64_t Offset)
void emitLabel(MCSymbol *Symbol, SMLoc Loc=SMLoc()) override
Emit a label for Symbol into the current section.
MCObjectStreamer(MCContext &Context, std::unique_ptr< MCAsmBackend > TAB, std::unique_ptr< MCObjectWriter > OW, std::unique_ptr< MCCodeEmitter > Emitter)
void emitValueImpl(const MCExpr *Value, unsigned Size, SMLoc Loc=SMLoc()) override
Emit the expression Value into the output as a native integer of the given Size bytes.
void emitPrefAlign(Align Alignment) override
void finishImpl() override
Streamer specific finalization.
void changeSection(MCSection *Section, uint32_t Subsection=0) override
This is called by popSection and switchSection, if the current section changes.
void emitAbsoluteSymbolDiffAsULEB128(const MCSymbol *Hi, const MCSymbol *Lo) override
Emit the absolute difference between two symbols encoded with ULEB128.
MCFragment * allocFragSpace(size_t Headroom)
void emitDwarfAdvanceFrameAddr(const MCSymbol *LastLabel, const MCSymbol *Label, SMLoc Loc)
bool mayHaveInstructions(MCSection &Sec) const override
void emitCodeAlignment(Align ByteAlignment, const MCSubtargetInfo *STI, unsigned MaxBytesToEmit=0) override
Emit nops until the byte alignment ByteAlignment is reached.
~MCObjectStreamer() override
void ensureHeadroom(size_t Headroom)
void emitCVFileChecksumOffsetDirective(unsigned FileNo) override
This implements the CodeView '.cv_filechecksumoffset' assembler directive.
void emitConditionalAssignment(MCSymbol *Symbol, const MCExpr *Value) override
Emit an assignment of Value to Symbol, but only if Value is also emitted.
void emitCVFileChecksumsDirective() override
This implements the CodeView '.cv_filechecksums' assembler directive.
void emitCVLinetableDirective(unsigned FunctionId, const MCSymbol *Begin, const MCSymbol *End) override
This implements the CodeView '.cv_linetable' assembler directive.
void emitValueToOffset(const MCExpr *Offset, unsigned char Value, SMLoc Loc) override
Emit some number of copies of Value until the byte offset Offset is reached.
uint8_t * getCurFragEnd() const
void emitAbsoluteSymbolDiff(const MCSymbol *Hi, const MCSymbol *Lo, unsigned Size) override
Emit the absolute difference between two symbols if possible.
Defines the object file and target independent interfaces used by the assembler backend to write nati...
void emitAddrsigSection()
Tell the object writer to emit an address-significance table during writeObject().
void addAddrsigSymbol(const MCSymbol *Sym)
Record the given symbol in the address-significance table to be written diring writeObject().
static LLVM_ABI void emit(MCObjectStreamer *MCOS)
static void emit(MCObjectStreamer &Streamer)
Definition MCSFrame.cpp:587
Instances of this class represent a uniqued identifier for a section in the current translation unit.
Definition MCSection.h:516
bool hasInstructions() const
Definition MCSection.h:625
void setHasInstructions(bool Value)
Definition MCSection.h:626
void ensurePreferredAlignment(Align PrefAlign)
Definition MCSection.h:615
MCSymbol * getBeginSymbol()
Definition MCSection.h:589
virtual void emitAssignment(MCSymbol *Symbol, const MCExpr *Value)
Emit an assignment of Value to Symbol.
std::unique_ptr< MCLFIRewriter > LFIRewriter
Definition MCStreamer.h:295
virtual void emitCFISections(bool EH, bool Debug, bool SFrame)
virtual void emitInstruction(const MCInst &Inst, const MCSubtargetInfo &STI)
Emit the given Instruction into the current section.
MCFragment * getCurrentFragment() const
Definition MCStreamer.h:438
SmallVector< MCDwarfFrameInfo, 0 > DwarfFrameInfos
Definition MCStreamer.h:269
virtual void emitAbsoluteSymbolDiffAsULEB128(const MCSymbol *Hi, const MCSymbol *Lo)
Emit the absolute difference between two symbols encoded with ULEB128.
bool getUseAssemblerInfoForParsing()
Definition MCStreamer.h:330
MCContext & getContext() const
Definition MCStreamer.h:322
void emitSymbolValue(const MCSymbol *Sym, unsigned Size, bool IsSectionRelative=false)
Special case of EmitValue that avoids the client having to pass in a MCExpr for MCSymbols.
bool checkCVLocSection(unsigned FuncId, unsigned FileNo, SMLoc Loc)
Returns true if the .cv_loc directive is in the right section.
virtual void emitAbsoluteSymbolDiff(const MCSymbol *Hi, const MCSymbol *Lo, unsigned Size)
Emit the absolute difference between two symbols.
virtual void emitLabel(MCSymbol *Symbol, SMLoc Loc=SMLoc())
Emit a label for Symbol into the current section.
void setAllowAutoPadding(bool v)
Definition MCStreamer.h:336
virtual void reset()
State management.
virtual void emitDwarfLocDirective(unsigned FileNo, unsigned Line, unsigned Column, unsigned Flags, unsigned Isa, unsigned Discriminator, StringRef FileName, StringRef Comment={})
This implements the DWARF2 '.loc fileno lineno ...' assembler directive.
virtual void emitCVLinetableDirective(unsigned FunctionId, const MCSymbol *FnStart, const MCSymbol *FnEnd)
This implements the CodeView '.cv_linetable' assembler directive.
MCStreamer(MCContext &Ctx)
MCFragment * CurFrag
Definition MCStreamer.h:267
virtual void emitIntValue(uint64_t Value, unsigned Size)
Special case of EmitValue that avoids the client having to pass in a MCExpr for constant integers.
unsigned getNumFrameInfos()
size_t getCurFragSize() const
Definition MCStreamer.h:447
unsigned emitULEB128IntValue(uint64_t Value, unsigned PadTo=0)
Special case of EmitULEB128Value that avoids the client having to pass in a MCExpr for constant integ...
MCSymbol * endSection(MCSection *Section)
virtual void switchSection(MCSection *Section, uint32_t Subsec=0)
Set the current section where code is being emitted to Section.
virtual void emitCVDefRangeDirective(ArrayRef< std::pair< const MCSymbol *, const MCSymbol * > > Ranges, StringRef FixedSizePortion)
This implements the CodeView '.cv_def_range' assembler directive.
MCSection * getCurrentSectionOnly() const
Definition MCStreamer.h:427
virtual void emitValueImpl(const MCExpr *Value, unsigned Size, SMLoc Loc=SMLoc())
Emit the expression Value into the output as a native integer of the given Size bytes.
void addFragment(MCFragment *F)
unsigned emitSLEB128IntValue(int64_t Value)
Special case of EmitSLEB128Value that avoids the client having to pass in a MCExpr for constant integ...
virtual void emitCVInlineLinetableDirective(unsigned PrimaryFunctionId, unsigned SourceFileId, unsigned SourceLineNum, const MCSymbol *FnStartSym, const MCSymbol *FnEndSym)
This implements the CodeView '.cv_inline_linetable' assembler directive.
void visitUsedExpr(const MCExpr &Expr)
Generic base class for all target subtargets.
static const MCSymbolRefExpr * create(const MCSymbol *Symbol, MCContext &Ctx, SMLoc Loc=SMLoc())
Definition MCExpr.h:214
MCSymbol - Instances of this class represent a symbol name in the MC file, and MCSymbols are created ...
Definition MCSymbol.h:42
MutableArrayRef - Represent a mutable reference to an array (0 or more elements consecutively in memo...
Definition ArrayRef.h:298
Represents a location in source code.
Definition SMLoc.h:22
SmallString - A SmallString is just a SmallVector with methods and accessors that make it work better...
Definition SmallString.h:26
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
LLVM_ABI void PrintMessage(raw_ostream &OS, SMLoc Loc, DiagKind Kind, const Twine &Msg, ArrayRef< SMRange > Ranges={}, ArrayRef< SMFixIt > FixIts={}, bool ShowColors=true) const
Emit a message about the specified location with the specified string.
StringRef - Represent a constant reference to a string, i.e.
Definition StringRef.h:55
constexpr size_t size() const
size - Get the string size.
Definition StringRef.h:143
Target - Wrapper for Target specific information.
Twine - A lightweight data structure for efficiently representing the concatenation of temporary valu...
Definition Twine.h:82
LLVM Value Representation.
Definition Value.h:75
This class represents a function that is read from a sample profile.
Definition FunctionId.h:36
#define INT64_MAX
Definition DataTypes.h:71
This is an optimization pass for GlobalISel generic memory operations.
Definition Types.h:26
@ Offset
Definition DWP.cpp:532
void fill(R &&Range, T &&Value)
Provide wrappers to std::fill which take ranges instead of having to pass begin/end explicitly.
Definition STLExtras.h:1759
@ Debug
Register 'use' is for debugging purpose.
constexpr bool isUIntN(unsigned N, uint64_t x)
Checks if an unsigned integer fits into the given (dynamic) bit width.
Definition MathExtras.h:243
uint16_t MCFixupKind
Extensible enumeration to represent the type of a fixup.
Definition MCFixup.h:22
constexpr T alignToPowerOf2(U Value, V Align)
Will overflow only if result is not representable in T.
Definition MathExtras.h:493
FunctionAddr VTableAddr uintptr_t uintptr_t Data
Definition InstrProf.h:189
ArrayRef(const T &OneElt) -> ArrayRef< T >
OutputIt move(R &&Range, OutputIt Out)
Provide wrappers to std::move which take ranges instead of having to pass begin/end explicitly.
Definition STLExtras.h:1917
decltype(auto) cast(const From &Val)
cast<X> - Return the argument parameter cast to the specified type.
Definition Casting.h:559
constexpr bool isIntN(unsigned N, int64_t x)
Checks if an signed integer fits into the given (dynamic) bit width.
Definition MathExtras.h:248
LLVM_ABI void reportFatalUsageError(Error Err)
Report a fatal error that does not indicate a bug in LLVM.
Definition Error.cpp:177
Implement std::hash so that hash_code can be used in STL containers.
Definition BitVector.h:870
This struct is a compact representation of a valid (non-zero power of two) alignment.
Definition Alignment.h:39
constexpr uint64_t value() const
This is a hole in the type system and should not be abused.
Definition Alignment.h:77