yuzu/src/core/tools/freezer.h

95 lines
2.8 KiB
C++
Raw Normal View History

// Copyright 2019 yuzu Emulator Project
// Licensed under GPLv2 or any later version
// Refer to the license.txt file included.
#pragma once
2019-05-30 22:57:23 +02:00
#include <atomic>
#include <chrono>
#include <memory>
2019-05-30 22:57:23 +02:00
#include <mutex>
#include <optional>
#include <vector>
#include "common/common_types.h"
2019-05-30 22:57:23 +02:00
namespace Core::Timing {
class CoreTiming;
struct EventType;
} // namespace Core::Timing
namespace Core::Memory {
class Memory;
}
namespace Tools {
2019-06-10 20:11:06 +02:00
/**
* This class allows the user to prevent an application from writing new values to certain memory
* locations. This has a variety of uses when attempting to reverse a game.
*
* One example could be a cheat to prevent Mario from taking damage in SMO. One could freeze the
* memory address that the game uses to store Mario's health so when he takes damage (and the game
* tries to write the new health value to memory), the value won't change.
*/
class Freezer {
public:
struct Entry {
VAddr address;
2019-05-30 22:57:23 +02:00
u32 width;
u64 value;
};
explicit Freezer(Core::Timing::CoreTiming& core_timing_, Core::Memory::Memory& memory_);
~Freezer();
2019-05-30 22:57:23 +02:00
// Enables or disables the entire memory freezer.
void SetActive(bool is_active);
2019-05-30 22:57:23 +02:00
// Returns whether or not the freezer is active.
bool IsActive() const;
2019-05-30 22:57:23 +02:00
// Removes all entries from the freezer.
void Clear();
2019-05-30 22:57:23 +02:00
// Freezes a value to its current memory address. The value the memory is kept at will be the
// value that is read during this function. Width can be 1, 2, 4, or 8 (in bytes).
u64 Freeze(VAddr address, u32 width);
// Unfreezes the memory value at address. If the address isn't frozen, this is a no-op.
void Unfreeze(VAddr address);
2019-05-30 22:57:23 +02:00
// Returns whether or not the address is frozen.
bool IsFrozen(VAddr address) const;
// Sets the value that address should be frozen to. This doesn't change the width set by using
// Freeze(). If the value isn't frozen, this will not freeze it and is thus a no-op.
void SetFrozenValue(VAddr address, u64 value);
2019-05-30 22:57:23 +02:00
// Returns the entry corresponding to the address if the address is frozen, otherwise
// std::nullopt.
std::optional<Entry> GetEntry(VAddr address) const;
2019-05-30 22:57:23 +02:00
// Returns all the entries in the freezer, an empty vector means nothing is frozen.
std::vector<Entry> GetEntries() const;
private:
using Entries = std::vector<Entry>;
Entries::iterator FindEntry(VAddr address);
Entries::const_iterator FindEntry(VAddr address) const;
void FrameCallback(std::uintptr_t user_data, std::chrono::nanoseconds ns_late);
void FillEntryReads();
std::atomic_bool active{false};
2019-05-30 22:57:23 +02:00
mutable std::mutex entries_mutex;
Entries entries;
std::shared_ptr<Core::Timing::EventType> event;
Core::Timing::CoreTiming& core_timing;
Core::Memory::Memory& memory;
};
} // namespace Tools