LLVM 23.0.0git
SystemZHLASMAsmStreamer.h
Go to the documentation of this file.
1//===- SystemZHLASMAsmStreamer.h - HLASM Assembly Text 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 SystemZHLASMAsmStreamer class.
10//
11//===----------------------------------------------------------------------===//
12
13#ifndef LLVM_LIB_TARGET_SYSTEMZ_MCTARGETDESC_SYSTEMZHLASMASMSTREAMER_H
14#define LLVM_LIB_TARGET_SYSTEMZ_MCTARGETDESC_SYSTEMZHLASMASMSTREAMER_H
15
17#include "llvm/ADT/StringRef.h"
19#include "llvm/MC/MCAsmInfo.h"
21#include "llvm/MC/MCAssembler.h"
23#include "llvm/MC/MCContext.h"
24#include "llvm/MC/MCInst.h"
27#include "llvm/MC/MCStreamer.h"
30
31namespace llvm {
32class MCSymbolGOFF;
33
35 constexpr static size_t InstLimit = 80;
36 constexpr static size_t ContIndicatorColumn = 72;
37 constexpr static size_t ContStartColumn = 15;
38 constexpr static size_t ContLen = ContIndicatorColumn - ContStartColumn;
39 std::unique_ptr<formatted_raw_ostream> FOSOwner;
41 std::string Str;
43 const MCAsmInfo *MAI;
44 std::unique_ptr<MCInstPrinter> InstPrinter;
45 bool IsVerboseAsm = false;
46
47public:
49 std::unique_ptr<formatted_raw_ostream> OS,
50 std::unique_ptr<MCInstPrinter> Printer,
51 std::unique_ptr<MCCodeEmitter> Emitter,
52 std::unique_ptr<MCAsmBackend> AsmBackend)
53 : MCAsmBaseStreamer(Context, std::move(Emitter), std::move(AsmBackend)),
54 FOSOwner(std::move(OS)), FOS(*FOSOwner), OS(Str),
55 MAI(&Context.getAsmInfo()), InstPrinter(std::move(Printer)) {
56 assert(InstPrinter);
57 if (Assembler->getBackendPtr())
58 setAllowAutoPadding(Assembler->getBackend().allowAutoPadding());
59
60 Context.setUseNamesOnTempLabels(true);
61 IsVerboseAsm = Context.getTargetOptions().AsmVerbose;
62 if (IsVerboseAsm)
63 InstPrinter->setCommentStream(CommentStream);
64 }
65
66 void EmitEOL();
67 void EmitComment();
68
69 /// Add a comment that can be emitted to the generated .s file to make the
70 /// output of the compiler more readable. This only affects the MCAsmStreamer
71 /// and only when verbose assembly output is enabled.
72 void AddComment(const Twine &T, bool EOL = true) override;
73
74 void emitBytes(StringRef Data) override;
75
76 void emitAlignmentDS(uint64_t ByteAlignment, std::optional<int64_t> Value,
77 unsigned ValueSize, unsigned MaxBytesToEmit);
78 void emitValueToAlignment(Align Alignment, int64_t Fill, uint8_t FillLen,
79 unsigned MaxBytesToEmit) override;
80
81 void emitCodeAlignment(Align Alignment, const MCSubtargetInfo &STI,
82 unsigned MaxBytesToEmit = 0) override;
83
84 void emitRawComment(const Twine &T, bool TabPrefix = false) override;
85 /// Return true if this streamer supports verbose assembly at all.
86 bool isVerboseAsm() const override { return IsVerboseAsm; }
87
88 /// Do we support EmitRawText?
89 bool hasRawTextSupport() const override { return true; }
90
91 void addEncodingComment(const MCInst &Inst, const MCSubtargetInfo &STI);
92
93 /// @name MCStreamer Interface
94 /// @{
95 void visitUsedSymbol(const MCSymbol &Sym) override;
96
97 void changeSection(MCSection *Section, uint32_t Subsection) override;
98
99 void emitInstruction(const MCInst &Inst, const MCSubtargetInfo &STI) override;
100 void emitLabel(MCSymbol *Symbol, SMLoc Loc) override;
101 bool emitSymbolAttribute(MCSymbol *Symbol, MCSymbolAttr Attribute) override;
102
104 Align ByteAlignment) override {}
105
106 void emitZerofill(MCSection *Section, MCSymbol *Symbol = nullptr,
107 uint64_t Size = 0, Align ByteAlignment = Align(1),
108 SMLoc Loc = SMLoc()) override {}
109 void emitRawTextImpl(StringRef String) override;
110 void emitValueImpl(const MCExpr *Value, unsigned Size, SMLoc Loc) override;
111
112 void emitHLASMValueImpl(const MCExpr *Value, unsigned Size,
113 bool Parens = false);
114 /// @}
115
116 void finishImpl() override;
117};
118} // namespace llvm
119
120#endif // LLVM_LIB_TARGET_SYSTEMZ_MCTARGETDESC_SYSTEMZHLASMASMSTREAMER_H
assert(UImm &&(UImm !=~static_cast< T >(0)) &&"Invalid immediate!")
amdgpu next use AMDGPU Next Use Analysis Printer
dxil DXContainer Global Emitter
#define T
This file defines the SmallString class.
Functions, function parameters, and return types can have attributes to indicate how they should be t...
Definition Attributes.h:105
std::unique_ptr< MCAssembler > Assembler
MCAsmBaseStreamer(MCContext &Context, std::unique_ptr< MCCodeEmitter > Emitter, std::unique_ptr< MCAsmBackend > AsmBackend)
raw_svector_ostream CommentStream
This class is intended to be used as a base class for asm properties and features specific to the tar...
Definition MCAsmInfo.h:66
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
Instances of this class represent a single low-level machine instruction.
Definition MCInst.h:188
Instances of this class represent a uniqued identifier for a section in the current translation unit.
Definition MCSection.h:573
void setAllowAutoPadding(bool v)
Definition MCStreamer.h:340
Generic base class for all target subtargets.
MCSymbol - Instances of this class represent a symbol name in the MC file, and MCSymbols are created ...
Definition MCSymbol.h:42
Represents a location in source code.
Definition SMLoc.h:22
Represent a constant reference to a string, i.e.
Definition StringRef.h:56
void emitHLASMValueImpl(const MCExpr *Value, unsigned Size, bool Parens=false)
void emitRawTextImpl(StringRef String) override
EmitRawText - If this file is backed by an assembly streamer, this dumps the specified string in the ...
SystemZHLASMAsmStreamer(MCContext &Context, std::unique_ptr< formatted_raw_ostream > OS, std::unique_ptr< MCInstPrinter > Printer, std::unique_ptr< MCCodeEmitter > Emitter, std::unique_ptr< MCAsmBackend > AsmBackend)
void emitCommonSymbol(MCSymbol *Symbol, uint64_t Size, Align ByteAlignment) override
Emit a common symbol.
void emitValueImpl(const MCExpr *Value, unsigned Size, SMLoc Loc) override
Emit the expression Value into the output as a native integer of the given Size bytes.
void addEncodingComment(const MCInst &Inst, const MCSubtargetInfo &STI)
void emitBytes(StringRef Data) override
Emit the bytes in Data into the output.
void emitAlignmentDS(uint64_t ByteAlignment, std::optional< int64_t > Value, unsigned ValueSize, unsigned MaxBytesToEmit)
void emitZerofill(MCSection *Section, MCSymbol *Symbol=nullptr, uint64_t Size=0, Align ByteAlignment=Align(1), SMLoc Loc=SMLoc()) override
Emit the zerofill section and an optional symbol.
void finishImpl() override
Streamer specific finalization.
void visitUsedSymbol(const MCSymbol &Sym) override
void AddComment(const Twine &T, bool EOL=true) override
Add a comment that can be emitted to the generated .s file to make the output of the compiler more re...
void emitInstruction(const MCInst &Inst, const MCSubtargetInfo &STI) override
Emit the given Instruction into the current section.
bool isVerboseAsm() const override
Return true if this streamer supports verbose assembly at all.
void emitValueToAlignment(Align Alignment, int64_t Fill, uint8_t FillLen, unsigned MaxBytesToEmit) override
Emit some number of copies of Value until the byte alignment ByteAlignment is reached.
void emitRawComment(const Twine &T, bool TabPrefix=false) override
Print T and prefix it with the comment string (normally #) and optionally a tab.
void emitCodeAlignment(Align Alignment, const MCSubtargetInfo &STI, unsigned MaxBytesToEmit=0) override
Emit nops until the byte alignment ByteAlignment is reached.
bool hasRawTextSupport() const override
Do we support EmitRawText?
void changeSection(MCSection *Section, uint32_t Subsection) override
This is called by popSection and switchSection, if the current section changes.
void emitLabel(MCSymbol *Symbol, SMLoc Loc) override
Emit a label for Symbol into the current section.
bool emitSymbolAttribute(MCSymbol *Symbol, MCSymbolAttr Attribute) override
Add the given Attribute to Symbol.
Twine - A lightweight data structure for efficiently representing the concatenation of temporary valu...
Definition Twine.h:82
LLVM Value Representation.
Definition Value.h:75
formatted_raw_ostream - A raw_ostream that wraps another one and keeps track of line and column posit...
A raw_ostream that writes to an std::string.
This is an optimization pass for GlobalISel generic memory operations.
OutputIt move(R &&Range, OutputIt Out)
Provide wrappers to std::move which take ranges instead of having to pass begin/end explicitly.
Definition STLExtras.h:1917
Implement std::hash so that hash_code can be used in STL containers.
Definition BitVector.h:860
This struct is a compact representation of a valid (non-zero power of two) alignment.
Definition Alignment.h:39