Commit 60563dfe authored by Pawel Kaminski's avatar Pawel Kaminski Committed by Jim Harris
Browse files

scripts/rpc: Rename rpc related to null bdev 



Rename construct_null_bdev to bdev_null_create
Rename delete_null_bdev to bdev_null_delete

Change-Id: I2390b14ac62130eaf20b2c43ebd30c763eca34de
Signed-off-by: default avatarPawel Kaminski <pawelx.kaminski@intel.com>
Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/465789


Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: default avatarJim Harris <james.r.harris@intel.com>
Reviewed-by: default avatarBroadcom SPDK FC-NVMe CI <spdk-ci.pdl@broadcom.com>
Reviewed-by: default avatarShuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
parent f60eeb6f

doc/bdev.md

+4 −4
Original line number Diff line number Diff line
@@ -377,17 +377,17 @@ application. 
The SPDK null bdev driver is a dummy block I/O target that discards all writes and returns undefined

data for reads.  It is useful for benchmarking the rest of the bdev I/O stack with minimal block

device overhead and for testing configurations that can't easily be created with the Malloc bdev.

To create Null bdev RPC command `construct_null_bdev` should be used.

To create Null bdev RPC command `bdev_null_create` should be used.



Example command



`rpc.py construct_null_bdev Null0 8589934592 4096`

`rpc.py bdev_null_create Null0 8589934592 4096`



This command will create an 8 petabyte `Null0` device with block size 4096.



To delete a null bdev use the delete_null_bdev command.

To delete a null bdev use the bdev_null_delete command.



`rpc.py delete_null_bdev Null0`

`rpc.py bdev_null_delete Null0`



# NVMe bdev {#bdev_config_nvme}

doc/jsonrpc.md

+5 −5
Original line number Diff line number Diff line
@@ -294,7 +294,7 @@ Example response: 
    "apply_nvme_firmware",

    "delete_nvme_controller",

    "construct_nvme_bdev",

    "construct_null_bdev",

    "bdev_null_create",

    "delete_malloc_bdev",

    "bdev_malloc_create",

    "delete_ftl_bdev",
@@ -1231,7 +1231,7 @@ Example response: 
}

~~~



## construct_null_bdev {#rpc_construct_null_bdev}

## bdev_null_create {#rpc_bdev_null_create}



Construct @ref bdev_config_null
@@ -1267,7 +1267,7 @@ Example request: 
    "dif_is_head_of_md": true

  },

  "jsonrpc": "2.0",

  "method": "construct_null_bdev",

  "method": "bdev_null_create",

  "id": 1

}

~~~
@@ -1282,7 +1282,7 @@ Example response: 
}

~~~



## delete_null_bdev {#rpc_delete_null_bdev}

## bdev_null_delete {#rpc_bdev_null_delete}



Delete @ref bdev_config_null.
@@ -1302,7 +1302,7 @@ Example request: 
    "name": "Null0"

  },

  "jsonrpc": "2.0",

  "method": "delete_null_bdev",

  "method": "bdev_null_delete",

  "id": 1

}

~~~

module/bdev/null/bdev_null.c

