xref: /freebsd-src/contrib/llvm-project/llvm/tools/llvm-mca/Views/InstructionInfoView.h (revision 0b57cec536236d46e3dba9bd041533462f33dbb7)
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/Support/raw_ostream.h"
44 
45 #define DEBUG_TYPE "llvm-mca"
46 
47 namespace llvm {
48 namespace mca {
49 
50 /// A view that prints out generic instruction information.
51 class InstructionInfoView : public View {
52   const llvm::MCSubtargetInfo &STI;
53   const llvm::MCInstrInfo &MCII;
54   llvm::ArrayRef<llvm::MCInst> Source;
55   llvm::MCInstPrinter &MCIP;
56 
57 public:
58   InstructionInfoView(const llvm::MCSubtargetInfo &sti,
59                       const llvm::MCInstrInfo &mcii,
60                       llvm::ArrayRef<llvm::MCInst> S, llvm::MCInstPrinter &IP)
61       : STI(sti), MCII(mcii), Source(S), MCIP(IP) {}
62 
63   void printView(llvm::raw_ostream &OS) const override;
64 };
65 } // namespace mca
66 } // namespace llvm
67 
68 #endif
69