aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/clickhouse/src/IO/MMappedFile.h
blob: 6ecf988fa941d9159e51703daf57d91028db26e6 (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
#pragma once

#include <Common/CurrentMetrics.h>
#include <IO/MMappedFileDescriptor.h>
#include <cstddef>


namespace CurrentMetrics
{
    extern const Metric OpenFileForRead;
}


namespace DB
{

/// Opens a file and mmaps a region in it (or a whole file) into memory. Unmaps and closes in destructor.
class MMappedFile : public MMappedFileDescriptor
{
public:
    MMappedFile(const std::string & file_name_, size_t offset_, size_t length_);

    /// Map till end of file.
    MMappedFile(const std::string & file_name_, size_t offset_);

    ~MMappedFile() override;

    void close();

    std::string getFileName() const;

private:
    std::string file_name;

    CurrentMetrics::Increment metric_increment{CurrentMetrics::OpenFileForRead};

    void open();
};

}