From 0ce026caf5d3e8f7915f4d5c59ff0026507efa0c Mon Sep 17 00:00:00 2001 From: Ming-Hung Tsai Date: Fri, 19 Feb 2016 00:35:10 +0800 Subject: [PATCH 01/11] [thin_debug] Integrate thin_debug into the main program --- Makefile.in | 1 + thin-provisioning/commands.h | 21 ++++++++---- thin-provisioning/devel_commands.cc | 1 + thin-provisioning/thin_debug.cc | 53 ++++++++++++++++++----------- 4 files changed, 50 insertions(+), 26 deletions(-) diff --git a/Makefile.in b/Makefile.in index ea2bdca..c70159d 100644 --- a/Makefile.in +++ b/Makefile.in @@ -130,6 +130,7 @@ DEVTOOLS_SOURCE=\ era/devel_commands.cc \ thin-provisioning/damage_generator.cc \ thin-provisioning/devel_commands.cc \ + thin-provisioning/thin_debug.cc \ thin-provisioning/thin_generate_damage.cc \ thin-provisioning/thin_generate_mappings.cc \ thin-provisioning/thin_generate_metadata.cc \ diff --git a/thin-provisioning/commands.h b/thin-provisioning/commands.h index 0f603ae..2067970 100644 --- a/thin-provisioning/commands.h +++ b/thin-provisioning/commands.h @@ -73,6 +73,13 @@ namespace thin_provisioning { //------------------------------------------------------ + class thin_debug_cmd : public base::command { + public: + thin_debug_cmd(); + virtual void usage(std::ostream &out) const; + virtual int run(int argc, char **argv); + }; + class thin_generate_damage_cmd : public base::command { public: thin_generate_damage_cmd(); @@ -94,6 +101,13 @@ namespace thin_provisioning { virtual int run(int argc, char **argv); }; + class thin_journal_cmd : public base::command { + public: + thin_journal_cmd(); + virtual void usage(std::ostream &out) const; + virtual int run(int argc, char **argv); + }; + class thin_ll_dump_cmd : public base::command { public: thin_ll_dump_cmd(); @@ -140,13 +154,6 @@ namespace thin_provisioning { virtual int run(int argc, char **argv); }; - class thin_journal_cmd : public base::command { - public: - thin_journal_cmd(); - virtual void usage(std::ostream &out) const; - virtual int run(int argc, char **argv); - }; - void register_thin_commands(base::application &app); } diff --git a/thin-provisioning/devel_commands.cc b/thin-provisioning/devel_commands.cc index 7a12297..e0f0ae5 100644 --- a/thin-provisioning/devel_commands.cc +++ b/thin-provisioning/devel_commands.cc @@ -8,6 +8,7 @@ using namespace thin_provisioning; void thin_provisioning::register_thin_commands(base::application &app) { + app.add_cmd(command::ptr(new thin_debug_cmd())); app.add_cmd(command::ptr(new thin_generate_damage_cmd())); app.add_cmd(command::ptr(new thin_generate_mappings_cmd())); app.add_cmd(command::ptr(new thin_generate_metadata_cmd())); diff --git a/thin-provisioning/thin_debug.cc b/thin-provisioning/thin_debug.cc index 48ad544..bee3548 100644 --- a/thin-provisioning/thin_debug.cc +++ b/thin-provisioning/thin_debug.cc @@ -29,6 +29,9 @@ #include #include "persistent-data/data-structures/btree.h" +#include "persistent-data/data-structures/simple_traits.h" +#include "persistent-data/file_utils.h" +#include "thin-provisioning/commands.h" #include "thin-provisioning/metadata.h" #include "thin-provisioning/metadata_checker.h" #include "version.h" @@ -43,7 +46,7 @@ namespace { class formatter { public: - typedef shared_ptr ptr; + typedef std::shared_ptr ptr; virtual ~formatter() {} @@ -60,8 +63,8 @@ namespace { virtual void output(ostream &out, int depth = 0) = 0; protected: - typedef variant value; - typedef tuple field_type; + typedef boost::variant value; + typedef boost::tuple field_type; vector fields_; }; @@ -183,7 +186,7 @@ namespace { virtual void exec(strings const &args, ostream &out) { xml_formatter f; - superblock const &sb = md_->sb_; + thin_provisioning::superblock_detail::superblock const &sb = md_->sb_; field(f, "csum", sb.csum_); field(f, "flags", sb.flags_); @@ -210,9 +213,10 @@ namespace { metadata::ptr md_; }; - class device_details_show_traits : public device_details_traits { + class device_details_show_traits : public thin_provisioning::device_tree_detail::device_details_traits { public: - static void show(formatter &f, string const &key, device_details const &value) { + static void show(formatter &f, string const &key, + thin_provisioning::device_tree_detail::device_details const &value) { field(f, "mapped blocks", value.mapped_blocks_); field(f, "transaction id", value.transaction_id_); field(f, "creation time", value.creation_time_); @@ -227,9 +231,10 @@ namespace { } }; - class block_show_traits : public block_traits { + class block_show_traits : public thin_provisioning::mapping_tree_detail::block_traits { public: - static void show(formatter &f, string const &key, block_time const &value) { + static void show(formatter &f, string const &key, + thin_provisioning::mapping_tree_detail::block_time const &value) { field(f, "block", value.block_); field(f, "time", value.time_); } @@ -249,7 +254,7 @@ namespace { throw runtime_error("incorrect number of arguments"); block_address block = lexical_cast(args[1]); - block_manager<>::read_ref rr = md_->tm_->read_lock(block); + block_manager::read_ref rr = md_->tm_->read_lock(block); node_ref n = btree_detail::to_node(rr); if (n.get_type() == INTERNAL) @@ -289,7 +294,8 @@ namespace { int debug(string const &path) { try { - metadata::ptr md(new metadata(path, metadata::OPEN)); + block_manager::ptr bm = open_bm(path, block_manager::READ_ONLY, 1); + metadata::ptr md(new metadata(bm, false)); command_interpreter interp(cin, cout); interp.register_command("hello", command::ptr(new hello)); interp.register_command("superblock", command::ptr(new show_superblock(md))); @@ -306,15 +312,24 @@ namespace { return 0; } - void usage(string const &cmd) { - cerr << "Usage: " << cmd << " {device|file}" << endl - << "Options:" << endl - << " {-h|--help}" << endl - << " {-V|--version}" << endl; - } } -int main(int argc, char **argv) +thin_debug_cmd::thin_debug_cmd() + : command("thin_debug") +{ +} + +void +thin_debug_cmd::usage(std::ostream &out) const +{ + out << "Usage: " << get_name() << " {device|file}" << endl + << "Options:" << endl + << " {-h|--help}" << endl + << " {-V|--version}" << endl; +} + +int +thin_debug_cmd::run(int argc, char **argv) { int c; const char shortopts[] = "hV"; @@ -327,7 +342,7 @@ int main(int argc, char **argv) while ((c = getopt_long(argc, argv, shortopts, longopts, NULL)) != -1) { switch(c) { case 'h': - usage(basename(argv[0])); + usage(cout); return 0; case 'V': @@ -337,7 +352,7 @@ int main(int argc, char **argv) } if (argc == optind) { - usage(basename(argv[0])); + usage(cerr); exit(1); } From 62d09c675226d891fdf4a69016de7fb6fec3959b Mon Sep 17 00:00:00 2001 From: Ming-Hung Tsai Date: Tue, 12 Jan 2021 18:09:00 +0800 Subject: [PATCH 02/11] [thin_debug] Reduce code size by eliminating duplicated types This patch doesn't have a significant effect - only a few KBs of code is reduced. However, it's still a nice have. --- thin-provisioning/thin_debug.cc | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/thin-provisioning/thin_debug.cc b/thin-provisioning/thin_debug.cc index bee3548..8a175e0 100644 --- a/thin-provisioning/thin_debug.cc +++ b/thin-provisioning/thin_debug.cc @@ -215,6 +215,8 @@ namespace { class device_details_show_traits : public thin_provisioning::device_tree_detail::device_details_traits { public: + typedef thin_provisioning::device_tree_detail::device_details_traits value_trait; + static void show(formatter &f, string const &key, thin_provisioning::device_tree_detail::device_details const &value) { field(f, "mapped blocks", value.mapped_blocks_); @@ -226,6 +228,8 @@ namespace { class uint64_show_traits : public uint64_traits { public: + typedef uint64_traits value_trait; + static void show(formatter &f, string const &key, uint64_t const &value) { field(f, key, lexical_cast(value)); } @@ -233,6 +237,8 @@ namespace { class block_show_traits : public thin_provisioning::mapping_tree_detail::block_traits { public: + typedef thin_provisioning::mapping_tree_detail::block_traits value_trait; + static void show(formatter &f, string const &key, thin_provisioning::mapping_tree_detail::block_time const &value) { field(f, "block", value.block_); @@ -240,7 +246,7 @@ namespace { } }; - template + template class show_btree_node : public command { public: explicit show_btree_node(metadata::ptr md) @@ -256,18 +262,18 @@ namespace { block_address block = lexical_cast(args[1]); block_manager::read_ref rr = md_->tm_->read_lock(block); - node_ref n = btree_detail::to_node(rr); + node_ref n = btree_detail::to_node(rr); if (n.get_type() == INTERNAL) show_node(n, out); else { - node_ref n = btree_detail::to_node(rr); - show_node(n, out); + node_ref n = btree_detail::to_node(rr); + show_node(n, out); } } private: - template - void show_node(node_ref n, ostream &out) { + template + void show_node(node_ref n, ostream &out) { xml_formatter f; field(f, "csum", n.get_checksum()); @@ -280,7 +286,7 @@ namespace { for (unsigned i = 0; i < n.get_nr_entries(); i++) { formatter::ptr f2(new xml_formatter); field(*f2, "key", n.key_at(i)); - VT::show(*f2, "value", n.value_at(i)); + ST::show(*f2, "value", n.value_at(i)); f.child("child", f2); } From 127f44c66b885d4c14de588a7e6f5cd961c9704b Mon Sep 17 00:00:00 2001 From: Ming-Hung Tsai Date: Tue, 12 Jan 2021 20:59:02 +0800 Subject: [PATCH 03/11] [thin_debug] Enhance error handling - Handle exception thrown by commands - Add help and exit commands --- thin-provisioning/thin_debug.cc | 62 ++++++++++++++++++++++++++++----- 1 file changed, 54 insertions(+), 8 deletions(-) diff --git a/thin-provisioning/thin_debug.cc b/thin-provisioning/thin_debug.cc index 8a175e0..2340479 100644 --- a/thin-provisioning/thin_debug.cc +++ b/thin-provisioning/thin_debug.cc @@ -34,6 +34,7 @@ #include "thin-provisioning/commands.h" #include "thin-provisioning/metadata.h" #include "thin-provisioning/metadata_checker.h" +#include "thin-provisioning/superblock.h" #include "version.h" using namespace boost; @@ -122,9 +123,12 @@ namespace { class command_interpreter { public: + typedef std::shared_ptr ptr; + command_interpreter(istream &in, ostream &out) : in_(in), - out_(out) { + out_(out), + exit_(false) { } void register_command(string const &str, command::ptr cmd) { @@ -132,10 +136,14 @@ namespace { } void enter_main_loop() { - while (true) + while (!exit_) do_once(); } + void exit_main_loop() { + exit_ = true; + } + private: strings read_input() { using namespace boost::algorithm; @@ -160,13 +168,19 @@ namespace { it = commands_.find(args[0]); if (it == commands_.end()) out_ << "Unrecognised command" << endl; - else - it->second->exec(args, out_); + else { + try { + it->second->exec(args, out_); + } catch (std::exception &e) { + cerr << e.what() << endl; + } + } } istream &in_; ostream &out_; map commands_; + bool exit_; }; //-------------------------------- @@ -177,6 +191,31 @@ namespace { } }; + class help : public command { + virtual void exec(strings const &args, ostream &out) { + out << "Commands:" << endl + << " superblock" << endl + << " m1_node " << endl + << " m2_node " << endl + << " detail_node " << endl + << " exit" << endl; + } + }; + + class exit_handler : public command { + public: + exit_handler(command_interpreter &interpreter) + : interpreter_(interpreter) { + } + + virtual void exec(strings const &args, ostream &out) { + out << "Goodbye!" << endl; + interpreter_.exit_main_loop(); + } + + command_interpreter &interpreter_; + }; + class show_superblock : public command { public: explicit show_superblock(metadata::ptr md) @@ -298,7 +337,7 @@ namespace { //-------------------------------- - int debug(string const &path) { + int debug(string const &path, bool ignore_metadata_sm) { try { block_manager::ptr bm = open_bm(path, block_manager::READ_ONLY, 1); metadata::ptr md(new metadata(bm, false)); @@ -308,16 +347,17 @@ namespace { interp.register_command("m1_node", command::ptr(new show_btree_node(md))); interp.register_command("m2_node", command::ptr(new show_btree_node(md))); interp.register_command("detail_node", command::ptr(new show_btree_node(md))); + interp.register_command("help", command::ptr(new help)); + interp.register_command("exit", command::ptr(new exit_handler(interp))); interp.enter_main_loop(); } catch (std::exception &e) { - cerr << e.what(); + cerr << e.what() << endl; return 1; } return 0; } - } thin_debug_cmd::thin_debug_cmd() @@ -342,8 +382,10 @@ thin_debug_cmd::run(int argc, char **argv) const struct option longopts[] = { { "help", no_argument, NULL, 'h'}, { "version", no_argument, NULL, 'V'}, + { "ignore-metadata-sm", no_argument, NULL, 1}, { NULL, no_argument, NULL, 0 } }; + bool ignore_metadata_sm = false; while ((c = getopt_long(argc, argv, shortopts, longopts, NULL)) != -1) { switch(c) { @@ -354,6 +396,10 @@ thin_debug_cmd::run(int argc, char **argv) case 'V': cerr << THIN_PROVISIONING_TOOLS_VERSION << endl; return 0; + + case 1: + ignore_metadata_sm = true; + break; } } @@ -362,5 +408,5 @@ thin_debug_cmd::run(int argc, char **argv) exit(1); } - return debug(argv[optind]); + return debug(argv[optind], ignore_metadata_sm); } From 3bfa775887d2fb613057d1c69f013f63ab59a28e Mon Sep 17 00:00:00 2001 From: Ming-Hung Tsai Date: Wed, 13 Jan 2021 11:43:14 +0800 Subject: [PATCH 04/11] [thin_debug] Show space map roots in superblock --- thin-provisioning/thin_debug.cc | 41 +++++++++++++++++++++++++++++---- 1 file changed, 37 insertions(+), 4 deletions(-) diff --git a/thin-provisioning/thin_debug.cc b/thin-provisioning/thin_debug.cc index 2340479..fa6e457 100644 --- a/thin-provisioning/thin_debug.cc +++ b/thin-provisioning/thin_debug.cc @@ -31,6 +31,7 @@ #include "persistent-data/data-structures/btree.h" #include "persistent-data/data-structures/simple_traits.h" #include "persistent-data/file_utils.h" +#include "persistent-data/space-maps/disk_structures.h" #include "thin-provisioning/commands.h" #include "thin-provisioning/metadata.h" #include "thin-provisioning/metadata_checker.h" @@ -61,7 +62,7 @@ namespace { fields_.push_back(field_type(name, t)); } - virtual void output(ostream &out, int depth = 0) = 0; + virtual void output(ostream &out, int depth = 0, boost::optional name = boost::none) = 0; protected: typedef boost::variant value; @@ -80,9 +81,12 @@ namespace { class xml_formatter : public formatter { public: - virtual void output(ostream &out, int depth) { + virtual void output(ostream &out, int depth, boost::optional name = boost::none) { indent(depth, out); - out << "" << endl; + if (name && (*name).length()) + out << "" << endl; + else + out << "" << endl; vector::const_iterator it; for (it = fields_.begin(); it != fields_.end(); ++it) { if (string const *s = get(&it->get<1>())) { @@ -96,7 +100,7 @@ namespace { } else { formatter::ptr f = get(it->get<1>()); - f->output(out, depth + 1); + f->output(out, depth + 1, it->get<0>()); } } @@ -216,6 +220,17 @@ namespace { command_interpreter &interpreter_; }; + class sm_root_show_traits : public persistent_data::sm_disk_detail::sm_root_traits { + public: + static void show(formatter &f, string const &key, + persistent_data::sm_disk_detail::sm_root const &value) { + field(f, "nr blocks", value.nr_blocks_); + field(f, "nr allocated", value.nr_allocated_); + field(f, "bitmap root", value.bitmap_root_); + field(f, "ref count root", value.ref_count_root_); + } + }; + class show_superblock : public command { public: explicit show_superblock(metadata::ptr md) @@ -236,6 +251,24 @@ namespace { field(f, "time", sb.time_); field(f, "trans id", sb.trans_id_); field(f, "metadata snap", sb.metadata_snap_); + + sm_disk_detail::sm_root_disk const *d; + sm_disk_detail::sm_root v; + { + d = reinterpret_cast(sb.metadata_space_map_root_); + sm_disk_detail::sm_root_traits::unpack(*d, v); + formatter::ptr f2(new xml_formatter); + sm_root_show_traits::show(*f2, "value", v); + f.child("metadata space map root", f2); + } + { + d = reinterpret_cast(sb.data_space_map_root_); + sm_disk_detail::sm_root_traits::unpack(*d, v); + formatter::ptr f2(new xml_formatter); + sm_root_show_traits::show(*f2, "value", v); + f.child("data space map root", f2); + } + field(f, "data mapping root", sb.data_mapping_root_); field(f, "device details root", sb.device_details_root_); field(f, "data block size", sb.data_block_size_); From 6dc50866436fb451e542f40b6645f38b37cc2929 Mon Sep 17 00:00:00 2001 From: Ming-Hung Tsai Date: Wed, 13 Jan 2021 11:56:18 +0800 Subject: [PATCH 05/11] [thin_debug] Add commands to show space maps --- thin-provisioning/thin_debug.cc | 63 +++++++++++++++++++++++++++++++++ 1 file changed, 63 insertions(+) diff --git a/thin-provisioning/thin_debug.cc b/thin-provisioning/thin_debug.cc index fa6e457..fc725e8 100644 --- a/thin-provisioning/thin_debug.cc +++ b/thin-provisioning/thin_debug.cc @@ -28,6 +28,7 @@ #include #include +#include "base/math_utils.h" #include "persistent-data/data-structures/btree.h" #include "persistent-data/data-structures/simple_traits.h" #include "persistent-data/file_utils.h" @@ -202,6 +203,8 @@ namespace { << " m1_node " << endl << " m2_node " << endl << " detail_node " << endl + << " index_block " << endl + << " index_node " << endl << " exit" << endl; } }; @@ -318,6 +321,18 @@ namespace { } }; + class index_entry_show_traits : public persistent_data::sm_disk_detail::index_entry_traits { + public: + typedef persistent_data::sm_disk_detail::index_entry_traits value_trait; + + static void show(formatter &f, string const &key, + persistent_data::sm_disk_detail::index_entry const &value) { + field(f, "blocknr", value.blocknr_); + field(f, "nr free", value.nr_free_); + field(f, "none free before", value.none_free_before_); + } + }; + template class show_btree_node : public command { public: @@ -368,6 +383,52 @@ namespace { metadata::ptr md_; }; + class show_index_block : public command { + public: + explicit show_index_block(metadata::ptr md) + : md_(md) { + } + + virtual void exec(strings const &args, ostream &out) { + if (args.size() != 2) + throw runtime_error("incorrect number of arguments"); + + // manually load metadata_index, without using index_validator() + block_address block = lexical_cast(args[1]); + block_manager::read_ref rr = md_->tm_->read_lock(block); + + sm_disk_detail::sm_root_disk const *d = + reinterpret_cast(md_->sb_.metadata_space_map_root_); + sm_disk_detail::sm_root v; + sm_disk_detail::sm_root_traits::unpack(*d, v); + block_address nr_indexes = base::div_up(v.nr_blocks_, ENTRIES_PER_BLOCK); + + sm_disk_detail::metadata_index const *mdi = + reinterpret_cast(rr.data()); + show_metadata_index(mdi, nr_indexes, out); + } + + private: + void show_metadata_index(sm_disk_detail::metadata_index const *mdi, block_address nr_indexes, ostream &out) { + xml_formatter f; + field(f, "csum", to_cpu(mdi->csum_)); + field(f, "padding", to_cpu(mdi->padding_)); + field(f, "blocknr", to_cpu(mdi->blocknr_)); + + sm_disk_detail::index_entry ie; + for (block_address i = 0; i < nr_indexes; i++) { + sm_disk_detail::index_entry_traits::unpack(*(mdi->index + i), ie); + formatter::ptr f2(new xml_formatter); + index_entry_show_traits::show(*f2, "value", ie); + f.child(lexical_cast(i), f2); + } + f.output(out, 0); + } + + unsigned const ENTRIES_PER_BLOCK = (MD_BLOCK_SIZE - sizeof(persistent_data::sm_disk_detail::bitmap_header)) * 4; + metadata::ptr md_; + }; + //-------------------------------- int debug(string const &path, bool ignore_metadata_sm) { @@ -380,6 +441,8 @@ namespace { interp.register_command("m1_node", command::ptr(new show_btree_node(md))); interp.register_command("m2_node", command::ptr(new show_btree_node(md))); interp.register_command("detail_node", command::ptr(new show_btree_node(md))); + interp.register_command("index_block", command::ptr(new show_index_block(md))); + interp.register_command("index_node", command::ptr(new show_btree_node(md))); interp.register_command("help", command::ptr(new help)); interp.register_command("exit", command::ptr(new exit_handler(interp))); interp.enter_main_loop(); From ab3b2cbda2bc4ce76246427758fd9c59dc6a95f2 Mon Sep 17 00:00:00 2001 From: Ming-Hung Tsai Date: Wed, 13 Jan 2021 12:02:20 +0800 Subject: [PATCH 06/11] [thin_debug] Refine the outputs - Show the blocknr from node header - Display the index of node entries --- thin-provisioning/thin_debug.cc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/thin-provisioning/thin_debug.cc b/thin-provisioning/thin_debug.cc index fc725e8..96fca15 100644 --- a/thin-provisioning/thin_debug.cc +++ b/thin-provisioning/thin_debug.cc @@ -364,7 +364,7 @@ namespace { xml_formatter f; field(f, "csum", n.get_checksum()); - field(f, "blocknr", n.get_location()); + field(f, "blocknr", n.get_block_nr()); field(f, "type", n.get_type() == INTERNAL ? "internal" : "leaf"); field(f, "nr entries", n.get_nr_entries()); field(f, "max entries", n.get_max_entries()); @@ -374,7 +374,7 @@ namespace { formatter::ptr f2(new xml_formatter); field(*f2, "key", n.key_at(i)); ST::show(*f2, "value", n.value_at(i)); - f.child("child", f2); + f.child(lexical_cast(i), f2); } f.output(out, 0); From 0816430ba0550effaa89c7d79f2ef3759d70f1c3 Mon Sep 17 00:00:00 2001 From: Ming-Hung Tsai Date: Wed, 13 Jan 2021 14:10:49 +0800 Subject: [PATCH 07/11] [thin_debug] Remove the using boost directive to avoid namespace pollution boost::uint32_t might conflict with the toolchain defined uint32_t. which causes template argument deduction failed. --- thin-provisioning/thin_debug.cc | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/thin-provisioning/thin_debug.cc b/thin-provisioning/thin_debug.cc index 96fca15..f3332b8 100644 --- a/thin-provisioning/thin_debug.cc +++ b/thin-provisioning/thin_debug.cc @@ -39,7 +39,6 @@ #include "thin-provisioning/superblock.h" #include "version.h" -using namespace boost; using namespace persistent_data; using namespace std; using namespace thin_provisioning; @@ -53,7 +52,7 @@ namespace { virtual ~formatter() {} - typedef optional maybe_string; + typedef boost::optional maybe_string; void field(string const &name, string const &value) { fields_.push_back(field_type(name, value)); @@ -75,7 +74,7 @@ namespace { template void field(formatter &t, string const &name, T const &value) { - t.field(name, lexical_cast(value)); + t.field(name, boost::lexical_cast(value)); } //-------------------------------- @@ -90,7 +89,7 @@ namespace { out << "" << endl; vector::const_iterator it; for (it = fields_.begin(); it != fields_.end(); ++it) { - if (string const *s = get(&it->get<1>())) { + if (string const *s = boost::get(&it->get<1>())) { indent(depth + 1, out); out << "get<0>() @@ -100,7 +99,7 @@ namespace { << endl; } else { - formatter::ptr f = get(it->get<1>()); + formatter::ptr f = boost::get(it->get<1>()); f->output(out, depth + 1, it->get<0>()); } } @@ -306,7 +305,7 @@ namespace { typedef uint64_traits value_trait; static void show(formatter &f, string const &key, uint64_t const &value) { - field(f, key, lexical_cast(value)); + field(f, key, boost::lexical_cast(value)); } }; @@ -346,7 +345,7 @@ namespace { if (args.size() != 2) throw runtime_error("incorrect number of arguments"); - block_address block = lexical_cast(args[1]); + block_address block = boost::lexical_cast(args[1]); block_manager::read_ref rr = md_->tm_->read_lock(block); node_ref n = btree_detail::to_node(rr); @@ -374,7 +373,7 @@ namespace { formatter::ptr f2(new xml_formatter); field(*f2, "key", n.key_at(i)); ST::show(*f2, "value", n.value_at(i)); - f.child(lexical_cast(i), f2); + f.child(boost::lexical_cast(i), f2); } f.output(out, 0); @@ -394,7 +393,7 @@ namespace { throw runtime_error("incorrect number of arguments"); // manually load metadata_index, without using index_validator() - block_address block = lexical_cast(args[1]); + block_address block = boost::lexical_cast(args[1]); block_manager::read_ref rr = md_->tm_->read_lock(block); sm_disk_detail::sm_root_disk const *d = @@ -420,7 +419,7 @@ namespace { sm_disk_detail::index_entry_traits::unpack(*(mdi->index + i), ie); formatter::ptr f2(new xml_formatter); index_entry_show_traits::show(*f2, "value", ie); - f.child(lexical_cast(i), f2); + f.child(boost::lexical_cast(i), f2); } f.output(out, 0); } From e046bbf5c49206fe0c04cc0cf3c82d13e21f2b30 Mon Sep 17 00:00:00 2001 From: Ming-Hung Tsai Date: Wed, 13 Jan 2021 14:30:37 +0800 Subject: [PATCH 08/11] [thin_debug] Simplify the output format Turn nested fields into attributes. Also replace spaces in field names by underscores. --- thin-provisioning/thin_debug.cc | 81 ++++++++++++++++++--------------- 1 file changed, 44 insertions(+), 37 deletions(-) diff --git a/thin-provisioning/thin_debug.cc b/thin-provisioning/thin_debug.cc index f3332b8..ea3541c 100644 --- a/thin-provisioning/thin_debug.cc +++ b/thin-provisioning/thin_debug.cc @@ -59,7 +59,7 @@ namespace { } void child(string const &name, formatter::ptr t) { - fields_.push_back(field_type(name, t)); + children_.push_back(field_type(name, t)); } virtual void output(ostream &out, int depth = 0, boost::optional name = boost::none) = 0; @@ -69,6 +69,7 @@ namespace { typedef boost::tuple field_type; vector fields_; + vector children_; }; template @@ -83,22 +84,27 @@ namespace { public: virtual void output(ostream &out, int depth, boost::optional name = boost::none) { indent(depth, out); + out << "" << endl; - else - out << "" << endl; + out << " id=\"" << *name << "\""; + + /* output non-child fields */ vector::const_iterator it; for (it = fields_.begin(); it != fields_.end(); ++it) { if (string const *s = boost::get(&it->get<1>())) { - indent(depth + 1, out); - out << "get<0>() - << "\" value=\"" - << *s - << "\"/>" - << endl; + out << " " << it->get<0>() << "=\"" << *s << "\""; + } + } - } else { + if (children_.size() == 0) { + out << " />" << endl; + return; + } + + /* output child fields */ + out << ">" << endl; + for (it = children_.begin(); it != children_.end(); ++it) { + if (!boost::get(&it->get<1>())) { formatter::ptr f = boost::get(it->get<1>()); f->output(out, depth + 1, it->get<0>()); } @@ -108,6 +114,7 @@ namespace { out << "" << endl; } + private: void indent(int depth, ostream &out) const { for (int i = 0; i < depth * 2; i++) @@ -226,10 +233,10 @@ namespace { public: static void show(formatter &f, string const &key, persistent_data::sm_disk_detail::sm_root const &value) { - field(f, "nr blocks", value.nr_blocks_); - field(f, "nr allocated", value.nr_allocated_); - field(f, "bitmap root", value.bitmap_root_); - field(f, "ref count root", value.ref_count_root_); + field(f, "nr_blocks", value.nr_blocks_); + field(f, "nr_allocated", value.nr_allocated_); + field(f, "bitmap_root", value.bitmap_root_); + field(f, "ref_count_root", value.ref_count_root_); } }; @@ -251,8 +258,8 @@ namespace { field(f, "magic", sb.magic_); field(f, "version", sb.version_); field(f, "time", sb.time_); - field(f, "trans id", sb.trans_id_); - field(f, "metadata snap", sb.metadata_snap_); + field(f, "trans_id", sb.trans_id_); + field(f, "metadata_snap", sb.metadata_snap_); sm_disk_detail::sm_root_disk const *d; sm_disk_detail::sm_root v; @@ -261,24 +268,24 @@ namespace { sm_disk_detail::sm_root_traits::unpack(*d, v); formatter::ptr f2(new xml_formatter); sm_root_show_traits::show(*f2, "value", v); - f.child("metadata space map root", f2); + f.child("metadata_space_map_root", f2); } { d = reinterpret_cast(sb.data_space_map_root_); sm_disk_detail::sm_root_traits::unpack(*d, v); formatter::ptr f2(new xml_formatter); sm_root_show_traits::show(*f2, "value", v); - f.child("data space map root", f2); + f.child("data_space_map_root", f2); } - field(f, "data mapping root", sb.data_mapping_root_); - field(f, "device details root", sb.device_details_root_); - field(f, "data block size", sb.data_block_size_); - field(f, "metadata block size", sb.metadata_block_size_); - field(f, "metadata nr blocks", sb.metadata_nr_blocks_); - field(f, "compat flags", sb.compat_flags_); - field(f, "compat ro flags", sb.compat_ro_flags_); - field(f, "incompat flags", sb.incompat_flags_); + field(f, "data_mapping_root", sb.data_mapping_root_); + field(f, "device_details_root", sb.device_details_root_); + field(f, "data_block_size", sb.data_block_size_); + field(f, "metadata_block_size", sb.metadata_block_size_); + field(f, "metadata_nr_blocks", sb.metadata_nr_blocks_); + field(f, "compat_flags", sb.compat_flags_); + field(f, "compat_ro_flags", sb.compat_ro_flags_); + field(f, "incompat_flags", sb.incompat_flags_); f.output(out, 0); } @@ -293,10 +300,10 @@ namespace { static void show(formatter &f, string const &key, thin_provisioning::device_tree_detail::device_details const &value) { - field(f, "mapped blocks", value.mapped_blocks_); - field(f, "transaction id", value.transaction_id_); - field(f, "creation time", value.creation_time_); - field(f, "snap time", value.snapshotted_time_); + field(f, "mapped_blocks", value.mapped_blocks_); + field(f, "transaction_id", value.transaction_id_); + field(f, "creation_time", value.creation_time_); + field(f, "snap_time", value.snapshotted_time_); } }; @@ -327,8 +334,8 @@ namespace { static void show(formatter &f, string const &key, persistent_data::sm_disk_detail::index_entry const &value) { field(f, "blocknr", value.blocknr_); - field(f, "nr free", value.nr_free_); - field(f, "none free before", value.none_free_before_); + field(f, "nr_free", value.nr_free_); + field(f, "none_free_before", value.none_free_before_); } }; @@ -365,9 +372,9 @@ namespace { field(f, "csum", n.get_checksum()); field(f, "blocknr", n.get_block_nr()); field(f, "type", n.get_type() == INTERNAL ? "internal" : "leaf"); - field(f, "nr entries", n.get_nr_entries()); - field(f, "max entries", n.get_max_entries()); - field(f, "value size", n.get_value_size()); + field(f, "nr_entries", n.get_nr_entries()); + field(f, "max_entries", n.get_max_entries()); + field(f, "value_size", n.get_value_size()); for (unsigned i = 0; i < n.get_nr_entries(); i++) { formatter::ptr f2(new xml_formatter); From b9b04dc872fadcf89eaee6211c698188bf8d30ba Mon Sep 17 00:00:00 2001 From: Ming-Hung Tsai Date: Thu, 21 Jan 2021 16:05:28 +0800 Subject: [PATCH 09/11] [thin_debug] Factor out reusable componments --- Makefile.in | 2 + base/command_interpreter.cc | 44 ++++++++ base/command_interpreter.h | 60 +++++++++++ base/output_formatter.cc | 53 ++++++++++ base/output_formatter.h | 59 +++++++++++ thin-provisioning/thin_debug.cc | 181 +++----------------------------- 6 files changed, 231 insertions(+), 168 deletions(-) create mode 100644 base/command_interpreter.cc create mode 100644 base/command_interpreter.h create mode 100644 base/output_formatter.cc create mode 100644 base/output_formatter.h diff --git a/Makefile.in b/Makefile.in index c70159d..ae7ebcd 100644 --- a/Makefile.in +++ b/Makefile.in @@ -126,6 +126,8 @@ TOOLS_SOURCE=\ thin-provisioning/thin_trim.cc DEVTOOLS_SOURCE=\ + base/command_interpreter.cc \ + base/output_formatter.cc \ caching/devel_commands.cc \ era/devel_commands.cc \ thin-provisioning/damage_generator.cc \ diff --git a/base/command_interpreter.cc b/base/command_interpreter.cc new file mode 100644 index 0000000..e2e4e82 --- /dev/null +++ b/base/command_interpreter.cc @@ -0,0 +1,44 @@ +#include "base/command_interpreter.h" + +using namespace dbg; +using namespace std; + +//---------------------------------------------------------------- + +namespace { + strings read_input(std::istream &in) { + using namespace boost::algorithm; + + std::string input; + getline(in, input); + + strings toks; + split(toks, input, is_any_of(" \t"), token_compress_on); + + return toks; + } +} + +//---------------------------------------------------------------- + +void command_interpreter::do_once() { + if (in_.eof()) + throw runtime_error("input closed"); + + out_ << "> "; + strings args = read_input(in_); + + std::map::iterator it; + it = commands_.find(args[0]); + if (it == commands_.end()) + out_ << "Unrecognised command" << endl; + else { + try { + it->second->exec(args, out_); + } catch (std::exception &e) { + cerr << e.what() << endl; + } + } +} + +//---------------------------------------------------------------- diff --git a/base/command_interpreter.h b/base/command_interpreter.h new file mode 100644 index 0000000..0b4abca --- /dev/null +++ b/base/command_interpreter.h @@ -0,0 +1,60 @@ +#ifndef DBG_COMMAND_INTERPRETER +#define DBG_COMMAND_INTERPRETER + +#include +#include + +#include +#include +#include +#include + +//---------------------------------------------------------------- + +namespace dbg { + typedef std::vector strings; + + class command { + public: + typedef std::shared_ptr ptr; + + virtual ~command() {} + virtual void exec(strings const &args, std::ostream &out) = 0; + }; + + class command_interpreter { + public: + typedef std::shared_ptr ptr; + + command_interpreter(std::istream &in, std::ostream &out) + : in_(in), + out_(out), + exit_(false) { + } + + void register_command(std::string const &str, command::ptr cmd) { + commands_.insert(make_pair(str, cmd)); + } + + void enter_main_loop() { + while (!exit_) + do_once(); + } + + void exit_main_loop() { + exit_ = true; + } + + private: + void do_once(); + + std::istream &in_; + std::ostream &out_; + std::map commands_; + bool exit_; + }; +} + +//---------------------------------------------------------------- + +#endif diff --git a/base/output_formatter.cc b/base/output_formatter.cc new file mode 100644 index 0000000..54ef578 --- /dev/null +++ b/base/output_formatter.cc @@ -0,0 +1,53 @@ +#include + +#include "base/output_formatter.h" + +using namespace dbg; +using namespace std; + +//---------------------------------------------------------------- + +namespace { + void indent(int depth, std::ostream &out) { + for (int i = 0; i < depth * 2; i++) + out << ' '; + } +} + +//---------------------------------------------------------------- + +void xml_formatter::output(std::ostream &out, + int depth, + boost::optional name) { + indent(depth, out); + out << "::const_iterator it; + for (it = fields_.begin(); it != fields_.end(); ++it) { + if (string const *s = boost::get(&it->get<1>())) { + out << " " << it->get<0>() << "=\"" << *s << "\""; + } + } + + if (children_.size() == 0) { + out << " />" << endl; + return; + } + + /* output child fields */ + out << ">" << endl; + for (it = children_.begin(); it != children_.end(); ++it) { + if (!boost::get(&it->get<1>())) { + formatter::ptr f = boost::get(it->get<1>()); + f->output(out, depth + 1, it->get<0>()); + } + } + + indent(depth, out); + out << "" << endl; +} + +//---------------------------------------------------------------- diff --git a/base/output_formatter.h b/base/output_formatter.h new file mode 100644 index 0000000..2299f9d --- /dev/null +++ b/base/output_formatter.h @@ -0,0 +1,59 @@ +#ifndef DBG_OUTPUT_FORMATTER_H +#define DBG_OUTPUT_FORMATTER_H + +#include +#include +#include +#include + +#include +#include + +//---------------------------------------------------------------- + +namespace dbg { + class formatter { + public: + typedef std::shared_ptr ptr; + + virtual ~formatter() {} + + typedef boost::optional maybe_string; + + void field(std::string const &name, std::string const &value) { + fields_.push_back(field_type(name, value)); + } + + void child(std::string const &name, formatter::ptr t) { + children_.push_back(field_type(name, t)); + } + + virtual void output(std::ostream &out, int depth = 0, + boost::optional name = boost::none) = 0; + + protected: + typedef boost::variant value; + typedef boost::tuple field_type; + + std::vector fields_; + std::vector children_; + }; + + template + void + field(formatter &t, std::string const &name, T const &value) { + t.field(name, boost::lexical_cast(value)); + } + + //-------------------------------- + + class xml_formatter : public formatter { + public: + virtual void output(std::ostream &out, int depth = 0, + boost::optional name = boost::none); + }; +} + +//---------------------------------------------------------------- + +#endif diff --git a/thin-provisioning/thin_debug.cc b/thin-provisioning/thin_debug.cc index ea3541c..a48b79f 100644 --- a/thin-provisioning/thin_debug.cc +++ b/thin-provisioning/thin_debug.cc @@ -16,193 +16,36 @@ // with thin-provisioning-tools. If not, see // . -#include -#include #include -#include -#include #include #include -#include -#include #include -#include +#include "base/command_interpreter.h" #include "base/math_utils.h" +#include "base/output_formatter.h" #include "persistent-data/data-structures/btree.h" #include "persistent-data/data-structures/simple_traits.h" #include "persistent-data/file_utils.h" #include "persistent-data/space-maps/disk_structures.h" #include "thin-provisioning/commands.h" #include "thin-provisioning/metadata.h" -#include "thin-provisioning/metadata_checker.h" #include "thin-provisioning/superblock.h" #include "version.h" +using namespace dbg; using namespace persistent_data; using namespace std; using namespace thin_provisioning; namespace { - typedef vector strings; - - class formatter { - public: - typedef std::shared_ptr ptr; - - virtual ~formatter() {} - - typedef boost::optional maybe_string; - - void field(string const &name, string const &value) { - fields_.push_back(field_type(name, value)); - } - - void child(string const &name, formatter::ptr t) { - children_.push_back(field_type(name, t)); - } - - virtual void output(ostream &out, int depth = 0, boost::optional name = boost::none) = 0; - - protected: - typedef boost::variant value; - typedef boost::tuple field_type; - - vector fields_; - vector children_; - }; - - template - void - field(formatter &t, string const &name, T const &value) { - t.field(name, boost::lexical_cast(value)); - } - - //-------------------------------- - - class xml_formatter : public formatter { - public: - virtual void output(ostream &out, int depth, boost::optional name = boost::none) { - indent(depth, out); - out << "::const_iterator it; - for (it = fields_.begin(); it != fields_.end(); ++it) { - if (string const *s = boost::get(&it->get<1>())) { - out << " " << it->get<0>() << "=\"" << *s << "\""; - } - } - - if (children_.size() == 0) { - out << " />" << endl; - return; - } - - /* output child fields */ - out << ">" << endl; - for (it = children_.begin(); it != children_.end(); ++it) { - if (!boost::get(&it->get<1>())) { - formatter::ptr f = boost::get(it->get<1>()); - f->output(out, depth + 1, it->get<0>()); - } - } - - indent(depth, out); - out << "" << endl; - } - - - private: - void indent(int depth, ostream &out) const { - for (int i = 0; i < depth * 2; i++) - out << ' '; - } - }; - - //-------------------------------- - - class command { - public: - typedef std::shared_ptr ptr; - - virtual ~command() {} - virtual void exec(strings const &args, ostream &out) = 0; - }; - - class command_interpreter { - public: - typedef std::shared_ptr ptr; - - command_interpreter(istream &in, ostream &out) - : in_(in), - out_(out), - exit_(false) { - } - - void register_command(string const &str, command::ptr cmd) { - commands_.insert(make_pair(str, cmd)); - } - - void enter_main_loop() { - while (!exit_) - do_once(); - } - - void exit_main_loop() { - exit_ = true; - } - - private: - strings read_input() { - using namespace boost::algorithm; - - string input; - getline(in_, input); - - strings toks; - split(toks, input, is_any_of(" \t"), token_compress_on); - - return toks; - } - - void do_once() { - if (in_.eof()) - throw runtime_error("input closed"); - - out_ << "> "; - strings args = read_input(); - - map::iterator it; - it = commands_.find(args[0]); - if (it == commands_.end()) - out_ << "Unrecognised command" << endl; - else { - try { - it->second->exec(args, out_); - } catch (std::exception &e) { - cerr << e.what() << endl; - } - } - } - - istream &in_; - ostream &out_; - map commands_; - bool exit_; - }; - - //-------------------------------- - - class hello : public command { + class hello : public dbg::command { virtual void exec(strings const &args, ostream &out) { out << "Hello, world!" << endl; } }; - class help : public command { + class help : public dbg::command { virtual void exec(strings const &args, ostream &out) { out << "Commands:" << endl << " superblock" << endl @@ -215,7 +58,7 @@ namespace { } }; - class exit_handler : public command { + class exit_handler : public dbg::command { public: exit_handler(command_interpreter &interpreter) : interpreter_(interpreter) { @@ -240,7 +83,7 @@ namespace { } }; - class show_superblock : public command { + class show_superblock : public dbg::command { public: explicit show_superblock(metadata::ptr md) : md_(md) { @@ -340,7 +183,7 @@ namespace { }; template - class show_btree_node : public command { + class show_btree_node : public dbg::command { public: explicit show_btree_node(metadata::ptr md) : md_(md) { @@ -389,7 +232,7 @@ namespace { metadata::ptr md_; }; - class show_index_block : public command { + class show_index_block : public dbg::command { public: explicit show_index_block(metadata::ptr md) : md_(md) { @@ -437,7 +280,9 @@ namespace { //-------------------------------- - int debug(string const &path, bool ignore_metadata_sm) { + int debug_(string const &path, bool ignore_metadata_sm) { + using dbg::command; + try { block_manager::ptr bm = open_bm(path, block_manager::READ_ONLY, 1); metadata::ptr md(new metadata(bm, false)); @@ -510,5 +355,5 @@ thin_debug_cmd::run(int argc, char **argv) exit(1); } - return debug(argv[optind], ignore_metadata_sm); + return debug_(argv[optind], ignore_metadata_sm); } From a05ac553b6581fd1889f750b1e4f2c0f777174b7 Mon Sep 17 00:00:00 2001 From: Ming-Hung Tsai Date: Wed, 3 Feb 2021 17:11:24 +0800 Subject: [PATCH 10/11] [dbg] Hide implementations of shared components --- base/command_interpreter.cc | 48 +++++++++- base/command_interpreter.h | 32 ++----- base/output_formatter.cc | 33 +++++++ base/output_formatter.h | 28 +----- thin-provisioning/thin_debug.cc | 154 ++++++++++++++++---------------- 5 files changed, 165 insertions(+), 130 deletions(-) diff --git a/base/command_interpreter.cc b/base/command_interpreter.cc index e2e4e82..ce7bd97 100644 --- a/base/command_interpreter.cc +++ b/base/command_interpreter.cc @@ -6,7 +6,42 @@ using namespace std; //---------------------------------------------------------------- namespace { - strings read_input(std::istream &in) { + class command_interpreter_impl : public command_interpreter { + public: + typedef std::shared_ptr ptr; + + command_interpreter_impl(std::istream &in, std::ostream &out) + : in_(in), + out_(out), + exit_(false) { + } + + void register_command(std::string const &str, command::ptr cmd) { + commands_.insert(make_pair(str, cmd)); + } + + void enter_main_loop() { + while (!exit_) + do_once(); + } + + void exit_main_loop() { + exit_ = true; + } + + private: + void do_once(); + + std::istream &in_; + std::ostream &out_; + std::map commands_; + bool exit_; + }; + + //-------------------------------- + + strings read_input(std::istream &in) + { using namespace boost::algorithm; std::string input; @@ -21,7 +56,8 @@ namespace { //---------------------------------------------------------------- -void command_interpreter::do_once() { +void command_interpreter_impl::do_once() +{ if (in_.eof()) throw runtime_error("input closed"); @@ -42,3 +78,11 @@ void command_interpreter::do_once() { } //---------------------------------------------------------------- + +command_interpreter::ptr +dbg::create_command_interpreter(std::istream &in, std::ostream &out) +{ + return command_interpreter::ptr(new command_interpreter_impl(in, out)); +} + +//---------------------------------------------------------------- diff --git a/base/command_interpreter.h b/base/command_interpreter.h index 0b4abca..b0646d9 100644 --- a/base/command_interpreter.h +++ b/base/command_interpreter.h @@ -26,33 +26,13 @@ namespace dbg { public: typedef std::shared_ptr ptr; - command_interpreter(std::istream &in, std::ostream &out) - : in_(in), - out_(out), - exit_(false) { - } - - void register_command(std::string const &str, command::ptr cmd) { - commands_.insert(make_pair(str, cmd)); - } - - void enter_main_loop() { - while (!exit_) - do_once(); - } - - void exit_main_loop() { - exit_ = true; - } - - private: - void do_once(); - - std::istream &in_; - std::ostream &out_; - std::map commands_; - bool exit_; + virtual void register_command(std::string const &str, command::ptr cmd) = 0; + virtual void enter_main_loop() = 0; + virtual void exit_main_loop() = 0; }; + + command_interpreter::ptr + create_command_interpreter(std::istream &in, std::ostream &out); } //---------------------------------------------------------------- diff --git a/base/output_formatter.cc b/base/output_formatter.cc index 54ef578..c62058f 100644 --- a/base/output_formatter.cc +++ b/base/output_formatter.cc @@ -8,6 +8,31 @@ using namespace std; //---------------------------------------------------------------- namespace { + class abstract_formatter : public formatter { + typedef boost::optional maybe_string; + + void field(std::string const &name, std::string const &value) { + fields_.push_back(field_type(name, value)); + } + + void child(std::string const &name, formatter::ptr t) { + children_.push_back(field_type(name, t)); + } + + protected: + typedef boost::variant value; + typedef boost::tuple field_type; + + std::vector fields_; + std::vector children_; + }; + + class xml_formatter : public abstract_formatter { + public: + void output(std::ostream &out, int depth = 0, + boost::optional name = boost::none); + }; + void indent(int depth, std::ostream &out) { for (int i = 0; i < depth * 2; i++) out << ' '; @@ -51,3 +76,11 @@ void xml_formatter::output(std::ostream &out, } //---------------------------------------------------------------- + +formatter::ptr +dbg::create_xml_formatter() +{ + return formatter::ptr(new xml_formatter()); +} + +//---------------------------------------------------------------- diff --git a/base/output_formatter.h b/base/output_formatter.h index 2299f9d..2cc4bc5 100644 --- a/base/output_formatter.h +++ b/base/output_formatter.h @@ -17,26 +17,10 @@ namespace dbg { typedef std::shared_ptr ptr; virtual ~formatter() {} - - typedef boost::optional maybe_string; - - void field(std::string const &name, std::string const &value) { - fields_.push_back(field_type(name, value)); - } - - void child(std::string const &name, formatter::ptr t) { - children_.push_back(field_type(name, t)); - } - + virtual void field(std::string const &name, std::string const &value) = 0; + virtual void child(std::string const &name, formatter::ptr t) = 0; virtual void output(std::ostream &out, int depth = 0, boost::optional name = boost::none) = 0; - - protected: - typedef boost::variant value; - typedef boost::tuple field_type; - - std::vector fields_; - std::vector children_; }; template @@ -45,13 +29,7 @@ namespace dbg { t.field(name, boost::lexical_cast(value)); } - //-------------------------------- - - class xml_formatter : public formatter { - public: - virtual void output(std::ostream &out, int depth = 0, - boost::optional name = boost::none); - }; + formatter::ptr create_xml_formatter(); } //---------------------------------------------------------------- diff --git a/thin-provisioning/thin_debug.cc b/thin-provisioning/thin_debug.cc index a48b79f..e458d7d 100644 --- a/thin-provisioning/thin_debug.cc +++ b/thin-provisioning/thin_debug.cc @@ -60,26 +60,26 @@ namespace { class exit_handler : public dbg::command { public: - exit_handler(command_interpreter &interpreter) + exit_handler(command_interpreter::ptr interpreter) : interpreter_(interpreter) { } virtual void exec(strings const &args, ostream &out) { out << "Goodbye!" << endl; - interpreter_.exit_main_loop(); + interpreter_->exit_main_loop(); } - command_interpreter &interpreter_; + command_interpreter::ptr interpreter_; }; class sm_root_show_traits : public persistent_data::sm_disk_detail::sm_root_traits { public: - static void show(formatter &f, string const &key, + static void show(formatter::ptr f, string const &key, persistent_data::sm_disk_detail::sm_root const &value) { - field(f, "nr_blocks", value.nr_blocks_); - field(f, "nr_allocated", value.nr_allocated_); - field(f, "bitmap_root", value.bitmap_root_); - field(f, "ref_count_root", value.ref_count_root_); + field(*f, "nr_blocks", value.nr_blocks_); + field(*f, "nr_allocated", value.nr_allocated_); + field(*f, "bitmap_root", value.bitmap_root_); + field(*f, "ref_count_root", value.ref_count_root_); } }; @@ -90,47 +90,47 @@ namespace { } virtual void exec(strings const &args, ostream &out) { - xml_formatter f; + formatter::ptr f = create_xml_formatter(); thin_provisioning::superblock_detail::superblock const &sb = md_->sb_; - field(f, "csum", sb.csum_); - field(f, "flags", sb.flags_); - field(f, "blocknr", sb.blocknr_); - field(f, "uuid", sb.uuid_); // FIXME: delimit, and handle non-printable chars - field(f, "magic", sb.magic_); - field(f, "version", sb.version_); - field(f, "time", sb.time_); - field(f, "trans_id", sb.trans_id_); - field(f, "metadata_snap", sb.metadata_snap_); + field(*f, "csum", sb.csum_); + field(*f, "flags", sb.flags_); + field(*f, "blocknr", sb.blocknr_); + field(*f, "uuid", sb.uuid_); // FIXME: delimit, and handle non-printable chars + field(*f, "magic", sb.magic_); + field(*f, "version", sb.version_); + field(*f, "time", sb.time_); + field(*f, "trans_id", sb.trans_id_); + field(*f, "metadata_snap", sb.metadata_snap_); sm_disk_detail::sm_root_disk const *d; sm_disk_detail::sm_root v; { d = reinterpret_cast(sb.metadata_space_map_root_); sm_disk_detail::sm_root_traits::unpack(*d, v); - formatter::ptr f2(new xml_formatter); - sm_root_show_traits::show(*f2, "value", v); - f.child("metadata_space_map_root", f2); + formatter::ptr f2 = create_xml_formatter(); + sm_root_show_traits::show(f2, "value", v); + f->child("metadata_space_map_root", f2); } { d = reinterpret_cast(sb.data_space_map_root_); sm_disk_detail::sm_root_traits::unpack(*d, v); - formatter::ptr f2(new xml_formatter); - sm_root_show_traits::show(*f2, "value", v); - f.child("data_space_map_root", f2); + formatter::ptr f2 = create_xml_formatter(); + sm_root_show_traits::show(f2, "value", v); + f->child("data_space_map_root", f2); } - field(f, "data_mapping_root", sb.data_mapping_root_); - field(f, "device_details_root", sb.device_details_root_); - field(f, "data_block_size", sb.data_block_size_); - field(f, "metadata_block_size", sb.metadata_block_size_); - field(f, "metadata_nr_blocks", sb.metadata_nr_blocks_); - field(f, "compat_flags", sb.compat_flags_); - field(f, "compat_ro_flags", sb.compat_ro_flags_); - field(f, "incompat_flags", sb.incompat_flags_); + field(*f, "data_mapping_root", sb.data_mapping_root_); + field(*f, "device_details_root", sb.device_details_root_); + field(*f, "data_block_size", sb.data_block_size_); + field(*f, "metadata_block_size", sb.metadata_block_size_); + field(*f, "metadata_nr_blocks", sb.metadata_nr_blocks_); + field(*f, "compat_flags", sb.compat_flags_); + field(*f, "compat_ro_flags", sb.compat_ro_flags_); + field(*f, "incompat_flags", sb.incompat_flags_); - f.output(out, 0); + f->output(out, 0); } private: @@ -141,12 +141,12 @@ namespace { public: typedef thin_provisioning::device_tree_detail::device_details_traits value_trait; - static void show(formatter &f, string const &key, + static void show(formatter::ptr f, string const &key, thin_provisioning::device_tree_detail::device_details const &value) { - field(f, "mapped_blocks", value.mapped_blocks_); - field(f, "transaction_id", value.transaction_id_); - field(f, "creation_time", value.creation_time_); - field(f, "snap_time", value.snapshotted_time_); + field(*f, "mapped_blocks", value.mapped_blocks_); + field(*f, "transaction_id", value.transaction_id_); + field(*f, "creation_time", value.creation_time_); + field(*f, "snap_time", value.snapshotted_time_); } }; @@ -154,8 +154,8 @@ namespace { public: typedef uint64_traits value_trait; - static void show(formatter &f, string const &key, uint64_t const &value) { - field(f, key, boost::lexical_cast(value)); + static void show(formatter::ptr f, string const &key, uint64_t const &value) { + field(*f, key, boost::lexical_cast(value)); } }; @@ -163,10 +163,10 @@ namespace { public: typedef thin_provisioning::mapping_tree_detail::block_traits value_trait; - static void show(formatter &f, string const &key, + static void show(formatter::ptr f, string const &key, thin_provisioning::mapping_tree_detail::block_time const &value) { - field(f, "block", value.block_); - field(f, "time", value.time_); + field(*f, "block", value.block_); + field(*f, "time", value.time_); } }; @@ -174,11 +174,11 @@ namespace { public: typedef persistent_data::sm_disk_detail::index_entry_traits value_trait; - static void show(formatter &f, string const &key, + static void show(formatter::ptr f, string const &key, persistent_data::sm_disk_detail::index_entry const &value) { - field(f, "blocknr", value.blocknr_); - field(f, "nr_free", value.nr_free_); - field(f, "none_free_before", value.none_free_before_); + field(*f, "blocknr", value.blocknr_); + field(*f, "nr_free", value.nr_free_); + field(*f, "none_free_before", value.none_free_before_); } }; @@ -210,23 +210,23 @@ namespace { private: template void show_node(node_ref n, ostream &out) { - xml_formatter f; + formatter::ptr f = create_xml_formatter(); - field(f, "csum", n.get_checksum()); - field(f, "blocknr", n.get_block_nr()); - field(f, "type", n.get_type() == INTERNAL ? "internal" : "leaf"); - field(f, "nr_entries", n.get_nr_entries()); - field(f, "max_entries", n.get_max_entries()); - field(f, "value_size", n.get_value_size()); + field(*f, "csum", n.get_checksum()); + field(*f, "blocknr", n.get_block_nr()); + field(*f, "type", n.get_type() == INTERNAL ? "internal" : "leaf"); + field(*f, "nr_entries", n.get_nr_entries()); + field(*f, "max_entries", n.get_max_entries()); + field(*f, "value_size", n.get_value_size()); for (unsigned i = 0; i < n.get_nr_entries(); i++) { - formatter::ptr f2(new xml_formatter); + formatter::ptr f2 = create_xml_formatter(); field(*f2, "key", n.key_at(i)); - ST::show(*f2, "value", n.value_at(i)); - f.child(boost::lexical_cast(i), f2); + ST::show(f2, "value", n.value_at(i)); + f->child(boost::lexical_cast(i), f2); } - f.output(out, 0); + f->output(out, 0); } metadata::ptr md_; @@ -259,19 +259,19 @@ namespace { private: void show_metadata_index(sm_disk_detail::metadata_index const *mdi, block_address nr_indexes, ostream &out) { - xml_formatter f; - field(f, "csum", to_cpu(mdi->csum_)); - field(f, "padding", to_cpu(mdi->padding_)); - field(f, "blocknr", to_cpu(mdi->blocknr_)); + formatter::ptr f = create_xml_formatter(); + field(*f, "csum", to_cpu(mdi->csum_)); + field(*f, "padding", to_cpu(mdi->padding_)); + field(*f, "blocknr", to_cpu(mdi->blocknr_)); sm_disk_detail::index_entry ie; for (block_address i = 0; i < nr_indexes; i++) { sm_disk_detail::index_entry_traits::unpack(*(mdi->index + i), ie); - formatter::ptr f2(new xml_formatter); - index_entry_show_traits::show(*f2, "value", ie); - f.child(boost::lexical_cast(i), f2); + formatter::ptr f2 = create_xml_formatter(); + index_entry_show_traits::show(f2, "value", ie); + f->child(boost::lexical_cast(i), f2); } - f.output(out, 0); + f->output(out, 0); } unsigned const ENTRIES_PER_BLOCK = (MD_BLOCK_SIZE - sizeof(persistent_data::sm_disk_detail::bitmap_header)) * 4; @@ -286,17 +286,17 @@ namespace { try { block_manager::ptr bm = open_bm(path, block_manager::READ_ONLY, 1); metadata::ptr md(new metadata(bm, false)); - command_interpreter interp(cin, cout); - interp.register_command("hello", command::ptr(new hello)); - interp.register_command("superblock", command::ptr(new show_superblock(md))); - interp.register_command("m1_node", command::ptr(new show_btree_node(md))); - interp.register_command("m2_node", command::ptr(new show_btree_node(md))); - interp.register_command("detail_node", command::ptr(new show_btree_node(md))); - interp.register_command("index_block", command::ptr(new show_index_block(md))); - interp.register_command("index_node", command::ptr(new show_btree_node(md))); - interp.register_command("help", command::ptr(new help)); - interp.register_command("exit", command::ptr(new exit_handler(interp))); - interp.enter_main_loop(); + command_interpreter::ptr interp = create_command_interpreter(cin, cout); + interp->register_command("hello", command::ptr(new hello)); + interp->register_command("superblock", command::ptr(new show_superblock(md))); + interp->register_command("m1_node", command::ptr(new show_btree_node(md))); + interp->register_command("m2_node", command::ptr(new show_btree_node(md))); + interp->register_command("detail_node", command::ptr(new show_btree_node(md))); + interp->register_command("index_block", command::ptr(new show_index_block(md))); + interp->register_command("index_node", command::ptr(new show_btree_node(md))); + interp->register_command("help", command::ptr(new help)); + interp->register_command("exit", command::ptr(new exit_handler(interp))); + interp->enter_main_loop(); } catch (std::exception &e) { cerr << e.what() << endl; From 08bd2f47bdba9f40b8115afb5250bd46743922c2 Mon Sep 17 00:00:00 2001 From: Ming-Hung Tsai Date: Thu, 3 Dec 2020 20:50:01 +0800 Subject: [PATCH 11/11] [cache_debug] Fork thin_debug into cache_debug --- Makefile.in | 1 + caching/cache_debug.cc | 331 ++++++++++++++++++++++++++++++++++++++ caching/commands.h | 12 ++ caching/devel_commands.cc | 1 + 4 files changed, 345 insertions(+) create mode 100644 caching/cache_debug.cc diff --git a/Makefile.in b/Makefile.in index ae7ebcd..949e30a 100644 --- a/Makefile.in +++ b/Makefile.in @@ -128,6 +128,7 @@ TOOLS_SOURCE=\ DEVTOOLS_SOURCE=\ base/command_interpreter.cc \ base/output_formatter.cc \ + caching/cache_debug.cc \ caching/devel_commands.cc \ era/devel_commands.cc \ thin-provisioning/damage_generator.cc \ diff --git a/caching/cache_debug.cc b/caching/cache_debug.cc new file mode 100644 index 0000000..1053560 --- /dev/null +++ b/caching/cache_debug.cc @@ -0,0 +1,331 @@ +// Copyright (C) 2012 Red Hat, Inc. All rights reserved. +// +// This file is part of the thin-provisioning-tools source. +// +// thin-provisioning-tools is free software: you can redistribute it +// and/or modify it under the terms of the GNU General Public License +// as published by the Free Software Foundation, either version 3 of +// the License, or (at your option) any later version. +// +// thin-provisioning-tools is distributed in the hope that it will be +// useful, but WITHOUT ANY WARRANTY; without even the implied warranty +// of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License along +// with thin-provisioning-tools. If not, see +// . + +#include +#include +#include +#include + +#include "base/command_interpreter.h" +#include "base/output_formatter.h" +#include "persistent-data/file_utils.h" +#include "persistent-data/data-structures/btree.h" +#include "persistent-data/data-structures/simple_traits.h" +#include "persistent-data/space-maps/disk_structures.h" +#include "caching/commands.h" +#include "caching/metadata.h" +#include "version.h" + +using namespace dbg; +using namespace persistent_data; +using namespace std; +using namespace caching; + +//---------------------------------------------------------------- + +namespace { + class hello : public dbg::command { + virtual void exec(strings const &args, ostream &out) { + out << "Hello, world!" << endl; + } + }; + + class help : public dbg::command { + virtual void exec(strings const &args, ostream &out) { + out << "Commands:" << endl + << " superblock" << endl + << " mapping_node " << endl + << " mapping_array " << endl + << " exit" << endl; + } + }; + + class exit_handler : public dbg::command { + public: + exit_handler(command_interpreter::ptr interpreter) + : interpreter_(interpreter) { + } + + virtual void exec(strings const &args, ostream &out) { + out << "Goodbye!" << endl; + interpreter_->exit_main_loop(); + } + + command_interpreter::ptr interpreter_; + }; + + class sm_root_show_traits : public persistent_data::sm_disk_detail::sm_root_traits { + public: + static void show(formatter::ptr f, string const &key, + persistent_data::sm_disk_detail::sm_root const &value) { + field(*f, "nr_blocks", value.nr_blocks_); + field(*f, "nr_allocated", value.nr_allocated_); + field(*f, "bitmap_root", value.bitmap_root_); + field(*f, "ref_count_root", value.ref_count_root_); + } + }; + + class show_superblock : public dbg::command { + public: + explicit show_superblock(metadata::ptr md) + : md_(md) { + } + + virtual void exec(strings const &args, ostream &out) { + formatter::ptr f = create_xml_formatter(); + ostringstream version; + + superblock const &sb = md_->sb_; + + field(*f, "csum", sb.csum); + field(*f, "flags", sb.flags.encode()); + field(*f, "blocknr", sb.blocknr); + field(*f, "uuid", sb.uuid); // FIXME: delimit, and handle non-printable chars + field(*f, "magic", sb.magic); + field(*f, "version", sb.version); + field(*f, "policy_name", reinterpret_cast(sb.policy_name)); + version << sb.policy_version[0] << "." + << sb.policy_version[1] << "." + << sb.policy_version[2]; + field(*f, "policy_version", version.str().c_str()); + field(*f, "policy_hint_size", sb.policy_hint_size); + + sm_disk_detail::sm_root_disk const *d; + sm_disk_detail::sm_root v; + { + d = reinterpret_cast(sb.metadata_space_map_root); + sm_disk_detail::sm_root_traits::unpack(*d, v); + formatter::ptr f2 = create_xml_formatter(); + sm_root_show_traits::show(f2, "value", v); + f->child("metadata_space_map_root", f2); + } + + field(*f, "mapping_root", sb.mapping_root); + if (sb.version >= 2) + field(*f, "dirty_root", *sb.dirty_root); + field(*f, "hint_root", sb.hint_root); + field(*f, "discard_root", sb.discard_root); + field(*f, "discard_block_size", sb.discard_block_size); + field(*f, "discard_nr_blocks", sb.discard_nr_blocks); + field(*f, "data_block_size", sb.data_block_size); + field(*f, "metadata_block_size", sb.metadata_block_size); + field(*f, "cache_blocks", sb.cache_blocks); + field(*f, "compat_flags", sb.compat_flags); + field(*f, "compat_ro_flags", sb.compat_ro_flags); + field(*f, "incompat_flags", sb.incompat_flags); + field(*f, "read_hits", sb.read_hits); + field(*f, "read_misses", sb.read_misses); + field(*f, "write_hits", sb.write_hits); + field(*f, "write_misses", sb.write_misses); + + f->output(out, 0); + } + + private: + metadata::ptr md_; + }; + + class uint64_show_traits : public uint64_traits { + public: + static void show(formatter::ptr f, string const &key, uint64_t const &value) { + field(*f, key, boost::lexical_cast(value)); + } + }; + + // FIXME: Expose the array ValueTraits parameter or not? + // Since the block_traits isn't related to the ValueTraits. + class block_show_traits : public persistent_data::array::block_traits { + public: + static void show(formatter::ptr f, string const &key, block_address const &value) { + field(*f, "block", value); + } + }; + + class mapping_show_traits : public caching::mapping_traits { + public: + static void show(formatter::ptr f, string const &key, caching::mapping const &value) { + field(*f, "oblock", value.oblock_); + field(*f, "flags", value.flags_); + } + }; + + template + class show_btree_node : public dbg::command { + public: + explicit show_btree_node(metadata::ptr md) + : md_(md) { + } + + virtual void exec(strings const &args, ostream &out) { + using namespace persistent_data::btree_detail; + + if (args.size() != 2) + throw runtime_error("incorrect number of arguments"); + + block_address block = boost::lexical_cast(args[1]); + block_manager::read_ref rr = md_->tm_->read_lock(block); + + node_ref n = btree_detail::to_node(rr); + if (n.get_type() == INTERNAL) + show_node(n, out); + else { + node_ref n = btree_detail::to_node(rr); + show_node(n, out); + } + } + + private: + template + void show_node(node_ref n, ostream &out) { + formatter::ptr f = create_xml_formatter(); + + field(*f, "csum", n.get_checksum()); + field(*f, "blocknr", n.get_location()); + field(*f, "type", n.get_type() == INTERNAL ? "internal" : "leaf"); + field(*f, "nr_entries", n.get_nr_entries()); + field(*f, "max_entries", n.get_max_entries()); + field(*f, "value_size", n.get_value_size()); + + for (unsigned i = 0; i < n.get_nr_entries(); i++) { + formatter::ptr f2 = create_xml_formatter(); + field(*f2, "key", n.key_at(i)); + VT::show(f2, "value", n.value_at(i)); + f->child("child", f2); + } + + f->output(out, 0); + } + + metadata::ptr md_; + }; + + template + class show_array_block : public dbg::command { + typedef array_block rblock; + public: + explicit show_array_block(metadata::ptr md) + : md_(md) { + } + + virtual void exec(strings const& args, ostream &out) { + if (args.size() != 2) + throw runtime_error("incorrect number of arguments"); + + block_address block = boost::lexical_cast(args[1]); + block_manager::read_ref rr = md_->tm_->read_lock(block); + + rblock b(rr, typename ValueTraits::ref_counter()); + show_array_entries(b, out); + } + + private: + void show_array_entries(rblock const& b, ostream &out) { + formatter::ptr f = create_xml_formatter(); + uint32_t nr_entries = b.nr_entries(); + + field(*f, "max_entries", b.max_entries()); + field(*f, "nr_entries", nr_entries); + field(*f, "value_size", b.value_size()); + + for (unsigned i = 0; i < nr_entries; i++) { + formatter::ptr f2 = create_xml_formatter(); + field(*f2, "index", i); + ValueTraits::show(f2, "value", b.get(i)); + f->child("child", f2); + } + + f->output(out, 0); + } + + metadata::ptr md_; + }; + + //-------------------------------- + + int debug(string const &path) { + using dbg::command; + + try { + block_manager::ptr bm = open_bm(path, block_manager::READ_ONLY); + metadata::ptr md(new metadata(bm)); + command_interpreter::ptr interp = create_command_interpreter(cin, cout); + interp->register_command("hello", command::ptr(new hello)); + interp->register_command("superblock", command::ptr(new show_superblock(md))); + interp->register_command("mapping_node", command::ptr(new show_btree_node(md))); + interp->register_command("mapping_array", command::ptr(new show_array_block(md))); + interp->register_command("help", command::ptr(new help)); + interp->register_command("exit", command::ptr(new exit_handler(interp))); + interp->enter_main_loop(); + + } catch (std::exception &e) { + cerr << e.what(); + return 1; + } + + return 0; + } +} + +//---------------------------------------------------------------- + +cache_debug_cmd::cache_debug_cmd() + : command("cache_debug") +{ +} + +void +cache_debug_cmd::usage(std::ostream &out) const +{ + out << "Usage: " << get_name() << " {device|file}" << endl + << "Options:" << endl + << " {-h|--help}" << endl + << " {-V|--version}" << endl; +} + +int +cache_debug_cmd::run(int argc, char **argv) +{ + int c; + const char shortopts[] = "hV"; + const struct option longopts[] = { + { "help", no_argument, NULL, 'h'}, + { "version", no_argument, NULL, 'V'}, + { NULL, no_argument, NULL, 0 } + }; + + while ((c = getopt_long(argc, argv, shortopts, longopts, NULL)) != -1) { + switch(c) { + case 'h': + usage(cout); + return 0; + + case 'V': + cerr << THIN_PROVISIONING_TOOLS_VERSION << endl; + return 0; + } + } + + if (argc == optind) { + usage(cerr); + exit(1); + } + + return debug(argv[optind]); +} + +//---------------------------------------------------------------- diff --git a/caching/commands.h b/caching/commands.h index b0546ab..04deac9 100644 --- a/caching/commands.h +++ b/caching/commands.h @@ -70,6 +70,18 @@ namespace caching { virtual int run(int argc, char **argv); }; + //------------------------------------------------------ + + class cache_debug_cmd : public base::command { + public: + cache_debug_cmd(); + + virtual void usage(std::ostream &out) const; + virtual int run(int argc, char **argv); + }; + + //------------------------------------------------------ + void register_cache_commands(base::application &app); } diff --git a/caching/devel_commands.cc b/caching/devel_commands.cc index 21a1188..c63a68d 100644 --- a/caching/devel_commands.cc +++ b/caching/devel_commands.cc @@ -8,6 +8,7 @@ using namespace caching; void caching::register_cache_commands(application &app) { + app.add_cmd(command::ptr(new cache_debug_cmd)); } //----------------------------------------------------------------