Commit 47bc5870 authored by Jim Harris's avatar Jim Harris
Browse files

bdev: remove support for deprecated RPC names 



These were deprecated in 2019, it's time to remove
support for them now.

Fix ocf test script that was still using the
deprecated get_bdevs RPC name - change it to
bdev_get_bdevs.

Signed-off-by: default avatarJim Harris <james.r.harris@intel.com>
Change-Id: I7f8caedc250b80503671a0236694181613f63860
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/12553


Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com>
Community-CI: Mellanox Build Bot
Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: default avatarChangpeng Liu <changpeng.liu@intel.com>
Reviewed-by: default avatarKonrad Sztyber <konrad.sztyber@intel.com>
parent febe9002

lib/bdev/bdev_rpc.c

+0 −8
Original line number Diff line number Diff line
@@ -114,7 +114,6 @@ rpc_bdev_set_options(struct spdk_jsonrpc_request *request, const struct spdk_jso 
	spdk_jsonrpc_send_bool_response(request, true);

}

SPDK_RPC_REGISTER("bdev_set_options", rpc_bdev_set_options, SPDK_RPC_STARTUP)

SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_set_options, set_bdev_options)



static void

rpc_bdev_wait_for_examine_cpl(void *arg)
@@ -416,7 +415,6 @@ rpc_bdev_get_iostat(struct spdk_jsonrpc_request *request, 
	rpc_bdev_get_iostat_done(ctx);

}

SPDK_RPC_REGISTER("bdev_get_iostat", rpc_bdev_get_iostat, SPDK_RPC_RUNTIME)

SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_get_iostat, get_bdevs_iostat)



static int

rpc_dump_bdev_info(void *ctx, struct spdk_bdev *bdev)
@@ -665,7 +663,6 @@ rpc_bdev_get_bdevs(struct spdk_jsonrpc_request *request, 
	spdk_jsonrpc_end_result(request, w);

}

SPDK_RPC_REGISTER("bdev_get_bdevs", rpc_bdev_get_bdevs, SPDK_RPC_RUNTIME)

SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_get_bdevs, get_bdevs)



struct rpc_bdev_set_qd_sampling_period {

	char *name;
@@ -719,8 +716,6 @@ cleanup: 
SPDK_RPC_REGISTER("bdev_set_qd_sampling_period",

		  rpc_bdev_set_qd_sampling_period,

		  SPDK_RPC_RUNTIME)

SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_set_qd_sampling_period,

				   set_bdev_qd_sampling_period)



struct rpc_bdev_set_qos_limit {

	char		*name;
@@ -818,7 +813,6 @@ cleanup: 
}



SPDK_RPC_REGISTER("bdev_set_qos_limit", rpc_bdev_set_qos_limit, SPDK_RPC_RUNTIME)

SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_set_qos_limit, set_bdev_qos_limit)



/* SPDK_RPC_ENABLE_BDEV_HISTOGRAM */
@@ -879,7 +873,6 @@ cleanup: 
}



SPDK_RPC_REGISTER("bdev_enable_histogram", rpc_bdev_enable_histogram, SPDK_RPC_RUNTIME)

SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_enable_histogram, enable_bdev_histogram)



/* SPDK_RPC_GET_BDEV_HISTOGRAM */
@@ -985,4 +978,3 @@ cleanup: 
}



SPDK_RPC_REGISTER("bdev_get_histogram", rpc_bdev_get_histogram, SPDK_RPC_RUNTIME)
 
SPDK_RPC_REGISTER_ALIAS_DEPRECATED(bdev_get_histogram, get_bdev_histogram)

python/spdk/rpc/bdev.py

+0 −7
Original line number Diff line number Diff line 
from .helpers import deprecated_alias





@deprecated_alias('set_bdev_options')

def bdev_set_options(client, bdev_io_pool_size=None, bdev_io_cache_size=None, bdev_auto_examine=None,

                     small_buf_pool_size=None, large_buf_pool_size=None):

    """Set parameters for the bdev subsystem.
@@ -1354,7 +1353,6 @@ def bdev_ftl_delete(client, name): 
    return client.call('bdev_ftl_delete', params)





@deprecated_alias('get_bdevs')

def bdev_get_bdevs(client, name=None, timeout=None):

    """Get information about block devices.
@@ -1373,7 +1371,6 @@ def bdev_get_bdevs(client, name=None, timeout=None): 
    return client.call('bdev_get_bdevs', params)





@deprecated_alias('get_bdevs_iostat')

def bdev_get_iostat(client, name=None):

    """Get I/O statistics for block devices.
@@ -1389,7 +1386,6 @@ def bdev_get_iostat(client, name=None): 
    return client.call('bdev_get_iostat', params)





@deprecated_alias('enable_bdev_histogram')

def bdev_enable_histogram(client, name, enable):

    """Control whether histogram is enabled for specified bdev.
@@ -1400,7 +1396,6 @@ def bdev_enable_histogram(client, name, enable): 
    return client.call('bdev_enable_histogram', params)





@deprecated_alias('get_bdev_histogram')

def bdev_get_histogram(client, name):

    """Get histogram for specified bdev.
@@ -1431,7 +1426,6 @@ def bdev_error_inject_error(client, name, io_type, error_type, num=1): 
    return client.call('bdev_error_inject_error', params)





@deprecated_alias('set_bdev_qd_sampling_period')

def bdev_set_qd_sampling_period(client, name, period):

    """Enable queue depth tracking on a specified bdev.
