xref: /freebsd/contrib/llvm-project/llvm/tools/llvm-mca/Views/InstructionInfoView.h (revision dd41de95a84d979615a2ef11df6850622bf6184e)
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/View.h"
38 #include "llvm/ADT/ArrayRef.h"
39 #include "llvm/MC/MCInst.h"
40 #include "llvm/MC/MCInstPrinter.h"
41 #include "llvm/MC/MCInstrInfo.h"
42 #include "llvm/MC/MCSubtargetInfo.h"
43 #include "llvm/MCA/CodeEmitter.h"
44 #include "llvm/Support/raw_ostream.h"
45 
46 #define DEBUG_TYPE "llvm-mca"
47 
48 namespace llvm {
49 namespace mca {
50 
51 /// A view that prints out generic instruction information.
52 class InstructionInfoView : public View {
53   const llvm::MCSubtargetInfo &STI;
54   const llvm::MCInstrInfo &MCII;
55   CodeEmitter &CE;
56   bool PrintEncodings;
57   llvm::ArrayRef<llvm::MCInst> Source;
58   llvm::MCInstPrinter &MCIP;
59 
60 public:
61   InstructionInfoView(const llvm::MCSubtargetInfo &ST,
62                       const llvm::MCInstrInfo &II, CodeEmitter &C,
63                       bool ShouldPrintEncodings, llvm::ArrayRef<llvm::MCInst> S,
64                       llvm::MCInstPrinter &IP)
65       : STI(ST), MCII(II), CE(C), PrintEncodings(ShouldPrintEncodings),
66         Source(S), MCIP(IP) {}
67 
68   void printView(llvm::raw_ostream &OS) const override;
69 };
70 } // namespace mca
71 } // namespace llvm
72 
73 #endif
74