ivampiresp/Spdk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

bdev: add doc for bdev_auto_examine

Browse Source 
Explain the bdev_auto_examine parameter of the bdev_set_options rpc.
Add bdev_auto_examine parameter for the bdev_set_options
in the python rpc client.

Signed-off-by: Peng Yu <yupeng0921@gmail.com>
Change-Id: I268cd5c01129180467967c2ebfffa7c3ba7e5b1a
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/2580
Community-CI: Mellanox Build Bot
Community-CI: Broadcom CI
Reviewed-by: Changpeng Liu <changpeng.liu@intel.com>
Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com>
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
This commit is contained in:
yupeng 2020-05-24 21:57:23 +00:00 committed by Tomasz Zawadzki
parent c84b3cccdd
commit 240b243af5
3 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/jsonrpc.md
View File

@ -731,6 +731,7 @@ Name | Optional | Type | Description
----------------------- | -------- | ----------- | ----------- ----------------------- | -------- | ----------- | -----------
bdev_io_pool_size | Optional | number | Number of spdk_bdev_io structures in shared buffer pool bdev_io_pool_size | Optional | number | Number of spdk_bdev_io structures in shared buffer pool
bdev_io_cache_size | Optional | number | Maximum number of spdk_bdev_io structures cached per thread bdev_io_cache_size | Optional | number | Maximum number of spdk_bdev_io structures cached per thread
bdev_auto_examine | Optional | boolean | If set to false, the bdev layer will not examine every disks automatically
### Example ### Example

7
scripts/rpc.py
View File

@ -158,12 +158,17 @@ if __name__ == "__main__":
def bdev_set_options(args): def bdev_set_options(args):
rpc.bdev.bdev_set_options(args.client, rpc.bdev.bdev_set_options(args.client,
bdev_io_pool_size=args.bdev_io_pool_size, bdev_io_pool_size=args.bdev_io_pool_size,
bdev_io_cache_size=args.bdev_io_cache_size) bdev_io_cache_size=args.bdev_io_cache_size,
bdev_auto_examine=args.bdev_auto_examine)
p = subparsers.add_parser('bdev_set_options', aliases=['set_bdev_options'], p = subparsers.add_parser('bdev_set_options', aliases=['set_bdev_options'],
help="""Set options of bdev subsystem""") 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('-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) p.add_argument('-c', '--bdev-io-cache-size', help='Maximum number of bdev_io structures cached per thread', type=int)
group = p.add_mutually_exclusive_group()
group.add_argument('-e', '--enable-auto-examine', dest='bdev_auto_examine', help='Allow to auto examine', action='store_true')
group.add_argument('-d', '--disable-auto-examine', dest='bdev_auto_examine', help='Not allow to auto examine', action='store_false')
p.set_defaults(bdev_auto_examine=True)
p.set_defaults(func=bdev_set_options) p.set_defaults(func=bdev_set_options)
def bdev_compress_create(args): def bdev_compress_create(args):

5
scripts/rpc/bdev.py
View File

@ -2,12 +2,13 @@ from .helpers import deprecated_alias
@deprecated_alias('set_bdev_options') @deprecated_alias('set_bdev_options')
def bdev_set_options(client, bdev_io_pool_size=None, bdev_io_cache_size=None): def bdev_set_options(client, bdev_io_pool_size=None, bdev_io_cache_size=None, bdev_auto_examine=None):
"""Set parameters for the bdev subsystem. """Set parameters for the bdev subsystem.
Args: Args:
bdev_io_pool_size: number of bdev_io structures in shared buffer pool (optional) bdev_io_pool_size: number of bdev_io structures in shared buffer pool (optional)
bdev_io_cache_size: maximum number of bdev_io structures cached per thread (optional) bdev_io_cache_size: maximum number of bdev_io structures cached per thread (optional)
bdev_auto_examine: if set to false, the bdev layer will not examine every disks automatically (optional)
""" """
params = {} params = {}
@ -15,6 +16,8 @@ def bdev_set_options(client, bdev_io_pool_size=None, bdev_io_cache_size=None):
params['bdev_io_pool_size'] = bdev_io_pool_size params['bdev_io_pool_size'] = bdev_io_pool_size
if bdev_io_cache_size: if bdev_io_cache_size:
params['bdev_io_cache_size'] = bdev_io_cache_size params['bdev_io_cache_size'] = bdev_io_cache_size
if bdev_auto_examine is not None:
params["bdev_auto_examine"] = bdev_auto_examine
return client.call('bdev_set_options', params) return client.call('bdev_set_options', params)