summaryrefslogtreecommitdiffstats
path: root/src/tools/ceph-dencoder/ceph_dencoder.cc
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--src/tools/ceph-dencoder/ceph_dencoder.cc272
1 files changed, 272 insertions, 0 deletions
diff --git a/src/tools/ceph-dencoder/ceph_dencoder.cc b/src/tools/ceph-dencoder/ceph_dencoder.cc
new file mode 100644
index 000000000..42060f860
--- /dev/null
+++ b/src/tools/ceph-dencoder/ceph_dencoder.cc
@@ -0,0 +1,272 @@
+// -*- mode:C++; tab-width:8; c-basic-offset:2; indent-tabs-mode:t -*-
+// vim: ts=8 sw=2 smarttab
+/*
+ * Ceph - scalable distributed file system
+ *
+ * Copyright (C) 2015 Red Hat
+ *
+ * This is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License version 2.1, as published by the Free Software
+ * Foundation. See file COPYING.
+ *
+ */
+
+
+#include <errno.h>
+
+#if __has_include(<filesystem>)
+#include <filesystem>
+namespace fs = std::filesystem;
+#else
+#include <experimental/filesystem>
+namespace fs = std::experimental::filesystem;
+#endif
+
+#include "ceph_ver.h"
+#include "include/types.h"
+#include "common/Formatter.h"
+#include "common/ceph_argparse.h"
+#include "common/errno.h"
+#include "denc_plugin.h"
+#include "denc_registry.h"
+
+#define MB(m) ((m) * 1024 * 1024)
+
+void usage(ostream &out)
+{
+ out << "usage: ceph-dencoder [commands ...]" << std::endl;
+ out << "\n";
+ out << " version print version string (to stdout)\n";
+ out << "\n";
+ out << " import <encfile> read encoded data from encfile\n";
+ out << " export <outfile> write encoded data to outfile\n";
+ out << "\n";
+ out << " set_features <num> set feature bits used for encoding\n";
+ out << " get_features print feature bits (int) to stdout\n";
+ out << "\n";
+ out << " list_types list supported types\n";
+ out << " type <classname> select in-memory type\n";
+ out << " skip <num> skip <num> leading bytes before decoding\n";
+ out << " decode decode into in-memory object\n";
+ out << " encode encode in-memory object\n";
+ out << " dump_json dump in-memory object as json (to stdout)\n";
+ out << " hexdump print encoded data in hex\n";
+ out << " get_struct_v print version of the encoded object\n";
+ out << " get_struct_compat print the oldest version of decoder that can decode the encoded object\n";
+ out << "\n";
+ out << " copy copy object (via operator=)\n";
+ out << " copy_ctor copy object (via copy ctor)\n";
+ out << "\n";
+ out << " count_tests print number of generated test objects (to stdout)\n";
+ out << " select_test <n> select generated test object as in-memory object\n";
+ out << " is_deterministic exit w/ success if type encodes deterministically\n";
+}
+
+vector<DencoderPlugin> load_plugins()
+{
+ fs::path mod_dir{CEPH_DENC_MOD_DIR};
+ if (auto ceph_lib = getenv("CEPH_LIB"); ceph_lib) {
+ mod_dir = ceph_lib;
+ } else if (fs::is_regular_file("CMakeCache.txt")) {
+ mod_dir = fs::canonical("lib");
+ }
+ vector<DencoderPlugin> dencoder_plugins;
+ for (auto& entry : fs::directory_iterator(mod_dir)) {
+ static const string_view DENC_MOD_PREFIX = "denc-mod-";
+ if (entry.path().stem().string().compare(0, DENC_MOD_PREFIX.size(),
+ DENC_MOD_PREFIX) != 0) {
+ continue;
+ }
+ DencoderPlugin plugin(entry);
+ if (!plugin.good()) {
+ continue;
+ }
+ dencoder_plugins.push_back(std::move(plugin));
+ }
+ return dencoder_plugins;
+}
+
+int main(int argc, const char **argv)
+{
+ vector<DencoderPlugin> plugins = load_plugins();
+ DencoderRegistry registry;
+ for (auto& plugin : plugins) {
+ for (auto& [name, denc] : plugin.register_dencoders()) {
+ registry.register_dencoder(name, denc);
+ }
+ }
+
+ vector<const char*> args;
+ argv_to_vec(argc, argv, args);
+ env_to_vec(args);
+
+ Dencoder *den = NULL;
+ uint64_t features = CEPH_FEATURES_SUPPORTED_DEFAULT;
+ bufferlist encbl;
+ uint64_t skip = 0;
+
+ if (args.empty()) {
+ cerr << "-h for help" << std::endl;
+ return 1;
+ }
+ for (std::vector<const char*>::iterator i = args.begin(); i != args.end(); ++i) {
+ string err;
+
+ auto& dencoders = registry.get();
+ if (*i == string("help") || *i == string("-h") || *i == string("--help")) {
+ usage(cout);
+ return 0;
+ } else if (*i == string("version")) {
+ cout << CEPH_GIT_NICE_VER << std::endl;
+ } else if (*i == string("list_types")) {
+ for (auto& dencoder : dencoders)
+ cout << dencoder.first << std::endl;
+ return 0;
+ } else if (*i == string("type")) {
+ ++i;
+ if (i == args.end()) {
+ cerr << "expecting type" << std::endl;
+ return 1;
+ }
+ string cname = *i;
+ if (!dencoders.count(cname)) {
+ cerr << "class '" << cname << "' unknown" << std::endl;
+ return 1;
+ }
+ den = dencoders[cname];
+ den->generate();
+ } else if (*i == string("skip")) {
+ ++i;
+ if (i == args.end()) {
+ cerr << "expecting byte count" << std::endl;
+ return 1;
+ }
+ skip = atoi(*i);
+ } else if (*i == string("get_features")) {
+ cout << CEPH_FEATURES_SUPPORTED_DEFAULT << std::endl;
+ return 0;
+ } else if (*i == string("set_features")) {
+ ++i;
+ if (i == args.end()) {
+ cerr << "expecting features" << std::endl;
+ return 1;
+ }
+ features = atoll(*i);
+ } else if (*i == string("encode")) {
+ if (!den) {
+ cerr << "must first select type with 'type <name>'" << std::endl;
+ return 1;
+ }
+ den->encode(encbl, features | CEPH_FEATURE_RESERVED); // hack for OSDMap
+ } else if (*i == string("decode")) {
+ if (!den) {
+ cerr << "must first select type with 'type <name>'" << std::endl;
+ return 1;
+ }
+ err = den->decode(encbl, skip);
+ } else if (*i == string("copy_ctor")) {
+ if (!den) {
+ cerr << "must first select type with 'type <name>'" << std::endl;
+ return 1;
+ }
+ den->copy_ctor();
+ } else if (*i == string("copy")) {
+ if (!den) {
+ cerr << "must first select type with 'type <name>'" << std::endl;
+ return 1;
+ }
+ den->copy();
+ } else if (*i == string("dump_json")) {
+ if (!den) {
+ cerr << "must first select type with 'type <name>'" << std::endl;
+ return 1;
+ }
+ JSONFormatter jf(true);
+ jf.open_object_section("object");
+ den->dump(&jf);
+ jf.close_section();
+ jf.flush(cout);
+ cout << std::endl;
+
+ } else if (*i == string("hexdump")) {
+ encbl.hexdump(cout);
+ } else if (*i == string("get_struct_v")) {
+ std::cout << den->get_struct_v(encbl, 0) << std::endl;
+ } else if (*i == string("get_struct_compat")) {
+ std::cout << den->get_struct_v(encbl, sizeof(uint8_t)) << std::endl;
+ } else if (*i == string("import")) {
+ ++i;
+ if (i == args.end()) {
+ cerr << "expecting filename" << std::endl;
+ return 1;
+ }
+ int r;
+ if (*i == string("-")) {
+ *i = "stdin";
+ // Read up to 1mb if stdin specified
+ r = encbl.read_fd(STDIN_FILENO, MB(1));
+ } else {
+ r = encbl.read_file(*i, &err);
+ }
+ if (r < 0) {
+ cerr << "error reading " << *i << ": " << err << std::endl;
+ return 1;
+ }
+
+ } else if (*i == string("export")) {
+ ++i;
+ if (i == args.end()) {
+ cerr << "expecting filename" << std::endl;
+ return 1;
+ }
+ int fd = ::open(*i, O_WRONLY|O_CREAT|O_TRUNC|O_BINARY, 0644);
+ if (fd < 0) {
+ cerr << "error opening " << *i << " for write: " << cpp_strerror(errno) << std::endl;
+ return 1;
+ }
+ int r = encbl.write_fd(fd);
+ if (r < 0) {
+ cerr << "error writing " << *i << ": " << cpp_strerror(errno) << std::endl;
+ return 1;
+ }
+ ::close(fd);
+
+ } else if (*i == string("count_tests")) {
+ if (!den) {
+ cerr << "must first select type with 'type <name>'" << std::endl;
+ return 1;
+ }
+ cout << den->num_generated() << std::endl;
+ } else if (*i == string("select_test")) {
+ if (!den) {
+ cerr << "must first select type with 'type <name>'" << std::endl;
+ return 1;
+ }
+ ++i;
+ if (i == args.end()) {
+ cerr << "expecting instance number" << std::endl;
+ return 1;
+ }
+ int n = atoi(*i);
+ err = den->select_generated(n);
+ } else if (*i == string("is_deterministic")) {
+ if (!den) {
+ cerr << "must first select type with 'type <name>'" << std::endl;
+ return 1;
+ }
+ if (den->is_deterministic())
+ return 0;
+ else
+ return 1;
+ } else {
+ cerr << "unknown option '" << *i << "'" << std::endl;
+ return 1;
+ }
+ if (err.length()) {
+ cerr << "error: " << err << std::endl;
+ return 1;
+ }
+ }
+ return 0;
+}