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
|
/**
* Copyright (C) 2018-present MongoDB, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the Server Side Public License, version 1,
* as published by MongoDB, Inc.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* Server Side Public License for more details.
*
* You should have received a copy of the Server Side Public License
* along with this program. If not, see
* <http://www.mongodb.com/licensing/server-side-public-license>.
*
* As a special exception, the copyright holders give permission to link the
* code of portions of this program with the OpenSSL library under certain
* conditions as described in each individual source file and distribute
* linked combinations including the program with the OpenSSL library. You
* must comply with the Server Side Public License in all respects for
* all of the code used other than as permitted herein. If you modify file(s)
* with this exception, you may extend this exception to your version of the
* file(s), but you are not obligated to do so. If you do not wish to do so,
* delete this exception statement from your version. If you delete this
* exception statement from all source files in the program, then also delete
* it in the license file.
*/
#pragma once
#include <boost/optional.hpp>
#include <map>
#include <set>
#include <string>
#include "mongo/base/string_data.h"
#include "mongo/bson/timestamp.h"
#include "mongo/db/namespace_string.h"
#include "mongo/db/storage/kv/kv_engine.h"
#include "mongo/platform/mutex.h"
namespace mongo {
/**
* This class manages idents in the KV storage engine that are marked as drop-pending by the
* two-phase algorithm.
*
* Replicated collections and indexes that are dropped are not permanently removed from the storage
* system when the drop request is first processed. The catalog entry is removed to render the
* collection or index inaccessible to user operations but the underlying ident is retained in the
* event we have to recover the collection. This is relevant mostly to rollback and startup
* recovery.
*
* On receiving a notification that the oldest timestamp queued has advanced and become part of the
* checkpoint, some drop-pending idents will become safe to remove permanently. The function
* dropldentsOlderThan() is provided for this purpose.
*/
class KVDropPendingIdentReaper {
KVDropPendingIdentReaper(const KVDropPendingIdentReaper&) = delete;
KVDropPendingIdentReaper& operator=(const KVDropPendingIdentReaper&) = delete;
public:
explicit KVDropPendingIdentReaper(KVEngine* engine);
virtual ~KVDropPendingIdentReaper() = default;
/**
* Adds a new drop-pending ident, with its drop timestamp and namespace, to be managed by this
* class.
*/
void addDropPendingIdent(const Timestamp& dropTimestamp,
const NamespaceString& nss,
StringData ident);
/**
* Returns earliest drop timestamp in '_dropPendingIdents'.
* Returns boost::none if '_dropPendingIdents' is empty.
*/
boost::optional<Timestamp> getEarliestDropTimestamp() const;
/**
* Returns drop-pending idents in a sorted set.
* Used by the storage engine during catalog reconciliation.
*/
std::set<std::string> getAllIdents() const;
/**
* Notifies this class that the storage engine has advanced its oldest timestamp.
* Drops all drop-pending idents with drop timestamps before 'ts'.
* After this function returns, all entries in '_dropPendingIdents' will have drop
* timestamps more recent than 'ts'.
*/
void dropIdentsOlderThan(OperationContext* opCtx, const Timestamp& ts);
/**
* Clears maps of drop pending idents but does not drop idents in storage engine.
* Used by rollback after recovering to a stable timestamp.
*/
void clearDropPendingState();
private:
// Container type for drop-pending namespaces. We use a multimap so that we can order the
// namespaces by drop optime. Additionally, it is possible for certain user operations (such
// as renameCollection across databases) to generate more than one drop-pending namespace for
// the same drop optime.
using IdentInfo = struct {
NamespaceString nss;
std::string ident;
};
using DropPendingIdents = std::multimap<Timestamp, IdentInfo>;
// Used to access the KV engine for the purposes of dropping the ident.
KVEngine* const _engine;
// Guards access to member variables below.
mutable Mutex _mutex = MONGO_MAKE_LATCH("KVDropPendingIdentReaper::_mutex");
// Drop-pending idents. Ordered by drop timestamp.
DropPendingIdents _dropPendingIdents;
};
} // namespace mongo
|