cpp/openttd-patchpack/source Changeset - r27981:3b49f5f0f9b4

Changeset - r27981:3b49f5f0f9b4

Parent rev.

Child rev.

[Not reviewed]

master

0 3 0

Peter Nelson - 14 months ago 2023-10-03 11:14:32
peter1138@openttd.org

Fix: Check for engine variant loops during NewGRF initialization. (#11343)

Invalid NewGRFs could set up an engine variant loop that never ends. This
was checked for in some places that evaluated variants, but not all. In
most cases this would result in the engines not appearing, but could
potentially cause an infinite loop and crash.

Instead, during NewGRF initialization detect loops and remove invalid
variants before setting display flags.

3 files changed with 30 insertions and 12 deletions:

src/build_vehicle_gui.cpp

src/engine.cpp

src/newgrf.cpp

0 comments (0 inline, 0 general)

src/build_vehicle_gui.cpp

➞

Show inline comments

@@ @@ -1422,7 +1422,7 @@ struct BuildVehicleWindow : Window { @@
 			list.emplace_back(eid, e->info.variant_id, e->display_flags, 0);
 			if (rvi->railveh_type != RAILVEH_WAGON) num_engines++;
-			if (e->info.variant_id != eid && e->info.variant_id != INVALID_ENGINE) variants.push_back(e->info.variant_id);
 			if (e->info.variant_id != INVALID_ENGINE) variants.push_back(e->info.variant_id);
 			if (eid == this->sel_engine) sel_id = eid;
+		}
@@ @@ -1654,13 +1654,14 @@ struct BuildVehicleWindow : Window { @@
 						Command<CMD_BUILD_VEHICLE>::Post(GetCmdBuildVehMsg(this->vehicle_type), CcBuildPrimaryVehicle, this->window_number, sel_eng, true, cargo, INVALID_CLIENT_ID);
+					}
 					/* Update last used variant and refresh if necessary. */
+					/* Update last used variant in hierarchy and refresh if necessary. */
 					bool refresh = false;
 					int recursion = 10; /* In case of infinite loop */
 					for (Engine *e = Engine::Get(sel_eng); recursion > 0; e = Engine::Get(e->info.variant_id), --recursion) {
 					EngineID parent = sel_eng;
 					while (parent != INVALID_ENGINE) {
 						Engine *e = Engine::Get(parent);
 						refresh |= (e->display_last_variant != sel_eng);
 						e->display_last_variant = sel_eng;
-						if (e->info.variant_id == INVALID_ENGINE) break;
+						parent = e->info.variant_id;
+					}
 					if (refresh) {
 						InvalidateWindowData(WC_REPLACE_VEHICLE, this->vehicle_type, 0); // Update the autoreplace window

src/engine.cpp

➞

Show inline comments

@@ @@ -491,7 +491,7 @@ bool Engine::IsVariantHidden(CompanyID c @@
 	 * the last display variant rather than the actual parent variant. */
 	const Engine *re = this;
 	const Engine *ve = re->GetDisplayVariant();
-	while (!(ve->IsHidden(c)) && re->info.variant_id != INVALID_ENGINE && re->info.variant_id != re->index) {
 	while (!(ve->IsHidden(c)) && re->info.variant_id != INVALID_ENGINE) {
 		re = Engine::Get(re->info.variant_id);
 		ve = re->GetDisplayVariant();
+	}
@@ @@ -607,7 +607,7 @@ void CalcEngineReliability(Engine *e, bo @@
+{
 	/* Get source engine for reliability age. This is normally our engine unless variant reliability syncing is requested. */
 	Engine *re = e;
-	while (re->info.variant_id != INVALID_ENGINE && re->info.variant_id != re->index && (re->info.extra_flags & ExtraEngineFlags::SyncReliability) != ExtraEngineFlags::None) {
 	while (re->info.variant_id != INVALID_ENGINE && (re->info.extra_flags & ExtraEngineFlags::SyncReliability) != ExtraEngineFlags::None) {
 		re = Engine::Get(re->info.variant_id);
+	}
@@ @@ -706,7 +706,7 @@ void StartupOneEngine(Engine *e, TimerGa @@
 	/* Get parent variant index for syncing reliability via random seed. */
 	const Engine *re = e;
-	while (re->info.variant_id != INVALID_ENGINE && re->info.variant_id != re->index && (re->info.extra_flags & ExtraEngineFlags::SyncReliability) != ExtraEngineFlags::None) {
 	while (re->info.variant_id != INVALID_ENGINE && (re->info.extra_flags & ExtraEngineFlags::SyncReliability) != ExtraEngineFlags::None) {
 		re = Engine::Get(re->info.variant_id);
+	}

src/newgrf.cpp

➞

Show inline comments

@@ @@ -9125,12 +9125,9 @@ static void FinaliseEngineArray() @@
+			}
+		}
-		/* Do final mapping on variant engine ID and set appropriate flags on variant engine */
+		/* Do final mapping on variant engine ID. */
 		if (e->info.variant_id != INVALID_ENGINE) {
 			e->info.variant_id = GetNewEngineID(e->grf_prop.grffile, e->type, e->info.variant_id);
 			if (e->info.variant_id != INVALID_ENGINE) {
 				Engine::Get(e->info.variant_id)->display_flags |= EngineDisplayFlags::HasVariants | EngineDisplayFlags::IsFolded;
+			}
+		}
 		if (!HasBit(e->info.climates, _settings_game.game_creation.landscape)) continue;
@@ @@ -9162,6 +9159,26 @@ static void FinaliseEngineArray() @@
+			}
+		}
+	}
 	/* Check engine variants don't point back on themselves (either directly or via a loop) then set appropriate flags
 	 * on variant engine. This is performed separately as all variant engines need to have been resolved. */
 	for (Engine *e : Engine::Iterate()) {
 		EngineID parent = e->info.variant_id;
 		while (parent != INVALID_ENGINE) {
 			parent = Engine::Get(parent)->info.variant_id;
 			if (parent != e->index) continue;
 			/* Engine looped back on itself, so clear the variant. */
 			e->info.variant_id = INVALID_ENGINE;
 			GrfMsg(1, "FinaliseEngineArray: Variant of engine {:x} in '{}' loops back on itself", _engine_mngr[e->index].internal_id, e->GetGRF()->filename);
 			break;
+		}
 		if (e->info.variant_id != INVALID_ENGINE) {
 			Engine::Get(e->info.variant_id)->display_flags |= EngineDisplayFlags::HasVariants | EngineDisplayFlags::IsFolded;
+		}
+	}
+}
 /** Check for invalid cargoes */

0 comments (0 inline, 0 general)