| commit | 2be9d05fe891b194b2e099acbf48899748e292cc | [log] [tgz] |
|---|---|---|
| author | Alan Donovan <adonovan@google.com> | Wed Dec 21 17:20:25 2022 -0500 |
| committer | Alan Donovan <adonovan@google.com> | Tue Jan 10 16:18:27 2023 +0000 |
| tree | f753197651f137c14b3923467fbcfeb14693f0a9 | |
| parent | 0362ceaa744fa1e5e2bf167ac785c67dbbb1c953 [diff] |
gopls/internal/lsp/source/xrefs: a new reference index This change defines a new, serializable cross-reference index that is constructed immediately after type checking. In due course it will be saved in the filecache alongside the other results of type-checking, such as export data, but for now it is simply hung off the cache.pkg. The index for a package P is a gob-encoded mapping from each of P's dependencies Q to the set of objects in Q that are referenced by P, along with the location of the reference. Q's objects are identified by (PackagePath, objectpath.Path). At query time, in-package references to an object are sought by type-checking its declaring package (and variants), and using the TypesInfo.Defs/Uses. Cross-package references are sought in the serialized index of each reverse dependency: direct for package-level objects, transitive for selections. Currently we don't have an incremental implementation of the "implements" algorithm (though we know what to do; see CL 452060). This algorithm is used by "references" when the query object is a method. For now, we fall back to the old implementation, rather than bite off too much in this CL. This is another step towards an incremental, scalable gopls that doesn't require holding the result of type-checking the entire workspace in memory. That said, at this stage this change is only costs. Using a large 'references' query in k8s as a benchmark, it adds about about 30MB of additional heap for the indexes, and about 10% of the command's CPU is spent building the index. (Lookup is cheap: <0.5% of CPU.) But these costs are modest relative to the existing large costs (>1GB, >22s) of this operation. Also, add missing test coverage of implicits (ImportSpec, type switch). Change-Id: I648607bab58e26e24bc99b276ffabc38db48eb09 Reviewed-on: https://go-review.googlesource.com/c/tools/+/458998 Reviewed-by: Robert Findley <rfindley@google.com> gopls-CI: kokoro <noreply+kokoro@google.com> Run-TryBot: Alan Donovan <adonovan@google.com> TryBot-Result: Gopher Robot <gobot@golang.org>
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.
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.
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.