OpenTTD Source  20241108-master-g80f628063a
refresh.cpp
1 /*
2  * This file is part of OpenTTD.
3  * 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.
4  * 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.
5  * 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 <http://www.gnu.org/licenses/>.
6  */
7 
10 #include "../stdafx.h"
11 #include "../core/bitmath_func.hpp"
12 #include "../station_func.h"
13 #include "../engine_base.h"
14 #include "../vehicle_func.h"
15 #include "refresh.h"
16 #include "linkgraph.h"
17 
18 #include "../safeguards.h"
19 
26 /* static */ void LinkRefresher::Run(Vehicle *v, bool allow_merge, bool is_full_loading)
27 {
28  /* If there are no orders we can't predict anything.*/
29  if (v->orders == nullptr) return;
30 
31  /* Make sure the first order is a useful order. */
33  if (first == nullptr) return;
34 
35  HopSet seen_hops;
37 
38  refresher.RefreshLinks(first, first, v->last_loading_station != INVALID_STATION ? 1 << HAS_CARGO : 0);
39 }
40 
46 bool LinkRefresher::Hop::operator<(const Hop &other) const
47 {
48  if (this->from < other.from) {
49  return true;
50  } else if (this->from > other.from) {
51  return false;
52  }
53  if (this->to < other.to) {
54  return true;
55  } else if (this->to > other.to) {
56  return false;
57  }
58  return this->cargo < other.cargo;
59 }
60 
72 {
73  memset(this->capacities, 0, sizeof(this->capacities));
74 
75  /* Assemble list of capacities and set last loading stations to 0. */
76  for (Vehicle *v = this->vehicle; v != nullptr; v = v->Next()) {
77  this->refit_capacities.push_back(RefitDesc(v->cargo_type, v->cargo_cap, v->refit_cap));
78  if (v->refit_cap > 0) {
79  assert(v->cargo_type < NUM_CARGO);
80  this->capacities[v->cargo_type] += v->refit_cap;
81  }
82  }
83 }
84 
91 {
92  this->cargo = refit_cargo;
93  RefitList::iterator refit_it = this->refit_capacities.begin();
94  bool any_refit = false;
95  for (Vehicle *v = this->vehicle; v != nullptr; v = v->Next()) {
96  const Engine *e = Engine::Get(v->engine_type);
97  if (!HasBit(e->info.refit_mask, this->cargo)) {
98  ++refit_it;
99  continue;
100  }
101  any_refit = true;
102 
103  /* Back up the vehicle's cargo type */
104  CargoID temp_cid = v->cargo_type;
105  uint8_t temp_subtype = v->cargo_subtype;
106  v->cargo_type = this->cargo;
107  v->cargo_subtype = GetBestFittingSubType(v, v, this->cargo);
108 
109  uint16_t mail_capacity = 0;
110  uint amount = e->DetermineCapacity(v, &mail_capacity);
111 
112  /* Restore the original cargo type */
113  v->cargo_type = temp_cid;
114  v->cargo_subtype = temp_subtype;
115 
116  /* Skip on next refit. */
117  if (this->cargo != refit_it->cargo && refit_it->remaining > 0) {
118  this->capacities[refit_it->cargo] -= refit_it->remaining;
119  refit_it->remaining = 0;
120  } else if (amount < refit_it->remaining) {
121  this->capacities[refit_it->cargo] -= refit_it->remaining - amount;
122  refit_it->remaining = amount;
123  }
124  refit_it->capacity = amount;
125  refit_it->cargo = this->cargo;
126 
127  ++refit_it;
128 
129  /* Special case for aircraft with mail. */
130  if (v->type == VEH_AIRCRAFT) {
131  if (mail_capacity < refit_it->remaining) {
132  this->capacities[refit_it->cargo] -= refit_it->remaining - mail_capacity;
133  refit_it->remaining = mail_capacity;
134  }
135  refit_it->capacity = mail_capacity;
136  break; // aircraft have only one vehicle
137  }
138  }
139  return any_refit;
140 }
141 
146 {
147  for (auto &it : this->refit_capacities) {
148  if (it.remaining == it.capacity) continue;
149  this->capacities[it.cargo] += it.capacity - it.remaining;
150  it.remaining = it.capacity;
151  }
152 }
153 
163 const Order *LinkRefresher::PredictNextOrder(const Order *cur, const Order *next, uint8_t flags, uint num_hops)
164 {
165  /* next is good if it's either nullptr (then the caller will stop the
166  * evaluation) or if it's not conditional and the caller allows it to be
167  * chosen (by setting USE_NEXT). */
168  while (next != nullptr && (!HasBit(flags, USE_NEXT) || next->IsType(OT_CONDITIONAL))) {
169 
170  /* After the first step any further non-conditional order is good,
171  * regardless of previous USE_NEXT settings. The case of cur and next or
172  * their respective stations being equal is handled elsewhere. */
173  SetBit(flags, USE_NEXT);
174 
175  if (next->IsType(OT_CONDITIONAL)) {
176  const Order *skip_to = this->vehicle->orders->GetNextDecisionNode(
177  this->vehicle->orders->GetOrderAt(next->GetConditionSkipToOrder()), num_hops);
178  if (skip_to != nullptr && num_hops < this->vehicle->orders->GetNumOrders()) {
179  /* Make copies of capacity tracking lists. There is potential
180  * for optimization here: If the vehicle never refits we don't
181  * need to copy anything. Also, if we've seen the branched link
182  * before we don't need to branch at all. */
183  LinkRefresher branch(*this);
184  branch.RefreshLinks(cur, skip_to, flags, num_hops + 1);
185  }
186  }
187 
188  /* Reassign next with the following stop. This can be a station or a
189  * depot.*/
190  next = this->vehicle->orders->GetNextDecisionNode(
191  this->vehicle->orders->GetNext(next), num_hops++);
192  }
193  return next;
194 }
195 
201 void LinkRefresher::RefreshStats(const Order *cur, const Order *next)
202 {
203  StationID next_station = next->GetDestination();
205  if (st != nullptr && next_station != INVALID_STATION && next_station != st->index) {
206  Station *st_to = Station::Get(next_station);
207  for (CargoID c = 0; c < NUM_CARGO; c++) {
208  /* Refresh the link and give it a minimum capacity. */
209 
210  uint cargo_quantity = this->capacities[c];
211  if (cargo_quantity == 0) continue;
212 
213  if (this->vehicle->GetDisplayMaxSpeed() == 0) continue;
214 
215  /* If not allowed to merge link graphs, make sure the stations are
216  * already in the same link graph. */
217  if (!this->allow_merge && st->goods[c].link_graph != st_to->goods[c].link_graph) {
218  continue;
219  }
220 
221  /* A link is at least partly restricted if a vehicle can't load at its source. */
222  EdgeUpdateMode restricted_mode = (cur->GetLoadType() & OLFB_NO_LOAD) == 0 ?
224  /* This estimates the travel time of the link as the time needed
225  * to travel between the stations at half the max speed of the consist.
226  * The result is in tiles/tick (= 2048 km-ish/h). */
227  uint32_t time_estimate = DistanceManhattan(st->xy, st_to->xy) * 4096U / this->vehicle->GetDisplayMaxSpeed();
228 
229  /* If the vehicle is currently full loading, increase the capacities at the station
230  * where it is loading by an estimate of what it would have transported if it wasn't
231  * loading. Don't do that if the vehicle has been waiting for longer than the entire
232  * order list is supposed to take, though. If that is the case the total duration is
233  * probably far off and we'd greatly overestimate the capacity by increasing.*/
234  if (this->is_full_loading && this->vehicle->orders != nullptr &&
236  this->vehicle->orders->GetTotalDuration() > this->vehicle->current_order_time) {
237  uint effective_capacity = cargo_quantity * this->vehicle->load_unload_ticks;
238  if (effective_capacity > (uint)this->vehicle->orders->GetTotalDuration()) {
239  IncreaseStats(st, c, next_station, effective_capacity /
240  this->vehicle->orders->GetTotalDuration(), 0, 0,
241  EUM_INCREASE | restricted_mode);
242  } else if (RandomRange(this->vehicle->orders->GetTotalDuration()) < effective_capacity) {
243  IncreaseStats(st, c, next_station, 1, 0, 0, EUM_INCREASE | restricted_mode);
244  } else {
245  IncreaseStats(st, c, next_station, cargo_quantity, 0, time_estimate, EUM_REFRESH | restricted_mode);
246  }
247  } else {
248  IncreaseStats(st, c, next_station, cargo_quantity, 0, time_estimate, EUM_REFRESH | restricted_mode);
249  }
250  }
251  }
252 }
253 
265 void LinkRefresher::RefreshLinks(const Order *cur, const Order *next, uint8_t flags, uint num_hops)
266 {
267  while (next != nullptr) {
268 
269  if ((next->IsType(OT_GOTO_DEPOT) || next->IsType(OT_GOTO_STATION)) && next->IsRefit()) {
270  SetBit(flags, WAS_REFIT);
271  if (!next->IsAutoRefit()) {
272  this->HandleRefit(next->GetRefitCargo());
273  } else if (!HasBit(flags, IN_AUTOREFIT)) {
274  SetBit(flags, IN_AUTOREFIT);
275  LinkRefresher backup(*this);
276  for (CargoID c = 0; c != NUM_CARGO; ++c) {
277  if (CargoSpec::Get(c)->IsValid() && this->HandleRefit(c)) {
278  this->RefreshLinks(cur, next, flags, num_hops);
279  *this = backup;
280  }
281  }
282  }
283  }
284 
285  /* Only reset the refit capacities if the "previous" next is a station,
286  * meaning that either the vehicle was refit at the previous station or
287  * it wasn't at all refit during the current hop. */
288  if (HasBit(flags, WAS_REFIT) && (next->IsType(OT_GOTO_STATION) || next->IsType(OT_IMPLICIT))) {
289  SetBit(flags, RESET_REFIT);
290  } else {
291  ClrBit(flags, RESET_REFIT);
292  }
293 
294  next = this->PredictNextOrder(cur, next, flags, num_hops);
295  if (next == nullptr) break;
296  Hop hop(cur->index, next->index, this->cargo);
297  if (this->seen_hops->find(hop) != this->seen_hops->end()) {
298  break;
299  } else {
300  this->seen_hops->insert(hop);
301  }
302 
303  /* Don't use the same order again, but choose a new one in the next round. */
304  ClrBit(flags, USE_NEXT);
305 
306  /* Skip resetting and link refreshing if next order won't do anything with cargo. */
307  if (!next->IsType(OT_GOTO_STATION) && !next->IsType(OT_IMPLICIT)) continue;
308 
309  if (HasBit(flags, RESET_REFIT)) {
310  this->ResetRefit();
311  ClrBit(flags, RESET_REFIT);
312  ClrBit(flags, WAS_REFIT);
313  }
314 
315  if (cur->IsType(OT_GOTO_STATION) || cur->IsType(OT_IMPLICIT)) {
316  if (cur->CanLeaveWithCargo(HasBit(flags, HAS_CARGO))) {
317  SetBit(flags, HAS_CARGO);
318  this->RefreshStats(cur, next);
319  } else {
320  ClrBit(flags, HAS_CARGO);
321  }
322  }
323 
324  /* "cur" is only assigned here if the stop is a station so that
325  * whenever stats are to be increased two stations can be found. */
326  cur = next;
327  }
328 }
constexpr debug_inline bool HasBit(const T x, const uint8_t y)
Checks if a bit in a value is set.
constexpr T SetBit(T &x, const uint8_t y)
Set a bit in a variable.
constexpr T ClrBit(T &x, const uint8_t y)
Clears a bit in a variable.
uint8_t CargoID
Cargo slots to indicate a cargo type within a game.
Definition: cargo_type.h:22
static const CargoID NUM_CARGO
Maximum number of cargo types in a game.
Definition: cargo_type.h:74
Utility to refresh links a consist will visit.
Definition: refresh.h:19
bool allow_merge
If the refresher is allowed to merge or extend link graphs.
Definition: refresh.h:85
void ResetRefit()
Restore capacities and refit_capacities as vehicle might have been able to load now.
Definition: refresh.cpp:145
void RefreshLinks(const Order *cur, const Order *next, uint8_t flags, uint num_hops=0)
Iterate over orders starting at cur and next and refresh links associated with them.
Definition: refresh.cpp:265
@ HAS_CARGO
Consist could leave the last stop where it could interact with cargo carrying cargo (i....
Definition: refresh.h:30
@ RESET_REFIT
Consist had a chance to load since the last refit and the refit capacities can be reset.
Definition: refresh.h:32
@ WAS_REFIT
Consist was refit since the last stop where it could interact with cargo.
Definition: refresh.h:31
@ IN_AUTOREFIT
Currently doing an autorefit loop. Ignore the first autorefit order.
Definition: refresh.h:33
@ USE_NEXT
There was a conditional jump. Try to use the given next order when looking for a new one.
Definition: refresh.h:29
Vehicle * vehicle
Vehicle for which the links should be refreshed.
Definition: refresh.h:80
bool HandleRefit(CargoID refit_cargo)
Handle refit orders by updating capacities and refit_capacities.
Definition: refresh.cpp:90
const Order * PredictNextOrder(const Order *cur, const Order *next, uint8_t flags, uint num_hops=0)
Predict the next order the vehicle will execute and resolve conditionals by recursion and return next...
Definition: refresh.cpp:163
CargoID cargo
Cargo given in last refit order.
Definition: refresh.h:84
RefitList refit_capacities
Current state of capacity remaining from previous refits versus overall capacity per vehicle in the c...
Definition: refresh.h:82
LinkRefresher(Vehicle *v, HopSet *seen_hops, bool allow_merge, bool is_full_loading)
Constructor for link refreshing algorithm.
Definition: refresh.cpp:69
HopSet * seen_hops
Hops already seen. If the same hop is seen twice we stop the algorithm. This is shared between all Re...
Definition: refresh.h:83
uint capacities[NUM_CARGO]
Current added capacities per cargo ID in the consist.
Definition: refresh.h:81
bool is_full_loading
If the vehicle is full loading.
Definition: refresh.h:86
static void Run(Vehicle *v, bool allow_merge=true, bool is_full_loading=false)
Refresh all links the given vehicle will visit.
Definition: refresh.cpp:26
void RefreshStats(const Order *cur, const Order *next)
Refresh link stats for the given pair of orders.
Definition: refresh.cpp:201
Declaration of link graph classes used for cargo distribution.
EdgeUpdateMode
Special modes for updating links.
@ EUM_REFRESH
Refresh capacity.
@ EUM_INCREASE
Increase capacity.
@ EUM_RESTRICTED
Use restricted link.
@ EUM_UNRESTRICTED
Use unrestricted link.
uint DistanceManhattan(TileIndex t0, TileIndex t1)
Gets the Manhattan distance between the two given tiles.
Definition: map.cpp:146
@ OLFB_NO_LOAD
Do not load anything.
Definition: order_type.h:66
uint32_t RandomRange(uint32_t limit, const std::source_location location=std::source_location::current())
Pick a random number between 0 and limit - 1, inclusive.
Definition: random_func.hpp:88
Definition of link refreshing utility.
void IncreaseStats(Station *st, CargoID cargo, StationID next_station_id, uint capacity, uint usage, uint32_t time, EdgeUpdateMode mode)
Increase capacity for a link stat given by station cargo and next hop.
VehicleOrderID cur_implicit_order_index
The index to the current implicit order.
Definition: base_consist.h:32
TileIndex xy
Base tile of the station.
static CargoSpec * Get(size_t index)
Retrieve cargo details for the given cargo ID.
Definition: cargotype.h:134
uint DetermineCapacity(const Vehicle *v, uint16_t *mail_capacity=nullptr) const
Determines capacity of a given vehicle from scratch.
Definition: engine.cpp:201
LinkGraphID link_graph
Link graph this station belongs to.
Definition: station_base.h:215
A hop the refresh algorithm might evaluate.
Definition: refresh.h:56
OrderID from
Last order where vehicle could interact with cargo or absolute first order.
Definition: refresh.h:57
OrderID to
Next order to be processed.
Definition: refresh.h:58
CargoID cargo
Cargo the consist is probably carrying or INVALID_CARGO if unknown.
Definition: refresh.h:59
bool operator<(const Hop &other) const
Comparison operator to allow hops to be used in a std::set.
Definition: refresh.cpp:46
Simulated cargo type and capacity for prediction of future links.
Definition: refresh.h:39
const Order * GetNextDecisionNode(const Order *next, uint hops) const
Get the next order which will make the given vehicle stop at a station or refit at a depot or evaluat...
Definition: order_cmd.cpp:364
Order * GetOrderAt(int index) const
Get a certain order of the order chain.
Definition: order_cmd.cpp:341
const Order * GetNext(const Order *curr) const
Get the order after the given one or the first one, if the given one is the last one.
Definition: order_base.h:313
VehicleOrderID GetNumOrders() const
Get number of orders in the order list.
Definition: order_base.h:319
TimerGameTick::Ticks GetTotalDuration() const
Gets the known duration of the vehicles orders, timetabled or not.
Definition: order_base.h:380
CargoID GetRefitCargo() const
Get the cargo to to refit to.
Definition: order_base.h:131
DestinationID GetDestination() const
Gets the destination of this order.
Definition: order_base.h:103
bool IsType(OrderType type) const
Check whether this order is of the given type.
Definition: order_base.h:70
VehicleOrderID GetConditionSkipToOrder() const
Get the order to skip to.
Definition: order_base.h:152
OrderLoadFlags GetLoadType() const
How must the consist be loaded?
Definition: order_base.h:136
bool CanLeaveWithCargo(bool has_cargo) const
A vehicle can leave the current station with cargo if:
Definition: order_cmd.cpp:2249
bool IsAutoRefit() const
Is this order a auto-refit order.
Definition: order_base.h:124
bool IsRefit() const
Is this order a refit order.
Definition: order_base.h:117
Tindex index
Index of this pool item.
Definition: pool_type.hpp:238
static Titem * Get(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:339
static Station * GetIfValid(size_t index)
Returns station if the index is a valid index for this station type.
static Station * Get(size_t index)
Gets station with given index.
Station data structure.
Definition: station_base.h:439
GoodsEntry goods[NUM_CARGO]
Goods at this station.
Definition: station_base.h:468
Vehicle data structure.
Definition: vehicle_base.h:244
StationID last_loading_station
Last station the vehicle has stopped at and could possibly leave from with any cargo loaded.
Definition: vehicle_base.h:338
virtual int GetDisplayMaxSpeed() const
Gets the maximum speed in km-ish/h that can be sent into SetDParam for string processing.
Definition: vehicle_base.h:530
Order * GetOrder(int index) const
Returns order 'index' of a vehicle or nullptr when it doesn't exists.
Definition: vehicle_base.h:922
Vehicle * Next() const
Get the next vehicle of this vehicle.
Definition: vehicle_base.h:632
OrderList * orders
Pointer to the order list for this vehicle.
Definition: vehicle_base.h:359
uint16_t load_unload_ticks
Ticks to wait before starting next cycle.
Definition: vehicle_base.h:352
StationID last_station_visited
The last station we stopped at.
Definition: vehicle_base.h:337
uint8_t GetBestFittingSubType(Vehicle *v_from, Vehicle *v_for, CargoID dest_cargo_type)
Get the best fitting subtype when 'cloning'/'replacing' v_from with v_for.
@ VEH_AIRCRAFT
Aircraft vehicle type.
Definition: vehicle_type.h:27