Skip to content

Commit

Permalink
lib/model: Remove runner during folder cleanup (fixes syncthing#9269)
Browse files Browse the repository at this point in the history
Before introducing the service map and using it for folder runners, the
entries in folderCfgs and folderRunners for the same key/folder were
removed under a single lock. Stopping the folder happens separately
before that with just the read lock. Now with the service map stopping the
folder and removing it from the map is a single operation. And that
still happens with just a read-lock. However even with a full lock it’s still
problematic: After the folder stopped, the runner isn’t present anymore while
the folder-config still is and sais the folder isn't paused.

The index handler in turn looks at the folder config that is not paused,
thus assumes the runner has to be present -> nil deref on the runner.

A better solution would like be to push most of these fmut maps into the
folder - they anyway are needed in there. Then there's just a single
map/source of info that's necessarily consistent.
  • Loading branch information
imsodin committed Dec 7, 2023
1 parent 75310b5 commit bb5cd15
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 11 deletions.
5 changes: 3 additions & 2 deletions lib/model/model.go
Original file line number Diff line number Diff line change
Expand Up @@ -465,7 +465,7 @@ func (m *model) warnAboutOverwritingProtectedFiles(cfg config.FolderConfiguratio

func (m *model) removeFolder(cfg config.FolderConfiguration) {
m.fmut.RLock()
wait := m.folderRunners.RemoveAndWaitChan(cfg.ID, 0)
wait := m.folderRunners.StopAndWaitChan(cfg.ID, 0)
m.fmut.RUnlock()
<-wait

Expand Down Expand Up @@ -507,6 +507,7 @@ func (m *model) removeFolder(cfg config.FolderConfiguration) {
// Need to hold lock on m.fmut when calling this.
func (m *model) cleanupFolderLocked(cfg config.FolderConfiguration) {
// clear up our config maps
m.folderRunners.Remove(cfg.ID)
delete(m.folderCfgs, cfg.ID)
delete(m.folderFiles, cfg.ID)
delete(m.folderIgnores, cfg.ID)
Expand Down Expand Up @@ -536,7 +537,7 @@ func (m *model) restartFolder(from, to config.FolderConfiguration, cacheIgnoredF
defer restartMut.Unlock()

m.fmut.RLock()
wait := m.folderRunners.RemoveAndWaitChan(from.ID, 0)
wait := m.folderRunners.StopAndWaitChan(from.ID, 0)
m.fmut.RUnlock()
<-wait

Expand Down
40 changes: 31 additions & 9 deletions lib/model/service_map.go
Original file line number Diff line number Diff line change
Expand Up @@ -59,13 +59,43 @@ func (s *serviceMap[K, S]) Get(k K) (v S, ok bool) {
return
}

// Stop removes the service at the given key from the supervisor, stopping it.
// The service itself is still retained, i.e. a call to Get with the same key
// will still return a result.
func (s *serviceMap[K, S]) Stop(k K) {
if tok, ok := s.tokens[k]; ok {
s.supervisor.Remove(tok)
}
return
}

// StopAndWaitChan removes the service at the given key from the supervisor,
// stopping it. The service itself is still retained, i.e. a call to Get with
// the same key will still return a result.
// The returned channel will produce precisely one error value: either the
// return value from RemoveAndWait (possibly nil), or errSvcNotFound if the
// service was not found.
func (s *serviceMap[K, S]) StopAndWaitChan(k K, timeout time.Duration) <-chan error {
ret := make(chan error, 1)
if tok, ok := s.tokens[k]; ok {
go func() {
ret <- s.supervisor.RemoveAndWait(tok, timeout)
}()
} else {
ret <- errSvcNotFound
}
return ret
}

// Remove removes the service at the given key, stopping it on the supervisor.
// If there is no service at the given key, nothing happens. The return value
// indicates whether a service was removed.
func (s *serviceMap[K, S]) Remove(k K) (found bool) {
if tok, ok := s.tokens[k]; ok {
found = true
s.supervisor.Remove(tok)
} else {
_, found = s.services[k]
}
delete(s.services, k)
delete(s.tokens, k)
Expand All @@ -84,16 +114,8 @@ func (s *serviceMap[K, S]) RemoveAndWait(k K, timeout time.Duration) error {
// value: either the return value from RemoveAndWait (possibly nil), or
// errSvcNotFound if the service was not found.
func (s *serviceMap[K, S]) RemoveAndWaitChan(k K, timeout time.Duration) <-chan error {
ret := make(chan error, 1)
if tok, ok := s.tokens[k]; ok {
go func() {
ret <- s.supervisor.RemoveAndWait(tok, timeout)
}()
} else {
ret <- errSvcNotFound
}
ret := s.StopAndWaitChan(k, timeout)
delete(s.services, k)
delete(s.tokens, k)
return ret
}

Expand Down

0 comments on commit bb5cd15

Please sign in to comment.