bdev: add delete_null_bdev call

Since delete_bdev should be used only for debug purpose,
this patch adds delete call specific for null bdev.

Changes in spdkcli done accordingly.

Signed-off-by: Maciej Szwed <maciej.szwed@intel.com>
Change-Id: I576322257e5cf70ec03d6b20f8ba43bfce222907
Reviewed-on: https://review.gerrithub.io/416505
Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com>
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com>

lib/bdev/null/bdev_null.c

@@ -214,6 +214,17 @@ create_null_bdev(const char *name, const struct spdk_uuid *uuid,
 	return &bdev->bdev;
 }
 
+void
+delete_null_bdev(struct spdk_bdev *bdev, spdk_delete_null_complete cb_fn, void *cb_arg)
+{
+	if (!bdev || bdev->module != &null_if) {
+		cb_fn(cb_arg, -ENODEV);
+		return;
+	}
+
+	spdk_bdev_unregister(bdev, cb_fn, cb_arg);
+}
+
 static int
 null_io_poll(void *arg)
 {

lib/bdev/null/bdev_null.h

@@ -36,10 +36,22 @@
 
 #include "spdk/stdinc.h"
 
+typedef void (*spdk_delete_null_complete)(void *cb_arg, int bdeverrno);
+
 struct spdk_bdev;
 struct spdk_uuid;
 
 struct spdk_bdev *create_null_bdev(const char *name, const struct spdk_uuid *uuid,
 				   uint64_t num_blocks, uint32_t block_size);
 
+/**
+ * Delete null bdev.
+ *
+ * \param bdev Pointer to null bdev.
+ * \param cb_fn Function to call after deletion.
+ * \param cb_arg Argument to pass to cb_fn.
+ */
+void delete_null_bdev(struct spdk_bdev *bdev, spdk_delete_null_complete cb_fn,
+		      void *cb_arg);
+
 #endif /* SPDK_BDEV_NULL_H */

lib/bdev/null/bdev_null_rpc.c

@@ -33,7 +33,7 @@
 
 #include "spdk/rpc.h"
 #include "spdk/util.h"
-
+#include "spdk/string.h"
 #include "spdk/bdev_module.h"
 #include "spdk_internal/log.h"
 
@@ -105,3 +105,65 @@ invalid:
 	free_rpc_construct_null(&req);
 }
 SPDK_RPC_REGISTER("construct_null_bdev", spdk_rpc_construct_null_bdev, SPDK_RPC_RUNTIME)
+
+struct rpc_delete_null {
+	char *name;
+};
+
+static void
+free_rpc_delete_null(struct rpc_delete_null *req)
+{
+	free(req->name);
+}
+
+static const struct spdk_json_object_decoder rpc_delete_null_decoders[] = {
+	{"name", offsetof(struct rpc_delete_null, name), spdk_json_decode_string},
+};
+
+static void
+_spdk_rpc_delete_null_bdev_cb(void *cb_arg, int bdeverrno)
+{
+	struct spdk_jsonrpc_request *request = cb_arg;
+	struct spdk_json_write_ctx *w;
+
+	w = spdk_jsonrpc_begin_result(request);
+	if (w == NULL) {
+		return;
+	}
+
+	spdk_json_write_bool(w, bdeverrno == 0);
+	spdk_jsonrpc_end_result(request, w);
+}
+
+static void
+spdk_rpc_delete_null_bdev(struct spdk_jsonrpc_request *request,
+			  const struct spdk_json_val *params)
+{
+	struct rpc_delete_null req = {NULL};
+	struct spdk_bdev *bdev;
+	int rc;
+
+	if (spdk_json_decode_object(params, rpc_delete_null_decoders,
+				    SPDK_COUNTOF(rpc_delete_null_decoders),
+				    &req)) {
+		rc = -EINVAL;
+		goto invalid;
+	}
+
+	bdev = spdk_bdev_get_by_name(req.name);
+	if (bdev == NULL) {
+		rc = -ENODEV;
+		goto invalid;
+	}
+
+	delete_null_bdev(bdev, _spdk_rpc_delete_null_bdev_cb, request);
+
+	free_rpc_delete_null(&req);
+
+	return;
+
+invalid:
+	free_rpc_delete_null(&req);
+	spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, spdk_strerror(-rc));
+}
+SPDK_RPC_REGISTER("delete_null_bdev", spdk_rpc_delete_null_bdev, SPDK_RPC_RUNTIME)

