import quincy beta 17.1.0

[ceph.git] / ceph / src / crimson / tools / store_nbd / block_driver.h

diff --git a/ceph/src/crimson/tools/store_nbd/block_driver.h b/ceph/src/crimson/tools/store_nbd/block_driver.h
new file mode 100644 (file)
index 0000000..ea3453e
--- /dev/null
+++ b/ceph/src/crimson/tools/store_nbd/block_driver.h
@@ -0,0 +1,134 @@
+// -*- mode:C++; tab-width:8; c-basic-offset:2; indent-tabs-mode:t -*-
+// vim: ts=8 sw=2 smarttab
+
+#pragma once
+
+#include <boost/program_options/variables_map.hpp>
+#include <boost/program_options/parsers.hpp>
+
+#include <seastar/core/future.hh>
+
+#include <string>
+#include <optional>
+
+#include "include/buffer.h"
+
+/**
+ * BlockDriver
+ *
+ * Simple interface to enable throughput test to compare raw disk to
+ * transaction_manager, etc
+ */
+class BlockDriver {
+public:
+  struct config_t {
+    std::string type;
+    bool mkfs = false;
+    unsigned num_pgs = 128;
+    unsigned log_size = 1000;
+    unsigned object_size = 4<<20 /* 4MB, rbd default */;
+    unsigned oi_size = 1<<9 /* 512b */;
+    unsigned log_entry_size = 1<<9 /* 512b */;
+    bool prepopulate_log = false;
+    std::optional<std::string> path;
+
+    bool is_futurized_store() const {
+      return type == "seastore" || type == "bluestore";
+    }
+
+    std::string get_fs_type() const {
+      ceph_assert(is_futurized_store());
+      return type;
+    }
+
+    bool oi_enabled() const {
+      return oi_size > 0;
+    }
+
+    bool log_enabled() const {
+      return log_entry_size > 0 && log_size > 0;
+    }
+
+    bool prepopulate_log_enabled() const {
+      return prepopulate_log;
+    }
+
+    void populate_options(
+      boost::program_options::options_description &desc)
+    {
+      namespace po = boost::program_options;
+      desc.add_options()
+       ("type",
+        po::value<std::string>()
+        ->default_value("transaction_manager")
+        ->notifier([this](auto s) { type = s; }),
+        "Backend to use, options are transaction_manager, seastore"
+       )
+       ("device-path",
+        po::value<std::string>()
+        ->required()
+        ->notifier([this](auto s) { path = s; }),
+        "Path to device for backend"
+       )
+       ("num-pgs",
+        po::value<unsigned>()
+        ->notifier([this](auto s) { num_pgs = s; }),
+        "Number of pgs to use for futurized_store backends"
+       )
+       ("log-size",
+        po::value<unsigned>()
+        ->notifier([this](auto s) { log_size = s; }),
+        "Number of log entries per pg to use for futurized_store backends"
+        ", 0 to disable"
+       )
+       ("log-entry-size",
+        po::value<unsigned>()
+        ->notifier([this](auto s) { log_entry_size = s; }),
+        "Size of each log entry per pg to use for futurized_store backends"
+        ", 0 to disable"
+       )
+       ("prepopulate-log",
+        po::value<bool>()
+        ->notifier([this](auto s) { prepopulate_log = s; }),
+        "Prepopulate log on mount"
+       )
+       ("object-info-size",
+        po::value<unsigned>()
+        ->notifier([this](auto s) { log_entry_size = s; }),
+        "Size of each log entry per pg to use for futurized_store backends"
+        ", 0 to disable"
+       )
+       ("object-size",
+        po::value<unsigned>()
+        ->notifier([this](auto s) { object_size = s; }),
+        "Object size to use for futurized_store backends"
+       )
+       ("mkfs",
+        po::value<bool>()
+        ->default_value(false)
+        ->notifier([this](auto s) { mkfs = s; }),
+        "Do mkfs first"
+       );
+    }
+  };
+
+  virtual ceph::bufferptr get_buffer(size_t size) = 0;
+
+  virtual seastar::future<> write(
+    off_t offset,
+    ceph::bufferptr ptr) = 0;
+
+  virtual seastar::future<ceph::bufferlist> read(
+    off_t offset,
+    size_t size) = 0;
+
+  virtual size_t get_size() const = 0;
+
+  virtual seastar::future<> mount() = 0;
+  virtual seastar::future<> close() = 0;
+
+  virtual ~BlockDriver() {}
+};
+using BlockDriverRef = std::unique_ptr<BlockDriver>;
+
+BlockDriverRef get_backend(BlockDriver::config_t config);