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
|
// Copyright 2017 Yahoo Holdings. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
#pragma once
#include <vespa/storage/distributor/operations/operation.h>
#include <vespa/storage/bucketdb/bucketdatabase.h>
#include <vespa/storage/visiting/memory_bounded_trace.h>
#include <vespa/storageapi/defs.h>
#include <vespa/storageapi/messageapi/storagemessage.h>
#include <vespa/storageapi/message/visitor.h>
#include <vespa/storageframework/generic/clock/timer.h>
namespace document { class Document; }
namespace storage { struct VisitorMetricSet; }
namespace storage::lib { class ClusterState; }
namespace storage::distributor {
class DistributorComponent;
class DistributorBucketSpace;
class VisitorOperation : public Operation
{
public:
struct Config {
Config(uint32_t minBucketsPerVisitor_,
uint32_t maxVisitorsPerNodePerVisitor_)
: minBucketsPerVisitor(minBucketsPerVisitor_),
maxVisitorsPerNodePerVisitor(maxVisitorsPerNodePerVisitor_) {}
uint32_t minBucketsPerVisitor;
uint32_t maxVisitorsPerNodePerVisitor;
};
VisitorOperation(DistributorComponent& manager,
DistributorBucketSpace &bucketSpace,
const std::shared_ptr<api::CreateVisitorCommand> & msg,
const Config& config,
VisitorMetricSet& metrics);
~VisitorOperation();
void onClose(DistributorMessageSender& sender) override;
void onStart(DistributorMessageSender& sender) override;
void onReceive(DistributorMessageSender& sender,
const std::shared_ptr<api::StorageReply> & msg) override;
const char* getName() const override { return "visit"; }
std::string getStatus() const override { return ""; }
private:
struct BucketInfo {
bool done;
int activeNode;
uint16_t failedCount;
std::vector<uint16_t> triedNodes;
BucketInfo() : done(false), activeNode(-1), failedCount(0), triedNodes() { }
void print(vespalib::asciistream & out) const;
vespalib::string toString() const;
};
typedef std::map<document::BucketId, BucketInfo> VisitBucketMap;
struct SuperBucketInfo {
document::BucketId bid;
bool subBucketsCompletelyExpanded;
VisitBucketMap subBuckets;
std::vector<document::BucketId> subBucketsVisitOrder;
SuperBucketInfo(const document::BucketId& b = document::BucketId(0))
: bid(b),
subBucketsCompletelyExpanded(false)
{
}
};
typedef std::map<uint16_t, std::vector<document::BucketId> > NodeToBucketsMap;
typedef std::map<uint64_t, api::CreateVisitorCommand::SP> SentMessagesMap;
void sendReply(const api::ReturnCode& code, DistributorMessageSender& sender);
void updateReplyMetrics(const api::ReturnCode& result);
void verifyDistributorsAreAvailable();
void verifyVisitorDistributionBitCount(const document::BucketId&);
void verifyDistributorIsNotDown(const lib::ClusterState&);
void verifyDistributorOwnsBucket(const document::BucketId&);
void verifyOperationContainsBuckets();
void verifyOperationHasSuperbucketAndProgress();
void verifyOperationSentToCorrectDistributor();
bool verifyCreateVisitorCommand(DistributorMessageSender& sender);
bool pickBucketsToVisit(const std::vector<BucketDatabase::Entry>& buckets);
bool expandBucketAll();
bool expandBucketContaining();
bool expandBucketContained();
void expandBucket();
int pickTargetNode(
const BucketDatabase::Entry& entry,
const std::vector<uint16_t>& triedNodes);
void attemptToParseOrderingSelector();
bool documentSelectionMayHaveOrdering() const;
bool parseDocumentSelection(DistributorMessageSender& sender);
bool maySendNewStorageVisitors() const noexcept;
void startNewVisitors(DistributorMessageSender& sender);
void initializeActiveNodes();
bool shouldSkipBucket(const BucketInfo& bucketInfo) const;
bool bucketIsValidAndConsistent(const BucketDatabase::Entry& entry) const;
bool allowInconsistencies() const noexcept;
bool shouldAbortDueToTimeout() const noexcept;
bool assignBucketsToNodes(NodeToBucketsMap& nodeToBucketsMap);
int getNumVisitorsToSendForNode(uint16_t node,
uint32_t totalBucketsOnNode) const;
uint32_t computeVisitorQueueTimeoutMs() const noexcept;
bool sendStorageVisitors(const NodeToBucketsMap& nodeToBucketsMap,
DistributorMessageSender& sender);
void sendStorageVisitor(uint16_t node,
const std::vector<document::BucketId>& buckets,
uint32_t pending,
DistributorMessageSender& sender);
void markCompleted(const document::BucketId& bid,
const api::ReturnCode& code);
/**
* Operation failed and we can pin the blame on a specific node. Updates
* internal error code and augments error message with the index of the
* failing node.
*/
void markOperationAsFailedDueToNodeError(
const api::ReturnCode& result,
uint16_t fromFailingNodeIndex);
/**
* Operation failed but cannot blame a specific node in the failing context.
* Only overwrites current error code if `result` has a higher numeric
* code value, which avoids overwriting more critical errors.
*/
void markOperationAsFailed(const api::ReturnCode& result);
bool isSpecialBucketForOrderDoc(const document::BucketId& bucketId) const;
std::vector<document::BucketId>::const_iterator addSpecialBucketsForOrderDoc(
std::vector<document::BucketId>::const_iterator iter,
std::vector<document::BucketId>::const_iterator end);
/**
* Compute time remaining of visitor in milliseconds, relative to timeout
* time point. In case of the current time having passed the timeout
* point, function returns 0.
*/
uint64_t timeLeft() const noexcept;
std::unique_ptr<document::OrderingSpecification> _ordering;
DistributorComponent& _owner;
DistributorBucketSpace &_bucketSpace;
SentMessagesMap _sentMessages;
api::CreateVisitorCommand::SP _msg;
api::ReturnCode _storageError;
bool _sentReply;
SuperBucketInfo _superBucket;
document::BucketId _lastBucket;
api::Timestamp _fromTime;
api::Timestamp _toTime;
std::vector<uint32_t> _activeNodes;
uint32_t _bucketCount;
vdslib::VisitorStatistics _visitorStatistics;
Config _config;
VisitorMetricSet& _metrics;
MemoryBoundedTrace _trace;
static constexpr size_t TRACE_SOFT_MEMORY_LIMIT = 65536;
bool done();
bool hasNoPendingMessages();
document::BucketId getLastBucketVisited();
mbus::TraceNode trace;
framework::MilliSecTimer _operationTimer;
};
}
|
