internal/lsp/cache: use persistent map for storing files in the snapshot
This on average reduces latency from 34ms to 25ms on internal codebase.
Updates golang/go#45686
Change-Id: I57b05e5679620d8481b1f1a051645cf1cc00aca5
Reviewed-on: https://go-review.googlesource.com/c/tools/+/413654
TryBot-Result: Gopher Robot <gobot@golang.org>
Reviewed-by: Robert Findley <rfindley@google.com>
gopls-CI: kokoro <noreply+kokoro@google.com>
Reviewed-by: Alan Donovan <adonovan@google.com>
Run-TryBot: Alan Donovan <adonovan@google.com>
diff --git a/internal/lsp/cache/maps.go b/internal/lsp/cache/maps.go
index 70f8039..cad4465 100644
--- a/internal/lsp/cache/maps.go
+++ b/internal/lsp/cache/maps.go
@@ -5,18 +5,63 @@
package cache
import (
+ "golang.org/x/tools/internal/lsp/source"
"golang.org/x/tools/internal/persistent"
"golang.org/x/tools/internal/span"
)
// TODO(euroelessar): Use generics once support for go1.17 is dropped.
+type filesMap struct {
+ impl *persistent.Map
+}
+
+func newFilesMap() filesMap {
+ return filesMap{
+ impl: persistent.NewMap(func(a, b interface{}) bool {
+ return a.(span.URI) < b.(span.URI)
+ }),
+ }
+}
+
+func (m filesMap) Clone() filesMap {
+ return filesMap{
+ impl: m.impl.Clone(),
+ }
+}
+
+func (m filesMap) Destroy() {
+ m.impl.Destroy()
+}
+
+func (m filesMap) Load(key span.URI) (source.VersionedFileHandle, bool) {
+ value, ok := m.impl.Load(key)
+ if !ok {
+ return nil, false
+ }
+ return value.(source.VersionedFileHandle), true
+}
+
+func (m filesMap) Range(do func(key span.URI, value source.VersionedFileHandle)) {
+ m.impl.Range(func(key, value interface{}) {
+ do(key.(span.URI), value.(source.VersionedFileHandle))
+ })
+}
+
+func (m filesMap) Store(key span.URI, value source.VersionedFileHandle) {
+ m.impl.Store(key, value, nil)
+}
+
+func (m filesMap) Delete(key span.URI) {
+ m.impl.Delete(key)
+}
+
type goFilesMap struct {
impl *persistent.Map
}
-func newGoFilesMap() *goFilesMap {
- return &goFilesMap{
+func newGoFilesMap() goFilesMap {
+ return goFilesMap{
impl: persistent.NewMap(func(a, b interface{}) bool {
return parseKeyLess(a.(parseKey), b.(parseKey))
}),
@@ -33,17 +78,17 @@
return a.file.URI < b.file.URI
}
-func (m *goFilesMap) Clone() *goFilesMap {
- return &goFilesMap{
+func (m goFilesMap) Clone() goFilesMap {
+ return goFilesMap{
impl: m.impl.Clone(),
}
}
-func (m *goFilesMap) Destroy() {
+func (m goFilesMap) Destroy() {
m.impl.Destroy()
}
-func (m *goFilesMap) Load(key parseKey) (*parseGoHandle, bool) {
+func (m goFilesMap) Load(key parseKey) (*parseGoHandle, bool) {
value, ok := m.impl.Load(key)
if !ok {
return nil, false
@@ -51,19 +96,19 @@
return value.(*parseGoHandle), true
}
-func (m *goFilesMap) Range(do func(key parseKey, value *parseGoHandle)) {
+func (m goFilesMap) Range(do func(key parseKey, value *parseGoHandle)) {
m.impl.Range(func(key, value interface{}) {
do(key.(parseKey), value.(*parseGoHandle))
})
}
-func (m *goFilesMap) Store(key parseKey, value *parseGoHandle, release func()) {
+func (m goFilesMap) Store(key parseKey, value *parseGoHandle, release func()) {
m.impl.Store(key, value, func(key, value interface{}) {
release()
})
}
-func (m *goFilesMap) Delete(key parseKey) {
+func (m goFilesMap) Delete(key parseKey) {
m.impl.Delete(key)
}
@@ -71,25 +116,25 @@
impl *persistent.Map
}
-func newParseKeysByURIMap() *parseKeysByURIMap {
- return &parseKeysByURIMap{
+func newParseKeysByURIMap() parseKeysByURIMap {
+ return parseKeysByURIMap{
impl: persistent.NewMap(func(a, b interface{}) bool {
return a.(span.URI) < b.(span.URI)
}),
}
}
-func (m *parseKeysByURIMap) Clone() *parseKeysByURIMap {
- return &parseKeysByURIMap{
+func (m parseKeysByURIMap) Clone() parseKeysByURIMap {
+ return parseKeysByURIMap{
impl: m.impl.Clone(),
}
}
-func (m *parseKeysByURIMap) Destroy() {
+func (m parseKeysByURIMap) Destroy() {
m.impl.Destroy()
}
-func (m *parseKeysByURIMap) Load(key span.URI) ([]parseKey, bool) {
+func (m parseKeysByURIMap) Load(key span.URI) ([]parseKey, bool) {
value, ok := m.impl.Load(key)
if !ok {
return nil, false
@@ -97,16 +142,16 @@
return value.([]parseKey), true
}
-func (m *parseKeysByURIMap) Range(do func(key span.URI, value []parseKey)) {
+func (m parseKeysByURIMap) Range(do func(key span.URI, value []parseKey)) {
m.impl.Range(func(key, value interface{}) {
do(key.(span.URI), value.([]parseKey))
})
}
-func (m *parseKeysByURIMap) Store(key span.URI, value []parseKey) {
+func (m parseKeysByURIMap) Store(key span.URI, value []parseKey) {
m.impl.Store(key, value, nil)
}
-func (m *parseKeysByURIMap) Delete(key span.URI) {
+func (m parseKeysByURIMap) Delete(key span.URI) {
m.impl.Delete(key)
}
diff --git a/internal/lsp/cache/session.go b/internal/lsp/cache/session.go
index 7dbccf7..4a7a5b2 100644
--- a/internal/lsp/cache/session.go
+++ b/internal/lsp/cache/session.go
@@ -233,7 +233,7 @@
generation: s.cache.store.Generation(generationName(v, 0)),
packages: make(map[packageKey]*packageHandle),
meta: &metadataGraph{},
- files: make(map[span.URI]source.VersionedFileHandle),
+ files: newFilesMap(),
goFiles: newGoFilesMap(),
parseKeysByURI: newParseKeysByURIMap(),
symbols: make(map[span.URI]*symbolHandle),
diff --git a/internal/lsp/cache/snapshot.go b/internal/lsp/cache/snapshot.go
index b2ac782..60cf416 100644
--- a/internal/lsp/cache/snapshot.go
+++ b/internal/lsp/cache/snapshot.go
@@ -74,11 +74,11 @@
// files maps file URIs to their corresponding FileHandles.
// It may invalidated when a file's content changes.
- files map[span.URI]source.VersionedFileHandle
+ files filesMap
// goFiles maps a parseKey to its parseGoHandle.
- goFiles *goFilesMap
- parseKeysByURI *parseKeysByURIMap
+ goFiles goFilesMap
+ parseKeysByURI parseKeysByURIMap
// TODO(rfindley): consider merging this with files to reduce burden on clone.
symbols map[span.URI]*symbolHandle
@@ -136,6 +136,7 @@
func (s *snapshot) Destroy(destroyedBy string) {
s.generation.Destroy(destroyedBy)
+ s.files.Destroy()
s.goFiles.Destroy()
s.parseKeysByURI.Destroy()
}
@@ -173,11 +174,11 @@
defer s.mu.Unlock()
tmpls := map[span.URI]source.VersionedFileHandle{}
- for k, fh := range s.files {
+ s.files.Range(func(k span.URI, fh source.VersionedFileHandle) {
if s.view.FileKind(fh) == source.Tmpl {
tmpls[k] = fh
}
- }
+ })
return tmpls
}
@@ -461,27 +462,27 @@
defer s.mu.Unlock()
overlays := make(map[string][]byte)
- for uri, fh := range s.files {
+ s.files.Range(func(uri span.URI, fh source.VersionedFileHandle) {
overlay, ok := fh.(*overlay)
if !ok {
- continue
+ return
}
if overlay.saved {
- continue
+ return
}
// TODO(rstambler): Make sure not to send overlays outside of the current view.
overlays[uri.Filename()] = overlay.text
- }
+ })
return overlays
}
-func hashUnsavedOverlays(files map[span.URI]source.VersionedFileHandle) source.Hash {
+func hashUnsavedOverlays(files filesMap) source.Hash {
var unsaved []string
- for uri, fh := range files {
+ files.Range(func(uri span.URI, fh source.VersionedFileHandle) {
if overlay, ok := fh.(*overlay); ok && !overlay.saved {
unsaved = append(unsaved, uri.Filename())
}
- }
+ })
sort.Strings(unsaved)
return source.Hashf("%s", unsaved)
}
@@ -869,9 +870,9 @@
s.knownSubdirs = map[span.URI]struct{}{}
s.knownSubdirsPatternCache = ""
- for uri := range s.files {
+ s.files.Range(func(uri span.URI, fh source.VersionedFileHandle) {
s.addKnownSubdirLocked(uri, dirs)
- }
+ })
}
func (s *snapshot) getKnownSubdirs(wsDirs []span.URI) []span.URI {
@@ -957,11 +958,11 @@
s.mu.Lock()
defer s.mu.Unlock()
- for uri := range s.files {
+ s.files.Range(func(uri span.URI, fh source.VersionedFileHandle) {
if source.InDir(dir.Filename(), uri.Filename()) {
files = append(files, uri)
}
- }
+ })
return files
}
@@ -1020,8 +1021,7 @@
resultMu sync.Mutex
result = make(map[span.URI][]source.Symbol)
)
- for uri, f := range s.files {
- uri, f := uri, f
+ s.files.Range(func(uri span.URI, f source.VersionedFileHandle) {
// TODO(adonovan): upgrade errgroup and use group.SetLimit(nprocs).
iolimit <- struct{}{} // acquire token
group.Go(func() error {
@@ -1035,7 +1035,7 @@
resultMu.Unlock()
return nil
})
- }
+ })
// Keep going on errors, but log the first failure.
// Partial results are better than no symbol results.
if err := group.Wait(); err != nil {
@@ -1326,7 +1326,8 @@
s.mu.Lock()
defer s.mu.Unlock()
- return s.files[f.URI()]
+ result, _ := s.files.Load(f.URI())
+ return result
}
// GetVersionedFile returns a File for the given URI. If the file is unknown it
@@ -1348,7 +1349,7 @@
}
func (s *snapshot) getFileLocked(ctx context.Context, f *fileBase) (source.VersionedFileHandle, error) {
- if fh, ok := s.files[f.URI()]; ok {
+ if fh, ok := s.files.Load(f.URI()); ok {
return fh, nil
}
@@ -1357,7 +1358,7 @@
return nil, err
}
closed := &closedFile{fh}
- s.files[f.URI()] = closed
+ s.files.Store(f.URI(), closed)
return closed, nil
}
@@ -1373,16 +1374,17 @@
defer s.mu.Unlock()
var open []source.VersionedFileHandle
- for _, fh := range s.files {
+ s.files.Range(func(uri span.URI, fh source.VersionedFileHandle) {
if s.isOpenLocked(fh.URI()) {
open = append(open, fh)
}
- }
+ })
return open
}
func (s *snapshot) isOpenLocked(uri span.URI) bool {
- _, open := s.files[uri].(*overlay)
+ fh, _ := s.files.Load(uri)
+ _, open := fh.(*overlay)
return open
}
@@ -1610,29 +1612,29 @@
defer s.mu.Unlock()
var files []source.VersionedFileHandle
- for uri, fh := range s.files {
+ s.files.Range(func(uri span.URI, fh source.VersionedFileHandle) {
// Don't try to reload metadata for go.mod files.
if s.view.FileKind(fh) != source.Go {
- continue
+ return
}
// If the URI doesn't belong to this view, then it's not in a workspace
// package and should not be reloaded directly.
if !contains(s.view.session.viewsOf(uri), s.view) {
- continue
+ return
}
// If the file is not open and is in a vendor directory, don't treat it
// like a workspace package.
if _, ok := fh.(*overlay); !ok && inVendor(uri) {
- continue
+ return
}
// Don't reload metadata for files we've already deemed unloadable.
if _, ok := s.unloadableFiles[uri]; ok {
- continue
+ return
}
if s.noValidMetadataForURILocked(uri) {
files = append(files, fh)
}
- }
+ })
return files
}
@@ -1701,7 +1703,7 @@
initializedErr: s.initializedErr,
packages: make(map[packageKey]*packageHandle, len(s.packages)),
actions: make(map[actionKey]*actionHandle, len(s.actions)),
- files: make(map[span.URI]source.VersionedFileHandle, len(s.files)),
+ files: s.files.Clone(),
goFiles: s.goFiles.Clone(),
parseKeysByURI: s.parseKeysByURI.Clone(),
symbols: make(map[span.URI]*symbolHandle, len(s.symbols)),
@@ -1721,9 +1723,6 @@
}
// Copy all of the FileHandles.
- for k, v := range s.files {
- result.files[k] = v
- }
for k, v := range s.symbols {
if change, ok := changes[k]; ok {
if change.exists {
@@ -1807,7 +1806,7 @@
}
// The original FileHandle for this URI is cached on the snapshot.
- originalFH := s.files[uri]
+ originalFH, _ := s.files.Load(uri)
var originalOpen, newOpen bool
_, originalOpen = originalFH.(*overlay)
_, newOpen = change.fileHandle.(*overlay)
@@ -1852,9 +1851,9 @@
delete(result.parseWorkHandles, uri)
// Handle the invalidated file; it may have new contents or not exist.
if !change.exists {
- delete(result.files, uri)
+ result.files.Delete(uri)
} else {
- result.files[uri] = change.fileHandle
+ result.files.Store(uri, change.fileHandle)
}
// Make sure to remove the changed file from the unloadable set.
