Debian Codegraph @

llvm-project/llvm/tools/llvm-mca/Views/InstructionInfoView.h

raw
1 //===--------------------- InstructionInfoView.h ----------------*- 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 /// \file
9 ///
10 /// This file implements the instruction info view.
11 ///
12 /// The goal fo the instruction info view is to print the latency and reciprocal
13 /// throughput information for every instruction in the input sequence.
14 /// This section also reports extra information related to the number of micro
15 /// opcodes, and opcode properties (i.e. 'MayLoad', 'MayStore', 'HasSideEffects)
16 ///
17 /// Example:
18 ///
19 /// Instruction Info:
20 /// [1]: #uOps
21 /// [2]: Latency
22 /// [3]: RThroughput
23 /// [4]: MayLoad
24 /// [5]: MayStore
25 /// [6]: HasSideEffects
26 ///
27 /// [1] [2] [3] [4] [5] [6] Instructions:
28 /// 1 2 1.00 vmulps %xmm0, %xmm1, %xmm2
29 /// 1 3 1.00 vhaddps %xmm2, %xmm2, %xmm3
30 /// 1 3 1.00 vhaddps %xmm3, %xmm3, %xmm4
31 //
32 //===----------------------------------------------------------------------===//
33
34 #ifndef LLVM_TOOLS_LLVM_MCA_INSTRUCTIONINFOVIEW_H
35 #define LLVM_TOOLS_LLVM_MCA_INSTRUCTIONINFOVIEW_H
36
37 #include "Views/InstructionView.h"
38 #include "llvm/ADT/ArrayRef.h"
39 #include "llvm/ADT/SmallVector.h"
40 #include "llvm/MC/MCInst.h"
41 #include "llvm/MC/MCInstPrinter.h"
42 #include "llvm/MC/MCInstrInfo.h"
43 #include "llvm/MC/MCSubtargetInfo.h"
44 #include "llvm/MCA/CodeEmitter.h"
45 #include "llvm/Support/raw_ostream.h"
46
47 #define DEBUG_TYPE "llvm-mca"
48
49 namespace llvm {
50 namespace mca {
51
52 /// A view that prints out generic instruction information.
53 class InstructionInfoView : public InstructionView {
54 const llvm::MCInstrInfo &MCII;
55 CodeEmitter &CE;
56 bool PrintEncodings;
57 bool PrintBarriers;
58 using UniqueInst = std::unique_ptr<Instruction>;
59 ArrayRef<UniqueInst> LoweredInsts;
60
61 struct InstructionInfoViewData {
62 unsigned NumMicroOpcodes = 0;
63 unsigned Latency = 0;
64 std::optional<double> RThroughput = 0.0;
65 bool mayLoad = false;
66 bool mayStore = false;
67 bool hasUnmodeledSideEffects = false;
68 };
69 using IIVDVec = SmallVector<InstructionInfoViewData, 16>;
70
71 /// Place the data into the array of InstructionInfoViewData IIVD.
72 void collectData(MutableArrayRef<InstructionInfoViewData> IIVD) const;
73
74 public:
75 InstructionInfoView(const llvm::MCSubtargetInfo &ST,
76 const llvm::MCInstrInfo &II, CodeEmitter &C,
77 bool ShouldPrintEncodings, llvm::ArrayRef<llvm::MCInst> S,
78 llvm::MCInstPrinter &IP,
79 ArrayRef<UniqueInst> LoweredInsts,
80 bool ShouldPrintBarriers)
81 : InstructionView(ST, IP, S), MCII(II), CE(C),
82 PrintEncodings(ShouldPrintEncodings),
83 PrintBarriers(ShouldPrintBarriers), LoweredInsts(LoweredInsts) {}
84
85 void printView(llvm::raw_ostream &OS) const override;
86 StringRef getNameAsString() const override { return "InstructionInfoView"; }
87 json::Value toJSON() const override;
88 json::Object toJSON(const InstructionInfoViewData &IIVD) const;
89 };
90 } // namespace mca
91 } // namespace llvm
92
93 #endif