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
|
/**
* 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/catalog/collection.h"
namespace mongo {
/**
* Controls life-time of PlanCache entries associated with a particular collection of a particular
* version. A new copy of the collection is created each time the collection
* changes (copy-on-write policy). The collection version is incremented only after changes that
* require invalidating the plan cache (for example, creating an index or deleting the collection).
* If the catalog change does not require invalidation of plan cache entries (for example, changing
* the document validator), then the collection version remains unchanged.
*/
class PlanCacheInvalidator {
public:
PlanCacheInvalidator() = default;
PlanCacheInvalidator(const CollectionPtr& collection, ServiceContext* serviceContext);
~PlanCacheInvalidator();
/**
* Forces SBE PlanCache invalidation for the collection UUID and version stored in this
* invalidator.
*/
void clearPlanCache() const;
size_t versionNumber() const {
return _version;
}
private:
// "Version" of the collection, increased any time we need to invalidate PlanCache.
const size_t _version{};
// The collection's UUID.
const boost::optional<UUID> _uuid{};
ServiceContext* const _serviceContext{};
};
} // namespace mongo
|