+4 −4
Original line number Diff line number Diff line
@@ -202,7 +202,7 @@ bdev_null_write_config_json(struct spdk_bdev *bdev, struct spdk_json_write_ctx * 


	spdk_json_write_object_begin(w);



	spdk_json_write_named_string(w, "method", "construct_null_bdev");

	spdk_json_write_named_string(w, "method", "bdev_null_create");



	spdk_json_write_named_object_begin(w, "params");

	spdk_json_write_named_string(w, "name", bdev->name);
@@ -227,7 +227,7 @@ static const struct spdk_bdev_fn_table null_fn_table = { 
};



int

create_null_bdev(struct spdk_bdev **bdev, const struct spdk_null_bdev_opts *opts)

bdev_null_create(struct spdk_bdev **bdev, const struct spdk_null_bdev_opts *opts)

{

	struct null_bdev *null_disk;

	uint32_t data_block_size;
@@ -323,7 +323,7 @@ create_null_bdev(struct spdk_bdev **bdev, const struct spdk_null_bdev_opts *opts 
}



void

delete_null_bdev(struct spdk_bdev *bdev, spdk_delete_null_complete cb_fn, void *cb_arg)

bdev_null_delete(struct spdk_bdev *bdev, spdk_delete_null_complete cb_fn, void *cb_arg)

{

	if (!bdev || bdev->module != &null_if) {

		cb_fn(cb_arg, -ENODEV);
@@ -480,7 +480,7 @@ bdev_null_initialize(void) 
		opts.md_interleave = true;

		opts.dif_type = dif_type;

		opts.dif_is_head_of_md = false;

		rc = create_null_bdev(&bdev, &opts);

		rc = bdev_null_create(&bdev, &opts);

		if (rc) {

			SPDK_ERRLOG("Could not create null bdev\n");

			goto end;

module/bdev/null/bdev_null.h

+2 −2
Original line number Diff line number Diff line
@@ -52,7 +52,7 @@ struct spdk_null_bdev_opts { 
	bool dif_is_head_of_md;

};



int create_null_bdev(struct spdk_bdev **bdev, const struct spdk_null_bdev_opts *opts);

int bdev_null_create(struct spdk_bdev **bdev, const struct spdk_null_bdev_opts *opts);



/**

 * Delete null bdev.
@@ -61,7 +61,7 @@ int create_null_bdev(struct spdk_bdev **bdev, const struct spdk_null_bdev_opts * 
 * \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 bdev_null_delete(struct spdk_bdev *bdev, spdk_delete_null_complete cb_fn,

		      void *cb_arg);



#endif /* SPDK_BDEV_NULL_H */

module/bdev/null/bdev_null_rpc.c

+10 −8
Original line number Diff line number Diff line
@@ -67,7 +67,7 @@ static const struct spdk_json_object_decoder rpc_construct_null_decoders[] = { 
};



static void

spdk_rpc_construct_null_bdev(struct spdk_jsonrpc_request *request,

spdk_rpc_bdev_null_create(struct spdk_jsonrpc_request *request,

			  const struct spdk_json_val *params)

{

	struct rpc_construct_null req = {};
@@ -128,7 +128,7 @@ spdk_rpc_construct_null_bdev(struct spdk_jsonrpc_request *request, 
	opts.md_interleave = true;

	opts.dif_type = req.dif_type;

	opts.dif_is_head_of_md = req.dif_is_head_of_md;

	rc = create_null_bdev(&bdev, &opts);

	rc = bdev_null_create(&bdev, &opts);

	if (rc) {

		spdk_jsonrpc_send_error_response(request, rc, spdk_strerror(-rc));

		goto cleanup;
@@ -143,7 +143,8 @@ spdk_rpc_construct_null_bdev(struct spdk_jsonrpc_request *request, 
cleanup:

	free_rpc_construct_null(&req);

}

SPDK_RPC_REGISTER("construct_null_bdev", spdk_rpc_construct_null_bdev, SPDK_RPC_RUNTIME)

SPDK_RPC_REGISTER("bdev_null_create", spdk_rpc_bdev_null_create, SPDK_RPC_RUNTIME)

SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_null_create, construct_null_bdev)



struct rpc_delete_null {

	char *name;
@@ -160,7 +161,7 @@ static const struct spdk_json_object_decoder rpc_delete_null_decoders[] = { 
};



static void

_spdk_rpc_delete_null_bdev_cb(void *cb_arg, int bdeverrno)

_spdk_rpc_bdev_null_delete_cb(void *cb_arg, int bdeverrno)

{

	struct spdk_jsonrpc_request *request = cb_arg;

	struct spdk_json_write_ctx *w = spdk_jsonrpc_begin_result(request);
@@ -170,7 +171,7 @@ _spdk_rpc_delete_null_bdev_cb(void *cb_arg, int bdeverrno) 
}



static void

spdk_rpc_delete_null_bdev(struct spdk_jsonrpc_request *request,

spdk_rpc_bdev_null_delete(struct spdk_jsonrpc_request *request,

			  const struct spdk_json_val *params)

{

	struct rpc_delete_null req = {NULL};
@@ -190,7 +191,7 @@ spdk_rpc_delete_null_bdev(struct spdk_jsonrpc_request *request, 
		goto cleanup;

	}



	delete_null_bdev(bdev, _spdk_rpc_delete_null_bdev_cb, request);

	bdev_null_delete(bdev, _spdk_rpc_bdev_null_delete_cb, request);



	free_rpc_delete_null(&req);
@@ -199,4 +200,5 @@ spdk_rpc_delete_null_bdev(struct spdk_jsonrpc_request *request, 
cleanup:

	free_rpc_delete_null(&req);

}

SPDK_RPC_REGISTER("delete_null_bdev", spdk_rpc_delete_null_bdev, SPDK_RPC_RUNTIME)
 
SPDK_RPC_REGISTER("bdev_null_delete", spdk_rpc_bdev_null_delete, SPDK_RPC_RUNTIME)

SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_null_delete, delete_null_bdev)