Ticket #4095: rename.patch

source/gui/scripting/ScriptFunctions.cpp

@@ -35 +35 @@
 #include "lib/timer.h"
 #include "lib/utf8.h"
 #include "lobby/scripting/JSInterface_Lobby.h"
 #include "maths/FixedVector3D.h"
 #include "network/NetClient.h"
+#include "network/NetMessage.h"
 #include "network/NetServer.h"
-#include "network/NetTurnManager.h"
 #include "ps/CConsole.h"
 #include "ps/CLogger.h"
 #include "ps/Errors.h"
 #include "ps/GUID.h"
 #include "ps/Game.h"
@@ -68 +68 @@
 #include "simulation2/components/ICmpPlayerManager.h"
 #include "simulation2/components/ICmpRangeManager.h"
 #include "simulation2/components/ICmpSelectable.h"
 #include "simulation2/components/ICmpTemplateManager.h"
 #include "simulation2/helpers/Selection.h"
+#include "simulation2/system/TurnManager.h"
 #include "soundmanager/SoundManager.h"
 #include "soundmanager/scripting/JSInterface_Sound.h"
 #include "tools/atlas/GameInterface/GameLoop.h"
 
 /*

source/network/NetTurnManager.cpp

@@ -16 +16 @@
  */
 
 #include "precompiled.h"
 
 #include "NetTurnManager.h"
-#include "NetMessage.h"
 
 #include "network/NetServer.h"
 #include "network/NetClient.h"
-#include "network/NetMessage.h"
 
 #include "gui/GUIManager.h"
-#include "maths/MathUtil.h"
 #include "ps/CLogger.h"
-#include "ps/Profile.h"
 #include "ps/Pyrogenesis.h"
 #include "ps/Replay.h"
-#include "ps/SavedGame.h"
-#include "scriptinterface/ScriptInterface.h"
 #include "simulation2/Simulation2.h"
 
 #include <sstream>
 #include <fstream>
 #include <iomanip>
 
-const u32 DEFAULT_TURN_LENGTH_MP = 500;
-const u32 DEFAULT_TURN_LENGTH_SP = 200;
-
-static const int COMMAND_DELAY = 2;
-
 #if 0
 #define NETTURN_LOG(args) debug_printf args
 #else
 #define NETTURN_LOG(args)
 #endif
@@ -56 +45 @@
     for (size_t i = 0; i < s.size(); ++i)
         str << std::setfill('0') << std::setw(2) << (int)(unsigned char)s[i];
     return str.str();
 }
 
