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
|
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
#pragma once
#include "raw_document_meta_data.h"
#include <vespa/document/base/globalid.h>
#include <vespa/document/bucket/bucketid.h>
namespace proton::documentmetastore {
/**
* Interface for storing information about mapping between global document id (gid)
* and local document id (lid) with additional meta data per document.
**/
struct IStore
{
using DocId = uint32_t;
using GlobalId = document::GlobalId;
using BucketId = document::BucketId;
using Timestamp = uint64_t;
/**
* Result after lookup in the store.
*/
struct Result
{
DocId _lid;
bool _success;
// Info about previous state.
bool _found; // gid was known (due to earlier put or remove)
Timestamp _timestamp; // previous timestamp
Result()
: _lid(0u),
_success(false),
_found(false),
_timestamp()
{
}
void setLid(DocId lid) { _lid = lid; }
DocId getLid() const { return _lid; }
bool ok() const { return _success; }
void markSuccess() { _success = true; }
void fillPrev(Timestamp prevTimestamp) {
_found = true;
_timestamp = prevTimestamp;
}
};
virtual ~IStore() = default;
/**
* Inspect the meta data associated with the given gid.
* If the gid is not found the result is not valid.
*/
virtual Result inspectExisting(const GlobalId &gid, uint64_t prepare_serial_num) = 0;
/**
* Inspect the meta data associated with the given gid.
* If the gid is not found the next available lid is returned in the result.
* This lid can be used if calling put() right afterwards.
*/
virtual Result inspect(const GlobalId &gid, uint64_t prepare_serial_num) = 0;
/**
* Puts the given <lid, meta data> pair to this store.
* This function should assert that the given lid is the same
* as returned from inspect().
**/
virtual Result put(const GlobalId &gid,
const BucketId &bucketId,
Timestamp timestamp,
uint32_t docSize,
DocId lid,
uint64_t prepare_serial_num) = 0;
/*
* Update the meta data associated with the given lid.
* Used when handling partial updates.
* Returns false if there is no entry for the given lid.
*/
virtual bool updateMetaData(DocId lid,
const BucketId &bucketId,
Timestamp timestamp) = 0;
/**
* Removes the <lid, meta data> pair with the given lid from this
* store. Returns false if the <lid, meta data> pair was not
* found or could not be removed.
* The caller must call removes_complete() after document removal is done.
**/
virtual bool remove(DocId lid, uint64_t prepare_serial_num) = 0;
/**
* Signal that the removal of the documents associated with these lid is complete.
* This is typically called after the documents have been removed from all
* other data structures. The lids are now candidates for later reuse.
* Both remove() and removeBatch() will trigger a later call to removes_complete()
* at the next force commit, cf. ForceCommitDoneTask.
*/
virtual void removes_complete(const std::vector<DocId>& lids) = 0;
/**
* Move meta data for fromLid to toLid. Mapping from gid to lid
* is updated atomically from fromLid to toLid.
* The caller must call removes_complete() with fromLid after document move is done.
*/
virtual void move(DocId fromLid, DocId toLid, uint64_t prepare_serial_num) = 0;
/**
* Check if the lid is valid.
* Returns true if valid, false otherwise.
**/
virtual bool validLid(DocId lid) const = 0;
/**
* Removes a list of lids.
* The caller must call removes_complete() after documents removal is done.
*/
virtual void removeBatch(const std::vector<DocId> &lidsToRemove, const DocId docIdLimit) = 0;
/**
* Returns the raw meta data stored for the given lid.
*/
virtual const RawDocumentMetaData &getRawMetaData(DocId lid) const = 0;
/**
* Check if free list is active.
*
* Returns true if free list is active.
*/
virtual bool getFreeListActive() const = 0;
};
}
|
