1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
|
#pragma once
#ifdef __GNUC__
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wunused-parameter"
#endif
//===--------------------- InstrBuilder.h -----------------------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
/// \file
///
/// A builder class for instructions that are statically analyzed by llvm-mca.
//
//===----------------------------------------------------------------------===//
#ifndef LLVM_MCA_INSTRBUILDER_H
#define LLVM_MCA_INSTRBUILDER_H
#include "llvm/ADT/STLExtras.h"
#include "llvm/MC/MCInstrAnalysis.h"
#include "llvm/MC/MCInstrInfo.h"
#include "llvm/MC/MCRegisterInfo.h"
#include "llvm/MC/MCSubtargetInfo.h"
#include "llvm/MCA/CustomBehaviour.h"
#include "llvm/MCA/Instruction.h"
#include "llvm/MCA/Support.h"
#include "llvm/Support/Error.h"
namespace llvm {
namespace mca {
class RecycledInstErr : public ErrorInfo<RecycledInstErr> {
Instruction *RecycledInst;
public:
static char ID;
explicit RecycledInstErr(Instruction *Inst) : RecycledInst(Inst) {}
// Always need to carry an Instruction
RecycledInstErr() = delete;
Instruction *getInst() const { return RecycledInst; }
void log(raw_ostream &OS) const override {
OS << "Instruction is recycled\n";
}
std::error_code convertToErrorCode() const override {
return llvm::inconvertibleErrorCode();
}
};
/// A builder class that knows how to construct Instruction objects.
///
/// Every llvm-mca Instruction is described by an object of class InstrDesc.
/// An InstrDesc describes which registers are read/written by the instruction,
/// as well as the instruction latency and hardware resources consumed.
///
/// This class is used by the tool to construct Instructions and instruction
/// descriptors (i.e. InstrDesc objects).
/// Information from the machine scheduling model is used to identify processor
/// resources that are consumed by an instruction.
class InstrBuilder {
const MCSubtargetInfo &STI;
const MCInstrInfo &MCII;
const MCRegisterInfo &MRI;
const MCInstrAnalysis *MCIA;
const InstrumentManager &IM;
SmallVector<uint64_t, 8> ProcResourceMasks;
// Key is the MCI.Opcode and SchedClassID the describe the value InstrDesc
DenseMap<std::pair<unsigned short, unsigned>,
std::unique_ptr<const InstrDesc>>
Descriptors;
// Key is the MCIInst and SchedClassID the describe the value InstrDesc
DenseMap<std::pair<const MCInst *, unsigned>,
std::unique_ptr<const InstrDesc>>
VariantDescriptors;
bool FirstCallInst;
bool FirstReturnInst;
using InstRecycleCallback =
llvm::function_ref<Instruction *(const InstrDesc &)>;
InstRecycleCallback InstRecycleCB;
Expected<const InstrDesc &>
createInstrDescImpl(const MCInst &MCI,
const SmallVector<SharedInstrument> &IVec);
Expected<const InstrDesc &>
getOrCreateInstrDesc(const MCInst &MCI,
const SmallVector<SharedInstrument> &IVec);
InstrBuilder(const InstrBuilder &) = delete;
InstrBuilder &operator=(const InstrBuilder &) = delete;
void populateWrites(InstrDesc &ID, const MCInst &MCI, unsigned SchedClassID);
void populateReads(InstrDesc &ID, const MCInst &MCI, unsigned SchedClassID);
Error verifyInstrDesc(const InstrDesc &ID, const MCInst &MCI) const;
public:
InstrBuilder(const MCSubtargetInfo &STI, const MCInstrInfo &MCII,
const MCRegisterInfo &RI, const MCInstrAnalysis *IA,
const InstrumentManager &IM);
void clear() {
Descriptors.clear();
VariantDescriptors.clear();
FirstCallInst = true;
FirstReturnInst = true;
}
/// Set a callback which is invoked to retrieve a recycled mca::Instruction
/// or null if there isn't any.
void setInstRecycleCallback(InstRecycleCallback CB) { InstRecycleCB = CB; }
Expected<std::unique_ptr<Instruction>>
createInstruction(const MCInst &MCI,
const SmallVector<SharedInstrument> &IVec);
};
} // namespace mca
} // namespace llvm
#endif // LLVM_MCA_INSTRBUILDER_H
#ifdef __GNUC__
#pragma GCC diagnostic pop
#endif
|
