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.

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

x/tools/gopls: specific sequence hangs if -logfile not passed #45377

Closed
myitcv opened this issue Apr 4, 2021 · 2 comments
Closed

x/tools/gopls: specific sequence hangs if -logfile not passed #45377

myitcv opened this issue Apr 4, 2021 · 2 comments
Labels
FrozenDueToAge gopls Issues related to the Go language server, gopls. NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. Tools This label describes issues relating to any tools in the x/tools repository.

Comments

@myitcv
Copy link
Member

myitcv commented Apr 4, 2021

What version of Go are you using (go version)?

$ go version
go version devel +135c9f45ec Wed Mar 31 04:13:44 2021 +0000 linux/amd64
$ go list -m golang.org/x/tools
golang.org/x/tools v0.1.1-0.20210325171239-63ea654b4772
$ go list -m golang.org/x/tools/gopls
golang.org/x/tools/gopls v0.0.0-20210325171239-63ea654b4772

Does this issue reproduce with the latest release?

Yes

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

go env Output
$ go env
GO111MODULE="on"
GOARCH="amd64"
GOBIN=""
GOCACHE="/home/myitcv/.cache/go-build"
GOENV="/home/myitcv/.config/go/env"
GOEXE=""
GOFLAGS=""
GOHOSTARCH="amd64"
GOHOSTOS="linux"
GOINSECURE=""
GOMODCACHE="/home/myitcv/gostuff/pkg/mod"
GONOPROXY=""
GONOSUMDB=""
GOOS="linux"
GOPATH="/home/myitcv/gostuff"
GOPRIVATE=""
GOPROXY="https://proxy.golang.org,direct"
GOROOT="/home/myitcv/gos"
GOSUMDB="sum.golang.org"
GOTMPDIR=""
GOTOOLDIR="/home/myitcv/gos/pkg/tool/linux_amd64"
GOVCS=""
GOVERSION="devel +135c9f45ec Wed Mar 31 04:13:44 2021 +0000"
GCCGO="gccgo"
AR="ar"
CC="gcc"
CXX="g++"
CGO_ENABLED="1"
GOMOD="/home/myitcv/gostuff/src/github.com/myitcv/govim/go.mod"
CGO_CFLAGS="-g -O2"
CGO_CPPFLAGS=""
CGO_CXXFLAGS="-g -O2"
CGO_FFLAGS="-g -O2"
CGO_LDFLAGS="-g -O2"
PKG_CONFIG="pkg-config"
GOGCCFLAGS="-fPIC -m64 -pthread -fmessage-length=0 -fdebug-prefix-map=/tmp/go-build3061377610=/tmp/go-build -gno-record-gcc-switches"

What did you do?

The following sequence, run with govim, succeeds if a -logfile flag is passed to gopls:

  • Open govim
  • Trigger workspace symbol search for cue.Value.Fill
  • Open file that contains definition for cue.Value.Fill
  • Exit

The logfile is as follows: good.log

However, that same sequence appears to hang gopls if the -logfile flag is not passed.

What did you expect to see?

gopls behaving the same (modulo logging) in both cases.

What did you see instead?

An apparently "stuck" gopls instance.

cc @stamblerre

FYI @leitzler
@myitcv myitcv added NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. gopls Issues related to the Go language server, gopls. labels Apr 4, 2021
@gopherbot gopherbot added the Tools This label describes issues relating to any tools in the x/tools repository. label Apr 4, 2021
@gopherbot gopherbot added this to the Unreleased milestone Apr 4, 2021
myitcv added a commit to govim/govim that referenced this issue Apr 4, 2021
@myitcv
cmd/govim: workaround golang/go#45377
3cebd4c 
Workaround golang/go#45377 by having gopls log to os.DevNull in case we
don't need gopls logging from a govim perspective.
@myitcv myitcv mentioned this issue Apr 4, 2021
Merged
myitcv added a commit to govim/govim that referenced this issue Apr 4, 2021
@myitcv
cmd/govim: workaround golang/go#45377 (#1072)
51015a9 
Workaround golang/go#45377 by having gopls log to os.DevNull in case we
don't need gopls logging from a govim perspective.
@stamblerre
Copy link
Contributor

stamblerre commented Apr 4, 2021 •
edited

When gopls hangs, can you send kill -SIGABRT <pid> to get the stack trace and see where it's stuck?

@myitcv
Copy link
Member Author

myitcv commented Apr 5, 2021

Rather embarrassingly (although perhaps not surprisingly) this is an error on the govim side. Without a -logfile flag, gopls logs to stderr. We relay gopls' stderr to the govim log file, using a bufio.Scanner. And that was the cause of the issue: the scanner was failing on a long line (notice the file in question above is relatively large)... but this error was not being reported in govim's log file. So this manifested as a gopls "hang" - but that was because the reading go routine on the govim side had crashed (ultimately debugged by comparing stack dumps of govim).

Apologies for the noise.

@myitcv myitcv closed this as completed Apr 5, 2021
@stamblerre stamblerre removed this from the Unreleased milestone Apr 5, 2021
@golang golang locked and limited conversation to collaborators Apr 5, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
FrozenDueToAge gopls Issues related to the Go language server, gopls. NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. Tools This label describes issues relating to any tools in the x/tools repository.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@myitcv @stamblerre @gopherbot