-CNetTurnManager::CNetTurnManager(CSimulation2& simulation, u32 defaultTurnLength, int clientId, IReplayLogger& replay) :
-    m_Simulation2(simulation), m_CurrentTurn(0), m_ReadyTurn(1), m_TurnLength(defaultTurnLength), m_DeltaSimTime(0),
-    m_PlayerId(-1), m_ClientId(clientId), m_HasSyncError(false), m_Replay(replay),
-    m_TimeWarpNumTurns(0), m_FinalTurn(std::numeric_limits<u32>::max())
-{
-    // When we are on turn n, we schedule new commands for n+2.
-    // We know that all other clients have finished scheduling commands for n (else we couldn't have got here).
-    // We know we have not yet finished scheduling commands for n+2.
-    // Hence other clients can be on turn n-1, n, n+1, and no other.
-    // So they can be sending us commands scheduled for n+1, n+2, n+3.
-    // So we need a 3-element buffer:
-    m_QueuedCommands.resize(COMMAND_DELAY + 1);
-}
-
-void CNetTurnManager::ResetState(u32 newCurrentTurn, u32 newReadyTurn)
-{
-    m_CurrentTurn = newCurrentTurn;
-    m_ReadyTurn = newReadyTurn;
-    m_DeltaSimTime = 0;
-    size_t queuedCommandsSize = m_QueuedCommands.size();
-    m_QueuedCommands.clear();
-    m_QueuedCommands.resize(queuedCommandsSize);
-}
-
-void CNetTurnManager::SetPlayerID(int playerId)
-{
-    m_PlayerId = playerId;
-}
-
-bool CNetTurnManager::WillUpdate(float simFrameLength)
-{
-    // Keep this in sync with the return value of Update()
-
-    if (m_CurrentTurn > m_FinalTurn)
-        return false;
-
-    if (m_DeltaSimTime + simFrameLength < 0)
-        return false;
-
-    if (m_ReadyTurn <= m_CurrentTurn)
-        return false;
-
-    return true;
-}
-
-bool CNetTurnManager::Update(float simFrameLength, size_t maxTurns)
-{
-    if (m_CurrentTurn > m_FinalTurn)
-        return false;
-
-    m_DeltaSimTime += simFrameLength;
-
-    // If the game becomes laggy, m_DeltaSimTime increases progressively.
-    // The engine will fast forward accordingly to catch up.
-    // To keep the game playable, stop fast forwarding after 2 turn lengths.
-    m_DeltaSimTime = std::min(m_DeltaSimTime, 2.0f * m_TurnLength / 1000.0f);
-
-    // If we haven't reached the next turn yet, do nothing
-    if (m_DeltaSimTime < 0)
-        return false;
-
-    NETTURN_LOG((L"Update current=%d ready=%d\n", m_CurrentTurn, m_ReadyTurn));
-
-    // Check that the next turn is ready for execution
-    if (m_ReadyTurn <= m_CurrentTurn)
-    {
-        // Oops, we wanted to start the next turn but it's not ready yet -
-        // there must be too much network lag.
-        // TODO: complain to the user.
-        // TODO: send feedback to the server to increase the turn length.
-
-        // Reset the next-turn timer to 0 so we try again next update but
-        // so we don't rush to catch up in subsequent turns.
-        // TODO: we should do clever rate adjustment instead of just pausing like this.
-        m_DeltaSimTime = 0;
-
-        return false;
-    }
-
-    maxTurns = std::max((size_t)1, maxTurns); // always do at least one turn
-
-    for (size_t i = 0; i < maxTurns; ++i)
-    {
-        // Check that we've reached the i'th next turn
-        if (m_DeltaSimTime < 0)
-            break;
-
-        // Check that the i'th next turn is still ready
-        if (m_ReadyTurn <= m_CurrentTurn)
-            break;
-
-        NotifyFinishedOwnCommands(m_CurrentTurn + COMMAND_DELAY);
-
-        // Increase now, so Update can send new commands for a subsequent turn
-        ++m_CurrentTurn;
-
-        // Clean up any destroyed entities since the last turn (e.g. placement previews
-        // or rally point flags generated by the GUI). (Must do this before the time warp
-        // serialization.)
-        m_Simulation2.FlushDestroyedEntities();
-
-        // Save the current state for rewinding, if enabled
-        if (m_TimeWarpNumTurns && (m_CurrentTurn % m_TimeWarpNumTurns) == 0)
-        {
-            PROFILE3("time warp serialization");
-            std::stringstream stream;
-            m_Simulation2.SerializeState(stream);
-            m_TimeWarpStates.push_back(stream.str());
-        }
-
-        // Put all the client commands into a single list, in a globally consistent order
-        std::vector<SimulationCommand> commands;
-        for (std::pair<const u32, std::vector<SimulationCommand>>& p : m_QueuedCommands[0])
-            commands.insert(commands.end(), std::make_move_iterator(p.second.begin()), std::make_move_iterator(p.second.end()));
-
-        m_QueuedCommands.pop_front();
-        m_QueuedCommands.resize(m_QueuedCommands.size() + 1);
-
-        m_Replay.Turn(m_CurrentTurn-1, m_TurnLength, commands);
-
-        NETTURN_LOG((L"Running %d cmds\n", commands.size()));
-
-        m_Simulation2.Update(m_TurnLength, commands);
-
-        NotifyFinishedUpdate(m_CurrentTurn);
-
-        // Set the time for the next turn update
-        m_DeltaSimTime -= m_TurnLength / 1000.f;
-    }
-
-    return true;
-}
-
-bool CNetTurnManager::UpdateFastForward()
-{
-    m_DeltaSimTime = 0;
-
-    NETTURN_LOG((L"UpdateFastForward current=%d ready=%d\n", m_CurrentTurn, m_ReadyTurn));
-
-    // Check that the next turn is ready for execution
-    if (m_ReadyTurn <= m_CurrentTurn)
-        return false;
-
-    while (m_ReadyTurn > m_CurrentTurn)
-    {
-        // TODO: It would be nice to remove some of the duplication with Update()
-        // (This is similar but doesn't call any Notify functions or update DeltaTime,
-        // it just updates the simulation state)
-
-        ++m_CurrentTurn;
-
-        m_Simulation2.FlushDestroyedEntities();
-
-        // Put all the client commands into a single list, in a globally consistent order
-        std::vector<SimulationCommand> commands;
-        for (std::pair<const u32, std::vector<SimulationCommand>>& p : m_QueuedCommands[0])
-            commands.insert(commands.end(), std::make_move_iterator(p.second.begin()), std::make_move_iterator(p.second.end()));
-
-        m_QueuedCommands.pop_front();
-        m_QueuedCommands.resize(m_QueuedCommands.size() + 1);
-
-        m_Replay.Turn(m_CurrentTurn-1, m_TurnLength, commands);
-
-        NETTURN_LOG((L"Running %d cmds\n", commands.size()));
-
-        m_Simulation2.Update(m_TurnLength, commands);
-    }
-
-    return true;
-}
-
-void CNetTurnManager::OnSyncError(u32 turn, const CStr& expectedHash, std::vector<CSyncErrorMessage::S_m_PlayerNames>& playerNames)
-{
-    NETTURN_LOG((L"OnSyncError(%d, %hs)\n", turn, Hexify(expectedHash).c_str()));
-
-    // Only complain the first time
-    if (m_HasSyncError)
-        return;
-
-    bool quick = !TurnNeedsFullHash(turn);
-    std::string hash;
-    ENSURE(m_Simulation2.ComputeStateHash(hash, quick));
-
-    OsPath path = psLogDir() / "oos_dump.txt";
-    std::ofstream file (OsString(path).c_str(), std::ofstream::out | std::ofstream::trunc);
-    m_Simulation2.DumpDebugState(file);
-    file.close();
-
-    hash = Hexify(hash);
-    const std::string& expectedHashHex = Hexify(expectedHash);
-
-    DisplayOOSError(turn, hash, expectedHashHex, false, &playerNames, &path);
-}
-
-void CNetTurnManager::DisplayOOSError(u32 turn, const CStr& hash, const CStr& expectedHash, bool isReplay, std::vector<CSyncErrorMessage::S_m_PlayerNames>* playerNames = NULL, OsPath* path = NULL)
-{
-    m_HasSyncError = true;
-
-    std::stringstream msg;
-    msg << "Out of sync on turn " << turn;
-
-    if (playerNames)
-        for (size_t i = 0; i < playerNames->size(); ++i)
-            msg << (i == 0 ? "\nPlayers: " : ", ") << utf8_from_wstring((*playerNames)[i].m_Name);
-
-    if (isReplay)
-        msg << "\n\n" << "The current game state is different from the original game state.";
-    else
-        msg << "\n\n" << "Your game state is " << (expectedHash == hash ? "identical to" : "different from") << " the hosts game state.";
-
-    if (path)
-        msg << "\n\n" << "Dumping current state to " << CStr(path->string8()).EscapeToPrintableASCII();
-
-    LOGERROR("%s", msg.str());
-
-    if (g_GUI)
-        g_GUI->DisplayMessageBox(600, 350, L"Sync error", wstring_from_utf8(msg.str()));
-}
-
-void CNetTurnManager::Interpolate(float simFrameLength, float realFrameLength)
-{
-    // TODO: using m_TurnLength might be a bit dodgy when length changes - maybe
-    // we need to save the previous turn length?
-
-    float offset = clamp(m_DeltaSimTime / (m_TurnLength / 1000.f) + 1.0, 0.0, 1.0);
-
-    // Stop animations while still updating the selection highlight
-    if (m_CurrentTurn > m_FinalTurn)
-        simFrameLength = 0;
-
-    m_Simulation2.Interpolate(simFrameLength, offset, realFrameLength);
-}
-
-void CNetTurnManager::AddCommand(int client, int player, JS::HandleValue data, u32 turn)
-{
-    NETTURN_LOG((L"AddCommand(client=%d player=%d turn=%d)\n", client, player, turn));
-
-    if (!(m_CurrentTurn < turn && turn <= m_CurrentTurn + COMMAND_DELAY + 1))
-    {
-        debug_warn(L"Received command for invalid turn");
-        return;
-    }
-
-    m_Simulation2.GetScriptInterface().FreezeObject(data, true);
-    m_QueuedCommands[turn - (m_CurrentTurn+1)][client].emplace_back(player, m_Simulation2.GetScriptInterface().GetContext(), data);
-}
-
-void CNetTurnManager::FinishedAllCommands(u32 turn, u32 turnLength)
-{
-    NETTURN_LOG((L"FinishedAllCommands(%d, %d)\n", turn, turnLength));
-
-    ENSURE(turn == m_ReadyTurn + 1);
-    m_ReadyTurn = turn;
-    m_TurnLength = turnLength;
-}
-
-bool CNetTurnManager::TurnNeedsFullHash(u32 turn)
-{
-    // Check immediately for errors caused by e.g. inconsistent game versions
-    // (The hash is computed after the first sim update, so we start at turn == 1)
-    if (turn == 1)
-        return true;
-
-    // Otherwise check the full state every ~10 seconds in multiplayer games
-    // (TODO: should probably remove this when we're reasonably sure the game
-    // isn't too buggy, since the full hash is still pretty slow)
-    if (turn % 20 == 0)
-        return true;
-
-    return false;
-}
-
-void CNetTurnManager::EnableTimeWarpRecording(size_t numTurns)
-{
-    m_TimeWarpStates.clear();
-    m_TimeWarpNumTurns = numTurns;
-}
-
-void CNetTurnManager::RewindTimeWarp()
-{
-    if (m_TimeWarpStates.empty())
-        return;
-
-    std::stringstream stream(m_TimeWarpStates.back());
-    m_Simulation2.DeserializeState(stream);
-    m_TimeWarpStates.pop_back();
-
-    // Reset the turn manager state, so we won't execute stray commands and
-    // won't do the next snapshot until the appropriate time.
-    // (Ideally we ought to serialise the turn manager state and restore it
-    // here, but this is simpler for now.)
-    ResetState(0, 1);
-}
-
-void CNetTurnManager::QuickSave()
-{
-    TIMER(L"QuickSave");
-
-    std::stringstream stream;
-    if (!m_Simulation2.SerializeState(stream))
-    {
-        LOGERROR("Failed to quicksave game");
-        return;
-    }
-
-    m_QuickSaveState = stream.str();
-    if (g_GUI)
-        m_QuickSaveMetadata = g_GUI->GetSavedGameData();
-    else
-        m_QuickSaveMetadata = std::string();
-
-    LOGMESSAGERENDER("Quicksaved game");
-
-}
-
-void CNetTurnManager::QuickLoad()
-{
-    TIMER(L"QuickLoad");
-
-    if (m_QuickSaveState.empty())
-    {
-        LOGERROR("Cannot quickload game - no game was quicksaved");
-        return;
-    }
-
-    std::stringstream stream(m_QuickSaveState);
-    if (!m_Simulation2.DeserializeState(stream))
-    {
-        LOGERROR("Failed to quickload game");
-        return;
-    }
-
-    if (g_GUI && !m_QuickSaveMetadata.empty())
-        g_GUI->RestoreSavedGameData(m_QuickSaveMetadata);
-
-    LOGMESSAGERENDER("Quickloaded game");
-
-    // See RewindTimeWarp
-    ResetState(0, 1);
-}
-
-
 CNetClientTurnManager::CNetClientTurnManager(CSimulation2& simulation, CNetClient& client, int clientId, IReplayLogger& replay) :
