Merge pull request #1969 from ZombieFreak115/proper-network-preload

Fix lockstep multiplayer save loading, reloading and oos recovery

Author: schombert

assets/alice.gui

@@ -4616,6 +4616,17 @@ guiTypes = {
 		position = { x= 148 y = 3 }
 		quadTextureSprite = "GFX_take_province"	
 	}
+
+	instantTextBoxType = {
+			name = "ready_state"
+			extends = "ingame_multiplayer_entry"
+			position = { x=160 y =2}
+			borderSize = { 0 0}
+			maxsize = { 50 32 }
+			textureFile = ""
+			font = "vic_18_black"
+		}
+
 	guiButtonType = {
 			name = "button_ban"
 			extends = "ingame_multiplayer_entry"
@@ -4625,6 +4636,16 @@ guiTypes = {
 			delayedTooltipText = ""
 			position = { x=228 y =2}
 		}
+
+		guiButtonType = {
+			name = "resync_button"
+			extends = "ingame_lobby_window"
+			quadTextureSprite = "GFX_alice_event_auto"
+			position = { x=535 y =314}
+		}
+
+
+
     guiButtonType = {
 		name = "alice_budget_warning"
 		extends = "topbar"

assets/localisation/en-US/alice.csv

@@ -1035,6 +1035,7 @@ tech_year_tt;?G$x$?! from the current year
 disband_all;Disband all selected units
 alice_play_checksum_host;Checksum mismatch with host, ensure you have the same mods and savefiles
 alice_play_save_stream;Host is streaming a save to you, wait until it completes
+alice_no_start_game_player_loading;Cannot start the game while players are loading
 ai_will_accept_po;They will accept this offer
 ai_will_not_accept_po;They will NOT accept this offer
 close_and_del;Close & Delete Factory
@@ -1186,6 +1187,7 @@ explain_colonial_points;Secondary and Great Powers accumulate colonial points.
 alice_lobby_back;Back to lobby
 alice_lobby_back_tt_1;You're already in the fucking lobby
 alice_lobby_back_tt_2;Only the host may go back to lobby
+alice_lobby_back_player_loading;You may not go back to the lobby while players are loading
 reopen_with_tab;You can reopen this window with ?YTAB?W
 alice_topbar_tab_1;Open or close this tab
 alice_topbar_tab_2;Open or close the population tab
@@ -1532,3 +1534,9 @@ pop_migration_attraction_wage_ratio;And the wage difference multipler: $x$
 pop_migration_attraction_bureaucracy;Bureaucracy base attraction: $x$
 alice_toggle_administration;Establish or abolish local administration. Administrations outside your control will not work. Consult administrative map mode to check existing administrations.
 alice_unit_target;===> $x$
+alice_lobby_resync;Resync lobby
+alice_lobby_resync_players_loading;Cannot resync when players are loading
+alice_lobby_resync_no_oos;No one is OOS
+alice_lobby_resync_not_host;Only the host may resync
+alice_host_has_resync;Host has resynced the lobby
+

docs/multiplayer_technical.md

@@ -20,24 +20,34 @@ The standard C++ and C library provide `sin`, `cos`, and `acos` functions for pe
 
 ### Notification commands
 
-`notify_player_joins` - Tells the clients that a player has joined, marks the `source` nation as player-controlled.
+`notify_player_joins` - Tells the clients that a player has joined, marks the `source` nation as player-controlled. When a player joins, all other players in the lobby (including the host) will fully reset, then reload their gamestate. Currently this is done so that there is no "lingering" data left behind after reloading their own state. This is to futureproof it against even minor mistakes/changes in contributions which can easily breka sync if state is not fully reset first.
 `notify_player_pick_nation` - Picks a nation, this is useful for example on the lobby where players are switching nations constantly, IF the `source` is invalid (i.e a `dcon::nation_id{}`) then it refers to the current local player nation of the client, this is useful to set the "temporal nation" on the lobby so that clients can be identified by their nation automatically assigned by the server. Otherwise the `source` is the client who requested to pick a nation `target` in `data.nation_pick.target`.
-`notify_save_loaded` - Updates the session checksum, used to check discrepancies between clients and hosts that could hinder gameplay and throw it into an invalid state. Following it comes an `uint32_t` describing the size of the save stream, and the save stream itself!
+`notify_save_loaded` - Updates the session checksum, used to check discrepancies between clients and hosts that could hinder gameplay and throw it into an invalid state. Following it comes an `uint32_t` describing the size of the save stream, and the save stream itself! Keep in mind that the client will automatically reload their state first before loading the save
 `notify_player_kick` - When kicking a player, it is disconnected, but allowed to rejoin.
 `notify_player_ban` - When banning a player, it is disconnected, and not allowed to rejoin.
 `notify_start_game` - Host has started the game, all players connected will be sent into the game.
 `notify_stop_game` - Host has stopped the game (not paused), all players connected will be sent into the lobby.
 `notify_pause_game` - Host has paused the game, exists mainly to notify clients that the host has paused the game.
 `notify_reload` - Perform a game state reload as if it was a savefile.
+`notify_player_is_loading` - Sent by the host to (usually) all of the clients to notify that `source` is currently loading. The host will NOT process most commands while more than 0 clients are loading. This command may be sent to the loading client itself. The command is sent out after a reload or save stream is requested, or when a new player joins a lobby with a save.
+`notify_notify_player_fully_loaded` - Sent by the client to notify the host, and then re-broadcast to all clients that `source` has finished loading.
 
 The server will send new clients a `notify_player_joins` for each connected player. It will send a `notify_player_pick_nation` to the client, with an invalid source, telling it what is their "assigned nation".
 
 An assigned nation is a "random" nation that the server will hand out to the client so it can identifiably connect to the server as a nation, and perform commands as such nation.
 
+When a state-reset&reload is happening, it will block rendering updates in the meantime to prevent crashes or other oddities happening while the state is completly empty. This is also the case when the `notify_stop_game` or `notify_start_game` are executed, it will block rendering updates until the scene change has been executed.
+
 ### Save streams
 
 We send a copy of the save to the client, ultra-compressed, to permit it to connect without having to use external toolage, this is done for example when the host is loading a savefile - the client is given the new data of the savefile to keep them in sync.
 
+### Re-sync
+
+The lobby can be resyncronized if one or more players are OOS, and must be done manually by the host in the "tab" lobby screen.
+When a resync starts, it will send the notify_save_loaded command to the oos'd clients together with a save for them to load. The non-oos clients will receive a notify_reload command, and will reload their own save.
+
+
 ### Hot-join
 
 A new functionality is hotjoining to running sessions - the client may connect to the host and the host will assign them a random nation, if they wish to change their nation then they'll have to ask the host to go back to the lobby.

src/economy/demographics.cpp

@@ -193,22 +193,30 @@ void sum_over_demographics(sys::state& state, dcon::demographics_key key, F cons
 	// sum in province
 	state.world.for_each_pop([&](dcon::pop_id p) {
 		auto location = state.world.pop_get_province_from_pop_location(p);
-		state.world.province_get_demographics(location, key) += source(state, p);
+		auto current = state.world.province_get_demographics(location, key);
+		state.world.province_set_demographics(location, key, current + source(state, p));
 	});
 	// clear state
 	state.world.execute_serial_over_state_instance(
 			[&](auto si) { state.world.state_instance_set_demographics(si, key, ve::fp_vector()); });
 	// sum in state
 	province::for_each_land_province(state, [&](dcon::province_id p) {
 		auto location = state.world.province_get_state_membership(p);
-		state.world.state_instance_get_demographics(location, key) += state.world.province_get_demographics(p, key);
+		// check if province is uncolonized, as uncolonized provinces do not have valid state membership
+		if(location) {
+			state.world.state_instance_get_demographics(location, key) += state.world.province_get_demographics(p, key);
+		}
 	});
 	// clear nation
 	state.world.execute_serial_over_nation([&](auto ni) { state.world.nation_set_demographics(ni, key, ve::fp_vector()); });
 	// sum in nation
 	state.world.for_each_state_instance([&](dcon::state_instance_id s) {
 		auto location = state.world.state_instance_get_nation_from_state_ownership(s);
-		state.world.nation_get_demographics(location, key) += state.world.state_instance_get_demographics(s, key);
+		// check if state is not owned by a nation
+		if(location) {
+			state.world.nation_get_demographics(location, key) += state.world.state_instance_get_demographics(s, key);
+		}
+		
 	});
 }
 
@@ -219,22 +227,31 @@ void alt_sum_over_demographics(sys::state& state, dcon::demographics_key key, F
 	// sum in province
 	state.world.for_each_pop([&](dcon::pop_id p) {
 		auto location = state.world.pop_get_province_from_pop_location(p);
-		state.world.province_get_demographics_alt(location, key) += source(state, p);
+		auto current = state.world.province_get_demographics_alt(location, key);
+		state.world.province_set_demographics_alt(location, key, current + source(state, p));
 	});
 	// clear state
 	state.world.execute_serial_over_state_instance(
 			[&](auto si) { state.world.state_instance_set_demographics_alt(si, key, ve::fp_vector()); });
 	// sum in state
 	province::for_each_land_province(state, [&](dcon::province_id p) {
 		auto location = state.world.province_get_state_membership(p);
-		state.world.state_instance_get_demographics_alt(location, key) += state.world.province_get_demographics_alt(p, key);
+		// check if province is uncolonized, as uncolonized provinces do not have valid state membership
+		if(location) {
+			state.world.state_instance_get_demographics_alt(location, key) += state.world.province_get_demographics_alt(p, key);
+		}
+		
 	});
 	// clear nation
 	state.world.execute_serial_over_nation([&](auto ni) { state.world.nation_set_demographics_alt(ni, key, ve::fp_vector()); });
 	// sum in nation
 	state.world.for_each_state_instance([&](dcon::state_instance_id s) {
 		auto location = state.world.state_instance_get_nation_from_state_ownership(s);
-		state.world.nation_get_demographics_alt(location, key) += state.world.state_instance_get_demographics_alt(s, key);
+		// check if state is not owned by a nation
+		if(location) {
+			state.world.nation_get_demographics_alt(location, key) += state.world.state_instance_get_demographics_alt(s, key);
+		}
+		
 	});
 }
 

src/economy/economy.cpp

@@ -2540,7 +2540,7 @@ void daily_update(sys::state& state, bool presimulation, float presimulation_sta
 			break;
 		}
 	});
