blob: 49443e9db2a681c24046df5e65a3a29c8ecd7b3e [file] [log] [blame]
// 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 "sync/engine/commit.h"
#include "base/debug/trace_event.h"
#include "sync/engine/build_commit_command.h"
#include "sync/engine/get_commit_ids_command.h"
#include "sync/engine/process_commit_response_command.h"
#include "sync/engine/syncer_proto_util.h"
#include "sync/sessions/sync_session.h"
#include "sync/syncable/mutable_entry.h"
#include "sync/syncable/write_transaction.h"
namespace syncer {
using sessions::SyncSession;
using sessions::StatusController;
using syncable::SYNCER;
using syncable::WriteTransaction;
namespace {
// Sets the SYNCING bits of all items in the commit set to value_to_set.
void SetAllSyncingBitsToValue(WriteTransaction* trans,
const sessions::OrderedCommitSet& commit_set,
bool value_to_set) {
const std::vector<syncable::Id>& commit_ids = commit_set.GetAllCommitIds();
for (std::vector<syncable::Id>::const_iterator it = commit_ids.begin();
it != commit_ids.end(); ++it) {
syncable::MutableEntry entry(trans, syncable::GET_BY_ID, *it);
if (entry.good()) {
entry.Put(syncable::SYNCING, value_to_set);
// Sets the SYNCING bits for all items in the OrderedCommitSet.
void SetSyncingBits(WriteTransaction* trans,
const sessions::OrderedCommitSet& commit_set) {
SetAllSyncingBitsToValue(trans, commit_set, true);
// Clears the SYNCING bits for all items in the OrderedCommitSet.
void ClearSyncingBits(syncable::Directory* dir,
const sessions::OrderedCommitSet& commit_set) {
WriteTransaction trans(FROM_HERE, SYNCER, dir);
SetAllSyncingBitsToValue(&trans, commit_set, false);
// Helper function that finds sync items that are ready to be committed to the
// server and serializes them into a commit message protobuf. It will return
// false iff there are no entries ready to be committed at this time.
// The OrderedCommitSet parameter is an output parameter which will contain
// the set of all items which are to be committed. The number of items in
// the set shall not exceed the maximum batch size. (The default batch size
// is currently 25, though it can be overwritten by the server.)
// The ClientToServerMessage parameter is an output parameter which will contain
// the commit message which should be sent to the server. It is valid iff the
// return value of this function is true.
bool PrepareCommitMessage(sessions::SyncSession* session,
sessions::OrderedCommitSet* commit_set,
sync_pb::ClientToServerMessage* commit_message) {
TRACE_EVENT0("sync", "PrepareCommitMessage");
WriteTransaction trans(FROM_HERE, SYNCER, session->context()->directory());
sessions::ScopedSetSessionWriteTransaction set_trans(session, &trans);
// Fetch the items to commit.
const size_t batch_size = session->context()->max_commit_batch_size();
GetCommitIdsCommand get_commit_ids_command(batch_size, commit_set);
DVLOG(1) << "Commit message will contain " << commit_set->Size() << " items.";
if (commit_set->Empty()) {
return false;
// Serialize the message.
BuildCommitCommand build_commit_command(*commit_set, commit_message);
SetSyncingBits(session->write_transaction(), *commit_set);
return true;
SyncerError BuildAndPostCommitsImpl(Syncer* syncer,
sessions::SyncSession* session,
sessions::OrderedCommitSet* commit_set) {
sync_pb::ClientToServerMessage commit_message;
while (!syncer->ExitRequested() &&
PrepareCommitMessage(session, commit_set, &commit_message)) {
sync_pb::ClientToServerResponse commit_response;
DVLOG(1) << "Sending commit message.";
TRACE_EVENT_BEGIN0("sync", "PostCommit");
const SyncerError post_result = SyncerProtoUtil::PostClientToServerMessage(
&commit_message, &commit_response, session);
TRACE_EVENT_END0("sync", "PostCommit");
if (post_result != SYNCER_OK) {
LOG(WARNING) << "Post commit failed";
return post_result;
if (!commit_response.has_commit()) {
LOG(WARNING) << "Commit response has no commit body!";
const size_t num_responses = commit_response.commit().entryresponse_size();
if (num_responses != commit_set->Size()) {
<< "Commit response has wrong number of entries! "
<< "Expected: " << commit_set->Size() << ", "
<< "Got: " << num_responses;
TRACE_EVENT_BEGIN0("sync", "ProcessCommitResponse");
ProcessCommitResponseCommand process_response_command(
*commit_set, commit_message, commit_response);
const SyncerError processing_result =
TRACE_EVENT_END0("sync", "ProcessCommitResponse");
if (processing_result != SYNCER_OK) {
return processing_result;
return SYNCER_OK;
} // namespace
SyncerError BuildAndPostCommits(Syncer* syncer,
sessions::SyncSession* session) {
sessions::OrderedCommitSet commit_set(session->routing_info());
SyncerError result = BuildAndPostCommitsImpl(syncer, session, &commit_set);
if (result != SYNCER_OK) {
ClearSyncingBits(session->context()->directory(), commit_set);
return result;
} // namespace syncer