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
|
/**
* Copyright (C) 2021-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/commands/change_stream_options_gen.h"
#include "mongo/db/service_context.h"
#include "mongo/platform/mutex.h"
#include "mongo/util/hierarchical_acquisition.h"
#include "mongo/util/periodic_runner.h"
namespace mongo {
namespace preImageRemoverInternal {
/**
* Specifies attributes that determines if the pre-image has been expired or not.
*/
struct PreImageAttributes {
mongo::UUID collectionUUID;
Timestamp ts;
Date_t operationTime;
/**
* Determines if the pre-image is considered expired based on the expiration parameter being
* set.
*/
bool isExpiredPreImage(const boost::optional<Date_t>& preImageExpirationTime,
const Timestamp& earliestOplogEntryTimestamp);
};
boost::optional<Date_t> getPreImageExpirationTime(OperationContext* opCtx, Date_t currentTime);
} // namespace preImageRemoverInternal
class ServiceContext;
/**
* A periodic background job to remove expired documents from 'system.preimages' collection. A
* document in this collection is considered expired if its corresponding oplog entry falls off the
* oplog.
*/
class PeriodicChangeStreamExpiredPreImagesRemover final {
public:
static PeriodicChangeStreamExpiredPreImagesRemover& get(ServiceContext* serviceContext);
PeriodicJobAnchor& operator*() const noexcept;
PeriodicJobAnchor* operator->() const noexcept;
private:
void _init(ServiceContext* serviceContext);
inline static const auto _serviceDecoration =
ServiceContext::declareDecoration<PeriodicChangeStreamExpiredPreImagesRemover>();
mutable Mutex _mutex = MONGO_MAKE_LATCH(HierarchicalAcquisitionLevel(1),
"PeriodicChangeStreamExpiredPreImagesRemover::_mutex");
std::shared_ptr<PeriodicJobAnchor> _anchor;
};
} // namespace mongo
|