-    CNetTurnManager(simulation, DEFAULT_TURN_LENGTH_MP, clientId, replay), m_NetClient(client)
+    CTurnManager(simulation, DEFAULT_TURN_LENGTH_MP, clientId, replay), m_NetClient(client)
 {
 }
 
 void CNetClientTurnManager::PostCommand(JS::HandleValue data)
 {
@@ -461 +108 @@
 void CNetClientTurnManager::OnDestroyConnection()
 {
     NotifyFinishedOwnCommands(m_CurrentTurn + COMMAND_DELAY);
 }
 
-void CNetClientTurnManager::OnSimulationMessage(CSimulationMessage* msg)
-{
-    // Command received from the server - store it for later execution
-    AddCommand(msg->m_Client, msg->m_Player, msg->m_Data, msg->m_Turn);
-}
-
-
-CNetLocalTurnManager::CNetLocalTurnManager(CSimulation2& simulation, IReplayLogger& replay) :
-    CNetTurnManager(simulation, DEFAULT_TURN_LENGTH_SP, 0, replay)
+void CNetClientTurnManager::OnSyncError(u32 turn, const CStr& expectedHash, const std::vector<CSyncErrorMessage::S_m_PlayerNames>& playerNames)
 {
-}
-
-void CNetLocalTurnManager::PostCommand(JS::HandleValue data)
-{
-    // Add directly to the next turn, ignoring COMMAND_DELAY,
-    // because we don't need to compensate for network latency
-    AddCommand(m_ClientId, m_PlayerId, data, m_CurrentTurn + 1);
-}
+    NETTURN_LOG((L"OnSyncError(%d, %hs)\n", turn, Hexify(expectedHash).c_str()));
 
-void CNetLocalTurnManager::NotifyFinishedOwnCommands(u32 turn)
-{
-    FinishedAllCommands(turn, m_TurnLength);
-}
+    // Only complain the first time
+    if (m_HasSyncError)
+        return;
 
-void CNetLocalTurnManager::NotifyFinishedUpdate(u32 UNUSED(turn))
-{
-#if 0 // this hurts performance and is only useful for verifying log replays
+    bool quick = !TurnNeedsFullHash(turn);
     std::string hash;
-    {
-        PROFILE3("state hash check");
-        ENSURE(m_Simulation2.ComputeStateHash(hash));
-    }
-    m_Replay.Hash(hash);
-#endif
-}
-
-void CNetLocalTurnManager::OnSimulationMessage(CSimulationMessage* UNUSED(msg))
-{
-    debug_warn(L"This should never be called");
-}
-
-CNetReplayTurnManager::CNetReplayTurnManager(CSimulation2& simulation, IReplayLogger& replay) :
-    CNetLocalTurnManager(simulation, replay)
-{
-}
-
-void CNetReplayTurnManager::StoreReplayCommand(u32 turn, int player, const std::string& command)
-{
-    // Using the pair we make sure that commands per turn will be processed in the correct order
-    m_ReplayCommands[turn].emplace_back(player, command);
-}
-
-void CNetReplayTurnManager::StoreReplayHash(u32 turn, const std::string& hash, bool quick)
-{
-    m_ReplayHash[turn] = std::make_pair(hash, quick);
-}
-
-void CNetReplayTurnManager::StoreReplayTurnLength(u32 turn, u32 turnLength)
-{
-    m_ReplayTurnLengths[turn] = turnLength;
-
-    // Initialize turn length
-    if (turn == 0)
-        m_TurnLength = m_ReplayTurnLengths[0];
-}
+    ENSURE(m_Simulation2.ComputeStateHash(hash, quick));
 
-void CNetReplayTurnManager::StoreFinalReplayTurn(u32 turn)
-{
-    m_FinalTurn = turn;
-}
+    OsPath path = psLogDir() / "oos_dump.txt";
+    std::ofstream file (OsString(path).c_str(), std::ofstream::out | std::ofstream::trunc);
+    m_Simulation2.DumpDebugState(file);
+    file.close();
 
-void CNetReplayTurnManager::NotifyFinishedUpdate(u32 turn)
-{
-    if (turn == 1 && m_FinalTurn == 0)
-        g_GUI->SendEventToAll("ReplayFinished");
+    hash = Hexify(hash);
+    const std::string& expectedHashHex = Hexify(expectedHash);
 
-    if (turn > m_FinalTurn)
-        return;
+    m_HasSyncError = true;
 
-    DoTurn(turn);
+    std::stringstream msg;
+    msg << "Out of sync on turn " << turn;
 
-    // Compare hash if it exists in the replay and if we didn't have an OOS already
-    if (m_HasSyncError || m_ReplayHash.find(turn) == m_ReplayHash.end())
-        return;
+    for (size_t i = 0; i < playerNames.size(); ++i)
+        msg << (i == 0 ? "\nPlayers: " : ", ") << utf8_from_wstring(playerNames[i].m_Name);
 
-    std::string expectedHash = m_ReplayHash[turn].first;
-    bool quickHash = m_ReplayHash[turn].second;
+    msg << "\n\n" << "Your game state is " << (expectedHash == hash ? "identical to" : "different from")
+        << " the hosts game state." << "\n\n" << "Dumping current state to " << CStr(path.string8()).EscapeToPrintableASCII();
 
-    // Compute hash
-    std::string hash;
-    ENSURE(m_Simulation2.ComputeStateHash(hash, quickHash));
-    hash = Hexify(hash);
+    LOGERROR("%s", msg.str());
 
-    if (hash != expectedHash)
-        DisplayOOSError(turn, hash, expectedHash, true);
+    if (g_GUI)
+        g_GUI->DisplayMessageBox(600, 350, L"Sync error", wstring_from_utf8(msg.str()));
 }
 
-void CNetReplayTurnManager::DoTurn(u32 turn)
+void CNetClientTurnManager::OnSimulationMessage(CSimulationMessage* msg)
 {
-    debug_printf("Executing turn %u of %u\n", turn, m_FinalTurn);
-
-    m_TurnLength = m_ReplayTurnLengths[turn];
-
-    // Simulate commands for that turn
-    for (const std::pair<player_id_t, std::string>& p : m_ReplayCommands[turn])
-    {
-        JS::RootedValue command(m_Simulation2.GetScriptInterface().GetContext());
-        m_Simulation2.GetScriptInterface().ParseJSON(p.second, &command);
-        AddCommand(m_ClientId, p.first, command, m_CurrentTurn + 1);
-    }
-
-    if (turn == m_FinalTurn)
-        g_GUI->SendEventToAll("ReplayFinished");
+    // Command received from the server - store it for later execution
+    AddCommand(msg->m_Client, msg->m_Player, msg->m_Data, msg->m_Turn);
 }
 
 CNetServerTurnManager::CNetServerTurnManager(CNetServerWorker& server) :
     m_NetServer(server), m_ReadyTurn(1), m_TurnLength(DEFAULT_TURN_LENGTH_MP), m_HasSyncError(false)
 {

source/network/NetTurnManager.h

@@ -16 +16 @@
  */
 
 #ifndef INCLUDED_NETTURNMANAGER
 #define INCLUDED_NETTURNMANAGER
 
-#include "simulation2/helpers/SimulationCommand.h"
-#include "lib/os_path.h"
-#include "NetMessage.h"
-
-#include <list>
-#include <map>
-#include <vector>
-
-extern const u32 DEFAULT_TURN_LENGTH_MP;
-extern const u32 DEFAULT_TURN_LENGTH_SP;
+#include "network/NetMessage.h"
+#include "simulation2/system/TurnManager.h"
 
 class CNetServerWorker;
 class CNetClient;
-class CSimulationMessage;
-class CSimulation2;
-class IReplayLogger;
-
-/*
- * This file deals with the logic of the network turn system. The basic idea is as in
- * http://www.gamasutra.com/view/feature/3094/1500_archers_on_a_288_network_.php?print=1
- *
- * Each player performs the simulation for turn N.
- * User input is translated into commands scheduled for execution in turn N+2 which are
- * distributed to all other clients.
- * After a while, a player wants to perform the simulation for turn N+1,
- * which first requires that it has all the other clients' commands for turn N+1.
- * In that case, it does the simulation and tells all the other clients (via the server)
- * it has finished sending commands for turn N+2, and it starts sending commands for turn N+3.
- *
- * Commands are redistributed immediately by the server.
- * To ensure a consistent execution of commands, they are each associated with a
- * client session ID (which is globally unique and consistent), which is used to sort them.
- */
-
-/**
- * Common network turn system (used by clients and offline games).
- */
-class CNetTurnManager
-{
-    NONCOPYABLE(CNetTurnManager);
-public:
-    /**
-     * Construct for a given network session ID.
-     */
-    CNetTurnManager(CSimulation2& simulation, u32 defaultTurnLength, int clientId, IReplayLogger& replay);
-
-    virtual ~CNetTurnManager() { }
-
-    void ResetState(u32 newCurrentTurn, u32 newReadyTurn);
-
-    /**
-     * Set the current user's player ID, which will be added into command messages.
-     */
-    void SetPlayerID(int playerId);
-
-    /**
-     * Advance the simulation by a certain time. If this brings us past the current
-     * turn length, the next turns are processed and the function returns true.
-     * Otherwise, nothing happens and it returns false.
-     *
-     * @param simFrameLength Length of the previous frame, in simulation seconds
-     * @param maxTurns Maximum number of turns to simulate at once
-     */
-    bool Update(float simFrameLength, size_t maxTurns);
-
-    /**
-     * Advance the simulation by as much as possible. Intended for catching up
-     * over a small number of turns when rejoining a multiplayer match.
-     * Returns true if it advanced by at least one turn.
-     */
-    bool UpdateFastForward();
-
-    /**
-     * Returns whether Update(simFrameLength, ...) will process at least one new turn.
-     * @param simFrameLength Length of the previous frame, in simulation seconds
-     */
-    bool WillUpdate(float simFrameLength);
-
-    /**
-     * Advance the graphics by a certain time.
-     * @param simFrameLength Length of the previous frame, in simulation seconds
-     * @param realFrameLength Length of the previous frame, in real time seconds
-     */
-    void Interpolate(float simFrameLength, float realFrameLength);
-
-    /**
-     * Called by networking code when a simulation message is received.
-     */
-    virtual void OnSimulationMessage(CSimulationMessage* msg) = 0;
-
-    /**
-     * Called when there has been an out-of-sync error.
-     */
-    virtual void OnSyncError(u32 turn, const CStr& expectedHash, std::vector<CSyncErrorMessage::S_m_PlayerNames>& playerNames);
-
-    /**
-     * Shows a message box when an out of sync error has been detected in the session or visual replay.
-     */
-    virtual void DisplayOOSError(u32 turn, const CStr& hash, const CStr& expectedHash, bool isReplay, std::vector<CSyncErrorMessage::S_m_PlayerNames>* playerNames, OsPath* path);
-
-    /**
-     * Called by simulation code, to add a new command to be distributed to all clients and executed soon.
-     */
-    virtual void PostCommand(JS::HandleValue data) = 0;
-
-    /**
-     * Called when all commands for a given turn have been received.
-     * This allows Update to progress to that turn.
-     */
-    void FinishedAllCommands(u32 turn, u32 turnLength);
-
-    /**
-     * Enables the recording of state snapshots every @p numTurns,
-     * which can be jumped back to via RewindTimeWarp().
-     * If @p numTurns is 0 then recording is disabled.
-     */
-    void EnableTimeWarpRecording(size_t numTurns);
-
-    /**
-     * Jumps back to the latest recorded state snapshot (if any).
-     */
-    void RewindTimeWarp();
-
-    void QuickSave();
-    void QuickLoad();
-
-    u32 GetCurrentTurn() { return m_CurrentTurn; }
-
-protected:
-    /**
-     * Store a command to be executed at a given turn.
-     */
-    void AddCommand(int client, int player, JS::HandleValue data, u32 turn);
-
-    /**
-     * Called when this client has finished sending all its commands scheduled for the given turn.
-     */
-    virtual void NotifyFinishedOwnCommands(u32 turn) = 0;
-
-    /**
-     * Called when this client has finished a simulation update.
-     */
-    virtual void NotifyFinishedUpdate(u32 turn) = 0;
-
-    /**
-     * Returns whether we should compute a complete state hash for the given turn,
-     * instead of a quick less-complete hash.
-     */
-    bool TurnNeedsFullHash(u32 turn);
-
-    CSimulation2& m_Simulation2;
-
-    /// The turn that we have most recently executed
-    u32 m_CurrentTurn;
-
-    /// The latest turn for which we have received all commands from all clients
-    u32 m_ReadyTurn;
-
-    // Current turn length
-    u32 m_TurnLength;
-
-    /// Commands queued at each turn (index 0 is for m_CurrentTurn+1)
-    std::deque<std::map<u32, std::vector<SimulationCommand>>> m_QueuedCommands;
-
-    int m_PlayerId;
-    uint m_ClientId;
-
-    /// Simulation time remaining until we ought to execute the next turn (as a negative value to
-    /// add elapsed time increments to until we reach 0).
-    float m_DeltaSimTime;
-
-    bool m_HasSyncError;
-
-    IReplayLogger& m_Replay;
-
-    // The number of the last turn that is allowed to be executed (used for replays)
-    u32 m_FinalTurn;
-
-private:
-    size_t m_TimeWarpNumTurns; // 0 if disabled
-    std::list<std::string> m_TimeWarpStates;
-    std::string m_QuickSaveState; // TODO: should implement a proper disk-based quicksave system
-    std::string m_QuickSaveMetadata;
-};
-
 
 /**
- * Implementation of CNetTurnManager for network clients.
+ * Implementation of CTurnManager for network clients.
  */
-class CNetClientTurnManager : public CNetTurnManager
+class CNetClientTurnManager : public CTurnManager
 {
 public:
     CNetClientTurnManager(CSimulation2& simulation, CNetClient& client, int clientId, IReplayLogger& replay);
 
     virtual void OnSimulationMessage(CSimulationMessage* msg);
 
     virtual void PostCommand(JS::HandleValue data);
 
     /**
-     * Notifiy the server that all commands are sent to prepare the connection for termination.
+     * Notify the server that all commands are sent to prepare the connection for termination.
      */
     void OnDestroyConnection();
 
+    void OnSyncError(u32 turn, const CStr& expectedHash, const std::vector<CSyncErrorMessage::S_m_PlayerNames>& playerNames);
+
 protected:
     virtual void NotifyFinishedOwnCommands(u32 turn);
 
     virtual void NotifyFinishedUpdate(u32 turn);
 
     CNetClient& m_NetClient;
 };
 
 /**
- * Implementation of CNetTurnManager for offline games.
- */
-class CNetLocalTurnManager : public CNetTurnManager
-{
-public:
-    CNetLocalTurnManager(CSimulation2& simulation, IReplayLogger& replay);
-
-    virtual void OnSimulationMessage(CSimulationMessage* msg);
-
-    virtual void PostCommand(JS::HandleValue data);
-
-protected:
-    virtual void NotifyFinishedOwnCommands(u32 turn);
-
-    virtual void NotifyFinishedUpdate(u32 turn);
-};
-
-
-
-/**
- * Implementation of CNetTurnManager for replay games.
- */
-class CNetReplayTurnManager : public CNetLocalTurnManager
-{
-public:
-    CNetReplayTurnManager(CSimulation2& simulation, IReplayLogger& replay);
-
-    void StoreReplayCommand(u32 turn, int player, const std::string& command);
-
-    void StoreReplayTurnLength(u32 turn, u32 turnLength);
-
-    void StoreReplayHash(u32 turn, const std::string& hash, bool quick);
-
-    void StoreFinalReplayTurn(u32 turn);
-
-
-protected:
-    virtual void NotifyFinishedUpdate(u32 turn);
-
-    void DoTurn(u32 turn);
-
-    // Contains the commands of every player on each turn
-    std::map<u32, std::vector<std::pair<player_id_t, std::string>>> m_ReplayCommands;
-
-    // Contains the length of every turn
-    std::map<u32, u32> m_ReplayTurnLengths;
-
-    // Contains all replay hash values and weather or not the quick hash method was used
-    std::map<u32, std::pair<std::string, bool>> m_ReplayHash;
-};
-/**
  * The server-side counterpart to CNetClientTurnManager.
  * Records the turn state of each client, and sends turn advancement messages
  * when all clients are ready.
  *
  * Thread-safety:

source/network/tests/test_Net.h

@@ -21 +21 @@
 #include "lib/external_libraries/enet.h"
 #include "lib/external_libraries/libsdl.h"
 #include "lib/tex/tex.h"
 #include "network/NetServer.h"
 #include "network/NetClient.h"
-#include "network/NetTurnManager.h"
 #include "network/NetMessage.h"
 #include "network/NetMessages.h"
 #include "ps/CLogger.h"
 #include "ps/Game.h"
 #include "ps/Filesystem.h"
 #include "ps/Loader.h"
 #include "ps/XML/Xeromyces.h"
 #include "scriptinterface/ScriptInterface.h"
 #include "simulation2/Simulation2.h"
+#include "simulation2/system/TurnManager.h"
 
 class TestNetComms : public CxxTest::TestSuite
 {
 public:
     void setUp()
@@ -137 +137 @@
         // and prints a load of debug output so you can see if anything funny's going on
 
         ScriptInterface scriptInterface("Engine", "Test", g_ScriptRuntime);
         JSContext* cx = scriptInterface.GetContext();
         JSAutoRequest rq(cx);
-        
+
         TestStdoutLogger logger;
 
         std::vector<CNetClient*> clients;
 
         CGame client1Game(true);
@@ -202 +202 @@
     void test_rejoin_DISABLED()
     {
         ScriptInterface scriptInterface("Engine", "Test", g_ScriptRuntime);
         JSContext* cx = scriptInterface.GetContext();
         JSAutoRequest rq(cx);
-        
+
         TestStdoutLogger logger;
 
         std::vector<CNetClient*> clients;
 
         CGame client1Game(true);
@@ -308 +308 @@
         client1Game.GetTurnManager()->Update(1.0f, 1);
         client3Game.GetTurnManager()->Update(1.0f, 1);
         wait(clients, 100);
 
         // (This SetTurnLength thing doesn't actually detect errors unless you change
-        // CNetTurnManager::TurnNeedsFullHash to always return true)
+        // CTurnManager::TurnNeedsFullHash to always return true)
 
         {
             JS::RootedValue cmd(cx);
             client1.GetScriptInterface().Eval("({type:'debug-print', message:'[>>> client1 test sim command 3]\\n'})", &cmd);
             client1Game.GetTurnManager()->PostCommand(cmd);

source/ps/Game.cpp

@@ -27 +27 @@
 #include "gui/CGUI.h"
 #include "lib/config2.h"
 #include "lib/timer.h"
 #include "network/NetClient.h"
 #include "network/NetServer.h"
-#include "network/NetTurnManager.h"
 #include "ps/CConsole.h"
 #include "ps/CLogger.h"
 #include "ps/CStr.h"
 #include "ps/Loader.h"
 #include "ps/LoaderThunks.h"
@@ -45 +44 @@
 #include "renderer/WaterManager.h"
 #include "scriptinterface/ScriptInterface.h"
 #include "simulation2/Simulation2.h"
 #include "simulation2/components/ICmpPlayer.h"
 #include "simulation2/components/ICmpPlayerManager.h"
+#include "simulation2/system/TurnManager.h"
 #include "soundmanager/ISoundManager.h"
 
 #include "tools/atlas/GameInterface/GameLoop.h"
 
 extern bool g_GameRestarted;
@@ -85 +85 @@
     // Need to set the CObjectManager references after various objects have
     // been initialised, so do it here rather than via the initialisers above.
     if (m_GameView)
         m_World->GetUnitManager().SetObjectManager(m_GameView->GetObjectManager());
 
-    m_TurnManager = new CNetLocalTurnManager(*m_Simulation2, GetReplayLogger()); // this will get replaced if we're a net server/client
+    m_TurnManager = new CLocalTurnManager(*m_Simulation2, GetReplayLogger()); // this will get replaced if we're a net server/client
 
     m_Simulation2->LoadDefaultScripts();
 }
 
 /**
@@ -108 +108 @@
     delete m_World;
     delete m_ReplayLogger;
     delete m_ReplayStream;
 }
 
-void CGame::SetTurnManager(CNetTurnManager* turnManager)
+void CGame::SetTurnManager(CTurnManager* turnManager)
 {
     if (m_TurnManager)
         delete m_TurnManager;
 
     m_TurnManager = turnManager;
@@ -125 +125 @@
 {
     ENSURE(m_IsVisualReplay);
     ENSURE(!m_ReplayPath.empty());
     ENSURE(m_ReplayStream);
 
-    CNetReplayTurnManager* replayTurnMgr = static_cast<CNetReplayTurnManager*>(GetTurnManager());
+    CReplayTurnManager* replayTurnMgr = static_cast<CReplayTurnManager*>(GetTurnManager());
 
     u32 currentTurn = 0;
     std::string type;
     while ((*m_ReplayStream >> type).good())
     {
@@ -173 +173 @@
     debug_printf("Starting to replay %s\n", replayPath.c_str());
 
     m_IsVisualReplay = true;
     ScriptInterface& scriptInterface = m_Simulation2->GetScriptInterface();
 
-    SetTurnManager(new CNetReplayTurnManager(*m_Simulation2, GetReplayLogger()));
+    SetTurnManager(new CReplayTurnManager(*m_Simulation2, GetReplayLogger()));
 
     m_ReplayPath = replayPath;
     m_ReplayStream = new std::ifstream(m_ReplayPath.c_str());
 
     std::string type;
@@ -200 +200 @@
 void CGame::RegisterInit(const JS::HandleValue attribs, const std::string& savedState)
 {
     ScriptInterface& scriptInterface = m_Simulation2->GetScriptInterface();
     JSContext* cx = scriptInterface.GetContext();
     JSAutoRequest rq(cx);
-    
+
     m_InitialSavedState = savedState;
     m_IsSavedGame = !savedState.empty();
 
     m_Simulation2->SetInitAttributes(attribs);
 
@@ -286 +286 @@
  **/
 PSRETURN CGame::ReallyStartGame()
 {
     JSContext* cx = m_Simulation2->GetScriptInterface().GetContext();
     JSAutoRequest rq(cx);
-    
+
     // Call the script function InitGame only for new games, not saved games
     if (!m_IsSavedGame)
     {
-        // Perform some simulation initializations (replace skirmish entities, explore territories, etc.) 
+        // Perform some simulation initializations (replace skirmish entities, explore territories, etc.)
         // that needs to be done before setting up the AI and shouldn't be done in Atlas
         if (!g_AtlasGameLoop->running)
             m_Simulation2->PreInitGame();
 
         JS::RootedValue settings(cx);
@@ -308 +308 @@
     // and we could end up rendering before having set up any models (so they'd
     // all be invisible)
     Interpolate(0, 0);
 
     m_GameStarted=true;
-    
+
     // Render a frame to begin loading assets
     if (CRenderer::IsInitialised())
         Render();
 
     if (g_NetClient)
@@ -378 +378 @@
 {
     if (m_Paused || !m_TurnManager)
         return;
 
     const double deltaSimTime = deltaRealTime * m_SimRate;
-    
+
     if (deltaSimTime)
     {
         // To avoid confusing the profiler, we need to trigger the new turn
         // while we're not nested inside any PROFILE blocks
         if (m_TurnManager->WillUpdate(deltaSimTime))

source/ps/Game.h

@@ -25 +25 @@
 #include "simulation2/helpers/Player.h"
 
 class CWorld;
 class CSimulation2;
 class CGameView;
-class CNetTurnManager;
+class CTurnManager;
 class IReplayLogger;
 struct CColor;
 
 /**
  * The container that holds the rules, resources and attributes of the game.
@@ -75 +75 @@
     /**
      * Differs from m_PlayerID if a defeated player or observer views another player.
      */
     player_id_t m_ViewedPlayerID;
 
-    CNetTurnManager* m_TurnManager;
+    CTurnManager* m_TurnManager;
 
 public:
     CGame(bool disableGraphics = false, bool replayLog = true);
     ~CGame();
 
@@ -183 +183 @@
 
     /**
      * Replace the current turn manager.
      * This class will take ownership of the pointer.
      */
-    void SetTurnManager(CNetTurnManager* turnManager);
+    void SetTurnManager(CTurnManager* turnManager);
 
-    CNetTurnManager* GetTurnManager() const
+    CTurnManager* GetTurnManager() const
     {   return m_TurnManager; }
 
     IReplayLogger& GetReplayLogger() const
     {   return *m_ReplayLogger; }
 

source/simulation2/components/CCmpCommandQueue.cpp

@@ -1 @@
-/* Copyright (C) 2010 Wildfire Games.
+/* Copyright (C) 2016 Wildfire Games.
  * This file is part of 0 A.D.
  *
  * 0 A.D. 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, either version 2 of the License, or
@@ -21 +21 @@
 #include "ICmpCommandQueue.h"
 
 #include "ps/CLogger.h"
 #include "ps/Game.h"
 #include "ps/Profile.h"
-#include "network/NetTurnManager.h"
+#include "simulation2/system/TurnManager.h"
 
 class CCmpCommandQueue : public ICmpCommandQueue
 {
 public:
     static void ClassInit(CComponentManager& UNUSED(componentManager))
@@ -64 +64 @@
 
     virtual void Deserialize(const CParamNode& UNUSED(paramNode), IDeserializer& deserialize)
     {
         JSContext* cx = GetSimContext().GetScriptInterface().GetContext();
         JSAutoRequest rq(cx);
-    
+
         u32 numCmds;
         deserialize.NumberU32_Unbounded("num commands", numCmds);
         for (size_t i = 0; i < numCmds; ++i)
         {
             i32 player;
@@ -87 +87 @@
 
     virtual void PostNetworkCommand(JS::HandleValue cmd1)
     {
         JSContext* cx = GetSimContext().GetScriptInterface().GetContext();
         JSAutoRequest rq(cx);
-        
+
         // TODO: This is a workaround because we need to pass a MutableHandle to StringifyJSON.
         JS::RootedValue cmd(cx, cmd1.get());
 
         PROFILE2_EVENT("post net command");
         PROFILE2_ATTR("command: %s", GetSimContext().GetScriptInterface().StringifyJSON(&cmd, false).c_str());
@@ -104 +104 @@
     virtual void FlushTurn(const std::vector<SimulationCommand>& commands)
     {
         ScriptInterface& scriptInterface = GetSimContext().GetScriptInterface();
         JSContext* cx = scriptInterface.GetContext();
         JSAutoRequest rq(cx);
-        
+
         JS::RootedValue global(cx, scriptInterface.GetGlobalObject());
         std::vector<SimulationCommand> localCommands;
         m_LocalQueue.swap(localCommands);
 
         for (size_t i = 0; i < localCommands.size(); ++i)

source/simulation2/system/TurnManager.cpp

@@ +1 @@
+/* Copyright (C) 2016 Wildfire Games.
+ * This file is part of 0 A.D.
+ *
+ * 0 A.D. 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, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * 0 A.D. 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 for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "precompiled.h"
+
+#include "TurnManager.h"
+
+#include "gui/GUIManager.h"
+#include "maths/MathUtil.h"
+#include "ps/CLogger.h"
+#include "ps/Profile.h"
+#include "ps/Pyrogenesis.h"
+#include "ps/Replay.h"
+#include "simulation2/Simulation2.h"
+
+#include <sstream>
+#include <fstream>
+#include <iomanip>
+
+const u32 DEFAULT_TURN_LENGTH_MP = 500;
+const u32 DEFAULT_TURN_LENGTH_SP = 200;
+const int COMMAND_DELAY = 2;
+
+#if 0
+#define TURN_LOG(args) debug_printf args
+#else
+#define TURN_LOG(args)
+#endif
+
+static std::string Hexify(const std::string& s)
+{
+    std::stringstream str;
+    str << std::hex;
+    for (size_t i = 0; i < s.size(); ++i)
+        str << std::setfill('0') << std::setw(2) << (int)(unsigned char)s[i];
+    return str.str();
+}
+
+CTurnManager::CTurnManager(CSimulation2& simulation, u32 defaultTurnLength, int clientId, IReplayLogger& replay) :
+    m_Simulation2(simulation), m_CurrentTurn(0), m_ReadyTurn(1), m_TurnLength(defaultTurnLength), m_DeltaSimTime(0),
+    m_PlayerId(-1), m_ClientId(clientId), m_HasSyncError(false), m_Replay(replay),
+    m_TimeWarpNumTurns(0), m_FinalTurn(std::numeric_limits<u32>::max())
+{
+    // When we are on turn n, we schedule new commands for n+2.
+    // We know that all other clients have finished scheduling commands for n (else we couldn't have got here).
+    // We know we have not yet finished scheduling commands for n+2.
+    // Hence other clients can be on turn n-1, n, n+1, and no other.
+    // So they can be sending us commands scheduled for n+1, n+2, n+3.
+    // So we need a 3-element buffer:
+    m_QueuedCommands.resize(COMMAND_DELAY + 1);
+}
+
+void CTurnManager::ResetState(u32 newCurrentTurn, u32 newReadyTurn)
+{
+    m_CurrentTurn = newCurrentTurn;
+    m_ReadyTurn = newReadyTurn;
+    m_DeltaSimTime = 0;
+    size_t queuedCommandsSize = m_QueuedCommands.size();
+    m_QueuedCommands.clear();
+    m_QueuedCommands.resize(queuedCommandsSize);
+}
+
+void CTurnManager::SetPlayerID(int playerId)
+{
+    m_PlayerId = playerId;
+}
+
+bool CTurnManager::WillUpdate(float simFrameLength)
+{
+    // Keep this in sync with the return value of Update()
+
+    if (m_CurrentTurn > m_FinalTurn)
+        return false;
+
+    if (m_DeltaSimTime + simFrameLength < 0)
+        return false;
+
+    if (m_ReadyTurn <= m_CurrentTurn)
+        return false;
+
+    return true;
+}
+
+bool CTurnManager::Update(float simFrameLength, size_t maxTurns)
+{
+    if (m_CurrentTurn > m_FinalTurn)
+        return false;
+
+    m_DeltaSimTime += simFrameLength;
+
+    // If the game becomes laggy, m_DeltaSimTime increases progressively.
+    // The engine will fast forward accordingly to catch up.
+    // To keep the game playable, stop fast forwarding after 2 turn lengths.
+    m_DeltaSimTime = std::min(m_DeltaSimTime, 2.0f * m_TurnLength / 1000.0f);
+
+    // If we haven't reached the next turn yet, do nothing
+    if (m_DeltaSimTime < 0)
+        return false;
+
+    TURN_LOG((L"Update current=%d ready=%d\n", m_CurrentTurn, m_ReadyTurn));
+
+    // Check that the next turn is ready for execution
+    if (m_ReadyTurn <= m_CurrentTurn)
+    {
+        // Oops, we wanted to start the next turn but it's not ready yet -
+        // there must be too much network lag.
+        // TODO: complain to the user.
+        // TODO: send feedback to the server to increase the turn length.
+
+        // Reset the next-turn timer to 0 so we try again next update but
+        // so we don't rush to catch up in subsequent turns.
+        // TODO: we should do clever rate adjustment instead of just pausing like this.
+        m_DeltaSimTime = 0;
+
+        return false;
+    }
+
+    maxTurns = std::max((size_t)1, maxTurns); // always do at least one turn
+
+    for (size_t i = 0; i < maxTurns; ++i)
+    {
+        // Check that we've reached the i'th next turn
+        if (m_DeltaSimTime < 0)
+            break;
+
+        // Check that the i'th next turn is still ready
+        if (m_ReadyTurn <= m_CurrentTurn)
+            break;
+
+        NotifyFinishedOwnCommands(m_CurrentTurn + COMMAND_DELAY);
+
+        // Increase now, so Update can send new commands for a subsequent turn
+        ++m_CurrentTurn;
+
+        // Clean up any destroyed entities since the last turn (e.g. placement previews
+        // or rally point flags generated by the GUI). (Must do this before the time warp
+        // serialization.)
+        m_Simulation2.FlushDestroyedEntities();
+
+        // Save the current state for rewinding, if enabled
+        if (m_TimeWarpNumTurns && (m_CurrentTurn % m_TimeWarpNumTurns) == 0)
+        {
+            PROFILE3("time warp serialization");
+            std::stringstream stream;
+            m_Simulation2.SerializeState(stream);
+            m_TimeWarpStates.push_back(stream.str());
+        }
+
+        // Put all the client commands into a single list, in a globally consistent order
+        std::vector<SimulationCommand> commands;
+        for (std::pair<const u32, std::vector<SimulationCommand>>& p : m_QueuedCommands[0])
+            commands.insert(commands.end(), std::make_move_iterator(p.second.begin()), std::make_move_iterator(p.second.end()));
+
+        m_QueuedCommands.pop_front();
+        m_QueuedCommands.resize(m_QueuedCommands.size() + 1);
+
+        m_Replay.Turn(m_CurrentTurn-1, m_TurnLength, commands);
+
+        TURN_LOG((L"Running %d cmds\n", commands.size()));
+
+        m_Simulation2.Update(m_TurnLength, commands);
+
+        NotifyFinishedUpdate(m_CurrentTurn);
+
+        // Set the time for the next turn update
+        m_DeltaSimTime -= m_TurnLength / 1000.f;
+    }
+
+    return true;
+}
+
+bool CTurnManager::UpdateFastForward()
+{
+    m_DeltaSimTime = 0;
+
+    TURN_LOG((L"UpdateFastForward current=%d ready=%d\n", m_CurrentTurn, m_ReadyTurn));
+
+    // Check that the next turn is ready for execution
+    if (m_ReadyTurn <= m_CurrentTurn)
+        return false;
+
+    while (m_ReadyTurn > m_CurrentTurn)
+    {
+        // TODO: It would be nice to remove some of the duplication with Update()
+        // (This is similar but doesn't call any Notify functions or update DeltaTime,
+        // it just updates the simulation state)
+
+        ++m_CurrentTurn;
+
+        m_Simulation2.FlushDestroyedEntities();
+
+        // Put all the client commands into a single list, in a globally consistent order
+        std::vector<SimulationCommand> commands;
+        for (std::pair<const u32, std::vector<SimulationCommand>>& p : m_QueuedCommands[0])
+            commands.insert(commands.end(), std::make_move_iterator(p.second.begin()), std::make_move_iterator(p.second.end()));
+
+        m_QueuedCommands.pop_front();
+        m_QueuedCommands.resize(m_QueuedCommands.size() + 1);
+
+        m_Replay.Turn(m_CurrentTurn-1, m_TurnLength, commands);
+
+        TURN_LOG((L"Running %d cmds\n", commands.size()));
+
+        m_Simulation2.Update(m_TurnLength, commands);
+    }
+
+    return true;
+}
+
+void CTurnManager::Interpolate(float simFrameLength, float realFrameLength)
+{
+    // TODO: using m_TurnLength might be a bit dodgy when length changes - maybe
+    // we need to save the previous turn length?
+
+    float offset = clamp(m_DeltaSimTime / (m_TurnLength / 1000.f) + 1.0, 0.0, 1.0);
+
+    // Stop animations while still updating the selection highlight
+    if (m_CurrentTurn > m_FinalTurn)
+        simFrameLength = 0;
+
+    m_Simulation2.Interpolate(simFrameLength, offset, realFrameLength);
+}
+
+void CTurnManager::AddCommand(int client, int player, JS::HandleValue data, u32 turn)
+{
+    TURN_LOG((L"AddCommand(client=%d player=%d turn=%d)\n", client, player, turn));
+
+    if (!(m_CurrentTurn < turn && turn <= m_CurrentTurn + COMMAND_DELAY + 1))
+    {
+        debug_warn(L"Received command for invalid turn");
+        return;
+    }
+
+    m_Simulation2.GetScriptInterface().FreezeObject(data, true);
+    m_QueuedCommands[turn - (m_CurrentTurn+1)][client].emplace_back(player, m_Simulation2.GetScriptInterface().GetContext(), data);
+}
+
+void CTurnManager::FinishedAllCommands(u32 turn, u32 turnLength)
+{
+    TURN_LOG((L"FinishedAllCommands(%d, %d)\n", turn, turnLength));
+
+    ENSURE(turn == m_ReadyTurn + 1);
+    m_ReadyTurn = turn;
+    m_TurnLength = turnLength;
+}
+
+bool CTurnManager::TurnNeedsFullHash(u32 turn)
+{
+    // Check immediately for errors caused by e.g. inconsistent game versions
+    // (The hash is computed after the first sim update, so we start at turn == 1)
+    if (turn == 1)
+        return true;
+
+    // Otherwise check the full state every ~10 seconds in multiplayer games
+    // (TODO: should probably remove this when we're reasonably sure the game
+    // isn't too buggy, since the full hash is still pretty slow)
+    if (turn % 20 == 0)
+        return true;
+
+    return false;
+}
+
+void CTurnManager::EnableTimeWarpRecording(size_t numTurns)
+{
+    m_TimeWarpStates.clear();
+    m_TimeWarpNumTurns = numTurns;
+}
+
+void CTurnManager::RewindTimeWarp()
+{
+    if (m_TimeWarpStates.empty())
+        return;
+
+    std::stringstream stream(m_TimeWarpStates.back());
+    m_Simulation2.DeserializeState(stream);
+    m_TimeWarpStates.pop_back();
+
+    // Reset the turn manager state, so we won't execute stray commands and
+    // won't do the next snapshot until the appropriate time.
+    // (Ideally we ought to serialise the turn manager state and restore it
+    // here, but this is simpler for now.)
+    ResetState(0, 1);
+}
+
+void CTurnManager::QuickSave()
+{
+    TIMER(L"QuickSave");
+
+    std::stringstream stream;
+    if (!m_Simulation2.SerializeState(stream))
+    {
+        LOGERROR("Failed to quicksave game");
+        return;
+    }
+
+    m_QuickSaveState = stream.str();
+    if (g_GUI)
+        m_QuickSaveMetadata = g_GUI->GetSavedGameData();
+    else
+        m_QuickSaveMetadata = std::string();
+
+    LOGMESSAGERENDER("Quicksaved game");
+
+}
+
+void CTurnManager::QuickLoad()
+{
+    TIMER(L"QuickLoad");
+
+    if (m_QuickSaveState.empty())
+    {
+        LOGERROR("Cannot quickload game - no game was quicksaved");
+        return;
+    }
+
+    std::stringstream stream(m_QuickSaveState);
+    if (!m_Simulation2.DeserializeState(stream))
+    {
+        LOGERROR("Failed to quickload game");
+        return;
+    }
+
+    if (g_GUI && !m_QuickSaveMetadata.empty())
+        g_GUI->RestoreSavedGameData(m_QuickSaveMetadata);
+
+    LOGMESSAGERENDER("Quickloaded game");
+
+    // See RewindTimeWarp
+    ResetState(0, 1);
+}
+
+CLocalTurnManager::CLocalTurnManager(CSimulation2& simulation, IReplayLogger& replay) :
+    CTurnManager(simulation, DEFAULT_TURN_LENGTH_SP, 0, replay)
+{
+}
+
+void CLocalTurnManager::PostCommand(JS::HandleValue data)
+{
+    // Add directly to the next turn, ignoring COMMAND_DELAY,
+    // because we don't need to compensate for network latency
+    AddCommand(m_ClientId, m_PlayerId, data, m_CurrentTurn + 1);
+}
+
+void CLocalTurnManager::NotifyFinishedOwnCommands(u32 turn)
+{
+    FinishedAllCommands(turn, m_TurnLength);
+}
+
+void CLocalTurnManager::NotifyFinishedUpdate(u32 UNUSED(turn))
+{
+#if 0 // this hurts performance and is only useful for verifying log replays
+    std::string hash;
+    {
+        PROFILE3("state hash check");
+        ENSURE(m_Simulation2.ComputeStateHash(hash));
+    }
+    m_Replay.Hash(hash);
+#endif
+}
+
+void CLocalTurnManager::OnSimulationMessage(CSimulationMessage* UNUSED(msg))
+{
+    debug_warn(L"This should never be called");
+}
+
+CReplayTurnManager::CReplayTurnManager(CSimulation2& simulation, IReplayLogger& replay) :
+    CLocalTurnManager(simulation, replay)
+{
+}
+
+void CReplayTurnManager::StoreReplayCommand(u32 turn, int player, const std::string& command)
+{
+    // Using the pair we make sure that commands per turn will be processed in the correct order
+    m_ReplayCommands[turn].emplace_back(player, command);
+}
+
+void CReplayTurnManager::StoreReplayHash(u32 turn, const std::string& hash, bool quick)
+{
+    m_ReplayHash[turn] = std::make_pair(hash, quick);
+}
+
+void CReplayTurnManager::StoreReplayTurnLength(u32 turn, u32 turnLength)
+{
+    m_ReplayTurnLengths[turn] = turnLength;
+
+    // Initialize turn length
+    if (turn == 0)
+        m_TurnLength = m_ReplayTurnLengths[0];
+}
+
+void CReplayTurnManager::StoreFinalReplayTurn(u32 turn)
+{
+    m_FinalTurn = turn;
+}
+
+void CReplayTurnManager::OnSyncError(u32 turn)
+{
+    m_HasSyncError = true;
+
+    std::stringstream msg;
+    msg << "Out of sync on turn " << turn << "\n\n" << "The current game state is different from the original game state.";
+
+    LOGERROR("%s", msg.str());
+
+    if (g_GUI)
+        g_GUI->DisplayMessageBox(600, 350, L"Sync error", wstring_from_utf8(msg.str()));
+}
+
+void CReplayTurnManager::NotifyFinishedUpdate(u32 turn)
+{
+    if (turn == 1 && m_FinalTurn == 0)
+        g_GUI->SendEventToAll("ReplayFinished");
+
+    if (turn > m_FinalTurn)
+        return;
+
+    DoTurn(turn);
+
+    // Compare hash if it exists in the replay and if we didn't have an OOS already
+    if (m_HasSyncError || m_ReplayHash.find(turn) == m_ReplayHash.end())
+        return;
+
+    std::string expectedHash = m_ReplayHash[turn].first;
+    bool quickHash = m_ReplayHash[turn].second;
+
+    // Compute hash
+    std::string hash;
+    ENSURE(m_Simulation2.ComputeStateHash(hash, quickHash));
+    hash = Hexify(hash);
+
+    if (hash != expectedHash)
+        OnSyncError(turn);
+}
+
+void CReplayTurnManager::DoTurn(u32 turn)
+{
+    debug_printf("Executing turn %u of %u\n", turn, m_FinalTurn);
+
+    m_TurnLength = m_ReplayTurnLengths[turn];
+
+    // Simulate commands for that turn
+    for (const std::pair<player_id_t, std::string>& p : m_ReplayCommands[turn])
+    {
+        JS::RootedValue command(m_Simulation2.GetScriptInterface().GetContext());
+        m_Simulation2.GetScriptInterface().ParseJSON(p.second, &command);
+        AddCommand(m_ClientId, p.first, command, m_CurrentTurn + 1);
+    }
+
+    if (turn == m_FinalTurn)
+        g_GUI->SendEventToAll("ReplayFinished");
+}

source/simulation2/system/TurnManager.h

@@ +1 @@
+/* Copyright (C) 2016 Wildfire Games.
+ * This file is part of 0 A.D.
+ *
+ * 0 A.D. 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, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * 0 A.D. 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 for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef INCLUDED_TURNMANAGER
+#define INCLUDED_TURNMANAGER
+
+#include "ps/CStr.h"
+#include "simulation2/helpers/SimulationCommand.h"
+
+#include <list>
+#include <map>
+#include <vector>
+
+extern const u32 DEFAULT_TURN_LENGTH_MP;
+extern const u32 DEFAULT_TURN_LENGTH_SP;
+extern const int COMMAND_DELAY;
+
+class CSimulationMessage;
+class CSimulation2;
+class IReplayLogger;
+
+/*
+ * This file deals with the logic of the turn system. The basic idea is as in
+ * http://www.gamasutra.com/view/feature/3094/1500_archers_on_a_288_network_.php?print=1
+ *
+ * Each player performs the simulation for turn N.
+ * User input is translated into commands scheduled for execution in turn N+2 which are
+ * distributed to all other clients.
+ * After a while, a player wants to perform the simulation for turn N+1,
+ * which first requires that it has all the other clients' commands for turn N+1.
+ * In that case, it does the simulation and tells all the other clients (via the server)
+ * it has finished sending commands for turn N+2, and it starts sending commands for turn N+3.
+ *
+ * Commands are redistributed immediately by the server.
+ * To ensure a consistent execution of commands, they are each associated with a
+ * client session ID (which is globally unique and consistent), which is used to sort them.
+ */
+
+/**
+ * Common turn system (used by clients and offline games).
+ */
+class CTurnManager
+{
+    NONCOPYABLE(CTurnManager);
+public:
+    /**
+     * Construct for a given session ID.
+     */
+    CTurnManager(CSimulation2& simulation, u32 defaultTurnLength, int clientId, IReplayLogger& replay);
+
+    virtual ~CTurnManager() { }
+
+    void ResetState(u32 newCurrentTurn, u32 newReadyTurn);
+
+    /**
+     * Set the current user's player ID, which will be added into command messages.
+     */
+    void SetPlayerID(int playerId);
+
+    /**
+     * Advance the simulation by a certain time. If this brings us past the current
+     * turn length, the next turns are processed and the function returns true.
+     * Otherwise, nothing happens and it returns false.
+     *
+     * @param simFrameLength Length of the previous frame, in simulation seconds
+     * @param maxTurns Maximum number of turns to simulate at once
+     */
+    bool Update(float simFrameLength, size_t maxTurns);
+
+    /**
+     * Advance the simulation by as much as possible. Intended for catching up
+     * over a small number of turns when rejoining a multiplayer match.
+     * Returns true if it advanced by at least one turn.
+     */
+    bool UpdateFastForward();
+
+    /**
+     * Returns whether Update(simFrameLength, ...) will process at least one new turn.
+     * @param simFrameLength Length of the previous frame, in simulation seconds
+     */
+    bool WillUpdate(float simFrameLength);
+
+    /**
+     * Advance the graphics by a certain time.
+     * @param simFrameLength Length of the previous frame, in simulation seconds
+     * @param realFrameLength Length of the previous frame, in real time seconds
+     */
+    void Interpolate(float simFrameLength, float realFrameLength);
+
+    /**
+     * Called when a simulation message is received.
+     */
+    virtual void OnSimulationMessage(CSimulationMessage* msg) = 0;
+
+    /**
+     * Called by simulation code, to add a new command to be distributed to all clients and executed soon.
+     */
+    virtual void PostCommand(JS::HandleValue data) = 0;
+
+    /**
+     * Called when all commands for a given turn have been received.
+     * This allows Update to progress to that turn.
+     */
+    void FinishedAllCommands(u32 turn, u32 turnLength);
+
+    /**
+     * Enables the recording of state snapshots every @p numTurns,
+     * which can be jumped back to via RewindTimeWarp().
+     * If @p numTurns is 0 then recording is disabled.
+     */
+    void EnableTimeWarpRecording(size_t numTurns);
+
+    /**
+     * Jumps back to the latest recorded state snapshot (if any).
+     */
+    void RewindTimeWarp();
+
+    void QuickSave();
+    void QuickLoad();
+
+    u32 GetCurrentTurn() { return m_CurrentTurn; }
+
+protected:
+    /**
+     * Store a command to be executed at a given turn.
+     */
+    void AddCommand(int client, int player, JS::HandleValue data, u32 turn);
+
+    /**
+     * Called when this client has finished sending all its commands scheduled for the given turn.
+     */
+    virtual void NotifyFinishedOwnCommands(u32 turn) = 0;
+
+    /**
+     * Called when this client has finished a simulation update.
+     */
+    virtual void NotifyFinishedUpdate(u32 turn) = 0;
+
+    /**
+     * Returns whether we should compute a complete state hash for the given turn,
+     * instead of a quick less-complete hash.
+     */
+    bool TurnNeedsFullHash(u32 turn);
+
+    CSimulation2& m_Simulation2;
+
+    /// The turn that we have most recently executed
+    u32 m_CurrentTurn;
+
+    /// The latest turn for which we have received all commands from all clients
+    u32 m_ReadyTurn;
+
+    // Current turn length
+    u32 m_TurnLength;
+
+    /// Commands queued at each turn (index 0 is for m_CurrentTurn+1)
+    std::deque<std::map<u32, std::vector<SimulationCommand>>> m_QueuedCommands;
+
+    int m_PlayerId;
+    uint m_ClientId;
+
+    /// Simulation time remaining until we ought to execute the next turn (as a negative value to
+    /// add elapsed time increments to until we reach 0).
+    float m_DeltaSimTime;
+
+    bool m_HasSyncError;
+
+    IReplayLogger& m_Replay;
+
+    // The number of the last turn that is allowed to be executed (used for replays)
+    u32 m_FinalTurn;
+
+private:
+    size_t m_TimeWarpNumTurns; // 0 if disabled
+    std::list<std::string> m_TimeWarpStates;
+    std::string m_QuickSaveState; // TODO: should implement a proper disk-based quicksave system
+    std::string m_QuickSaveMetadata;
+};
+
+/**
+ * Implementation of CTurnManager for offline games.
+ */
+class CLocalTurnManager : public CTurnManager
+{
+public:
+    CLocalTurnManager(CSimulation2& simulation, IReplayLogger& replay);
+
+    virtual void OnSimulationMessage(CSimulationMessage* msg);
+
+    virtual void PostCommand(JS::HandleValue data);
+
+protected:
+    virtual void NotifyFinishedOwnCommands(u32 turn);
+
+    virtual void NotifyFinishedUpdate(u32 turn);
+};
+
+/**
+ * Implementation of CTurnManager for replay games.
+ */
+class CReplayTurnManager : public CLocalTurnManager
+{
+public:
+    CReplayTurnManager(CSimulation2& simulation, IReplayLogger& replay);
+
+    void StoreReplayCommand(u32 turn, int player, const std::string& command);
+
+    void StoreReplayTurnLength(u32 turn, u32 turnLength);
+
+    void StoreReplayHash(u32 turn, const std::string& hash, bool quick);
+
+    void StoreFinalReplayTurn(u32 turn);
+
+    void OnSyncError(u32 turn);
+
+protected:
+    virtual void NotifyFinishedUpdate(u32 turn);
+
+    void DoTurn(u32 turn);
+
+    // Contains the commands of every player on each turn
+    std::map<u32, std::vector<std::pair<player_id_t, std::string>>> m_ReplayCommands;
+
+    // Contains the length of every turn
+    std::map<u32, u32> m_ReplayTurnLengths;
+
+    // Contains all replay hash values and weather or not the quick hash method was used
+    std::map<u32, std::pair<std::string, bool>> m_ReplayHash;
+};
+
+#endif // INCLUDED_TURNMANAGER