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.

Sign up for GitHub

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

Jump to bottom

Refactor MsQuic's native IP address types. #53461

Merged
merged 3 commits into from
May 31, 2021
Merged

Refactor MsQuic's native IP address types. #53461

merged 3 commits into from
May 31, 2021

Conversation

teo-tsirpanis
Copy link
Contributor

MsQuicAddressHelpers.INetToIPEndPoint passes byte arrays to the IPAddress' constructor which were allocated by the Address properties of the MsQuicNativeMethods+SOCKADDR_IN(6) structs. There are no other uses of these properties.

This PR changes these properties to return read-only spans, avoiding the allocation of an byte array.

A similar trick is already performed on the spans returned by the System.GCMemory type.

@ghost
Copy link

ghost commented May 29, 2021

Tagging subscribers to this area: @dotnet/ncl
See info in area-owners.md if you want to be subscribed.

Issue Details

MsQuicAddressHelpers.INetToIPEndPoint passes byte arrays to the IPAddress' constructor which were allocated by the Address properties of the MsQuicNativeMethods+SOCKADDR_IN(6) structs. There are no other uses of these properties.

This PR changes these properties to return read-only spans, avoiding the allocation of an byte array.

A similar trick is already performed on the spans returned by the System.GCMemory type.

Author: teo-tsirpanis
Assignees: -
Labels:

area-System.Net
Milestone: -

stephentoub
stephentoub approved these changes May 29, 2021
View reviewed changes
Copy link
Member

@stephentoub stephentoub left a comment

Choose a reason for hiding this comment

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

LGTM, based on current usage. This becomes very unsafe if that span is passed out to a different scope than the struct was defined, so usage of this property needs to be scrutinized heavily moving forward.

@teo-tsirpanis
Copy link
Contributor Author

I got another idea. We could add a ToIpAddress method at each struct. The span would not be exposed and INetToIPAddresswould call the method on the appropriate struct depending on whether IPv4 or 6 is used.

@stephentoub
Copy link
Member

My preference actually would be for the _addr fields to instead by a fixed buffer pointer (e.g. internal fixed byte sin_addr[16];), and then the call site would construct the span from that pointer. That keeps layering cleaner, reduces the cruft in the struct definition, and more closely matches the native header file.

@teo-tsirpanis teo-tsirpanis changed the title Avoid byte array allocations on MsQuic's IP address structs. Refactor MsQuic's native IP address types. May 29, 2021
@teo-tsirpanis
Copy link
Contributor Author

OK @stephentoub, I applied your suggestions; they turned out to allow optimizing the IPEndPointToINet method as well. Could you review it again?

@teo-tsirpanis
Use fixed buffers in MsQuic's native IP address types.
07bc4e2 
And handle them more efficiently when moving between them and .NET's IPAddresses.
@teo-tsirpanis
Update the names of all SOCKADDR_IN6's fields.
ba747cb
@stephentoub
Copy link
Member

cc: @dotnet/ncl

wfurt
wfurt approved these changes May 31, 2021
View reviewed changes
Copy link
Member

@wfurt wfurt left a comment

Choose a reason for hiding this comment

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

LGTM

@wfurt wfurt merged commit 3846a9c into dotnet:main May 31, 2021
@teo-tsirpanis teo-tsirpanis deleted the patch-1 branch May 31, 2021 10:01
@wfurt wfurt mentioned this pull request May 31, 2021
Closed
thaystg added a commit to thaystg/runtime that referenced this pull request Jun 1, 2021
@thaystg
Merge remote-tracking branch 'upstream/main' into thays_remove_mini_w…
c4bf8fc 
…asm_debugger_and_use_debugger_agent

* upstream/main: (597 commits)
  Fix42292 (dotnet#52463)
  [mono] Remove some obsolete emscripten flags. (dotnet#53486)
  Fixed path to projects (dotnet#53435)
  support ServerCertificateContext in quic (dotnet#53175)
  Socket: delete unix local endpoint filename on Close (dotnet#52103)
  [mono] Fix sgen_gc_info.memory_load_bytes (dotnet#53364)
  Refactor MsQuic's native IP address types. (dotnet#53461)
  Re-enabled optimizations for gtFoldExprConst (dotnet#53347)
  Add diagnostic support into sample app and AppBuilders on Mono. (dotnet#53361)
  Fix issues with virtuals and mdarrays (dotnet#53400)
  Split Variant marshalling tests (dotnet#53035)
  Update clrjit.natvis to cover GT_SIMD and GT_HWINTRINSIC (dotnet#53470)
  remove WSL checks in tests (dotnet#53475)
  Always spawn message loop thread for SystemEvents (dotnet#53467)
  add AcceptAsync cancellation overloads (dotnet#53340)
  Remove unnecessary reference to iOS workload pack in the Mono workload (dotnet#53425)
  Add CookieContainer.GetAllCookies (dotnet#53441)
  Remove DynamicallyAccessedMembers on JsonSerializer  (dotnet#53235)
  [wasm] Re-enable Wasm.Build.Tests (dotnet#53433)
  [libraries] Move library tests Feature Switches defaults to Functional tests (dotnet#53253)
  ...
@AustinWise AustinWise mentioned this pull request Jun 12, 2021
Merged
ManickaP pushed a commit that referenced this pull request Jun 14, 2021
@AustinWise
Remove allocation from MsQuicAddressHelpers.IPEndPointToINet (#54095)
af5c238 
Assuming that GetAddressBytes() does not have side effects, this call
should not be needed.

Clean up from #53461
@ghost ghost locked as resolved and limited conversation to collaborators Jun 30, 2021
@karelz karelz added this to the 6.0.0 milestone Jul 15, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@geoffkizer geoffkizer geoffkizer left review comments

@stephentoub stephentoub stephentoub approved these changes

@wfurt wfurt wfurt approved these changes

@CertifiedRice CertifiedRice CertifiedRice approved these changes

Assignees
No one assigned
Labels
area-System.Net
Projects
None yet
Milestone
6.0.0
Development

Successfully merging this pull request may close these issues.
6 participants
@teo-tsirpanis @stephentoub @geoffkizer @wfurt @CertifiedRice @karelz