blob: fe8a9e2e9cc3d2cc21482e7ee7afd5ac1ea24f14 [file] [log] [blame]
Clement Courbet44b4c542018-06-19 11:28:59 +00001//===-- Target.h ------------------------------------------------*- C++ -*-===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9///
10/// \file
11///
12/// Classes that handle the creation of target-specific objects. This is
13/// similar to llvm::Target/TargetRegistry.
14///
15//===----------------------------------------------------------------------===//
16
17#ifndef LLVM_TOOLS_LLVM_EXEGESIS_TARGET_H
18#define LLVM_TOOLS_LLVM_EXEGESIS_TARGET_H
19
Clement Courbet4860b982018-06-26 08:49:30 +000020#include "BenchmarkResult.h"
21#include "BenchmarkRunner.h"
22#include "LlvmState.h"
Clement Courbetd939f6d2018-09-13 07:40:53 +000023#include "SnippetGenerator.h"
Clement Courbet44b4c542018-06-19 11:28:59 +000024#include "llvm/ADT/Triple.h"
Clement Courbet6fd00e32018-06-20 11:54:35 +000025#include "llvm/CodeGen/TargetPassConfig.h"
Guillaume Chateletfb943542018-08-01 14:41:45 +000026#include "llvm/IR/CallingConv.h"
Clement Courbet6fd00e32018-06-20 11:54:35 +000027#include "llvm/IR/LegacyPassManager.h"
Clement Courbeta51efc22018-06-25 13:12:02 +000028#include "llvm/MC/MCInst.h"
29#include "llvm/MC/MCRegisterInfo.h"
Clement Courbet44b4c542018-06-19 11:28:59 +000030
31namespace exegesis {
32
33class ExegesisTarget {
34public:
Clement Courbet6fd00e32018-06-20 11:54:35 +000035 // Targets can use this to add target-specific passes in assembleToStream();
36 virtual void addTargetSpecificPasses(llvm::PassManagerBase &PM) const {}
37
Clement Courbeta51efc22018-06-25 13:12:02 +000038 // Generates code to move a constant into a the given register.
Clement Courbete7851692018-07-03 06:17:05 +000039 virtual std::vector<llvm::MCInst>
40 setRegToConstant(const llvm::MCSubtargetInfo &STI, unsigned Reg) const {
Clement Courbeta51efc22018-06-25 13:12:02 +000041 return {};
42 }
43
Guillaume Chateletfb943542018-08-01 14:41:45 +000044 // Returns the register pointing to scratch memory, or 0 if this target does
45 // not support memory operands. The benchmark function uses the default
46 // calling convention.
47 virtual unsigned getScratchMemoryRegister(const llvm::Triple &) const {
48 return 0;
49 }
50
51 // Fills memory operands with references to the address at [Reg] + Offset.
Guillaume Chatelet171f3f42018-08-02 11:12:02 +000052 virtual void fillMemoryOperands(InstructionBuilder &IB, unsigned Reg,
Guillaume Chateletfb943542018-08-01 14:41:45 +000053 unsigned Offset) const {
54 llvm_unreachable(
55 "fillMemoryOperands() requires getScratchMemoryRegister() > 0");
56 }
57
58 // Returns the maximum number of bytes a load/store instruction can access at
59 // once. This is typically the size of the largest register available on the
60 // processor. Note that this only used as a hint to generate independant
61 // load/stores to/from memory, so the exact returned value does not really
62 // matter as long as it's large enough.
63 virtual unsigned getMaxMemoryAccessSize() const { return 0; }
64
Clement Courbetd939f6d2018-09-13 07:40:53 +000065 // Creates a snippet generator for the given mode.
66 std::unique_ptr<SnippetGenerator>
67 createSnippetGenerator(InstructionBenchmark::ModeE Mode,
68 const LLVMState &State) const;
Clement Courbet4860b982018-06-26 08:49:30 +000069 // Creates a benchmark runner for the given mode.
70 std::unique_ptr<BenchmarkRunner>
71 createBenchmarkRunner(InstructionBenchmark::ModeE Mode,
72 const LLVMState &State) const;
73
Clement Courbet44b4c542018-06-19 11:28:59 +000074 // Returns the ExegesisTarget for the given triple or nullptr if the target
75 // does not exist.
Clement Courbet6fd00e32018-06-20 11:54:35 +000076 static const ExegesisTarget *lookup(llvm::Triple TT);
Clement Courbet4860b982018-06-26 08:49:30 +000077 // Returns the default (unspecialized) ExegesisTarget.
78 static const ExegesisTarget &getDefault();
Clement Courbet44b4c542018-06-19 11:28:59 +000079 // Registers a target. Not thread safe.
80 static void registerTarget(ExegesisTarget *T);
81
Roman Lebedev3de96642018-06-19 11:58:10 +000082 virtual ~ExegesisTarget();
Clement Courbet44b4c542018-06-19 11:28:59 +000083
84private:
85 virtual bool matchesArch(llvm::Triple::ArchType Arch) const = 0;
Clement Courbet4860b982018-06-26 08:49:30 +000086
Clement Courbetd939f6d2018-09-13 07:40:53 +000087 // Targets can implement their own snippet generators/benchmarks runners by
Clement Courbet4860b982018-06-26 08:49:30 +000088 // implementing these.
Clement Courbetd939f6d2018-09-13 07:40:53 +000089 std::unique_ptr<SnippetGenerator> virtual createLatencySnippetGenerator(
90 const LLVMState &State) const;
91 std::unique_ptr<SnippetGenerator> virtual createUopsSnippetGenerator(
92 const LLVMState &State) const;
Clement Courbet4860b982018-06-26 08:49:30 +000093 std::unique_ptr<BenchmarkRunner> virtual createLatencyBenchmarkRunner(
94 const LLVMState &State) const;
95 std::unique_ptr<BenchmarkRunner> virtual createUopsBenchmarkRunner(
96 const LLVMState &State) const;
97
Clement Courbetcff2caa2018-06-25 11:22:23 +000098 const ExegesisTarget *Next = nullptr;
Clement Courbet44b4c542018-06-19 11:28:59 +000099};
100
Clement Courbetcff2caa2018-06-25 11:22:23 +0000101} // namespace exegesis
Clement Courbet44b4c542018-06-19 11:28:59 +0000102
103#endif // LLVM_TOOLS_LLVM_EXEGESIS_TARGET_H