warrentyexpired/ModernUO
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

feat: Adds optimized dynamic/static layout gumps (#1652)

Browse source 
# New Gump API
We are pleased to release a new API that is faster, allocates nearly zero memory, and still feels very similar to the original API. The API is broken into 3 types of gumps, dynamic, static with placeholders, and static without placeholders. 

### Dynamic Gumps
These gumps will inherit `DynamicGump` and are meant for gumps that have a dynamic layout. This includes specifying dynamic arguments to HtmlLocalized entries.

## Static Gumps 
Static gumps are those where the function to the build the layout is called only once and cached forever. They can optionally have placeholders. These placeholders allow the developer to specify the string values later, dynamically in a `BuildStrings` method on the gump. If a gump does not have any placeholders, the string entries will also be cached forever.

## Benchmarks
To make sure we were going in the right direction and not wasting time, we took copious benchmarks. Here are the final benchmarks for a really simple gump. 

Note:
* The majority of creating a gump is compressing the layout and the strings. Compressing each section takes ~6,000ns (12us total).

```cs
| Method                         | Mean         | Error        | StdDev       | Median       | Ratio | RatioSD | Gen0   | Allocated | Alloc Ratio |
|------------------------------- |-------------:|-------------:|-------------:|-------------:|------:|--------:|-------:|----------:|------------:|
| OldGump                        | 13,308.29 ns | 1,059.695 ns | 1,883.608 ns | 14,330.72 ns | 1.000 |    0.00 | 0.1526 |    2400 B |        1.00 |
| DynamicLayoutGump              | 13,357.86 ns |   129.144 ns |   226.185 ns | 13,323.60 ns | 1.029 |    0.17 |      - |      48 B |        0.02 |
| StaticLayoutDynamicStringsGump |  6,653.10 ns |    81.815 ns |   143.292 ns |  6,617.45 ns | 0.514 |    0.09 |      - |      40 B |        0.02 |
| StaticLayoutGump               |     86.33 ns |     0.760 ns |     1.350 ns |     86.07 ns | 0.007 |    0.00 | 0.0020 |      32 B |        0.01 |
```

# Non-Breaking Changes
* All gump components in the core have been moved to `Gumps/Legacy`.
* All legacy gumps will still inherit `Gump`, which now inherits `BaseGump`

# Special Thanks

Thank you to @stefanomerotta for considerable contributions/benchmarking/testing to make this effort a reality! We collectively went through over 10 iterations, but it is finally ready.
This commit is contained in:
Kamron Batman 2024-04-25 22:40:30 -07:00 • committed by GitHub
parent 1c10b6dbed
commit 65532ea887
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
46 changed files with 2527 additions and 273 deletions
Download patch file Download diff file Expand all files Collapse all files

75
Projects/UOContent/Network/Packets/IncomingPlayerPackets.cs
View file

@ -350,7 +350,7 @@ public static class IncomingPlayerPackets
var typeId = reader.ReadInt32();
var buttonId = reader.ReadInt32();
Gump gump = null;
BaseGump baseGump = null;
foreach (var g in state.Gumps)
{
@ -359,61 +359,58 @@ public static class IncomingPlayerPackets
continue;
}
gump = g;
baseGump = g;
break;
}
if (gump != null)
if (baseGump != null)
{
var buttonExists = buttonId == 0; // 0 is always 'close'
if (!buttonExists)
if (baseGump is Gump gump)
{
foreach (var e in gump.Entries)
{
if (e is GumpButton button && button.ButtonID == buttonId)
{
buttonExists = true;
break;
}
var buttonExists = buttonId == 0; // 0 is always 'close'
if (e is GumpImageTileButton tileButton && tileButton.ButtonID == buttonId)
if (!buttonExists)
{
foreach (var e in gump.Entries)
{
buttonExists = true;
break;
if ((e as GumpButton)?.ButtonID == buttonId)
{
buttonExists = true;
break;
}
if ((e as GumpImageTileButton)?.ButtonID == buttonId)
{
buttonExists = true;
break;
}
}
}
}
if (!buttonExists)
{
state.LogInfo("Invalid gump response, disconnecting...");
var exception = new InvalidGumpResponseException($"Button {buttonId} doesn't exist");
exception.SetStackTrace(new StackTrace());
NetState.TraceException(exception);
state.Mobile?.SendMessage("Invalid gump response.");
// state.Disconnect("Invalid gump response.");
return;
if (!buttonExists)
{
state.LogInfo("Invalid gump response, disconnecting...");
var exception = new InvalidGumpResponseException($"Button {buttonId} doesn't exist");
exception.SetStackTrace(new StackTrace());
NetState.TraceException(exception);
return;
}
}
var switchCount = reader.ReadInt32();
if (switchCount < 0 || switchCount > gump.Switches)
if (switchCount < 0 || switchCount > baseGump.Switches)
{
state.LogInfo("Invalid gump response, disconnecting...");
var exception = new InvalidGumpResponseException($"Bad switch count {switchCount}");
exception.SetStackTrace(new StackTrace());
NetState.TraceException(exception);
state.Mobile?.SendMessage("Invalid gump response.");
// state.Disconnect("Invalid gump response.");
return;
}
int switchByteCount = switchCount * 4;
// Read in all of the integers
// Read all the integers
ReadOnlySpan<int> switchBlock =
MemoryMarshal.Cast<byte, int>(reader.Buffer.Slice(reader.Position, switchByteCount));
@ -434,15 +431,12 @@ public static class IncomingPlayerPackets
}
var textCount = reader.ReadInt32();
if (textCount < 0 || textCount > gump.TextEntries)
if (textCount < 0 || textCount > baseGump.TextEntries)
{
state.LogInfo("Invalid gump response, disconnecting...");
var exception = new InvalidGumpResponseException($"Bad text entry count {textCount}");
exception.SetStackTrace(new StackTrace());
NetState.TraceException(exception);
state.Mobile?.SendMessage("Invalid gump response.");
// state.Disconnect("Invalid gump response.");
return;
}
@ -461,9 +455,6 @@ public static class IncomingPlayerPackets
var exception = new InvalidGumpResponseException($"Text entry {i} is too long ({textLength})");
exception.SetStackTrace(new StackTrace());
NetState.TraceException(exception);
state.Mobile?.SendMessage("Invalid gump response.");
// state.Disconnect("Invalid gump response.");
return;
}
@ -476,9 +467,9 @@ public static class IncomingPlayerPackets
var textBlock = reader.Buffer.Slice(textOffset, reader.Position - textOffset);
state.RemoveGump(gump);
state.RemoveGump(baseGump);
var prof = GumpProfile.Acquire(gump.GetType());
var prof = GumpProfile.Acquire(baseGump.GetType());
prof?.Start();
@ -489,7 +480,7 @@ public static class IncomingPlayerPackets
textFields,
textBlock
);
gump.OnResponse(state, relayInfo);
baseGump.OnResponse(state, relayInfo);
prof?.Finish();
}