Description
Currently, the documentation says:
// Signal that the process will get when its parent dies (Linux only)
However, according to the prctl man page:
Warning: the "parent" in this case is considered to be the thread that created this process. In other words, the signal will be sent when that thread terminates (via, for example, pthread_exit(3)), rather than after all of the threads in the parent process terminate.
I got bit by this in a python program -- started a new program on one thread, and tried to wait for it on another thread, and the child process kept dying and it took awhile to figure out what was going on. While I haven't ran into it in go yet, because in go threads and goroutines aren't one to one, I imagine if one ran into this sort of bug it would only occur intermittently.
Thinking about it, it seems like a user might want to call runtime.LockOSThread when using this?
It's not clear to me whether the docs should have a larger warning in them -- but I think at the minimum the documentation should be updated to say 'parent thread' or 'parent goroutine' instead of just 'parent'.
Metadata
Assignees
Labels
Type
Projects
Status
Triage Backlog
Activity
dominikh commentedon Sep 5, 2018
If I am not mistaken, the current implementation of Go never kills threads, which is why you wouldn't be able to run into this bug in Go currently. At the same time, if Go ever does start killing threads, this might hit a lot of people at once.
virtuald commentedon Sep 6, 2018
Looked around a bit, looks like go 1.10+ will kill a thread if you lock it and the goroutine exits without unlocking it: #20395
Here's an example that shows that:
In that example, if
-deathis passed as an argument the program will immediately exit. Obviously, you have to go out of your way to trigger this behavior, but presumably someone who is messing with platform-specific behavior is going to want to know about platform-specific behaviors... thus why the docs should at least hint that this is possible.virtuald commentedon Oct 22, 2020
Circling back to this, I did eventually figure out the right way to use Pdeathsig, and I think the documentation should include some examples or discussion about this.
Here's an example of what people usually want to do when using Pdeathsig -- ensure the child dies when the parent dies. This example ensures that golang won't accidentally kill the OS thread associated with the child process.
gopherbot commentedon Jun 14, 2022
Change https://go.dev/cl/412114 mentions this issue:
syscall: clarify Pdeathsig documentation on Linux17 remaining items
Lock OS threads when exec'ing with Pdeathsig
run: ensure task process is killed when baur terminates on linux & fr…
run: ensure task process is killed when baur terminates
run: ensure task process is killed when baur terminates
Safeguard pdeathsig usage in shim w/ os thread lock.
Safeguard pdeathsig usage in shim w/ os thread lock. (#4886)
Fix a potential bug in linux involving pdeathsig killing children early
Lock OS threads when exec'ing with Pdeathsig