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
16#include "llvm/ADT/SmallString.h"
17#include "llvm/ADT/StringRef.h"
18#include "llvm/MC/MCAsmBackend.h"
19#include "llvm/MC/MCAsmInfo.h"
20#include "llvm/MC/MCAsmStreamer.h"
21#include "llvm/MC/MCAssembler.h"
22#include "llvm/MC/MCCodeEmitter.h"
23#include "llvm/MC/MCContext.h"
24#include "llvm/MC/MCInst.h"
25#include "llvm/MC/MCInstPrinter.h"
26#include "llvm/MC/MCObjectWriter.h"
27#include "llvm/MC/MCStreamer.h"
28#include "llvm/MC/MCTargetOptions.h"
29#include "llvm/Support/FormattedStream.h"
30
31namespace llvm {
32class MCSymbolGOFF;
33
34class SystemZHLASMAsmStreamer final : public MCAsmBaseStreamer {
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;
40 formatted_raw_ostream &FOS;
41 std::string Str;
42 raw_string_ostream OS;
43 const MCAsmInfo *MAI;
44 std::unique_ptr<MCInstPrinter> InstPrinter;
45 bool IsVerboseAsm = false;
46
47public:
48 SystemZHLASMAsmStreamer(MCContext &Context,
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
103 void emitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
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
121