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
|
/**
* 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 "mongo/db/ttl_collection_cache.h"
#include "mongo/util/background.h"
namespace mongo {
class ServiceContext;
/**
* Instantiates the TTLMonitor to periodically remove documents from TTL collections. Safe to call
* again after shutdownTTLMonitor() has been called.
*/
void startTTLMonitor(ServiceContext* serviceContext);
/**
* Shuts down the TTLMonitor if it is running. Safe to call multiple times.
*/
void shutdownTTLMonitor(ServiceContext* serviceContext);
class TTLMonitor : public BackgroundJob {
public:
explicit TTLMonitor() : BackgroundJob(false /* selfDelete */) {}
static TTLMonitor* get(ServiceContext* serviceCtx);
static void set(ServiceContext* serviceCtx, std::unique_ptr<TTLMonitor> monitor);
std::string name() const {
return "TTLMonitor";
}
void run();
/**
* Signals the thread to quit and then waits until it does.
*/
void shutdown();
long long getTTLPasses_forTest();
long long getTTLSubPasses_forTest();
private:
friend class TTLTest;
/**
* Deletes all expired documents. May consist of several sub-passes.
*/
void _doTTLPass();
/**
* A sub-pass iterates over a list of TTL indexes until there are no more expired documents to
* delete or 'ttlSubPassTargetSecs' is exceeded.
*
* Once it is confirmed there are no more expired documents on an index, the index will not be
* visited again for the remainder of the sub-pass.
*
* Returns true if there are more expired documents to delete. False otherwise.
*/
bool _doTTLSubPass(OperationContext* opCtx);
/**
* Given a TTL index, attempts to delete all expired documents through the index until
* - hitting the batched delete document or time limit for a single TTL index
* - removing all expired documents corresponding to the TTLIndex
* - reaching an error
*
* Returns true if there are more expired documents to delete (a batched delete limit is met).
* Returns false if there are no more expired documents to delete at this time - including when
* errors specific to the TTL index are reached.
*
* When batching is disabled, always returns false since all expired documents are guaranteed to
* be removed.
*
* In some cases (i.e: on temporary resharding collections, collections pending to be dropped,
* etc), the TTLMonitor is prohibitied from removing expired documents - returns false in these
* scenarios as well.
*/
bool _doTTLIndexDelete(OperationContext* opCtx,
TTLCollectionCache* ttlCollectionCache,
const UUID& uuid,
const TTLCollectionCache::Info& info);
/**
* Removes documents from the collection using the specified TTL index after a sufficient
* amount of time has passed according to its expiry specification.
*
* Returns true if there are more expired documents to delete through the index at this time.
* False otherwise.
*
* When batching is disabled, always returns false since all expired documents are guaranteed to
* be removed.
*/
bool _deleteExpiredWithIndex(OperationContext* opCtx,
TTLCollectionCache* ttlCollectionCache,
const CollectionPtr& collection,
std::string indexName);
/*
* Removes expired documents from a clustered collection using a bounded collection scan.
* On time-series buckets collections, TTL operates on type 'ObjectId'. On general purpose
* collections, TTL operates on type 'Date'.
*
* Returns true if there are more expired documents to delete through the clustered index at
* this time. False otherwise.
*
* When batching is disabled, always returns false since all expired documents are guaranteed to
* be removed.
*/
bool _deleteExpiredWithCollscan(OperationContext* opCtx,
TTLCollectionCache* ttlCollectionCache,
const CollectionPtr& collection);
// Protects the state below.
mutable Mutex _stateMutex = MONGO_MAKE_LATCH("TTLMonitorStateMutex");
// Signaled to wake up the thread, if the thread is waiting. The thread will check whether
// _shuttingDown is set and stop accordingly.
mutable stdx::condition_variable _shuttingDownCV;
bool _shuttingDown = false;
};
} // namespace mongo
|
