internal/modindex: memoize the index parsed by Read
Read parses the entire on-disk index, which may be hundreds of
megabytes, on every call. Clients that format many files call it once
per file: imports.Process constructs a fresh ProcessEnv for each call,
so nothing can be carried over between files, and getFixesWithSource
consults the index for every file that has an unresolved reference.
CL 811860 moved that call past the early returns, so a file whose
imports are already complete no longer touches the index. A file that
does need a candidate from the module cache still causes the whole
payload to be parsed again.
Memoize the parsed index, keyed by the name of the payload file it was
read from. Payload files are immutable: write gives each one a fresh
random name and only then updates the link file to refer to it. The
name is therefore a sound cache key, an index written by another
process is picked up as soon as the link file changes, and only the
most recent index for each module cache directory is retained.
An Index may now be shared by several callers and must not be
modified. Neither caller in this repository does: build copies the
entries of the previous index into a new slice, and gopls holds the
pointer under a mutex and only ever replaces it.
goimports over 100 files that each need one import added, with a 54MB
index in the module cache:
before 12.6s
after 1.3s
and over 463 files of a real project with their imports stripped:
before 52.9s
after 13.7s
Updates golang/go#80774
Change-Id: I4dfa0f2e354af4db00c0177e1c5c84f6ab04b5c1
Reviewed-on: https://go-review.googlesource.com/c/tools/+/817520
Reviewed-by: Peter Weinberger <pjw@google.com>
LUCI-TryBot-Result: golang-scoped@luci-project-accounts.iam.gserviceaccount.com <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Reviewed-by: Hongxiang Jiang <hxjiang@golang.org>
Reviewed-by: Dmitri Shuralyov <dmitshur@google.com>
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/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://go.dev/doc/contribute.
The git repository is https://go.googlesource.com/tools.
The main issue tracker for the tools repository is located at https://go.dev/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.