scripts/rpc.py

@@ -178,6 +178,15 @@ if __name__ == "__main__":
     p.add_argument('block_size', help='Block size for this bdev', type=int)
     p.set_defaults(func=construct_null_bdev)
 
+    @call_cmd
+    def delete_null_bdev(args):
+        rpc.bdev.delete_null_bdev(args.client,
+                                  name=args.name)
+
+    p = subparsers.add_parser('delete_null_bdev', help='Delete a null bdev')
+    p.add_argument('name', help='null bdev name')
+    p.set_defaults(func=delete_null_bdev)
+
     @call_cmd
     def construct_aio_bdev(args):
         print(rpc.bdev.construct_aio_bdev(args.client,

scripts/rpc/bdev.py

@@ -64,6 +64,16 @@ def construct_null_bdev(client, num_blocks, block_size, name, uuid=None):
     return client.call('construct_null_bdev', params)
 
 
+def delete_null_bdev(client, name):
+    """Remove null bdev from the system.
+
+    Args:
+        name: name of null bdev to delete
+    """
+    params = {'name': name}
+    return client.call('delete_null_bdev', params)
+
+
 def construct_aio_bdev(client, filename, name, block_size=None):
     """Construct a Linux AIO block device.
 

scripts/spdkcli/ui_root.py

@@ -82,6 +82,9 @@ class UIRoot(UINode):
         response = rpc.bdev.construct_null_bdev(self.client, **kwargs)
         return response
 
+    def delete_null_bdev(self, **kwargs):
+        rpc.bdev.delete_null_bdev(self.client, **kwargs)
+
     def create_error_bdev(self, **kwargs):
         response = rpc.bdev.construct_error_bdev(self.client, **kwargs)
 

test/json_config/clear_config.py

@@ -50,7 +50,7 @@ def get_bdev_destroy_method(bdev):
                           'construct_pmem_bdev': "delete_bdev",
                           'construct_rbd_bdev': "delete_bdev",
                           'construct_malloc_bdev': "delete_malloc_bdev",
-                          'construct_null_bdev': "delete_bdev",
+                          'construct_null_bdev': "delete_null_bdev",
                           'construct_aio_bdev': "delete_aio_bdev",
                           'construct_error_bdev': "delete_error_bdev",
                           'construct_split_vbdev': "destruct_split_vbdev",

test/nvmf/discovery/discovery.sh

@@ -35,14 +35,14 @@ trap "killprocess $nvmfpid; exit 1" SIGINT SIGTERM EXIT
 waitforlisten $nvmfpid
 timing_exit start_nvmf_tgt
 
-bdevs="$bdevs $($rpc_py construct_null_bdev Null0 $NULL_BDEV_SIZE $NULL_BLOCK_SIZE)"
-bdevs="$bdevs $($rpc_py construct_null_bdev Null1 $NULL_BDEV_SIZE $NULL_BLOCK_SIZE)"
+null_bdevs="$($rpc_py construct_null_bdev Null0 $NULL_BDEV_SIZE $NULL_BLOCK_SIZE) "
+null_bdevs+="$($rpc_py construct_null_bdev Null1 $NULL_BDEV_SIZE $NULL_BLOCK_SIZE)"
 
 modprobe -v nvme-rdma
 
 $rpc_py construct_nvmf_subsystem nqn.2016-06.io.spdk:cnode1 "trtype:RDMA traddr:$NVMF_FIRST_TARGET_IP trsvcid:4420" "" -a -s SPDK00000000000001
-for bdev in $bdevs; do
-	$rpc_py nvmf_subsystem_add_ns nqn.2016-06.io.spdk:cnode1 $bdev
+for null_bdev in $null_bdevs; do
+	$rpc_py nvmf_subsystem_add_ns nqn.2016-06.io.spdk:cnode1 $null_bdev
 done
 
 nvme discover -t rdma -a $NVMF_FIRST_TARGET_IP -s $NVMF_PORT
@@ -52,8 +52,9 @@ $rpc_py get_nvmf_subsystems
 
 $rpc_py delete_nvmf_subsystem nqn.2016-06.io.spdk:cnode1
 
-$rpc_py delete_bdev Null1
-$rpc_py delete_bdev Null0
+for null_bdev in $null_bdevs; do
+	$rpc_py delete_null_bdev $null_bdev
+done
 
 check_bdevs=$($rpc_py get_bdevs | jq -r '.[].name')
 if [ -n "$check_bdevs" ]; then