1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
|
// Copyright 2014 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/internal_api/public/attachments/on_disk_attachment_store.h"
#include <stdint.h>
#include <string>
#include "base/bind.h"
#include "base/callback.h"
#include "base/location.h"
#include "base/memory/scoped_ptr.h"
#include "base/metrics/histogram.h"
#include "base/sequenced_task_runner.h"
#include "sync/internal_api/attachments/proto/attachment_store.pb.h"
#include "sync/internal_api/public/attachments/attachment_util.h"
#include "sync/protocol/attachments.pb.h"
#include "third_party/leveldatabase/env_chromium.h"
#include "third_party/leveldatabase/src/include/leveldb/db.h"
#include "third_party/leveldatabase/src/include/leveldb/options.h"
#include "third_party/leveldatabase/src/include/leveldb/slice.h"
#include "third_party/leveldatabase/src/include/leveldb/status.h"
#include "third_party/leveldatabase/src/include/leveldb/write_batch.h"
namespace syncer {
namespace {
// Prefix for records containing attachment data.
const char kDataPrefix[] = "data-";
// Prefix for records containing attachment metadata.
const char kMetadataPrefix[] = "metadata-";
const char kDatabaseMetadataKey[] = "database-metadata";
const int32_t kCurrentSchemaVersion = 1;
const base::FilePath::CharType kLeveldbDirectory[] =
FILE_PATH_LITERAL("leveldb");
// Converts syncer::AttachmentStore::Component values into
// attachment_store_pb::RecordMetadata::Component.
attachment_store_pb::RecordMetadata::Component ComponentToProto(
syncer::AttachmentStore::Component component) {
switch (component) {
case AttachmentStore::MODEL_TYPE:
return attachment_store_pb::RecordMetadata::MODEL_TYPE;
case AttachmentStore::SYNC:
return attachment_store_pb::RecordMetadata::SYNC;
}
NOTREACHED();
return attachment_store_pb::RecordMetadata::UNKNOWN;
}
leveldb::WriteOptions MakeWriteOptions() {
leveldb::WriteOptions write_options;
write_options.sync = true;
return write_options;
}
leveldb::ReadOptions MakeNonCachingReadOptions() {
leveldb::ReadOptions read_options;
read_options.fill_cache = false;
read_options.verify_checksums = true;
return read_options;
}
leveldb::ReadOptions MakeCachingReadOptions() {
leveldb::ReadOptions read_options;
read_options.fill_cache = true;
read_options.verify_checksums = true;
return read_options;
}
leveldb::Status ReadStoreMetadata(
leveldb::DB* db,
attachment_store_pb::StoreMetadata* metadata) {
std::string data_str;
leveldb::Status status =
db->Get(MakeCachingReadOptions(), kDatabaseMetadataKey, &data_str);
if (!status.ok())
return status;
if (!metadata->ParseFromString(data_str))
return leveldb::Status::Corruption("Metadata record corruption");
return leveldb::Status::OK();
}
leveldb::Status WriteStoreMetadata(
leveldb::DB* db,
const attachment_store_pb::StoreMetadata& metadata) {
std::string data_str;
metadata.SerializeToString(&data_str);
return db->Put(MakeWriteOptions(), kDatabaseMetadataKey, data_str);
}
// Adds reference to component into RecordMetadata::component set.
// Returns true if record_metadata was modified and needs to be written to disk.
bool SetReferenceInRecordMetadata(
attachment_store_pb::RecordMetadata* record_metadata,
attachment_store_pb::RecordMetadata::Component proto_component) {
DCHECK(record_metadata);
for (const int component : record_metadata->component()) {
if (component == proto_component)
return false;
}
record_metadata->add_component(proto_component);
return true;
}
// Drops reference to component from RecordMetadata::component set.
// Returns true if record_metadata was modified and needs to be written to disk.
bool DropReferenceInRecordMetadata(
attachment_store_pb::RecordMetadata* record_metadata,
attachment_store_pb::RecordMetadata::Component proto_component) {
DCHECK(record_metadata);
bool component_removed = false;
::google::protobuf::RepeatedField<int>* mutable_components =
record_metadata->mutable_component();
for (int i = 0; i < mutable_components->size();) {
if (mutable_components->Get(i) == proto_component) {
if (i < mutable_components->size() - 1) {
// Don't swap last element with itself.
mutable_components->SwapElements(i, mutable_components->size() - 1);
}
mutable_components->RemoveLast();
component_removed = true;
} else {
++i;
}
}
return component_removed;
}
bool AttachmentHasReferenceFromComponent(
const attachment_store_pb::RecordMetadata& record_metadata,
attachment_store_pb::RecordMetadata::Component proto_component) {
for (const auto& reference_component : record_metadata.component()) {
if (reference_component == proto_component) {
return true;
}
}
return false;
}
} // namespace
OnDiskAttachmentStore::OnDiskAttachmentStore(
const scoped_refptr<base::SequencedTaskRunner>& callback_task_runner,
const base::FilePath& path)
: AttachmentStoreBackend(callback_task_runner), path_(path) {
}
OnDiskAttachmentStore::~OnDiskAttachmentStore() {
}
void OnDiskAttachmentStore::Init(
const AttachmentStore::InitCallback& callback) {
DCHECK(CalledOnValidThread());
AttachmentStore::Result result_code = OpenOrCreate(path_);
UMA_HISTOGRAM_ENUMERATION("Sync.Attachments.StoreInitResult", result_code,
AttachmentStore::RESULT_SIZE);
PostCallback(base::Bind(callback, result_code));
}
void OnDiskAttachmentStore::Read(
AttachmentStore::Component component,
const AttachmentIdList& ids,
const AttachmentStore::ReadCallback& callback) {
DCHECK(CalledOnValidThread());
scoped_ptr<AttachmentMap> result_map(new AttachmentMap());
scoped_ptr<AttachmentIdList> unavailable_attachments(new AttachmentIdList());
AttachmentStore::Result result_code =
AttachmentStore::STORE_INITIALIZATION_FAILED;
if (db_) {
result_code = AttachmentStore::SUCCESS;
for (const auto& id : ids) {
scoped_ptr<Attachment> attachment;
attachment = ReadSingleAttachment(id, component);
if (attachment) {
result_map->insert(std::make_pair(id, *attachment));
} else {
unavailable_attachments->push_back(id);
}
}
result_code = unavailable_attachments->empty()
? AttachmentStore::SUCCESS
: AttachmentStore::UNSPECIFIED_ERROR;
} else {
*unavailable_attachments = ids;
}
PostCallback(base::Bind(callback, result_code, base::Passed(&result_map),
base::Passed(&unavailable_attachments)));
}
void OnDiskAttachmentStore::Write(
AttachmentStore::Component component,
const AttachmentList& attachments,
const AttachmentStore::WriteCallback& callback) {
DCHECK(CalledOnValidThread());
AttachmentStore::Result result_code =
AttachmentStore::STORE_INITIALIZATION_FAILED;
if (db_) {
result_code = AttachmentStore::SUCCESS;
AttachmentList::const_iterator iter = attachments.begin();
const AttachmentList::const_iterator end = attachments.end();
for (; iter != end; ++iter) {
if (!WriteSingleAttachment(*iter, component))
result_code = AttachmentStore::UNSPECIFIED_ERROR;
}
}
PostCallback(base::Bind(callback, result_code));
}
void OnDiskAttachmentStore::SetReference(AttachmentStore::Component component,
const AttachmentIdList& ids) {
DCHECK(CalledOnValidThread());
if (!db_)
return;
attachment_store_pb::RecordMetadata::Component proto_component =
ComponentToProto(component);
for (const auto& id : ids) {
attachment_store_pb::RecordMetadata record_metadata;
if (!ReadSingleRecordMetadata(id, &record_metadata))
continue;
if (SetReferenceInRecordMetadata(&record_metadata, proto_component))
WriteSingleRecordMetadata(id, record_metadata);
}
}
void OnDiskAttachmentStore::DropReference(
AttachmentStore::Component component,
const AttachmentIdList& ids,
const AttachmentStore::DropCallback& callback) {
DCHECK(CalledOnValidThread());
AttachmentStore::Result result_code =
AttachmentStore::STORE_INITIALIZATION_FAILED;
if (db_) {
attachment_store_pb::RecordMetadata::Component proto_component =
ComponentToProto(component);
result_code = AttachmentStore::SUCCESS;
leveldb::WriteOptions write_options = MakeWriteOptions();
for (const auto& id : ids) {
attachment_store_pb::RecordMetadata record_metadata;
if (!ReadSingleRecordMetadata(id, &record_metadata))
continue; // Record not found.
if (!DropReferenceInRecordMetadata(&record_metadata, proto_component))
continue; // Component is not in components set. Metadata was not
// updated.
if (record_metadata.component_size() == 0) {
// Last reference dropped. Need to delete attachment.
leveldb::WriteBatch write_batch;
write_batch.Delete(MakeDataKeyFromAttachmentId(id));
write_batch.Delete(MakeMetadataKeyFromAttachmentId(id));
leveldb::Status status = db_->Write(write_options, &write_batch);
if (!status.ok()) {
// DB::Delete doesn't check if record exists, it returns ok just like
// AttachmentStore::Drop should.
DVLOG(1) << "DB::Write failed: status=" << status.ToString();
result_code = AttachmentStore::UNSPECIFIED_ERROR;
}
} else {
WriteSingleRecordMetadata(id, record_metadata);
}
}
}
PostCallback(base::Bind(callback, result_code));
}
void OnDiskAttachmentStore::ReadMetadataById(
AttachmentStore::Component component,
const AttachmentIdList& ids,
const AttachmentStore::ReadMetadataCallback& callback) {
DCHECK(CalledOnValidThread());
AttachmentStore::Result result_code =
AttachmentStore::STORE_INITIALIZATION_FAILED;
scoped_ptr<AttachmentMetadataList> metadata_list(
new AttachmentMetadataList());
if (db_) {
result_code = AttachmentStore::SUCCESS;
for (const auto& id : ids) {
attachment_store_pb::RecordMetadata record_metadata;
if (!ReadSingleRecordMetadata(id, &record_metadata)) {
result_code = AttachmentStore::UNSPECIFIED_ERROR;
continue;
}
if (!AttachmentHasReferenceFromComponent(record_metadata,
ComponentToProto(component))) {
result_code = AttachmentStore::UNSPECIFIED_ERROR;
continue;
}
metadata_list->push_back(MakeAttachmentMetadata(id, record_metadata));
}
}
PostCallback(base::Bind(callback, result_code, base::Passed(&metadata_list)));
}
void OnDiskAttachmentStore::ReadMetadata(
AttachmentStore::Component component,
const AttachmentStore::ReadMetadataCallback& callback) {
DCHECK(CalledOnValidThread());
AttachmentStore::Result result_code =
AttachmentStore::STORE_INITIALIZATION_FAILED;
scoped_ptr<AttachmentMetadataList> metadata_list(
new AttachmentMetadataList());
if (db_) {
attachment_store_pb::RecordMetadata::Component proto_component =
ComponentToProto(component);
result_code = AttachmentStore::SUCCESS;
scoped_ptr<leveldb::Iterator> db_iterator(
db_->NewIterator(MakeNonCachingReadOptions()));
DCHECK(db_iterator);
for (db_iterator->Seek(kMetadataPrefix); db_iterator->Valid();
db_iterator->Next()) {
leveldb::Slice key = db_iterator->key();
if (!key.starts_with(kMetadataPrefix)) {
break;
}
// Make AttachmentId from levelDB key.
key.remove_prefix(strlen(kMetadataPrefix));
sync_pb::AttachmentIdProto id_proto;
id_proto.set_unique_id(key.ToString());
AttachmentId id = AttachmentId::CreateFromProto(id_proto);
// Parse metadata record.
attachment_store_pb::RecordMetadata record_metadata;
if (!record_metadata.ParseFromString(db_iterator->value().ToString())) {
DVLOG(1) << "RecordMetadata::ParseFromString failed";
result_code = AttachmentStore::UNSPECIFIED_ERROR;
continue;
}
DCHECK_GT(record_metadata.component_size(), 0);
if (AttachmentHasReferenceFromComponent(record_metadata, proto_component))
metadata_list->push_back(MakeAttachmentMetadata(id, record_metadata));
}
if (!db_iterator->status().ok()) {
DVLOG(1) << "DB Iterator failed: status="
<< db_iterator->status().ToString();
result_code = AttachmentStore::UNSPECIFIED_ERROR;
}
}
PostCallback(base::Bind(callback, result_code, base::Passed(&metadata_list)));
}
AttachmentStore::Result OnDiskAttachmentStore::OpenOrCreate(
const base::FilePath& path) {
DCHECK(!db_);
base::FilePath leveldb_path = path.Append(kLeveldbDirectory);
leveldb::DB* db_raw;
scoped_ptr<leveldb::DB> db;
leveldb::Options options;
options.create_if_missing = true;
options.reuse_logs = leveldb_env::kDefaultLogReuseOptionValue;
// TODO(pavely): crbug/424287 Consider adding info_log, block_cache and
// filter_policy to options.
leveldb::Status status =
leveldb::DB::Open(options, leveldb_path.AsUTF8Unsafe(), &db_raw);
if (!status.ok()) {
DVLOG(1) << "DB::Open failed: status=" << status.ToString()
<< ", path=" << path.AsUTF8Unsafe();
return AttachmentStore::UNSPECIFIED_ERROR;
}
db.reset(db_raw);
attachment_store_pb::StoreMetadata metadata;
status = ReadStoreMetadata(db.get(), &metadata);
if (!status.ok() && !status.IsNotFound()) {
DVLOG(1) << "ReadStoreMetadata failed: status=" << status.ToString();
return AttachmentStore::UNSPECIFIED_ERROR;
}
if (status.IsNotFound()) {
// Brand new database.
metadata.set_schema_version(kCurrentSchemaVersion);
status = WriteStoreMetadata(db.get(), metadata);
if (!status.ok()) {
DVLOG(1) << "WriteStoreMetadata failed: status=" << status.ToString();
return AttachmentStore::UNSPECIFIED_ERROR;
}
}
DCHECK(status.ok());
// Upgrade code goes here.
if (metadata.schema_version() != kCurrentSchemaVersion) {
DVLOG(1) << "Unknown schema version: " << metadata.schema_version();
return AttachmentStore::UNSPECIFIED_ERROR;
}
db_ = db.Pass();
return AttachmentStore::SUCCESS;
}
scoped_ptr<Attachment> OnDiskAttachmentStore::ReadSingleAttachment(
const AttachmentId& attachment_id,
AttachmentStore::Component component) {
scoped_ptr<Attachment> attachment;
attachment_store_pb::RecordMetadata record_metadata;
if (!ReadSingleRecordMetadata(attachment_id, &record_metadata)) {
return attachment.Pass();
}
if (!AttachmentHasReferenceFromComponent(record_metadata,
ComponentToProto(component)))
return attachment.Pass();
const std::string key = MakeDataKeyFromAttachmentId(attachment_id);
std::string data_str;
leveldb::Status status = db_->Get(
MakeNonCachingReadOptions(), key, &data_str);
if (!status.ok()) {
DVLOG(1) << "DB::Get for data failed: status=" << status.ToString();
return attachment.Pass();
}
scoped_refptr<base::RefCountedMemory> data =
base::RefCountedString::TakeString(&data_str);
uint32_t crc32c = ComputeCrc32c(data);
if (record_metadata.has_crc32c()) {
if (record_metadata.crc32c() != crc32c) {
DVLOG(1) << "Attachment crc32c does not match value read from store";
return attachment.Pass();
}
if (record_metadata.crc32c() != attachment_id.GetCrc32c()) {
DVLOG(1) << "Attachment crc32c does not match value in AttachmentId";
return attachment.Pass();
}
}
attachment.reset(
new Attachment(Attachment::CreateFromParts(attachment_id, data)));
return attachment.Pass();
}
bool OnDiskAttachmentStore::WriteSingleAttachment(
const Attachment& attachment,
AttachmentStore::Component component) {
const std::string metadata_key =
MakeMetadataKeyFromAttachmentId(attachment.GetId());
const std::string data_key = MakeDataKeyFromAttachmentId(attachment.GetId());
std::string metadata_str;
leveldb::Status status =
db_->Get(MakeCachingReadOptions(), metadata_key, &metadata_str);
if (status.ok()) {
// Entry exists, don't overwrite.
return true;
} else if (!status.IsNotFound()) {
// Entry exists but failed to read.
DVLOG(1) << "DB::Get failed: status=" << status.ToString();
return false;
}
DCHECK(status.IsNotFound());
leveldb::WriteBatch write_batch;
// Write metadata.
attachment_store_pb::RecordMetadata metadata;
metadata.set_attachment_size(attachment.GetData()->size());
metadata.set_crc32c(attachment.GetCrc32c());
SetReferenceInRecordMetadata(&metadata, ComponentToProto(component));
metadata_str = metadata.SerializeAsString();
write_batch.Put(metadata_key, metadata_str);
// Write data.
scoped_refptr<base::RefCountedMemory> data = attachment.GetData();
leveldb::Slice data_slice(data->front_as<char>(), data->size());
write_batch.Put(data_key, data_slice);
status = db_->Write(MakeWriteOptions(), &write_batch);
if (!status.ok()) {
// Failed to write.
DVLOG(1) << "DB::Write failed: status=" << status.ToString();
return false;
}
return true;
}
bool OnDiskAttachmentStore::ReadSingleRecordMetadata(
const AttachmentId& attachment_id,
attachment_store_pb::RecordMetadata* record_metadata) {
DCHECK(record_metadata);
const std::string metadata_key =
MakeMetadataKeyFromAttachmentId(attachment_id);
std::string metadata_str;
leveldb::Status status =
db_->Get(MakeCachingReadOptions(), metadata_key, &metadata_str);
if (!status.ok()) {
DVLOG(1) << "DB::Get for metadata failed: status=" << status.ToString();
return false;
}
if (!record_metadata->ParseFromString(metadata_str)) {
DVLOG(1) << "RecordMetadata::ParseFromString failed";
return false;
}
DCHECK_GT(record_metadata->component_size(), 0);
return true;
}
bool OnDiskAttachmentStore::WriteSingleRecordMetadata(
const AttachmentId& attachment_id,
const attachment_store_pb::RecordMetadata& record_metadata) {
const std::string metadata_key =
MakeMetadataKeyFromAttachmentId(attachment_id);
std::string metadata_str;
metadata_str = record_metadata.SerializeAsString();
leveldb::Status status =
db_->Put(MakeWriteOptions(), metadata_key, metadata_str);
if (!status.ok()) {
DVLOG(1) << "DB::Put failed: status=" << status.ToString();
return false;
}
return true;
}
std::string OnDiskAttachmentStore::MakeDataKeyFromAttachmentId(
const AttachmentId& attachment_id) {
std::string key = kDataPrefix + attachment_id.GetProto().unique_id();
return key;
}
std::string OnDiskAttachmentStore::MakeMetadataKeyFromAttachmentId(
const AttachmentId& attachment_id) {
std::string key = kMetadataPrefix + attachment_id.GetProto().unique_id();
return key;
}
AttachmentMetadata OnDiskAttachmentStore::MakeAttachmentMetadata(
const AttachmentId& attachment_id,
const attachment_store_pb::RecordMetadata& record_metadata) {
return AttachmentMetadata(attachment_id, record_metadata.attachment_size());
}
} // namespace syncer
|