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