-
Notifications
You must be signed in to change notification settings - Fork 442
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
Return a meaningful reattach error for non-existent pids on Windows #125
Merged
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
This fix causes no change in behavior on Unix systems, and only affects the error return type from reattach() when the reattach data provided has a non-existent pid on Windows. With this change in place, reattach() will now consistently return ErrProcessNotFound on both Windows and Unix systems when the process is indeed not found. I encountered this while writing a Windows Nomad Task Driver plugin, here's more context from the Nomad perspective: The Reattach info Nomad stores can get stale, whereby the pid no longer refers to a live process. This has happened to me regularly (but not always) when troubleshooting plugin development as I'm testingn what happens when Nomad is forcefully killed and restarted. On Windows, when the go-plugin code calls FindProcess with as stale pid, the following error is always returned: os.SyscallError - 'OpenProcess: the paremter is incorrect' On Unix systems, FindProcess never returns an error, at least as presently defined in the go source code. In order for Nomad to recognize this condition we need to bubble up the ErrProcesNotFound error, with which we can then futher propogate the SingletonPluginExited error from singleton.go. With these changes in place, whenever a stale pid is found in the Reattach info, Nomad now properly restarts the plugin exe.
notnoop
reviewed
Oct 4, 2019
return nil, err | ||
// On Unix systems, FindProcess never returns an error. | ||
// On Windows, for non-existent pids it returns: | ||
// os.SyscallError - 'OpenProcess: the paremter is incorrect' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for catching - in a similar logs, I noticed the formatting was a bit different:
// os.SyscallError - 'OpenProcess: The parameter is incorrect'
notnoop
approved these changes
Oct 4, 2019
Thanks you @lachlanorr so much - I'll follow up with maintainers to get this PR merged. |
notnoop
pushed a commit
to hashicorp/nomad
that referenced
this pull request
Oct 4, 2019
Upgrade go-plugin to latest to pick up Windows fix in hashicorp/go-plugin#125 .
notnoop
pushed a commit
to hashicorp/nomad
that referenced
this pull request
Oct 4, 2019
Upgrade go-plugin to latest to pick up Windows fix in hashicorp/go-plugin#125 .
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.
This fix causes no change in behavior on Unix systems, and only
affects the error return type from reattach() when the reattach data
provided has a non-existent pid on Windows.
With this change in place, reattach() will now consistently return
ErrProcessNotFound on both Windows and Unix systems when the process
is indeed not found.
I encountered this while writing a Windows Nomad Task Driver plugin,
here's more context from the Nomad perspective:
The Reattach info Nomad stores can get stale, whereby the pid no
longer refers to a live process.
This has happened to me regularly (but not always) when
troubleshooting plugin development as I'm testingn what happens when
Nomad is forcefully killed and restarted.
On Windows, when the go-plugin code calls FindProcess with as stale
pid, the following error is always returned:
os.SyscallError - 'OpenProcess: the paremter is incorrect'
On Unix systems, FindProcess never returns an error, at least as
presently defined in the go source code.
In order for Nomad to recognize this condition we need to bubble up
the ErrProcesNotFound error, with which we can then futher propogate
the SingletonPluginExited error from singleton.go.
With these changes in place, whenever a stale pid is found in the
Reattach info, Nomad now properly restarts the plugin exe.