-
+		
 	populate_construction_consumption(state);
 
 	sanity_check(state);
@@ -2951,7 +2951,7 @@ void daily_update(sys::state& state, bool presimulation, float presimulation_sta
 				);
 			});
 		});
-	});
+			});
 
 	sanity_check(state);
 
@@ -3279,6 +3279,9 @@ void daily_update(sys::state& state, bool presimulation, float presimulation_sta
 
 	// STEP 4 national budget updates
 	for(auto n : state.nations_by_rank) {
+		if(!n) {
+			continue;
+		}
 		spent_on_construction_buffer.set(n, 0.f);
 
 		auto cap_prov = state.world.nation_get_capital(n);

src/economy/economy_stats.cpp

@@ -33,7 +33,8 @@ void register_demand(
 	economy_reason reason
 ) {
 	assert(amount >= 0.f);
-	state.world.market_get_demand(s, commodity_type) += amount;
+	auto current = state.world.market_get_demand(s, commodity_type);
+	state.world.market_set_demand(s, commodity_type, current + amount);
 	assert(std::isfinite(state.world.market_get_demand(s, commodity_type)));
 }
 
@@ -169,16 +170,20 @@ void register_intermediate_demand(
 	float amount,
 	economy_reason reason
 ) {
-	register_demand(state, s, c, amount, reason);
-	state.world.market_set_intermediate_demand(
-		s,
-		c,
-		state.world.market_get_intermediate_demand(s, c) + amount
-	);
-	auto local_price = price(state, s, c);
-	auto median_price = state.world.commodity_get_median_price(c);
-	auto sat = state.world.market_get_demand_satisfaction(s, c);
-	state.world.market_set_gdp(s, state.world.market_get_gdp(s) - amount * median_price * sat);
+	// check for market validity before writing data to it
+	if(s) {
+			register_demand(state, s, c, amount, reason);
+		state.world.market_set_intermediate_demand(
+			s,
+			c,
+			state.world.market_get_intermediate_demand(s, c) + amount
+		);
+		auto local_price = price(state, s, c);
+		auto median_price = state.world.commodity_get_median_price(c);
+		auto sat = state.world.market_get_demand_satisfaction(s, c);
+		state.world.market_set_gdp(s, state.world.market_get_gdp(s) - amount * median_price * sat);
+	}
+	
 }
 
 void register_domestic_supply(