gopls/internal/lsp/cache: fix two crashes when parsed file overflows

This change fixes two crashes discovered related to the parse cache.

Fix 1 is an off-by-one error when re-parsing the first file in the parse
cache: the minimum permitted base value for a token.File is 1, yet we
were using 0 to compute the actual size used by parsing. As a result, we
violated the assertion that re-parsing left us exactly where we expected
to be.

Fix 2 is a fix for the case where a parse function is cancelled before
its value can be used. In this case, because we were closing over the
fileset (which is mutated by every parse), we were overflowing the
allocated space even though parsing had no errors. Oops!

Additionally add more instrumentation for parsing fixes, and include
more information in the panic message when parsing does not match its
allocated space (though I think I've found all the bugs now.)

While instrumenting this additional information, I observed inaccuracies
in the ParsedGoFile.Fixed field, which was undocumented and mostly
unused (though we should probably use it in several places where we
correlate positions back to the source). Fixed was only set in some
places where the AST was fixed, and did not reflect Src fixes. I've
split this field into FixedSrc and FixedAST, with clearer meanings, so
that we can hopefully interpret it correctly in the future.

Fixes golang/go#59097

Change-Id: I85e03dcd9587ee43af728957b34ab69ce40b413d
Reviewed-on: https://go-review.googlesource.com/c/tools/+/477315
Run-TryBot: Robert Findley <rfindley@google.com>
Reviewed-by: Alan Donovan <adonovan@google.com>
TryBot-Result: Gopher Robot <gobot@golang.org>
gopls-CI: kokoro <noreply+kokoro@google.com>
5 files changed
tree: 02364f0c34dc44703c39430cf8ad09d90e8549e4
  1. benchmark/
  2. blog/
  3. cmd/
  4. container/
  5. copyright/
  6. cover/
  7. go/
  8. godoc/
  9. gopls/
  10. imports/
  11. internal/
  12. playground/
  13. present/
  14. refactor/
  15. txtar/
  16. .gitattributes
  17. .gitignore
  18. .prettierrc
  19. codereview.cfg
  20. CONTRIBUTING.md
  21. go.mod
  22. go.sum
  23. LICENSE
  24. PATENTS
  25. README.md
README.md

Go Tools

PkgGoDev

This repository provides the golang.org/x/tools module, comprising various tools and packages mostly for static analysis of Go programs, some of which are listed below. Use the “Go reference” link above for more information about any package.

It also contains the golang.org/x/tools/gopls module, whose root package is a language-server protocol (LSP) server for Go. An LSP server analyses the source code of a project and responds to requests from a wide range of editors such as VSCode and Vim, allowing them to support IDE-like functionality.

Selected commands:

  • cmd/goimports formats a Go program like go fmt and additionally inserts import statements for any packages required by the file after it is edited.
  • cmd/callgraph prints the call graph of a Go program.
  • cmd/digraph is a utility for manipulating directed graphs in textual notation.
  • cmd/stringer generates declarations (including a String method) for “enum” types.
  • cmd/toolstash is a utility to simplify working with multiple versions of the Go toolchain.

These commands may be fetched with a command such as

go install golang.org/x/tools/cmd/goimports@latest

Selected packages:

  • go/ssa provides a static single-assignment form (SSA) intermediate representation (IR) for Go programs, similar to a typical compiler, for use by analysis tools.

  • go/packages provides a simple interface for loading, parsing, and type checking a complete Go program from source code.

  • go/analysis provides a framework for modular static analysis of Go programs.

  • go/callgraph provides call graphs of Go programs using a variety of algorithms with different trade-offs.

  • go/ast/inspector provides an optimized means of traversing a Go parse tree for use in analysis tools.

  • go/cfg provides a simple control-flow graph (CFG) for a Go function.

  • go/expect reads Go source files used as test inputs and interprets special comments within them as queries or assertions for testing.

  • go/gcexportdata and go/gccgoexportdata read and write the binary files containing type information used by the standard and gccgo compilers.

  • go/types/objectpath provides a stable naming scheme for named entities (“objects”) in the go/types API.

Numerous other packages provide more esoteric functionality.

Contributing

This repository uses Gerrit for code changes. To learn how to submit changes, see https://golang.org/doc/contribute.html.

The main issue tracker for the tools repository is located at https://github.com/golang/go/issues. Prefix your issue with “x/tools/(your subdir):” in the subject line, so it is easy to find.

JavaScript and CSS Formatting

This repository uses prettier to format JS and CSS files.

The version of prettier used is 1.18.2.

It is encouraged that all JS and CSS code be run through this before submitting a change. However, it is not a strict requirement enforced by CI.