aboutsummaryrefslogtreecommitdiffstats
path: root/storage/src/vespa/storage/distributor/idealstatemanager.cpp
blob: 59dbecc4397e7a0b72b003413d408f2e30111db1 (plain) (blame)
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
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.

#include "idealstatemanager.h"
#include "statecheckers.h"
#include "top_level_distributor.h"
#include "idealstatemetricsset.h"
#include "distributor_bucket_space_repo.h"
#include "distributor_bucket_space.h"
#include <vespa/vespalib/stllike/asciistream.h>
#include <vespa/storageapi/message/persistence.h>
#include <vespa/document/bucket/fixed_bucket_spaces.h>
#include <vespa/vespalib/util/assert.h>

#include <vespa/log/log.h>
LOG_SETUP(".distributor.idealstatemanager");

using document::BucketSpace;
using storage::lib::Node;
using storage::lib::NodeType;

namespace storage::distributor {

IdealStateManager::IdealStateManager(const DistributorNodeContext& node_ctx,
                                     DistributorStripeOperationContext& op_ctx,
                                     IdealStateMetricSet& metrics)
    : _metrics(metrics),
      _stateCheckers(),
      _splitBucketStateChecker(nullptr),
      _node_ctx(node_ctx),
      _op_ctx(op_ctx),
      _has_logged_phantom_replica_warning(false)
{
    _stateCheckers.emplace_back(std::make_shared<BucketStateStateChecker>());
    _stateCheckers.emplace_back(std::make_shared<SplitBucketStateChecker>());
    _splitBucketStateChecker = dynamic_cast<SplitBucketStateChecker *>(_stateCheckers.back().get());
    _stateCheckers.emplace_back(std::make_shared<SplitInconsistentStateChecker>());
    _stateCheckers.emplace_back(std::make_shared<SynchronizeAndMoveStateChecker>());
    _stateCheckers.emplace_back(std::make_shared<JoinBucketsStateChecker>());
    _stateCheckers.emplace_back(std::make_shared<DeleteExtraCopiesStateChecker>());
    _stateCheckers.emplace_back(std::make_shared<GarbageCollectionStateChecker>());
}

IdealStateManager::~IdealStateManager() = default;

void
IdealStateManager::print(std::ostream& out, bool verbose, const std::string& indent)
{
    (void) verbose; (void) indent;
    out << "IdealStateManager";
}

namespace {

/*
 * Since state checkers are in prioritized order, don't allow
 * overwriting if already explicitly set.
 */
bool
canOverwriteResult(const StateChecker::Result& existing, const StateChecker::Result& candidate)
{
    return (!existing.getPriority().requiresMaintenance()
            && candidate.getPriority().requiresMaintenance());
}

}

StateChecker::Result
IdealStateManager::runStateCheckers(const StateChecker::Context& c) const
{
    auto highestPri = StateChecker::Result::noMaintenanceNeeded();
    // We go through _all_ active state checkers so that statistics can be
    // collected across all checkers, not just the ones that are highest pri.
    for (const auto & checker : _stateCheckers) {
        if (!operation_context().distributor_config().stateCheckerIsActive(checker->getName())) {
            LOG(spam, "Skipping state checker %s", checker->getName());
            continue;
        }

        auto result = checker->check(c);
        if (canOverwriteResult(highestPri, result)) {
            highestPri = std::move(result);
        }
    }
    return highestPri;
}

void
IdealStateManager::verify_only_live_nodes_in_context(const StateChecker::Context& c) const {
    if (_has_logged_phantom_replica_warning) {
        return;
    }
    for (const auto& n : c.entry()->getRawNodes()) {
        const uint16_t index = n.getNode();
        const auto& state = c.systemState.getNodeState(lib::Node(lib::NodeType::STORAGE, index));
        // Only nodes in Up, Initializing or Retired should ever be present in the DB.
        if (!state.getState().oneOf("uir")) {
            LOG(error, "%s in bucket DB is on node %u, which is in unavailable state %s. Current cluster state is '%s'",
                       c.entry().getBucketId().toString().c_str(), index, state.getState().toString().c_str(),
                       c.systemState.toString().c_str());
            ASSERT_ONCE_OR_LOG(false, "Bucket DB contains replicas on unavailable node", 10000);
            _has_logged_phantom_replica_warning = true;
        }
    }
}

StateChecker::Result
IdealStateManager::generateHighestPriority(const document::Bucket& bucket, NodeMaintenanceStatsTracker& statsTracker) const
{
    auto& distributorBucketSpace = _op_ctx.bucket_space_repo().get(bucket.getBucketSpace());
    StateChecker::Context c(node_context(), operation_context(), distributorBucketSpace, statsTracker, bucket);
    c.fillParentAndChildBuckets();
    c.fillSiblingBucket();

    const BucketDatabase::Entry* e(c.getEntryForPrimaryBucket());
    if (!e) {
        return StateChecker::Result::noMaintenanceNeeded();
    }
    LOG(spam, "Checking bucket %s", e->toString().c_str());

    c.set_entry(*e);
    verify_only_live_nodes_in_context(c);
    return runStateCheckers(c);
}

MaintenancePriorityAndType
IdealStateManager::prioritize(const document::Bucket& bucket, NodeMaintenanceStatsTracker& statsTracker) const
{
    StateChecker::Result generated(generateHighestPriority(bucket, statsTracker));
    MaintenancePriority priority(generated.getPriority());
    MaintenanceOperation::Type type(priority.requiresMaintenance()
                                    ? generated.getType()
                                    : MaintenanceOperation::OPERATION_COUNT);
    return {priority, type};
}

IdealStateOperation::SP
IdealStateManager::generateInterceptingSplit(BucketSpace bucketSpace, const BucketDatabase::Entry& e,
                                             api::StorageMessage::Priority pri)
{
    if ( ! e.valid()) return {};

    NodeMaintenanceStatsTracker statsTracker;
    document::Bucket bucket(bucketSpace, e.getBucketId());
    auto& distributorBucketSpace = _op_ctx.bucket_space_repo().get(bucket.getBucketSpace());
    StateChecker::Context c(node_context(), operation_context(), distributorBucketSpace, statsTracker, bucket);
    c.set_entry(e);

    IdealStateOperation::UP operation(_splitBucketStateChecker->check(c).createOperation());
    if (operation.get()) {
        operation->setPriority(pri);
        operation->setIdealStateManager(this);
    }

    return operation;
}

MaintenanceOperation::SP
IdealStateManager::generate(const document::Bucket& bucket) const
{
    NodeMaintenanceStatsTracker statsTracker;
    IdealStateOperation::SP op(generateHighestPriority(bucket, statsTracker).createOperation());
    if (op.get()) {
        op->setIdealStateManager(const_cast<IdealStateManager*>(this));
    }
    return op;
}

std::vector<MaintenanceOperation::SP>
IdealStateManager::generateAll(const document::Bucket &bucket, NodeMaintenanceStatsTracker& statsTracker) const
{
    auto& distributorBucketSpace = _op_ctx.bucket_space_repo().get(bucket.getBucketSpace());
    StateChecker::Context c(node_context(), operation_context(), distributorBucketSpace, statsTracker, bucket);
    c.fillParentAndChildBuckets();
    c.fillSiblingBucket();
    const BucketDatabase::Entry* e(c.getEntryForPrimaryBucket());
    std::vector<MaintenanceOperation::SP> operations;
    if (e) {
        c.set_entry(*e);
    } else {
        return operations;
    }

    for (const auto & checker : _stateCheckers) {
        IdealStateOperation::UP op(checker->check(c).createOperation());
        if (op) {
            operations.emplace_back(std::move(op));
        }
    }
    return operations;
}

void
IdealStateManager::getBucketStatus(BucketSpace bucketSpace, const BucketDatabase::ConstEntryRef& entry,
                                   NodeMaintenanceStatsTracker& statsTracker, std::ostream& out) const
{
    document::Bucket bucket(bucketSpace, entry.getBucketId());
    std::vector<MaintenanceOperation::SP> operations(generateAll(bucket, statsTracker));
    if (operations.empty()) {
        out << entry.getBucketId() << " : ";
    } else {
        out << "<b>" << entry.getBucketId() << ":</b> <i> : ";
    }
    for (uint32_t i = 0; i < operations.size(); ++i) {
        const MaintenanceOperation& op(*operations[i]);
        if (i > 0) {
            out << ", ";
        }
        out << op.getName() << ": " << op.getDetailedReason();
    }
    if (!operations.empty()) {
        out << "</i> ";
    }
    out << "[" << entry->toString() << "]<br>\n";
}

void
IdealStateManager::dump_bucket_space_db_status(document::BucketSpace bucket_space, std::ostream& out) const {
    StatusBucketVisitor proc(*this, bucket_space, out);
    auto& distributorBucketSpace = _op_ctx.bucket_space_repo().get(bucket_space);
    distributorBucketSpace.getBucketDatabase().for_each_upper_bound(proc);
}

void
IdealStateManager::getBucketStatus(std::ostream& out) const {
    LOG(debug, "Dumping bucket database valid at cluster state version %u",
        operation_context().cluster_state_bundle().getVersion());

    for (auto& space : _op_ctx.bucket_space_repo()) {
        out << "<h2>" << document::FixedBucketSpaces::to_string(space.first) << " - " << space.first << "</h2>\n";
        dump_bucket_space_db_status(space.first, out);
    }
}

} // storage::distributor