LLVM 23.0.0git
MCStreamer.h
Go to the documentation of this file.
1//===- MCStreamer.h - High-level Streaming Machine Code Output --*- C++ -*-===//
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//
9// This file declares the MCStreamer class.
10//
11//===----------------------------------------------------------------------===//
12
13#ifndef LLVM_MC_MCSTREAMER_H
14#define LLVM_MC_MCSTREAMER_H
15
16#include "llvm/ADT/ArrayRef.h"
17#include "llvm/ADT/DenseMap.h"
19#include "llvm/ADT/StringRef.h"
21#include "llvm/MC/MCDwarf.h"
24#include "llvm/MC/MCSection.h"
25#include "llvm/MC/MCWinEH.h"
27#include "llvm/Support/Error.h"
28#include "llvm/Support/MD5.h"
29#include "llvm/Support/SMLoc.h"
32#include <cassert>
33#include <cstdint>
34#include <memory>
35#include <optional>
36#include <string>
37#include <utility>
38#include <vector>
39
40namespace llvm {
41
42class APInt;
44class MCAsmBackend;
45class MCAssembler;
46class MCLFIRewriter;
47class MCContext;
48class MCExpr;
49class MCInst;
50class MCInstPrinter;
51class MCRegister;
52class MCStreamer;
53class MCSubtargetInfo;
54class MCSymbol;
55class MCSymbolRefExpr;
56class Triple;
57class Twine;
58class raw_ostream;
59
60namespace codeview {
65}
66
67using MCSectionSubPair = std::pair<MCSection *, uint32_t>;
68
69/// Target specific streamer interface. This is used so that targets can
70/// implement support for target specific assembly directives.
71///
72/// If target foo wants to use this, it should implement 3 classes:
73/// * FooTargetStreamer : public MCTargetStreamer
74/// * FooTargetAsmStreamer : public FooTargetStreamer
75/// * FooTargetELFStreamer : public FooTargetStreamer
76///
77/// FooTargetStreamer should have a pure virtual method for each directive. For
78/// example, for a ".bar symbol_name" directive, it should have
79/// virtual emitBar(const MCSymbol &Symbol) = 0;
80///
81/// The FooTargetAsmStreamer and FooTargetELFStreamer classes implement the
82/// method. The assembly streamer just prints ".bar symbol_name". The object
83/// streamer does whatever is needed to implement .bar in the object file.
84///
85/// In the assembly printer and parser the target streamer can be used by
86/// calling getTargetStreamer and casting it to FooTargetStreamer:
87///
88/// MCTargetStreamer &TS = OutStreamer.getTargetStreamer();
89/// FooTargetStreamer &ATS = static_cast<FooTargetStreamer &>(TS);
90///
91/// The base classes FooTargetAsmStreamer and FooTargetELFStreamer should
92/// *never* be treated differently. Callers should always talk to a
93/// FooTargetStreamer.
95protected:
97
98public:
101
103 MCContext &getContext();
104
105 // Allow a target to add behavior to the EmitLabel of MCStreamer.
106 virtual void emitLabel(MCSymbol *Symbol);
107 // Allow a target to add behavior to the emitAssignment of MCStreamer.
108 virtual void emitAssignment(MCSymbol *Symbol, const MCExpr *Value);
109
110 virtual void prettyPrintAsm(MCInstPrinter &InstPrinter, uint64_t Address,
111 const MCInst &Inst, const MCSubtargetInfo &STI,
112 raw_ostream &OS);
113
114 virtual void emitDwarfFileDirective(StringRef Directive);
115
116 /// Update streamer for a new active section.
117 ///
118 /// This is called by popSection and switchSection, if the current
119 /// section changes.
120 virtual void changeSection(const MCSection *CurSection, MCSection *Section,
121 uint32_t SubSection, raw_ostream &OS);
122
123 virtual void emitValue(const MCExpr *Value);
124
125 /// Emit the bytes in \p Data into the output.
126 ///
127 /// This is used to emit bytes in \p Data as sequence of .byte directives.
128 virtual void emitRawBytes(StringRef Data);
129
130 virtual void emitConstantPools();
131
132 virtual void finish();
133};
134
135// FIXME: declared here because it is used from
136// lib/CodeGen/AsmPrinter/ARMException.cpp.
138public:
141
142 virtual void emitFnStart();
143 virtual void emitFnEnd();
144 virtual void emitCantUnwind();
145 virtual void emitPersonality(const MCSymbol *Personality);
146 virtual void emitPersonalityIndex(unsigned Index);
147 virtual void emitHandlerData();
148 virtual void emitSetFP(MCRegister FpReg, MCRegister SpReg,
149 int64_t Offset = 0);
150 virtual void emitMovSP(MCRegister Reg, int64_t Offset = 0);
151 virtual void emitPad(int64_t Offset);
152 virtual void emitRegSave(const SmallVectorImpl<MCRegister> &RegList,
153 bool isVector);
154 virtual void emitUnwindRaw(int64_t StackOffset,
155 const SmallVectorImpl<uint8_t> &Opcodes);
156
157 virtual void switchVendor(StringRef Vendor);
158 virtual void emitAttribute(unsigned Attribute, unsigned Value);
159 virtual void emitTextAttribute(unsigned Attribute, StringRef String);
160 virtual void emitIntTextAttribute(unsigned Attribute, unsigned IntValue,
161 StringRef StringValue = "");
162 virtual void emitFPU(ARM::FPUKind FPU);
163 virtual void emitArch(ARM::ArchKind Arch);
164 virtual void emitArchExtension(uint64_t ArchExt);
165 virtual void emitObjectArch(ARM::ArchKind Arch);
166 void emitTargetAttributes(const MCSubtargetInfo &STI);
167 virtual void finishAttributeSection();
168 virtual void emitInst(uint32_t Inst, char Suffix = '\0');
169
170 virtual void annotateTLSDescriptorSequence(const MCSymbolRefExpr *SRE);
171
172 virtual void emitSyntaxUnified();
173
174 virtual void emitCode16();
175 virtual void emitCode32();
176
177 // Note in the output that the specified \p Symbol is a Thumb mode function.
178 virtual void emitThumbFunc(MCSymbol *Symbol);
179 virtual void emitThumbSet(MCSymbol *Symbol, const MCExpr *Value);
180
181 void emitConstantPools() override;
182
183 virtual void emitARMWinCFIAllocStack(unsigned Size, bool Wide);
184 virtual void emitARMWinCFISaveRegMask(unsigned Mask, bool Wide);
185 virtual void emitARMWinCFISaveSP(unsigned Reg);
186 virtual void emitARMWinCFISaveFRegs(unsigned First, unsigned Last);
187 virtual void emitARMWinCFISaveLR(unsigned Offset);
188 virtual void emitARMWinCFIPrologEnd(bool Fragment);
189 virtual void emitARMWinCFINop(bool Wide);
190 virtual void emitARMWinCFIEpilogStart(unsigned Condition);
191 virtual void emitARMWinCFIEpilogEnd();
192 virtual void emitARMWinCFICustom(unsigned Opcode);
193
194 /// Reset any state between object emissions, i.e. the equivalent of
195 /// MCStreamer's reset method.
196 virtual void reset();
197
198 /// Callback used to implement the ldr= pseudo.
199 /// Add a new entry to the constant pool for the current section and return an
200 /// MCExpr that can be used to refer to the constant pool location.
201 const MCExpr *addConstantPoolEntry(const MCExpr *, SMLoc Loc);
202
203 /// Callback used to implement the .ltorg directive.
204 /// Emit contents of constant pool for the current section.
206
207private:
208 std::unique_ptr<AssemblerConstantPools> ConstantPools;
209};
210
211/// Streaming machine code generation interface.
212///
213/// This interface is intended to provide a programmatic interface that is very
214/// similar to the level that an assembler .s file provides. It has callbacks
215/// to emit bytes, handle directives, etc. The implementation of this interface
216/// retains state to know what the current section is etc.
217///
218/// There are multiple implementations of this interface: one for writing out
219/// a .s file, and implementations that write out .o files of various formats.
220///
222 MCContext &Context;
223 std::unique_ptr<MCTargetStreamer> TargetStreamer;
224
225 // This is a pair of index into DwarfFrameInfos and the MCSection associated
226 // with the frame. Note, we use an index instead of an iterator because they
227 // can be invalidated in std::vector.
229 MCDwarfFrameInfo *getCurrentDwarfFrameInfo();
230
231 /// Similar to DwarfFrameInfos, but for SEH unwind info. Chained frames may
232 /// refer to each other, so use std::unique_ptr to provide pointer stability.
233 std::vector<std::unique_ptr<WinEH::FrameInfo>> WinFrameInfos;
234
235 WinEH::FrameInfo *CurrentWinFrameInfo;
236 size_t CurrentProcWinFrameInfoStartIndex;
237
238 /// This is stack of current and previous section values saved by
239 /// pushSection.
241
242 /// Pointer to the parser's SMLoc if available. This is used to provide
243 /// locations for diagnostics.
244 const SMLoc *StartTokLocPtr = nullptr;
245
246 /// The next unique ID to use when creating a WinCFI-related section (.pdata
247 /// or .xdata). This ID ensures that we have a one-to-one mapping from
248 /// code section to unwind info section, which MSVC's incremental linker
249 /// requires.
250 unsigned NextWinCFIID = 0;
251
252 bool UseAssemblerInfoForParsing = true;
253
254 /// Is the assembler allowed to insert padding automatically? For
255 /// correctness reasons, we sometimes need to ensure instructions aren't
256 /// separated in unexpected ways. At the moment, this feature is only
257 /// useable from an integrated assembler, but assembly syntax is under
258 /// discussion for future inclusion.
259 bool AllowAutoPadding = false;
260
261protected:
262 bool IsObj = false;
263
264 // Symbol of the current epilog for which we are processing SEH directives.
266
267 MCFragment *CurFrag = nullptr;
268
270
271 MCStreamer(MCContext &Ctx);
272
273 /// This is called by popSection and switchSection, if the current
274 /// section changes.
275 virtual void changeSection(MCSection *, uint32_t);
276
277 void addFragment(MCFragment *F);
278
279 virtual void emitCFIStartProcImpl(MCDwarfFrameInfo &Frame);
280 virtual void emitCFIEndProcImpl(MCDwarfFrameInfo &CurFrame);
281
283 return CurrentWinFrameInfo;
284 }
285
286 virtual void emitWindowsUnwindTables(WinEH::FrameInfo *Frame);
287
288 virtual void emitWindowsUnwindTables();
289
290 virtual void emitRawTextImpl(StringRef String);
291
292 /// Returns true if the .cv_loc directive is in the right section.
293 bool checkCVLocSection(unsigned FuncId, unsigned FileNo, SMLoc Loc);
294
295 std::unique_ptr<MCLFIRewriter> LFIRewriter;
296
297public:
298 MCStreamer(const MCStreamer &) = delete;
299 MCStreamer &operator=(const MCStreamer &) = delete;
300 virtual ~MCStreamer();
301
302 void visitUsedExpr(const MCExpr &Expr);
303 virtual void visitUsedSymbol(const MCSymbol &Sym);
304
306 TargetStreamer.reset(TS);
307 }
308
309 void setStartTokLocPtr(const SMLoc *Loc) { StartTokLocPtr = Loc; }
311 return StartTokLocPtr ? *StartTokLocPtr : SMLoc();
312 }
313
314 void setLFIRewriter(std::unique_ptr<MCLFIRewriter> Rewriter);
315
317
318 /// State management
319 ///
320 virtual void reset();
321
322 MCContext &getContext() const { return Context; }
323 bool isObj() const { return IsObj; }
324
325 // MCObjectStreamer has an MCAssembler and allows more expression folding at
326 // parse time.
327 virtual MCAssembler *getAssemblerPtr() { return nullptr; }
328
329 void setUseAssemblerInfoForParsing(bool v) { UseAssemblerInfoForParsing = v; }
330 bool getUseAssemblerInfoForParsing() { return UseAssemblerInfoForParsing; }
331
333 return TargetStreamer.get();
334 }
335
336 void setAllowAutoPadding(bool v) { AllowAutoPadding = v; }
337 bool getAllowAutoPadding() const { return AllowAutoPadding; }
338
339 MCSymbol *emitLineTableLabel();
340
341 /// When emitting an object file, create and emit a real label. When emitting
342 /// textual assembly, this should do nothing to avoid polluting our output.
343 virtual MCSymbol *emitCFILabel();
344
345 /// Retrieve the current frame info if one is available and it is not yet
346 /// closed. Otherwise, issue an error and return null.
347 WinEH::FrameInfo *EnsureValidWinFrameInfo(SMLoc Loc);
348
349 unsigned getNumFrameInfos();
350 ArrayRef<MCDwarfFrameInfo> getDwarfFrameInfos() const;
351
352 bool hasUnfinishedDwarfFrameInfo();
353
354 unsigned getNumWinFrameInfos() { return WinFrameInfos.size(); }
356 return WinFrameInfos;
357 }
358
362
363 bool isInEpilogCFI() const { return CurrentWinEpilog; }
364
365 /// \name Assembly File Formatting.
366 /// @{
367
368 /// Return true if this streamer supports verbose assembly and if it is
369 /// enabled.
370 virtual bool isVerboseAsm() const { return false; }
371
372 /// Return true if this asm streamer supports emitting unformatted text
373 /// to the .s file with EmitRawText.
374 virtual bool hasRawTextSupport() const { return false; }
375
376 /// Is the integrated assembler required for this streamer to function
377 /// correctly?
378 virtual bool isIntegratedAssemblerRequired() const { return false; }
379
380 /// Add a textual comment.
381 ///
382 /// Typically for comments that can be emitted to the generated .s
383 /// file if applicable as a QoI issue to make the output of the compiler
384 /// more readable. This only affects the MCAsmStreamer, and only when
385 /// verbose assembly output is enabled.
386 ///
387 /// If the comment includes embedded \n's, they will each get the comment
388 /// prefix as appropriate. The added comment should not end with a \n.
389 /// By default, each comment is terminated with an end of line, i.e. the
390 /// EOL param is set to true by default. If one prefers not to end the
391 /// comment with a new line then the EOL param should be passed
392 /// with a false value.
393 virtual void AddComment(const Twine &T, bool EOL = true) {}
394
395 /// Return a raw_ostream that comments can be written to. Unlike
396 /// AddComment, you are required to terminate comments with \n if you use this
397 /// method.
398 virtual raw_ostream &getCommentOS();
399
400 /// Print T and prefix it with the comment string (normally #) and
401 /// optionally a tab. This prints the comment immediately, not at the end of
402 /// the current line. It is basically a safe version of EmitRawText: since it
403 /// only prints comments, the object streamer ignores it instead of asserting.
404 virtual void emitRawComment(const Twine &T, bool TabPrefix = true);
405
406 /// Add explicit comment T. T is required to be a valid
407 /// comment in the output and does not need to be escaped.
408 virtual void addExplicitComment(const Twine &T);
409
410 /// Emit added explicit comments.
411 virtual void emitExplicitComments();
412
413 /// Emit a blank line to a .s file to pretty it up.
414 virtual void addBlankLine() {}
415
416 /// @}
417
418 /// \name Symbol & Section Management
419 /// @{
420
421 /// Return the current section that the streamer is emitting code to.
423 if (!SectionStack.empty())
424 return SectionStack.back().first;
425 return MCSectionSubPair();
426 }
428 return CurFrag->getParent();
429 }
430
431 /// Return the previous section that the streamer is emitting code to.
433 if (!SectionStack.empty())
434 return SectionStack.back().second;
435 return MCSectionSubPair();
436 }
437
439 // Ensure consistency with the section stack.
440 assert(!getCurrentSection().first ||
441 CurFrag->getParent() == getCurrentSection().first);
442 // Ensure we eagerly allocate an empty fragment after adding fragment with a
443 // variable-size tail.
444 assert(!CurFrag || CurFrag->getKind() == MCFragment::FT_Data);
445 return CurFrag;
446 }
447 size_t getCurFragSize() const { return getCurrentFragment()->getFixedSize(); }
448 /// Save the current and previous section on the section stack.
449 void pushSection() {
450 SectionStack.push_back(
451 std::make_pair(getCurrentSection(), getPreviousSection()));
452 }
453
454 /// Restore the current and previous section from the section stack.
455 /// Calls changeSection as needed.
456 ///
457 /// Returns false if the stack was empty.
458 virtual bool popSection();
459
460 /// Set the current section where code is being emitted to \p Section. This
461 /// is required to update CurSection.
462 ///
463 /// This corresponds to assembler directives like .section, .text, etc.
464 virtual void switchSection(MCSection *Section, uint32_t Subsec = 0);
465 bool switchSection(MCSection *Section, const MCExpr *);
466
467 /// Similar to switchSection, but does not print the section directive.
468 void switchSectionNoPrint(MCSection *Section);
469
470 /// Create the default sections and set the initial one.
471 virtual void initSections(bool NoExecStack, const MCSubtargetInfo &STI);
472
473 MCSymbol *endSection(MCSection *Section);
474
475 /// Returns the mnemonic for \p MI, if the streamer has access to a
476 /// instruction printer and returns an empty string otherwise.
477 virtual StringRef getMnemonic(const MCInst &MI) const { return ""; }
478
479 /// Emit a label for \p Symbol into the current section.
480 ///
481 /// This corresponds to an assembler statement such as:
482 /// foo:
483 ///
484 /// \param Symbol - The symbol to emit. A given symbol should only be
485 /// emitted as a label once, and symbols emitted as a label should never be
486 /// used in an assignment.
487 // FIXME: These emission are non-const because we mutate the symbol to
488 // add the section we're emitting it to later.
489 virtual void emitLabel(MCSymbol *Symbol, SMLoc Loc = SMLoc());
490
491 virtual void emitEHSymAttributes(const MCSymbol *Symbol, MCSymbol *EHSymbol);
492
493 /// Emit a .subsection_via_symbols directive.
494 virtual void emitSubsectionsViaSymbols();
495
496 /// Emit the given list \p Options of strings as linker
497 /// options into the output.
499
500 /// Note in the output the specified region \p Kind.
501 virtual void emitDataRegion(MCDataRegionType Kind) {}
502
503 /// Specify the Mach-O minimum deployment target version.
504 virtual void emitVersionMin(MCVersionMinType Type, unsigned Major,
505 unsigned Minor, unsigned Update,
506 VersionTuple SDKVersion) {}
507
508 /// Emit/Specify Mach-O build version command.
509 /// \p Platform should be one of MachO::PlatformType.
510 virtual void emitBuildVersion(unsigned Platform, unsigned Major,
511 unsigned Minor, unsigned Update,
512 VersionTuple SDKVersion) {}
513
514 virtual void emitDarwinTargetVariantBuildVersion(unsigned Platform,
515 unsigned Major,
516 unsigned Minor,
517 unsigned Update,
518 VersionTuple SDKVersion) {}
519
520 void emitVersionForTarget(const Triple &Target,
521 const VersionTuple &SDKVersion,
522 const Triple *DarwinTargetVariantTriple,
523 const VersionTuple &DarwinTargetVariantSDKVersion);
524
525 /// Emit an assignment of \p Value to \p Symbol.
526 ///
527 /// This corresponds to an assembler statement such as:
528 /// symbol = value
529 ///
530 /// The assignment generates no code, but has the side effect of binding the
531 /// value in the current context. For the assembly streamer, this prints the
532 /// binding into the .s file.
533 ///
534 /// \param Symbol - The symbol being assigned to.
535 /// \param Value - The value for the symbol.
536 virtual void emitAssignment(MCSymbol *Symbol, const MCExpr *Value);
537
538 /// Emit an assignment of \p Value to \p Symbol, but only if \p Value is also
539 /// emitted.
540 virtual void emitConditionalAssignment(MCSymbol *Symbol, const MCExpr *Value);
541
542 /// Emit an weak reference from \p Alias to \p Symbol.
543 ///
544 /// This corresponds to an assembler statement such as:
545 /// .weakref alias, symbol
546 ///
547 /// \param Alias - The alias that is being created.
548 /// \param Symbol - The symbol being aliased.
549 virtual void emitWeakReference(MCSymbol *Alias, const MCSymbol *Symbol);
550
551 /// Add the given \p Attribute to \p Symbol.
552 virtual bool emitSymbolAttribute(MCSymbol *Symbol,
554
555 /// Set the \p DescValue for the \p Symbol.
556 ///
557 /// \param Symbol - The symbol to have its n_desc field set.
558 /// \param DescValue - The value to set into the n_desc field.
559 virtual void emitSymbolDesc(MCSymbol *Symbol, unsigned DescValue);
560
561 /// Start emitting COFF symbol definition
562 ///
563 /// \param Symbol - The symbol to have its External & Type fields set.
564 virtual void beginCOFFSymbolDef(const MCSymbol *Symbol);
565
566 /// Emit the storage class of the symbol.
567 ///
568 /// \param StorageClass - The storage class the symbol should have.
570
571 /// Emit the type of the symbol.
572 ///
573 /// \param Type - A COFF type identifier (see COFF::SymbolType in X86COFF.h)
574 virtual void emitCOFFSymbolType(int Type);
575
576 /// Marks the end of the symbol definition.
577 virtual void endCOFFSymbolDef();
578
579 virtual void emitCOFFSafeSEH(MCSymbol const *Symbol);
580
581 /// Emits the symbol table index of a Symbol into the current section.
582 virtual void emitCOFFSymbolIndex(MCSymbol const *Symbol);
583
584 /// Emits a COFF section index.
585 ///
586 /// \param Symbol - Symbol the section number relocation should point to.
587 virtual void emitCOFFSectionIndex(MCSymbol const *Symbol);
588
589 /// Emits a COFF section relative relocation.
590 ///
591 /// \param Symbol - Symbol the section relative relocation should point to.
592 virtual void emitCOFFSecRel32(MCSymbol const *Symbol, uint64_t Offset);
593
594 /// Emits a COFF image relative relocation.
595 ///
596 /// \param Symbol - Symbol the image relative relocation should point to.
597 virtual void emitCOFFImgRel32(MCSymbol const *Symbol, int64_t Offset);
598
599 /// Emits the physical number of the section containing the given symbol as
600 /// assigned during object writing (i.e., this is not a runtime relocation).
601 virtual void emitCOFFSecNumber(MCSymbol const *Symbol);
602
603 /// Emits the offset of the symbol from the beginning of the section during
604 /// object writing (i.e., this is not a runtime relocation).
605 virtual void emitCOFFSecOffset(MCSymbol const *Symbol);
606
607 /// Emits an lcomm directive with XCOFF csect information.
608 ///
609 /// \param LabelSym - Label on the block of storage.
610 /// \param Size - The size of the block of storage.
611 /// \param CsectSym - Csect name for the block of storage.
612 /// \param Alignment - The alignment of the symbol in bytes.
613 virtual void emitXCOFFLocalCommonSymbol(MCSymbol *LabelSym, uint64_t Size,
614 MCSymbol *CsectSym, Align Alignment);
615
616 /// Emit a symbol's linkage and visibility with a linkage directive for XCOFF.
617 ///
618 /// \param Symbol - The symbol to emit.
619 /// \param Linkage - The linkage of the symbol to emit.
620 /// \param Visibility - The visibility of the symbol to emit or MCSA_Invalid
621 /// if the symbol does not have an explicit visibility.
624 MCSymbolAttr Visibility);
625
626 /// Emit a XCOFF .rename directive which creates a synonym for an illegal or
627 /// undesirable name.
628 ///
629 /// \param Name - The name used internally in the assembly for references to
630 /// the symbol.
631 /// \param Rename - The value to which the Name parameter is
632 /// changed at the end of assembly.
633 virtual void emitXCOFFRenameDirective(const MCSymbol *Name, StringRef Rename);
634
635 /// Emit an XCOFF .except directive which adds information about
636 /// a trap instruction to the object file exception section
637 ///
638 /// \param Symbol - The function containing the trap.
639 /// \param Lang - The language code for the exception entry.
640 /// \param Reason - The reason code for the exception entry.
641 virtual void emitXCOFFExceptDirective(const MCSymbol *Symbol,
642 const MCSymbol *Trap,
643 unsigned Lang, unsigned Reason,
644 unsigned FunctionSize, bool hasDebug);
645
646 /// Emit a XCOFF .ref directive which creates R_REF type entry in the
647 /// relocation table for one or more symbols.
648 ///
649 /// \param Sym - The symbol on the .ref directive.
650 virtual void emitXCOFFRefDirective(const MCSymbol *Symbol);
651
652 /// Emit a C_INFO symbol with XCOFF embedded metadata to the .info section.
653 ///
654 /// \param Name - The embedded metadata name
655 /// \param Metadata - The embedded metadata
656 virtual void emitXCOFFCInfoSym(StringRef Name, StringRef Metadata);
657
658 /// Emit an ELF .size directive.
659 ///
660 /// This corresponds to an assembler statement such as:
661 /// .size symbol, expression
662 virtual void emitELFSize(MCSymbol *Symbol, const MCExpr *Value);
663
664 /// Emit an ELF .symver directive.
665 ///
666 /// This corresponds to an assembler statement such as:
667 /// .symver _start, foo@@SOME_VERSION
668 virtual void emitELFSymverDirective(const MCSymbol *OriginalSym,
669 StringRef Name, bool KeepOriginalSym);
670
671 /// Emit a Linker Optimization Hint (LOH) directive.
672 /// \param Args - Arguments of the LOH.
673 virtual void emitLOHDirective(MCLOHType Kind, const MCLOHArgs &Args) {}
674
675 /// Emit a .gnu_attribute directive.
676 virtual void emitGNUAttribute(unsigned Tag, unsigned Value) {}
677
678 /// Emit a common symbol.
679 ///
680 /// \param Symbol - The common symbol to emit.
681 /// \param Size - The size of the common symbol.
682 /// \param ByteAlignment - The alignment of the symbol.
683 virtual void emitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
684 Align ByteAlignment) = 0;
685
686 /// Emit a local common (.lcomm) symbol.
687 ///
688 /// \param Symbol - The common symbol to emit.
689 /// \param Size - The size of the common symbol.
690 /// \param ByteAlignment - The alignment of the common symbol in bytes.
691 virtual void emitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size,
692 Align ByteAlignment);
693
694 /// Emit the zerofill section and an optional symbol.
695 ///
696 /// \param Section - The zerofill section to create and or to put the symbol
697 /// \param Symbol - The zerofill symbol to emit, if non-NULL.
698 /// \param Size - The size of the zerofill symbol.
699 /// \param ByteAlignment - The alignment of the zerofill symbol.
700 virtual void emitZerofill(MCSection *Section, MCSymbol *Symbol = nullptr,
701 uint64_t Size = 0, Align ByteAlignment = Align(1),
702 SMLoc Loc = SMLoc());
703
704 /// Emit a thread local bss (.tbss) symbol.
705 ///
706 /// \param Section - The thread local common section.
707 /// \param Symbol - The thread local common symbol to emit.
708 /// \param Size - The size of the symbol.
709 /// \param ByteAlignment - The alignment of the thread local common symbol.
710 virtual void emitTBSSSymbol(MCSection *Section, MCSymbol *Symbol,
711 uint64_t Size, Align ByteAlignment = Align(1));
712
713 /// @}
714 /// \name Generating Data
715 /// @{
716
717 /// Emit the bytes in \p Data into the output.
718 ///
719 /// This is used to implement assembler directives such as .byte, .ascii,
720 /// etc.
721 virtual void emitBytes(StringRef Data);
722
723 /// Functionally identical to EmitBytes. When emitting textual assembly, this
724 /// method uses .byte directives instead of .ascii or .asciz for readability.
725 virtual void emitBinaryData(StringRef Data);
726
727 /// Emit the expression \p Value into the output as a native
728 /// integer of the given \p Size bytes.
729 ///
730 /// This is used to implement assembler directives such as .word, .quad,
731 /// etc.
732 ///
733 /// \param Value - The value to emit.
734 /// \param Size - The size of the integer (in bytes) to emit. This must
735 /// match a native machine width.
736 /// \param Loc - The location of the expression for error reporting.
737 virtual void emitValueImpl(const MCExpr *Value, unsigned Size,
738 SMLoc Loc = SMLoc());
739
740 void emitValue(const MCExpr *Value, unsigned Size, SMLoc Loc = SMLoc());
741
742 /// Special case of EmitValue that avoids the client having
743 /// to pass in a MCExpr for constant integers.
744 virtual void emitIntValue(uint64_t Value, unsigned Size);
745 virtual void emitIntValue(const APInt &Value);
746
747 /// Special case of EmitValue that avoids the client having to pass
748 /// in a MCExpr for constant integers & prints in Hex format for certain
749 /// modes.
750 virtual void emitIntValueInHex(uint64_t Value, unsigned Size) {
752 }
753
758
759 /// Special case of EmitValue that avoids the client having to pass
760 /// in a MCExpr for constant integers & prints in Hex format for certain
761 /// modes, pads the field with leading zeros to Size width
764 }
765
766 virtual void emitULEB128Value(const MCExpr *Value);
767
768 virtual void emitSLEB128Value(const MCExpr *Value);
769
770 /// Special case of EmitULEB128Value that avoids the client having to
771 /// pass in a MCExpr for constant integers.
772 unsigned emitULEB128IntValue(uint64_t Value, unsigned PadTo = 0);
773
774 /// Special case of EmitSLEB128Value that avoids the client having to
775 /// pass in a MCExpr for constant integers.
776 unsigned emitSLEB128IntValue(int64_t Value);
777
778 /// Special case of EmitValue that avoids the client having to pass in
779 /// a MCExpr for MCSymbols.
780 void emitSymbolValue(const MCSymbol *Sym, unsigned Size,
781 bool IsSectionRelative = false);
782
783 /// Emit NumBytes bytes worth of the value specified by FillValue.
784 /// This implements directives such as '.space'.
785 void emitFill(uint64_t NumBytes, uint8_t FillValue);
786
787 /// Emit \p Size bytes worth of the value specified by \p FillValue.
788 ///
789 /// This is used to implement assembler directives such as .space or .skip.
790 ///
791 /// \param NumBytes - The number of bytes to emit.
792 /// \param FillValue - The value to use when filling bytes.
793 /// \param Loc - The location of the expression for error reporting.
794 virtual void emitFill(const MCExpr &NumBytes, uint64_t FillValue,
795 SMLoc Loc = SMLoc());
796
797 /// Emit \p NumValues copies of \p Size bytes. Each \p Size bytes is
798 /// taken from the lowest order 4 bytes of \p Expr expression.
799 ///
800 /// This is used to implement assembler directives such as .fill.
801 ///
802 /// \param NumValues - The number of copies of \p Size bytes to emit.
803 /// \param Size - The size (in bytes) of each repeated value.
804 /// \param Expr - The expression from which \p Size bytes are used.
805 virtual void emitFill(const MCExpr &NumValues, int64_t Size, int64_t Expr,
806 SMLoc Loc = SMLoc());
807
808 virtual void emitNops(int64_t NumBytes, int64_t ControlledNopLength,
809 SMLoc Loc, const MCSubtargetInfo& STI);
810
811 /// Emit NumBytes worth of zeros.
812 /// This function properly handles data in virtual sections.
813 void emitZeros(uint64_t NumBytes);
814
815 /// Emit some number of copies of \p Value until the byte alignment \p
816 /// ByteAlignment is reached.
817 ///
818 /// If the number of bytes need to emit for the alignment is not a multiple
819 /// of \p ValueSize, then the contents of the emitted fill bytes is
820 /// undefined.
821 ///
822 /// This used to implement the .align assembler directive.
823 ///
824 /// \param Alignment - The alignment to reach.
825 /// \param Fill - The value to use when filling bytes.
826 /// \param FillLen - The size of the integer (in bytes) to emit for
827 /// \p Value. This must match a native machine width.
828 /// \param MaxBytesToEmit - The maximum numbers of bytes to emit, or 0. If
829 /// the alignment cannot be reached in this many bytes, no bytes are
830 /// emitted.
831 virtual void emitValueToAlignment(Align Alignment, int64_t Fill = 0,
832 uint8_t FillLen = 1,
833 unsigned MaxBytesToEmit = 0);
834
835 /// Emit nops until the byte alignment \p ByteAlignment is reached.
836 ///
837 /// This used to align code where the alignment bytes may be executed. This
838 /// can emit different bytes for different sizes to optimize execution.
839 ///
840 /// \param Alignment - The alignment to reach.
841 /// \param STI - The MCSubtargetInfo in operation when padding is emitted.
842 /// \param MaxBytesToEmit - The maximum numbers of bytes to emit, or 0. If
843 /// the alignment cannot be reached in this many bytes, no bytes are
844 /// emitted.
845 virtual void emitCodeAlignment(Align Alignment, const MCSubtargetInfo *STI,
846 unsigned MaxBytesToEmit = 0);
847
848 virtual void emitPrefAlign(Align A);
849
850 /// Emit some number of copies of \p Value until the byte offset \p
851 /// Offset is reached.
852 ///
853 /// This is used to implement assembler directives such as .org.
854 ///
855 /// \param Offset - The offset to reach. This may be an expression, but the
856 /// expression must be associated with the current section.
857 /// \param Value - The value to use when filling bytes.
858 virtual void emitValueToOffset(const MCExpr *Offset, unsigned char Value,
859 SMLoc Loc);
860
861 /// @}
862
863 /// Switch to a new logical file. This is used to implement the '.file
864 /// "foo.c"' assembler directive.
865 virtual void emitFileDirective(StringRef Filename);
866
867 /// Emit ".file assembler diretive with additioal info.
868 virtual void emitFileDirective(StringRef Filename, StringRef CompilerVersion,
869 StringRef TimeStamp, StringRef Description);
870
871 /// Emit the "identifiers" directive. This implements the
872 /// '.ident "version foo"' assembler directive.
873 virtual void emitIdent(StringRef IdentString) {}
874
875 /// Associate a filename with a specified logical file number. This
876 /// implements the DWARF2 '.file 4 "foo.c"' assembler directive.
878 unsigned FileNo, StringRef Directory, StringRef Filename,
879 std::optional<MD5::MD5Result> Checksum = std::nullopt,
880 std::optional<StringRef> Source = std::nullopt, unsigned CUID = 0) {
881 return cantFail(
882 tryEmitDwarfFileDirective(FileNo, Directory, Filename, Checksum,
883 Source, CUID));
884 }
885
886 /// Associate a filename with a specified logical file number.
887 /// Also associate a directory, optional checksum, and optional source
888 /// text with the logical file. This implements the DWARF2
889 /// '.file 4 "dir/foo.c"' assembler directive, and the DWARF5
890 /// '.file 4 "dir/foo.c" md5 "..." source "..."' assembler directive.
891 virtual Expected<unsigned> tryEmitDwarfFileDirective(
892 unsigned FileNo, StringRef Directory, StringRef Filename,
893 std::optional<MD5::MD5Result> Checksum = std::nullopt,
894 std::optional<StringRef> Source = std::nullopt, unsigned CUID = 0);
895
896 /// Specify the "root" file of the compilation, using the ".file 0" extension.
897 virtual void emitDwarfFile0Directive(StringRef Directory, StringRef Filename,
898 std::optional<MD5::MD5Result> Checksum,
899 std::optional<StringRef> Source,
900 unsigned CUID = 0);
901
902 virtual void emitCFIBKeyFrame();
903 virtual void emitCFIMTETaggedFrame();
904
905 /// This implements the DWARF2 '.loc fileno lineno ...' assembler
906 /// directive.
907 virtual void emitDwarfLocDirective(unsigned FileNo, unsigned Line,
908 unsigned Column, unsigned Flags,
909 unsigned Isa, unsigned Discriminator,
910 StringRef FileName,
911 StringRef Comment = {});
912
913 /// This is same as emitDwarfLocDirective, except it has the capability to
914 /// add inlined_at information.
916 unsigned FileNo, unsigned Line, unsigned Column, unsigned FileIA,
917 unsigned LineIA, unsigned ColumnIA, const MCSymbol *Sym, unsigned Flags,
918 unsigned Isa, unsigned Discriminator, StringRef FileName,
919 StringRef Comment = {}) {}
920
921 /// This implements the '.loc_label Name' directive.
922 virtual void emitDwarfLocLabelDirective(SMLoc Loc, StringRef Name);
923
924 /// Associate a filename with a specified logical file number, and also
925 /// specify that file's checksum information. This implements the '.cv_file 4
926 /// "foo.c"' assembler directive. Returns true on success.
927 virtual bool emitCVFileDirective(unsigned FileNo, StringRef Filename,
928 ArrayRef<uint8_t> Checksum,
929 unsigned ChecksumKind);
930
931 /// Introduces a function id for use with .cv_loc.
932 virtual bool emitCVFuncIdDirective(unsigned FunctionId);
933
934 /// Introduces an inline call site id for use with .cv_loc. Includes
935 /// extra information for inline line table generation.
936 virtual bool emitCVInlineSiteIdDirective(unsigned FunctionId, unsigned IAFunc,
937 unsigned IAFile, unsigned IALine,
938 unsigned IACol, SMLoc Loc);
939
940 /// This implements the CodeView '.cv_loc' assembler directive.
941 virtual void emitCVLocDirective(unsigned FunctionId, unsigned FileNo,
942 unsigned Line, unsigned Column,
943 bool PrologueEnd, bool IsStmt,
944 StringRef FileName, SMLoc Loc);
945
946 /// This implements the CodeView '.cv_linetable' assembler directive.
947 virtual void emitCVLinetableDirective(unsigned FunctionId,
948 const MCSymbol *FnStart,
949 const MCSymbol *FnEnd);
950
951 /// This implements the CodeView '.cv_inline_linetable' assembler
952 /// directive.
953 virtual void emitCVInlineLinetableDirective(unsigned PrimaryFunctionId,
954 unsigned SourceFileId,
955 unsigned SourceLineNum,
956 const MCSymbol *FnStartSym,
957 const MCSymbol *FnEndSym);
958
959 /// This implements the CodeView '.cv_def_range' assembler
960 /// directive.
961 virtual void emitCVDefRangeDirective(
962 ArrayRef<std::pair<const MCSymbol *, const MCSymbol *>> Ranges,
963 StringRef FixedSizePortion);
964
965 virtual void emitCVDefRangeDirective(
966 ArrayRef<std::pair<const MCSymbol *, const MCSymbol *>> Ranges,
967 codeview::DefRangeRegisterRelHeader DRHdr);
968
969 virtual void emitCVDefRangeDirective(
970 ArrayRef<std::pair<const MCSymbol *, const MCSymbol *>> Ranges,
971 codeview::DefRangeSubfieldRegisterHeader DRHdr);
972
973 virtual void emitCVDefRangeDirective(
974 ArrayRef<std::pair<const MCSymbol *, const MCSymbol *>> Ranges,
975 codeview::DefRangeRegisterHeader DRHdr);
976
977 virtual void emitCVDefRangeDirective(
978 ArrayRef<std::pair<const MCSymbol *, const MCSymbol *>> Ranges,
979 codeview::DefRangeFramePointerRelHeader DRHdr);
980
981 /// This implements the CodeView '.cv_stringtable' assembler directive.
983
984 /// This implements the CodeView '.cv_filechecksums' assembler directive.
986
987 /// This implements the CodeView '.cv_filechecksumoffset' assembler
988 /// directive.
989 virtual void emitCVFileChecksumOffsetDirective(unsigned FileNo) {}
990
991 /// This implements the CodeView '.cv_fpo_data' assembler directive.
992 virtual void emitCVFPOData(const MCSymbol *ProcSym, SMLoc Loc = {}) {}
993
994 /// Emit the absolute difference between two symbols.
995 ///
996 /// \pre Offset of \c Hi is greater than the offset \c Lo.
997 virtual void emitAbsoluteSymbolDiff(const MCSymbol *Hi, const MCSymbol *Lo,
998 unsigned Size);
999
1000 /// Emit the absolute difference between two symbols encoded with ULEB128.
1001 virtual void emitAbsoluteSymbolDiffAsULEB128(const MCSymbol *Hi,
1002 const MCSymbol *Lo);
1003
1004 virtual MCSymbol *getDwarfLineTableSymbol(unsigned CUID);
1005 virtual void emitCFISections(bool EH, bool Debug, bool SFrame);
1006 void emitCFIStartProc(bool IsSimple, SMLoc Loc = SMLoc());
1007 void emitCFIEndProc();
1008 virtual void emitCFIDefCfa(int64_t Register, int64_t Offset, SMLoc Loc = {});
1009 virtual void emitCFIDefCfaOffset(int64_t Offset, SMLoc Loc = {});
1010 virtual void emitCFIDefCfaRegister(int64_t Register, SMLoc Loc = {});
1011 virtual void emitCFILLVMDefAspaceCfa(int64_t Register, int64_t Offset,
1012 int64_t AddressSpace, SMLoc Loc = {});
1013 virtual void emitCFIOffset(int64_t Register, int64_t Offset, SMLoc Loc = {});
1014 virtual void emitCFIPersonality(const MCSymbol *Sym, unsigned Encoding);
1015 virtual void emitCFILsda(const MCSymbol *Sym, unsigned Encoding);
1016 virtual void emitCFIRememberState(SMLoc Loc);
1017 virtual void emitCFIRestoreState(SMLoc Loc);
1018 virtual void emitCFISameValue(int64_t Register, SMLoc Loc = {});
1019 virtual void emitCFIRestore(int64_t Register, SMLoc Loc = {});
1020 virtual void emitCFIRelOffset(int64_t Register, int64_t Offset, SMLoc Loc);
1021 virtual void emitCFIAdjustCfaOffset(int64_t Adjustment, SMLoc Loc = {});
1022 virtual void emitCFIEscape(StringRef Values, SMLoc Loc = {});
1023 virtual void emitCFIReturnColumn(int64_t Register);
1024 virtual void emitCFIGnuArgsSize(int64_t Size, SMLoc Loc = {});
1025 virtual void emitCFISignalFrame();
1026 virtual void emitCFIUndefined(int64_t Register, SMLoc Loc = {});
1027 virtual void emitCFIRegister(int64_t Register1, int64_t Register2,
1028 SMLoc Loc = {});
1029 virtual void emitCFIWindowSave(SMLoc Loc = {});
1030 virtual void emitCFINegateRAState(SMLoc Loc = {});
1031 virtual void emitCFINegateRAStateWithPC(SMLoc Loc = {});
1032 virtual void emitCFILabelDirective(SMLoc Loc, StringRef Name);
1033 virtual void emitCFIValOffset(int64_t Register, int64_t Offset,
1034 SMLoc Loc = {});
1035
1036 virtual void emitWinCFIStartProc(const MCSymbol *Symbol, SMLoc Loc = SMLoc());
1037 virtual void emitWinCFIEndProc(SMLoc Loc = SMLoc());
1038 /// This is used on platforms, such as Windows on ARM64, that require function
1039 /// or funclet sizes to be emitted in .xdata before the End marker is emitted
1040 /// for the frame. We cannot use the End marker, as it is not set at the
1041 /// point of emitting .xdata, in order to indicate that the frame is active.
1042 virtual void emitWinCFIFuncletOrFuncEnd(SMLoc Loc = SMLoc());
1043 virtual void emitWinCFISplitChained(SMLoc Loc = SMLoc());
1044 virtual void emitWinCFIPushReg(MCRegister Register, SMLoc Loc = SMLoc());
1045 virtual void emitWinCFISetFrame(MCRegister Register, unsigned Offset,
1046 SMLoc Loc = SMLoc());
1047 virtual void emitWinCFIAllocStack(unsigned Size, SMLoc Loc = SMLoc());
1048 virtual void emitWinCFISaveReg(MCRegister Register, unsigned Offset,
1049 SMLoc Loc = SMLoc());
1050 virtual void emitWinCFISaveXMM(MCRegister Register, unsigned Offset,
1051 SMLoc Loc = SMLoc());
1052 virtual void emitWinCFIPushFrame(bool Code, SMLoc Loc = SMLoc());
1053 virtual void emitWinCFIEndProlog(SMLoc Loc = SMLoc());
1054 virtual void emitWinCFIBeginEpilogue(SMLoc Loc = SMLoc());
1055 virtual void emitWinCFIEndEpilogue(SMLoc Loc = SMLoc());
1056 virtual void emitWinCFIUnwindV2Start(SMLoc Loc = SMLoc());
1057 virtual void emitWinCFIUnwindVersion(uint8_t Version, SMLoc Loc = SMLoc());
1058 virtual void emitWinEHHandler(const MCSymbol *Sym, bool Unwind, bool Except,
1059 SMLoc Loc = SMLoc());
1060 virtual void emitWinEHHandlerData(SMLoc Loc = SMLoc());
1061
1062 virtual void emitCGProfileEntry(const MCSymbolRefExpr *From,
1063 const MCSymbolRefExpr *To, uint64_t Count);
1064
1065 /// Get the .pdata section used for the given section. Typically the given
1066 /// section is either the main .text section or some other COMDAT .text
1067 /// section, but it may be any section containing code.
1068 MCSection *getAssociatedPDataSection(const MCSection *TextSec);
1069
1070 /// Get the .xdata section used for the given section.
1071 MCSection *getAssociatedXDataSection(const MCSection *TextSec);
1072
1073 virtual void emitSyntaxDirective(StringRef Syntax, StringRef Options);
1074
1075 /// Record a relocation described by the .reloc directive.
1076 virtual void emitRelocDirective(const MCExpr &Offset, StringRef Name,
1077 const MCExpr *Expr, SMLoc Loc = {}) {}
1078
1079 virtual void emitAddrsig() {}
1080 virtual void emitAddrsigSym(const MCSymbol *Sym) {}
1081
1082 /// Emit the given \p Instruction into the current section.
1083 virtual void emitInstruction(const MCInst &Inst, const MCSubtargetInfo &STI);
1084
1085 /// Emit the a pseudo probe into the current section.
1086 virtual void emitPseudoProbe(uint64_t Guid, uint64_t Index, uint64_t Type,
1087 uint64_t Attr, uint64_t Discriminator,
1088 const MCPseudoProbeInlineStack &InlineStack,
1089 MCSymbol *FnSym);
1090
1091 /// If this file is backed by a assembly streamer, this dumps the
1092 /// specified string in the output .s file. This capability is indicated by
1093 /// the hasRawTextSupport() predicate. By default this aborts.
1094 void emitRawText(const Twine &String);
1095
1096 /// Streamer specific finalization.
1097 virtual void finishImpl();
1098 /// Finish emission of machine code.
1099 void finish(SMLoc EndLoc = SMLoc());
1100
1101 virtual bool mayHaveInstructions(MCSection &Sec) const { return true; }
1102
1103 /// Emit a special value of 0xffffffff if producing 64-bit debugging info.
1104 void maybeEmitDwarf64Mark();
1105
1106 /// Emit a unit length field. The actual format, DWARF32 or DWARF64, is chosen
1107 /// according to the settings.
1108 virtual void emitDwarfUnitLength(uint64_t Length, const Twine &Comment);
1109
1110 /// Emit a unit length field. The actual format, DWARF32 or DWARF64, is chosen
1111 /// according to the settings.
1112 /// Return the end symbol generated inside, the caller needs to emit it.
1113 virtual MCSymbol *emitDwarfUnitLength(const Twine &Prefix,
1114 const Twine &Comment);
1115
1116 /// Emit the debug line start label.
1117 virtual void emitDwarfLineStartLabel(MCSymbol *StartSym);
1118
1119 /// Emit the debug line end entry.
1120 virtual void emitDwarfLineEndEntry(MCSection *Section, MCSymbol *LastLabel,
1121 MCSymbol *EndLabel = nullptr) {}
1122
1123 /// If targets does not support representing debug line section by .loc/.file
1124 /// directives in assembly output, we need to populate debug line section with
1125 /// raw debug line contents.
1126 virtual void emitDwarfAdvanceLineAddr(int64_t LineDelta,
1127 const MCSymbol *LastLabel,
1128 const MCSymbol *Label,
1129 unsigned PointerSize) {}
1130};
1131
1133 return Streamer.getContext();
1134}
1135
1136/// Create a dummy machine code streamer, which does nothing. This is useful for
1137/// timing the assembler front end.
1139
1140} // end namespace llvm
1141
1142#endif // LLVM_MC_MCSTREAMER_H
assert(UImm &&(UImm !=~static_cast< T >(0)) &&"Invalid immediate!")
static GCRegistry::Add< ErlangGC > A("erlang", "erlang-compatible garbage collector")
#define LLVM_ABI
Definition Compiler.h:213
DXIL Finalize Linkage
static ManagedStatic< cl::opt< bool, true >, CreateDebug > Debug
Definition Debug.cpp:147
This file defines the DenseMap class.
IRTranslator LLVM IR MI
static LVOptions Options
Definition LVOptions.cpp:25
#define F(x, y, z)
Definition MD5.cpp:54
Register Reg
Promote Memory to Register
Definition Mem2Reg.cpp:110
#define T
static constexpr StringLiteral Filename
This file defines the SmallVector class.
Defines the llvm::VersionTuple class, which represents a version in the form major[....
Class for arbitrary precision integers.
Definition APInt.h:78
virtual void emitUnwindRaw(int64_t StackOffset, const SmallVectorImpl< uint8_t > &Opcodes)
~ARMTargetStreamer() override
void emitTargetAttributes(const MCSubtargetInfo &STI)
Emit the build attributes that only depend on the hardware that we expect.
virtual void reset()
Reset any state between object emissions, i.e.
virtual void emitSetFP(MCRegister FpReg, MCRegister SpReg, int64_t Offset=0)
virtual void annotateTLSDescriptorSequence(const MCSymbolRefExpr *SRE)
virtual void finishAttributeSection()
virtual void emitMovSP(MCRegister Reg, int64_t Offset=0)
virtual void emitARMWinCFISaveSP(unsigned Reg)
virtual void emitPersonalityIndex(unsigned Index)
virtual void emitInst(uint32_t Inst, char Suffix='\0')
virtual void emitARMWinCFISaveLR(unsigned Offset)
virtual void emitArchExtension(uint64_t ArchExt)
virtual void emitTextAttribute(unsigned Attribute, StringRef String)
virtual void emitARMWinCFIAllocStack(unsigned Size, bool Wide)
virtual void emitARMWinCFICustom(unsigned Opcode)
virtual void emitARMWinCFISaveRegMask(unsigned Mask, bool Wide)
virtual void emitRegSave(const SmallVectorImpl< MCRegister > &RegList, bool isVector)
virtual void emitARMWinCFIEpilogEnd()
virtual void emitARMWinCFIPrologEnd(bool Fragment)
virtual void switchVendor(StringRef Vendor)
virtual void emitPersonality(const MCSymbol *Personality)
virtual void emitObjectArch(ARM::ArchKind Arch)
const MCExpr * addConstantPoolEntry(const MCExpr *, SMLoc Loc)
Callback used to implement the ldr= pseudo.
virtual void emitIntTextAttribute(unsigned Attribute, unsigned IntValue, StringRef StringValue="")
virtual void emitThumbSet(MCSymbol *Symbol, const MCExpr *Value)
virtual void emitThumbFunc(MCSymbol *Symbol)
virtual void emitFPU(ARM::FPUKind FPU)
virtual void emitARMWinCFISaveFRegs(unsigned First, unsigned Last)
virtual void emitARMWinCFIEpilogStart(unsigned Condition)
virtual void emitPad(int64_t Offset)
void emitCurrentConstantPool()
Callback used to implement the .ltorg directive.
virtual void emitAttribute(unsigned Attribute, unsigned Value)
virtual void emitARMWinCFINop(bool Wide)
void emitConstantPools() override
virtual void emitArch(ARM::ArchKind Arch)
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory),...
Definition ArrayRef.h:40
Functions, function parameters, and return types can have attributes to indicate how they should be t...
Definition Attributes.h:105
Tagged union holding either a T or a Error.
Definition Error.h:485
Generic interface to target specific assembler backends.
Context object for machine code objects.
Definition MCContext.h:83
Base class for the full range of assembler expressions which are needed for parsing.
Definition MCExpr.h:34
This is an instance of a target assembly language printer that converts an MCInst to valid target ass...
Instances of this class represent a single low-level machine instruction.
Definition MCInst.h:188
Wrapper class representing physical registers. Should be passed by value.
Definition MCRegister.h:41
Instances of this class represent a uniqued identifier for a section in the current translation unit.
Definition MCSection.h:516
Streaming machine code generation interface.
Definition MCStreamer.h:221
virtual void emitAddrsig()
virtual void addBlankLine()
Emit a blank line to a .s file to pretty it up.
Definition MCStreamer.h:414
virtual void visitUsedSymbol(const MCSymbol &Sym)
MCSectionSubPair getPreviousSection() const
Return the previous section that the streamer is emitting code to.
Definition MCStreamer.h:432
virtual void beginCOFFSymbolDef(const MCSymbol *Symbol)
Start emitting COFF symbol definition.
virtual void emitBinaryData(StringRef Data)
Functionally identical to EmitBytes.
std::unique_ptr< MCLFIRewriter > LFIRewriter
Definition MCStreamer.h:295
MCStreamer(const MCStreamer &)=delete
virtual void emitGNUAttribute(unsigned Tag, unsigned Value)
Emit a .gnu_attribute directive.
Definition MCStreamer.h:676
virtual void emitZerofill(MCSection *Section, MCSymbol *Symbol=nullptr, uint64_t Size=0, Align ByteAlignment=Align(1), SMLoc Loc=SMLoc())
Emit the zerofill section and an optional symbol.
unsigned getNumWinFrameInfos()
Definition MCStreamer.h:354
virtual ~MCStreamer()
void setStartTokLocPtr(const SMLoc *Loc)
Definition MCStreamer.h:309
MCFragment * getCurrentFragment() const
Definition MCStreamer.h:438
virtual bool emitSymbolAttribute(MCSymbol *Symbol, MCSymbolAttr Attribute)=0
Add the given Attribute to Symbol.
virtual void emitCOFFSymbolType(int Type)
Emit the type of the symbol.
virtual void emitRelocDirective(const MCExpr &Offset, StringRef Name, const MCExpr *Expr, SMLoc Loc={})
Record a relocation described by the .reloc directive.
virtual void emitCOFFSymbolIndex(MCSymbol const *Symbol)
Emits the symbol table index of a Symbol into the current section.
virtual void emitCVStringTableDirective()
This implements the CodeView '.cv_stringtable' assembler directive.
Definition MCStreamer.h:982
virtual bool hasRawTextSupport() const
Return true if this asm streamer supports emitting unformatted text to the .s file with EmitRawText.
Definition MCStreamer.h:374
SmallVector< MCDwarfFrameInfo, 0 > DwarfFrameInfos
Definition MCStreamer.h:269
virtual void emitIntValueInHex(uint64_t Value, unsigned Size)
Special case of EmitValue that avoids the client having to pass in a MCExpr for constant integers & p...
Definition MCStreamer.h:750
virtual bool isVerboseAsm() const
Return true if this streamer supports verbose assembly and if it is enabled.
Definition MCStreamer.h:370
virtual void emitCOFFImgRel32(MCSymbol const *Symbol, int64_t Offset)
Emits a COFF image relative relocation.
virtual void endCOFFSymbolDef()
Marks the end of the symbol definition.
unsigned emitDwarfFileDirective(unsigned FileNo, StringRef Directory, StringRef Filename, std::optional< MD5::MD5Result > Checksum=std::nullopt, std::optional< StringRef > Source=std::nullopt, unsigned CUID=0)
Associate a filename with a specified logical file number.
Definition MCStreamer.h:877
WinEH::FrameInfo::Epilog * getCurrentWinEpilog() const
Definition MCStreamer.h:359
virtual void emitCommonSymbol(MCSymbol *Symbol, uint64_t Size, Align ByteAlignment)=0
Emit a common symbol.
virtual MCAssembler * getAssemblerPtr()
Definition MCStreamer.h:327
virtual void emitXCOFFSymbolLinkageWithVisibility(MCSymbol *Symbol, MCSymbolAttr Linkage, MCSymbolAttr Visibility)
Emit a symbol's linkage and visibility with a linkage directive for XCOFF.
void setTargetStreamer(MCTargetStreamer *TS)
Definition MCStreamer.h:305
virtual bool isIntegratedAssemblerRequired() const
Is the integrated assembler required for this streamer to function correctly?
Definition MCStreamer.h:378
virtual void emitCFIStartProcImpl(MCDwarfFrameInfo &Frame)
virtual void emitCVFileChecksumOffsetDirective(unsigned FileNo)
This implements the CodeView '.cv_filechecksumoffset' assembler directive.
Definition MCStreamer.h:989
bool getUseAssemblerInfoForParsing()
Definition MCStreamer.h:330
virtual void emitCOFFSecNumber(MCSymbol const *Symbol)
Emits the physical number of the section containing the given symbol as assigned during object writin...
MCContext & getContext() const
Definition MCStreamer.h:322
SMLoc getStartTokLoc() const
Definition MCStreamer.h:310
virtual Expected< unsigned > tryEmitDwarfFileDirective(unsigned FileNo, StringRef Directory, StringRef Filename, std::optional< MD5::MD5Result > Checksum=std::nullopt, std::optional< StringRef > Source=std::nullopt, unsigned CUID=0)
Associate a filename with a specified logical file number.
virtual void AddComment(const Twine &T, bool EOL=true)
Add a textual comment.
Definition MCStreamer.h:393
virtual void emitCVFPOData(const MCSymbol *ProcSym, SMLoc Loc={})
This implements the CodeView '.cv_fpo_data' assembler directive.
Definition MCStreamer.h:992
virtual void emitELFSize(MCSymbol *Symbol, const MCExpr *Value)
Emit an ELF .size directive.
virtual void emitXCOFFLocalCommonSymbol(MCSymbol *LabelSym, uint64_t Size, MCSymbol *CsectSym, Align Alignment)
Emits an lcomm directive with XCOFF csect information.
virtual void emitCOFFSecRel32(MCSymbol const *Symbol, uint64_t Offset)
Emits a COFF section relative relocation.
void emitValue(const MCExpr *Value, unsigned Size, SMLoc Loc=SMLoc())
virtual void emitIdent(StringRef IdentString)
Emit the "identifiers" directive.
Definition MCStreamer.h:873
virtual StringRef getMnemonic(const MCInst &MI) const
Returns the mnemonic for MI, if the streamer has access to a instruction printer and returns an empty...
Definition MCStreamer.h:477
virtual void emitCVFileChecksumsDirective()
This implements the CodeView '.cv_filechecksums' assembler directive.
Definition MCStreamer.h:985
virtual void emitXCOFFExceptDirective(const MCSymbol *Symbol, const MCSymbol *Trap, unsigned Lang, unsigned Reason, unsigned FunctionSize, bool hasDebug)
Emit an XCOFF .except directive which adds information about a trap instruction to the object file ex...
virtual void emitCOFFSectionIndex(MCSymbol const *Symbol)
Emits a COFF section index.
void setAllowAutoPadding(bool v)
Definition MCStreamer.h:336
virtual void emitCOFFSecOffset(MCSymbol const *Symbol)
Emits the offset of the symbol from the beginning of the section during object writing (i....
MCTargetStreamer * getTargetStreamer()
Definition MCStreamer.h:332
virtual void emitIntValueInHexWithPadding(uint64_t Value, unsigned Size)
Special case of EmitValue that avoids the client having to pass in a MCExpr for constant integers & p...
Definition MCStreamer.h:762
MCStreamer(MCContext &Ctx)
MCFragment * CurFrag
Definition MCStreamer.h:267
virtual void emitDarwinTargetVariantBuildVersion(unsigned Platform, unsigned Major, unsigned Minor, unsigned Update, VersionTuple SDKVersion)
Definition MCStreamer.h:514
virtual bool mayHaveInstructions(MCSection &Sec) const
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.
MCLFIRewriter * getLFIRewriter()
Definition MCStreamer.h:316
bool isInEpilogCFI() const
Definition MCStreamer.h:363
virtual void emitDwarfAdvanceLineAddr(int64_t LineDelta, const MCSymbol *LastLabel, const MCSymbol *Label, unsigned PointerSize)
If targets does not support representing debug line section by .loc/.file directives in assembly outp...
void emitInt16(uint64_t Value)
Definition MCStreamer.h:755
virtual void emitCFIEndProcImpl(MCDwarfFrameInfo &CurFrame)
virtual void emitSymbolDesc(MCSymbol *Symbol, unsigned DescValue)
Set the DescValue for the Symbol.
virtual void emitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size, Align ByteAlignment)
Emit a local common (.lcomm) symbol.
size_t getCurFragSize() const
Definition MCStreamer.h:447
virtual void emitCOFFSafeSEH(MCSymbol const *Symbol)
virtual void emitXCOFFRenameDirective(const MCSymbol *Name, StringRef Rename)
Emit a XCOFF .rename directive which creates a synonym for an illegal or undesirable name.
void pushSection()
Save the current and previous section on the section stack.
Definition MCStreamer.h:449
void setUseAssemblerInfoForParsing(bool v)
Definition MCStreamer.h:329
virtual void emitDwarfLocDirectiveWithInlinedAt(unsigned FileNo, unsigned Line, unsigned Column, unsigned FileIA, unsigned LineIA, unsigned ColumnIA, const MCSymbol *Sym, unsigned Flags, unsigned Isa, unsigned Discriminator, StringRef FileName, StringRef Comment={})
This is same as emitDwarfLocDirective, except it has the capability to add inlined_at information.
Definition MCStreamer.h:915
virtual void emitDataRegion(MCDataRegionType Kind)
Note in the output the specified region Kind.
Definition MCStreamer.h:501
bool getAllowAutoPadding() const
Definition MCStreamer.h:337
virtual void emitLinkerOptions(ArrayRef< std::string > Kind)
Emit the given list Options of strings as linker options into the output.
Definition MCStreamer.h:498
void emitInt64(uint64_t Value)
Definition MCStreamer.h:757
virtual void emitXCOFFRefDirective(const MCSymbol *Symbol)
Emit a XCOFF .ref directive which creates R_REF type entry in the relocation table for one or more sy...
void emitInt32(uint64_t Value)
Definition MCStreamer.h:756
ArrayRef< std::unique_ptr< WinEH::FrameInfo > > getWinFrameInfos() const
Definition MCStreamer.h:355
MCSectionSubPair getCurrentSection() const
Return the current section that the streamer is emitting code to.
Definition MCStreamer.h:422
virtual void emitELFSymverDirective(const MCSymbol *OriginalSym, StringRef Name, bool KeepOriginalSym)
Emit an ELF .symver directive.
virtual void emitXCOFFCInfoSym(StringRef Name, StringRef Metadata)
Emit a C_INFO symbol with XCOFF embedded metadata to the .info section.
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.
MCStreamer & operator=(const MCStreamer &)=delete
virtual void emitDwarfLineEndEntry(MCSection *Section, MCSymbol *LastLabel, MCSymbol *EndLabel=nullptr)
Emit the debug line end entry.
virtual void emitLOHDirective(MCLOHType Kind, const MCLOHArgs &Args)
Emit a Linker Optimization Hint (LOH) directive.
Definition MCStreamer.h:673
void addFragment(MCFragment *F)
virtual void emitVersionMin(MCVersionMinType Type, unsigned Major, unsigned Minor, unsigned Update, VersionTuple SDKVersion)
Specify the Mach-O minimum deployment target version.
Definition MCStreamer.h:504
virtual void emitCOFFSymbolStorageClass(int StorageClass)
Emit the storage class of the symbol.
WinEH::FrameInfo * getCurrentWinFrameInfo()
Definition MCStreamer.h:282
void emitInt8(uint64_t Value)
Definition MCStreamer.h:754
virtual void emitTBSSSymbol(MCSection *Section, MCSymbol *Symbol, uint64_t Size, Align ByteAlignment=Align(1))
Emit a thread local bss (.tbss) symbol.
WinEH::FrameInfo::Epilog * CurrentWinEpilog
Definition MCStreamer.h:265
virtual void emitBytes(StringRef Data)
Emit the bytes in Data into the output.
virtual void emitAddrsigSym(const MCSymbol *Sym)
void visitUsedExpr(const MCExpr &Expr)
virtual void emitBuildVersion(unsigned Platform, unsigned Major, unsigned Minor, unsigned Update, VersionTuple SDKVersion)
Emit/Specify Mach-O build version command.
Definition MCStreamer.h:510
virtual void changeSection(MCSection *, uint32_t)
This is called by popSection and switchSection, if the current section changes.
bool isObj() const
Definition MCStreamer.h:323
Generic base class for all target subtargets.
Represent a reference to a symbol from inside an expression.
Definition MCExpr.h:190
MCSymbol - Instances of this class represent a symbol name in the MC file, and MCSymbols are created ...
Definition MCSymbol.h:42
Target specific streamer interface.
Definition MCStreamer.h:94
MCStreamer & getStreamer()
Definition MCStreamer.h:102
MCContext & getContext()
MCStreamer & Streamer
Definition MCStreamer.h:96
MCTargetStreamer(MCStreamer &S)
Root of the metadata hierarchy.
Definition Metadata.h:64
Represents a location in source code.
Definition SMLoc.h:22
This class consists of common code factored out of the SmallVector class to reduce code duplication b...
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
StackOffset holds a fixed and a scalable offset in bytes.
Definition TypeSize.h:30
StringRef - Represent a constant reference to a string, i.e.
Definition StringRef.h:55
Target - Wrapper for Target specific information.
Triple - Helper class for working with autoconf configuration names.
Definition Triple.h:47
Twine - A lightweight data structure for efficiently representing the concatenation of temporary valu...
Definition Twine.h:82
The instances of the Type class are immutable: once they are created, they are never changed.
Definition Type.h:45
LLVM Value Representation.
Definition Value.h:75
Represents a version number in the form major[.minor[.subminor[.build]]].
This class implements an extremely fast bulk output stream that can only output to a stream.
Definition raw_ostream.h:53
This is an optimization pass for GlobalISel generic memory operations.
Definition Types.h:26
@ Offset
Definition DWP.cpp:532
@ Length
Definition DWP.cpp:532
LLVM_ABI MCStreamer * createNullStreamer(MCContext &Ctx)
Create a dummy machine code streamer, which does nothing.
MCDataRegionType
MCLOHDirective::LOHArgs MCLOHArgs
SmallVector< InlineSite, 8 > MCPseudoProbeInlineStack
MCVersionMinType
@ First
Helpers to iterate all locations in the MemoryEffectsBase class.
Definition ModRef.h:74
void cantFail(Error Err, const char *Msg=nullptr)
Report a fatal error if Err is a failure value.
Definition Error.h:769
FunctionAddr VTableAddr uintptr_t uintptr_t Data
Definition InstrProf.h:189
MCLOHType
Linker Optimization Hint Type.
std::pair< MCSection *, uint32_t > MCSectionSubPair
Definition MCStreamer.h:67
This struct is a compact representation of a valid (non-zero power of two) alignment.
Definition Alignment.h:39