aboutsummaryrefslogtreecommitdiffstats
path: root/searchlib/src/vespa/searchlib/attribute/attributefilewriter.cpp
blob: 48cfd2f914c2c029b81948f67a66eb66acaca08e (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
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.

#include "attributefilewriter.h"
#include "attribute_header.h"
#include "attributefilebufferwriter.h"
#include <vespa/fastos/file.h>
#include <vespa/searchlib/common/fileheadercontext.h>
#include <vespa/searchlib/common/tunefileinfo.h>
#include <vespa/searchlib/util/file_settings.h>
#include <vespa/vespalib/data/databuffer.h>
#include <vespa/vespalib/data/fileheader.h>
#include <vespa/vespalib/util/size_literals.h>

#include <vespa/log/log.h>
LOG_SETUP(".searchlib.attribute.attributefilewriter");

using search::common::FileHeaderContext;
using vespalib::getLastErrorString;

namespace search {

namespace {

void
writeDirectIOAligned(FastOS_FileInterface &file, const void *buf, size_t length)
{
    const char * data(static_cast<const char *>(buf));
    size_t remaining(length);
    for (size_t maxChunk(2_Mi); maxChunk >= FileSettings::DIRECTIO_ALIGNMENT; maxChunk >>= 1) {
        for ( ; remaining > maxChunk; remaining -= maxChunk, data += maxChunk) {
            file.WriteBuf(data, maxChunk);
        }
    }
    if (remaining > 0) {
        file.WriteBuf(data, remaining);
    }
}

void
updateHeader(const vespalib::string &name, uint64_t fileBitSize)
{
    vespalib::FileHeader h(FileSettings::DIRECTIO_ALIGNMENT);
    FastOS_File f;
    f.OpenReadWrite(name.c_str());
    h.readFile(f);
    FileHeaderContext::setFreezeTime(h);
    using Tag = vespalib::GenericHeader::Tag;
    h.putTag(Tag("frozen", 1));
    h.putTag(Tag("fileBitSize", fileBitSize));
    h.rewriteFile(f);
    bool sync_ok = f.Sync();
    assert(sync_ok);
}

/*
 * BufferWriter implementation that passes full buffers on to
 * AttributeFileWriter.
 */
class FileBackedBufferWriter : public AttributeFileBufferWriter
{
public:
    FileBackedBufferWriter(AttributeFileWriter &fileWriter);
    ~FileBackedBufferWriter() override;

    void onFlush(size_t nowLen) override;
};


FileBackedBufferWriter::FileBackedBufferWriter(AttributeFileWriter &fileWriter)
    : AttributeFileBufferWriter(fileWriter)
{ }

FileBackedBufferWriter::~FileBackedBufferWriter() = default;

void
FileBackedBufferWriter::onFlush(size_t nowLen) {
    // Note: Must use const ptr to indicate that buffer is pre-filled.
    auto buf(std::make_unique<BufferBuf>(static_cast<const void *>(_buf->getFree()), nowLen));
    assert(buf->getDataLen() == nowLen);
    assert(buf->getData() == _buf->getFree());
    _fileWriter.writeBuf(std::move(buf));
}

}

AttributeFileWriter::
AttributeFileWriter(const TuneFileAttributes &tuneFileAttributes,
                    const FileHeaderContext &fileHeaderContext,
                    const attribute::AttributeHeader &header,
                    const vespalib::string &desc)
    : _file(new FastOS_File()),
      _tuneFileAttributes(tuneFileAttributes),
      _fileHeaderContext(fileHeaderContext),
      _header(header),
      _desc(desc),
      _fileBitSize(0)
{ }

AttributeFileWriter::~AttributeFileWriter() = default;

bool
AttributeFileWriter::open(const vespalib::string &fileName)
{
    if (_tuneFileAttributes._write.getWantSyncWrites()) {
        _file->EnableSyncWrites();
    }
    if (_tuneFileAttributes._write.getWantDirectIO()) {
        _file->EnableDirectIO();
    }
    _file->OpenWriteOnlyTruncate(fileName.c_str());
    if (!_file->IsOpened()) {
        LOG(error, "Could not open attribute vector '%s' for writing: %s",
            fileName.c_str(), getLastErrorString().c_str());
        return false;
    }
    writeHeader();
    return true;
}

void
AttributeFileWriter::writeHeader()
{
    vespalib::FileHeader header(FileSettings::DIRECTIO_ALIGNMENT);
    _fileHeaderContext.addTags(header, _file->GetFileName());
    addTags(header);
    size_t headerLen = header.writeFile(*_file);
    assert((headerLen % FileSettings::DIRECTIO_ALIGNMENT) == 0);
    _fileBitSize = headerLen * 8;
}

void
AttributeFileWriter::addTags(vespalib::GenericHeader &header)
{
    _header.addTags(header);
    using Tag = vespalib::GenericHeader::Tag;
    header.putTag(Tag("desc", _desc));
}

AttributeFileWriter::Buffer
AttributeFileWriter::allocBuf(size_t size)
{
    return std::make_unique<BufferBuf>(size, FileSettings::DIRECTIO_ALIGNMENT);
}

void
AttributeFileWriter::writeBuf(Buffer buf)
{
    size_t bufLen = buf->getDataLen();
    // TODO: pad to DirectIO boundary when burning bridges
    writeDirectIOAligned(*_file, buf->getData(), bufLen);
    _fileBitSize += bufLen * 8;
}

void
AttributeFileWriter::close()
{
    if (_file->IsOpened()) {
        bool synk_ok = _file->Sync();
        assert(synk_ok);
        bool close_ok = _file->Close();
        assert(close_ok);
        updateHeader(_file->GetFileName(), _fileBitSize);
    }
}

std::unique_ptr<BufferWriter>
AttributeFileWriter::allocBufferWriter()
{
    return std::make_unique<FileBackedBufferWriter>(*this);
}

} // namespace search