aboutsummaryrefslogtreecommitdiffstats
path: root/searchcore/src/vespa/searchcore/proton/documentmetastore/documentmetastoreflushtarget.cpp
blob: db3d8adfe265a61417c859b616d614cadfb3ffe9 (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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.

#include "documentmetastoreflushtarget.h"
#include "documentmetastore.h"
#include <vespa/searchcore/proton/attribute/attributedisklayout.h>
#include <vespa/searchcore/proton/server/itlssyncer.h>
#include <vespa/searchcore/proton/attribute/attribute_directory.h>
#include <vespa/searchlib/attribute/attributefilesavetarget.h>
#include <vespa/searchlib/attribute/attributememorysavetarget.h>
#include <vespa/searchlib/attribute/attributesaver.h>
#include <vespa/searchlib/common/serialnumfileheadercontext.h>
#include <vespa/searchlib/util/filekit.h>
#include <filesystem>
#include <fstream>

#include <vespa/log/log.h>
LOG_SETUP(".proton.documentmetastore.documentmetastoreflushtarget");

using namespace search;
using namespace vespalib;
using search::common::FileHeaderContext;
using search::common::SerialNumFileHeaderContext;
using searchcorespi::IFlushTarget;
using searchcorespi::FlushStats;

namespace proton {

/**
 * Task performing the actual flushing to disk.
 **/
class DocumentMetaStoreFlushTarget::Flusher : public Task {
private:
    DocumentMetaStoreFlushTarget     &_dmsft;
    std::unique_ptr<search::AttributeSaver> _saver;
    uint64_t                          _syncToken;
    vespalib::string                  _flushDir;

    bool saveDocumentMetaStore(); // not updating snap info.
public:
    Flusher(DocumentMetaStoreFlushTarget &dmsft, uint64_t syncToken, AttributeDirectory::Writer &writer);
    ~Flusher() override;
    bool flush(AttributeDirectory::Writer &writer);
    void updateStats();
    bool cleanUp(AttributeDirectory::Writer &writer);
    void run() override;

    SerialNum getFlushSerial() const override { return _syncToken; }
};

DocumentMetaStoreFlushTarget::Flusher::
Flusher(DocumentMetaStoreFlushTarget &dmsft,
        SerialNum syncToken, AttributeDirectory::Writer &writer)
    : _dmsft(dmsft),
      _saver(),
      _syncToken(syncToken),
      _flushDir("")
{
    // Called by document db executor
    DocumentMetaStore &dms = *_dmsft._dms;
    dms.commit(CommitParam(syncToken));
    _flushDir = writer.getSnapshotDir(syncToken);
    vespalib::string newBaseFileName(_flushDir + "/" + dms.getName());
    _saver = dms.initSave(newBaseFileName);
    assert(_saver);
}

DocumentMetaStoreFlushTarget::Flusher::~Flusher() = default;

bool
DocumentMetaStoreFlushTarget::Flusher::saveDocumentMetaStore()
{
    std::filesystem::create_directory(std::filesystem::path(_flushDir));
    SerialNumFileHeaderContext fileHeaderContext(_dmsft._fileHeaderContext, _syncToken);
    bool saveSuccess = false;
    if (_dmsft._hwInfo.disk().slow()) {
        search::AttributeMemorySaveTarget memorySaveTarget;
        saveSuccess = _saver->save(memorySaveTarget);
        _saver.reset();
        if (saveSuccess) {
            saveSuccess = memorySaveTarget.writeToFile(_dmsft._tuneFileAttributes, fileHeaderContext);
        }
    } else {
        search::AttributeFileSaveTarget saveTarget(_dmsft._tuneFileAttributes, fileHeaderContext);
        saveSuccess = _saver->save(saveTarget);
        _saver.reset();
    }
    return saveSuccess;
}

bool
DocumentMetaStoreFlushTarget::Flusher::flush(AttributeDirectory::Writer &writer)
{
    writer.createInvalidSnapshot(_syncToken);
    if (!saveDocumentMetaStore()) {
        vespalib::string baseFileName(_flushDir + "/" + _dmsft._dms->getName());
        LOG(warning, "Could not write document meta store '%s' to disk", baseFileName.c_str());
        return false;
    }
    /*
     * Sync transaction log again.  This is needed when background
     * flush is activated to ensure that same future will occur that has
     * already been observable in the saved document meta store (future
     * timestamp or bucket id).
     *
     * Assume only flush engine tries to flush document meta store, i.e.
     * noone else tries to get writer while flush task is flushing
     * document meta store to disk.
     */
    _dmsft._tlsSyncer.sync();
    writer.markValidSnapshot(_syncToken);
    writer.setLastFlushTime(search::FileKit::getModificationTime(_flushDir));
    return true;
}

void
DocumentMetaStoreFlushTarget::Flusher::updateStats()
{
    _dmsft._lastStats.setPath(_flushDir);
}

bool
DocumentMetaStoreFlushTarget::Flusher::cleanUp(AttributeDirectory::Writer &writer)
{
    if (_dmsft._cleanUpAfterFlush) {
        writer.invalidateOldSnapshots();
        writer.removeInvalidSnapshots();
    }
    return true;
}

void
DocumentMetaStoreFlushTarget::Flusher::run()
{
    auto writer = _dmsft._dmsDir->tryGetWriter();
    if (!writer || _syncToken <= _dmsft.getFlushedSerialNum()) {
        // another flusher has created an equal or better snapshot
        // after this flusher was created
        return;
    }
    if (!flush(*writer)) {
        // TODO (geirst): throw exception ?
    }
    updateStats();
    if (!cleanUp(*writer)) {
        // TODO (geirst): throw exception ?
    }
}

DocumentMetaStoreFlushTarget::
DocumentMetaStoreFlushTarget(const DocumentMetaStore::SP dms, ITlsSyncer &tlsSyncer,
                             const vespalib::string & baseDir, const TuneFileAttributes &tuneFileAttributes,
                             const FileHeaderContext &fileHeaderContext, const HwInfo &hwInfo)
    : LeafFlushTarget("documentmetastore.flush", Type::SYNC, Component::ATTRIBUTE),
      _dms(dms),
      _tlsSyncer(tlsSyncer),
      _baseDir(baseDir),
      _cleanUpAfterFlush(true),
      _lastStats(),
      _tuneFileAttributes(tuneFileAttributes),
      _fileHeaderContext(fileHeaderContext),
      _hwInfo(hwInfo),
      _diskLayout(AttributeDiskLayout::createSimple(baseDir)),
      _dmsDir(_diskLayout->createAttributeDir(""))

{
    _lastStats.setPathElementsToLog(8);
}

DocumentMetaStoreFlushTarget::~DocumentMetaStoreFlushTarget() = default;

TransientResourceUsage
DocumentMetaStoreFlushTarget::get_transient_resource_usage() const
{
    return _dmsDir->get_transient_resource_usage();
}

IFlushTarget::SerialNum
DocumentMetaStoreFlushTarget::getFlushedSerialNum() const
{
    return _dmsDir->getFlushedSerialNum();
}


IFlushTarget::MemoryGain
DocumentMetaStoreFlushTarget::getApproxMemoryGain() const
{
    int64_t used(_dms->getStatus().getUsed());
    return MemoryGain(used, used);
}


IFlushTarget::DiskGain
DocumentMetaStoreFlushTarget::getApproxDiskGain() const
{
    return DiskGain(0, 0);
}


IFlushTarget::Time
DocumentMetaStoreFlushTarget::getLastFlushTime() const
{
    return _dmsDir->getLastFlushTime();
}


IFlushTarget::Task::UP
DocumentMetaStoreFlushTarget::initFlush(SerialNum currentSerial, std::shared_ptr<search::IFlushToken>)
{
    // Called by document db executor
    _dms->reclaim_unused_memory();
    SerialNum syncToken = std::max(currentSerial, _dms->getStatus().getLastSyncToken());
    auto writer = _dmsDir->tryGetWriter();
    if (!writer) {
        return Task::UP();
    }
    if (syncToken <= getFlushedSerialNum()) {
        writer->setLastFlushTime(vespalib::system_clock::now());
        LOG(debug, "No document meta store to flush. Update flush time to current: lastFlushTime(%f)",
            vespalib::to_s(getLastFlushTime().time_since_epoch()));
        return Task::UP();
    }
    return std::make_unique<Flusher>(*this, syncToken, *writer);
}


uint64_t
DocumentMetaStoreFlushTarget::getApproxBytesToWriteToDisk() const
{
    auto guard = _dms->getGuard();
    return _dms->getEstimatedSaveByteSize();
}

} // namespace proton