1
0
mirror of https://github.com/golang/go synced 2024-11-25 19:37:58 -07:00
go/src
Michael Pratt beaf7f3282 os: overhaul handling of PID vs pidfd within Process
There are several issues with pidfd handling today:

* The zero value of a Process makes the handle field appear valid, so
  methods attempt to use it as a pidfd rather than falling back to the
  PID as they should (#67634).

* If a process doesn't exist, FindProcess returns a Process with Pid ==
  -2, which is not a compatible change (#67640).

* pidfd close is racy as-is. A Release call or successful Wait will
  clear the handle field and close the pidfd. However, a concurrent call
  may have already loaded the handle field and could then proceed to use
  the closed FD (which could have been reopened as a different pidfd,
  targeting a different process) (#67641).

This CL performs multiple structural changes to the internals of
Process.

First and foremost, each method is refactored to clearly select either
pidfd or raw pid mode. Previously, raw pid mode was structured as a
fallback when pidfd mode is unavailable. This works fine, but it does
not make it clear that a given Process object either always uses pidfd
or always uses raw pid. Since each mode needs to handle different race
conditions, it helps to make it clear that we can't switch between modes
within a single Process object.

Second, pidfd close safety is handled by reference counting uses of the
FD. The last user of the FD will close the FD. For example, this means
that with concurrent Release and Signal, the Signal call may be the one
to close the FD. This is the bulk of this CL, though I find the end
result makes the overall implementation easier to reason about.

Third, the PID path handles a similar race condtion between Wait and
Kill: Wait frees the PID value in the kernel, which could be reallocated
causing Kill to target the wrong process. This is handled with a done
flag and a mutex. The done flag now shares the same state field used for
the handle.

Similarly, the Windows implementation reuses all of the handle reference
counting that Linux uses. This means the implementations more
consistent, and make Windows safe against the same handle reuse
problems. (Though I am unsure if Windows ever reuses handles).

Wait has a slight behavior change on Windows: previously Wait after
Release or an earlier Wait would hang indefinitely (WaitForSingleObject
on syscall.InvalidHandle waits indefinitely). Now it returns the same
errors as Linux (EINVAL and ErrProcessDone, respectively).

Similarly, Release on Windows no longer returns close errors, as it may
not actually be the place where the close occurs.

Fixes #67634.
Fixes #67640.
Fixes #67641.
Updates #67642.

Cq-Include-Trybots: luci.golang.try:gotip-linux-amd64-longtest,gotip-windows-amd64-longtest
Change-Id: I2ad998f7b67d32031e6f870e8533dbd55d3c3d10
Reviewed-on: https://go-review.googlesource.com/c/go/+/588675
Reviewed-by: Austin Clements <austin@google.com>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
2024-06-10 22:06:47 +00:00
..
archive archive/zip: fix UncompressedSize godoc 2024-05-28 21:41:09 +00:00
arena
bufio
builtin
bytes all: document legacy //go:linkname for final round of modules 2024-05-29 17:58:53 +00:00
cmd cmd/compile/internal/ssa: fix DWARF location expr for .closureptr 2024-06-10 19:44:43 +00:00
cmp
compress
container
context
crypto net/http: check GetConfigForClient in server.ServeTLS 2024-06-07 17:57:01 +00:00
database/sql all: document legacy //go:linkname for final round of modules 2024-05-29 17:58:53 +00:00
debug all: document legacy //go:linkname for final round of modules 2024-05-29 17:58:53 +00:00
embed embed: simplify the code 2024-05-20 19:42:51 +00:00
encoding std: fix calls to Printf(s) with non-constant s 2024-05-23 18:42:28 +00:00
errors errors: change interface{} to any in comment 2024-05-24 17:13:04 +00:00
expvar
flag flag: replace sort.Slice with slices.SortFunc 2024-05-07 18:38:24 +00:00
fmt all: change from sort functions to slices functions where feasible 2024-05-23 01:00:11 +00:00
go all: make function comments match function names 2024-06-03 14:56:25 +00:00
hash all: make function comments match function names 2024-06-03 14:56:25 +00:00
html html: update jstmpllitinterp doc 2024-05-22 18:04:29 +00:00
image all: make function comments match function names 2024-06-03 14:56:25 +00:00
index/suffixarray all: change from sort functions to slices functions where feasible 2024-05-23 01:00:11 +00:00
internal all: make function comments match function names 2024-06-03 14:56:25 +00:00
io all: change from sort functions to slices functions where feasible 2024-05-23 01:00:11 +00:00
iter iter: don't iterate if stop is called before next on Pull 2024-06-07 19:09:28 +00:00
log log/slog: handle times with undefined UnixNanos 2024-05-16 16:12:08 +00:00
maps maps: slightly improve iter tests 2024-05-23 03:44:19 +00:00
math math/big: better doc string for Float.Copy, add example test 2024-06-06 15:46:54 +00:00
mime all: document legacy //go:linkname for final round of modules 2024-05-29 17:58:53 +00:00
net net/http: check GetConfigForClient in server.ServeTLS 2024-06-07 17:57:01 +00:00
os os: overhaul handling of PID vs pidfd within Process 2024-06-10 22:06:47 +00:00
path all: change from sort functions to slices functions where feasible 2024-05-23 01:00:11 +00:00
plugin
reflect all: document legacy //go:linkname for final round of modules 2024-05-29 17:58:53 +00:00
regexp
runtime iter: propagate runtime.Goexit from iterator passed to Pull 2024-06-07 19:09:18 +00:00
slices slices: fix punctuation in the documentation of Values 2024-05-13 21:40:32 +00:00
sort
strconv strconv: use stringslite.Clone 2024-05-05 00:24:26 +00:00
strings strings: move Clone to stringslite 2024-05-04 01:23:42 +00:00
structs cmd/compile: add structs.HostLayout 2024-05-20 21:19:39 +00:00
sync sync: include links to the Go memory model in package documentation 2024-06-07 21:14:51 +00:00
syscall syscall: rm go:linkname from origRlimitNofile 2024-06-07 20:13:57 +00:00
testdata
testing cmd/go,testdeps: move import of internal/coverage/cfile to testmain 2024-05-23 14:01:23 +00:00
text text/template: clarify error when too few or too many return values 2024-05-24 22:23:55 +00:00
time time: time/internal_test.go remove redundant type conversion 2024-06-03 14:56:37 +00:00
unicode
unique internal/concurrent: make HashTrieMap iteration more idiomatic 2024-05-22 16:01:55 +00:00
unsafe unsafe: document the behavior of Sizeof on an interface 2024-05-21 19:45:20 +00:00
vendor all: update vendored dependencies 2024-06-04 16:19:04 +00:00
all.bash
all.bat
all.rc
bootstrap.bash
buildall.bash
clean.bash
clean.bat
clean.rc
cmp.bash
go.mod all: update vendored dependencies 2024-06-04 16:19:04 +00:00
go.sum all: update vendored dependencies 2024-06-04 16:19:04 +00:00
make.bash make.bash: preserve GOROOT_BOOTSTRAP 2024-05-29 13:48:46 +00:00
make.bat
Make.dist
make.rc make.bash: preserve GOROOT_BOOTSTRAP 2024-05-29 13:48:46 +00:00
race.bash
race.bat
README.vendor
run.bash run.bash: rm bumping open files soft limit 2024-05-15 15:02:23 +00:00
run.bat
run.rc

Vendoring in std and cmd
========================

The Go command maintains copies of external packages needed by the
standard library in the src/vendor and src/cmd/vendor directories.

There are two modules, std and cmd, defined in src/go.mod and
src/cmd/go.mod. When a package outside std or cmd is imported
by a package inside std or cmd, the import path is interpreted
as if it had a "vendor/" prefix. For example, within "crypto/tls",
an import of "golang.org/x/crypto/cryptobyte" resolves to
"vendor/golang.org/x/crypto/cryptobyte". When a package with the
same path is imported from a package outside std or cmd, it will
be resolved normally. Consequently, a binary may be built with two
copies of a package at different versions if the package is
imported normally and vendored by the standard library.

Vendored packages are internally renamed with a "vendor/" prefix
to preserve the invariant that all packages have distinct paths.
This is necessary to avoid compiler and linker conflicts. Adding
a "vendor/" prefix also maintains the invariant that standard
library packages begin with a dotless path element.

The module requirements of std and cmd do not influence version
selection in other modules. They are only considered when running
module commands like 'go get' and 'go mod vendor' from a directory
in GOROOT/src.

Maintaining vendor directories
==============================

Before updating vendor directories, ensure that module mode is enabled.
Make sure that GO111MODULE is not set in the environment, or that it is
set to 'on' or 'auto', and if you use a go.work file, set GOWORK=off.

Requirements may be added, updated, and removed with 'go get'.
The vendor directory may be updated with 'go mod vendor'.
A typical sequence might be:

    cd src  # or src/cmd
    go get golang.org/x/net@master
    go mod tidy
    go mod vendor

Use caution when passing '-u' to 'go get'. The '-u' flag updates
modules providing all transitively imported packages, not only
the module providing the target package.

Note that 'go mod vendor' only copies packages that are transitively
imported by packages in the current module. If a new package is needed,
it should be imported before running 'go mod vendor'.