bbradson
949bde76ce
This also adds an experimental, usually slower, threaded gas grid mode and implements a workaround for the whole mod and game failing to start when opening prepatcher's mod manager with unfortunate timing
402 lines
14 KiB
C#
402 lines
14 KiB
C#
// Copyright (c) 2023 bradson
|
|
// This Source Code Form is subject to the terms of the Mozilla Public
|
|
// License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
// file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
|
|
|
// #define STORAGE_GROUP_DEBUG
|
|
|
|
using System.Diagnostics;
|
|
using System.Linq;
|
|
using Mono.Cecil;
|
|
using Mono.Cecil.Cil;
|
|
using PerformanceFish.Events;
|
|
using PerformanceFish.Listers;
|
|
using PerformanceFish.Prepatching;
|
|
|
|
namespace PerformanceFish.Hauling;
|
|
|
|
public sealed class StoreUtilityPrepatches : ClassWithFishPrepatches
|
|
{
|
|
public sealed class NoStorageBlockersInPatch : FishPrepatch
|
|
{
|
|
public override string? Description { get; }
|
|
= "Optimizes this frequently accessed storage check by caching fully blocked cells in a bit array and "
|
|
+ "reordering instructions to make better use of caches.";
|
|
|
|
public override MethodBase TargetMethodBase { get; } = methodof(StoreUtility.NoStorageBlockersIn);
|
|
|
|
protected internal override void OnPatchingCompleted() => ThingEvents.Initialized += TryRegister;
|
|
|
|
public static void TryRegister(Thing thing)
|
|
{
|
|
if (!IsStorageBlocker(thing.def))
|
|
return;
|
|
|
|
var thingEvents = thing.Events();
|
|
thingEvents.RegisteredAtThingGrid += SetStorageBlocker;
|
|
thingEvents.DeregisteredAtThingGrid += TryUnsetStorageBlocker;
|
|
}
|
|
|
|
public static bool IsStorageBlocker(ThingDef thingDef)
|
|
=> (thingDef.entityDefToBuild != null && thingDef.entityDefToBuild.passability != 0)
|
|
|| (thingDef.passability != 0
|
|
&& thingDef.surfaceType == SurfaceType.None
|
|
&& thingDef.category != ThingCategory.Item);
|
|
|
|
public static void SetStorageBlocker(Thing thing, Map map, in IntVec3 cell)
|
|
=> map.StorageBlockerGrid()[cell] = true;
|
|
|
|
public static void TryUnsetStorageBlocker(Thing thing, Map map, in IntVec3 cell)
|
|
{
|
|
var thingsList = map.thingGrid.ThingsListAt(cell);
|
|
|
|
for (var i = thingsList.Count; i-- > 0;)
|
|
{
|
|
var otherThing = thingsList[i];
|
|
if (otherThing != thing && IsStorageBlocker(otherThing.def))
|
|
return;
|
|
}
|
|
|
|
map.StorageBlockerGrid()[cell] = false;
|
|
}
|
|
|
|
public override void Transpiler(ILProcessor ilProcessor, ModuleDefinition module)
|
|
=> ilProcessor.ReplaceBodyWith(ReplacementBody);
|
|
|
|
public static bool ReplacementBody(IntVec3 c, Map map, Thing thing)
|
|
{
|
|
if (map.StorageBlockerGrid()[c])
|
|
return false;
|
|
|
|
if (c.GetItemCount(map) < c.GetMaxItemsAllowedInCell(map))
|
|
return true;
|
|
|
|
var thingsAtCell = map.thingGrid.ThingsListAt(c);
|
|
var thingCount = thingsAtCell.Count;
|
|
for (var i = 0; i < thingCount; i++)
|
|
{
|
|
var thingAtCell = thingsAtCell[i];
|
|
|
|
if (thingAtCell.stackCount < thingAtCell.def.stackLimit
|
|
&& thingAtCell.CanStackWith(thing)
|
|
&& thingAtCell.def.EverStorable(false))
|
|
{
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
}
|
|
|
|
public sealed class TryFindBestBetterStoreCellForWorkerPatch : FishPrepatch
|
|
{
|
|
public override List<Type> LinkedPatches { get; } =
|
|
[
|
|
typeof(SlotGroupPrepatches.Notify_AddedCellPatch), typeof(SlotGroupPrepatches.Notify_LostCellPatch),
|
|
typeof(StorageSettingsPatches.AllowedToAcceptPatch)
|
|
];
|
|
|
|
public override string? Description { get; }
|
|
= "Optimizes hauling by splitting storage areas into smaller regions with cached capacity information. "
|
|
+ "Additionally makes lookups more thorough when having the 'Improve hauling accuracy' setting enabled, "
|
|
+ "raising the odds of getting closer cells as haul destinations. StorageSettingsPatches:AllowedToAccept "
|
|
+ "requires this patch due to shared caches";
|
|
|
|
public override MethodBase TargetMethodBase { get; }
|
|
= methodof(StoreUtility.TryFindBestBetterStoreCellForWorker);
|
|
|
|
protected internal override void OnPatchingCompleted() => ThingEvents.Initialized += TryRegister;
|
|
|
|
public static void TryRegister(Thing thing)
|
|
{
|
|
var thingEvents = thing.Events();
|
|
|
|
if (thing is ISlotGroupParent)
|
|
{
|
|
thingEvents.Spawned += NotifySlotGroupCellCountChanged;
|
|
thingEvents.Spawned += StorageSettingsPatches.InitializeSlotGroupParent;
|
|
thingEvents.DeSpawned += NotifySlotGroupCellCountChanged;
|
|
}
|
|
|
|
if (!thing.IsItem())
|
|
return;
|
|
|
|
thingEvents.RegisteredAtThingGrid += TryNotifyReceivedThing;
|
|
thingEvents.DeregisteredAtThingGrid += TryNotifyLostThing;
|
|
}
|
|
|
|
public static void NotifySlotGroupCellCountChanged(Thing slotGroupParent, Map map)
|
|
=> NotifySlotGroupCellCountChanged(slotGroupParent);
|
|
|
|
public static void NotifySlotGroupCellCountChanged(Thing slotGroupParent)
|
|
=> slotGroupParent.GetSlotGroup()?.NotifyCellCountChanged();
|
|
|
|
public static void TryNotifyReceivedThing(Thing thing, Map map, in IntVec3 cell)
|
|
{
|
|
if (cell.GetSlotGroupParent(map) is { } parent and Thing)
|
|
parent.GetThingStoreSettings()?.Cache().Notify_ReceivedThing(thing);
|
|
|
|
map.StorageDistrictGrid()[cell]?.AddThing(thing);
|
|
}
|
|
|
|
public static void TryNotifyLostThing(Thing thing, Map map, in IntVec3 cell)
|
|
{
|
|
if (cell.GetSlotGroupParent(map) is { } parent and Thing)
|
|
parent.GetThingStoreSettings()?.Cache().Notify_LostThing(thing);
|
|
|
|
map.StorageDistrictGrid()[cell]?.RemoveThing(thing);
|
|
}
|
|
|
|
public override void Transpiler(ILProcessor ilProcessor, ModuleDefinition module)
|
|
=> ilProcessor.ReplaceBodyWith(ReplacementBody);
|
|
|
|
public static void ReplacementBody(Thing t, Pawn carrier, Map map, Faction faction, SlotGroup? slotGroup,
|
|
bool needAccurateResult, ref IntVec3 closestSlot, ref float closestDistSquared,
|
|
ref StoragePriority foundPriority)
|
|
{
|
|
if (slotGroup == null || !slotGroup.parent.Accepts(t) || !CapacityAllows(slotGroup, t))
|
|
return;
|
|
|
|
var thingPosition = t.SpawnedOrAnyParentSpawned ? t.PositionHeld : carrier.PositionHeld;
|
|
var slotGroupCells = slotGroup.CellsList;
|
|
|
|
var maxValidCellsToCheck
|
|
= !FishSettings.ImproveHaulingAccuracy && needAccurateResult
|
|
? Mathf.FloorToInt(slotGroupCells.Count * Rand.Range(0.005f, 0.018f))
|
|
: 0;
|
|
|
|
StartOfDistrictLoop:
|
|
var districts = GetDistricts(slotGroup);
|
|
|
|
for (var districtIndex = 0; districtIndex < districts.Length; districtIndex++)
|
|
{
|
|
var district = districts[districtIndex];
|
|
|
|
if (!district.CapacityAllows(t))
|
|
continue;
|
|
|
|
var districtCells = districts.Length > 1 ? district.Cells : slotGroupCells;
|
|
|
|
for (var i = 0; i < districtCells.Count; i++)
|
|
{
|
|
var slotGroupCell = districtCells[i];
|
|
var cellDistance = (float)(thingPosition - slotGroupCell).LengthHorizontalSquared;
|
|
|
|
if (cellDistance > closestDistSquared
|
|
|| !StoreUtility.IsGoodStoreCell(slotGroupCell, map, t, carrier, faction))
|
|
{
|
|
continue;
|
|
}
|
|
|
|
if (districts.Length > 1 && slotGroupCell.GetSlotGroup(map) != district.Parent)
|
|
{
|
|
district.Parent.ResetAndRemakeDistricts(); // TODO: figure out why this happens
|
|
goto StartOfDistrictLoop;
|
|
}
|
|
|
|
closestSlot = slotGroupCell;
|
|
closestDistSquared = cellDistance;
|
|
foundPriority = slotGroup.Settings.Priority;
|
|
if (!FishSettings.ImproveHaulingAccuracy && (districtIndex * i) + i >= maxValidCellsToCheck)
|
|
return;
|
|
}
|
|
}
|
|
}
|
|
|
|
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
|
public static StorageDistrict[] GetDistricts(SlotGroup slotGroup) => slotGroup.Districts();
|
|
// wrapper for analyzer compatibility, as it otherwise throws on ref returns
|
|
|
|
[MethodImpl(MethodImplOptions.NoInlining)]
|
|
public static bool CapacityAllows(SlotGroup slotGroup, Thing t)
|
|
{
|
|
var storageSettings = slotGroup.GetThingStoreSettings();
|
|
if (storageSettings?.owner is not Thing)
|
|
return true;
|
|
|
|
ref var cache = ref storageSettings.Cache();
|
|
StorageSettingsPatches.Debug.VerifyItemCount((Thing)storageSettings.owner, ref cache);
|
|
|
|
return cache.FreeSlots > 0 || AcceptsForStacking(ref cache, t);
|
|
}
|
|
|
|
public static bool AcceptsForStacking(ref StorageSettingsPatches.StorageSettingsCache cache, Thing t)
|
|
=> cache.StoredThingsOfDef(t.def).ContainsThingStackableWith(t);
|
|
}
|
|
|
|
public sealed class TryFindBestBetterStoreCellForPatch : FishPrepatch
|
|
{
|
|
public override string? Description { get; }
|
|
= "Optimizes a loop in the method to make use of cached storage priorities for fewer comparisons against "
|
|
+ "those. Also removes haulables from ListerHaulables if the found best store cell turns out to be the "
|
|
+ "current cell";
|
|
|
|
public override MethodBase TargetMethodBase { get; } = methodof(StoreUtility.TryFindBestBetterStoreCellFor);
|
|
|
|
public override void Transpiler(ILProcessor ilProcessor, ModuleDefinition module)
|
|
=> ilProcessor.ReplaceBodyWith(ReplacementBody);
|
|
|
|
public static bool ReplacementBody(Thing t, Pawn carrier, Map map,
|
|
StoragePriority currentPriority, Faction faction, out IntVec3 foundCell, bool needAccurateResult = true)
|
|
{
|
|
var haulDestinationManager = map.haulDestinationManager;
|
|
List<SlotGroup> listInPriorityOrder = haulDestinationManager.AllGroupsListInPriorityOrder;
|
|
if (listInPriorityOrder.Count == 0)
|
|
{
|
|
foundCell = IntVec3.Invalid;
|
|
return false;
|
|
}
|
|
|
|
#if STORAGE_GROUP_DEBUG
|
|
if (!Debug.LoggedOnce && !(Current.Game?.tickManager?.Paused ?? true))
|
|
Debug.LogStuff(listInPriorityOrder);
|
|
#endif
|
|
|
|
var foundPriority = currentPriority;
|
|
var closestDistSquared = (float)int.MaxValue;
|
|
var closestSlot = IntVec3.Invalid;
|
|
|
|
var groupCountByPriority = GetCachedGroupCountByPriority(haulDestinationManager);
|
|
var i = 0;
|
|
for (var priorityGroupIndex = groupCountByPriority.Length; priorityGroupIndex-- > 0;)
|
|
{
|
|
var groupsOfPriorityCount = groupCountByPriority[priorityGroupIndex];
|
|
|
|
if ((StoragePriority)priorityGroupIndex < foundPriority) // succeeded finding a higher priority storage
|
|
break;
|
|
|
|
if ((StoragePriority)priorityGroupIndex <= currentPriority) // current storage is highest valid priority
|
|
{
|
|
TryRemoveFromListerHaulables(t, currentPriority);
|
|
break;
|
|
}
|
|
|
|
while (groupsOfPriorityCount-- > 0)
|
|
{
|
|
var slotGroup = listInPriorityOrder[i++];
|
|
int otherGroupMembers;
|
|
var storageGroup = slotGroup.TryGetStorageGroup();
|
|
if (storageGroup != null)
|
|
{
|
|
otherGroupMembers = storageGroup.MemberCount - 1;
|
|
Debug.VerifyStorageGroup(otherGroupMembers, listInPriorityOrder, i, storageGroup);
|
|
|
|
groupsOfPriorityCount -= otherGroupMembers;
|
|
|
|
if (!storageGroup.Accepts(t))
|
|
{
|
|
i += otherGroupMembers;
|
|
continue;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
otherGroupMembers = 0;
|
|
}
|
|
|
|
while (true)
|
|
{
|
|
StoreUtility.TryFindBestBetterStoreCellForWorker(t, carrier, map, faction, slotGroup,
|
|
needAccurateResult, ref closestSlot, ref closestDistSquared, ref foundPriority);
|
|
|
|
if (otherGroupMembers <= 0)
|
|
break;
|
|
|
|
otherGroupMembers--;
|
|
slotGroup = listInPriorityOrder[i++];
|
|
}
|
|
}
|
|
}
|
|
|
|
if (!closestSlot.IsValid)
|
|
{
|
|
foundCell = IntVec3.Invalid;
|
|
return false;
|
|
}
|
|
|
|
foundCell = closestSlot;
|
|
return true;
|
|
}
|
|
|
|
[MethodImpl(MethodImplOptions.AggressiveInlining)]
|
|
public static int[] GetCachedGroupCountByPriority(HaulDestinationManager haulDestinationManager)
|
|
=> haulDestinationManager.Cache().GroupCountByPriority;
|
|
|
|
[MethodImpl(MethodImplOptions.NoInlining)]
|
|
public static void TryRemoveFromListerHaulables(Thing t, StoragePriority currentPriority)
|
|
{
|
|
if (t.IsInAnyStorage() /*t.IsInValidStorage()*/ && t.TryGetMapHeld() is { } map)
|
|
map.listerHaulables.TryRemoveDirectly(t);
|
|
|
|
// remove for any storage instead of only valid storage to prevent further haul attempts until the next
|
|
// automatic ListerHaulablesTick cycle
|
|
}
|
|
|
|
public static class Debug
|
|
{
|
|
[Conditional("STORAGE_GROUP_DEBUG")]
|
|
public static void VerifyStorageGroup(int otherGroupMembers, List<SlotGroup> listInPriorityOrder, int i,
|
|
StorageGroup storageGroup)
|
|
{
|
|
for (var b = otherGroupMembers; b-- > 0;)
|
|
{
|
|
var otherSlotGroup = listInPriorityOrder[i + b];
|
|
if (otherSlotGroup.TryGetStorageGroup() == storageGroup)
|
|
continue;
|
|
|
|
Log.Error($"Incorrect haul destination order! Storage '{
|
|
otherSlotGroup.parent}' was expected to have Storage group '{storageGroup}', but had '{
|
|
otherSlotGroup.TryGetStorageGroup().ToStringSafe()}' instead");
|
|
}
|
|
}
|
|
|
|
[Conditional("STORAGE_GROUP_DEBUG")]
|
|
public static void LogStuff(List<SlotGroup> listInPriorityOrder)
|
|
{
|
|
LoggedOnce = true;
|
|
var storageGroups = listInPriorityOrder.Select(static slotGroup => slotGroup.TryGetStorageGroup())
|
|
.Where(Is.NotNull).Distinct().ToList();
|
|
Log.Message($"SlotGroup count: {listInPriorityOrder.Count}, StorageGroup count: {
|
|
storageGroups.Count}, slotGroups in storage groups: {
|
|
storageGroups.Select(static group => group!.MemberCount).Sum()}, outside of storage groups: {
|
|
listInPriorityOrder.Select(static slotGroup => slotGroup.TryGetStorageGroup())
|
|
.Where(Is.Null).Count()}");
|
|
}
|
|
|
|
public static bool LoggedOnce;
|
|
}
|
|
}
|
|
|
|
public sealed class GetSlotGroupPatch : FishPrepatch
|
|
{
|
|
public override string? Description { get; }
|
|
= "Optimization for this method by reducing its amount of instructions without changing results";
|
|
|
|
public override MethodBase TargetMethodBase { get; }
|
|
= methodof((Func<Thing, SlotGroup>)StoreUtility.GetSlotGroup);
|
|
|
|
public override void Transpiler(ILProcessor ilProcessor, ModuleDefinition module)
|
|
=> ilProcessor.ReplaceBodyWith(ReplacementBody);
|
|
|
|
public static SlotGroup? ReplacementBody(Thing thing)
|
|
=> thing.TryGetMap() is { } map ? thing.Position.GetSlotGroup(map) : null;
|
|
}
|
|
|
|
public sealed class CurrentHaulDestinationOfPatch : FishPrepatch
|
|
{
|
|
public override string? Description { get; }
|
|
= "Optimization for this method by reducing its amount of instructions without changing results";
|
|
|
|
public override MethodBase TargetMethodBase { get; }
|
|
= methodof(StoreUtility.CurrentHaulDestinationOf);
|
|
|
|
public override void Transpiler(ILProcessor ilProcessor, ModuleDefinition module)
|
|
=> ilProcessor.ReplaceBodyWith(ReplacementBody);
|
|
|
|
public static IHaulDestination? ReplacementBody(Thing t)
|
|
=> t.TryGetMap() is { } map
|
|
? map.haulDestinationManager.SlotGroupParentAt(t.Position)
|
|
: t.ParentHolder as IHaulDestination;
|
|
}
|
|
} |