Sync: Avoid deadlock in SyncBackendRegistrar / ModelSafeWorker on sync backend shutdown.

chrome/browser/sync/glue/sync_backend_registrar_unittest.cc

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "chrome/browser/sync/glue/sync_backend_registrar.h"
 
 #include "chrome/browser/sync/glue/ui_model_worker.h"
 #include "chrome/test/base/testing_profile.h"
 #include "components/sync_driver/change_processor_mock.h"
 #include "content/public/browser/browser_thread.h"
@@ skipping 238 matching lines @@
   done.Wait();
 
   registrar_->DeactivateDataType(AUTOFILL);
   ExpectRoutingInfo(registrar_.get(), syncer::ModelSafeRoutingInfo());
   ExpectHasProcessorsForTypes(*registrar_, ModelTypeSet());
 
   // Should do nothing.
   TriggerChanges(registrar_.get(), AUTOFILL);
 }
 
+class SyncBackendRegistrarShutdownTest : public testing::Test {
+ public:
+  void BlockDBThread() {
+    EXPECT_FALSE(db_thread_lock_.Try());
+
+    db_thread_blocked_.Signal();
+    base::AutoLock l(db_thread_lock_);
+  }
+
+ protected:
+  friend class TestRegistrar;
+
+  SyncBackendRegistrarShutdownTest()
+      : thread_bundle_(content::TestBrowserThreadBundle::REAL_DB_THREAD |
+                       content::TestBrowserThreadBundle::REAL_FILE_THREAD |
+                       content::TestBrowserThreadBundle::REAL_IO_THREAD),
+        db_thread_blocked_(false, false) {}
+
+  virtual ~SyncBackendRegistrarShutdownTest() {}
+
+  content::TestBrowserThreadBundle thread_bundle_;
+  base::WaitableEvent db_thread_blocked_;
+  base::Lock db_thread_lock_;
+};
+
+// Wrap SyncBackendRegistrar so that we can monitor its lifetime.
+class TestRegistrar : public SyncBackendRegistrar {
+ public:
+  explicit TestRegistrar(Profile* profile)
+      : SyncBackendRegistrar("test", profile, scoped_ptr<base::Thread>()) {}
+
+  ~TestRegistrar() override {
+    BrowserThread::PostTask(
+        BrowserThread::UI, FROM_HERE, base::MessageLoop::QuitClosure());
+  }
+};
+
+TEST_F(SyncBackendRegistrarShutdownTest, BlockingShutdown) {
+  // Take ownership of |db_thread_lock_| so that the DB thread can't acquire it.
+  db_thread_lock_.Acquire();
+
+  // This will block the DB thread by waiting on |db_thread_lock_|.
+  BrowserThread::PostTask(
+      BrowserThread::DB,
+      FROM_HERE,
+      base::Bind(&SyncBackendRegistrarShutdownTest::BlockDBThread,
+                 base::Unretained(this)));
+
+  TestingProfile profile;
+  scoped_ptr<TestRegistrar> registrar(new TestRegistrar(&profile));
+  base::Thread* sync_thread = registrar->sync_thread();
+
+  // Stop here until the DB thread gets a chance to run and block on the lock.
+  // Please note that since the task above didn't finish, the task to
+  // initialize the worker on the DB thread hasn't had a chance to run yet too.
+  // Which means ModelSafeWorker::SetWorkingLoopToCurrent hasn't been called
+  // for the DB worker.
+  db_thread_blocked_.Wait();
+
+  registrar->SetInitialTypes(ModelTypeSet());
+
+  // Start the shutdown.
+  registrar->RequestWorkerStopOnUIThread();
+
+  sync_thread->message_loop()->PostTask(
+      FROM_HERE,
+      base::Bind(&SyncBackendRegistrar::Shutdown,
+                 base::Unretained(registrar.release())));
+
+  // The test verifies that the sync thread doesn't block because
+  // of the blocked DB thread and can finish the shutdown.
+  sync_thread->message_loop()->RunUntilIdle();
+
+  db_thread_lock_.Release();
+
+  // Run the main thread loop until all workers have been removed and the
+  // registrar destroyed.
+  base::MessageLoop::current()->Run();

[Nicolas Zea, 2014/10/22 17:06:44]

nit: Run() is deprecated. The preferred approach these days is to create a
RunLoop, and pass it's quit closure to the TestRegistrar to invoke.

[stanisc, 2014/10/23 17:51:13]

Done.

+}
+
 }  // namespace
 
 }  // namespace browser_sync