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

Jump to bottom

runtime/coverage: covcounters not written in -buildmode=c-shared #64371

Open
1 task done
spacewander opened this issue Nov 24, 2023 · 5 comments
Open
1 task done

runtime/coverage: covcounters not written in -buildmode=c-shared #64371

spacewander opened this issue Nov 24, 2023 · 5 comments
Assignees
@thanm
Labels
compiler/runtime Issues related to the Go compiler and/or runtime. NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one.
Milestone
Backlog

Comments

@spacewander
Copy link
Contributor

Go version

go version go1.21.4 linux/arm64

Reproducibility

  • Does this issue reproduce with the latest release?

What operating system and processor architecture are you using (go env)?

GO111MODULE=''
GOARCH='arm64'
GOBIN=''
GOCACHE='/root/.cache/go-build'
GOENV='/root/.config/go/env'
GOEXE=''
GOEXPERIMENT=''
GOFLAGS=''
GOHOSTARCH='arm64'
GOHOSTOS='linux'
GOINSECURE=''
GOMODCACHE='/go/pkg/mod'
GONOPROXY=''
GONOSUMDB=''
GOOS='linux'
GOPATH='/go'
GOPRIVATE=''
GOPROXY='https://goproxy.cn'
GOROOT='/usr/local/go'
GOSUMDB='sum.golang.org'
GOTMPDIR=''
GOTOOLCHAIN='local'
GOTOOLDIR='/usr/local/go/pkg/tool/linux_arm64'
GOVCS=''
GOVERSION='go1.21.4'
GCCGO='gccgo'
AR='ar'
CC='gcc'
CXX='g++'
CGO_ENABLED='1'
GOMOD='/go/src/mosn.io/moe/go.mod'
GOWORK=''
CGO_CFLAGS='-O2 -g'
CGO_CPPFLAGS=''
CGO_CXXFLAGS='-O2 -g'
CGO_FFLAGS='-O2 -g'
CGO_LDFLAGS='-O2 -g'
PKG_CONFIG='pkg-config'
GOGCCFLAGS='-fPIC -pthread -Wl,--no-gc-sections -fmessage-length=0 -ffile-prefix-map=/tmp/go-build681226605=/tmp/go-build -gno-record-gcc-switches'

What did you do?

  1. built Go program into a shared library by using CGO_ENABLED=1 go build -cover --buildmode=c-shared -o libgolang.so.
  2. Run a process with env variable GOCOVERDIR set, the process will load the libgolang.so.
  3. The process exited.
  4. I checked the GOCOVERDIR, only covmeta file is generated.

What did you expect to see?

Both covmeta and covcounters file should be generated.

What did you see instead?

Only covmeta file is generated.
Look like when Go code runs as a shared library, the covcounters file is not flushed when the host process exits.

Currently, I work around this by calling coverage.WriteCounters manually.
@seankhliao seankhliao changed the title go build -cover: doesn't work when --buildmode=c-shared runtime/coverage: covcounters not written in -buildmode=c-shared Nov 24, 2023
@dmitshur
Copy link
Contributor

CC @thanm.

@dmitshur dmitshur added NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. compiler/runtime Issues related to the Go compiler and/or runtime. labels Nov 27, 2023
@dmitshur dmitshur added this to the Backlog milestone Nov 27, 2023
@thanm thanm self-assigned this Nov 27, 2023
@thanm thanm added the WaitingForInfo Issue is not actionable because of missing required information, which needs to be provided. label Nov 27, 2023
@thanm
Copy link
Contributor

thanm commented Nov 27, 2023

Thanks for the report.

If you could please post a complete example, that would be helpful. In particular, does your example program invoke os.Exit() when it terminates?

@spacewander
Copy link
Contributor Author

does your example program invoke os.Exit() when it terminates?

No, it can't. The program loads the Go shared library is a C++ program, so it won't invoke os.Exit() when it terminates.

If you could please post a complete example, that would be helpful.

It is a Go plugin running inside Envoy: https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/golang_filter.html#golang.

It would require knowledge about Envoy (a network proxy) to run the example. I am glad to give you help if you need.

@thanm
Copy link
Contributor

thanm commented Nov 28, 2023

No, it can't. The program loads the Go shared library is a C++ program, so it won't invoke os.Exit() when it terminates.

Thanks for that.

Given that the Go code is running as a plugin of some sort and is only invoked at the behest of the main process, and isn't being notified when the program terminates, how exactly would you imagine it would be possible to write out coverage counters?

Unless the Go runtime within the plugin has some idea that the program is complete, it doesn't seem as though there's much the runtime can do. I think this is a case where it needs a bit of help from the main program, would you not agree?

@spacewander
Copy link
Contributor Author

No, it can't. The program loads the Go shared library is a C++ program, so it won't invoke os.Exit() when it terminates.

Thanks for that.

Given that the Go code is running as a plugin of some sort and is only invoked at the behest of the main process, and isn't being notified when the program terminates, how exactly would you imagine it would be possible to write out coverage counters?

Unless the Go runtime within the plugin has some idea that the program is complete, it doesn't seem as though there's much the runtime can do. I think this is a case where it needs a bit of help from the main program, would you not agree?

Thanks for your reply.
Is it possible that Go can register something like atexit or add hook to dlclose, so that when the program is gone, the Go code can be noticed and flush the counter?

@spacewander spacewander mentioned this issue Jan 5, 2024
Closed
@seankhliao seankhliao removed the WaitingForInfo Issue is not actionable because of missing required information, which needs to be provided. label Jan 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@thanm thanm

Labels
compiler/runtime Issues related to the Go compiler and/or runtime. NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one.
Projects
Go Compiler / Runtime
Status: Todo
Milestone
Backlog
Development

No branches or pull requests
4 participants
@dmitshur @spacewander @seankhliao @thanm