cachecheck.cpp

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * OpenTTD 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, version 2.
 * OpenTTD 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 OpenTTD. If not, see <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
 */

 
#include "stdafx.h"
#include "aircraft.h"
#include "company_base.h"
#include "debug.h"
#include "industry.h"
#include "roadstop_base.h"
#include "roadveh.h"
#include "ship.h"
#include "station_base.h"
#include "station_map.h"
#include "subsidy_func.h"
#include "town.h"
#include "train.h"
#include "vehicle_base.h"
 
#include "safeguards.h"
 
extern void AfterLoadCompanyStats();
extern void RebuildTownCaches();

void CheckCaches()
{
  /* Return here so it is easy to add checks that are run
   * always to aid testing of caches. */
  if (!IsVisibleSeverity(Facility::Desync, Severity::Warning)) return;
 
  /* Check the town caches. */
  std::vector<TownCache> old_town_caches;
  for (const Town *t : Town::Iterate()) {
    old_town_caches.push_back(t->cache);
  }
 
  RebuildTownCaches();
  RebuildSubsidisedSourceAndDestinationCache();
 
  uint i = 0;
  for (Town *t : Town::Iterate()) {
    if (old_town_caches[i] != t->cache) {
      Debug(Facility::Desync, Severity::Warning, "warning: town cache mismatch: town {}", t->index);
    }
    i++;
  }
 
  /* Check company infrastructure cache. */
  std::vector<CompanyInfrastructure> old_infrastructure;
  for (const Company *c : Company::Iterate()) old_infrastructure.push_back(c->infrastructure);
 
  AfterLoadCompanyStats();
 
  i = 0;
  for (const Company *c : Company::Iterate()) {
    if (old_infrastructure[i] != c->infrastructure) {
      Debug(Facility::Desync, Severity::Warning, "warning: infrastructure cache mismatch: company {}", c->index);
    }
    i++;
  }
 
  /* Strict checking of the road stop cache entries */
  for (const RoadStop *rs : RoadStop::Iterate()) {
    if (IsBayRoadStopTile(rs->xy)) continue;
 
    rs->GetEntry(DiagDirection::NE).CheckIntegrity(rs);
    rs->GetEntry(DiagDirection::NW).CheckIntegrity(rs);
  }
 
  std::vector<NewGRFCache> grf_cache;
  std::vector<VehicleCache> veh_cache;
  std::vector<GroundVehicleCache> gro_cache;
  std::vector<TrainCache> tra_cache;
 
  for (Vehicle *v : Vehicle::Iterate()) {
    if (v != v->First() || v->vehstatus.Test(VehState::Crashed) || !v->IsPrimaryVehicle()) continue;
 
    for (const Vehicle *u = v; u != nullptr; u = u->Next()) {
      FillNewGRFVehicleCache(u);
      grf_cache.emplace_back(u->grf_cache);
      veh_cache.emplace_back(u->vcache);
      switch (u->type) {
        case VehicleType::Train:
          gro_cache.emplace_back(Train::From(u)->gcache);
          tra_cache.emplace_back(Train::From(u)->tcache);
          break;
        case VehicleType::Road:
          gro_cache.emplace_back(RoadVehicle::From(u)->gcache);
          break;
        default:
          break;
      }
    }
 
    switch (v->type) {
      case VehicleType::Train: Train::From(v)->ConsistChanged(CCF_TRACK); break;
      case VehicleType::Road: RoadVehUpdateCache(RoadVehicle::From(v)); break;
      case VehicleType::Aircraft: UpdateAircraftCache(Aircraft::From(v)); break;
      case VehicleType::Ship: Ship::From(v)->UpdateCache(); break;
      default: break;
    }
 
    uint length = 0;
    for (const Vehicle *u = v; u != nullptr; u = u->Next()) {
      FillNewGRFVehicleCache(u);
      if (grf_cache[length] != u->grf_cache) {
        Debug(Facility::Desync, Severity::Warning, "warning: newgrf cache mismatch: type {}, vehicle {}, company {}, unit number {}, wagon {}", v->type, v->index, v->owner, v->unitnumber, length);
      }
      if (veh_cache[length] != u->vcache) {
        Debug(Facility::Desync, Severity::Warning, "warning: vehicle cache mismatch: type {}, vehicle {}, company {}, unit number {}, wagon {}", v->type, v->index, v->owner, v->unitnumber, length);
      }
      switch (u->type) {
        case VehicleType::Train:
          if (gro_cache[length] != Train::From(u)->gcache) {
            Debug(Facility::Desync, Severity::Warning, "warning: train ground vehicle cache mismatch: vehicle {}, company {}, unit number {}, wagon {}", v->index, v->owner, v->unitnumber, length);
          }
          if (tra_cache[length] != Train::From(u)->tcache) {
            Debug(Facility::Desync, Severity::Warning, "warning: train cache mismatch: vehicle {}, company {}, unit number {}, wagon {}", v->index, v->owner, v->unitnumber, length);
          }
          break;
        case VehicleType::Road:
          if (gro_cache[length] != RoadVehicle::From(u)->gcache) {
            Debug(Facility::Desync, Severity::Warning, "warning: road vehicle ground vehicle cache mismatch: vehicle {}, company {}, unit number {}, wagon {}", v->index, v->owner, v->unitnumber, length);
          }
          break;
        default:
          break;
      }
      length++;
    }
 
    grf_cache.clear();
    veh_cache.clear();
    gro_cache.clear();
    tra_cache.clear();
  }
 
  /* Check whether the caches are still valid */
  for (Vehicle *v : Vehicle::Iterate()) {
    [[maybe_unused]] const auto a = v->cargo.PeriodsInTransit();
    [[maybe_unused]] const auto b = v->cargo.TotalCount();
    [[maybe_unused]] const auto c = v->cargo.GetFeederShare();
    v->cargo.InvalidateCache();
    assert(a == v->cargo.PeriodsInTransit());
    assert(b == v->cargo.TotalCount());
    assert(c == v->cargo.GetFeederShare());
  }
 
  /* Backup stations_near */
  std::vector<StationList> old_town_stations_near;
  for (Town *t : Town::Iterate()) old_town_stations_near.push_back(t->stations_near);
 
  std::vector<StationList> old_industry_stations_near;
  for (Industry *ind : Industry::Iterate()) old_industry_stations_near.push_back(ind->stations_near);
 
  std::vector<IndustryList> old_station_industries_near;
  for (Station *st : Station::Iterate()) old_station_industries_near.push_back(st->industries_near);
 
  for (Station *st : Station::Iterate()) {
    for (GoodsEntry &ge : st->goods) {
      if (!ge.HasData()) continue;
 
      StationCargoList &cargo_list = ge.GetData().cargo;
      [[maybe_unused]] const auto a = cargo_list.PeriodsInTransit();
      [[maybe_unused]] const auto b = cargo_list.TotalCount();
      cargo_list.InvalidateCache();
      assert(a == cargo_list.PeriodsInTransit());
      assert(b == cargo_list.TotalCount());
    }
 
    /* Check docking tiles */
    TileArea ta;
    std::map<TileIndex, bool> docking_tiles;
    for (TileIndex tile : st->docking_station) {
      ta.Add(tile);
      docking_tiles[tile] = IsDockingTile(tile);
    }
    UpdateStationDockingTiles(st);
    if (ta.tile != st->docking_station.tile || ta.w != st->docking_station.w || ta.h != st->docking_station.h) {
      Debug(Facility::Desync, Severity::Warning, "warning: station docking mismatch: station {}, company {}", st->index, st->owner);
    }
    for (TileIndex tile : ta) {
      if (docking_tiles[tile] != IsDockingTile(tile)) {
        Debug(Facility::Desync, Severity::Warning, "warning: docking tile mismatch: tile {}", tile);
      }
    }
  }
 
  Station::RecomputeCatchmentForAll();
 
  /* Check industries_near */
  i = 0;
  for (Station *st : Station::Iterate()) {
    if (st->industries_near != old_station_industries_near[i]) {
      Debug(Facility::Desync, Severity::Warning, "warning: station industries near mismatch: station {}", st->index);
    }
    i++;
  }
 
  /* Check stations_near */
  i = 0;
  for (Town *t : Town::Iterate()) {
    if (t->stations_near != old_town_stations_near[i]) {
      Debug(Facility::Desync, Severity::Warning, "warning: town stations near mismatch: town {}", t->index);
    }
    i++;
  }
  i = 0;
  for (Industry *ind : Industry::Iterate()) {
    if (ind->stations_near != old_industry_stations_near[i]) {
      Debug(Facility::Desync, Severity::Warning, "warning: industry stations near mismatch: industry {}", ind->index);
    }
    i++;
  }
 
  /* Check the last vehicle cache. */
  for (Vehicle *v : Vehicle::Iterate()) {
    if (v != v->First() || v->vehstatus.Test(VehState::Crashed) || !v->IsPrimaryVehicle()) continue;
 
    /* Check that the last vehicle is actually last. */
    if (v->Last()->Next() != nullptr) {
      Debug(Facility::Desync, Severity::Warning, "warning: vehicle cache mismatch, last vehicle must not have a next vehicle: type {}, vehicle {}, company {}, unit number {}, invalid 'Last()'", v->type, v->index, v->owner, v->unitnumber);
    }
 
    /* Ensure that all vehicles in the chain have the same last vehicle. */
    for (Vehicle *u = v; u != nullptr; u = u->Next()) {
      if (u->Last() != v->Last()) {
        Debug(Facility::Desync, Severity::Warning, "warning: vehicle cache mismatch, all vehicles in chain must have same last vehicle: type {}, vehicle {}, company {}, unit number {}, invalid 'Last()'", v->type, v->index, v->owner, v->unitnumber);
      }
    }
  }
}