OpenTTD Source: src/linkgraph/refresh.cpp Source File

OpenTTD Source 15.0-beta1

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