15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved.
25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be
35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file.
45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "chrome/browser/sync/glue/ui_model_worker.h"
65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/bind.h"
85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/bind_helpers.h"
99ab5563a3196760eb381d102cbb2bc0f7abc6a50Ben Murdoch#include "base/message_loop/message_loop.h"
105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/synchronization/waitable_event.h"
115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/third_party/dynamic_annotations/dynamic_annotations.h"
125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/threading/thread_restrictions.h"
135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "content/public/browser/browser_thread.h"
145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)using content::BrowserThread;
165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace browser_sync {
185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace {
205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// A simple callback to signal a waitable event after running a closure.
225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void CallDoWorkAndSignalCallback(const syncer::WorkCallback& work,
235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)                                 base::WaitableEvent* work_done,
245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)                                 syncer::SyncerError* error_info) {
255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  if (work.is_null()) {
265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    // This can happen during tests or cases where there are more than just the
275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    // default UIModelWorker in existence and it gets destroyed before
285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    // the main UI loop has terminated.  There is no easy way to assert the
295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    // loop is running / not running at the moment, so we just provide cancel
305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    // semantics here and short-circuit.
315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    // TODO(timsteele): Maybe we should have the message loop destruction
325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    // observer fire when the loop has ended, just a bit before it
335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    // actually gets destroyed.
345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    return;
355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  }
365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  *error_info = work.Run();
385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  work_done->Signal();  // Unblock the syncer thread that scheduled us.
405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}  // namespace
435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
4490dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)UIModelWorker::UIModelWorker(syncer::WorkerLoopDestructionObserver* observer)
45a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)    : syncer::ModelSafeWorker(observer) {
465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
4890dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)void UIModelWorker::RegisterForLoopDestruction() {
4990dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)  CHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
50a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)  SetWorkingLoopToCurrent();
5190dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)}
5290dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)
5390dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)syncer::SyncerError UIModelWorker::DoWorkAndWaitUntilDoneImpl(
545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    const syncer::WorkCallback& work) {
555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  syncer::SyncerError error_info;
565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  if (BrowserThread::CurrentlyOn(BrowserThread::UI)) {
575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    DLOG(WARNING) << "DoWorkAndWaitUntilDone called from "
585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)      << "ui_loop_. Probably a nested invocation?";
595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    return work.Run();
605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  }
615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
62a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)  if (!BrowserThread::PostTask(
63a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)      BrowserThread::UI, FROM_HERE,
64a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)      base::Bind(&CallDoWorkAndSignalCallback,
65a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)                 work, work_done_or_stopped(), &error_info))) {
66a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)    DLOG(WARNING) << "Could not post work to UI loop.";
67a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)    error_info = syncer::CANNOT_DO_WORK;
68a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)    return error_info;
695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  }
7090dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)  work_done_or_stopped()->Wait();
71a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)
725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  return error_info;
735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)syncer::ModelSafeGroup UIModelWorker::GetModelSafeGroup() {
765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  return syncer::GROUP_UI;
775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)UIModelWorker::~UIModelWorker() {
805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}  // namespace browser_sync
83