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
|
//===-- BenchmarkRunner.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
/// Defines the abstract BenchmarkRunner class for measuring a certain execution
/// property of instructions (e.g. latency).
///
//===----------------------------------------------------------------------===//
#ifndef LLVM_TOOLS_LLVM_EXEGESIS_BENCHMARKRUNNER_H
#define LLVM_TOOLS_LLVM_EXEGESIS_BENCHMARKRUNNER_H
#include "Assembler.h"
#include "BenchmarkCode.h"
#include "BenchmarkResult.h"
#include "LlvmState.h"
#include "MCInstrDescView.h"
#include "SnippetRepetitor.h"
#include "llvm/ADT/SmallVector.h"
#include "llvm/MC/MCInst.h"
#include "llvm/Support/Error.h"
#include <cstdlib>
#include <memory>
#include <vector>
namespace llvm {
namespace exegesis {
// Common code for all benchmark modes.
class BenchmarkRunner {
public:
explicit BenchmarkRunner(const LLVMState &State,
InstructionBenchmark::ModeE Mode,
BenchmarkPhaseSelectorE BenchmarkPhaseSelector);
virtual ~BenchmarkRunner();
class RunnableConfiguration {
friend class BenchmarkRunner;
public:
~RunnableConfiguration() = default;
RunnableConfiguration(RunnableConfiguration &&) = default;
RunnableConfiguration(const RunnableConfiguration &) = delete;
RunnableConfiguration &operator=(RunnableConfiguration &&) = delete;
RunnableConfiguration &operator=(const RunnableConfiguration &) = delete;
private:
RunnableConfiguration() = default;
InstructionBenchmark InstrBenchmark;
object::OwningBinary<object::ObjectFile> ObjectFile;
};
Expected<RunnableConfiguration>
getRunnableConfiguration(const BenchmarkCode &Configuration,
unsigned NumRepetitions, unsigned LoopUnrollFactor,
const SnippetRepetitor &Repetitor) const;
Expected<InstructionBenchmark> runConfiguration(RunnableConfiguration &&RC,
bool DumpObjectToDisk) const;
// Scratch space to run instructions that touch memory.
struct ScratchSpace {
static constexpr const size_t kAlignment = 1024;
static constexpr const size_t kSize = 1 << 20; // 1MB.
ScratchSpace()
: UnalignedPtr(std::make_unique<char[]>(kSize + kAlignment)),
AlignedPtr(
UnalignedPtr.get() + kAlignment -
(reinterpret_cast<intptr_t>(UnalignedPtr.get()) % kAlignment)) {}
char *ptr() const { return AlignedPtr; }
void clear() { std::memset(ptr(), 0, kSize); }
private:
const std::unique_ptr<char[]> UnalignedPtr;
char *const AlignedPtr;
};
// A helper to measure counters while executing a function in a sandboxed
// context.
class FunctionExecutor {
public:
virtual ~FunctionExecutor();
// FIXME deprecate this.
virtual Expected<int64_t> runAndMeasure(const char *Counters) const = 0;
virtual Expected<llvm::SmallVector<int64_t, 4>>
runAndSample(const char *Counters) const = 0;
};
protected:
const LLVMState &State;
const InstructionBenchmark::ModeE Mode;
const BenchmarkPhaseSelectorE BenchmarkPhaseSelector;
private:
virtual Expected<std::vector<BenchmarkMeasure>>
runMeasurements(const FunctionExecutor &Executor) const = 0;
Expected<SmallString<0>> assembleSnippet(const BenchmarkCode &BC,
const SnippetRepetitor &Repetitor,
unsigned MinInstructions,
unsigned LoopBodySize) const;
Expected<std::string> writeObjectFile(StringRef Buffer) const;
const std::unique_ptr<ScratchSpace> Scratch;
};
} // namespace exegesis
} // namespace llvm
#endif // LLVM_TOOLS_LLVM_EXEGESIS_BENCHMARKRUNNER_H
|
