Matin Raayai bb3f5e1fed
Overhaul the TargetMachine and LLVMTargetMachine Classes (#111234)
Following discussions in #110443, and the following earlier discussions
in https://lists.llvm.org/pipermail/llvm-dev/2017-October/117907.html,
https://reviews.llvm.org/D38482, https://reviews.llvm.org/D38489, this
PR attempts to overhaul the `TargetMachine` and `LLVMTargetMachine`
interface classes. More specifically:
1. Makes `TargetMachine` the only class implemented under
`TargetMachine.h` in the `Target` library.
2. `TargetMachine` contains target-specific interface functions that
relate to IR/CodeGen/MC constructs, whereas before (at least on paper)
it was supposed to have only IR/MC constructs. Any Target that doesn't
want to use the independent code generator simply does not implement
them, and returns either `false` or `nullptr`.
3. Renames `LLVMTargetMachine` to `CodeGenCommonTMImpl`. This renaming
aims to make the purpose of `LLVMTargetMachine` clearer. Its interface
was moved under the CodeGen library, to further emphasis its usage in
Targets that use CodeGen directly.
4. Makes `TargetMachine` the only interface used across LLVM and its
projects. With these changes, `CodeGenCommonTMImpl` is simply a set of
shared function implementations of `TargetMachine`, and CodeGen users
don't need to static cast to `LLVMTargetMachine` every time they need a
CodeGen-specific feature of the `TargetMachine`.
5. More importantly, does not change any requirements regarding library
linking.

cc @arsenm @aeubanks
2024-11-14 13:30:05 -08:00

106 lines
3.5 KiB
C++

//===-- LlvmState.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 class to set up and access common LLVM objects.
///
//===----------------------------------------------------------------------===//
#ifndef LLVM_TOOLS_LLVM_EXEGESIS_LLVMSTATE_H
#define LLVM_TOOLS_LLVM_EXEGESIS_LLVMSTATE_H
#include "MCInstrDescView.h"
#include "RegisterAliasing.h"
#include "llvm/MC/MCAsmInfo.h"
#include "llvm/MC/MCInst.h"
#include "llvm/MC/MCInstrInfo.h"
#include "llvm/MC/MCRegister.h"
#include "llvm/MC/MCRegisterInfo.h"
#include "llvm/MC/MCSubtargetInfo.h"
#include "llvm/Target/TargetMachine.h"
#include <memory>
#include <string>
static constexpr llvm::StringLiteral kNoRegister("%noreg");
namespace llvm {
namespace exegesis {
class ExegesisTarget;
struct PfmCountersInfo;
// An object to initialize LLVM and prepare objects needed to run the
// measurements.
class LLVMState {
public:
// Factory function.
// If `Triple` is empty, uses the host triple.
// If `CpuName` is empty, uses the host CPU.
// If `UseDummyPerfCounters` is set, does not query the kernel
// for event counts.
// `UseDummyPerfCounters` and `Features` are intended for tests.
static Expected<LLVMState> Create(std::string TripleName, std::string CpuName,
StringRef Features = "",
bool UseDummyPerfCounters = false);
const TargetMachine &getTargetMachine() const { return *TheTargetMachine; }
std::unique_ptr<TargetMachine> createTargetMachine() const;
const ExegesisTarget &getExegesisTarget() const { return *TheExegesisTarget; }
bool canAssemble(const MCInst &mc_inst) const;
// For convenience:
const MCInstrInfo &getInstrInfo() const {
return *TheTargetMachine->getMCInstrInfo();
}
const MCRegisterInfo &getRegInfo() const {
return *TheTargetMachine->getMCRegisterInfo();
}
const MCSubtargetInfo &getSubtargetInfo() const {
return *TheTargetMachine->getMCSubtargetInfo();
}
const RegisterAliasingTrackerCache &getRATC() const { return *RATC; }
const InstructionsCache &getIC() const { return *IC; }
const PfmCountersInfo &getPfmCounters() const { return *PfmCounters; }
const DenseMap<StringRef, unsigned> &getOpcodeNameToOpcodeIdxMapping() const {
assert(OpcodeNameToOpcodeIdxMapping);
return *OpcodeNameToOpcodeIdxMapping;
};
std::optional<MCRegister>
getRegisterNumberFromName(StringRef RegisterName) const;
private:
std::unique_ptr<const DenseMap<StringRef, unsigned>>
createOpcodeNameToOpcodeIdxMapping() const;
std::unique_ptr<const DenseMap<StringRef, MCRegister>>
createRegNameToRegNoMapping() const;
LLVMState(std::unique_ptr<const TargetMachine> TM, const ExegesisTarget *ET,
const PfmCountersInfo *PCI);
const ExegesisTarget *TheExegesisTarget;
std::unique_ptr<const TargetMachine> TheTargetMachine;
std::unique_ptr<const RegisterAliasingTrackerCache> RATC;
std::unique_ptr<const InstructionsCache> IC;
const PfmCountersInfo *PfmCounters;
std::unique_ptr<const DenseMap<StringRef, unsigned>>
OpcodeNameToOpcodeIdxMapping;
std::unique_ptr<const DenseMap<StringRef, MCRegister>> RegNameToRegNoMapping;
};
} // namespace exegesis
} // namespace llvm
#endif // LLVM_TOOLS_LLVM_EXEGESIS_LLVMSTATE_H