xattr: add rpc_bdev_lvol_set_xattr

Longhorn 6604

Signed-off-by: Derek Su <derek.su@suse.com>

include/spdk/lvol.h

@@ -261,6 +261,19 @@ void
 spdk_lvol_rename(struct spdk_lvol *lvol, const char *new_name,
 		 spdk_lvol_op_complete cb_fn, void *cb_arg);
 
+/**
+ * Set lvol's xattr.
+ *
+ * \param lvol Handle to lvol.
+ * \param name xattr name.
+ * \param value xattr value.
+ * \param cb_fn Completion callback.
+ * \param cb_arg Completion callback custom arguments.
+ */
+void
+spdk_lvol_set_xattr(struct spdk_lvol *lvol, const char *name, const char *value,
+		    spdk_lvol_op_complete cb_fn, void *cb_arg);
+
 /**
  * \brief Returns if it is possible to delete an lvol (i.e. lvol is not a snapshot that have at least one clone).
  * \param lvol Handle to lvol

lib/lvol/lvol.c

@@ -1549,6 +1549,42 @@ spdk_lvol_rename(struct spdk_lvol *lvol, const char *new_name,
 	spdk_blob_sync_md(blob, lvol_rename_cb, req);
 }
 
+static void
+lvol_set_xattr_cb(void *cb_arg, int lvolerrno)
+{
+	struct spdk_lvol_req *req = cb_arg;
+
+	req->cb_fn(req->cb_arg,  lvolerrno);
+	free(req);
+}
+
+void
+spdk_lvol_set_xattr(struct spdk_lvol *lvol, const char *name, const char *value,
+		    spdk_lvol_op_complete cb_fn, void *cb_arg)
+{
+	struct spdk_blob *blob = lvol->blob;
+	struct spdk_lvol_req *req;
+	int rc;
+
+	req = calloc(1, sizeof(*req));
+	if (!req) {
+		SPDK_ERRLOG("Cannot alloc memory for lvol request pointer\n");
+		cb_fn(cb_arg, -ENOMEM);
+		return;
+	}
+	req->cb_fn = cb_fn;
+	req->cb_arg = cb_arg;
+
+	rc = spdk_blob_set_xattr(blob, name, value, strlen(value) + 1);
+	if (rc < 0) {
+		free(req);
+		cb_fn(cb_arg, rc);
+		return;
+	}
+
+	spdk_blob_sync_md(blob, lvol_set_xattr_cb, req);
+}
+
 void
 spdk_lvol_destroy(struct spdk_lvol *lvol, spdk_lvol_op_complete cb_fn, void *cb_arg)
 {

module/bdev/lvol/vbdev_lvol.c

@@ -1359,6 +1359,36 @@ vbdev_lvol_rename(struct spdk_lvol *lvol, const char *new_lvol_name,
 	spdk_lvol_rename(lvol, new_lvol_name, _vbdev_lvol_rename_cb, req);
 }
 
+static void
+_vbdev_lvol_set_xattr_cb(void *cb_arg, int lvolerrno)
+{
+	struct spdk_lvol_req *req = cb_arg;
+
+	if (lvolerrno != 0) {
+		SPDK_ERRLOG("Setting xattr failed\n");
+	}
+
+	req->cb_fn(req->cb_arg, lvolerrno);
+	free(req);
+}
+
+void
+vbdev_lvol_set_xattr(struct spdk_lvol *lvol, const char *name,
+		     const char *value, spdk_lvol_op_complete cb_fn, void *cb_arg)
+{
+	struct spdk_lvol_req *req;
+
+	req = calloc(1, sizeof(*req));
+	if (req == NULL) {
+		cb_fn(cb_arg, -ENOMEM);
+		return;
+	}
+	req->cb_fn = cb_fn;
+	req->cb_arg = cb_arg;
+
+	spdk_lvol_set_xattr(lvol, name, value, _vbdev_lvol_set_xattr_cb, req);
+}
+
 static void
 _vbdev_lvol_resize_cb(void *cb_arg, int lvolerrno)
 {

module/bdev/lvol/vbdev_lvol.h

@@ -69,6 +69,17 @@ void vbdev_lvol_set_read_only(struct spdk_lvol *lvol, spdk_lvol_op_complete cb_f
 void vbdev_lvol_rename(struct spdk_lvol *lvol, const char *new_lvol_name,
 		       spdk_lvol_op_complete cb_fn, void *cb_arg);
 
+/**
+ * \brief Set lvol's xattr
+ * \param lvol Handle to lvol
+ * \param name xattr name
+ * \param value xattr value
+ * \param cb_fn Completion callback
+ * \param cb_arg Completion callback custom arguments
+ */
+void vbdev_lvol_set_xattr(struct spdk_lvol *lvol, const char *name,
+			  const char *value, spdk_lvol_op_complete cb_fn, void *cb_arg);
+
 /**
  * Destroy a logical volume
  * \param lvol Handle to lvol

module/bdev/lvol/vbdev_lvol_rpc.c

@@ -701,6 +701,86 @@ cleanup:
 
 SPDK_RPC_REGISTER("bdev_lvol_rename", rpc_bdev_lvol_rename, SPDK_RPC_RUNTIME)
 
+
+struct rpc_bdev_lvol_set_xattr {
+	char *name;
+	char *xattr_name;
+	char *xattr_value;
+};
+
+static void
+free_rpc_bdev_lvol_set_xattr(struct rpc_bdev_lvol_set_xattr *req)
+{
+	free(req->name);
+	free(req->xattr_name);
+	free(req->xattr_value);
+}
+
+static const struct spdk_json_object_decoder rpc_bdev_lvol_set_xattr_decoders[] = {
+	{"name", offsetof(struct rpc_bdev_lvol_set_xattr, name), spdk_json_decode_string},
+	{"xattr_name", offsetof(struct rpc_bdev_lvol_set_xattr, xattr_name), spdk_json_decode_string},
+	{"xattr_value", offsetof(struct rpc_bdev_lvol_set_xattr, xattr_value), spdk_json_decode_string},
+};
+
+static void
+rpc_bdev_lvol_set_xattr_cb(void *cb_arg, int lvolerrno)
+{
+	struct spdk_jsonrpc_request *request = cb_arg;
+
+	if (lvolerrno != 0) {
+		goto invalid;
+	}
+
+	spdk_jsonrpc_send_bool_response(request, true);
+	return;
+
+invalid:
+	spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS,
+					 spdk_strerror(-lvolerrno));
+}
+
+static void
+rpc_bdev_lvol_set_xattr(struct spdk_jsonrpc_request *request,
+		     const struct spdk_json_val *params)
+{
+	struct rpc_bdev_lvol_set_xattr req = {};
+	struct spdk_bdev *bdev;
+	struct spdk_lvol *lvol;
+
+	SPDK_INFOLOG(lvol_rpc, "Setting lvol xattr\n");
+
+	if (spdk_json_decode_object(params, rpc_bdev_lvol_set_xattr_decoders,
+				    SPDK_COUNTOF(rpc_bdev_lvol_set_xattr_decoders),
+				    &req)) {
+		SPDK_INFOLOG(lvol_rpc, "spdk_json_decode_object failed\n");
+		spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
+						 "spdk_json_decode_object failed");
+		goto cleanup;
+	}
+
+	bdev = spdk_bdev_get_by_name(req.name);
+	if (bdev == NULL) {
+		SPDK_ERRLOG("bdev '%s' does not exist\n", req.name);
+		spdk_jsonrpc_send_error_response(request, -ENODEV, spdk_strerror(ENODEV));
+		goto cleanup;
+	}
+
+	lvol = vbdev_lvol_get_from_bdev(bdev);
+	if (lvol == NULL) {
+		SPDK_ERRLOG("lvol does not exist\n");
+		spdk_jsonrpc_send_error_response(request, -ENODEV, spdk_strerror(ENODEV));
+		goto cleanup;
+	}
+
+	vbdev_lvol_set_xattr(lvol, req.xattr_name, req.xattr_value, rpc_bdev_lvol_set_xattr_cb, request);
+
+cleanup:
+	free_rpc_bdev_lvol_set_xattr(&req);
+}
+
+SPDK_RPC_REGISTER("bdev_lvol_set_xattr", rpc_bdev_lvol_set_xattr, SPDK_RPC_RUNTIME)
+
+
 struct rpc_bdev_lvol_inflate {
 	char *name;
 };

python/spdk/rpc/lvol.py

@@ -161,6 +161,22 @@ def bdev_lvol_rename(client, old_name, new_name):
     return client.call('bdev_lvol_rename', params)
 
 
+def bdev_lvol_set_xattr(client, name, xattr_name, xattr_value):
+    """Set extended attribute on a logical volume.
+
+    Args:
+        name: name of logical volume
+        xattr_name: name of extended attribute
+        xattr_value: value of extended attribute
+    """
+    params = {
+        'name': name,
+        'xattr_name': xattr_name,
+        'xattr_value': xattr_value,
+    }
+    return client.call('bdev_lvol_set_xattr', params)
+
+
 def bdev_lvol_resize(client, name, size_in_mib):
     """Resize a logical volume.
 

scripts/rpc.py

@@ -1999,6 +1999,18 @@ Format: 'user:u1 secret:s1 muser:mu1 msecret:ms1,user:u2 secret:s2 muser:mu2 mse
     p.add_argument('new_name', help='new lvol name')
     p.set_defaults(func=bdev_lvol_rename)
 
+    def bdev_lvol_set_xattr(args):
+        rpc.lvol.bdev_lvol_set_xattr(args.client,
+                                     name=args.name,
+                                     xattr_name=args.xattr_name,
+                                     xattr_value=args.xattr_value)
+
+    p = subparsers.add_parser('bdev_lvol_set_xattr', help='Set xattr for lvol bdev')
+    p.add_argument('name', help='lvol bdev name')
+    p.add_argument('xattr_name', help='xattr name')
+    p.add_argument('xattr_value', help='xattr value')
+    p.set_defaults(func=bdev_lvol_set_xattr)
+
     def bdev_lvol_inflate(args):
         rpc.lvol.bdev_lvol_inflate(args.client,
                                    name=args.name)