summaryrefslogtreecommitdiff
path: root/src/mongo/db/catalog_raii.cpp
blob: 339a72655ce84b21faa93a854ebabd8be7c034da (plain)
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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191

/**
 *    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.
 */

#include "mongo/platform/basic.h"

#include "mongo/db/catalog_raii.h"

#include "mongo/db/catalog/database_holder.h"
#include "mongo/db/catalog/uuid_catalog.h"
#include "mongo/db/s/database_sharding_state.h"
#include "mongo/util/fail_point_service.h"

namespace mongo {
namespace {

MONGO_FAIL_POINT_DEFINE(setAutoGetCollectionWait);

void uassertLockTimeout(std::string resourceName, LockMode lockMode, bool isLocked) {
    uassert(ErrorCodes::LockTimeout,
            str::stream() << "Failed to acquire " << modeName(lockMode) << " lock for "
                          << resourceName
                          << " due to lock timeout.",
            isLocked);
}

}  // namespace

AutoGetDb::AutoGetDb(OperationContext* opCtx, StringData dbName, LockMode mode, Date_t deadline)
    : _dbLock(opCtx, dbName, mode, deadline), _db([&] {
          uassertLockTimeout(str::stream() << "database " << dbName, mode, _dbLock.isLocked());
          return DatabaseHolder::getDatabaseHolder().get(opCtx, dbName);
      }()) {
    if (_db) {
        DatabaseShardingState::get(_db).checkDbVersion(opCtx);
    }
}

AutoGetCollection::AutoGetCollection(OperationContext* opCtx,
                                     const NamespaceStringOrUUID& nsOrUUID,
                                     LockMode modeDB,
                                     LockMode modeColl,
                                     ViewMode viewMode,
                                     Date_t deadline)
    :  // The UUID to NamespaceString resolution is performed outside of any locks
      _resolvedNss(resolveNamespaceStringOrUUID(opCtx, nsOrUUID)),
      // The database locking is performed based on the resolved NamespaceString
      _autoDb(opCtx, _resolvedNss.db(), modeDB, deadline) {
    // In order to account for possible collection rename happening because the resolution from UUID
    // to NamespaceString was done outside of database lock, if UUID was specified we need to
    // re-resolve the _resolvedNss after acquiring the database lock so it has the correct value.
    //
    // Holding a database lock prevents collection renames, so this guarantees a stable UUID to
    // NamespaceString mapping.
    if (nsOrUUID.uuid())
        _resolvedNss = resolveNamespaceStringOrUUID(opCtx, nsOrUUID);

    _collLock.emplace(opCtx->lockState(), _resolvedNss.ns(), modeColl, deadline);
    uassertLockTimeout(
        str::stream() << "collection " << nsOrUUID.toString(), modeColl, _collLock->isLocked());

    // Wait for a configured amount of time after acquiring locks if the failpoint is enabled
    MONGO_FAIL_POINT_BLOCK(setAutoGetCollectionWait, customWait) {
        const BSONObj& data = customWait.getData();
        sleepFor(Milliseconds(data["waitForMillis"].numberInt()));
    }

    Database* const db = _autoDb.getDb();
    invariant(!nsOrUUID.uuid() || db,
              str::stream() << "Database for " << _resolvedNss.ns()
                            << " disappeared after successufully resolving "
                            << nsOrUUID.toString());

    // If the database doesn't exists, we can't obtain a collection or check for views
    if (!db)
        return;

    _coll = db->getCollection(opCtx, _resolvedNss);
    invariant(!nsOrUUID.uuid() || _coll,
              str::stream() << "Collection for " << _resolvedNss.ns()
                            << " disappeared after successufully resolving "
                            << nsOrUUID.toString());

    if (_coll) {
        // Unlike read concern majority, read concern snapshot cannot yield and wait when there are
        // pending catalog changes. Instead, we must return an error in such situations. We ignore
        // this restriction for the oplog, since it never has pending catalog changes.
        auto readConcernLevel = repl::ReadConcernArgs::get(opCtx).getLevel();
        auto mySnapshot = opCtx->recoveryUnit()->getPointInTimeReadTimestamp();
        if (readConcernLevel == repl::ReadConcernLevel::kSnapshotReadConcern && mySnapshot &&
            _resolvedNss != NamespaceString::kRsOplogNamespace) {
            auto minSnapshot = _coll->getMinimumVisibleSnapshot();
            uassert(
                ErrorCodes::SnapshotUnavailable,
                str::stream() << "Unable to read from a snapshot due to pending collection catalog "
                                 "changes; please retry the operation. Snapshot timestamp is "
                              << mySnapshot->toString()
                              << ". Collection minimum is "
                              << minSnapshot->toString(),
                !minSnapshot || *mySnapshot >= *minSnapshot);
        }

        // If the collection exists, there is no need to check for views.
        return;
    }

    _view = db->getViewCatalog()->lookup(opCtx, _resolvedNss.ns());
    uassert(ErrorCodes::CommandNotSupportedOnView,
            str::stream() << "Namespace " << _resolvedNss.ns() << " is a view, not a collection",
            !_view || viewMode == kViewsPermitted);
}

NamespaceString AutoGetCollection::resolveNamespaceStringOrUUID(OperationContext* opCtx,
                                                                NamespaceStringOrUUID nsOrUUID) {
    if (nsOrUUID.nss())
        return *nsOrUUID.nss();

    UUIDCatalog& uuidCatalog = UUIDCatalog::get(opCtx);
    auto resolvedNss = uuidCatalog.lookupNSSByUUID(*nsOrUUID.uuid());

    uassert(ErrorCodes::NamespaceNotFound,
            str::stream() << "Unable to resolve " << nsOrUUID.toString(),
            resolvedNss.isValid());

    uassert(ErrorCodes::NamespaceNotFound,
            str::stream() << "UUID " << nsOrUUID.toString() << " specified in " << nsOrUUID.dbname()
                          << " resolved to a collection in a different database: "
                          << resolvedNss.toString(),
            resolvedNss.db() == nsOrUUID.dbname());

    return resolvedNss;
}

AutoGetOrCreateDb::AutoGetOrCreateDb(OperationContext* opCtx,
                                     StringData dbName,
                                     LockMode mode,
                                     Date_t deadline) {
    invariant(mode == MODE_IX || mode == MODE_X);

    _autoDb.emplace(opCtx, dbName, mode, deadline);
    _db = _autoDb->getDb();

    // If the database didn't exist, relock in MODE_X
    if (!_db) {
        if (mode != MODE_X) {
            _autoDb.emplace(opCtx, dbName, MODE_X, deadline);
        }

        _db = DatabaseHolder::getDatabaseHolder().openDb(opCtx, dbName, &_justCreated);
    }

    DatabaseShardingState::get(_db).checkDbVersion(opCtx);
}

ConcealUUIDCatalogChangesBlock::ConcealUUIDCatalogChangesBlock(OperationContext* opCtx)
    : _opCtx(opCtx) {
    UUIDCatalog::get(_opCtx).onCloseCatalog(_opCtx);
}

ConcealUUIDCatalogChangesBlock::~ConcealUUIDCatalogChangesBlock() {
    invariant(_opCtx);
    UUIDCatalog::get(_opCtx).onOpenCatalog(_opCtx);
}

}  // namespace mongo