Merge pull request #248 from igaw/tp8010-support-refactored

TP8010 support refactored

Author: dwsuse

doc/config-schema.json

@@ -25,6 +25,10 @@
 		    "description": "NVMe host ID",
 		    "type": "string"
 		},
+		"hostsymname": {
+		    "description": "NVMe host symbolic name",
+		    "type": "string"
+		},
 		"required": [ "hostnqn" ],
 		"subsystems": {
 		    "description": "Array of NVMe subsystem properties",

libnvme/nvme.i

@@ -6,7 +6,8 @@
  * Authors: Hannes Reinecke <[email protected]>
  */
 
-%module nvme
+%module(docstring="Python bindings for libnvme") nvme
+%feature("autodoc", "1");
 
 %include "exception.i"
 
@@ -280,8 +281,10 @@ struct nvme_root {
 struct nvme_host {
   %immutable hostnqn;
   %immutable hostid;
+  %immutable hostsymname;
   char *hostnqn;
   char *hostid;
+  char *hostsymname;
   char *dhchap_key;
 };
 
@@ -373,6 +376,9 @@ struct nvme_ns {
   void update_config() {
     nvme_update_config($self);
   }
+  void dump_config() {
+    nvme_dump_config($self);
+  }
 }
 
 %extend host_iter {
@@ -393,14 +399,28 @@ struct nvme_ns {
 
 %extend nvme_host {
   nvme_host(struct nvme_root *r, const char *hostnqn = NULL,
-	    const char *hostid = NULL) {
-    if (!hostnqn)
-      return nvme_default_host(r);
-    return nvme_lookup_host(r, hostnqn, hostid);
+	    const char *hostid = NULL, const char *hostsymname = NULL) {
+
+    nvme_host_t h = hostnqn ? nvme_lookup_host(r, hostnqn, hostid) : nvme_default_host(r);
+    if (hostsymname)
+        nvme_host_set_hostsymname(h, hostsymname);
+    return h;
   }
   ~nvme_host() {
     nvme_free_host($self);
   }
+%define SET_SYMNAME_DOCSTRING
+"@brief Set or Clear Host's Symbolic Name
+
+@param hostsymname: A symbolic name, or None to clear the symbolic name.
+@type hostsymname: str|None
+
+@return: None"
+%enddef
+  %feature("autodoc", SET_SYMNAME_DOCSTRING) set_symname;
+  void set_symname(const char *hostsymname) {
+    nvme_host_set_hostsymname($self, hostsymname);
+  }
   char *__str__() {
     static char tmp[2048];
 
@@ -555,6 +575,29 @@ struct nvme_ns {
     nvme_disconnect_ctrl($self);
   }
 
+  %feature("autodoc", "@return: True if controller supports explicit registration. False otherwise.") is_registration_supported;
+  bool is_registration_supported() {
+    return nvmf_is_registration_supported($self);
+  }
+
+  %feature("autodoc", "@return None on success or Error string on error.") registration_ctlr;
+  PyObject *registration_ctlr(enum nvmf_dim_tas tas) {
+    __u32 result;
+    int   status;
+
+    status = nvmf_register_ctrl($self, NVMF_DIM_TAS_REGISTER, &result);
+    if (status != NVME_SC_SUCCESS) {
+      /* On error, return an error message */
+      if (status < 0)
+        return PyUnicode_FromFormat("Status:0x%04x - %s", status, nvme_status_to_string(status, false));
+      else
+        return PyUnicode_FromFormat("Result:0x%04x, Status:0x%04x - %s", result, status, nvme_status_to_string(status, false));
+    }
+
+    /* On success, return None */
+    Py_RETURN_NONE;
+  }
+
   %newobject discover;
   struct nvmf_discovery_log *discover(int max_retries = 6) {
     struct nvmf_discovery_log *logp = NULL;

src/libnvme.map

@@ -42,6 +42,7 @@ LIBNVME_1_0 {
 		nvme_ctrls_filter;
 		nvme_default_host;
 		nvme_dev_self_test;
+		nvme_dim_send;
 		nvme_directive_recv;
 		nvme_directive_recv_identify_parameters;
 		nvme_directive_recv_stream_allocate;
@@ -144,8 +145,10 @@ LIBNVME_1_0 {
 		nvme_host_get_dhchap_key;
 		nvme_host_get_hostid;
 		nvme_host_get_hostnqn;
+		nvme_host_get_hostsymname;
 		nvme_host_get_root;
 		nvme_host_set_dhchap_key;
+		nvme_host_set_hostsymname;
 		nvme_identify;
 		nvme_identify_active_ns_list;
 		nvme_identify_allocated_ns;
@@ -322,8 +325,10 @@ LIBNVME_1_0 {
 		nvmf_hostid_from_file;
 		nvmf_hostnqn_from_file;
 		nvmf_hostnqn_generate;
+		nvmf_is_registration_supported;
 		nvmf_prtype_str;
 		nvmf_qptype_str;
+		nvmf_register_ctrl;
 		nvmf_sectype_str;
 		nvmf_subtype_str;
 		nvmf_treq_str;