@@ -1446,7 +1440,6 @@ def bdev_set_qd_sampling_period(client, name, period): 
    return client.call('bdev_set_qd_sampling_period', params)





@deprecated_alias('set_bdev_qos_limit')

def bdev_set_qos_limit(

        client,

        name,

scripts/rpc.py

+7 −7
Original line number Diff line number Diff line
@@ -193,7 +193,7 @@ if __name__ == "__main__": 
                                  small_buf_pool_size=args.small_buf_pool_size,

                                  large_buf_pool_size=args.large_buf_pool_size)



    p = subparsers.add_parser('bdev_set_options', aliases=['set_bdev_options'],

    p = subparsers.add_parser('bdev_set_options',

                              help="""Set options of bdev subsystem""")

    p.add_argument('-p', '--bdev-io-pool-size', help='Number of bdev_io structures in shared buffer pool', type=int)

    p.add_argument('-c', '--bdev-io-cache-size', help='Maximum number of bdev_io structures cached per thread', type=int)
@@ -1063,7 +1063,7 @@ if __name__ == "__main__": 
        print_dict(rpc.bdev.bdev_get_bdevs(args.client,

                                           name=args.name, timeout=args.timeout_ms))



    p = subparsers.add_parser('bdev_get_bdevs', aliases=['get_bdevs'],

    p = subparsers.add_parser('bdev_get_bdevs',

                              help='Display current blockdev list or required blockdev')

    p.add_argument('-b', '--name', help="Name of the Blockdev. Example: Nvme0n1", required=False)

    p.add_argument('-t', '--timeout-ms', help="""Time in ms to wait for the bdev to appear (only used
@@ -1076,7 +1076,7 @@ if __name__ == "__main__": 
        print_dict(rpc.bdev.bdev_get_iostat(args.client,

                                            name=args.name))



    p = subparsers.add_parser('bdev_get_iostat', aliases=['get_bdevs_iostat'],

    p = subparsers.add_parser('bdev_get_iostat',

                              help='Display current I/O statistics of all the blockdevs or required blockdev.')

    p.add_argument('-b', '--name', help="Name of the Blockdev. Example: Nvme0n1", required=False)

    p.set_defaults(func=bdev_get_iostat)
@@ -1084,7 +1084,7 @@ if __name__ == "__main__": 
    def bdev_enable_histogram(args):

        rpc.bdev.bdev_enable_histogram(args.client, name=args.name, enable=args.enable)



    p = subparsers.add_parser('bdev_enable_histogram', aliases=['enable_bdev_histogram'],

    p = subparsers.add_parser('bdev_enable_histogram',

                              help='Enable or disable histogram for specified bdev')

    p.add_argument('-e', '--enable', default=True, dest='enable', action='store_true', help='Enable histograms on specified device')

    p.add_argument('-d', '--disable', dest='enable', action='store_false', help='Disable histograms on specified device')
@@ -1094,7 +1094,7 @@ if __name__ == "__main__": 
    def bdev_get_histogram(args):

        print_dict(rpc.bdev.bdev_get_histogram(args.client, name=args.name))



    p = subparsers.add_parser('bdev_get_histogram', aliases=['get_bdev_histogram'],

    p = subparsers.add_parser('bdev_get_histogram',

                              help='Get histogram for specified bdev')

    p.add_argument('name', help='bdev name')

    p.set_defaults(func=bdev_get_histogram)
@@ -1104,7 +1104,7 @@ if __name__ == "__main__": 
                                             name=args.name,

                                             period=args.period)



    p = subparsers.add_parser('bdev_set_qd_sampling_period', aliases=['set_bdev_qd_sampling_period'],

    p = subparsers.add_parser('bdev_set_qd_sampling_period',

                              help="Enable or disable tracking of a bdev's queue depth.")

    p.add_argument('name', help='Blockdev name. Example: Malloc0')

    p.add_argument('period', help='Period with which to poll the block device queue depth in microseconds.'
@@ -1120,7 +1120,7 @@ if __name__ == "__main__": 
                                    r_mbytes_per_sec=args.r_mbytes_per_sec,

                                    w_mbytes_per_sec=args.w_mbytes_per_sec)



    p = subparsers.add_parser('bdev_set_qos_limit', aliases=['set_bdev_qos_limit'],

    p = subparsers.add_parser('bdev_set_qos_limit',

                              help='Set QoS rate limit on a blockdev')

    p.add_argument('name', help='Blockdev name to set QoS. Example: Malloc0')

    p.add_argument('--rw-ios-per-sec',

test/ocf/management/create-destruct.sh

+2 −2
Original line number Diff line number Diff line
@@ -7,7 +7,7 @@ source $rootdir/test/common/autotest_common.sh 
rpc_py=$rootdir/scripts/rpc.py



function bdev_check_claimed() {

	if [ "$($rpc_py get_bdevs -b "$@" | jq '.[0].claimed')" = "true" ]; then

	if [ "$($rpc_py bdev_get_bdevs -b "$@" | jq '.[0].claimed')" = "true" ]; then

		return 0

	else

		return 1
@@ -73,7 +73,7 @@ if bdev_check_claimed Malloc1; then 
	exit 1

fi



status=$($rpc_py get_bdevs)

status=$($rpc_py bdev_get_bdevs)

gone=$(echo $status | jq 'map(select(.name == "HotCache")) == []')

if [[ $gone == false ]]; then

	echo >&2 "OCF bdev is expected to unregister"