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

Equals/GetHashCode for UnixDomainSocketEndPoint #69722

Merged
merged 8 commits into from
Jun 8, 2022
Merged

Equals/GetHashCode for UnixDomainSocketEndPoint #69722

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
afc0431
Added impl of Equals/GetHashCode for UnixDomainSocketEP
sakno May 24, 2022
b308d73
Fixed typo
sakno May 25, 2022
90ddb6f
Fixed missing underscore
sakno May 25, 2022
1d1b9c2
Clarify new fields using comments
sakno May 25, 2022
0fde07a
Review feedback
sakno May 31, 2022
7e3d6ee
Review feedback
sakno May 31, 2022
843405e
Added platform verification
sakno Jun 7, 2022
6b25d4f
Fixed sporadic test failure due to hashcode collision
sakno Jun 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions src/libraries/System.Net.Sockets/src/System/Net/Sockets/UnixDomainSocketEndPoint.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
// The .NET Foundation licenses this file to you under the MIT license.

using System.Diagnostics;
using System.Diagnostics.CodeAnalysis;
using System.Text;
using System.IO;

Expand Down Expand Up @@ -124,12 +125,23 @@ public override string ToString()
}
}

public override bool Equals([NotNullWhen(true)] object? obj)
=> obj is UnixDomainSocketEndPoint ep && MemoryExtensions.SequenceEqual<byte>(_encodedPath, ep._encodedPath);

public override int GetHashCode()
{
HashCode hash = default;
hash.AddBytes(_encodedPath);
return hash.ToHashCode();
}

internal UnixDomainSocketEndPoint CreateBoundEndPoint()
{
if (IsAbstract(_path))
{
return this;
}

return new UnixDomainSocketEndPoint(_path, Path.GetFullPath(_path));
}

Expand All @@ -139,6 +151,7 @@ internal UnixDomainSocketEndPoint CreateUnboundEndPoint()
{
return this;
}

return new UnixDomainSocketEndPoint(_path, null);
}

Expand Down
37 changes: 37 additions & 0 deletions src/libraries/System.Net.Sockets/tests/FunctionalTests/UnixDomainSocketTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -518,6 +518,43 @@ public void UnixDomainSocketEndPoint_RelativePathDeletesFile()
}).Dispose();
}

[Fact]
public void AbstractPathEquality()
{
string abstractPath = '\0' + Guid.NewGuid().ToString();
UnixDomainSocketEndPoint endPoint1 = new(abstractPath);
UnixDomainSocketEndPoint endPoint2 = new(abstractPath);
UnixDomainSocketEndPoint endPoint3 = new('\0' + Guid.NewGuid().ToString());

Assert.Equal(endPoint1, endPoint2);
Assert.Equal(endPoint1.GetHashCode(), endPoint2.GetHashCode());

Assert.NotEqual(endPoint1, endPoint3);
Assert.NotEqual(endPoint2, endPoint3);
Assert.NotEqual(endPoint1.GetHashCode(), endPoint3.GetHashCode());
Assert.NotEqual(endPoint2.GetHashCode(), endPoint3.GetHashCode());
Copy link
Member

Choose a reason for hiding this comment

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

These hashcode NotEqual asserts could sporadically fail. It should be exceedingly rare, but better to remove them. We could instead assert that the endpoint hashcode equals the path hashcode, and leave the correctness of the path hashcode up to string's implementation.

Same for the test below.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Because of hash code collision.. hmm, makes sense. I would prefer just to remove NotEqual assertions.

}

[Fact]
public void FilePathEquality()
{
string path1 = "relative" + Path.DirectorySeparatorChar + "path";
string path2 = new(path1); // make a copy to avoid reference equality
string path3 = GetRandomNonExistingFilePath();

UnixDomainSocketEndPoint endPoint1 = new(path1);
UnixDomainSocketEndPoint endPoint2 = new(path2);
UnixDomainSocketEndPoint endPoint3 = new(path3);

Assert.Equal(endPoint1, endPoint2);
Assert.Equal(endPoint1.GetHashCode(), endPoint2.GetHashCode());

Assert.NotEqual(endPoint1, endPoint3);
Assert.NotEqual(endPoint2, endPoint3);
Assert.NotEqual(endPoint1.GetHashCode(), endPoint3.GetHashCode());
Assert.NotEqual(endPoint2.GetHashCode(), endPoint3.GetHashCode());
}

private static string GetRandomNonExistingFilePath()
{
string result;
Expand Down