summaryrefslogtreecommitdiff
path: root/src/mongo/db/snapshot_window_util_test.cpp
blob: 3956a9f9b71e1006a2860ec873f9ee44a0176d7a (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
192
193
194
195
196
197
198
199
200
201
/**
 *    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/snapshot_window_util.h"

#include "mongo/db/client.h"
#include "mongo/db/service_context.h"
#include "mongo/db/service_context_devnull_test_fixture.h"
#include "mongo/db/snapshot_window_options.h"
#include "mongo/db/storage/storage_options.h"
#include "mongo/unittest/unittest.h"

namespace mongo {
namespace {

using namespace SnapshotWindowUtil;

/**
 * Tests the functions in snapshot_window_util.h using a devnull storage engine.
 */
class SnapshotWindowTest : public ServiceContextDevnullTestFixture {
public:
    void setUp() override {
        ServiceContextDevnullTestFixture::setUp();
        _opCtx = cc().makeOperationContext();
    }

    void tearDown() override {
        _opCtx.reset();
        ServiceContextDevnullTestFixture::tearDown();
    }

    ServiceContext::UniqueOperationContext _opCtx;
};

TEST_F(SnapshotWindowTest, DecreaseAndIncreaseSnapshotWindow) {
    auto engine = getServiceContext()->getStorageEngine();
    invariant(engine);

    snapshotWindowParams.maxTargetSnapshotHistoryWindowInSeconds.store(100);
    snapshotWindowParams.targetSnapshotHistoryWindowInSeconds.store(100);

    // Lower the time enforced between function calls to speed up testing.
    snapshotWindowParams.minMillisBetweenSnapshotWindowInc.store(100);

    // Stabilize for the test so we know that we are testing things as expected.
    snapshotWindowParams.snapshotWindowAdditiveIncreaseSeconds.store(2);
    snapshotWindowParams.snapshotWindowMultiplicativeDecrease.store(0.75);

    auto maxTargetSnapshotWindowSeconds =
        snapshotWindowParams.maxTargetSnapshotHistoryWindowInSeconds.load();
    auto snapshotWindowSeconds = snapshotWindowParams.targetSnapshotHistoryWindowInSeconds.load();
    ASSERT_EQ(maxTargetSnapshotWindowSeconds, snapshotWindowSeconds);

    auto windowMultiplicativeDecrease =
        snapshotWindowParams.snapshotWindowMultiplicativeDecrease.load();
    auto windowAdditiveIncrease = snapshotWindowParams.snapshotWindowAdditiveIncreaseSeconds.load();

    auto minTimeBetweenInc = snapshotWindowParams.minMillisBetweenSnapshotWindowInc.load();

    /**
     * Test that trying to decrease the window size FAILS when there have been no writes to the
     * cache overflow table.
     */

    decreaseTargetSnapshotWindowSize(_opCtx.get());
    auto snapshotWindowSecondsOne =
        snapshotWindowParams.targetSnapshotHistoryWindowInSeconds.load();

    ASSERT_EQ(snapshotWindowSeconds, snapshotWindowSecondsOne);

    /**
     * Test that trying to decrease the window size SUCCEEDS when there have been writes to the
     * cache overflow table.
     */

    engine->setCacheOverflowTableInsertCountForTest(1);

    decreaseTargetSnapshotWindowSize(_opCtx.get());
    auto snapshotWindowSecondsTwo =
        snapshotWindowParams.targetSnapshotHistoryWindowInSeconds.load();

    ASSERT_GT(snapshotWindowSecondsOne, snapshotWindowSecondsTwo);
    ASSERT_EQ(snapshotWindowSecondsTwo,
              static_cast<int>(snapshotWindowSeconds * windowMultiplicativeDecrease));

    /**
     * Test that trying to decrease the window size FAILS when there have been writes to the
     * cache overflow table AND SnapshotTooOld errors have occurred.
     */

    engine->setCacheOverflowTableInsertCountForTest(2);
    incrementSnapshotTooOldErrorCount();

    decreaseTargetSnapshotWindowSize(_opCtx.get());
    auto snapshotWindowSecondsThree =
        snapshotWindowParams.targetSnapshotHistoryWindowInSeconds.load();

    ASSERT_EQ(snapshotWindowSecondsTwo, snapshotWindowSecondsThree);

    /**
     * Now test again that decreasing the size SUCCEEDS when there have been writes to the cache
     * overflow table again (without any further SnapshotTooOld errors).
     */

    engine->setCacheOverflowTableInsertCountForTest(3);

    decreaseTargetSnapshotWindowSize(_opCtx.get());
    auto snapshotWindowSecondsFour =
        snapshotWindowParams.targetSnapshotHistoryWindowInSeconds.load();

    ASSERT_GT(snapshotWindowSecondsThree, snapshotWindowSecondsFour);
    ASSERT_EQ(snapshotWindowSecondsFour,
              static_cast<int>(snapshotWindowSecondsThree * windowMultiplicativeDecrease));

    /**
     * Test that increasing the size SUCCEEDS.
     */

    increaseTargetSnapshotWindowSize(_opCtx.get());
    auto snapshotWindowSecondsFive =
        snapshotWindowParams.targetSnapshotHistoryWindowInSeconds.load();

    ASSERT_EQ(snapshotWindowSecondsFive, snapshotWindowSecondsFour + windowAdditiveIncrease);

    /**
     * Test that increasing the size SUCCEEDS even when there have been writes to the cache overflow
     * table.
     */

    // Sleep for a time because increaseTargetSnapshotWindowSize() enforces a wait time between
    // updates.
    sleepmillis(2 * minTimeBetweenInc);

    engine->setCacheOverflowTableInsertCountForTest(4);

    increaseTargetSnapshotWindowSize(_opCtx.get());
    auto snapshotWindowSecondsSix =
        snapshotWindowParams.targetSnapshotHistoryWindowInSeconds.load();

    ASSERT_EQ(snapshotWindowSecondsSix, snapshotWindowSecondsFive + windowAdditiveIncrease);

    /**
     * Test that the size cannot be increased above the maximum size.
     */

    // Bump up the additive increase to make this run faster.
    snapshotWindowParams.snapshotWindowAdditiveIncreaseSeconds.store(9);
    windowAdditiveIncrease = snapshotWindowParams.snapshotWindowAdditiveIncreaseSeconds.load();

    // Integers round down, so add 1 to make sure it reaches the max.
    int numIncreasesToReachMax =
        (maxTargetSnapshotWindowSeconds - snapshotWindowSecondsSix) / windowAdditiveIncrease + 1;
    for (int i = 0; i < numIncreasesToReachMax; ++i) {
        sleepmillis(2 * minTimeBetweenInc);
        increaseTargetSnapshotWindowSize(_opCtx.get());
    }

    // Should be at max.
    auto snapshotWindowSecondsSeven =
        snapshotWindowParams.targetSnapshotHistoryWindowInSeconds.load();
    ASSERT_EQ(snapshotWindowSecondsSeven, maxTargetSnapshotWindowSeconds);

    // An attempt to increase beyond max should have no effect.
    sleepmillis(2 * minTimeBetweenInc);
    increaseTargetSnapshotWindowSize(_opCtx.get());
    auto snapshotWindowSecondsEight =
        snapshotWindowParams.targetSnapshotHistoryWindowInSeconds.load();
    ASSERT_EQ(snapshotWindowSecondsEight, maxTargetSnapshotWindowSeconds);
}

}  // namespace
}  // namespace mongo