From 330c7f86f52f4d56d3a9266442b1e17e129a52a9 Mon Sep 17 00:00:00 2001 From: Yunchuan Wen Date: Wed, 2 Dec 2015 11:29:01 +0800 Subject: [PATCH] add rbd-nbd wrap to rbd CLI Signed-off-by: Yunchuan Wen --- src/test/cli/rbd/help.t | 35 +++++++ src/tools/Makefile-client.am | 1 + src/tools/rbd/action/Nbd.cc | 186 +++++++++++++++++++++++++++++++++++ 3 files changed, 222 insertions(+) create mode 100644 src/tools/rbd/action/Nbd.cc diff --git a/src/test/cli/rbd/help.t b/src/test/cli/rbd/help.t index 7d6dde2b6127a..52239df5c25b4 100644 --- a/src/test/cli/rbd/help.t +++ b/src/test/cli/rbd/help.t @@ -36,6 +36,9 @@ lock remove (lock rm) Release a lock on an image. map Map image to a block device using the kernel. merge-diff Merge two diff exports together. + nbd list (nbd ls) List the nbd devices already used. + nbd map Map image to a nbd device. + nbd unmap Unmap a nbd device. object-map rebuild Rebuild an invalid object map. remove (rm) Delete an image. rename (mv) Rename image within pool. @@ -557,6 +560,38 @@ --path arg path to merged diff (or '-' for stdout) --no-progress disable progress output + rbd help nbd list + usage: rbd nbd list + + List the nbd devices already used. + + rbd help nbd map + usage: rbd nbd map [--pool ] [--image ] [--snap ] + [--read-only] [--device ] + + + Map image to a nbd device. + + Positional arguments + image or snapshot specification + (example: [/][@]) + + Optional arguments + -p [ --pool ] arg pool name + --image arg image name + --snap arg snapshot name + --read-only mount read-only + --device arg specify nbd device + + rbd help nbd unmap + usage: rbd nbd unmap + + + Unmap a nbd device. + + Positional arguments + specify nbd device + rbd help object-map rebuild usage: rbd object-map rebuild [--pool ] [--image ] [--snap ] [--no-progress] diff --git a/src/tools/Makefile-client.am b/src/tools/Makefile-client.am index 9717345fa122d..3935c44ce6a05 100644 --- a/src/tools/Makefile-client.am +++ b/src/tools/Makefile-client.am @@ -46,6 +46,7 @@ rbd_SOURCES = \ tools/rbd/action/ImportDiff.cc \ tools/rbd/action/Info.cc \ tools/rbd/action/Kernel.cc \ + tools/rbd/action/Nbd.cc \ tools/rbd/action/List.cc \ tools/rbd/action/Lock.cc \ tools/rbd/action/MergeDiff.cc \ diff --git a/src/tools/rbd/action/Nbd.cc b/src/tools/rbd/action/Nbd.cc new file mode 100644 index 0000000000000..be42173a95bf4 --- /dev/null +++ b/src/tools/rbd/action/Nbd.cc @@ -0,0 +1,186 @@ +// -*- mode:C++; tab-width:8; c-basic-offset:2; indent-tabs-mode:t -*- +// vim: ts=8 sw=2 smarttab + +#include "tools/rbd/ArgumentTypes.h" +#include "tools/rbd/Shell.h" +#include "tools/rbd/Utils.h" +#include "include/stringify.h" +#include "common/SubProcess.h" +#include +#include +#include +#include + +namespace rbd { +namespace action { +namespace nbd { + +namespace at = argument_types; +namespace po = boost::program_options; + +static int call_nbd_cmd(const po::variables_map &vm, + const std::vector &args) +{ + char exe_path[PATH_MAX]; + ssize_t exe_path_bytes = readlink("/proc/self/exe", exe_path, + sizeof(exe_path) - 1); + if (exe_path_bytes < 0) { + strcpy(exe_path, "rbd-nbd"); + } else { + if (snprintf(exe_path + exe_path_bytes, + sizeof(exe_path) - exe_path_bytes, + "-nbd") < 0) { + return -EOVERFLOW; + } + } + + SubProcess process(exe_path, SubProcess::KEEP, SubProcess::KEEP, SubProcess::KEEP); + + if (vm.count("conf")) { + process.add_cmd_arg("--conf"); + process.add_cmd_arg(vm["conf"].as().c_str()); + } + if (vm.count("cluster")) { + process.add_cmd_arg("--cluster"); + process.add_cmd_arg(vm["cluster"].as().c_str()); + } + if (vm.count("id")) { + process.add_cmd_arg("--id"); + process.add_cmd_arg(vm["id"].as().c_str()); + } + if (vm.count("name")) { + process.add_cmd_arg("--name"); + process.add_cmd_arg(vm["name"].as().c_str()); + } + if (vm.count("mon_host")) { + process.add_cmd_arg("--mon_host"); + process.add_cmd_arg(vm["mon_host"].as().c_str()); + } + if (vm.count("keyfile")) { + process.add_cmd_arg("--keyfile"); + process.add_cmd_arg(vm["keyfile"].as().c_str()); + } + if (vm.count("keyring")) { + process.add_cmd_arg("--keyring"); + process.add_cmd_arg(vm["keyring"].as().c_str()); + } + + for (std::vector::const_iterator p = args.begin(); + p != args.end(); p++) + process.add_cmd_arg(*p); + + if (process.spawn()) { + std::cerr << "rbd: failed to run rbd-nbd: " << process.err() << std::endl; + return -EINVAL; + } else if (process.join()) { + std::cerr << "rbd: rbd-nbd failed with error: " << process.err() << std::endl; + return -EINVAL; + } + + return 0; +} + +void get_show_arguments(po::options_description *positional, + po::options_description *options) +{ } + +int execute_show(const po::variables_map &vm) +{ + std::vector args; + + args.push_back("list-mapped"); + + return call_nbd_cmd(vm, args); +} + +void get_map_arguments(po::options_description *positional, + po::options_description *options) +{ + at::add_image_or_snap_spec_options(positional, options, + at::ARGUMENT_MODIFIER_NONE); + options->add_options() + ("read-only", po::bool_switch(), "mount read-only") + ("device", po::value(), "specify nbd device"); +} + +int execute_map(const po::variables_map &vm) +{ + size_t arg_index = 0; + std::string pool_name; + std::string image_name; + std::string snap_name; + int r = utils::get_pool_image_snapshot_names( + vm, at::ARGUMENT_MODIFIER_NONE, &arg_index, &pool_name, &image_name, + &snap_name, utils::SNAPSHOT_PRESENCE_PERMITTED); + if (r < 0) { + return r; + } + + std::vector args; + + args.push_back("map"); + std::string img; + img.append(pool_name); + img.append("/"); + img.append(image_name); + if (!snap_name.empty()) { + img.append("@"); + img.append(snap_name); + } + args.push_back(img.c_str()); + + if (vm["read-only"].as()) + args.push_back("--read-only"); + + if (vm.count("device")) { + args.push_back("--device"); + args.push_back(vm["device"].as().c_str()); + } + + return call_nbd_cmd(vm, args); +} + +void get_unmap_arguments(po::options_description *positional, + po::options_description *options) +{ + positional->add_options() + ("device-spec", "specify nbd device"); +} + +int execute_unmap(const po::variables_map &vm) +{ + std::string device_name = utils::get_positional_argument(vm, 0); + if (!boost::starts_with(device_name, "/dev/")) { + device_name.clear(); + } + + if (device_name.empty()) { + std::cerr << "rbd: nbd unmap requires device path" << std::endl; + return -EINVAL; + } + + std::vector args; + + args.push_back("unmap"); + args.push_back(device_name.c_str()); + + return call_nbd_cmd(vm, args); +} + +Shell::SwitchArguments switched_arguments({"read-only"}); + +Shell::Action action_show( + {"nbd", "list"}, {"nbd", "ls"}, "List the nbd devices already used.", "", + &get_show_arguments, &execute_show); + +Shell::Action action_map( + {"nbd", "map"}, {}, "Map image to a nbd device.", "", + &get_map_arguments, &execute_map); + +Shell::Action action_unmap( + {"nbd", "unmap"}, {}, "Unmap a nbd device.", "", + &get_unmap_arguments, &execute_unmap); + +} // namespace nbd +} // namespace action +} // namespace rbd -- 2.39.5