Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Optimizations for KeyBuilder #3598

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

nan01ab
Copy link
Contributor

@nan01ab nan01ab commented Nov 25, 2024

Description

Optimizing memory allocation for KeyBuilder and add UTs for not-convered methods

Benchmarks:
Before:

BenchmarkDotNet v0.13.12, macOS 15.1.1 (24B2091) [Darwin 24.1.0]
Apple M4 Pro, 1 CPU, 14 logical and 14 physical cores
.NET SDK 8.0.404
  [Host]     : .NET 8.0.11 (8.0.1124.51707), Arm64 RyuJIT AdvSIMD
  DefaultJob : .NET 8.0.11 (8.0.1124.51707), Arm64 RyuJIT AdvSIMD


| Method                | Mean     | Error    | StdDev   |
|---------------------- |---------:|---------:|---------:|
| KeyBuilder_AddInt     | 40.16 ns | 0.090 ns | 0.084 ns |
| KeyBuilder_AddBytes   | 36.04 ns | 0.051 ns | 0.048 ns |
| KeyBuilder_AddUInt160 | 45.21 ns | 0.044 ns | 0.039 ns |

After:

BenchmarkDotNet v0.13.12, macOS 15.1.1 (24B2091) [Darwin 24.1.0]
Apple M4 Pro, 1 CPU, 14 logical and 14 physical cores
.NET SDK 8.0.404
  [Host]     : .NET 8.0.11 (8.0.1124.51707), Arm64 RyuJIT AdvSIMD
  DefaultJob : .NET 8.0.11 (8.0.1124.51707), Arm64 RyuJIT AdvSIMD


| Method                | Mean     | Error    | StdDev   |
|---------------------- |---------:|---------:|---------:|
| KeyBuilder_AddInt     | 27.27 ns | 0.110 ns | 0.103 ns |
| KeyBuilder_AddBytes   | 27.43 ns | 0.059 ns | 0.056 ns |
| KeyBuilder_AddUInt160 | 25.75 ns | 0.031 ns | 0.029 ns |

Type of change

  • Optimization (the change is only an optimization)
  • Style (the change is only a code style for better maintenance or standard purpose)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

src/Neo/SmartContract/KeyBuilder.cs Show resolved Hide resolved
public KeyBuilder AddBigEndian(int key)
{
var data = new byte[sizeof(int)];
Span<byte> data = stackalloc byte[sizeof(int)];
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you sure this makes any difference? Have you measured these changes in isolation?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you sure this makes any difference? Have you measured these changes in isolation?

Yes. This change avoids allocating memory from the heap.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In general compilers can optimize such allocations out (but I'm not aware of C# compiler specifics, maybe it never does it and I just don't know), but if you've checked that this particular change is really worthwhile (and this means testing it in isolation from other changes in the same PR) then OK.

BinaryPrimitives.WriteInt32LittleEndian(data, id);

stream = new(sizeof(int) + sizeof(byte) + keySizeHint);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

byte shouldn't be necessary, in general MaxStorageKeySize limits the whole key with prefix included. That said, KeyBuilder is somewhat special in that only native contracts use it. And native contracts can do things normal contracts can't (like #3596). Still, current native contracts never go beyond this limit.

BinaryPrimitives.WriteInt32LittleEndian(data, id);

stream = new(sizeof(int) + sizeof(byte) + keySizeHint);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
stream = new(sizeof(int) + sizeof(byte) + keySizeHint);
stream = new(keySizeHint);


/// <summary>
/// Initializes a new instance of the <see cref="KeyBuilder"/> class.
/// </summary>
/// <param name="id">The id of the contract.</param>
/// <param name="prefix">The prefix of the key.</param>
public KeyBuilder(int id, byte prefix)
/// <param name="keySizeHint">The hint of the storage key size(not including the id and prefix).</param>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/// <param name="keySizeHint">The hint of the storage key size(not including the id and prefix).</param>
/// <param name="keySizeHint">The hint of the storage key size(including the id and prefix).</param>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants