summaryrefslogtreecommitdiffstats
path: root/storage/src/tests/persistence/persistencequeuetest.cpp
blob: a212e65efe86f7b2dc90278270471673a35abb3a (plain) (blame)
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
202
203
204
// Copyright 2017 Yahoo Holdings. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.

#include <vespa/log/log.h>
#include <vespa/vdstestlib/cppunit/macros.h>
#include <vespa/storageapi/message/bucket.h>
#include <tests/persistence/common/persistenceproviderwrapper.h>
#include <vespa/persistence/dummyimpl/dummypersistence.h>
#include <tests/persistence/common/filestortestfixture.h>
#include <tests/persistence/filestorage/forwardingmessagesender.h>
#include <vespa/document/test/make_document_bucket.h>

LOG_SETUP(".persistencequeuetest");

using document::test::makeDocumentBucket;

namespace storage {

class PersistenceQueueTest : public FileStorTestFixture {
public:
    void testFetchNextUnlockedMessageIfBucketLocked();
    void shared_locked_operations_allow_concurrent_bucket_access();
    void exclusive_locked_operation_not_started_if_shared_op_active();
    void shared_locked_operation_not_started_if_exclusive_op_active();
    void exclusive_locked_operation_not_started_if_exclusive_op_active();
    void operation_batching_not_allowed_across_different_lock_modes();

    std::shared_ptr<api::StorageMessage> createPut(uint64_t bucket, uint64_t docIdx);
    std::shared_ptr<api::StorageMessage> createGet(uint64_t bucket) const;

    void setUp() override;

    CPPUNIT_TEST_SUITE(PersistenceQueueTest);
    CPPUNIT_TEST(testFetchNextUnlockedMessageIfBucketLocked);
    CPPUNIT_TEST(shared_locked_operations_allow_concurrent_bucket_access);
    CPPUNIT_TEST(exclusive_locked_operation_not_started_if_shared_op_active);
    CPPUNIT_TEST(shared_locked_operation_not_started_if_exclusive_op_active);
    CPPUNIT_TEST(exclusive_locked_operation_not_started_if_exclusive_op_active);
    CPPUNIT_TEST(operation_batching_not_allowed_across_different_lock_modes);
    CPPUNIT_TEST_SUITE_END();

    struct Fixture {
        FileStorTestFixture& parent;
        DummyStorageLink top;
        std::unique_ptr<DummyStorageLink> dummyManager;
        ForwardingMessageSender messageSender;
        documentapi::LoadTypeSet loadTypes;
        FileStorMetrics metrics;
        std::unique_ptr<FileStorHandler> filestorHandler;
        uint32_t stripeId;

        explicit Fixture(FileStorTestFixture& parent);
        ~Fixture();
    };

    static constexpr uint16_t _disk = 0;
};

CPPUNIT_TEST_SUITE_REGISTRATION(PersistenceQueueTest);

PersistenceQueueTest::Fixture::Fixture(FileStorTestFixture& parent_)
    : parent(parent_),
      top(),
      dummyManager(std::make_unique<DummyStorageLink>()),
      messageSender(*dummyManager),
      loadTypes("raw:"),
      metrics(loadTypes.getMetricLoadTypes())
{
    top.push_back(std::move(dummyManager));
    top.open();

    metrics.initDiskMetrics(parent._node->getPartitions().size(), loadTypes.getMetricLoadTypes(), 1, 1);

    filestorHandler = std::make_unique<FileStorHandler>(messageSender, metrics, parent._node->getPartitions(),
                                                        parent._node->getComponentRegister());
    // getNextMessage will time out if no unlocked buckets are present. Choose a timeout
    // that is large enough to fail tests with high probability if this is not the case,
    // and small enough to not slow down testing too much.
    filestorHandler->setGetNextMessageTimeout(20);

    stripeId = filestorHandler->getNextStripeId(0);
}

PersistenceQueueTest::Fixture::~Fixture() = default;

void PersistenceQueueTest::setUp() {
    setupPersistenceThreads(1);
    _node->setPersistenceProvider(std::make_unique<spi::dummy::DummyPersistence>(_node->getTypeRepo(), 1));
}

std::shared_ptr<api::StorageMessage> PersistenceQueueTest::createPut(uint64_t bucket, uint64_t docIdx) {
    std::shared_ptr<document::Document> doc = _node->getTestDocMan().createDocument(
            "foobar", vespalib::make_string("id:foo:testdoctype1:n=%" PRIu64 ":%" PRIu64, bucket, docIdx));
    auto cmd = std::make_shared<api::PutCommand>(makeDocumentBucket(document::BucketId(16, bucket)), doc, 1234);
    cmd->setAddress(makeSelfAddress());
    return cmd;
}

std::shared_ptr<api::StorageMessage> PersistenceQueueTest::createGet(uint64_t bucket) const {
    auto cmd = std::make_shared<api::GetCommand>(
            makeDocumentBucket(document::BucketId(16, bucket)),
            document::DocumentId(vespalib::make_string("id:foo:testdoctype1:n=%" PRIu64 ":0", bucket)), "[all]");
    cmd->setAddress(makeSelfAddress());
    return cmd;
}

void PersistenceQueueTest::testFetchNextUnlockedMessageIfBucketLocked() {
    Fixture f(*this);
    // Send 2 puts, 2 to the first bucket, 1 to the second. Calling
    // getNextMessage 2 times should then return a lock on the first bucket,
    // then subsequently on the second, skipping the already locked bucket.
    // Puts all have same pri, so order is well defined.
    f.filestorHandler->schedule(createPut(1234, 0), _disk);
    f.filestorHandler->schedule(createPut(1234, 1), _disk);
    f.filestorHandler->schedule(createPut(5432, 0), _disk);

    auto lock0 = f.filestorHandler->getNextMessage(_disk, f.stripeId);
    CPPUNIT_ASSERT(lock0.first.get());
    CPPUNIT_ASSERT_EQUAL(document::BucketId(16, 1234),
                         dynamic_cast<api::PutCommand&>(*lock0.second).getBucketId());

    auto lock1 = f.filestorHandler->getNextMessage(_disk, f.stripeId);
    CPPUNIT_ASSERT(lock1.first.get());
    CPPUNIT_ASSERT_EQUAL(document::BucketId(16, 5432),
                         dynamic_cast<api::PutCommand&>(*lock1.second).getBucketId());
}

void PersistenceQueueTest::shared_locked_operations_allow_concurrent_bucket_access() {
    Fixture f(*this);

    f.filestorHandler->schedule(createGet(1234), _disk);
    f.filestorHandler->schedule(createGet(1234), _disk);

    auto lock0 = f.filestorHandler->getNextMessage(_disk, f.stripeId);
    CPPUNIT_ASSERT(lock0.first.get());
    CPPUNIT_ASSERT_EQUAL(api::LockingRequirements::Shared, lock0.first->lockingRequirements());

    // Even though we already have a lock on the bucket, Gets allow shared locking and we
    // should therefore be able to get another lock.
    auto lock1 = f.filestorHandler->getNextMessage(_disk, f.stripeId);
    CPPUNIT_ASSERT(lock1.first.get());
    CPPUNIT_ASSERT_EQUAL(api::LockingRequirements::Shared, lock1.first->lockingRequirements());
}

void PersistenceQueueTest::exclusive_locked_operation_not_started_if_shared_op_active() {
    Fixture f(*this);

    f.filestorHandler->schedule(createGet(1234), _disk);
    f.filestorHandler->schedule(createPut(1234, 0), _disk);

    auto lock0 = f.filestorHandler->getNextMessage(_disk, f.stripeId);
    CPPUNIT_ASSERT(lock0.first.get());
    CPPUNIT_ASSERT_EQUAL(api::LockingRequirements::Shared, lock0.first->lockingRequirements());

    // Expected to time out
    auto lock1 = f.filestorHandler->getNextMessage(_disk, f.stripeId);
    CPPUNIT_ASSERT(!lock1.first.get());
}

void PersistenceQueueTest::shared_locked_operation_not_started_if_exclusive_op_active() {
    Fixture f(*this);

    f.filestorHandler->schedule(createPut(1234, 0), _disk);
    f.filestorHandler->schedule(createGet(1234), _disk);

    auto lock0 = f.filestorHandler->getNextMessage(_disk, f.stripeId);
    CPPUNIT_ASSERT(lock0.first.get());
    CPPUNIT_ASSERT_EQUAL(api::LockingRequirements::Exclusive, lock0.first->lockingRequirements());

    // Expected to time out
    auto lock1 = f.filestorHandler->getNextMessage(_disk, f.stripeId);
    CPPUNIT_ASSERT(!lock1.first.get());
}

void PersistenceQueueTest::exclusive_locked_operation_not_started_if_exclusive_op_active() {
    Fixture f(*this);

    f.filestorHandler->schedule(createPut(1234, 0), _disk);
    f.filestorHandler->schedule(createPut(1234, 0), _disk);

    auto lock0 = f.filestorHandler->getNextMessage(_disk, f.stripeId);
    CPPUNIT_ASSERT(lock0.first.get());
    CPPUNIT_ASSERT_EQUAL(api::LockingRequirements::Exclusive, lock0.first->lockingRequirements());

    // Expected to time out
    auto lock1 = f.filestorHandler->getNextMessage(_disk, f.stripeId);
    CPPUNIT_ASSERT(!lock1.first.get());
}

void PersistenceQueueTest::operation_batching_not_allowed_across_different_lock_modes() {
    Fixture f(*this);

    f.filestorHandler->schedule(createPut(1234, 0), _disk);
    f.filestorHandler->schedule(createGet(1234), _disk);

    auto lock0 = f.filestorHandler->getNextMessage(_disk, f.stripeId);
    CPPUNIT_ASSERT(lock0.first);
    CPPUNIT_ASSERT(lock0.second);
    CPPUNIT_ASSERT_EQUAL(api::LockingRequirements::Exclusive, lock0.first->lockingRequirements());

    f.filestorHandler->getNextMessage(_disk, f.stripeId, lock0);
    CPPUNIT_ASSERT(!lock0.second);
}

} // namespace storage