ppsspp/Core/MIPS/IR/IRJit.h
2024-10-28 17:59:06 +01:00

261 lines
7.6 KiB
C++

// Copyright (c) 2012- PPSSPP Project.
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, version 2.0 or later versions.
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License 2.0 for more details.
// A copy of the GPL 2.0 should have been included with the program.
// If not, see http://www.gnu.org/licenses/
// Official git repository and contact information can be found at
// https://github.com/hrydgard/ppsspp and http://www.ppsspp.org/.
#pragma once
#include <cstring>
#include <unordered_map>
#include "Common/CommonTypes.h"
#include "Common/CPUDetect.h"
#include "Core/MIPS/JitCommon/JitBlockCache.h"
#include "Core/MIPS/JitCommon/JitCommon.h"
#include "Core/MIPS/IR/IRRegCache.h"
#include "Core/MIPS/IR/IRInst.h"
#include "Core/MIPS/IR/IRFrontend.h"
#include "Core/MIPS/MIPSVFPUUtils.h"
#ifndef offsetof
#include "stddef.h"
#endif
// Very expensive, time-profiles every block.
// Not to be released with this enabled.
//
// #define IR_PROFILING
// Try to catch obvious misses of be above rule.
#if defined(IR_PROFILING) && defined(GOLD)
#error
#endif
namespace MIPSComp {
// TODO : Use arena allocators. For now let's just malloc.
class IRBlock {
public:
IRBlock() {}
IRBlock(u32 emAddr, u32 origSize, int instOffset, u32 numInstructions)
: origAddr_(emAddr), origSize_(origSize), arenaOffset_(instOffset), numIRInstructions_(numInstructions) {}
IRBlock(IRBlock &&b) noexcept {
arenaOffset_ = b.arenaOffset_;
hash_ = b.hash_;
origAddr_ = b.origAddr_;
origSize_ = b.origSize_;
origFirstOpcode_ = b.origFirstOpcode_;
nativeOffset_ = b.nativeOffset_;
numIRInstructions_ = b.numIRInstructions_;
b.arenaOffset_ = 0xFFFFFFFF;
}
~IRBlock() {}
u32 GetIRArenaOffset() const { return arenaOffset_; }
int GetNumIRInstructions() const { return numIRInstructions_; }
MIPSOpcode GetOriginalFirstOp() const { return origFirstOpcode_; }
bool HasOriginalFirstOp() const;
bool RestoreOriginalFirstOp(int number);
bool IsValid() const { return origAddr_ != 0 && origFirstOpcode_.encoding != 0x68FFFFFF; }
void SetNativeOffset(int offset) {
nativeOffset_ = offset;
}
int GetNativeOffset() const {
return nativeOffset_;
}
void UpdateHash() {
hash_ = CalculateHash();
}
bool HashMatches() const {
return origAddr_ && hash_ == CalculateHash();
}
bool OverlapsRange(u32 addr, u32 size) const;
void GetRange(u32 *start, u32 *size) const {
*start = origAddr_;
*size = origSize_;
}
u32 GetOriginalStart() const {
return origAddr_;
}
u64 GetHash() const {
return hash_;
}
void Finalize(int number);
void Destroy(int number);
#ifdef IR_PROFILING
JitBlockProfileStats profileStats_{};
#endif
private:
u64 CalculateHash() const;
// Offset into the block cache's Arena
u32 arenaOffset_ = 0;
// Offset into the native code buffer.
int nativeOffset_ = -1;
u64 hash_ = 0;
u32 origAddr_ = 0;
u32 origSize_ = 0;
MIPSOpcode origFirstOpcode_ = MIPSOpcode(0x68FFFFFF);
u32 numIRInstructions_ = 0;
};
class IRBlockCache : public JitBlockCacheDebugInterface {
public:
IRBlockCache(bool compileToNative);
void Clear();
std::vector<int> FindInvalidatedBlockNumbers(u32 address, u32 length);
void FinalizeBlock(int blockNum, bool preload = false);
int GetNumBlocks() const override { return (int)blocks_.size(); }
int AllocateBlock(int emAddr, u32 origSize, const std::vector<IRInst> &inst);
IRBlock *GetBlock(int blockNum) {
if (blockNum >= 0 && blockNum < (int)blocks_.size()) {
return &blocks_[blockNum];
} else {
return nullptr;
}
}
void RemoveBlockFromPageLookup(int blockNum);
int GetBlockNumFromIRArenaOffset(int offset) const;
const IRInst *GetBlockInstructionPtr(const IRBlock &block) const {
return arena_.data() + block.GetIRArenaOffset();
}
const IRInst *GetBlockInstructionPtr(int blockNum) const {
return arena_.data() + blocks_[blockNum].GetIRArenaOffset();
}
const IRInst *GetArenaPtr() const {
return arena_.data();
}
bool IsValidBlock(int blockNum) const override {
return blockNum >= 0 && blockNum < (int)blocks_.size() && blocks_[blockNum].IsValid();
}
IRBlock *GetBlockUnchecked(int blockNum) {
return &blocks_[blockNum];
}
const IRBlock *GetBlock(int blockNum) const {
if (blockNum >= 0 && blockNum < (int)blocks_.size()) {
return &blocks_[blockNum];
} else {
return nullptr;
}
}
int FindPreloadBlock(u32 em_address);
// "Cookie" means the 24 bits we inject into the first instruction of each block.
int FindByCookie(int cookie);
std::vector<u32> SaveAndClearEmuHackOps();
void RestoreSavedEmuHackOps(const std::vector<u32> &saved);
JitBlockDebugInfo GetBlockDebugInfo(int blockNum) const override;
JitBlockMeta GetBlockMeta(int blockNum) const override {
JitBlockMeta meta{};
if (IsValidBlock(blockNum)) {
meta.valid = true;
blocks_[blockNum].GetRange(&meta.addr, &meta.sizeInBytes);
}
return meta;
}
JitBlockProfileStats GetBlockProfileStats(int blockNum) const override {
#ifdef IR_PROFILING
return blocks_[blockNum].profileStats_;
#else
return JitBlockProfileStats{};
#endif
}
void ComputeStats(BlockCacheStats &bcStats) const override;
int GetBlockNumberFromStartAddress(u32 em_address, bool realBlocksOnly = true) const override;
bool SupportsProfiling() const override {
#ifdef IR_PROFILING
return true;
#else
return false;
#endif
}
private:
u32 AddressToPage(u32 addr) const;
bool compileToNative_;
std::vector<IRBlock> blocks_;
std::vector<IRInst> arena_;
std::unordered_map<u32, std::vector<int>> byPage_;
};
class IRJit : public JitInterface {
public:
IRJit(MIPSState *mipsState, bool actualJit);
~IRJit();
void DoState(PointerWrap &p) override;
const JitOptions &GetJitOptions() { return jo; }
void RunLoopUntil(u64 globalticks) override;
void Compile(u32 em_address) override; // Compiles a block at current MIPS PC
void CompileFunction(u32 start_address, u32 length) override;
bool DescribeCodePtr(const u8 *ptr, std::string &name) override;
// Not using a regular block cache.
JitBlockCache *GetBlockCache() override { return nullptr; }
JitBlockCacheDebugInterface *GetBlockCacheDebugInterface() override { return &blocks_; }
MIPSOpcode GetOriginalOp(MIPSOpcode op) override;
std::vector<u32> SaveAndClearEmuHackOps() override { return blocks_.SaveAndClearEmuHackOps(); }
void RestoreSavedEmuHackOps(std::vector<u32> saved) override { blocks_.RestoreSavedEmuHackOps(saved); }
void ClearCache() override;
void InvalidateCacheAt(u32 em_address, int length = 4) override;
void UpdateFCR31() override;
bool CodeInRange(const u8 *ptr) const override {
return false;
}
const u8 *GetDispatcher() const override { return nullptr; }
const u8 *GetCrashHandler() const override { return nullptr; }
void LinkBlock(u8 *exitPoint, const u8 *checkedEntry) override;
void UnlinkBlock(u8 *checkedEntry, u32 originalAddress) override;
protected:
bool CompileBlock(u32 em_address, std::vector<IRInst> &instructions, u32 &mipsBytes, bool preload);
virtual bool CompileNativeBlock(IRBlockCache *irBlockCache, int block_num, bool preload) { return true; }
virtual void FinalizeNativeBlock(IRBlockCache *irBlockCache, int block_num) {}
bool compileToNative_;
JitOptions jo;
IRFrontend frontend_;
IRBlockCache blocks_;
MIPSState *mips_;
bool compilerEnabled_ = true;
// where to write branch-likely trampolines. not used atm
// u32 blTrampolines_;
// int blTrampolineCount_;
};
} // namespace MIPSComp