From 07aa682124e17f843f4917ed67266961378d1619 Mon Sep 17 00:00:00 2001 From: mamoniot Date: Sun, 30 Apr 2023 15:23:46 -0400 Subject: [PATCH 1/3] added caching to SE --- cybersyn/changelog.txt | 5 ++ cybersyn/info.lua | 2 +- cybersyn/scripts/factorio-api.lua | 130 +++++++++++++++++++++--------- cybersyn/scripts/global.lua | 6 ++ cybersyn/scripts/migrations.lua | 2 + 5 files changed, 107 insertions(+), 38 deletions(-) diff --git a/cybersyn/changelog.txt b/cybersyn/changelog.txt index 4f1170c..9ee597c 100644 --- a/cybersyn/changelog.txt +++ b/cybersyn/changelog.txt @@ -1,4 +1,9 @@ --------------------------------------------------------------------------------------------------- +Version: 1.2.15 +Date: 2023-4-30 + Bugfixes: + - Fixed UPS spikes in Space Exploration related to expensive remote calls into their modding interface. +--------------------------------------------------------------------------------------------------- Version: 1.2.14 Date: 2023-4-30 Features: diff --git a/cybersyn/info.lua b/cybersyn/info.lua index 639a3a2..860f838 100644 --- a/cybersyn/info.lua +++ b/cybersyn/info.lua @@ -3,4 +3,4 @@ --- It is used in migrations.lua to determine if any migrations need to be run for beta testers. --- It is expected these are only meaningful between releases during beta testing. --- It should be set to nil for any release version. -return nil +return 1 diff --git a/cybersyn/scripts/factorio-api.lua b/cybersyn/scripts/factorio-api.lua index 1c060bc..7809154 100644 --- a/cybersyn/scripts/factorio-api.lua +++ b/cybersyn/scripts/factorio-api.lua @@ -33,19 +33,70 @@ function get_dist(entity0, entity1) end +---@param cache PerfCache ---@param surface LuaSurface -function se_get_space_elevator_name(surface) - --TODO: check how expensive the following is and potentially cache it's results - local entity = surface.find_entities_filtered({ - name = SE_ELEVATOR_STOP_PROTO_NAME, - type = "train-stop", - limit = 1, - })[1] - if entity and entity.valid then - return string.sub(entity.backer_name, 1, string.len(entity.backer_name) - SE_ELEVATOR_SUFFIX_LENGTH) +function se_get_space_elevator_name(cache, surface) + ---@type LuaEntity? + local entity = nil + ---@type string? + local name = nil + local cache_idx = 2*surface.index + if cache.se_get_space_elevator_name then + entity = cache.se_get_space_elevator_name[cache_idx - 1] + name = cache.se_get_space_elevator_name[cache_idx] + else + cache.se_get_space_elevator_name = {} end -end + if entity and entity.valid then + return name + else + --Chaching failed, default to expensive lookup + entity = surface.find_entities_filtered({ + name = SE_ELEVATOR_STOP_PROTO_NAME, + type = "train-stop", + limit = 1, + })[1] + + if entity then + name = string.sub(entity.backer_name, 1, string.len(entity.backer_name) - SE_ELEVATOR_SUFFIX_LENGTH) + cache.se_get_space_elevator_name[cache_idx - 1] = entity + cache.se_get_space_elevator_name[cache_idx] = name + return name + end + end + + return nil +end +---@param cache PerfCache +---@param surface_index uint +local function se_get_zone_from_surface_index(cache, surface_index) + ---@type uint? + local zone_index = nil + ---@type uint? + local zone_orbit_index = nil + local cache_idx = 2*surface_index + if cache.se_get_zone_from_surface_index then + zone_index = cache.se_get_zone_from_surface_index[cache_idx - 1]--[[@as uint]] + zone_orbit_index = cache.se_get_zone_from_surface_index[cache_idx]--[[@as uint]] + else + cache.se_get_zone_from_surface_index = {} + end + + if not zone_index then + zone = remote.call("space-exploration", "get_zone_from_surface_index", {surface_index = surface_index}) + + if type(zone.index) == "number" and type(zone.orbit_index) == "number" then + zone_index = zone.index--[[@as uint]] + zone_orbit_index = zone.orbit_index--[[@as uint]] + --NOTE: caching these indices could be a problem if SE is not deterministic in choosing them + cache.se_get_zone_from_surface_index[cache_idx - 1] = zone_index + cache.se_get_zone_from_surface_index[cache_idx] = zone_orbit_index + end + end + + return zone_index, zone_orbit_index +end ---@param train LuaTrain ---@return LuaEntity? @@ -249,12 +300,12 @@ function set_manifest_schedule(map_data, train, depot_stop, same_depot, p_stop, elseif IS_SE_PRESENT then local other_surface_i = (not is_p_on_t and p_surface_i) or (not is_r_on_t and r_surface_i) or d_surface_i if (is_p_on_t or p_surface_i == other_surface_i) and (is_r_on_t or r_surface_i == other_surface_i) and (is_d_on_t or d_surface_i == other_surface_i) then - local t_zone = remote.call("space-exploration", "get_zone_from_surface_index", {surface_index = t_surface_i})--[[@as {}]] - local other_zone = remote.call("space-exploration", "get_zone_from_surface_index", {surface_index = other_surface_i})--[[@as {}]] - if t_zone and other_zone then - local is_train_in_orbit = other_zone.orbit_index == t_zone.index - if is_train_in_orbit or t_zone.orbit_index == other_zone.index then - local elevator_name = se_get_space_elevator_name(t_surface) + local t_zone_index, t_zone_orbit_index = se_get_zone_from_surface_index(map_data.perf_cache, t_surface_i) + local other_zone_index, other_zone_orbit_index = se_get_zone_from_surface_index(map_data.perf_cache, other_surface_i) + if t_zone_index and other_zone_index then + local is_train_in_orbit = other_zone_orbit_index == t_zone_index + if is_train_in_orbit or t_zone_orbit_index == other_zone_index then + local elevator_name = se_get_space_elevator_name(map_data.perf_cache, t_surface) if elevator_name then local records = {create_inactivity_order(depot_stop.backer_name)} if t_surface_i == p_surface_i then @@ -329,28 +380,32 @@ function add_refueler_schedule(map_data, train, stop) train.schedule = schedule return true elseif IS_SE_PRESENT then - local t_zone = remote.call("space-exploration", "get_zone_from_surface_index", {surface_index = t_surface_i})--[[@as {}]] - local other_zone = remote.call("space-exploration", "get_zone_from_surface_index", {surface_index = f_surface_i})--[[@as {}]] - local is_train_in_orbit = other_zone.orbit_index == t_zone.index - if is_train_in_orbit or t_zone.orbit_index == other_zone.index then - local elevator_name = se_get_space_elevator_name(t_surface) - local cur_order = schedule.records[i] - local is_elevator_in_orders_already = cur_order and cur_order.station == elevator_name..(is_train_in_orbit and SE_ELEVATOR_ORBIT_SUFFIX or SE_ELEVATOR_PLANET_SUFFIX) - if not is_elevator_in_orders_already then - table_insert(schedule.records, i, se_create_elevator_order(elevator_name, is_train_in_orbit)) - end - i = i + 1 - is_train_in_orbit = not is_train_in_orbit - table_insert(schedule.records, i, create_inactivity_order(stop.backer_name)) - i = i + 1 - if not is_elevator_in_orders_already then - table_insert(schedule.records, i, se_create_elevator_order(elevator_name, is_train_in_orbit)) - i = i + 1 - is_train_in_orbit = not is_train_in_orbit - end + local t_zone_index, t_zone_orbit_index = se_get_zone_from_surface_index(map_data.perf_cache, t_surface_i) + local other_zone_index, other_zone_orbit_index = se_get_zone_from_surface_index(map_data.perf_cache, f_surface_i) + if t_zone_index and other_zone_index then + local is_train_in_orbit = other_zone_orbit_index == t_zone_index + if is_train_in_orbit or t_zone_orbit_index == other_zone_index then + local elevator_name = se_get_space_elevator_name(map_data.perf_cache, t_surface) + if elevator_name then + local cur_order = schedule.records[i] + local is_elevator_in_orders_already = cur_order and cur_order.station == elevator_name..(is_train_in_orbit and SE_ELEVATOR_ORBIT_SUFFIX or SE_ELEVATOR_PLANET_SUFFIX) + if not is_elevator_in_orders_already then + table_insert(schedule.records, i, se_create_elevator_order(elevator_name, is_train_in_orbit)) + end + i = i + 1 + is_train_in_orbit = not is_train_in_orbit + table_insert(schedule.records, i, create_inactivity_order(stop.backer_name)) + i = i + 1 + if not is_elevator_in_orders_already then + table_insert(schedule.records, i, se_create_elevator_order(elevator_name, is_train_in_orbit)) + i = i + 1 + is_train_in_orbit = not is_train_in_orbit + end - train.schedule = schedule - return true + train.schedule = schedule + return true + end + end end end --create an order that probably cannot be fulfilled and alert the player @@ -358,6 +413,7 @@ function add_refueler_schedule(map_data, train, stop) lock_train(train) train.schedule = schedule send_alert_cannot_path_between_surfaces(map_data, train) + return false end diff --git a/cybersyn/scripts/global.lua b/cybersyn/scripts/global.lua index 4e668bf..e50d3c9 100644 --- a/cybersyn/scripts/global.lua +++ b/cybersyn/scripts/global.lua @@ -24,6 +24,11 @@ ---@field public each_refuelers {[uint]: true} ---@field public active_alerts {[uint]: {[1]: LuaTrain, [2]: int}}? ---@field public manager Manager +---@field public perf_cache PerfCache -- This gets reset to an empty table on migration change + +---@class PerfCache +---@field public se_get_space_elevator_name {}? +---@field public se_get_zone_from_surface_index {}? ---@class Station ---@field public entity_stop LuaEntity @@ -161,6 +166,7 @@ function init_global() global.refuelers = {} global.to_refuelers = {} global.each_refuelers = {} + global.perf_cache = {} IS_SE_PRESENT = remote.interfaces["space-exploration"] ~= nil end diff --git a/cybersyn/scripts/migrations.lua b/cybersyn/scripts/migrations.lua index fe0786b..20506fe 100644 --- a/cybersyn/scripts/migrations.lua +++ b/cybersyn/scripts/migrations.lua @@ -326,6 +326,8 @@ local migrations_table = { function on_config_changed(data) global.tick_state = STATE_INIT global.tick_data = {} + global.perf_cache = {} + flib_migration.on_config_changed(data, migrations_table) for i, v in pairs(global.manager.players) do From 2d33b908dd717eac388bed834c5d7d6b3ccc0db2 Mon Sep 17 00:00:00 2001 From: mamoniot Date: Sun, 30 Apr 2023 15:39:32 -0400 Subject: [PATCH 2/3] bugfixed SE --- cybersyn/locale/en/base.cfg | 4 +++- cybersyn/scripts/factorio-api.lua | 11 ++++++----- cybersyn/scripts/gui/main.lua | 2 +- 3 files changed, 10 insertions(+), 7 deletions(-) diff --git a/cybersyn/locale/en/base.cfg b/cybersyn/locale/en/base.cfg index 42d7217..247a08c 100644 --- a/cybersyn/locale/en/base.cfg +++ b/cybersyn/locale/en/base.cfg @@ -12,7 +12,7 @@ cybersyn-warmup-time=Station warmup time (sec) cybersyn-stuck-train-time=Stuck train timeout (sec) cybersyn-allow-cargo-in-depot=Allow cargo in depots cybersyn-invert-sign=Invert combinator output (deprecated) -cybersyn-manager-enabled=Enable the Cybersyn GUI. +cybersyn-manager-enabled=Preview the Indev Cybersyn Manager. cybersyn-manager-update-rate=Manager refresh tick interval cybersyn-manager-result-limit=Max entities displayed on GUI pages. @@ -30,6 +30,8 @@ cybersyn-warmup-time=How many seconds a cybernetic combinator will wait before c cybersyn-stuck-train-time=After this many seconds from a train's dispatch, an alert will be sent to let you know a train is probably stuck and has not completed its delivery. The player will likely have to debug their network to get the train unstuck. cybersyn-allow-cargo-in-depot=If checked, trains will be allowed to have cargo in depots; no alerts will be generated and the train will not be held. In addition, trains with orders to visit requester stations with "Inactivity condition" checked will wait for inactivity instead of waiting for empty cargo. Useful for creating train systems where depots handle excess cargo. For advanced users only. cybersyn-invert-sign=Flip the sign of the output of cybernetic combinators to be the same as it is in LTN or in earlier versions of Project Cybersyn. +cybersyn-manager-enabled=Allows viewing of all trains and stations connected to the Cybersyn network. This GUI is currently in development and is likely to have many crash. +cybersyn-manager-update-rate=Controls how frequently the Cybersyn manager gui refreshes. The Cybersyn manager must be set to active for this setting to have an effect. cybersyn-manager-result-limit=Caps the number of matching enitities (e.g. stations, trains) to limit the amount of update time consumed when the list is refreshed.\n-1 means return all results. [item-name] diff --git a/cybersyn/scripts/factorio-api.lua b/cybersyn/scripts/factorio-api.lua index 7809154..b053e19 100644 --- a/cybersyn/scripts/factorio-api.lua +++ b/cybersyn/scripts/factorio-api.lua @@ -63,10 +63,10 @@ function se_get_space_elevator_name(cache, surface) cache.se_get_space_elevator_name[cache_idx - 1] = entity cache.se_get_space_elevator_name[cache_idx] = name return name + else + return nil end end - - return nil end ---@param cache PerfCache ---@param surface_index uint @@ -78,7 +78,8 @@ local function se_get_zone_from_surface_index(cache, surface_index) local cache_idx = 2*surface_index if cache.se_get_zone_from_surface_index then zone_index = cache.se_get_zone_from_surface_index[cache_idx - 1]--[[@as uint]] - zone_orbit_index = cache.se_get_zone_from_surface_index[cache_idx]--[[@as uint]] + --zones may not have an orbit_index + zone_orbit_index = cache.se_get_zone_from_surface_index[cache_idx]--[[@as uint?]] else cache.se_get_zone_from_surface_index = {} end @@ -86,9 +87,9 @@ local function se_get_zone_from_surface_index(cache, surface_index) if not zone_index then zone = remote.call("space-exploration", "get_zone_from_surface_index", {surface_index = surface_index}) - if type(zone.index) == "number" and type(zone.orbit_index) == "number" then + if zone and type(zone.index) == "number" then zone_index = zone.index--[[@as uint]] - zone_orbit_index = zone.orbit_index--[[@as uint]] + zone_orbit_index = zone.orbit_index--[[@as uint?]] --NOTE: caching these indices could be a problem if SE is not deterministic in choosing them cache.se_get_zone_from_surface_index[cache_idx - 1] = zone_index cache.se_get_zone_from_surface_index[cache_idx] = zone_orbit_index diff --git a/cybersyn/scripts/gui/main.lua b/cybersyn/scripts/gui/main.lua index ae7d033..78ffa0b 100644 --- a/cybersyn/scripts/gui/main.lua +++ b/cybersyn/scripts/gui/main.lua @@ -47,7 +47,7 @@ end local manager_gui = {} function manager_gui.on_lua_shortcut(e) - if e.prototype_name == "cybersyn-toggle-gui" or e.input_name == "cybersyn-toggle-gui" or e.element.name == "manager_window" then + if e.prototype_name == "cybersyn-toggle-gui" or e.input_name == "cybersyn-toggle-gui" or (e.element and e.element.name == "manager_window") then manager.wrapper(e, manager.handle.manager_toggle) end end From 230fe3a7328832ac85d8744f75be0cb0983ede1d Mon Sep 17 00:00:00 2001 From: mamoniot Date: Sun, 30 Apr 2023 15:43:42 -0400 Subject: [PATCH 3/3] removed unused migration --- cybersyn/scripts/migrations.lua | 21 --------------------- 1 file changed, 21 deletions(-) diff --git a/cybersyn/scripts/migrations.lua b/cybersyn/scripts/migrations.lua index 20506fe..94488ac 100644 --- a/cybersyn/scripts/migrations.lua +++ b/cybersyn/scripts/migrations.lua @@ -351,25 +351,4 @@ end ---NOTE 2: Everything in this section must be idempotent function on_debug_revision_change() local map_data = global - - if debug_revision == 1 then - for _, e in pairs(map_data.refuelers) do - if e.network_flag ~= nil then - e.network_mask = e.network_flag - e.network_flag = nil - end - end - for _, e in pairs(map_data.stations) do - if e.network_flag ~= nil then - e.network_mask = e.network_flag - e.network_flag = nil - end - end - for _, e in pairs(map_data.trains) do - if e.network_flag ~= nil then - e.network_mask = e.network_flag - e.network_flag = nil - end - end - end end