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
|
/**
* Copyright (C) 2020-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/operation_context.h"
#include "mongo/db/repl/tenant_migration_access_blocker_registry.h"
#include "mongo/db/repl/tenant_migration_conflict_info.h"
#include "mongo/db/repl/tenant_migration_donor_access_blocker.h"
#include "mongo/db/repl/tenant_migration_recipient_access_blocker.h"
#include "mongo/db/repl/tenant_migration_state_machine_gen.h"
namespace mongo {
namespace tenant_migration_access_blocker {
std::shared_ptr<TenantMigrationDonorAccessBlocker> getTenantMigrationDonorAccessBlocker(
ServiceContext* const serviceContext, StringData tenantId);
std::shared_ptr<TenantMigrationRecipientAccessBlocker> getTenantMigrationRecipientAccessBlocker(
ServiceContext* const serviceContext, StringData tenantId);
/**
* Returns a TenantMigrationDonorDocument constructed from the given bson doc and validate the
* resulting doc.
*/
TenantMigrationDonorDocument parseDonorStateDocument(const BSONObj& doc);
/**
* Checks if a request is allowed to read based on the tenant migration states of this node as a
* donor or as a recipient. TenantMigrationCommitted is returned if the request needs to be
* re-routed to the new owner of the tenant. If the tenant is currently being migrated and the
* request needs to block, a future for when the request is unblocked is returned, and the promise
* will be set for the returned future when the migration is committed or aborted. Note: for better
* performance, check if the future is immediately ready.
*/
SemiFuture<void> checkIfCanReadOrBlock(OperationContext* opCtx, const OpMsgRequest& request);
/**
* If the operation has read concern "linearizable", throws TenantMigrationCommitted error if the
* database has been migrated to a different replica set.
*/
void checkIfLinearizableReadWasAllowedOrThrow(OperationContext* opCtx, StringData dbName);
/**
* Throws TenantMigrationConflict if the database is being migrated and the migration is in the
* blocking state. Throws TenantMigrationCommitted if it is in committed.
*/
void checkIfCanWriteOrThrow(OperationContext* opCtx, StringData dbName);
/**
* Returns TenantMigrationConflict if the database is being migrated (even if migration is not yet
* in the blocking state). Returns TenantMigrationCommitted if it is in committed.
*/
Status checkIfCanBuildIndex(OperationContext* opCtx, StringData dbName);
/**
* Scan config.tenantMigrationDonors and creates the necessary TenantMigrationAccessBlockers for
* unfinished migrations.
*/
void recoverTenantMigrationAccessBlockers(OperationContext* opCtx);
/**
* Blocks until the migration commits or aborts, then returns TenantMigrationCommitted or
* TenantMigrationAborted.
*/
void handleTenantMigrationConflict(OperationContext* opCtx, Status status);
/**
* Appends a no-op to the oplog.
*/
void performNoopWrite(OperationContext* opCtx, StringData msg);
/**
* Returns true if the node is in startup recovery, initial sync or rollback. If the node is any
* of these mode, the TenantMigrationAccessBlocker will be recovered outside of the OpObserver
* by tenant_migration_access_blocker::recoverTenantMigrationAccessBlockers.
*/
bool inRecoveryMode(OperationContext* opCtx);
} // namespace tenant_migration_access_blocker
} // namespace mongo
|
