ReverseManager.hh

Go to the documentation of this file.

#ifndef REVERSEMANGER_HH
#define REVERSEMANGER_HH
 
#include "Schedulable.hh"
#include "EventListener.hh"
#include "Command.hh"
#include "EmuTime.hh"
#include "MemBuffer.hh"
#include "DeltaBlock.hh"
#include "outer.hh"
#include <cstdint>
#include <deque>
#include <span>
#include <map>
#include <memory>
#include <string_view>
#include <vector>
 
namespace openmsx {
 
class EventDelay;
class EventDistributor;
class Interpreter;
class MSXMotherBoard;
class Keyboard;
class StateChange;
class TclObject;
 
class ReverseManager final : private EventListener
{
public:
        static constexpr std::string_view REPLAY_DIR = "replays";
        static constexpr std::string_view REPLAY_EXTENSION = ".omr";
 
public:
        explicit ReverseManager(MSXMotherBoard& motherBoard);
        ~ReverseManager();
 
        // Keyboard is special because we need to transfer the host keyboard
        // state on 'reverse goto' to be able to resynchronize when replay
        // stops. See Keyboard::transferHostKeyMatrix() for more info.
        void registerKeyboard(Keyboard& keyboard_) {
                keyboard = &keyboard_;
        }
 
        // To not loose any events we need to flush delayed events before
        // switching machine. See comments in goTo() for more info.
        void registerEventDelay(EventDelay& eventDelay_) {
                eventDelay = &eventDelay_;
        }
 
        // Should only be used by MSXMotherBoard to be able to transfer
        // reRecordCount to ReverseManager for version 2 of MSXMotherBoard
        // serializers.
        void setReRecordCount(unsigned count) {
                reRecordCount = count;
        }
 
        [[nodiscard]] bool isReplaying() const;
        void stopReplay(EmuTime::param time) noexcept;
 
        template<typename T, typename... Args>
        StateChange& record(EmuTime::param time, Args&& ...args) {
                assert(!isReplaying());
                ++replayIndex;
                history.events.push_back(std::make_unique<T>(time, std::forward<Args>(args)...));
                return *history.events.back();
        }
 
        [[nodiscard]] bool isCollecting() const { return collecting; }
        [[nodiscard]] bool isViewOnlyMode() const;
        [[nodiscard]] double getBegin() const;
        [[nodiscard]] double getEnd() const;
        [[nodiscard]] double getCurrent() const;
        [[nodiscard]] std::vector<double> getSnapshotTimes() const;
 
private:
        struct ReverseChunk {
                EmuTime time = EmuTime::zero();
                std::vector<std::shared_ptr<DeltaBlock>> deltaBlocks;
                MemBuffer<uint8_t> savestate;
                size_t size;
 
                // Number of recorded events (or replay index) when this
                // snapshot was created. So when going back replay should
                // start at this index.
                unsigned eventCount;
        };
        using Chunks = std::map<unsigned, ReverseChunk>;
        using Events = std::deque<std::unique_ptr<StateChange>>;
 
        struct ReverseHistory {
                void swap(ReverseHistory& other) noexcept;
                void clear();
                [[nodiscard]] unsigned getNextSeqNum(EmuTime::param time) const;
 
                Chunks chunks;
                Events events;
                LastDeltaBlocks lastDeltaBlocks;
        };
 
        void start();
        void stop();
        void status(TclObject& result) const;
        void debugInfo(TclObject& result) const;
        void goBack(std::span<const TclObject> tokens);
        void goTo(std::span<const TclObject> tokens);
        void saveReplay(Interpreter& interp,
                        std::span<const TclObject> tokens, TclObject& result);
        void loadReplay(Interpreter& interp,
                        std::span<const TclObject> tokens, TclObject& result);
 
        void signalStopReplay(EmuTime::param time);
        [[nodiscard]] EmuTime::param getEndTime(const ReverseHistory& history) const;
        void goTo(EmuTime::param targetTime, bool noVideo);
        void goTo(EmuTime::param targetTime, bool noVideo,
                  ReverseHistory& history, bool sameTimeLine);
        void transferHistory(ReverseHistory& oldHistory,
                             unsigned oldEventCount);
        void transferState(MSXMotherBoard& newBoard);
        void takeSnapshot(EmuTime::param time);
        void schedule(EmuTime::param time);
        void replayNextEvent();
        template<unsigned N> void dropOldSnapshots(unsigned count);
 
        // Schedulable
        struct SyncNewSnapshot final : Schedulable {
                friend class ReverseManager;
                explicit SyncNewSnapshot(Scheduler& s) : Schedulable(s) {}
                void executeUntil(EmuTime::param /*time*/) override {
                        auto& rm = OUTER(ReverseManager, syncNewSnapshot);
                        rm.execNewSnapshot();
                }
        } syncNewSnapshot;
        struct SyncInputEvent final : Schedulable {
                friend class ReverseManager;
                explicit SyncInputEvent(Scheduler& s) : Schedulable(s) {}
                void executeUntil(EmuTime::param /*time*/) override {
                        auto& rm = OUTER(ReverseManager, syncInputEvent);
                        rm.execInputEvent();
                }
        } syncInputEvent;
 
        void execNewSnapshot();
        void execInputEvent();
        [[nodiscard]] EmuTime::param getCurrentTime() const { return syncNewSnapshot.getCurrentTime(); }
 
        // EventListener
        int signalEvent(const Event& event) override;
 
private:
        MSXMotherBoard& motherBoard;
        EventDistributor& eventDistributor;
 
        struct ReverseCmd final : Command {
                explicit ReverseCmd(CommandController& controller);
                void execute(std::span<const TclObject> tokens, TclObject& result) override;
                [[nodiscard]] std::string help(std::span<const TclObject> tokens) const override;
                void tabCompletion(std::vector<std::string>& tokens) const override;
        } reverseCmd;
 
        Keyboard* keyboard = nullptr;
        EventDelay* eventDelay = nullptr;
        ReverseHistory history;
        unsigned replayIndex = 0;
        bool collecting = false;
        bool pendingTakeSnapshot = false;
 
        unsigned reRecordCount = 0;
 
        friend struct Replay;
};
 
} // namespace openmsx
 
#endif