initial code repo
[stor4nfv.git] / src / ceph / src / mgr / ActivePyModule.h
diff --git a/src/ceph/src/mgr/ActivePyModule.h b/src/ceph/src/mgr/ActivePyModule.h
new file mode 100644 (file)
index 0000000..0c2ee12
--- /dev/null
@@ -0,0 +1,98 @@
+
+// -*- 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) 2016 John Spray <john.spray@redhat.com>
+ *
+ * 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.
+ */
+
+
+#pragma once
+
+// Python.h comes first because otherwise it clobbers ceph's assert
+#include "Python.h"
+
+#include "common/cmdparse.h"
+#include "common/LogEntry.h"
+#include "common/Mutex.h"
+#include "common/Thread.h"
+#include "mon/health_check.h"
+#include "mgr/Gil.h"
+
+#include "PyModuleRunner.h"
+
+#include <vector>
+#include <string>
+
+
+class ActivePyModule;
+class ActivePyModules;
+
+/**
+ * A Ceph CLI command description provided from a Python module
+ */
+class ModuleCommand {
+public:
+  std::string cmdstring;
+  std::string helpstring;
+  std::string perm;
+  ActivePyModule *handler;
+};
+
+class ActivePyModule : public PyModuleRunner
+{
+private:
+  health_check_map_t health_checks;
+
+  std::vector<ModuleCommand> commands;
+
+  int load_commands();
+
+  // Optional, URI exposed by plugins that implement serve()
+  std::string uri;
+
+public:
+  ActivePyModule(const std::string &module_name_,
+      PyObject *pClass_,
+      const SafeThreadState &my_ts_)
+    : PyModuleRunner(module_name_, pClass_, my_ts_)
+  {}
+
+  int load(ActivePyModules *py_modules);
+  void notify(const std::string &notify_type, const std::string &notify_id);
+  void notify_clog(const LogEntry &le);
+
+  const std::vector<ModuleCommand> &get_commands() const
+  {
+    return commands;
+  }
+
+  int handle_command(
+    const cmdmap_t &cmdmap,
+    std::stringstream *ds,
+    std::stringstream *ss);
+
+  void set_health_checks(health_check_map_t&& c) {
+    health_checks = std::move(c);
+  }
+  void get_health_checks(health_check_map_t *checks);
+
+  void set_uri(const std::string &str)
+  {
+    uri = str;
+  }
+
+  std::string get_uri() const
+  {
+    return uri;
+  }
+};
+
+std::string handle_pyerror();
+