Skip to content

Commit

Permalink
internal/lsp: rework snapshots and cache FileHandles per-snapshot
Browse files Browse the repository at this point in the history 
This change does not complete the work to handle snapshots correctly,
but it does implement the behavior of re-building the snapshot on each
file invalidation.

It also moves to the approach of caching the FileHandles on the snapshot,
rather than in the goFile object, which is now not necessary.

Finally, this change shifts the logic of metadata invalidation into the
content invalidation step, so there is less logic to decide if we should
re-load a package or not.

Change-Id: I18387c385fb070da4db1302bf97035ce6328b5c3
Reviewed-on: https://go-review.googlesource.com/c/tools/+/197799
Run-TryBot: Rebecca Stambler <[email protected]>
TryBot-Result: Gobot Gobot <[email protected]>
Reviewed-by: Ian Cottrell <[email protected]>
  • Loading branch information
@stamblerre
stamblerre committed Oct 1, 2019
1 parent 8b695b2 commit 57610ed
Show file tree
Hide file tree
Showing 38 changed files with 641 additions and 679 deletions.
61 changes: 34 additions & 27 deletions internal/lsp/cache/check.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ import (
)

type importer struct {
view *view
ctx context.Context
config *packages.Config
snapshot *snapshot
ctx context.Context
config *packages.Config

// seen maintains the set of previously imported packages.
// If we have seen a package that is already in this map, we have a circular import.
Expand Down Expand Up @@ -62,7 +62,7 @@ type checkPackageHandle struct {
config *packages.Config
}

func (cph *checkPackageHandle) mode() source.ParseMode {
func (cph *checkPackageHandle) Mode() source.ParseMode {
if len(cph.files) == 0 {
return -1
}
Expand All @@ -83,19 +83,15 @@ type checkPackageData struct {
err error
}

func (pkg *pkg) GetImport(ctx context.Context, pkgPath string) (source.Package, error) {
if imp := pkg.imports[packagePath(pkgPath)]; imp != nil {
return imp, nil
}
// Don't return a nil pointer because that still satisfies the interface.
return nil, errors.Errorf("no imported package for %s", pkgPath)
}

// checkPackageHandle returns a source.CheckPackageHandle for a given package and config.
func (imp *importer) checkPackageHandle(ctx context.Context, m *metadata) (*checkPackageHandle, error) {
func (imp *importer) checkPackageHandle(ctx context.Context, id packageID, s *snapshot) (*checkPackageHandle, error) {
m := s.getMetadata(id)
if m == nil {
return nil, errors.Errorf("no metadata for %s", id)
}
phs, err := imp.parseGoHandles(ctx, m)
if err != nil {
log.Error(ctx, "no ParseGoHandles", err, telemetry.Package.Of(m.id))
log.Error(ctx, "no ParseGoHandles", err, telemetry.Package.Of(id))
return nil, err
}
cph := &checkPackageHandle{
Expand All @@ -104,12 +100,19 @@ func (imp *importer) checkPackageHandle(ctx context.Context, m *metadata) (*chec
config: imp.config,
imports: make(map[packagePath]*checkPackageHandle),
}
h := imp.view.session.cache.store.Bind(cph.key(), func(ctx context.Context) interface{} {
h := imp.snapshot.view.session.cache.store.Bind(cph.key(), func(ctx context.Context) interface{} {
data := &checkPackageData{}
data.pkg, data.err = imp.typeCheck(ctx, cph, m)
return data
})

cph.handle = h

// Cache the CheckPackageHandle in the snapshot.
for _, ph := range cph.files {
uri := ph.File().Identity().URI
s.addPackage(uri, cph)
}
return cph, nil
}

Expand Down Expand Up @@ -190,16 +193,16 @@ func (cph *checkPackageHandle) key() checkPackageKey {
func (imp *importer) parseGoHandles(ctx context.Context, m *metadata) ([]source.ParseGoHandle, error) {
phs := make([]source.ParseGoHandle, 0, len(m.files))
for _, uri := range m.files {
f, err := imp.view.GetFile(ctx, uri)
f, err := imp.snapshot.view.GetFile(ctx, uri)
if err != nil {
return nil, err
}
fh := f.Handle(ctx)
fh := imp.snapshot.Handle(ctx, f)
mode := source.ParseExported
if imp.topLevelPackageID == m.id {
mode = source.ParseFull
}
phs = append(phs, imp.view.session.cache.ParseGoHandle(fh, mode))
phs = append(phs, imp.snapshot.view.session.cache.ParseGoHandle(fh, mode))
}
return phs, nil
}
Expand Down Expand Up @@ -236,7 +239,7 @@ func (imp *importer) typeCheck(ctx context.Context, cph *checkPackageHandle, m *
defer done()

pkg := &pkg{
view: imp.view,
view: imp.snapshot.view,
id: m.id,
pkgPath: m.pkgPath,
files: cph.Files(),
Expand All @@ -259,13 +262,17 @@ func (imp *importer) typeCheck(ctx context.Context, cph *checkPackageHandle, m *
}
// Set imports of package to correspond to cached packages.
cimp := imp.child(ctx, pkg, cph)
for _, child := range m.children {
childHandle, err := cimp.checkPackageHandle(ctx, child)
for _, depID := range m.deps {
dep := imp.snapshot.getMetadata(depID)
if dep == nil {
continue
}
depHandle, err := cimp.checkPackageHandle(ctx, depID, imp.snapshot)
if err != nil {
log.Error(ctx, "no check package handle", err, telemetry.Package.Of(child.id))
log.Error(ctx, "no check package handle", err, telemetry.Package.Of(depID))
continue
}
cph.imports[child.pkgPath] = childHandle
cph.imports[dep.pkgPath] = depHandle
}
var (
files = make([]*ast.File, len(pkg.files))
Expand All @@ -284,7 +291,7 @@ func (imp *importer) typeCheck(ctx context.Context, cph *checkPackageHandle, m *

for _, err := range parseErrors {
if err != nil {
imp.view.session.cache.appendPkgError(pkg, err)
imp.snapshot.view.session.cache.appendPkgError(pkg, err)
}
}

Expand All @@ -308,11 +315,11 @@ func (imp *importer) typeCheck(ctx context.Context, cph *checkPackageHandle, m *

cfg := &types.Config{
Error: func(err error) {
imp.view.session.cache.appendPkgError(pkg, err)
imp.snapshot.view.session.cache.appendPkgError(pkg, err)
},
Importer: cimp,
}
check := types.NewChecker(cfg, imp.view.session.cache.FileSet(), pkg.types, pkg.typesInfo)
check := types.NewChecker(cfg, imp.snapshot.view.session.cache.FileSet(), pkg.types, pkg.typesInfo)

// Type checking errors are handled via the config, so ignore them here.
_ = check.Files(files)
Expand All @@ -328,7 +335,7 @@ func (imp *importer) child(ctx context.Context, pkg *pkg, cph *checkPackageHandl
}
seen[pkg.id] = struct{}{}
return &importer{
view: imp.view,
snapshot: imp.snapshot,
ctx: ctx,
config: imp.config,
seen: seen,
Expand Down
20 changes: 4 additions & 16 deletions internal/lsp/cache/file.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,9 @@
package cache

import (
"context"
"go/token"
"path/filepath"
"strings"
"sync"

"golang.org/x/tools/internal/lsp/source"
"golang.org/x/tools/internal/span"
Expand All @@ -31,9 +29,6 @@ type fileBase struct {
kind source.FileKind

view *view

handleMu sync.Mutex
handle source.FileHandle
}

func basename(filename string) string {
Expand All @@ -44,6 +39,10 @@ func (f *fileBase) URI() span.URI {
return f.uris[0]
}

func (f *fileBase) Kind() source.FileKind {
return f.kind
}

func (f *fileBase) filename() string {
return f.fname
}
Expand All @@ -53,17 +52,6 @@ func (f *fileBase) View() source.View {
return f.view
}

// Content returns a handle for the contents of the file.
func (f *fileBase) Handle(ctx context.Context) source.FileHandle {
f.handleMu.Lock()
defer f.handleMu.Unlock()

if f.handle == nil {
f.handle = f.view.session.GetFile(f.URI(), f.kind)
}
return f.handle
}

func (f *fileBase) FileSet() *token.FileSet {
return f.view.Session().Cache().FileSet()
}
Loading

0 comments on commit 57610ed

Please sign in to comment.