2019-11-27 09:39:44 +00:00
|
|
|
#pragma once
|
|
|
|
|
2019-12-12 08:57:25 +00:00
|
|
|
#include <Core/Defines.h>
|
2019-11-28 19:11:49 +00:00
|
|
|
#include <Core/Types.h>
|
2019-11-27 09:39:44 +00:00
|
|
|
#include <Common/CurrentMetrics.h>
|
|
|
|
#include <Common/Exception.h>
|
|
|
|
|
|
|
|
#include <memory>
|
2019-12-17 13:45:53 +00:00
|
|
|
#include <mutex>
|
2019-11-27 09:39:44 +00:00
|
|
|
#include <utility>
|
|
|
|
#include <boost/noncopyable.hpp>
|
2019-12-27 10:26:23 +00:00
|
|
|
#include <Poco/Path.h>
|
2019-11-27 09:39:44 +00:00
|
|
|
|
|
|
|
|
|
|
|
namespace CurrentMetrics
|
|
|
|
{
|
|
|
|
extern const Metric DiskSpaceReservedForMerge;
|
|
|
|
}
|
|
|
|
|
|
|
|
namespace DB
|
|
|
|
{
|
2019-12-03 13:37:40 +00:00
|
|
|
class IDiskDirectoryIterator;
|
|
|
|
using DiskDirectoryIteratorPtr = std::unique_ptr<IDiskDirectoryIterator>;
|
2019-11-27 09:39:44 +00:00
|
|
|
|
|
|
|
class IReservation;
|
|
|
|
using ReservationPtr = std::unique_ptr<IReservation>;
|
|
|
|
|
2020-02-14 14:28:33 +00:00
|
|
|
class ReadBufferFromFileBase;
|
2020-02-20 16:39:32 +00:00
|
|
|
class WriteBufferFromFileBase;
|
2019-11-27 09:39:44 +00:00
|
|
|
|
2019-12-26 14:28:22 +00:00
|
|
|
/**
|
|
|
|
* Mode of opening a file for write.
|
|
|
|
*/
|
|
|
|
enum class WriteMode
|
|
|
|
{
|
|
|
|
Rewrite,
|
|
|
|
Append
|
|
|
|
};
|
|
|
|
|
2019-11-27 09:39:44 +00:00
|
|
|
/**
|
2019-11-27 15:49:15 +00:00
|
|
|
* Provide interface for reservation.
|
2019-11-27 09:39:44 +00:00
|
|
|
*/
|
|
|
|
class Space : public std::enable_shared_from_this<Space>
|
|
|
|
{
|
|
|
|
public:
|
2019-12-03 13:37:40 +00:00
|
|
|
/// Return the name of the space object.
|
2019-11-27 09:39:44 +00:00
|
|
|
virtual const String & getName() const = 0;
|
|
|
|
|
2019-12-03 13:37:40 +00:00
|
|
|
/// Reserve the specified number of bytes.
|
|
|
|
virtual ReservationPtr reserve(UInt64 bytes) = 0;
|
2019-11-27 09:39:44 +00:00
|
|
|
|
|
|
|
virtual ~Space() = default;
|
|
|
|
};
|
|
|
|
|
2019-12-03 13:37:40 +00:00
|
|
|
using SpacePtr = std::shared_ptr<Space>;
|
2019-11-27 09:39:44 +00:00
|
|
|
|
2019-11-28 19:11:49 +00:00
|
|
|
/**
|
|
|
|
* A unit of storage persisting data and metadata.
|
|
|
|
* Abstract underlying storage technology.
|
|
|
|
* Responsible for:
|
|
|
|
* - file management;
|
|
|
|
* - space accounting and reservation.
|
|
|
|
*/
|
2019-11-27 09:39:44 +00:00
|
|
|
class IDisk : public Space
|
|
|
|
{
|
|
|
|
public:
|
2019-12-03 13:37:40 +00:00
|
|
|
/// Root path for all files stored on the disk.
|
|
|
|
/// It's not required to be a local filesystem path.
|
2019-11-27 09:39:44 +00:00
|
|
|
virtual const String & getPath() const = 0;
|
|
|
|
|
2019-12-03 13:37:40 +00:00
|
|
|
/// Total available space on the disk.
|
2019-11-27 09:39:44 +00:00
|
|
|
virtual UInt64 getTotalSpace() const = 0;
|
|
|
|
|
2019-12-03 13:37:40 +00:00
|
|
|
/// Space currently available on the disk.
|
2019-11-27 09:39:44 +00:00
|
|
|
virtual UInt64 getAvailableSpace() const = 0;
|
|
|
|
|
2019-12-03 13:37:40 +00:00
|
|
|
/// Space available for reservation (available space minus reserved space).
|
2019-11-27 09:39:44 +00:00
|
|
|
virtual UInt64 getUnreservedSpace() const = 0;
|
|
|
|
|
2019-12-03 13:37:40 +00:00
|
|
|
/// Amount of bytes which should be kept free on the disk.
|
2019-11-27 09:39:44 +00:00
|
|
|
virtual UInt64 getKeepingFreeSpace() const { return 0; }
|
|
|
|
|
2019-12-03 13:37:40 +00:00
|
|
|
/// Return `true` if the specified file exists.
|
|
|
|
virtual bool exists(const String & path) const = 0;
|
2019-11-27 09:39:44 +00:00
|
|
|
|
2019-12-03 13:37:40 +00:00
|
|
|
/// Return `true` if the specified file exists and it's a regular file (not a directory or special file type).
|
|
|
|
virtual bool isFile(const String & path) const = 0;
|
2019-11-27 09:39:44 +00:00
|
|
|
|
2019-12-03 13:37:40 +00:00
|
|
|
/// Return `true` if the specified file exists and it's a directory.
|
|
|
|
virtual bool isDirectory(const String & path) const = 0;
|
2019-11-27 09:39:44 +00:00
|
|
|
|
2019-12-12 08:57:25 +00:00
|
|
|
/// Return size of the specified file.
|
|
|
|
virtual size_t getFileSize(const String & path) const = 0;
|
|
|
|
|
2019-12-03 13:37:40 +00:00
|
|
|
/// Create directory.
|
|
|
|
virtual void createDirectory(const String & path) = 0;
|
2019-11-27 09:39:44 +00:00
|
|
|
|
2019-12-03 13:37:40 +00:00
|
|
|
/// Create directory and all parent directories if necessary.
|
|
|
|
virtual void createDirectories(const String & path) = 0;
|
2019-11-27 09:39:44 +00:00
|
|
|
|
2020-01-18 23:18:23 +00:00
|
|
|
/// Remove all files from the directory. Directories are not removed.
|
2019-12-12 08:57:25 +00:00
|
|
|
virtual void clearDirectory(const String & path) = 0;
|
|
|
|
|
|
|
|
/// Move directory from `from_path` to `to_path`.
|
|
|
|
virtual void moveDirectory(const String & from_path, const String & to_path) = 0;
|
|
|
|
|
2019-12-03 13:37:40 +00:00
|
|
|
/// Return iterator to the contents of the specified directory.
|
|
|
|
virtual DiskDirectoryIteratorPtr iterateDirectory(const String & path) = 0;
|
2019-11-27 09:39:44 +00:00
|
|
|
|
2019-12-12 08:57:25 +00:00
|
|
|
/// Return `true` if the specified directory is empty.
|
|
|
|
bool isDirectoryEmpty(const String & path);
|
|
|
|
|
2019-12-03 13:37:40 +00:00
|
|
|
/// Move the file from `from_path` to `to_path`.
|
2020-01-02 14:37:31 +00:00
|
|
|
/// If a file with `to_path` path already exists, an exception will be thrown .
|
2019-12-03 13:37:40 +00:00
|
|
|
virtual void moveFile(const String & from_path, const String & to_path) = 0;
|
2019-11-27 09:39:44 +00:00
|
|
|
|
2020-01-02 14:37:31 +00:00
|
|
|
/// Move the file from `from_path` to `to_path`.
|
|
|
|
/// If a file with `to_path` path already exists, it will be replaced.
|
|
|
|
virtual void replaceFile(const String & from_path, const String & to_path) = 0;
|
|
|
|
|
2019-12-03 13:37:40 +00:00
|
|
|
/// Copy the file from `from_path` to `to_path`.
|
|
|
|
virtual void copyFile(const String & from_path, const String & to_path) = 0;
|
2019-11-27 09:39:44 +00:00
|
|
|
|
2020-02-20 16:39:32 +00:00
|
|
|
/// Open the file for read and return ReadBufferFromFileBase object.
|
|
|
|
virtual std::unique_ptr<ReadBufferFromFileBase> readFile(
|
|
|
|
const String & path,
|
|
|
|
size_t buf_size = DBMS_DEFAULT_BUFFER_SIZE,
|
|
|
|
size_t estimated_size = 0,
|
|
|
|
size_t aio_threshold = 0,
|
|
|
|
size_t mmap_threshold = 0) const = 0;
|
|
|
|
|
|
|
|
/// Open the file for write and return WriteBufferFromFileBase object.
|
|
|
|
virtual std::unique_ptr<WriteBufferFromFileBase> writeFile(
|
|
|
|
const String & path,
|
|
|
|
size_t buf_size = DBMS_DEFAULT_BUFFER_SIZE,
|
|
|
|
WriteMode mode = WriteMode::Rewrite,
|
|
|
|
size_t estimated_size = 0,
|
|
|
|
size_t aio_threshold = 0) = 0;
|
2019-12-17 13:45:53 +00:00
|
|
|
|
2020-01-18 23:18:23 +00:00
|
|
|
/// Remove file or directory. Throws exception if file doesn't exists or if directory is not empty.
|
|
|
|
virtual void remove(const String & path) = 0;
|
|
|
|
|
|
|
|
/// Remove file or directory with all children. Use with extra caution. Throws exception if file doesn't exists.
|
|
|
|
virtual void removeRecursive(const String & path) = 0;
|
2019-11-27 09:39:44 +00:00
|
|
|
};
|
|
|
|
|
2019-12-03 13:37:40 +00:00
|
|
|
using DiskPtr = std::shared_ptr<IDisk>;
|
|
|
|
using Disks = std::vector<DiskPtr>;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Iterator of directory contents on particular disk.
|
|
|
|
*/
|
|
|
|
class IDiskDirectoryIterator
|
2019-11-27 09:39:44 +00:00
|
|
|
{
|
|
|
|
public:
|
2019-12-03 13:37:40 +00:00
|
|
|
/// Iterate to the next file.
|
2019-11-27 09:39:44 +00:00
|
|
|
virtual void next() = 0;
|
|
|
|
|
2019-12-03 13:37:40 +00:00
|
|
|
/// Return `true` if the iterator points to a valid element.
|
2019-11-27 09:39:44 +00:00
|
|
|
virtual bool isValid() const = 0;
|
|
|
|
|
2020-01-10 21:42:26 +00:00
|
|
|
/// Path to the file that the iterator currently points to.
|
|
|
|
virtual String path() const = 0;
|
2019-11-27 09:39:44 +00:00
|
|
|
|
2020-02-27 16:47:40 +00:00
|
|
|
/// Name of the file that the iterator currently points to.
|
|
|
|
virtual String name() const = 0;
|
|
|
|
|
2019-12-03 13:37:40 +00:00
|
|
|
virtual ~IDiskDirectoryIterator() = default;
|
2019-11-27 09:39:44 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
2019-11-27 15:49:15 +00:00
|
|
|
* Information about reserved size on particular disk.
|
2019-11-27 09:39:44 +00:00
|
|
|
*/
|
2019-12-17 13:45:53 +00:00
|
|
|
class IReservation : boost::noncopyable
|
2019-11-27 09:39:44 +00:00
|
|
|
{
|
|
|
|
public:
|
|
|
|
/// Get reservation size.
|
2019-12-03 13:37:40 +00:00
|
|
|
virtual UInt64 getSize() const = 0;
|
2019-11-27 09:39:44 +00:00
|
|
|
|
|
|
|
/// Get disk where reservation take place.
|
2019-12-03 13:37:40 +00:00
|
|
|
virtual DiskPtr getDisk() const = 0;
|
2019-11-27 09:39:44 +00:00
|
|
|
|
|
|
|
/// Changes amount of reserved space.
|
|
|
|
virtual void update(UInt64 new_size) = 0;
|
|
|
|
|
|
|
|
/// Unreserves reserved space.
|
|
|
|
virtual ~IReservation() = default;
|
|
|
|
};
|
|
|
|
|
2019-12-03 13:37:40 +00:00
|
|
|
/// Return full path to a file on disk.
|
|
|
|
inline String fullPath(const DiskPtr & disk, const String & path)
|
|
|
|
{
|
|
|
|
return disk->getPath() + path;
|
|
|
|
}
|
2019-12-27 10:26:23 +00:00
|
|
|
|
|
|
|
/// Return parent path for the specified path.
|
|
|
|
inline String parentPath(const String & path)
|
|
|
|
{
|
|
|
|
return Poco::Path(path).parent().toString();
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Return file name for the specified path.
|
|
|
|
inline String fileName(const String & path)
|
|
|
|
{
|
|
|
|
return Poco::Path(path).getFileName();
|
|
|
|
}
|
2019-11-27 09:39:44 +00:00
|
|
|
}
|