From 40c959cbcc96863c362305fa7ef187144ebde821 Mon Sep 17 00:00:00 2001 From: Maciej Wawryk Date: Tue, 13 Aug 2019 14:34:24 +0200 Subject: [PATCH] RPC: rename RPC crypto_bdev series RPC: rename RPC delete_crypto_bdev to bdev_crypto_delete RPC: rename RPC construct_crypto_bdev to bdev_crypto_create Signed-off-by: Maciej Wawryk Change-Id: Ib93714504ee7a97cbbe36457f7826f0af69b1fe5 Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/465057 Tested-by: SPDK CI Jenkins Reviewed-by: Pawel Kaminski Reviewed-by: Jim Harris Reviewed-by: Shuhei Matsumoto --- doc/bdev.md | 6 +++--- lib/bdev/crypto/vbdev_crypto.c | 2 +- lib/bdev/crypto/vbdev_crypto_rpc.c | 16 +++++++++------- scripts/rpc.py | 24 ++++++++++++------------ scripts/rpc/bdev.py | 10 ++++++---- test/json_config/clear_config.py | 2 +- test/json_config/json_config.sh | 2 +- 7 files changed, 33 insertions(+), 29 deletions(-) diff --git a/doc/bdev.md b/doc/bdev.md index 25e3e5568..b1ea89c30 100644 --- a/doc/bdev.md +++ b/doc/bdev.md @@ -199,15 +199,15 @@ may cause problems in some use cases. Example command -`rpc.py construct_crypto_bdev NVMe1n1 CryNvmeA crypto_aesni_mb 0123456789123456` +`rpc.py bdev_crypto_create NVMe1n1 CryNvmeA crypto_aesni_mb 0123456789123456` This command will create a crypto vbdev called 'CryNvmeA' on top of the NVMe bdev 'NVMe1n1' and will use the DPDK software driver 'crypto_aesni_mb' and the key '0123456789123456'. -To remove the vbdev use the delete_crypto_bdev command. +To remove the vbdev use the bdev_crypto_delete command. -`rpc.py delete_crypto_bdev CryNvmeA` +`rpc.py bdev_crypto_delete CryNvmeA` # Delay Bdev Module {#bdev_config_delay} diff --git a/lib/bdev/crypto/vbdev_crypto.c b/lib/bdev/crypto/vbdev_crypto.c index d037f386d..c504b23a8 100644 --- a/lib/bdev/crypto/vbdev_crypto.c +++ b/lib/bdev/crypto/vbdev_crypto.c @@ -1143,7 +1143,7 @@ vbdev_crypto_config_json(struct spdk_json_write_ctx *w) TAILQ_FOREACH(crypto_bdev, &g_vbdev_crypto, link) { spdk_json_write_object_begin(w); - spdk_json_write_named_string(w, "method", "construct_crypto_bdev"); + spdk_json_write_named_string(w, "method", "bdev_crypto_create"); spdk_json_write_named_object_begin(w, "params"); spdk_json_write_named_string(w, "base_bdev_name", spdk_bdev_get_name(crypto_bdev->base_bdev)); spdk_json_write_named_string(w, "name", spdk_bdev_get_name(&crypto_bdev->crypto_bdev)); diff --git a/lib/bdev/crypto/vbdev_crypto_rpc.c b/lib/bdev/crypto/vbdev_crypto_rpc.c index 3658e0751..10147527c 100644 --- a/lib/bdev/crypto/vbdev_crypto_rpc.c +++ b/lib/bdev/crypto/vbdev_crypto_rpc.c @@ -63,8 +63,8 @@ static const struct spdk_json_object_decoder rpc_construct_crypto_decoders[] = { * device. Error status returned in the failed cases. */ static void -spdk_rpc_construct_crypto_bdev(struct spdk_jsonrpc_request *request, - const struct spdk_json_val *params) +spdk_rpc_bdev_crypto_create(struct spdk_jsonrpc_request *request, + const struct spdk_json_val *params) { struct rpc_construct_crypto req = {NULL}; struct spdk_json_write_ctx *w; @@ -95,7 +95,8 @@ spdk_rpc_construct_crypto_bdev(struct spdk_jsonrpc_request *request, cleanup: free_rpc_construct_crypto(&req); } -SPDK_RPC_REGISTER("construct_crypto_bdev", spdk_rpc_construct_crypto_bdev, SPDK_RPC_RUNTIME) +SPDK_RPC_REGISTER("bdev_crypto_create", spdk_rpc_bdev_crypto_create, SPDK_RPC_RUNTIME) +SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_crypto_create, construct_crypto_bdev) struct rpc_delete_crypto { char *name; @@ -112,7 +113,7 @@ static const struct spdk_json_object_decoder rpc_delete_crypto_decoders[] = { }; static void -_spdk_rpc_delete_crypto_bdev_cb(void *cb_arg, int bdeverrno) +_spdk_rpc_bdev_crypto_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); @@ -122,7 +123,7 @@ _spdk_rpc_delete_crypto_bdev_cb(void *cb_arg, int bdeverrno) } static void -spdk_rpc_delete_crypto_bdev(struct spdk_jsonrpc_request *request, +spdk_rpc_bdev_crypto_delete(struct spdk_jsonrpc_request *request, const struct spdk_json_val *params) { struct rpc_delete_crypto req = {NULL}; @@ -142,7 +143,7 @@ spdk_rpc_delete_crypto_bdev(struct spdk_jsonrpc_request *request, goto cleanup; } - delete_crypto_disk(bdev, _spdk_rpc_delete_crypto_bdev_cb, request); + delete_crypto_disk(bdev, _spdk_rpc_bdev_crypto_delete_cb, request); free_rpc_delete_crypto(&req); @@ -151,4 +152,5 @@ spdk_rpc_delete_crypto_bdev(struct spdk_jsonrpc_request *request, cleanup: free_rpc_delete_crypto(&req); } -SPDK_RPC_REGISTER("delete_crypto_bdev", spdk_rpc_delete_crypto_bdev, SPDK_RPC_RUNTIME) +SPDK_RPC_REGISTER("bdev_crypto_delete", spdk_rpc_bdev_crypto_delete, SPDK_RPC_RUNTIME) +SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_crypto_delete, delete_crypto_bdev) diff --git a/scripts/rpc.py b/scripts/rpc.py index 0e16a6eed..6ce8b246b 100755 --- a/scripts/rpc.py +++ b/scripts/rpc.py @@ -161,27 +161,27 @@ if __name__ == "__main__": p.add_argument('-p', '--pmd', type=int, help='0 = auto-select, 1= QAT only, 2 = ISAL only') p.set_defaults(func=set_compress_pmd) - def construct_crypto_bdev(args): - print_json(rpc.bdev.construct_crypto_bdev(args.client, - base_bdev_name=args.base_bdev_name, - name=args.name, - crypto_pmd=args.crypto_pmd, - key=args.key)) - p = subparsers.add_parser('construct_crypto_bdev', + def bdev_crypto_create(args): + print_json(rpc.bdev.bdev_crypto_create(args.client, + base_bdev_name=args.base_bdev_name, + name=args.name, + crypto_pmd=args.crypto_pmd, + key=args.key)) + p = subparsers.add_parser('bdev_crypto_create', help='Add a crypto vbdev') p.add_argument('base_bdev_name', help="Name of the base bdev") p.add_argument('name', help="Name of the crypto vbdev") p.add_argument('crypto_pmd', help="Name of the crypto device driver") p.add_argument('key', help="Key") - p.set_defaults(func=construct_crypto_bdev) + p.set_defaults(func=bdev_crypto_create) - def delete_crypto_bdev(args): - rpc.bdev.delete_crypto_bdev(args.client, + def bdev_crypto_delete(args): + rpc.bdev.bdev_crypto_delete(args.client, name=args.name) - p = subparsers.add_parser('delete_crypto_bdev', help='Delete a crypto disk') + p = subparsers.add_parser('bdev_crypto_delete', help='Delete a crypto disk') p.add_argument('name', help='crypto bdev name') - p.set_defaults(func=delete_crypto_bdev) + p.set_defaults(func=bdev_crypto_delete) def construct_ocf_bdev(args): print_json(rpc.bdev.construct_ocf_bdev(args.client, diff --git a/scripts/rpc/bdev.py b/scripts/rpc/bdev.py index 9f766cb8b..96b2ceeba 100644 --- a/scripts/rpc/bdev.py +++ b/scripts/rpc/bdev.py @@ -56,7 +56,8 @@ def set_compress_pmd(client, pmd): return client.call('set_compress_pmd', params) -def construct_crypto_bdev(client, base_bdev_name, name, crypto_pmd, key): +@deprecated_alias('construct_crypto_bdev') +def bdev_crypto_create(client, base_bdev_name, name, crypto_pmd, key): """Construct a crypto virtual block device. Args: @@ -70,17 +71,18 @@ def construct_crypto_bdev(client, base_bdev_name, name, crypto_pmd, key): """ params = {'base_bdev_name': base_bdev_name, 'name': name, 'crypto_pmd': crypto_pmd, 'key': key} - return client.call('construct_crypto_bdev', params) + return client.call('bdev_crypto_create', params) -def delete_crypto_bdev(client, name): +@deprecated_alias('delete_crypto_bdev') +def bdev_crypto_delete(client, name): """Delete crypto virtual block device. Args: name: name of crypto vbdev to delete """ params = {'name': name} - return client.call('delete_crypto_bdev', params) + return client.call('bdev_crypto_delete', params) def construct_ocf_bdev(client, name, mode, cache_bdev_name, core_bdev_name): diff --git a/test/json_config/clear_config.py b/test/json_config/clear_config.py index 5a52f3894..252a27b2e 100755 --- a/test/json_config/clear_config.py +++ b/test/json_config/clear_config.py @@ -39,7 +39,7 @@ def get_bdev_destroy_method(bdev): 'construct_error_bdev': "delete_error_bdev", 'construct_split_vbdev': "destruct_split_vbdev", 'construct_virtio_dev': "remove_virtio_bdev", - 'construct_crypto_bdev': "delete_crypto_bdev", + 'bdev_crypto_create': "bdev_crypto_delete", 'bdev_delay_create': "bdev_delay_delete", 'construct_passthru_bdev': "delete_passthru_bdev", 'bdev_compress_create': 'bdev_compress_delete', diff --git a/test/json_config/json_config.sh b/test/json_config/json_config.sh index aca7d9bc3..ffd87cf90 100755 --- a/test/json_config/json_config.sh +++ b/test/json_config/json_config.sh @@ -222,7 +222,7 @@ function create_bdev_subsystem_config() { local crypto_dirver=crypto_qat fi - tgt_rpc construct_crypto_bdev MallocForCryptoBdev CryptoMallocBdev $crypto_dirver 0123456789123456 + tgt_rpc bdev_crypto_create MallocForCryptoBdev CryptoMallocBdev $crypto_dirver 0123456789123456 expected_notifications+=( bdev_register:MallocForCryptoBdev bdev_register:CryptoMallocBdev