give common blocking functions a clear name #2984
Open
+322
−141
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
weissi
force-pushed
the
jw-blocking-names
branch
5 times, most recently
from
cb35884
to
699bb33
Compare
Lukasa
reviewed
Nov 21, 2024
| @@ -534,14 +567,15 @@ internal enum Posix { | |||
| } | |||
|
|
|||
| @inline(never) | |||
| internal static func bind(descriptor: CInt, ptr: UnsafePointer<sockaddr>, bytes: Int) throws { | |||
| public static func bind(descriptor: CInt, ptr: UnsafePointer<sockaddr>, bytes: Int) throws { | |||
There was a problem hiding this comment.
Can we drop the changes to public here? They're very misleading.
There was a problem hiding this comment.
@Lukasa there were other, newer (for NIOFileSystem etc) functions that used public, so I thought I'd make it consistent with the other new stuff
weissi
force-pushed
the
jw-blocking-names
branch
from
699bb33
to
3fe2f8e
Compare
weissi
force-pushed
the
jw-blocking-names
branch
from
3fe2f8e
to
108fbdb
Compare
Lukasa
approved these changes
Nov 21, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation:
In many situations, for example continuous profiling with sampling profilers, it's important to distinguish between on- and off-CPU work. That's most easily done if there are clear function names/prefixes to grep for that are common places to just wait (off-CPU) and do no real work. In SwiftNIO those are chiefly three places:
EventLoopswaiting for workThe NIOThreadPoolthreads waiting for workEventLoopFuture.wait()This patch makes sure that each of those will have a function with prefix
_blockingWaitForin the function name which is easily greppable.Modifications:
_blockingWaitFor...that just wait for....Result:
SwiftNIO makes operational excellence easier and your SRE team more happy.