1#!/usr/bin/env python3 2# SPDX-License-Identifier: BSD-3-Clause 3# Copyright (C) 2016 Intel Corporation 4# All rights reserved. 5# Copyright (c) 2022 Dell Inc, or its subsidiaries. 6# Copyright (c) 2022-2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved. 7# 8 9import logging 10import argparse 11import importlib 12import os 13import sys 14import shlex 15import json 16 17try: 18 from shlex import quote 19except ImportError: 20 from pipes import quote 21 22sys.path.append(os.path.dirname(__file__) + '/../python') 23 24import spdk.rpc as rpc # noqa 25from spdk.rpc.client import print_dict, print_json, JSONRPCException # noqa 26from spdk.rpc.helpers import deprecated_aliases # noqa 27 28 29def print_array(a): 30 print(" ".join((quote(v) for v in a))) 31 32 33if __name__ == "__main__": 34 parser = argparse.ArgumentParser( 35 description='SPDK RPC command line interface', usage='%(prog)s [options]') 36 parser.add_argument('-s', dest='server_addr', 37 help='RPC domain socket path or IP address', default='/var/tmp/spdk.sock') 38 parser.add_argument('-p', dest='port', 39 help='RPC port number (if server_addr is IP address)', 40 default=5260, type=int) 41 parser.add_argument('-t', dest='timeout', 42 help='Timeout as a floating point number expressed in seconds waiting for response. Default: 60.0', 43 default=60.0, type=float) 44 parser.add_argument('-r', dest='conn_retries', 45 help='Retry connecting to the RPC server N times with 0.2s interval. Default: 0', 46 default=0, type=int) 47 parser.add_argument('-v', dest='verbose', action='store_const', const="INFO", 48 help='Set verbose mode to INFO', default="ERROR") 49 parser.add_argument('--verbose', dest='verbose', choices=['DEBUG', 'INFO', 'ERROR'], 50 help="""Set verbose level. """) 51 parser.add_argument('--dry-run', dest='dry_run', action='store_true', help="Display request and exit") 52 parser.set_defaults(dry_run=False) 53 parser.add_argument('--go-client', dest='go_client', action='store_true', help="Use Go client") 54 parser.set_defaults(go_client=False) 55 parser.add_argument('--server', dest='is_server', action='store_true', 56 help="Start listening on stdin, parse each line as a regular rpc.py execution and create \ 57 a separate connection for each command. Each command's output ends with either \ 58 **STATUS=0 if the command succeeded or **STATUS=1 if it failed. --server is meant \ 59 to be used in conjunction with bash coproc, where stdin and stdout are connected to \ 60 pipes and can be used as a faster way to send RPC commands. If enabled, rpc.py \ 61 must be executed without any other parameters.") 62 parser.set_defaults(is_server=False) 63 parser.add_argument('--plugin', dest='rpc_plugin', help='Module name of plugin with additional RPC commands') 64 subparsers = parser.add_subparsers(help='RPC methods', dest='called_rpc_name', metavar='') 65 66 def framework_start_init(args): 67 rpc.framework_start_init(args.client) 68 69 p = subparsers.add_parser('framework_start_init', help='Start initialization of subsystems') 70 p.set_defaults(func=framework_start_init) 71 72 def framework_wait_init(args): 73 rpc.framework_wait_init(args.client) 74 75 p = subparsers.add_parser('framework_wait_init', help='Block until subsystems have been initialized') 76 p.set_defaults(func=framework_wait_init) 77 78 def rpc_get_methods(args): 79 print_dict(rpc.rpc_get_methods(args.client, 80 current=args.current, 81 include_aliases=args.include_aliases)) 82 83 p = subparsers.add_parser('rpc_get_methods', help='Get list of supported RPC methods') 84 p.add_argument('-c', '--current', help='Get list of RPC methods only callable in the current state.', action='store_true') 85 p.add_argument('-i', '--include-aliases', help='include RPC aliases', action='store_true') 86 p.set_defaults(func=rpc_get_methods) 87 88 def spdk_get_version(args): 89 print_json(rpc.spdk_get_version(args.client)) 90 91 p = subparsers.add_parser('spdk_get_version', help='Get SPDK version') 92 p.set_defaults(func=spdk_get_version) 93 94 def save_config(args): 95 rpc.save_config(args.client, 96 sys.stdout, 97 indent=args.indent) 98 99 p = subparsers.add_parser('save_config', help="""Write current (live) configuration of SPDK subsystems and targets to stdout. 100 """) 101 p.add_argument('-i', '--indent', help="""Indent level. Value less than 0 mean compact mode. Default indent level is 2. 102 """, type=int, default=2) 103 p.set_defaults(func=save_config) 104 105 def load_config(args): 106 rpc.load_config(args.client, args.json_conf, 107 include_aliases=args.include_aliases) 108 109 p = subparsers.add_parser('load_config', help="""Configure SPDK subsystems and targets using JSON RPC.""") 110 p.add_argument('-i', '--include-aliases', help='include RPC aliases', action='store_true') 111 p.add_argument('-j', '--json-conf', help='Valid JSON configuration', default=sys.stdin) 112 p.set_defaults(func=load_config) 113 114 def save_subsystem_config(args): 115 rpc.save_subsystem_config(args.client, 116 sys.stdout, 117 indent=args.indent, 118 name=args.name) 119 120 p = subparsers.add_parser('save_subsystem_config', help="""Write current (live) configuration of SPDK subsystem to stdout. 121 """) 122 p.add_argument('-i', '--indent', help="""Indent level. Value less than 0 mean compact mode. Default indent level is 2. 123 """, type=int, default=2) 124 p.add_argument('-n', '--name', help='Name of subsystem', required=True) 125 p.set_defaults(func=save_subsystem_config) 126 127 def load_subsystem_config(args): 128 rpc.load_subsystem_config(args.client, 129 args.json_conf) 130 131 p = subparsers.add_parser('load_subsystem_config', help="""Configure SPDK subsystem using JSON RPC.""") 132 p.add_argument('-j', '--json-conf', help='Valid JSON configuration', default=sys.stdin) 133 p.set_defaults(func=load_subsystem_config) 134 135 # app 136 def spdk_kill_instance(args): 137 rpc.app.spdk_kill_instance(args.client, 138 sig_name=args.sig_name) 139 140 p = subparsers.add_parser('spdk_kill_instance', help='Send signal to instance') 141 p.add_argument('sig_name', help='signal will be sent to server.') 142 p.set_defaults(func=spdk_kill_instance) 143 144 def framework_monitor_context_switch(args): 145 enabled = None 146 if args.enable: 147 enabled = True 148 if args.disable: 149 enabled = False 150 print_dict(rpc.app.framework_monitor_context_switch(args.client, 151 enabled=enabled)) 152 153 p = subparsers.add_parser('framework_monitor_context_switch', 154 help='Control whether the context switch monitor is enabled') 155 p.add_argument('-e', '--enable', action='store_true', help='Enable context switch monitoring') 156 p.add_argument('-d', '--disable', action='store_true', help='Disable context switch monitoring') 157 p.set_defaults(func=framework_monitor_context_switch) 158 159 def framework_get_reactors(args): 160 print_dict(rpc.app.framework_get_reactors(args.client)) 161 162 p = subparsers.add_parser( 163 'framework_get_reactors', help='Display list of all reactors') 164 p.set_defaults(func=framework_get_reactors) 165 166 def framework_set_scheduler(args): 167 rpc.app.framework_set_scheduler(args.client, 168 name=args.name, 169 period=args.period, 170 load_limit=args.load_limit, 171 core_limit=args.core_limit, 172 core_busy=args.core_busy) 173 174 p = subparsers.add_parser( 175 'framework_set_scheduler', help='Select thread scheduler that will be activated and its period (experimental)') 176 p.add_argument('name', help="Name of a scheduler") 177 p.add_argument('-p', '--period', help="Scheduler period in microseconds", type=int) 178 p.add_argument('--load-limit', help="Scheduler load limit. Reserved for dynamic scheduler", type=int, required=False) 179 p.add_argument('--core-limit', help="Scheduler core limit. Reserved for dynamic scheduler", type=int, required=False) 180 p.add_argument('--core-busy', help="Scheduler core busy limit. Reserved for dynamic schedler", type=int, required=False) 181 p.set_defaults(func=framework_set_scheduler) 182 183 def framework_get_scheduler(args): 184 print_dict(rpc.app.framework_get_scheduler(args.client)) 185 186 p = subparsers.add_parser( 187 'framework_get_scheduler', help='Display currently set scheduler and its properties.') 188 p.set_defaults(func=framework_get_scheduler) 189 190 def framework_disable_cpumask_locks(args): 191 rpc.framework_disable_cpumask_locks(args.client) 192 193 p = subparsers.add_parser('framework_disable_cpumask_locks', 194 help='Disable CPU core lock files.') 195 p.set_defaults(func=framework_disable_cpumask_locks) 196 197 def framework_enable_cpumask_locks(args): 198 rpc.framework_enable_cpumask_locks(args.client) 199 200 p = subparsers.add_parser('framework_enable_cpumask_locks', 201 help='Enable CPU core lock files.') 202 p.set_defaults(func=framework_enable_cpumask_locks) 203 204 # bdev 205 def bdev_set_options(args): 206 rpc.bdev.bdev_set_options(args.client, 207 bdev_io_pool_size=args.bdev_io_pool_size, 208 bdev_io_cache_size=args.bdev_io_cache_size, 209 bdev_auto_examine=args.bdev_auto_examine, 210 iobuf_small_cache_size=args.iobuf_small_cache_size, 211 iobuf_large_cache_size=args.iobuf_large_cache_size) 212 213 p = subparsers.add_parser('bdev_set_options', 214 help="""Set options of bdev subsystem""") 215 p.add_argument('-p', '--bdev-io-pool-size', help='Number of bdev_io structures in shared buffer pool', type=int) 216 p.add_argument('-c', '--bdev-io-cache-size', help='Maximum number of bdev_io structures cached per thread', type=int) 217 group = p.add_mutually_exclusive_group() 218 group.add_argument('-e', '--enable-auto-examine', dest='bdev_auto_examine', help='Allow to auto examine', action='store_true') 219 group.add_argument('-d', '--disable-auto-examine', dest='bdev_auto_examine', help='Not allow to auto examine', action='store_false') 220 p.add_argument('--iobuf-small-cache-size', help='Size of the small iobuf per thread cache', type=int) 221 p.add_argument('--iobuf-large-cache-size', help='Size of the large iobuf per thread cache', type=int) 222 p.set_defaults(bdev_auto_examine=True) 223 p.set_defaults(func=bdev_set_options) 224 225 def bdev_examine(args): 226 rpc.bdev.bdev_examine(args.client, 227 name=args.name) 228 229 p = subparsers.add_parser('bdev_examine', 230 help="""examine a bdev if it exists, or will examine it after it is created""") 231 p.add_argument('-b', '--name', help='Name or alias of the bdev') 232 p.set_defaults(func=bdev_examine) 233 234 def bdev_wait_for_examine(args): 235 rpc.bdev.bdev_wait_for_examine(args.client) 236 237 p = subparsers.add_parser('bdev_wait_for_examine', 238 help="""Report when all bdevs have been examined""") 239 p.set_defaults(func=bdev_wait_for_examine) 240 241 def bdev_compress_create(args): 242 print_json(rpc.bdev.bdev_compress_create(args.client, 243 base_bdev_name=args.base_bdev_name, 244 pm_path=args.pm_path, 245 lb_size=args.lb_size)) 246 247 p = subparsers.add_parser('bdev_compress_create', help='Add a compress vbdev') 248 p.add_argument('-b', '--base-bdev-name', help="Name of the base bdev") 249 p.add_argument('-p', '--pm-path', help="Path to persistent memory") 250 p.add_argument('-l', '--lb-size', help="Compressed vol logical block size (optional, if used must be 512 or 4096)", type=int) 251 p.set_defaults(func=bdev_compress_create) 252 253 def bdev_compress_delete(args): 254 rpc.bdev.bdev_compress_delete(args.client, 255 name=args.name) 256 257 p = subparsers.add_parser('bdev_compress_delete', help='Delete a compress disk') 258 p.add_argument('name', help='compress bdev name') 259 p.set_defaults(func=bdev_compress_delete) 260 261 def bdev_compress_get_orphans(args): 262 print_dict(rpc.bdev.bdev_compress_get_orphans(args.client, 263 name=args.name)) 264 p = subparsers.add_parser( 265 'bdev_compress_get_orphans', help='Display list of orphaned compress bdevs.') 266 p.add_argument('-b', '--name', help="Name of a comp bdev. Example: COMP_Nvme0n1", required=False) 267 p.set_defaults(func=bdev_compress_get_orphans) 268 269 def bdev_crypto_create(args): 270 print_json(rpc.bdev.bdev_crypto_create(args.client, 271 base_bdev_name=args.base_bdev_name, 272 name=args.name, 273 crypto_pmd=args.crypto_pmd, 274 key=args.key, 275 cipher=args.cipher, 276 key2=args.key2, 277 key_name=args.key_name)) 278 p = subparsers.add_parser('bdev_crypto_create', help='Add a crypto vbdev') 279 p.add_argument('base_bdev_name', help="Name of the base bdev") 280 p.add_argument('name', help="Name of the crypto vbdev") 281 p.add_argument('-p', '--crypto-pmd', help="Name of the crypto device driver. Obsolete, see dpdk_cryptodev_set_driver", required=False) 282 p.add_argument('-k', '--key', help="Key. Obsolete, see accel_crypto_key_create", required=False) 283 p.add_argument('-c', '--cipher', help="cipher to use. Obsolete, see accel_crypto_key_create", required=False) 284 p.add_argument('-k2', '--key2', help="2nd key for cipher AES_XTS. Obsolete, see accel_crypto_key_create", default=None) 285 p.add_argument('-n', '--key-name', help="Key name to use, see accel_crypto_key_create", required=False) 286 p.set_defaults(func=bdev_crypto_create) 287 288 def bdev_crypto_delete(args): 289 rpc.bdev.bdev_crypto_delete(args.client, 290 name=args.name) 291 292 p = subparsers.add_parser('bdev_crypto_delete', help='Delete a crypto disk') 293 p.add_argument('name', help='crypto bdev name') 294 p.set_defaults(func=bdev_crypto_delete) 295 296 def bdev_ocf_create(args): 297 print_json(rpc.bdev.bdev_ocf_create(args.client, 298 name=args.name, 299 mode=args.mode, 300 cache_line_size=args.cache_line_size, 301 cache_bdev_name=args.cache_bdev_name, 302 core_bdev_name=args.core_bdev_name)) 303 p = subparsers.add_parser('bdev_ocf_create', help='Add an OCF block device') 304 p.add_argument('name', help='Name of resulting OCF bdev') 305 p.add_argument('mode', help='OCF cache mode', choices=['wb', 'wt', 'pt', 'wa', 'wi', 'wo']) 306 p.add_argument( 307 '--cache-line-size', 308 help='OCF cache line size. The unit is KiB', 309 type=int, 310 choices=[4, 8, 16, 32, 64], 311 required=False 312 ) 313 p.add_argument('cache_bdev_name', help='Name of underlying cache bdev') 314 p.add_argument('core_bdev_name', help='Name of underlying core bdev') 315 p.set_defaults(func=bdev_ocf_create) 316 317 def bdev_ocf_delete(args): 318 rpc.bdev.bdev_ocf_delete(args.client, 319 name=args.name) 320 321 p = subparsers.add_parser('bdev_ocf_delete', help='Delete an OCF block device') 322 p.add_argument('name', help='Name of OCF bdev') 323 p.set_defaults(func=bdev_ocf_delete) 324 325 def bdev_ocf_get_stats(args): 326 print_dict(rpc.bdev.bdev_ocf_get_stats(args.client, 327 name=args.name)) 328 p = subparsers.add_parser('bdev_ocf_get_stats', help='Get statistics of chosen OCF block device') 329 p.add_argument('name', help='Name of OCF bdev') 330 p.set_defaults(func=bdev_ocf_get_stats) 331 332 def bdev_ocf_reset_stats(args): 333 print_dict(rpc.bdev.bdev_ocf_reset_stats(args.client, 334 name=args.name)) 335 p = subparsers.add_parser('bdev_ocf_reset_stats', help='Reset statistics of chosen OCF block device') 336 p.add_argument('name', help='Name of OCF bdev') 337 p.set_defaults(func=bdev_ocf_reset_stats) 338 339 def bdev_ocf_get_bdevs(args): 340 print_dict(rpc.bdev.bdev_ocf_get_bdevs(args.client, 341 name=args.name)) 342 p = subparsers.add_parser('bdev_ocf_get_bdevs', help='Get list of OCF devices including unregistered ones') 343 p.add_argument('name', nargs='?', help='name of OCF vbdev or name of cache device or name of core device (optional)') 344 p.set_defaults(func=bdev_ocf_get_bdevs) 345 346 def bdev_ocf_set_cache_mode(args): 347 print_json(rpc.bdev.bdev_ocf_set_cache_mode(args.client, 348 name=args.name, 349 mode=args.mode)) 350 p = subparsers.add_parser('bdev_ocf_set_cache_mode', 351 help='Set cache mode of OCF block device') 352 p.add_argument('name', help='Name of OCF bdev') 353 p.add_argument('mode', help='OCF cache mode', choices=['wb', 'wt', 'pt', 'wa', 'wi', 'wo']) 354 p.set_defaults(func=bdev_ocf_set_cache_mode) 355 356 def bdev_ocf_set_seqcutoff(args): 357 rpc.bdev.bdev_ocf_set_seqcutoff(args.client, 358 name=args.name, 359 policy=args.policy, 360 threshold=args.threshold, 361 promotion_count=args.promotion_count) 362 p = subparsers.add_parser('bdev_ocf_set_seqcutoff', 363 help='Set sequential cutoff parameters on all cores for the given OCF cache device') 364 p.add_argument('name', help='Name of OCF cache bdev') 365 p.add_argument('-t', '--threshold', type=int, 366 help='Activation threshold [KiB]') 367 p.add_argument('-c', '--promotion-count', type=int, 368 help='Promotion request count') 369 p.add_argument('-p', '--policy', choices=['always', 'full', 'never'], required=True, 370 help='Sequential cutoff policy') 371 p.set_defaults(func=bdev_ocf_set_seqcutoff) 372 373 def bdev_ocf_flush_start(args): 374 rpc.bdev.bdev_ocf_flush_start(args.client, name=args.name) 375 p = subparsers.add_parser('bdev_ocf_flush_start', 376 help='Start flushing OCF cache device') 377 p.add_argument('name', help='Name of OCF bdev') 378 p.set_defaults(func=bdev_ocf_flush_start) 379 380 def bdev_ocf_flush_status(args): 381 print_json(rpc.bdev.bdev_ocf_flush_status(args.client, name=args.name)) 382 p = subparsers.add_parser('bdev_ocf_flush_status', 383 help='Get flush status of OCF cache device') 384 p.add_argument('name', help='Name of OCF bdev') 385 p.set_defaults(func=bdev_ocf_flush_status) 386 387 def bdev_malloc_create(args): 388 num_blocks = (args.total_size * 1024 * 1024) // args.block_size 389 print_json(rpc.bdev.bdev_malloc_create(args.client, 390 num_blocks=int(num_blocks), 391 block_size=args.block_size, 392 physical_block_size=args.physical_block_size, 393 name=args.name, 394 uuid=args.uuid, 395 optimal_io_boundary=args.optimal_io_boundary, 396 md_size=args.md_size, 397 md_interleave=args.md_interleave, 398 dif_type=args.dif_type, 399 dif_is_head_of_md=args.dif_is_head_of_md)) 400 p = subparsers.add_parser('bdev_malloc_create', help='Create a bdev with malloc backend') 401 p.add_argument('-b', '--name', help="Name of the bdev") 402 p.add_argument('-u', '--uuid', help="UUID of the bdev") 403 p.add_argument( 404 'total_size', help='Size of malloc bdev in MB (float > 0)', type=float) 405 p.add_argument('block_size', help='Data block size for this bdev', type=int) 406 p.add_argument('-p', '--physical-block-size', help='Physical block size for this bdev.', type=int) 407 p.add_argument('-o', '--optimal-io-boundary', help="""Split on optimal IO boundary, in number of 408 blocks, default 0 (disabled)""", type=int) 409 p.add_argument('-m', '--md-size', type=int, 410 help='Metadata size for this bdev (0, 8, 16, 32, 64, or 128). Default is 0.') 411 p.add_argument('-i', '--md-interleave', action='store_true', 412 help='Metadata location, interleaved if set, and separated if omitted.') 413 p.add_argument('-t', '--dif-type', type=int, choices=[0, 1, 2, 3], 414 help='Protection information type. Parameter --md-size needs' 415 'to be set along --dif-type. Default=0 - no protection.') 416 p.add_argument('-d', '--dif-is-head-of-md', action='store_true', 417 help='Protection information is in the first 8 bytes of metadata. Default=false.') 418 p.set_defaults(func=bdev_malloc_create) 419 420 def bdev_malloc_delete(args): 421 rpc.bdev.bdev_malloc_delete(args.client, 422 name=args.name) 423 424 p = subparsers.add_parser('bdev_malloc_delete', help='Delete a malloc disk') 425 p.add_argument('name', help='malloc bdev name') 426 p.set_defaults(func=bdev_malloc_delete) 427 428 def bdev_null_create(args): 429 num_blocks = (args.total_size * 1024 * 1024) // args.block_size 430 if args.dif_type and not args.md_size: 431 print("ERROR: --md-size must be > 0 when --dif-type is > 0") 432 exit(1) 433 print_json(rpc.bdev.bdev_null_create(args.client, 434 num_blocks=num_blocks, 435 block_size=args.block_size, 436 physical_block_size=args.physical_block_size, 437 name=args.name, 438 uuid=args.uuid, 439 md_size=args.md_size, 440 dif_type=args.dif_type, 441 dif_is_head_of_md=args.dif_is_head_of_md)) 442 443 p = subparsers.add_parser('bdev_null_create', help='Add a bdev with null backend') 444 p.add_argument('name', help='Block device name') 445 p.add_argument('-u', '--uuid', help='UUID of the bdev') 446 p.add_argument('total_size', help='Size of null bdev in MB (int > 0). Includes only data blocks.', type=int) 447 p.add_argument('block_size', help='Data block size for this bdev.', type=int) 448 p.add_argument('-p', '--physical-block-size', help='Physical block size for this bdev.', type=int) 449 p.add_argument('-m', '--md-size', type=int, 450 help='Metadata size for this bdev. Default=0.') 451 p.add_argument('-t', '--dif-type', type=int, choices=[0, 1, 2, 3], 452 help='Protection information type. Parameter --md-size needs' 453 'to be set along --dif-type. Default=0 - no protection.') 454 p.add_argument('-d', '--dif-is-head-of-md', action='store_true', 455 help='Protection information is in the first 8 bytes of metadata. Default=false.') 456 p.set_defaults(func=bdev_null_create) 457 458 def bdev_null_delete(args): 459 rpc.bdev.bdev_null_delete(args.client, 460 name=args.name) 461 462 p = subparsers.add_parser('bdev_null_delete', help='Delete a null bdev') 463 p.add_argument('name', help='null bdev name') 464 p.set_defaults(func=bdev_null_delete) 465 466 def bdev_null_resize(args): 467 print_json(rpc.bdev.bdev_null_resize(args.client, 468 name=args.name, 469 new_size=int(args.new_size))) 470 471 p = subparsers.add_parser('bdev_null_resize', 472 help='Resize a null bdev') 473 p.add_argument('name', help='null bdev name') 474 p.add_argument('new_size', help='new bdev size for resize operation. The unit is MiB') 475 p.set_defaults(func=bdev_null_resize) 476 477 def bdev_aio_create(args): 478 print_json(rpc.bdev.bdev_aio_create(args.client, 479 filename=args.filename, 480 name=args.name, 481 block_size=args.block_size, 482 readonly=args.readonly)) 483 484 p = subparsers.add_parser('bdev_aio_create', help='Add a bdev with aio backend') 485 p.add_argument('filename', help='Path to device or file (ex: /dev/sda)') 486 p.add_argument('name', help='Block device name') 487 p.add_argument('block_size', help='Block size for this bdev', type=int, nargs='?') 488 p.add_argument("-r", "--readonly", action='store_true', help='Set this bdev as read-only') 489 p.set_defaults(func=bdev_aio_create) 490 491 def bdev_aio_rescan(args): 492 print_json(rpc.bdev.bdev_aio_rescan(args.client, 493 name=args.name)) 494 495 p = subparsers.add_parser('bdev_aio_rescan', help='Rescan a bdev size with aio backend') 496 p.add_argument('name', help='Block device name') 497 p.set_defaults(func=bdev_aio_rescan) 498 499 def bdev_aio_delete(args): 500 rpc.bdev.bdev_aio_delete(args.client, 501 name=args.name) 502 503 p = subparsers.add_parser('bdev_aio_delete', help='Delete an aio disk') 504 p.add_argument('name', help='aio bdev name') 505 p.set_defaults(func=bdev_aio_delete) 506 507 def bdev_uring_create(args): 508 print_json(rpc.bdev.bdev_uring_create(args.client, 509 filename=args.filename, 510 name=args.name, 511 block_size=args.block_size)) 512 513 p = subparsers.add_parser('bdev_uring_create', help='Create a bdev with io_uring backend') 514 p.add_argument('filename', help='Path to device or file (ex: /dev/nvme0n1)') 515 p.add_argument('name', help='bdev name') 516 p.add_argument('block_size', help='Block size for this bdev', type=int, nargs='?') 517 p.set_defaults(func=bdev_uring_create) 518 519 def bdev_uring_delete(args): 520 rpc.bdev.bdev_uring_delete(args.client, 521 name=args.name) 522 523 p = subparsers.add_parser('bdev_uring_delete', help='Delete a uring bdev') 524 p.add_argument('name', help='uring bdev name') 525 p.set_defaults(func=bdev_uring_delete) 526 527 def bdev_xnvme_create(args): 528 print_json(rpc.bdev.bdev_xnvme_create(args.client, 529 filename=args.filename, 530 name=args.name, 531 io_mechanism=args.io_mechanism)) 532 533 p = subparsers.add_parser('bdev_xnvme_create', help='Create a bdev with xNVMe backend') 534 p.add_argument('filename', help='Path to device or file (ex: /dev/nvme0n1)') 535 p.add_argument('name', help='name of xNVMe bdev to create') 536 p.add_argument('io_mechanism', help='IO mechanism to use (ex: libaio, io_uring, io_uring_cmd, etc.)') 537 p.add_argument('conserve_cpu', action='store_true', help='Whether or not to conserve CPU when polling') 538 p.set_defaults(func=bdev_xnvme_create) 539 540 def bdev_xnvme_delete(args): 541 rpc.bdev.bdev_xnvme_delete(args.client, 542 name=args.name) 543 544 p = subparsers.add_parser('bdev_xnvme_delete', help='Delete a xNVMe bdev') 545 p.add_argument('name', help='xNVMe bdev name') 546 p.set_defaults(func=bdev_xnvme_delete) 547 548 def bdev_nvme_set_options(args): 549 rpc.bdev.bdev_nvme_set_options(args.client, 550 action_on_timeout=args.action_on_timeout, 551 timeout_us=args.timeout_us, 552 timeout_admin_us=args.timeout_admin_us, 553 keep_alive_timeout_ms=args.keep_alive_timeout_ms, 554 retry_count=args.retry_count, 555 arbitration_burst=args.arbitration_burst, 556 low_priority_weight=args.low_priority_weight, 557 medium_priority_weight=args.medium_priority_weight, 558 high_priority_weight=args.high_priority_weight, 559 nvme_adminq_poll_period_us=args.nvme_adminq_poll_period_us, 560 nvme_ioq_poll_period_us=args.nvme_ioq_poll_period_us, 561 io_queue_requests=args.io_queue_requests, 562 delay_cmd_submit=args.delay_cmd_submit, 563 transport_retry_count=args.transport_retry_count, 564 bdev_retry_count=args.bdev_retry_count, 565 transport_ack_timeout=args.transport_ack_timeout, 566 ctrlr_loss_timeout_sec=args.ctrlr_loss_timeout_sec, 567 reconnect_delay_sec=args.reconnect_delay_sec, 568 fast_io_fail_timeout_sec=args.fast_io_fail_timeout_sec, 569 disable_auto_failback=args.disable_auto_failback, 570 generate_uuids=args.generate_uuids, 571 transport_tos=args.transport_tos, 572 nvme_error_stat=args.nvme_error_stat, 573 rdma_srq_size=args.rdma_srq_size, 574 io_path_stat=args.io_path_stat, 575 allow_accel_sequence=args.allow_accel_sequence, 576 rdma_max_cq_size=args.rdma_max_cq_size) 577 578 p = subparsers.add_parser('bdev_nvme_set_options', 579 help='Set options for the bdev nvme type. This is startup command.') 580 p.add_argument('-a', '--action-on-timeout', 581 help="Action to take on command time out. Valid values are: none, reset, abort") 582 p.add_argument('-t', '--timeout-us', 583 help="Timeout for each command, in microseconds. If 0, don't track timeouts.", type=int) 584 p.add_argument('--timeout-admin-us', 585 help="Timeout for each admin command, in microseconds. If 0, treat same as io timeouts.", type=int) 586 p.add_argument('-k', '--keep-alive-timeout-ms', 587 help="Keep alive timeout period in millisecond. If 0, disable keep-alive.", type=int) 588 p.add_argument('-n', '--retry-count', 589 help='the number of attempts per I/O when an I/O fails. (deprecated, please use --transport-retry-count.)', type=int) 590 p.add_argument('--arbitration-burst', 591 help='the value is expressed as a power of two', type=int) 592 p.add_argument('--low-priority-weight', 593 help='the maximum number of commands that the controller may launch at one time from a low priority queue', type=int) 594 p.add_argument('--medium-priority-weight', 595 help='the maximum number of commands that the controller may launch at one time from a medium priority queue', type=int) 596 p.add_argument('--high-priority-weight', 597 help='the maximum number of commands that the controller may launch at one time from a high priority queue', type=int) 598 p.add_argument('-p', '--nvme-adminq-poll-period-us', 599 help='How often the admin queue is polled for asynchronous events', type=int) 600 p.add_argument('-i', '--nvme-ioq-poll-period-us', 601 help='How often to poll I/O queues for completions', type=int) 602 p.add_argument('-s', '--io-queue-requests', 603 help='The number of requests allocated for each NVMe I/O queue. Default: 512', type=int) 604 p.add_argument('-d', '--disable-delay-cmd-submit', 605 help='Disable delaying NVMe command submission, i.e. no batching of multiple commands', 606 action='store_false', dest='delay_cmd_submit') 607 p.add_argument('-c', '--transport-retry-count', 608 help='the number of attempts per I/O in the transport layer when an I/O fails.', type=int) 609 p.add_argument('-r', '--bdev-retry-count', 610 help='the number of attempts per I/O in the bdev layer when an I/O fails. -1 means infinite retries.', type=int) 611 p.add_argument('-e', '--transport-ack-timeout', 612 help="""Time to wait ack until packet retransmission for RDMA or until closes connection for TCP. 613 Range 0-31 where 0 is driver-specific default value.""", type=int) 614 p.add_argument('-l', '--ctrlr-loss-timeout-sec', 615 help="""Time to wait until ctrlr is reconnected before deleting ctrlr. 616 -1 means infinite reconnect retries. 0 means no reconnect retry. 617 If reconnect_delay_sec is zero, ctrlr_loss_timeout_sec has to be zero. 618 If reconnect_delay_sec is non-zero, ctrlr_loss_timeout_sec has to be -1 or not less than 619 reconnect_delay_sec. 620 This can be overridden by bdev_nvme_attach_controller.""", 621 type=int) 622 p.add_argument('-o', '--reconnect-delay-sec', 623 help="""Time to delay a reconnect retry. 624 If ctrlr_loss_timeout_sec is zero, reconnect_delay_sec has to be zero. 625 If ctrlr_loss_timeout_sec is -1, reconnect_delay_sec has to be non-zero. 626 If ctrlr_loss_timeout_sec is not -1 or zero, reconnect_delay_sec has to be non-zero and 627 less than ctrlr_loss_timeout_sec. 628 This can be overridden by bdev_nvme_attach_controller.""", 629 type=int) 630 p.add_argument('-u', '--fast-io-fail-timeout-sec', 631 help="""Time to wait until ctrlr is reconnected before failing I/O to ctrlr. 632 0 means no such timeout. 633 If fast_io_fail_timeout_sec is not zero, it has to be not less than reconnect_delay_sec and 634 less than ctrlr_loss_timeout_sec if ctrlr_loss_timeout_sec is not -1. 635 This can be overridden by bdev_nvme_attach_controller.""", 636 type=int) 637 p.add_argument('-f', '--disable-auto-failback', 638 help="""Disable automatic failback. bdev_nvme_set_preferred_path can be used to do manual failback. 639 By default, immediately failback to the preferred I/O path if it restored.""", 640 action='store_true') 641 p.add_argument('--generate-uuids', 642 help="""Enable generation of unique identifiers for NVMe bdevs only if they do 643 not provide UUID themselves. These strings are based on device serial number and 644 namespace ID and will always be the same for that device.""", action='store_true') 645 p.add_argument('--transport-tos', 646 help="""IPv4 Type of Service value. Only applicable for RDMA transports. 647 The default is 0 which means no TOS is applied.""", type=int) 648 p.add_argument('-m', '--nvme-error-stat', help="Enable collecting NVMe error counts.", action='store_true') 649 p.add_argument('-q', '--rdma-srq-size', 650 help='Set the size of a shared rdma receive queue. Default: 0 (disabled)', type=int) 651 p.add_argument('--io-path-stat', 652 help="""Enable collecting I/O path stat of each io path.""", 653 action='store_true') 654 p.add_argument('--allow-accel-sequence', 655 help='''Allow NVMe bdevs to advertise support for accel sequences if the 656 controller also supports them.''', action='store_true') 657 p.add_argument('--rdma-max-cq-size', 658 help='The maximum size of a rdma completion queue. Default: 0 (unlimited)', type=int) 659 660 p.set_defaults(func=bdev_nvme_set_options) 661 662 def bdev_nvme_set_hotplug(args): 663 rpc.bdev.bdev_nvme_set_hotplug(args.client, enable=args.enable, period_us=args.period_us) 664 665 p = subparsers.add_parser('bdev_nvme_set_hotplug', help='Set hotplug options for bdev nvme type.') 666 p.add_argument('-d', '--disable', dest='enable', default=False, action='store_false', help="Disable hotplug (default)") 667 p.add_argument('-e', '--enable', dest='enable', action='store_true', help="Enable hotplug") 668 p.add_argument('-r', '--period-us', 669 help='How often the hotplug is processed for insert and remove events', type=int) 670 p.set_defaults(func=bdev_nvme_set_hotplug) 671 672 def bdev_nvme_attach_controller(args): 673 print_array(rpc.bdev.bdev_nvme_attach_controller(args.client, 674 name=args.name, 675 trtype=args.trtype, 676 traddr=args.traddr, 677 adrfam=args.adrfam, 678 trsvcid=args.trsvcid, 679 priority=args.priority, 680 subnqn=args.subnqn, 681 hostnqn=args.hostnqn, 682 hostaddr=args.hostaddr, 683 hostsvcid=args.hostsvcid, 684 prchk_reftag=args.prchk_reftag, 685 prchk_guard=args.prchk_guard, 686 hdgst=args.hdgst, 687 ddgst=args.ddgst, 688 fabrics_timeout=args.fabrics_timeout, 689 multipath=args.multipath, 690 num_io_queues=args.num_io_queues, 691 ctrlr_loss_timeout_sec=args.ctrlr_loss_timeout_sec, 692 reconnect_delay_sec=args.reconnect_delay_sec, 693 fast_io_fail_timeout_sec=args.fast_io_fail_timeout_sec, 694 psk=args.psk, 695 max_bdevs=args.max_bdevs)) 696 697 p = subparsers.add_parser('bdev_nvme_attach_controller', help='Add bdevs with nvme backend') 698 p.add_argument('-b', '--name', help="Name of the NVMe controller, prefix for each bdev name", required=True) 699 p.add_argument('-t', '--trtype', 700 help='NVMe-oF target trtype: e.g., rdma, pcie', required=True) 701 p.add_argument('-a', '--traddr', 702 help='NVMe-oF target address: e.g., an ip address or BDF', required=True) 703 p.add_argument('-f', '--adrfam', 704 help='NVMe-oF target adrfam: e.g., ipv4, ipv6, ib, fc, intra_host') 705 p.add_argument('-s', '--trsvcid', 706 help='NVMe-oF target trsvcid: e.g., a port number') 707 p.add_argument('-p', '--priority', 708 help='NVMe-oF connection priority: e.g., a priority number') 709 p.add_argument('-n', '--subnqn', help='NVMe-oF target subnqn') 710 p.add_argument('-q', '--hostnqn', help='NVMe-oF host subnqn') 711 p.add_argument('-i', '--hostaddr', 712 help='NVMe-oF host address: e.g., an ip address') 713 p.add_argument('-c', '--hostsvcid', 714 help='NVMe-oF host svcid: e.g., a port number') 715 p.add_argument('-r', '--prchk-reftag', 716 help='Enable checking of PI reference tag for I/O processing.', action='store_true') 717 p.add_argument('-g', '--prchk-guard', 718 help='Enable checking of PI guard for I/O processing.', action='store_true') 719 p.add_argument('-e', '--hdgst', 720 help='Enable TCP header digest.', action='store_true') 721 p.add_argument('-d', '--ddgst', 722 help='Enable TCP data digest.', action='store_true') 723 p.add_argument('--fabrics-timeout', type=int, help='Fabrics connect timeout in microseconds') 724 p.add_argument('-x', '--multipath', help='Set multipath behavior (disable, failover, multipath)') 725 p.add_argument('--num-io-queues', type=int, help='Set the number of IO queues to request during initialization.') 726 p.add_argument('-l', '--ctrlr-loss-timeout-sec', 727 help="""Time to wait until ctrlr is reconnected before deleting ctrlr. 728 -1 means infinite reconnect retries. 0 means no reconnect retry. 729 If reconnect_delay_sec is zero, ctrlr_loss_timeout_sec has to be zero. 730 If reconnect_delay_sec is non-zero, ctrlr_loss_timeout_sec has to be -1 or not less than 731 reconnect_delay_sec.""", 732 type=int) 733 p.add_argument('-o', '--reconnect-delay-sec', 734 help="""Time to delay a reconnect retry. 735 If ctrlr_loss_timeout_sec is zero, reconnect_delay_sec has to be zero. 736 If ctrlr_loss_timeout_sec is -1, reconnect_delay_sec has to be non-zero. 737 If ctrlr_loss_timeout_sec is not -1 or zero, reconnect_delay_sec has to be non-zero and 738 less than ctrlr_loss_timeout_sec.""", 739 type=int) 740 p.add_argument('-u', '--fast-io-fail-timeout-sec', 741 help="""Time to wait until ctrlr is reconnected before failing I/O to ctrlr. 742 0 means no such timeout. 743 If fast_io_fail_timeout_sec is not zero, it has to be not less than reconnect_delay_sec and 744 less than ctrlr_loss_timeout_sec if ctrlr_loss_timeout_sec is not -1.""", 745 type=int) 746 p.add_argument('-k', '--psk', 747 help='Set PSK file path and enable TCP SSL socket implementation.') 748 p.add_argument('-m', '--max-bdevs', type=int, 749 help='The size of the name array for newly created bdevs. Default is 128',) 750 751 p.set_defaults(func=bdev_nvme_attach_controller) 752 753 def bdev_nvme_get_controllers(args): 754 print_dict(rpc.nvme.bdev_nvme_get_controllers(args.client, 755 name=args.name)) 756 757 p = subparsers.add_parser( 758 'bdev_nvme_get_controllers', help='Display current NVMe controllers list or required NVMe controller') 759 p.add_argument('-n', '--name', help="Name of the NVMe controller. Example: Nvme0", required=False) 760 p.set_defaults(func=bdev_nvme_get_controllers) 761 762 def bdev_nvme_detach_controller(args): 763 rpc.bdev.bdev_nvme_detach_controller(args.client, 764 name=args.name, 765 trtype=args.trtype, 766 traddr=args.traddr, 767 adrfam=args.adrfam, 768 trsvcid=args.trsvcid, 769 subnqn=args.subnqn, 770 hostaddr=args.hostaddr, 771 hostsvcid=args.hostsvcid) 772 773 p = subparsers.add_parser('bdev_nvme_detach_controller', 774 help='Detach an NVMe controller and delete any associated bdevs') 775 p.add_argument('name', help="Name of the controller") 776 p.add_argument('-t', '--trtype', 777 help='NVMe-oF target trtype: e.g., rdma, pcie') 778 p.add_argument('-a', '--traddr', 779 help='NVMe-oF target address: e.g., an ip address or BDF') 780 p.add_argument('-f', '--adrfam', 781 help='NVMe-oF target adrfam: e.g., ipv4, ipv6, ib, fc, intra_host') 782 p.add_argument('-s', '--trsvcid', 783 help='NVMe-oF target trsvcid: e.g., a port number') 784 p.add_argument('-n', '--subnqn', help='NVMe-oF target subnqn') 785 p.add_argument('-i', '--hostaddr', 786 help='NVMe-oF host address: e.g., an ip address') 787 p.add_argument('-c', '--hostsvcid', 788 help='NVMe-oF host svcid: e.g., a port number') 789 p.set_defaults(func=bdev_nvme_detach_controller) 790 791 def bdev_nvme_reset_controller(args): 792 rpc.bdev.bdev_nvme_reset_controller(args.client, 793 name=args.name, 794 cntlid=args.cntlid) 795 796 p = subparsers.add_parser('bdev_nvme_reset_controller', 797 help='Reset an NVMe controller or all NVMe controllers in an NVMe bdev controller') 798 p.add_argument('name', help="Name of the NVMe controller") 799 p.add_argument('-c', '--cntlid', help="NVMe controller ID", type=int) 800 p.set_defaults(func=bdev_nvme_reset_controller) 801 802 def bdev_nvme_enable_controller(args): 803 rpc.bdev.bdev_nvme_enable_controller(args.client, 804 name=args.name, 805 cntlid=args.cntlid) 806 807 p = subparsers.add_parser('bdev_nvme_enable_controller', 808 help='Enable an NVMe controller or all NVMe controllers in an NVMe bdev controller') 809 p.add_argument('name', help="Name of the NVMe controller") 810 p.add_argument('-c', '--cntlid', help="NVMe controller ID", type=int) 811 p.set_defaults(func=bdev_nvme_enable_controller) 812 813 def bdev_nvme_disable_controller(args): 814 rpc.bdev.bdev_nvme_disable_controller(args.client, 815 name=args.name, 816 cntlid=args.cntlid) 817 818 p = subparsers.add_parser('bdev_nvme_disable_controller', 819 help='Disable an NVMe controller or all NVMe controllers in an NVMe bdev controller') 820 p.add_argument('name', help="Name of the NVMe controller") 821 p.add_argument('-c', '--cntlid', help="NVMe controller ID", type=int) 822 p.set_defaults(func=bdev_nvme_disable_controller) 823 824 def bdev_nvme_start_discovery(args): 825 rpc.bdev.bdev_nvme_start_discovery(args.client, 826 name=args.name, 827 trtype=args.trtype, 828 traddr=args.traddr, 829 adrfam=args.adrfam, 830 trsvcid=args.trsvcid, 831 hostnqn=args.hostnqn, 832 wait_for_attach=args.wait_for_attach, 833 attach_timeout_ms=args.attach_timeout_ms, 834 ctrlr_loss_timeout_sec=args.ctrlr_loss_timeout_sec, 835 reconnect_delay_sec=args.reconnect_delay_sec, 836 fast_io_fail_timeout_sec=args.fast_io_fail_timeout_sec) 837 838 p = subparsers.add_parser('bdev_nvme_start_discovery', help='Start automatic discovery') 839 p.add_argument('-b', '--name', help="Name of the NVMe controller prefix for each bdev name", required=True) 840 p.add_argument('-t', '--trtype', 841 help='NVMe-oF target trtype: e.g., rdma, pcie', required=True) 842 p.add_argument('-a', '--traddr', 843 help='NVMe-oF target address: e.g., an ip address or BDF', required=True) 844 p.add_argument('-f', '--adrfam', 845 help='NVMe-oF target adrfam: e.g., ipv4, ipv6, ib, fc, intra_host') 846 p.add_argument('-s', '--trsvcid', 847 help='NVMe-oF target trsvcid: e.g., a port number') 848 p.add_argument('-q', '--hostnqn', help='NVMe-oF host subnqn') 849 p.add_argument('-w', '--wait-for-attach', action='store_true', 850 help='Do not complete RPC until all discovered NVM subsystems are attached') 851 p.add_argument('-T', '--attach-timeout-ms', type=int, required=False, 852 help="""Time to wait until the discovery and all discovered NVM subsystems 853 are attached (default: 0, meaning wait indefinitely). Automatically 854 selects the --wait-for-attach option.""") 855 p.add_argument('-l', '--ctrlr-loss-timeout-sec', 856 help="""Time to wait until ctrlr is reconnected before deleting ctrlr. 857 -1 means infinite reconnect retries. 0 means no reconnect retry. 858 If reconnect_delay_sec is zero, ctrlr_loss_timeout_sec has to be zero. 859 If reconnect_delay_sec is non-zero, ctrlr_loss_timeout_sec has to be -1 or not less than 860 reconnect_delay_sec.""", 861 type=int) 862 p.add_argument('-o', '--reconnect-delay-sec', 863 help="""Time to delay a reconnect retry. 864 If ctrlr_loss_timeout_sec is zero, reconnect_delay_sec has to be zero. 865 If ctrlr_loss_timeout_sec is -1, reconnect_delay_sec has to be non-zero. 866 If ctrlr_loss_timeout_sec is not -1 or zero, reconnect_delay_sec has to be non-zero and 867 less than ctrlr_loss_timeout_sec.""", 868 type=int) 869 p.add_argument('-u', '--fast-io-fail-timeout-sec', 870 help="""Time to wait until ctrlr is reconnected before failing I/O to ctrlr. 871 0 means no such timeout. 872 If fast_io_fail_timeout_sec is not zero, it has to be not less than reconnect_delay_sec and 873 less than ctrlr_loss_timeout_sec if ctrlr_loss_timeout_sec is not -1.""", 874 type=int) 875 p.set_defaults(func=bdev_nvme_start_discovery) 876 877 def bdev_nvme_stop_discovery(args): 878 rpc.bdev.bdev_nvme_stop_discovery(args.client, name=args.name) 879 880 p = subparsers.add_parser('bdev_nvme_stop_discovery', help='Stop automatic discovery') 881 p.add_argument('-b', '--name', help="Name of the service to stop", required=True) 882 p.set_defaults(func=bdev_nvme_stop_discovery) 883 884 def bdev_nvme_get_discovery_info(args): 885 print_dict(rpc.bdev.bdev_nvme_get_discovery_info(args.client)) 886 887 p = subparsers.add_parser('bdev_nvme_get_discovery_info', help='Get information about the automatic discovery') 888 p.set_defaults(func=bdev_nvme_get_discovery_info) 889 890 def bdev_nvme_get_io_paths(args): 891 print_dict(rpc.bdev.bdev_nvme_get_io_paths(args.client, name=args.name)) 892 893 p = subparsers.add_parser('bdev_nvme_get_io_paths', help='Display active I/O paths') 894 p.add_argument('-n', '--name', help="Name of the NVMe bdev", required=False) 895 p.set_defaults(func=bdev_nvme_get_io_paths) 896 897 def bdev_nvme_set_preferred_path(args): 898 rpc.bdev.bdev_nvme_set_preferred_path(args.client, 899 name=args.name, 900 cntlid=args.cntlid) 901 902 p = subparsers.add_parser('bdev_nvme_set_preferred_path', 903 help="""Set the preferred I/O path for an NVMe bdev when in multipath mode""") 904 p.add_argument('-b', '--name', help='Name of the NVMe bdev', required=True) 905 p.add_argument('-c', '--cntlid', help='NVMe-oF controller ID', type=int, required=True) 906 p.set_defaults(func=bdev_nvme_set_preferred_path) 907 908 def bdev_nvme_set_multipath_policy(args): 909 rpc.bdev.bdev_nvme_set_multipath_policy(args.client, 910 name=args.name, 911 policy=args.policy, 912 selector=args.selector, 913 rr_min_io=args.rr_min_io) 914 915 p = subparsers.add_parser('bdev_nvme_set_multipath_policy', 916 help="""Set multipath policy of the NVMe bdev""") 917 p.add_argument('-b', '--name', help='Name of the NVMe bdev', required=True) 918 p.add_argument('-p', '--policy', help='Multipath policy (active_passive or active_active)', required=True) 919 p.add_argument('-s', '--selector', help='Multipath selector (round_robin, queue_depth)', required=False) 920 p.add_argument('-r', '--rr-min-io', 921 help='Number of IO to route to a path before switching to another for round-robin', 922 type=int, required=False) 923 p.set_defaults(func=bdev_nvme_set_multipath_policy) 924 925 def bdev_nvme_get_path_iostat(args): 926 print_dict(rpc.bdev.bdev_nvme_get_path_iostat(args.client, 927 name=args.name)) 928 929 p = subparsers.add_parser('bdev_nvme_get_path_iostat', 930 help="""Display current I/O statistics of all the IO paths of the blockdev. It can be 931 called when io_path_stat is true.""") 932 p.add_argument('-b', '--name', help="Name of the Blockdev. Example: NVMe0n1", required=True) 933 p.set_defaults(func=bdev_nvme_get_path_iostat) 934 935 def bdev_nvme_cuse_register(args): 936 rpc.bdev.bdev_nvme_cuse_register(args.client, 937 name=args.name) 938 939 p = subparsers.add_parser('bdev_nvme_cuse_register', 940 help='Register CUSE devices on NVMe controller') 941 p.add_argument('-n', '--name', 942 help='Name of the NVMe controller. Example: Nvme0', required=True) 943 p.set_defaults(func=bdev_nvme_cuse_register) 944 945 def bdev_nvme_cuse_unregister(args): 946 rpc.bdev.bdev_nvme_cuse_unregister(args.client, 947 name=args.name) 948 949 p = subparsers.add_parser('bdev_nvme_cuse_unregister', 950 help='Unregister CUSE devices on NVMe controller') 951 p.add_argument('-n', '--name', 952 help='Name of the NVMe controller. Example: Nvme0', required=True) 953 p.set_defaults(func=bdev_nvme_cuse_unregister) 954 955 def bdev_zone_block_create(args): 956 print_json(rpc.bdev.bdev_zone_block_create(args.client, 957 name=args.name, 958 base_bdev=args.base_bdev, 959 zone_capacity=args.zone_capacity, 960 optimal_open_zones=args.optimal_open_zones)) 961 962 p = subparsers.add_parser('bdev_zone_block_create', 963 help='Create virtual zone namespace device with block device backend') 964 p.add_argument('-b', '--name', help="Name of the zone device", required=True) 965 p.add_argument('-n', '--base-bdev', help='Name of underlying, non-zoned bdev', required=True) 966 p.add_argument('-z', '--zone-capacity', help='Surfaced zone capacity in blocks', type=int, required=True) 967 p.add_argument('-o', '--optimal-open-zones', help='Number of zones required to reach optimal write speed', type=int, required=True) 968 p.set_defaults(func=bdev_zone_block_create) 969 970 def bdev_zone_block_delete(args): 971 rpc.bdev.bdev_zone_block_delete(args.client, 972 name=args.name) 973 974 p = subparsers.add_parser('bdev_zone_block_delete', help='Delete a virtual zone namespace device') 975 p.add_argument('name', help='Virtual zone bdev name') 976 p.set_defaults(func=bdev_zone_block_delete) 977 978 def bdev_rbd_register_cluster(args): 979 config_param = None 980 if args.config_param: 981 config_param = {} 982 for entry in args.config_param: 983 parts = entry.split('=', 1) 984 if len(parts) != 2: 985 raise Exception('--config %s not in key=value form' % entry) 986 config_param[parts[0]] = parts[1] 987 print_json(rpc.bdev.bdev_rbd_register_cluster(args.client, 988 name=args.name, 989 user=args.user, 990 config_param=config_param, 991 config_file=args.config_file, 992 key_file=args.key_file, 993 core_mask=args.core_mask)) 994 995 p = subparsers.add_parser('bdev_rbd_register_cluster', 996 help='Add a Rados cluster with ceph rbd backend') 997 p.add_argument('name', help="Name of the Rados cluster only known to rbd bdev") 998 p.add_argument('--user', help="Ceph user name (i.e. admin, not client.admin)", required=False) 999 p.add_argument('--config-param', action='append', metavar='key=value', 1000 help="adds a key=value configuration option for rados_conf_set (default: rely on config file)") 1001 p.add_argument('--config-file', help="The file path of the Rados configuration file", required=False) 1002 p.add_argument('--key-file', help="The file path of the Rados keyring file", required=False) 1003 p.add_argument('--core-mask', help="Set core mask for librbd IO context threads", required=False) 1004 p.set_defaults(func=bdev_rbd_register_cluster) 1005 1006 def bdev_rbd_unregister_cluster(args): 1007 rpc.bdev.bdev_rbd_unregister_cluster(args.client, name=args.name) 1008 1009 p = subparsers.add_parser('bdev_rbd_unregister_cluster', 1010 help='Unregister a Rados cluster object') 1011 p.add_argument('name', help='Name of the Rados Cluster only known to rbd bdev') 1012 p.set_defaults(func=bdev_rbd_unregister_cluster) 1013 1014 def bdev_rbd_get_clusters_info(args): 1015 print_json(rpc.bdev.bdev_rbd_get_clusters_info(args.client, name=args.name)) 1016 1017 p = subparsers.add_parser('bdev_rbd_get_clusters_info', 1018 help='Display registered Rados Cluster names and related info') 1019 p.add_argument('-b', '--name', help="Name of the registered Rados Cluster Name. Example: Cluster1", required=False) 1020 p.set_defaults(func=bdev_rbd_get_clusters_info) 1021 1022 def bdev_rbd_create(args): 1023 config = None 1024 if args.config: 1025 config = {} 1026 for entry in args.config: 1027 parts = entry.split('=', 1) 1028 if len(parts) != 2: 1029 raise Exception('--config %s not in key=value form' % entry) 1030 config[parts[0]] = parts[1] 1031 print_json(rpc.bdev.bdev_rbd_create(args.client, 1032 name=args.name, 1033 user=args.user, 1034 config=config, 1035 pool_name=args.pool_name, 1036 rbd_name=args.rbd_name, 1037 block_size=args.block_size, 1038 cluster_name=args.cluster_name, 1039 uuid=args.uuid)) 1040 1041 p = subparsers.add_parser('bdev_rbd_create', help='Add a bdev with ceph rbd backend') 1042 p.add_argument('-b', '--name', help="Name of the bdev", required=False) 1043 p.add_argument('--user', help="Ceph user name (i.e. admin, not client.admin)", required=False) 1044 p.add_argument('--config', action='append', metavar='key=value', 1045 help="adds a key=value configuration option for rados_conf_set (default: rely on config file)") 1046 p.add_argument('pool_name', help='rbd pool name') 1047 p.add_argument('rbd_name', help='rbd image name') 1048 p.add_argument('block_size', help='rbd block size', type=int) 1049 p.add_argument('-c', '--cluster-name', help="cluster name to identify the Rados cluster", required=False) 1050 p.add_argument('-u', '--uuid', help="UUID of the bdev") 1051 p.set_defaults(func=bdev_rbd_create) 1052 1053 def bdev_rbd_delete(args): 1054 rpc.bdev.bdev_rbd_delete(args.client, 1055 name=args.name) 1056 1057 p = subparsers.add_parser('bdev_rbd_delete', help='Delete a rbd bdev') 1058 p.add_argument('name', help='rbd bdev name') 1059 p.set_defaults(func=bdev_rbd_delete) 1060 1061 def bdev_rbd_resize(args): 1062 print_json(rpc.bdev.bdev_rbd_resize(args.client, 1063 name=args.name, 1064 new_size=int(args.new_size))) 1065 1066 p = subparsers.add_parser('bdev_rbd_resize', 1067 help='Resize a rbd bdev') 1068 p.add_argument('name', help='rbd bdev name') 1069 p.add_argument('new_size', help='new bdev size for resize operation. The unit is MiB') 1070 p.set_defaults(func=bdev_rbd_resize) 1071 1072 def bdev_delay_create(args): 1073 print_json(rpc.bdev.bdev_delay_create(args.client, 1074 base_bdev_name=args.base_bdev_name, 1075 name=args.name, 1076 uuid=args.uuid, 1077 avg_read_latency=args.avg_read_latency, 1078 p99_read_latency=args.nine_nine_read_latency, 1079 avg_write_latency=args.avg_write_latency, 1080 p99_write_latency=args.nine_nine_write_latency)) 1081 1082 p = subparsers.add_parser('bdev_delay_create', 1083 help='Add a delay bdev on existing bdev') 1084 p.add_argument('-b', '--base-bdev-name', help="Name of the existing bdev", required=True) 1085 p.add_argument('-d', '--name', help="Name of the delay bdev", required=True) 1086 p.add_argument('-u', '--uuid', help='UUID of the bdev (optional)') 1087 p.add_argument('-r', '--avg-read-latency', 1088 help="Average latency to apply before completing read ops (in microseconds)", required=True, type=int) 1089 p.add_argument('-t', '--nine-nine-read-latency', 1090 help="latency to apply to 1 in 100 read ops (in microseconds)", required=True, type=int) 1091 p.add_argument('-w', '--avg-write-latency', 1092 help="Average latency to apply before completing write ops (in microseconds)", required=True, type=int) 1093 p.add_argument('-n', '--nine-nine-write-latency', 1094 help="latency to apply to 1 in 100 write ops (in microseconds)", required=True, type=int) 1095 p.set_defaults(func=bdev_delay_create) 1096 1097 def bdev_delay_delete(args): 1098 rpc.bdev.bdev_delay_delete(args.client, 1099 name=args.name) 1100 1101 p = subparsers.add_parser('bdev_delay_delete', help='Delete a delay bdev') 1102 p.add_argument('name', help='delay bdev name') 1103 p.set_defaults(func=bdev_delay_delete) 1104 1105 def bdev_delay_update_latency(args): 1106 print_json(rpc.bdev.bdev_delay_update_latency(args.client, 1107 delay_bdev_name=args.delay_bdev_name, 1108 latency_type=args.latency_type, 1109 latency_us=args.latency_us)) 1110 p = subparsers.add_parser('bdev_delay_update_latency', 1111 help='Update one of the latency values for a given delay bdev') 1112 p.add_argument('delay_bdev_name', help='The name of the given delay bdev') 1113 p.add_argument('latency_type', help='one of: avg_read, avg_write, p99_read, p99_write. No other values accepted.') 1114 p.add_argument('latency_us', help='new latency value in microseconds.', type=int) 1115 p.set_defaults(func=bdev_delay_update_latency) 1116 1117 def bdev_error_create(args): 1118 print_json(rpc.bdev.bdev_error_create(args.client, 1119 base_name=args.base_name, 1120 uuid=args.uuid)) 1121 1122 p = subparsers.add_parser('bdev_error_create', help='Add bdev with error injection backend') 1123 p.add_argument('base_name', help='base bdev name') 1124 p.add_argument('--uuid', help='UUID for this bdev', required=False) 1125 p.set_defaults(func=bdev_error_create) 1126 1127 def bdev_error_delete(args): 1128 rpc.bdev.bdev_error_delete(args.client, 1129 name=args.name) 1130 1131 p = subparsers.add_parser('bdev_error_delete', help='Delete an error bdev') 1132 p.add_argument('name', help='error bdev name') 1133 p.set_defaults(func=bdev_error_delete) 1134 1135 def bdev_iscsi_set_options(args): 1136 rpc.bdev.bdev_iscsi_set_options(args.client, 1137 timeout_sec=args.timeout_sec) 1138 1139 p = subparsers.add_parser('bdev_iscsi_set_options', help='Set options for the bdev iscsi type.') 1140 p.add_argument('-t', '--timeout-sec', help="Timeout for command, in seconds, if 0, don't track timeout.", type=int) 1141 p.set_defaults(func=bdev_iscsi_set_options) 1142 1143 def bdev_iscsi_create(args): 1144 print_json(rpc.bdev.bdev_iscsi_create(args.client, 1145 name=args.name, 1146 url=args.url, 1147 initiator_iqn=args.initiator_iqn)) 1148 1149 p = subparsers.add_parser('bdev_iscsi_create', 1150 help='Add bdev with iSCSI initiator backend') 1151 p.add_argument('-b', '--name', help="Name of the bdev", required=True) 1152 p.add_argument('-i', '--initiator-iqn', help="Initiator IQN", required=True) 1153 p.add_argument('--url', help="iSCSI Lun URL", required=True) 1154 p.set_defaults(func=bdev_iscsi_create) 1155 1156 def bdev_iscsi_delete(args): 1157 rpc.bdev.bdev_iscsi_delete(args.client, 1158 name=args.name) 1159 1160 p = subparsers.add_parser('bdev_iscsi_delete', help='Delete an iSCSI bdev') 1161 p.add_argument('name', help='iSCSI bdev name') 1162 p.set_defaults(func=bdev_iscsi_delete) 1163 1164 def bdev_passthru_create(args): 1165 print_json(rpc.bdev.bdev_passthru_create(args.client, 1166 base_bdev_name=args.base_bdev_name, 1167 name=args.name, 1168 uuid=args.uuid)) 1169 1170 p = subparsers.add_parser('bdev_passthru_create', help='Add a pass through bdev on existing bdev') 1171 p.add_argument('-b', '--base-bdev-name', help="Name of the existing bdev", required=True) 1172 p.add_argument('-p', '--name', help="Name of the pass through bdev", required=True) 1173 p.add_argument('-u', '--uuid', help="UUID of the bdev") 1174 p.set_defaults(func=bdev_passthru_create) 1175 1176 def bdev_passthru_delete(args): 1177 rpc.bdev.bdev_passthru_delete(args.client, 1178 name=args.name) 1179 1180 p = subparsers.add_parser('bdev_passthru_delete', help='Delete a pass through bdev') 1181 p.add_argument('name', help='pass through bdev name') 1182 p.set_defaults(func=bdev_passthru_delete) 1183 1184 def bdev_get_bdevs(args): 1185 print_dict(rpc.bdev.bdev_get_bdevs(args.client, 1186 name=args.name, timeout=args.timeout_ms)) 1187 1188 p = subparsers.add_parser('bdev_get_bdevs', 1189 help='Display current blockdev list or required blockdev') 1190 p.add_argument('-b', '--name', help="Name of the Blockdev. Example: Nvme0n1", required=False) 1191 p.add_argument('-t', '--timeout-ms', help="""Time in ms to wait for the bdev to appear (only used 1192 with the -b|--name option). The default timeout is 0, meaning the RPC returns immediately 1193 whether the bdev exists or not.""", 1194 type=int, required=False) 1195 p.set_defaults(func=bdev_get_bdevs) 1196 1197 def bdev_get_iostat(args): 1198 print_dict(rpc.bdev.bdev_get_iostat(args.client, 1199 name=args.name, 1200 per_channel=args.per_channel)) 1201 1202 p = subparsers.add_parser('bdev_get_iostat', 1203 help='Display current I/O statistics of all the blockdevs or specified blockdev.') 1204 p.add_argument('-b', '--name', help="Name of the Blockdev. Example: Nvme0n1", required=False) 1205 p.add_argument('-c', '--per-channel', default=False, dest='per_channel', help='Display per channel IO stats for specified device', 1206 action='store_true', required=False) 1207 p.set_defaults(func=bdev_get_iostat) 1208 1209 def bdev_reset_iostat(args): 1210 rpc.bdev.bdev_reset_iostat(args.client, name=args.name, mode=args.mode) 1211 1212 p = subparsers.add_parser('bdev_reset_iostat', 1213 help='Reset I/O statistics of all the blockdevs or specified blockdev.') 1214 p.add_argument('-b', '--name', help="Name of the Blockdev. Example: Nvme0n1", required=False) 1215 p.add_argument('-m', '--mode', help="Mode to reset I/O statistics", choices=['all', 'maxmin'], required=False) 1216 p.set_defaults(func=bdev_reset_iostat) 1217 1218 def bdev_enable_histogram(args): 1219 rpc.bdev.bdev_enable_histogram(args.client, name=args.name, enable=args.enable) 1220 1221 p = subparsers.add_parser('bdev_enable_histogram', 1222 help='Enable or disable histogram for specified bdev') 1223 p.add_argument('-e', '--enable', default=True, dest='enable', action='store_true', help='Enable histograms on specified device') 1224 p.add_argument('-d', '--disable', dest='enable', action='store_false', help='Disable histograms on specified device') 1225 p.add_argument('name', help='bdev name') 1226 p.set_defaults(func=bdev_enable_histogram) 1227 1228 def bdev_get_histogram(args): 1229 print_dict(rpc.bdev.bdev_get_histogram(args.client, name=args.name)) 1230 1231 p = subparsers.add_parser('bdev_get_histogram', 1232 help='Get histogram for specified bdev') 1233 p.add_argument('name', help='bdev name') 1234 p.set_defaults(func=bdev_get_histogram) 1235 1236 def bdev_set_qd_sampling_period(args): 1237 rpc.bdev.bdev_set_qd_sampling_period(args.client, 1238 name=args.name, 1239 period=args.period) 1240 1241 p = subparsers.add_parser('bdev_set_qd_sampling_period', 1242 help="Enable or disable tracking of a bdev's queue depth.") 1243 p.add_argument('name', help='Blockdev name. Example: Malloc0') 1244 p.add_argument('period', help='Period with which to poll the block device queue depth in microseconds.' 1245 ' If set to 0, polling will be disabled.', 1246 type=int) 1247 p.set_defaults(func=bdev_set_qd_sampling_period) 1248 1249 def bdev_set_qos_limit(args): 1250 rpc.bdev.bdev_set_qos_limit(args.client, 1251 name=args.name, 1252 rw_ios_per_sec=args.rw_ios_per_sec, 1253 rw_mbytes_per_sec=args.rw_mbytes_per_sec, 1254 r_mbytes_per_sec=args.r_mbytes_per_sec, 1255 w_mbytes_per_sec=args.w_mbytes_per_sec) 1256 1257 p = subparsers.add_parser('bdev_set_qos_limit', 1258 help='Set QoS rate limit on a blockdev') 1259 p.add_argument('name', help='Blockdev name to set QoS. Example: Malloc0') 1260 p.add_argument('--rw-ios-per-sec', 1261 help='R/W IOs per second limit (>=1000, example: 20000). 0 means unlimited.', 1262 type=int, required=False) 1263 p.add_argument('--rw-mbytes-per-sec', 1264 help="R/W megabytes per second limit (>=10, example: 100). 0 means unlimited.", 1265 type=int, required=False) 1266 p.add_argument('--r-mbytes-per-sec', 1267 help="Read megabytes per second limit (>=10, example: 100). 0 means unlimited.", 1268 type=int, required=False) 1269 p.add_argument('--w-mbytes-per-sec', 1270 help="Write megabytes per second limit (>=10, example: 100). 0 means unlimited.", 1271 type=int, required=False) 1272 p.set_defaults(func=bdev_set_qos_limit) 1273 1274 def bdev_error_inject_error(args): 1275 rpc.bdev.bdev_error_inject_error(args.client, 1276 name=args.name, 1277 io_type=args.io_type, 1278 error_type=args.error_type, 1279 num=args.num, 1280 queue_depth=args.queue_depth, 1281 corrupt_offset=args.corrupt_offset, 1282 corrupt_value=args.corrupt_value) 1283 1284 p = subparsers.add_parser('bdev_error_inject_error', help='bdev inject error') 1285 p.add_argument('name', help="""the name of the error injection bdev""") 1286 p.add_argument('io_type', help="""io_type: 'clear' 'read' 'write' 'unmap' 'flush' 'all'""") 1287 p.add_argument('error_type', help="""error_type: 'failure' 'pending' 'corrupt_data' 'nomem'""") 1288 p.add_argument( 1289 '-n', '--num', help='the number of commands you want to fail', type=int) 1290 p.add_argument( 1291 '-q', '--queue-depth', help='the queue depth at which to trigger the error', type=int) 1292 p.add_argument( 1293 '-o', '--corrupt-offset', help='the offset in bytes to xor with corrupt_value', type=int) 1294 p.add_argument( 1295 '-v', '--corrupt-value', help='the value for xor (1-255, 0 is invalid)', type=int) 1296 p.set_defaults(func=bdev_error_inject_error) 1297 1298 def bdev_nvme_apply_firmware(args): 1299 print_dict(rpc.bdev.bdev_nvme_apply_firmware(args.client, 1300 bdev_name=args.bdev_name, 1301 filename=args.filename)) 1302 1303 p = subparsers.add_parser('bdev_nvme_apply_firmware', help='Download and commit firmware to NVMe device') 1304 p.add_argument('filename', help='filename of the firmware to download') 1305 p.add_argument('bdev_name', help='name of the NVMe device') 1306 p.set_defaults(func=bdev_nvme_apply_firmware) 1307 1308 def bdev_nvme_get_transport_statistics(args): 1309 print_dict(rpc.bdev.bdev_nvme_get_transport_statistics(args.client)) 1310 1311 p = subparsers.add_parser('bdev_nvme_get_transport_statistics', 1312 help='Get bdev_nvme poll group transport statistics') 1313 p.set_defaults(func=bdev_nvme_get_transport_statistics) 1314 1315 def bdev_nvme_get_controller_health_info(args): 1316 print_dict(rpc.bdev.bdev_nvme_get_controller_health_info(args.client, 1317 name=args.name)) 1318 1319 p = subparsers.add_parser('bdev_nvme_get_controller_health_info', 1320 help='Display health log of the required NVMe bdev controller.') 1321 p.add_argument('-c', '--name', help="Name of the NVMe bdev controller. Example: Nvme0", required=True) 1322 p.set_defaults(func=bdev_nvme_get_controller_health_info) 1323 1324 # iSCSI 1325 def iscsi_set_options(args): 1326 rpc.iscsi.iscsi_set_options( 1327 args.client, 1328 auth_file=args.auth_file, 1329 node_base=args.node_base, 1330 nop_timeout=args.nop_timeout, 1331 nop_in_interval=args.nop_in_interval, 1332 disable_chap=args.disable_chap, 1333 require_chap=args.require_chap, 1334 mutual_chap=args.mutual_chap, 1335 chap_group=args.chap_group, 1336 max_sessions=args.max_sessions, 1337 max_queue_depth=args.max_queue_depth, 1338 max_connections_per_session=args.max_connections_per_session, 1339 default_time2wait=args.default_time2wait, 1340 default_time2retain=args.default_time2retain, 1341 first_burst_length=args.first_burst_length, 1342 immediate_data=args.immediate_data, 1343 error_recovery_level=args.error_recovery_level, 1344 allow_duplicated_isid=args.allow_duplicated_isid, 1345 max_large_datain_per_connection=args.max_large_datain_per_connection, 1346 max_r2t_per_connection=args.max_r2t_per_connection, 1347 pdu_pool_size=args.pdu_pool_size, 1348 immediate_data_pool_size=args.immediate_data_pool_size, 1349 data_out_pool_size=args.data_out_pool_size) 1350 1351 p = subparsers.add_parser('iscsi_set_options', 1352 help="""Set options of iSCSI subsystem""") 1353 p.add_argument('-f', '--auth-file', help='Path to CHAP shared secret file') 1354 p.add_argument('-b', '--node-base', help='Prefix of the name of iSCSI target node') 1355 p.add_argument('-o', '--nop-timeout', help='Timeout in seconds to nop-in request to the initiator', type=int) 1356 p.add_argument('-n', '--nop-in-interval', help='Time interval in secs between nop-in requests by the target', type=int) 1357 p.add_argument('-d', '--disable-chap', help="""CHAP for discovery session should be disabled. 1358 *** Mutually exclusive with --require-chap""", action='store_true') 1359 p.add_argument('-r', '--require-chap', help="""CHAP for discovery session should be required. 1360 *** Mutually exclusive with --disable-chap""", action='store_true') 1361 p.add_argument('-m', '--mutual-chap', help='CHAP for discovery session should be mutual', action='store_true') 1362 p.add_argument('-g', '--chap-group', help="""Authentication group ID for discovery session. 1363 *** Authentication group must be precreated ***""", type=int) 1364 p.add_argument('-a', '--max-sessions', help='Maximum number of sessions in the host.', type=int) 1365 p.add_argument('-q', '--max-queue-depth', help='Max number of outstanding I/Os per queue.', type=int) 1366 p.add_argument('-c', '--max-connections-per-session', help='Negotiated parameter, MaxConnections.', type=int) 1367 p.add_argument('-w', '--default-time2wait', help='Negotiated parameter, DefaultTime2Wait.', type=int) 1368 p.add_argument('-v', '--default-time2retain', help='Negotiated parameter, DefaultTime2Retain.', type=int) 1369 p.add_argument('-s', '--first-burst-length', help='Negotiated parameter, FirstBurstLength.', type=int) 1370 p.add_argument('-i', '--immediate-data', help='Negotiated parameter, ImmediateData.', action='store_true') 1371 p.add_argument('-l', '--error-recovery-level', help='Negotiated parameter, ErrorRecoveryLevel', type=int) 1372 p.add_argument('-p', '--allow-duplicated-isid', help='Allow duplicated initiator session ID.', action='store_true') 1373 p.add_argument('-x', '--max-large-datain-per-connection', help='Max number of outstanding split read I/Os per connection', type=int) 1374 p.add_argument('-k', '--max-r2t-per-connection', help='Max number of outstanding R2Ts per connection', type=int) 1375 p.add_argument('-u', '--pdu-pool-size', help='Number of PDUs in the pool', type=int) 1376 p.add_argument('-j', '--immediate-data-pool-size', help='Number of immediate data buffers in the pool', type=int) 1377 p.add_argument('-z', '--data-out-pool-size', help='Number of data out buffers in the pool', type=int) 1378 p.set_defaults(func=iscsi_set_options) 1379 1380 def iscsi_set_discovery_auth(args): 1381 rpc.iscsi.iscsi_set_discovery_auth( 1382 args.client, 1383 disable_chap=args.disable_chap, 1384 require_chap=args.require_chap, 1385 mutual_chap=args.mutual_chap, 1386 chap_group=args.chap_group) 1387 1388 p = subparsers.add_parser('iscsi_set_discovery_auth', 1389 help="""Set CHAP authentication for discovery session.""") 1390 p.add_argument('-d', '--disable-chap', help="""CHAP for discovery session should be disabled. 1391 *** Mutually exclusive with --require-chap""", action='store_true') 1392 p.add_argument('-r', '--require-chap', help="""CHAP for discovery session should be required. 1393 *** Mutually exclusive with --disable-chap""", action='store_true') 1394 p.add_argument('-m', '--mutual-chap', help='CHAP for discovery session should be mutual', action='store_true') 1395 p.add_argument('-g', '--chap-group', help="""Authentication group ID for discovery session. 1396 *** Authentication group must be precreated ***""", type=int) 1397 p.set_defaults(func=iscsi_set_discovery_auth) 1398 1399 def iscsi_create_auth_group(args): 1400 secrets = None 1401 if args.secrets: 1402 secrets = [dict(u.split(":") for u in a.split(" ")) for a in args.secrets.split(",")] 1403 1404 rpc.iscsi.iscsi_create_auth_group(args.client, tag=args.tag, secrets=secrets) 1405 1406 p = subparsers.add_parser('iscsi_create_auth_group', 1407 help='Create authentication group for CHAP authentication.') 1408 p.add_argument('tag', help='Authentication group tag (unique, integer > 0).', type=int) 1409 p.add_argument('-c', '--secrets', help="""Comma-separated list of CHAP secrets 1410<user:user_name secret:chap_secret muser:mutual_user_name msecret:mutual_chap_secret> enclosed in quotes. 1411Format: 'user:u1 secret:s1 muser:mu1 msecret:ms1,user:u2 secret:s2 muser:mu2 msecret:ms2'""", required=False) 1412 p.set_defaults(func=iscsi_create_auth_group) 1413 1414 def iscsi_delete_auth_group(args): 1415 rpc.iscsi.iscsi_delete_auth_group(args.client, tag=args.tag) 1416 1417 p = subparsers.add_parser('iscsi_delete_auth_group', 1418 help='Delete an authentication group.') 1419 p.add_argument('tag', help='Authentication group tag', type=int) 1420 p.set_defaults(func=iscsi_delete_auth_group) 1421 1422 def iscsi_auth_group_add_secret(args): 1423 rpc.iscsi.iscsi_auth_group_add_secret( 1424 args.client, 1425 tag=args.tag, 1426 user=args.user, 1427 secret=args.secret, 1428 muser=args.muser, 1429 msecret=args.msecret) 1430 1431 p = subparsers.add_parser('iscsi_auth_group_add_secret', 1432 help='Add a secret to an authentication group.') 1433 p.add_argument('tag', help='Authentication group tag', type=int) 1434 p.add_argument('-u', '--user', help='User name for one-way CHAP authentication', required=True) 1435 p.add_argument('-s', '--secret', help='Secret for one-way CHAP authentication', required=True) 1436 p.add_argument('-m', '--muser', help='User name for mutual CHAP authentication') 1437 p.add_argument('-r', '--msecret', help='Secret for mutual CHAP authentication') 1438 p.set_defaults(func=iscsi_auth_group_add_secret) 1439 1440 def iscsi_auth_group_remove_secret(args): 1441 rpc.iscsi.iscsi_auth_group_remove_secret(args.client, tag=args.tag, user=args.user) 1442 1443 p = subparsers.add_parser('iscsi_auth_group_remove_secret', 1444 help='Remove a secret from an authentication group.') 1445 p.add_argument('tag', help='Authentication group tag', type=int) 1446 p.add_argument('-u', '--user', help='User name for one-way CHAP authentication', required=True) 1447 p.set_defaults(func=iscsi_auth_group_remove_secret) 1448 1449 def iscsi_get_auth_groups(args): 1450 print_dict(rpc.iscsi.iscsi_get_auth_groups(args.client)) 1451 1452 p = subparsers.add_parser('iscsi_get_auth_groups', 1453 help='Display current authentication group configuration') 1454 p.set_defaults(func=iscsi_get_auth_groups) 1455 1456 def iscsi_get_portal_groups(args): 1457 print_dict(rpc.iscsi.iscsi_get_portal_groups(args.client)) 1458 1459 p = subparsers.add_parser('iscsi_get_portal_groups', help='Display current portal group configuration') 1460 p.set_defaults(func=iscsi_get_portal_groups) 1461 1462 def iscsi_get_initiator_groups(args): 1463 print_dict(rpc.iscsi.iscsi_get_initiator_groups(args.client)) 1464 1465 p = subparsers.add_parser('iscsi_get_initiator_groups', 1466 help='Display current initiator group configuration') 1467 p.set_defaults(func=iscsi_get_initiator_groups) 1468 1469 def iscsi_get_target_nodes(args): 1470 print_dict(rpc.iscsi.iscsi_get_target_nodes(args.client)) 1471 1472 p = subparsers.add_parser('iscsi_get_target_nodes', help='Display target nodes') 1473 p.set_defaults(func=iscsi_get_target_nodes) 1474 1475 def iscsi_create_target_node(args): 1476 luns = [] 1477 for u in args.bdev_name_id_pairs.strip().split(" "): 1478 bdev_name, lun_id = u.split(":") 1479 luns.append({"bdev_name": bdev_name, "lun_id": int(lun_id)}) 1480 1481 pg_ig_maps = [] 1482 for u in args.pg_ig_mappings.strip().split(" "): 1483 pg, ig = u.split(":") 1484 pg_ig_maps.append({"pg_tag": int(pg), "ig_tag": int(ig)}) 1485 1486 rpc.iscsi.iscsi_create_target_node( 1487 args.client, 1488 luns=luns, 1489 pg_ig_maps=pg_ig_maps, 1490 name=args.name, 1491 alias_name=args.alias_name, 1492 queue_depth=args.queue_depth, 1493 chap_group=args.chap_group, 1494 disable_chap=args.disable_chap, 1495 require_chap=args.require_chap, 1496 mutual_chap=args.mutual_chap, 1497 header_digest=args.header_digest, 1498 data_digest=args.data_digest) 1499 1500 p = subparsers.add_parser('iscsi_create_target_node', help='Add a target node') 1501 p.add_argument('name', help='Target node name (ASCII)') 1502 p.add_argument('alias_name', help='Target node alias name (ASCII)') 1503 p.add_argument('bdev_name_id_pairs', help="""Whitespace-separated list of <bdev name:LUN ID> pairs enclosed 1504 in quotes. Format: 'bdev_name0:id0 bdev_name1:id1' etc 1505 Example: 'Malloc0:0 Malloc1:1 Malloc5:2' 1506 *** The bdevs must pre-exist *** 1507 *** LUN0 (id = 0) is required *** 1508 *** bdevs names cannot contain space or colon characters ***""") 1509 p.add_argument('pg_ig_mappings', help="""List of (Portal_Group_Tag:Initiator_Group_Tag) mappings 1510 Whitespace separated, quoted, mapping defined with colon 1511 separated list of "tags" (int > 0) 1512 Example: '1:1 2:2 2:1' 1513 *** The Portal/Initiator Groups must be precreated ***""") 1514 p.add_argument('queue_depth', help='Desired target queue depth', type=int) 1515 p.add_argument('-g', '--chap-group', help="""Authentication group ID for this target node. 1516 *** Authentication group must be precreated ***""", type=int) 1517 p.add_argument('-d', '--disable-chap', help="""CHAP authentication should be disabled for this target node. 1518 *** Mutually exclusive with --require-chap ***""", action='store_true') 1519 p.add_argument('-r', '--require-chap', help="""CHAP authentication should be required for this target node. 1520 *** Mutually exclusive with --disable-chap ***""", action='store_true') 1521 p.add_argument( 1522 '-m', '--mutual-chap', help='CHAP authentication should be mutual/bidirectional.', action='store_true') 1523 p.add_argument('-H', '--header-digest', 1524 help='Header Digest should be required for this target node.', action='store_true') 1525 p.add_argument('-D', '--data-digest', 1526 help='Data Digest should be required for this target node.', action='store_true') 1527 p.set_defaults(func=iscsi_create_target_node) 1528 1529 def iscsi_target_node_add_lun(args): 1530 rpc.iscsi.iscsi_target_node_add_lun( 1531 args.client, 1532 name=args.name, 1533 bdev_name=args.bdev_name, 1534 lun_id=args.lun_id) 1535 1536 p = subparsers.add_parser('iscsi_target_node_add_lun', 1537 help='Add LUN to the target node') 1538 p.add_argument('name', help='Target node name (ASCII)') 1539 p.add_argument('bdev_name', help="""bdev name enclosed in quotes. 1540 *** bdev name cannot contain space or colon characters ***""") 1541 p.add_argument('-i', dest='lun_id', help="""LUN ID (integer >= 0) 1542 *** If LUN ID is omitted or -1, the lowest free one is assigned ***""", type=int, required=False) 1543 p.set_defaults(func=iscsi_target_node_add_lun) 1544 1545 def iscsi_target_node_set_auth(args): 1546 rpc.iscsi.iscsi_target_node_set_auth( 1547 args.client, 1548 name=args.name, 1549 chap_group=args.chap_group, 1550 disable_chap=args.disable_chap, 1551 require_chap=args.require_chap, 1552 mutual_chap=args.mutual_chap) 1553 1554 p = subparsers.add_parser('iscsi_target_node_set_auth', 1555 help='Set CHAP authentication for the target node') 1556 p.add_argument('name', help='Target node name (ASCII)') 1557 p.add_argument('-g', '--chap-group', help="""Authentication group ID for this target node. 1558 *** Authentication group must be precreated ***""", type=int) 1559 p.add_argument('-d', '--disable-chap', help="""CHAP authentication should be disabled for this target node. 1560 *** Mutually exclusive with --require-chap ***""", action='store_true') 1561 p.add_argument('-r', '--require-chap', help="""CHAP authentication should be required for this target node. 1562 *** Mutually exclusive with --disable-chap ***""", action='store_true') 1563 p.add_argument('-m', '--mutual-chap', help='CHAP authentication should be mutual/bidirectional.', 1564 action='store_true') 1565 p.set_defaults(func=iscsi_target_node_set_auth) 1566 1567 def iscsi_target_node_add_pg_ig_maps(args): 1568 pg_ig_maps = [] 1569 for u in args.pg_ig_mappings.strip().split(" "): 1570 pg, ig = u.split(":") 1571 pg_ig_maps.append({"pg_tag": int(pg), "ig_tag": int(ig)}) 1572 rpc.iscsi.iscsi_target_node_add_pg_ig_maps( 1573 args.client, 1574 pg_ig_maps=pg_ig_maps, 1575 name=args.name) 1576 1577 p = subparsers.add_parser('iscsi_target_node_add_pg_ig_maps', 1578 help='Add PG-IG maps to the target node') 1579 p.add_argument('name', help='Target node name (ASCII)') 1580 p.add_argument('pg_ig_mappings', help="""List of (Portal_Group_Tag:Initiator_Group_Tag) mappings 1581 Whitespace separated, quoted, mapping defined with colon 1582 separated list of "tags" (int > 0) 1583 Example: '1:1 2:2 2:1' 1584 *** The Portal/Initiator Groups must be precreated ***""") 1585 p.set_defaults(func=iscsi_target_node_add_pg_ig_maps) 1586 1587 def iscsi_target_node_remove_pg_ig_maps(args): 1588 pg_ig_maps = [] 1589 for u in args.pg_ig_mappings.strip().split(" "): 1590 pg, ig = u.split(":") 1591 pg_ig_maps.append({"pg_tag": int(pg), "ig_tag": int(ig)}) 1592 rpc.iscsi.iscsi_target_node_remove_pg_ig_maps( 1593 args.client, pg_ig_maps=pg_ig_maps, name=args.name) 1594 1595 p = subparsers.add_parser('iscsi_target_node_remove_pg_ig_maps', 1596 help='Delete PG-IG maps from the target node') 1597 p.add_argument('name', help='Target node name (ASCII)') 1598 p.add_argument('pg_ig_mappings', help="""List of (Portal_Group_Tag:Initiator_Group_Tag) mappings 1599 Whitespace separated, quoted, mapping defined with colon 1600 separated list of "tags" (int > 0) 1601 Example: '1:1 2:2 2:1' 1602 *** The Portal/Initiator Groups must be precreated ***""") 1603 p.set_defaults(func=iscsi_target_node_remove_pg_ig_maps) 1604 1605 def iscsi_target_node_set_redirect(args): 1606 rpc.iscsi.iscsi_target_node_set_redirect( 1607 args.client, 1608 name=args.name, 1609 pg_tag=args.pg_tag, 1610 redirect_host=args.redirect_host, 1611 redirect_port=args.redirect_port) 1612 1613 p = subparsers.add_parser('iscsi_target_node_set_redirect', 1614 help="""Update redirect portal of the public portal group for the target node. 1615 Omit redirect host and port to clear previously set redirect settings.""") 1616 p.add_argument('name', help='Target node name (ASCII)') 1617 p.add_argument('pg_tag', help='Portal group tag (unique, integer > 0)', type=int) 1618 p.add_argument('-a', '--redirect-host', help='Numeric IP address for redirect portal', required=False) 1619 p.add_argument('-p', '--redirect-port', help='Numeric TCP port for redirect portal', required=False) 1620 p.set_defaults(func=iscsi_target_node_set_redirect) 1621 1622 def iscsi_target_node_request_logout(args): 1623 rpc.iscsi.iscsi_target_node_request_logout( 1624 args.client, 1625 name=args.name, 1626 pg_tag=args.pg_tag) 1627 1628 p = subparsers.add_parser('iscsi_target_node_request_logout', 1629 help="""For the target node, request connections whose portal group tag 1630 match to logout, or request all connections if portal group tag is omitted.""") 1631 p.add_argument('name', help='Target node name (ASCII)') 1632 p.add_argument('-t', '--pg-tag', help='Portal group tag (unique, integer > 0)', type=int, required=False) 1633 p.set_defaults(func=iscsi_target_node_request_logout) 1634 1635 def iscsi_create_portal_group(args): 1636 portals = [] 1637 for p in args.portal_list.strip().split(' '): 1638 ip, separator, port_cpumask = p.rpartition(':') 1639 split_port_cpumask = port_cpumask.split('@') 1640 if len(split_port_cpumask) == 1: 1641 port = port_cpumask 1642 portals.append({'host': ip, 'port': port}) 1643 else: 1644 port = split_port_cpumask[0] 1645 cpumask = split_port_cpumask[1] 1646 portals.append({'host': ip, 'port': port}) 1647 print("WARNING: Specifying a portal group with a CPU mask is no longer supported. Ignoring it.") 1648 rpc.iscsi.iscsi_create_portal_group( 1649 args.client, 1650 portals=portals, 1651 tag=args.tag, 1652 private=args.private, 1653 wait=args.wait) 1654 1655 p = subparsers.add_parser('iscsi_create_portal_group', 1656 help='Add a portal group') 1657 p.add_argument( 1658 'tag', help='Portal group tag (unique, integer > 0)', type=int) 1659 p.add_argument('portal_list', help="""List of portals in host:port format, separated by whitespace 1660 Example: '192.168.100.100:3260 192.168.100.100:3261 192.168.100.100:3262""") 1661 p.add_argument('-p', '--private', help="""Public (false) or private (true) portal group. 1662 Private portal groups do not have their portals returned by a discovery session. A public 1663 portal group may optionally specify a redirect portal for non-discovery logins. This redirect 1664 portal must be from a private portal group.""", action='store_true') 1665 p.add_argument('-w', '--wait', help="""Do not listening on portals until it is started explicitly. 1666 One major iSCSI initiator may not retry login once it failed. Hence for such initiator, listening 1667 on portals should be allowed after all associated target nodes are created.""", action='store_true') 1668 p.set_defaults(func=iscsi_create_portal_group) 1669 1670 def iscsi_start_portal_group(args): 1671 rpc.iscsi.iscsi_start_portal_group(args.client, tag=args.tag) 1672 1673 p = subparsers.add_parser('iscsi_start_portal_group', 1674 help='Start listening on portals if it is not started yet.') 1675 p.add_argument( 1676 'tag', help='Portal group tag (unique, integer > 0)', type=int) 1677 p.set_defaults(func=iscsi_start_portal_group) 1678 1679 def iscsi_create_initiator_group(args): 1680 initiators = [] 1681 netmasks = [] 1682 for i in args.initiator_list.strip().split(' '): 1683 initiators.append(i) 1684 for n in args.netmask_list.strip().split(' '): 1685 netmasks.append(n) 1686 rpc.iscsi.iscsi_create_initiator_group( 1687 args.client, 1688 tag=args.tag, 1689 initiators=initiators, 1690 netmasks=netmasks) 1691 1692 p = subparsers.add_parser('iscsi_create_initiator_group', 1693 help='Add an initiator group') 1694 p.add_argument( 1695 'tag', help='Initiator group tag (unique, integer > 0)', type=int) 1696 p.add_argument('initiator_list', help="""Whitespace-separated list of initiator hostnames or IP addresses, 1697 enclosed in quotes. Example: 'ANY' or 'iqn.2016-06.io.spdk:host1 iqn.2016-06.io.spdk:host2'""") 1698 p.add_argument('netmask_list', help="""Whitespace-separated list of initiator netmasks enclosed in quotes. 1699 Example: '255.255.0.0 255.248.0.0' etc""") 1700 p.set_defaults(func=iscsi_create_initiator_group) 1701 1702 def iscsi_initiator_group_add_initiators(args): 1703 initiators = None 1704 netmasks = None 1705 if args.initiator_list: 1706 initiators = [] 1707 for i in args.initiator_list.strip().split(' '): 1708 initiators.append(i) 1709 if args.netmask_list: 1710 netmasks = [] 1711 for n in args.netmask_list.strip().split(' '): 1712 netmasks.append(n) 1713 rpc.iscsi.iscsi_initiator_group_add_initiators( 1714 args.client, 1715 tag=args.tag, 1716 initiators=initiators, 1717 netmasks=netmasks) 1718 1719 p = subparsers.add_parser('iscsi_initiator_group_add_initiators', 1720 help='Add initiators to an existing initiator group') 1721 p.add_argument( 1722 'tag', help='Initiator group tag (unique, integer > 0)', type=int) 1723 p.add_argument('-n', dest='initiator_list', help="""Whitespace-separated list of initiator hostnames or IP addresses, 1724 enclosed in quotes. This parameter can be omitted. Example: 'ANY' or 1725 'iqn.2016-06.io.spdk:host1 iqn.2016-06.io.spdk:host2'""", required=False) 1726 p.add_argument('-m', dest='netmask_list', help="""Whitespace-separated list of initiator netmasks enclosed in quotes. 1727 This parameter can be omitted. Example: '255.255.0.0 255.248.0.0' etc""", required=False) 1728 p.set_defaults(func=iscsi_initiator_group_add_initiators) 1729 1730 def iscsi_initiator_group_remove_initiators(args): 1731 initiators = None 1732 netmasks = None 1733 if args.initiator_list: 1734 initiators = [] 1735 for i in args.initiator_list.strip().split(' '): 1736 initiators.append(i) 1737 if args.netmask_list: 1738 netmasks = [] 1739 for n in args.netmask_list.strip().split(' '): 1740 netmasks.append(n) 1741 rpc.iscsi.iscsi_initiator_group_remove_initiators( 1742 args.client, 1743 tag=args.tag, 1744 initiators=initiators, 1745 netmasks=netmasks) 1746 1747 p = subparsers.add_parser('iscsi_initiator_group_remove_initiators', 1748 help='Delete initiators from an existing initiator group') 1749 p.add_argument( 1750 'tag', help='Initiator group tag (unique, integer > 0)', type=int) 1751 p.add_argument('-n', dest='initiator_list', help="""Whitespace-separated list of initiator hostnames or IP addresses, 1752 enclosed in quotes. This parameter can be omitted. Example: 'ANY' or 1753 'iqn.2016-06.io.spdk:host1 iqn.2016-06.io.spdk:host2'""", required=False) 1754 p.add_argument('-m', dest='netmask_list', help="""Whitespace-separated list of initiator netmasks enclosed in quotes. 1755 This parameter can be omitted. Example: '255.255.0.0 255.248.0.0' etc""", required=False) 1756 p.set_defaults(func=iscsi_initiator_group_remove_initiators) 1757 1758 def iscsi_delete_target_node(args): 1759 rpc.iscsi.iscsi_delete_target_node( 1760 args.client, target_node_name=args.target_node_name) 1761 1762 p = subparsers.add_parser('iscsi_delete_target_node', 1763 help='Delete a target node') 1764 p.add_argument('target_node_name', 1765 help='Target node name to be deleted. Example: iqn.2016-06.io.spdk:disk1.') 1766 p.set_defaults(func=iscsi_delete_target_node) 1767 1768 def iscsi_delete_portal_group(args): 1769 rpc.iscsi.iscsi_delete_portal_group(args.client, tag=args.tag) 1770 1771 p = subparsers.add_parser('iscsi_delete_portal_group', 1772 help='Delete a portal group') 1773 p.add_argument( 1774 'tag', help='Portal group tag (unique, integer > 0)', type=int) 1775 p.set_defaults(func=iscsi_delete_portal_group) 1776 1777 def iscsi_delete_initiator_group(args): 1778 rpc.iscsi.iscsi_delete_initiator_group(args.client, tag=args.tag) 1779 1780 p = subparsers.add_parser('iscsi_delete_initiator_group', 1781 help='Delete an initiator group') 1782 p.add_argument( 1783 'tag', help='Initiator group tag (unique, integer > 0)', type=int) 1784 p.set_defaults(func=iscsi_delete_initiator_group) 1785 1786 def iscsi_portal_group_set_auth(args): 1787 rpc.iscsi.iscsi_portal_group_set_auth( 1788 args.client, 1789 tag=args.tag, 1790 chap_group=args.chap_group, 1791 disable_chap=args.disable_chap, 1792 require_chap=args.require_chap, 1793 mutual_chap=args.mutual_chap) 1794 1795 p = subparsers.add_parser('iscsi_portal_group_set_auth', 1796 help='Set CHAP authentication for discovery sessions specific for the portal group') 1797 p.add_argument('tag', help='Portal group tag (unique, integer > 0)', type=int) 1798 p.add_argument('-g', '--chap-group', help="""Authentication group ID for this portal group. 1799 *** Authentication group must be precreated ***""", type=int) 1800 p.add_argument('-d', '--disable-chap', help="""CHAP authentication should be disabled for this portal group. 1801 *** Mutually exclusive with --require-chap ***""", action='store_true') 1802 p.add_argument('-r', '--require-chap', help="""CHAP authentication should be required for this portal group. 1803 *** Mutually exclusive with --disable-chap ***""", action='store_true') 1804 p.add_argument('-m', '--mutual-chap', help='CHAP authentication should be mutual/bidirectional.', 1805 action='store_true') 1806 p.set_defaults(func=iscsi_portal_group_set_auth) 1807 1808 def iscsi_get_connections(args): 1809 print_dict(rpc.iscsi.iscsi_get_connections(args.client)) 1810 1811 p = subparsers.add_parser('iscsi_get_connections', 1812 help='Display iSCSI connections') 1813 p.set_defaults(func=iscsi_get_connections) 1814 1815 def iscsi_get_options(args): 1816 print_dict(rpc.iscsi.iscsi_get_options(args.client)) 1817 1818 p = subparsers.add_parser('iscsi_get_options', 1819 help='Display iSCSI global parameters') 1820 p.set_defaults(func=iscsi_get_options) 1821 1822 def scsi_get_devices(args): 1823 print_dict(rpc.iscsi.scsi_get_devices(args.client)) 1824 1825 p = subparsers.add_parser('scsi_get_devices', help='Display SCSI devices') 1826 p.set_defaults(func=scsi_get_devices) 1827 1828 # trace 1829 def trace_enable_tpoint_group(args): 1830 rpc.trace.trace_enable_tpoint_group(args.client, name=args.name) 1831 1832 p = subparsers.add_parser('trace_enable_tpoint_group', 1833 help='enable trace on a specific tpoint group') 1834 p.add_argument( 1835 'name', help="""trace group name we want to enable in tpoint_group_mask. 1836 (for example "bdev" for bdev trace group, "all" for all trace groups).""") 1837 p.set_defaults(func=trace_enable_tpoint_group) 1838 1839 def trace_disable_tpoint_group(args): 1840 rpc.trace.trace_disable_tpoint_group(args.client, name=args.name) 1841 1842 p = subparsers.add_parser('trace_disable_tpoint_group', 1843 help='disable trace on a specific tpoint group') 1844 p.add_argument( 1845 'name', help="""trace group name we want to disable in tpoint_group_mask. 1846 (for example "bdev" for bdev trace group, "all" for all trace groups).""") 1847 p.set_defaults(func=trace_disable_tpoint_group) 1848 1849 def trace_set_tpoint_mask(args): 1850 rpc.trace.trace_set_tpoint_mask(args.client, name=args.name, tpoint_mask=args.tpoint_mask) 1851 1852 p = subparsers.add_parser('trace_set_tpoint_mask', 1853 help='enable tracepoint mask on a specific tpoint group') 1854 p.add_argument( 1855 'name', help="""trace group name we want to enable in tpoint_group_mask. 1856 (for example "bdev" for bdev trace group)""") 1857 p.add_argument( 1858 'tpoint_mask', help="""tracepoints to be enabled inside a given trace group. 1859 (for example value of "0x3" will enable only the first two tpoints in this group)""", 1860 type=lambda m: int(m, 16)) 1861 p.set_defaults(func=trace_set_tpoint_mask) 1862 1863 def trace_clear_tpoint_mask(args): 1864 rpc.trace.trace_clear_tpoint_mask(args.client, name=args.name, tpoint_mask=args.tpoint_mask) 1865 1866 p = subparsers.add_parser('trace_clear_tpoint_mask', 1867 help='disable tracepoint mask on a specific tpoint group') 1868 p.add_argument( 1869 'name', help="""trace group name we want to disable in tpoint_group_mask. 1870 (for example "bdev" for bdev trace group)""") 1871 p.add_argument( 1872 'tpoint_mask', help="""tracepoints to be disabled inside a given trace group. 1873 (for example value of "0x3" will disable the first two tpoints in this group)""", 1874 type=lambda m: int(m, 16)) 1875 p.set_defaults(func=trace_clear_tpoint_mask) 1876 1877 def trace_get_tpoint_group_mask(args): 1878 print_dict(rpc.trace.trace_get_tpoint_group_mask(args.client)) 1879 1880 p = subparsers.add_parser('trace_get_tpoint_group_mask', help='get trace point group mask') 1881 p.set_defaults(func=trace_get_tpoint_group_mask) 1882 1883 def trace_get_info(args): 1884 print_dict(rpc.trace.trace_get_info(args.client)) 1885 1886 p = subparsers.add_parser('trace_get_info', 1887 help='get name of shared memory file and list of the available trace point groups') 1888 p.set_defaults(func=trace_get_info) 1889 1890 # log 1891 def log_set_flag(args): 1892 rpc.log.log_set_flag(args.client, flag=args.flag) 1893 1894 p = subparsers.add_parser('log_set_flag', help='set log flag') 1895 p.add_argument( 1896 'flag', help='log flag we want to set. (for example "nvme").') 1897 p.set_defaults(func=log_set_flag) 1898 1899 def log_clear_flag(args): 1900 rpc.log.log_clear_flag(args.client, flag=args.flag) 1901 1902 p = subparsers.add_parser('log_clear_flag', help='clear log flag') 1903 p.add_argument( 1904 'flag', help='log flag we want to clear. (for example "nvme").') 1905 p.set_defaults(func=log_clear_flag) 1906 1907 def log_get_flags(args): 1908 print_dict(rpc.log.log_get_flags(args.client)) 1909 1910 p = subparsers.add_parser('log_get_flags', help='get log flags') 1911 p.set_defaults(func=log_get_flags) 1912 1913 def log_set_level(args): 1914 rpc.log.log_set_level(args.client, level=args.level) 1915 1916 p = subparsers.add_parser('log_set_level', help='set log level') 1917 p.add_argument('level', help='log level we want to set. (for example "DEBUG").') 1918 p.set_defaults(func=log_set_level) 1919 1920 def log_get_level(args): 1921 print_dict(rpc.log.log_get_level(args.client)) 1922 1923 p = subparsers.add_parser('log_get_level', help='get log level') 1924 p.set_defaults(func=log_get_level) 1925 1926 def log_set_print_level(args): 1927 rpc.log.log_set_print_level(args.client, level=args.level) 1928 1929 p = subparsers.add_parser('log_set_print_level', help='set log print level') 1930 p.add_argument('level', help='log print level we want to set. (for example "DEBUG").') 1931 p.set_defaults(func=log_set_print_level) 1932 1933 def log_get_print_level(args): 1934 print_dict(rpc.log.log_get_print_level(args.client)) 1935 1936 p = subparsers.add_parser('log_get_print_level', help='get log print level') 1937 p.set_defaults(func=log_get_print_level) 1938 1939 # lvol 1940 def bdev_lvol_create_lvstore(args): 1941 print_json(rpc.lvol.bdev_lvol_create_lvstore(args.client, 1942 bdev_name=args.bdev_name, 1943 lvs_name=args.lvs_name, 1944 cluster_sz=args.cluster_sz, 1945 clear_method=args.clear_method, 1946 num_md_pages_per_cluster_ratio=args.md_pages_per_cluster_ratio)) 1947 1948 p = subparsers.add_parser('bdev_lvol_create_lvstore', help='Add logical volume store on base bdev') 1949 p.add_argument('bdev_name', help='base bdev name') 1950 p.add_argument('lvs_name', help='name for lvol store') 1951 p.add_argument('-c', '--cluster-sz', help='size of cluster (in bytes)', type=int, required=False) 1952 p.add_argument('--clear-method', help="""Change clear method for data region. 1953 Available: none, unmap, write_zeroes""", required=False) 1954 p.add_argument('-m', '--md-pages-per-cluster-ratio', help='reserved metadata pages for each cluster', type=int, required=False) 1955 p.set_defaults(func=bdev_lvol_create_lvstore) 1956 1957 def bdev_lvol_rename_lvstore(args): 1958 rpc.lvol.bdev_lvol_rename_lvstore(args.client, 1959 old_name=args.old_name, 1960 new_name=args.new_name) 1961 1962 p = subparsers.add_parser('bdev_lvol_rename_lvstore', help='Change logical volume store name') 1963 p.add_argument('old_name', help='old name') 1964 p.add_argument('new_name', help='new name') 1965 p.set_defaults(func=bdev_lvol_rename_lvstore) 1966 1967 def bdev_lvol_grow_lvstore(args): 1968 print_dict(rpc.lvol.bdev_lvol_grow_lvstore(args.client, 1969 uuid=args.uuid, 1970 lvs_name=args.lvs_name)) 1971 1972 p = subparsers.add_parser('bdev_lvol_grow_lvstore', 1973 help='Grow the lvstore size to the underlying bdev size') 1974 p.add_argument('-u', '--uuid', help='lvol store UUID', required=False) 1975 p.add_argument('-l', '--lvs-name', help='lvol store name', required=False) 1976 p.set_defaults(func=bdev_lvol_grow_lvstore) 1977 1978 def bdev_lvol_create(args): 1979 print_json(rpc.lvol.bdev_lvol_create(args.client, 1980 lvol_name=args.lvol_name, 1981 size_in_mib=args.size_in_mib, 1982 thin_provision=args.thin_provision, 1983 clear_method=args.clear_method, 1984 uuid=args.uuid, 1985 lvs_name=args.lvs_name)) 1986 1987 p = subparsers.add_parser('bdev_lvol_create', help='Add a bdev with an logical volume backend') 1988 p.add_argument('-u', '--uuid', help='lvol store UUID', required=False) 1989 p.add_argument('-l', '--lvs-name', help='lvol store name', required=False) 1990 p.add_argument('-t', '--thin-provision', action='store_true', help='create lvol bdev as thin provisioned') 1991 p.add_argument('-c', '--clear-method', help="""Change default data clusters clear method. 1992 Available: none, unmap, write_zeroes""", required=False) 1993 p.add_argument('lvol_name', help='name for this lvol') 1994 p.add_argument('size_in_mib', help='size in MiB for this bdev', type=int) 1995 p.set_defaults(func=bdev_lvol_create) 1996 1997 def bdev_lvol_snapshot(args): 1998 print_json(rpc.lvol.bdev_lvol_snapshot(args.client, 1999 lvol_name=args.lvol_name, 2000 snapshot_name=args.snapshot_name)) 2001 2002 p = subparsers.add_parser('bdev_lvol_snapshot', help='Create a snapshot of an lvol bdev') 2003 p.add_argument('lvol_name', help='lvol bdev name') 2004 p.add_argument('snapshot_name', help='lvol snapshot name') 2005 p.set_defaults(func=bdev_lvol_snapshot) 2006 2007 def bdev_lvol_clone(args): 2008 print_json(rpc.lvol.bdev_lvol_clone(args.client, 2009 snapshot_name=args.snapshot_name, 2010 clone_name=args.clone_name)) 2011 2012 p = subparsers.add_parser('bdev_lvol_clone', help='Create a clone of an lvol snapshot') 2013 p.add_argument('snapshot_name', help='lvol snapshot name') 2014 p.add_argument('clone_name', help='lvol clone name') 2015 p.set_defaults(func=bdev_lvol_clone) 2016 2017 def bdev_lvol_clone_bdev(args): 2018 print_json(rpc.lvol.bdev_lvol_clone_bdev(args.client, 2019 bdev=args.bdev, 2020 lvs_name=args.lvs_name, 2021 clone_name=args.clone_name)) 2022 2023 p = subparsers.add_parser('bdev_lvol_clone_bdev', 2024 help='Create a clone of a non-lvol bdev') 2025 p.add_argument('bdev', help='bdev to clone') 2026 p.add_argument('lvs_name', help='logical volume store name') 2027 p.add_argument('clone_name', help='lvol clone name') 2028 p.set_defaults(func=bdev_lvol_clone_bdev) 2029 2030 def bdev_lvol_rename(args): 2031 rpc.lvol.bdev_lvol_rename(args.client, 2032 old_name=args.old_name, 2033 new_name=args.new_name) 2034 2035 p = subparsers.add_parser('bdev_lvol_rename', help='Change lvol bdev name') 2036 p.add_argument('old_name', help='lvol bdev name') 2037 p.add_argument('new_name', help='new lvol name') 2038 p.set_defaults(func=bdev_lvol_rename) 2039 2040 def bdev_lvol_inflate(args): 2041 rpc.lvol.bdev_lvol_inflate(args.client, 2042 name=args.name) 2043 2044 p = subparsers.add_parser('bdev_lvol_inflate', help='Make thin provisioned lvol a thick provisioned lvol') 2045 p.add_argument('name', help='lvol bdev name') 2046 p.set_defaults(func=bdev_lvol_inflate) 2047 2048 def bdev_lvol_decouple_parent(args): 2049 rpc.lvol.bdev_lvol_decouple_parent(args.client, 2050 name=args.name) 2051 2052 p = subparsers.add_parser('bdev_lvol_decouple_parent', help='Decouple parent of lvol') 2053 p.add_argument('name', help='lvol bdev name') 2054 p.set_defaults(func=bdev_lvol_decouple_parent) 2055 2056 def bdev_lvol_resize(args): 2057 rpc.lvol.bdev_lvol_resize(args.client, 2058 name=args.name, 2059 size_in_mib=args.size_in_mib) 2060 2061 p = subparsers.add_parser('bdev_lvol_resize', help='Resize existing lvol bdev') 2062 p.add_argument('name', help='lvol bdev name') 2063 p.add_argument('size_in_mib', help='new size in MiB for this bdev', type=int) 2064 p.set_defaults(func=bdev_lvol_resize) 2065 2066 def bdev_lvol_set_read_only(args): 2067 rpc.lvol.bdev_lvol_set_read_only(args.client, 2068 name=args.name) 2069 2070 p = subparsers.add_parser('bdev_lvol_set_read_only', help='Mark lvol bdev as read only') 2071 p.add_argument('name', help='lvol bdev name') 2072 p.set_defaults(func=bdev_lvol_set_read_only) 2073 2074 def bdev_lvol_delete(args): 2075 rpc.lvol.bdev_lvol_delete(args.client, 2076 name=args.name) 2077 2078 p = subparsers.add_parser('bdev_lvol_delete', help='Destroy a logical volume') 2079 p.add_argument('name', help='lvol bdev name') 2080 p.set_defaults(func=bdev_lvol_delete) 2081 2082 def bdev_lvol_delete_lvstore(args): 2083 rpc.lvol.bdev_lvol_delete_lvstore(args.client, 2084 uuid=args.uuid, 2085 lvs_name=args.lvs_name) 2086 2087 p = subparsers.add_parser('bdev_lvol_delete_lvstore', help='Destroy an logical volume store') 2088 p.add_argument('-u', '--uuid', help='lvol store UUID', required=False) 2089 p.add_argument('-l', '--lvs-name', help='lvol store name', required=False) 2090 p.set_defaults(func=bdev_lvol_delete_lvstore) 2091 2092 def bdev_lvol_get_lvstores(args): 2093 print_dict(rpc.lvol.bdev_lvol_get_lvstores(args.client, 2094 uuid=args.uuid, 2095 lvs_name=args.lvs_name)) 2096 2097 p = subparsers.add_parser('bdev_lvol_get_lvstores', help='Display current logical volume store list') 2098 p.add_argument('-u', '--uuid', help='lvol store UUID', required=False) 2099 p.add_argument('-l', '--lvs-name', help='lvol store name', required=False) 2100 p.set_defaults(func=bdev_lvol_get_lvstores) 2101 2102 def bdev_lvol_get_lvols(args): 2103 print_dict(rpc.lvol.bdev_lvol_get_lvols(args.client, 2104 lvs_uuid=args.lvs_uuid, 2105 lvs_name=args.lvs_name)) 2106 2107 p = subparsers.add_parser('bdev_lvol_get_lvols', help='Display current logical volume list') 2108 p.add_argument('-u', '--lvs-uuid', help='only lvols in lvol store UUID', required=False) 2109 p.add_argument('-l', '--lvs-name', help='only lvols in lvol store name', required=False) 2110 p.set_defaults(func=bdev_lvol_get_lvols) 2111 2112 def bdev_raid_get_bdevs(args): 2113 print_json(rpc.bdev.bdev_raid_get_bdevs(args.client, 2114 category=args.category)) 2115 2116 p = subparsers.add_parser('bdev_raid_get_bdevs', 2117 help="""This is used to list all the raid bdev details based on the input category 2118 requested. Category should be one of 'all', 'online', 'configuring' or 'offline'. 'all' means all the raid bdevs whether 2119 they are online or configuring or offline. 'online' is the raid bdev which is registered with bdev layer. 'configuring' 2120 is the raid bdev which does not have full configuration discovered yet. 'offline' is the raid bdev which is not registered 2121 with bdev as of now and it has encountered any error or user has requested to offline the raid bdev""") 2122 p.add_argument('category', help='all or online or configuring or offline') 2123 p.set_defaults(func=bdev_raid_get_bdevs) 2124 2125 def bdev_raid_create(args): 2126 base_bdevs = [] 2127 for u in args.base_bdevs.strip().split(" "): 2128 base_bdevs.append(u) 2129 2130 rpc.bdev.bdev_raid_create(args.client, 2131 name=args.name, 2132 strip_size_kb=args.strip_size_kb, 2133 raid_level=args.raid_level, 2134 base_bdevs=base_bdevs, 2135 uuid=args.uuid, 2136 superblock=args.superblock) 2137 p = subparsers.add_parser('bdev_raid_create', help='Create new raid bdev') 2138 p.add_argument('-n', '--name', help='raid bdev name', required=True) 2139 p.add_argument('-z', '--strip-size-kb', help='strip size in KB', type=int) 2140 p.add_argument('-r', '--raid-level', help='raid level, raid0, raid1 and a special level concat are supported', required=True) 2141 p.add_argument('-b', '--base-bdevs', help='base bdevs name, whitespace separated list in quotes', required=True) 2142 p.add_argument('--uuid', help='UUID for this raid bdev', required=False) 2143 p.add_argument('-s', '--superblock', help='information about raid bdev will be stored in superblock on each base bdev, ' 2144 'disabled by default due to backward compatibility', action='store_true') 2145 p.set_defaults(func=bdev_raid_create) 2146 2147 def bdev_raid_delete(args): 2148 rpc.bdev.bdev_raid_delete(args.client, 2149 name=args.name) 2150 p = subparsers.add_parser('bdev_raid_delete', help='Delete existing raid bdev') 2151 p.add_argument('name', help='raid bdev name') 2152 p.set_defaults(func=bdev_raid_delete) 2153 2154 def bdev_raid_remove_base_bdev(args): 2155 rpc.bdev.bdev_raid_remove_base_bdev(args.client, 2156 name=args.name) 2157 p = subparsers.add_parser('bdev_raid_remove_base_bdev', help='Remove base bdev from existing raid bdev') 2158 p.add_argument('name', help='base bdev name') 2159 p.set_defaults(func=bdev_raid_remove_base_bdev) 2160 2161 # split 2162 def bdev_split_create(args): 2163 print_array(rpc.bdev.bdev_split_create(args.client, 2164 base_bdev=args.base_bdev, 2165 split_count=args.split_count, 2166 split_size_mb=args.split_size_mb)) 2167 2168 p = subparsers.add_parser('bdev_split_create', 2169 help="""Add given disk name to split config. If bdev with base_name 2170 name exist the split bdevs will be created right away, if not split bdevs will be created when base bdev became 2171 available (during examination process).""") 2172 p.add_argument('base_bdev', help='base bdev name') 2173 p.add_argument('-s', '--split-size-mb', help='size in MiB for each bdev', type=int) 2174 p.add_argument('split_count', help="""Optional - number of split bdevs to create. Total size * split_count must not 2175 exceed the base bdev size.""", type=int) 2176 p.set_defaults(func=bdev_split_create) 2177 2178 def bdev_split_delete(args): 2179 rpc.bdev.bdev_split_delete(args.client, 2180 base_bdev=args.base_bdev) 2181 2182 p = subparsers.add_parser('bdev_split_delete', help="""Delete split config with all created splits.""") 2183 p.add_argument('base_bdev', help='base bdev name') 2184 p.set_defaults(func=bdev_split_delete) 2185 2186 # ftl 2187 def bdev_ftl_create(args): 2188 print_dict(rpc.bdev.bdev_ftl_create(args.client, 2189 name=args.name, 2190 base_bdev=args.base_bdev, 2191 uuid=args.uuid, 2192 cache=args.cache, 2193 overprovisioning=args.overprovisioning, 2194 l2p_dram_limit=args.l2p_dram_limit, 2195 core_mask=args.core_mask, 2196 fast_shutdown=args.fast_shutdown)) 2197 2198 p = subparsers.add_parser('bdev_ftl_create', help='Add FTL bdev') 2199 p.add_argument('-b', '--name', help="Name of the bdev", required=True) 2200 p.add_argument('-d', '--base-bdev', help='Name of bdev used as underlying device', 2201 required=True) 2202 p.add_argument('-u', '--uuid', help='UUID of restored bdev (not applicable when creating new ' 2203 'instance): e.g. b286d19a-0059-4709-abcd-9f7732b1567d (optional)') 2204 p.add_argument('-c', '--cache', help='Name of the bdev to be used as a write buffer cache', 2205 required=True) 2206 p.add_argument('--overprovisioning', help='Percentage of device used for relocation, not exposed' 2207 ' to user (optional); default 20', type=int) 2208 p.add_argument('--l2p-dram-limit', help='l2p size that could reside in DRAM (optional); default 2048', 2209 type=int) 2210 p.add_argument('--core-mask', help='CPU core mask - which cores will be used for ftl core thread, ' 2211 'by default core thread will be set to the main application core (optional)') 2212 p.add_argument('-f', '--fast-shutdown', help="Enable fast shutdown", action='store_true') 2213 p.set_defaults(func=bdev_ftl_create) 2214 2215 def bdev_ftl_load(args): 2216 print_dict(rpc.bdev.bdev_ftl_load(args.client, 2217 name=args.name, 2218 base_bdev=args.base_bdev, 2219 uuid=args.uuid, 2220 cache=args.cache, 2221 overprovisioning=args.overprovisioning, 2222 l2p_dram_limit=args.l2p_dram_limit, 2223 core_mask=args.core_mask, 2224 fast_shutdown=args.fast_shutdown)) 2225 2226 p = subparsers.add_parser('bdev_ftl_load', help='Load FTL bdev') 2227 p.add_argument('-b', '--name', help="Name of the bdev", required=True) 2228 p.add_argument('-d', '--base-bdev', help='Name of bdev used as underlying device', 2229 required=True) 2230 p.add_argument('-u', '--uuid', help='UUID of restored bdev', required=True) 2231 p.add_argument('-c', '--cache', help='Name of the bdev to be used as a write buffer cache', 2232 required=True) 2233 p.add_argument('--overprovisioning', help='Percentage of device used for relocation, not exposed' 2234 ' to user (optional); default 20', type=int) 2235 p.add_argument('--l2p-dram-limit', help='l2p size that could reside in DRAM (optional); default 2048', 2236 type=int) 2237 p.add_argument('--core-mask', help='CPU core mask - which cores will be used for ftl core thread, ' 2238 'by default core thread will be set to the main application core (optional)') 2239 p.add_argument('-f', '--fast-shutdown', help="Enable fast shutdown", action='store_true') 2240 p.set_defaults(func=bdev_ftl_load) 2241 2242 def bdev_ftl_unload(args): 2243 print_dict(rpc.bdev.bdev_ftl_unload(args.client, name=args.name, fast_shutdown=args.fast_shutdown)) 2244 2245 p = subparsers.add_parser('bdev_ftl_unload', help='Unload FTL bdev') 2246 p.add_argument('-b', '--name', help="Name of the bdev", required=True) 2247 p.add_argument('-f', '--fast-shutdown', help="Fast shutdown", action='store_true') 2248 p.set_defaults(func=bdev_ftl_unload) 2249 2250 def bdev_ftl_delete(args): 2251 print_dict(rpc.bdev.bdev_ftl_delete(args.client, name=args.name, fast_shutdown=args.fast_shutdown)) 2252 2253 p = subparsers.add_parser('bdev_ftl_delete', help='Delete FTL bdev') 2254 p.add_argument('-b', '--name', help="Name of the bdev", required=True) 2255 p.add_argument('-f', '--fast-shutdown', help="Fast shutdown", action='store_true') 2256 p.set_defaults(func=bdev_ftl_delete) 2257 2258 def bdev_ftl_unmap(args): 2259 print_dict(rpc.bdev.bdev_ftl_unmap(args.client, name=args.name, 2260 lba=args.lba, 2261 num_blocks=args.num_blocks)) 2262 2263 p = subparsers.add_parser('bdev_ftl_unmap', help='FTL unmap') 2264 p.add_argument('-b', '--name', help="Name of the bdev", required=True) 2265 p.add_argument('--lba', help='start LBA', required=True, type=int) 2266 p.add_argument('--num-blocks', help='num blocks', required=True, type=int) 2267 p.set_defaults(func=bdev_ftl_unmap) 2268 2269 def bdev_ftl_get_stats(args): 2270 print_dict(rpc.bdev.bdev_ftl_get_stats(args.client, name=args.name)) 2271 2272 p = subparsers.add_parser('bdev_ftl_get_stats', help='print ftl stats') 2273 p.add_argument('-b', '--name', help="Name of the bdev", required=True) 2274 p.set_defaults(func=bdev_ftl_get_stats) 2275 2276 def bdev_ftl_get_properties(args): 2277 print_dict(rpc.bdev.bdev_ftl_get_properties(args.client, name=args.name)) 2278 2279 p = subparsers.add_parser('bdev_ftl_get_properties', help='Print FTL properties') 2280 p.add_argument('-b', '--name', help="Name of the bdev", required=True) 2281 p.set_defaults(func=bdev_ftl_get_properties) 2282 2283 def bdev_ftl_set_property(args): 2284 print_dict(rpc.bdev.bdev_ftl_set_property(args.client, name=args.name, 2285 ftl_property=args.property, 2286 value=args.value)) 2287 2288 p = subparsers.add_parser('bdev_ftl_set_property', help='Set FTL property') 2289 p.add_argument('-b', '--name', help="Name of the bdev", required=True) 2290 p.add_argument('-p', '--property', help="Name of the property to be set", required=True) 2291 p.add_argument('-v', '--value', help="Value of the property", required=True) 2292 p.set_defaults(func=bdev_ftl_set_property) 2293 2294 # vmd 2295 def vmd_enable(args): 2296 print_dict(rpc.vmd.vmd_enable(args.client)) 2297 2298 p = subparsers.add_parser('vmd_enable', aliases=['enable_vmd'], help='Enable VMD enumeration') 2299 p.set_defaults(func=vmd_enable) 2300 2301 def vmd_remove_device(args): 2302 print_dict(rpc.vmd.vmd_remove_device(args.client, addr=args.addr)) 2303 2304 p = subparsers.add_parser('vmd_remove_device', help='Remove a device behind VMD') 2305 p.add_argument('addr', help='Address of the device to remove', type=str) 2306 p.set_defaults(func=vmd_remove_device) 2307 2308 def vmd_rescan(args): 2309 print_dict(rpc.vmd.vmd_rescan(args.client)) 2310 2311 p = subparsers.add_parser('vmd_rescan', help='Force a rescan of the devices behind VMD') 2312 p.set_defaults(func=vmd_rescan) 2313 2314 # ublk 2315 def ublk_create_target(args): 2316 rpc.ublk.ublk_create_target(args.client, 2317 cpumask=args.cpumask) 2318 p = subparsers.add_parser('ublk_create_target', 2319 help='Create spdk ublk target for ublk dev') 2320 p.add_argument('-m', '--cpumask', help='cpu mask for ublk dev') 2321 p.set_defaults(func=ublk_create_target) 2322 2323 def ublk_destroy_target(args): 2324 rpc.ublk.ublk_destroy_target(args.client) 2325 p = subparsers.add_parser('ublk_destroy_target', 2326 help='Destroy spdk ublk target for ublk dev') 2327 p.set_defaults(func=ublk_destroy_target) 2328 2329 def ublk_start_disk(args): 2330 print(rpc.ublk.ublk_start_disk(args.client, 2331 bdev_name=args.bdev_name, 2332 ublk_id=args.ublk_id, 2333 num_queues=args.num_queues, 2334 queue_depth=args.queue_depth)) 2335 2336 p = subparsers.add_parser('ublk_start_disk', 2337 help='Export a bdev as a ublk device') 2338 p.add_argument('bdev_name', help='Blockdev name to be exported. Example: Malloc0.') 2339 p.add_argument('ublk_id', help='ublk device id to be assigned. Example: 1.', type=int) 2340 p.add_argument('-q', '--num-queues', help="the total number of queues. Example: 1", type=int, required=False) 2341 p.add_argument('-d', '--queue-depth', help="queue depth. Example: 128", type=int, required=False) 2342 p.set_defaults(func=ublk_start_disk) 2343 2344 def ublk_stop_disk(args): 2345 rpc.ublk.ublk_stop_disk(args.client, 2346 ublk_id=args.ublk_id) 2347 2348 p = subparsers.add_parser('ublk_stop_disk', 2349 help='Stop a ublk device') 2350 p.add_argument('ublk_id', help='ublk device id to be deleted. Example: 1.', type=int) 2351 p.set_defaults(func=ublk_stop_disk) 2352 2353 def ublk_recover_disk(args): 2354 print(rpc.ublk.ublk_recover_disk(args.client, 2355 bdev_name=args.bdev_name, 2356 ublk_id=args.ublk_id)) 2357 2358 p = subparsers.add_parser('ublk_recover_disk', 2359 help='Recover ublk device') 2360 p.add_argument('bdev_name', help='Blockdev name to be recovered. Example: Malloc0.') 2361 p.add_argument('ublk_id', help='ublk device id to be recovered. Example: 1.', type=int) 2362 p.set_defaults(func=ublk_recover_disk) 2363 2364 def ublk_get_disks(args): 2365 print_dict(rpc.ublk.ublk_get_disks(args.client, 2366 ublk_id=args.ublk_id)) 2367 2368 p = subparsers.add_parser('ublk_get_disks', 2369 help='Display full or specified ublk device list') 2370 p.add_argument('-n', '--ublk-id', help="ublk device id. Example: 1", type=int, required=False) 2371 p.set_defaults(func=ublk_get_disks) 2372 2373 # nbd 2374 def nbd_start_disk(args): 2375 print(rpc.nbd.nbd_start_disk(args.client, 2376 bdev_name=args.bdev_name, 2377 nbd_device=args.nbd_device)) 2378 2379 p = subparsers.add_parser('nbd_start_disk', 2380 help='Export a bdev as an nbd disk') 2381 p.add_argument('bdev_name', help='Blockdev name to be exported. Example: Malloc0.') 2382 p.add_argument('nbd_device', help='Nbd device name to be assigned. Example: /dev/nbd0.', nargs='?') 2383 p.set_defaults(func=nbd_start_disk) 2384 2385 def nbd_stop_disk(args): 2386 rpc.nbd.nbd_stop_disk(args.client, 2387 nbd_device=args.nbd_device) 2388 2389 p = subparsers.add_parser('nbd_stop_disk', 2390 help='Stop an nbd disk') 2391 p.add_argument('nbd_device', help='Nbd device name to be stopped. Example: /dev/nbd0.') 2392 p.set_defaults(func=nbd_stop_disk) 2393 2394 def nbd_get_disks(args): 2395 print_dict(rpc.nbd.nbd_get_disks(args.client, 2396 nbd_device=args.nbd_device)) 2397 2398 p = subparsers.add_parser('nbd_get_disks', 2399 help='Display full or specified nbd device list') 2400 p.add_argument('-n', '--nbd-device', help="Path of the nbd device. Example: /dev/nbd0", required=False) 2401 p.set_defaults(func=nbd_get_disks) 2402 2403 # NVMe-oF 2404 def nvmf_set_max_subsystems(args): 2405 rpc.nvmf.nvmf_set_max_subsystems(args.client, 2406 max_subsystems=args.max_subsystems) 2407 2408 p = subparsers.add_parser('nvmf_set_max_subsystems', 2409 help='Set the maximum number of NVMf target subsystems') 2410 p.add_argument('-x', '--max-subsystems', help='Max number of NVMf subsystems', type=int, required=True) 2411 p.set_defaults(func=nvmf_set_max_subsystems) 2412 2413 def nvmf_set_config(args): 2414 rpc.nvmf.nvmf_set_config(args.client, 2415 passthru_identify_ctrlr=args.passthru_identify_ctrlr, 2416 poll_groups_mask=args.poll_groups_mask, 2417 discovery_filter=args.discovery_filter) 2418 2419 p = subparsers.add_parser('nvmf_set_config', help='Set NVMf target config') 2420 p.add_argument('-i', '--passthru-identify-ctrlr', help="""Passthrough fields like serial number and model number 2421 when the controller has a single namespace that is an NVMe bdev""", action='store_true') 2422 p.add_argument('-m', '--poll-groups-mask', help='Set cpumask for NVMf poll groups (optional)', type=str) 2423 p.add_argument('-d', '--discovery-filter', help="""Set discovery filter (optional), possible values are: `match_any` (default) or 2424 comma separated values: `transport`, `address`, `svcid`""", type=str) 2425 p.set_defaults(func=nvmf_set_config) 2426 2427 def nvmf_create_transport(args): 2428 rpc.nvmf.nvmf_create_transport(**vars(args)) 2429 2430 p = subparsers.add_parser('nvmf_create_transport', help='Create NVMf transport') 2431 p.add_argument('-t', '--trtype', help='Transport type (ex. RDMA)', type=str, required=True) 2432 p.add_argument('-g', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2433 p.add_argument('-q', '--max-queue-depth', help='Max number of outstanding I/O per queue', type=int) 2434 p.add_argument('-m', '--max-io-qpairs-per-ctrlr', help='Max number of IO qpairs per controller', type=int) 2435 p.add_argument('-c', '--in-capsule-data-size', help='Max number of in-capsule data size', type=int) 2436 p.add_argument('-i', '--max-io-size', help='Max I/O size (bytes)', type=int) 2437 p.add_argument('-u', '--io-unit-size', help='I/O unit size (bytes)', type=int) 2438 p.add_argument('-a', '--max-aq-depth', help='Max number of admin cmds per AQ', type=int) 2439 p.add_argument('-n', '--num-shared-buffers', help='The number of pooled data buffers available to the transport', type=int) 2440 p.add_argument('-b', '--buf-cache-size', help='The number of shared buffers to reserve for each poll group', type=int) 2441 p.add_argument('-z', '--zcopy', action='store_true', help='''Use zero-copy operations if the 2442 underlying bdev supports them''') 2443 p.add_argument('-d', '--num-cqe', help="""The number of CQ entries. Only used when no_srq=true. 2444 Relevant only for RDMA transport""", type=int) 2445 p.add_argument('-s', '--max-srq-depth', help='Max number of outstanding I/O per SRQ. Relevant only for RDMA transport', type=int) 2446 p.add_argument('-r', '--no-srq', action='store_true', help='Disable per-thread shared receive queue. Relevant only for RDMA transport') 2447 p.add_argument('-o', '--c2h-success', action='store_false', help='Disable C2H success optimization. Relevant only for TCP transport') 2448 p.add_argument('-f', '--dif-insert-or-strip', action='store_true', help='Enable DIF insert/strip. Relevant only for TCP transport') 2449 p.add_argument('-y', '--sock-priority', help='The sock priority of the tcp connection. Relevant only for TCP transport', type=int) 2450 p.add_argument('-l', '--acceptor-backlog', help='Pending connections allowed at one time. Relevant only for RDMA transport', type=int) 2451 p.add_argument('-x', '--abort-timeout-sec', help='Abort execution timeout value, in seconds', type=int) 2452 p.add_argument('-w', '--no-wr-batching', action='store_true', help='Disable work requests batching. Relevant only for RDMA transport') 2453 p.add_argument('-e', '--control-msg-num', help="""The number of control messages per poll group. 2454 Relevant only for TCP transport""", type=int) 2455 p.add_argument('-M', '--disable-mappable-bar0', action='store_true', help="""Disable mmap() of BAR0. 2456 Relevant only for VFIO-USER transport""") 2457 p.add_argument('-I', '--disable-adaptive-irq', action='store_true', help="""Disable adaptive interrupt feature. 2458 Relevant only for VFIO-USER transport""") 2459 p.add_argument('-S', '--disable-shadow-doorbells', action='store_true', help="""Disable shadow doorbell support. 2460 Relevant only for VFIO-USER transport""") 2461 p.add_argument('--acceptor-poll-rate', help='Polling interval of the acceptor for incoming connections (usec)', type=int) 2462 p.set_defaults(func=nvmf_create_transport) 2463 2464 def nvmf_get_transports(args): 2465 print_dict(rpc.nvmf.nvmf_get_transports(args.client, trtype=args.trtype, tgt_name=args.tgt_name)) 2466 2467 p = subparsers.add_parser('nvmf_get_transports', help='Display nvmf transports or required transport') 2468 p.add_argument('--trtype', help='Transport type (optional)') 2469 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2470 p.set_defaults(func=nvmf_get_transports) 2471 2472 def nvmf_get_subsystems(args): 2473 print_dict(rpc.nvmf.nvmf_get_subsystems(args.client, nqn=args.nqn, tgt_name=args.tgt_name)) 2474 2475 p = subparsers.add_parser('nvmf_get_subsystems', help='Display nvmf subsystems or required subsystem') 2476 p.add_argument('nqn', help='Subsystem NQN (optional)', nargs="?") 2477 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2478 p.set_defaults(func=nvmf_get_subsystems) 2479 2480 def nvmf_create_subsystem(args): 2481 rpc.nvmf.nvmf_create_subsystem(args.client, 2482 nqn=args.nqn, 2483 tgt_name=args.tgt_name, 2484 serial_number=args.serial_number, 2485 model_number=args.model_number, 2486 allow_any_host=args.allow_any_host, 2487 max_namespaces=args.max_namespaces, 2488 ana_reporting=args.ana_reporting, 2489 min_cntlid=args.min_cntlid, 2490 max_cntlid=args.max_cntlid) 2491 2492 p = subparsers.add_parser('nvmf_create_subsystem', help='Create an NVMe-oF subsystem') 2493 p.add_argument('nqn', help='Subsystem NQN (ASCII)') 2494 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2495 p.add_argument("-s", "--serial-number", help=""" 2496 Format: 'sn' etc 2497 Example: 'SPDK00000000000001'""") 2498 p.add_argument("-d", "--model-number", help=""" 2499 Format: 'mn' etc 2500 Example: 'SPDK Controller'""") 2501 p.add_argument("-a", "--allow-any-host", action='store_true', help="Allow any host to connect (don't enforce allowed host NQN list)") 2502 p.add_argument("-m", "--max-namespaces", help="Maximum number of namespaces allowed", 2503 type=int) 2504 p.add_argument("-r", "--ana-reporting", action='store_true', help="Enable ANA reporting feature") 2505 p.add_argument("-i", "--min_cntlid", help="Minimum controller ID", type=int) 2506 p.add_argument("-I", "--max_cntlid", help="Maximum controller ID", type=int) 2507 p.set_defaults(func=nvmf_create_subsystem) 2508 2509 def nvmf_delete_subsystem(args): 2510 rpc.nvmf.nvmf_delete_subsystem(args.client, 2511 nqn=args.subsystem_nqn, 2512 tgt_name=args.tgt_name) 2513 2514 p = subparsers.add_parser('nvmf_delete_subsystem', help='Delete a nvmf subsystem') 2515 p.add_argument('subsystem_nqn', 2516 help='subsystem nqn to be deleted. Example: nqn.2016-06.io.spdk:cnode1.') 2517 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2518 p.set_defaults(func=nvmf_delete_subsystem) 2519 2520 def nvmf_subsystem_add_listener(args): 2521 rpc.nvmf.nvmf_subsystem_add_listener(**vars(args)) 2522 2523 p = subparsers.add_parser('nvmf_subsystem_add_listener', help='Add a listener to an NVMe-oF subsystem') 2524 p.add_argument('nqn', help='NVMe-oF subsystem NQN (\'discovery\' can be used as shortcut for discovery NQN)') 2525 p.add_argument('-t', '--trtype', help='NVMe-oF transport type: e.g., rdma', required=True) 2526 p.add_argument('-a', '--traddr', help='NVMe-oF transport address: e.g., an ip address', required=True) 2527 p.add_argument('-p', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2528 p.add_argument('-f', '--adrfam', help='NVMe-oF transport adrfam: e.g., ipv4, ipv6, ib, fc, intra_host') 2529 p.add_argument('-s', '--trsvcid', help='NVMe-oF transport service id: e.g., a port number (required for RDMA or TCP)') 2530 p.add_argument('-k', '--secure-channel', help='Immediately establish a secure channel', action="store_true") 2531 p.add_argument('-n', '--ana-state', help='ANA state to set: optimized, non_optimized, or inaccessible', type=str, required=False) 2532 p.set_defaults(func=nvmf_subsystem_add_listener) 2533 2534 def nvmf_subsystem_remove_listener(args): 2535 rpc.nvmf.nvmf_subsystem_remove_listener(args.client, 2536 nqn=args.nqn, 2537 trtype=args.trtype, 2538 traddr=args.traddr, 2539 tgt_name=args.tgt_name, 2540 adrfam=args.adrfam, 2541 trsvcid=args.trsvcid) 2542 2543 p = subparsers.add_parser('nvmf_subsystem_remove_listener', help='Remove a listener from an NVMe-oF subsystem') 2544 p.add_argument('nqn', help='NVMe-oF subsystem NQN (\'discovery\' can be used as shortcut for discovery NQN)') 2545 p.add_argument('-t', '--trtype', help='NVMe-oF transport type: e.g., rdma', required=True) 2546 p.add_argument('-a', '--traddr', help='NVMe-oF transport address: e.g., an ip address', required=True) 2547 p.add_argument('-p', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2548 p.add_argument('-f', '--adrfam', help='NVMe-oF transport adrfam: e.g., ipv4, ipv6, ib, fc, intra_host') 2549 p.add_argument('-s', '--trsvcid', help='NVMe-oF transport service id: e.g., a port number (required for TCP and RDMA transport types)') 2550 p.set_defaults(func=nvmf_subsystem_remove_listener) 2551 2552 def nvmf_subsystem_listener_set_ana_state(args): 2553 rpc.nvmf.nvmf_subsystem_listener_set_ana_state(args.client, 2554 nqn=args.nqn, 2555 ana_state=args.ana_state, 2556 trtype=args.trtype, 2557 traddr=args.traddr, 2558 tgt_name=args.tgt_name, 2559 adrfam=args.adrfam, 2560 trsvcid=args.trsvcid, 2561 anagrpid=args.anagrpid) 2562 2563 p = subparsers.add_parser('nvmf_subsystem_listener_set_ana_state', help='Set ANA state of a listener for an NVMe-oF subsystem') 2564 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 2565 p.add_argument('-n', '--ana-state', help='ANA state to set: optimized, non_optimized, or inaccessible', required=True) 2566 p.add_argument('-t', '--trtype', help='NVMe-oF transport type: e.g., rdma', required=True) 2567 p.add_argument('-a', '--traddr', help='NVMe-oF transport address: e.g., an ip address', required=True) 2568 p.add_argument('-p', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2569 p.add_argument('-f', '--adrfam', help='NVMe-oF transport adrfam: e.g., ipv4, ipv6, ib, fc, intra_host') 2570 p.add_argument('-s', '--trsvcid', help='NVMe-oF transport service id: e.g., a port number') 2571 p.add_argument('-g', '--anagrpid', help='ANA group ID (optional)', type=int) 2572 p.set_defaults(func=nvmf_subsystem_listener_set_ana_state) 2573 2574 def nvmf_discovery_add_referral(args): 2575 rpc.nvmf.nvmf_discovery_add_referral(**vars(args)) 2576 2577 p = subparsers.add_parser('nvmf_discovery_add_referral', help='Add a discovery service referral to an NVMe-oF target') 2578 p.add_argument('-t', '--trtype', help='NVMe-oF transport type: e.g., rdma', required=True) 2579 p.add_argument('-a', '--traddr', help='NVMe-oF transport address: e.g., an ip address', required=True) 2580 p.add_argument('-p', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2581 p.add_argument('-f', '--adrfam', help='NVMe-oF transport adrfam: e.g., ipv4, ipv6, ib, fc, intra_host') 2582 p.add_argument('-s', '--trsvcid', help='NVMe-oF transport service id: e.g., a port number (required for RDMA or TCP)') 2583 p.add_argument('-k', '--secure-channel', help='The connection to that discovery subsystem requires a secure channel', 2584 action="store_true") 2585 p.add_argument('-n', '--subnqn', help='Subsystem NQN') 2586 p.set_defaults(func=nvmf_discovery_add_referral) 2587 2588 def nvmf_discovery_remove_referral(args): 2589 rpc.nvmf.nvmf_discovery_remove_referral(args.client, 2590 trtype=args.trtype, 2591 traddr=args.traddr, 2592 tgt_name=args.tgt_name, 2593 adrfam=args.adrfam, 2594 trsvcid=args.trsvcid, 2595 subnqn=args.subnqn) 2596 2597 p = subparsers.add_parser('nvmf_discovery_remove_referral', help='Remove a discovery service referral from an NVMe-oF target') 2598 p.add_argument('-t', '--trtype', help='NVMe-oF transport type: e.g., rdma', required=True) 2599 p.add_argument('-a', '--traddr', help='NVMe-oF transport address: e.g., an ip address', required=True) 2600 p.add_argument('-p', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2601 p.add_argument('-f', '--adrfam', help='NVMe-oF transport adrfam: e.g., ipv4, ipv6, ib, fc, intra_host') 2602 p.add_argument('-s', '--trsvcid', help='NVMe-oF transport service id: e.g., a port number (required for TCP and RDMA transport types)') 2603 p.add_argument('-n', '--subnqn', help='Subsystem NQN') 2604 p.set_defaults(func=nvmf_discovery_remove_referral) 2605 2606 def nvmf_discovery_get_referrals(args): 2607 print_dict(rpc.nvmf.nvmf_discovery_get_referrals(args.client, 2608 tgt_name=args.tgt_name)) 2609 2610 p = subparsers.add_parser('nvmf_discovery_get_referrals', 2611 help='Display discovery subsystem referrals of an NVMe-oF target') 2612 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2613 p.set_defaults(func=nvmf_discovery_get_referrals) 2614 2615 def nvmf_subsystem_add_ns(args): 2616 rpc.nvmf.nvmf_subsystem_add_ns(args.client, 2617 nqn=args.nqn, 2618 bdev_name=args.bdev_name, 2619 tgt_name=args.tgt_name, 2620 ptpl_file=args.ptpl_file, 2621 nsid=args.nsid, 2622 nguid=args.nguid, 2623 eui64=args.eui64, 2624 uuid=args.uuid, 2625 anagrpid=args.anagrpid) 2626 2627 p = subparsers.add_parser('nvmf_subsystem_add_ns', help='Add a namespace to an NVMe-oF subsystem') 2628 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 2629 p.add_argument('bdev_name', help='The name of the bdev that will back this namespace') 2630 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2631 p.add_argument('-p', '--ptpl-file', help='The persistent reservation storage location (optional)', type=str) 2632 p.add_argument('-n', '--nsid', help='The requested NSID (optional)', type=int) 2633 p.add_argument('-g', '--nguid', help='Namespace globally unique identifier (optional)') 2634 p.add_argument('-e', '--eui64', help='Namespace EUI-64 identifier (optional)') 2635 p.add_argument('-u', '--uuid', help='Namespace UUID (optional)') 2636 p.add_argument('-a', '--anagrpid', help='ANA group ID (optional)', type=int) 2637 p.set_defaults(func=nvmf_subsystem_add_ns) 2638 2639 def nvmf_subsystem_remove_ns(args): 2640 rpc.nvmf.nvmf_subsystem_remove_ns(args.client, 2641 nqn=args.nqn, 2642 nsid=args.nsid, 2643 tgt_name=args.tgt_name) 2644 2645 p = subparsers.add_parser('nvmf_subsystem_remove_ns', help='Remove a namespace to an NVMe-oF subsystem') 2646 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 2647 p.add_argument('nsid', help='The requested NSID', type=int) 2648 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2649 p.set_defaults(func=nvmf_subsystem_remove_ns) 2650 2651 def nvmf_subsystem_add_host(args): 2652 rpc.nvmf.nvmf_subsystem_add_host(args.client, 2653 nqn=args.nqn, 2654 host=args.host, 2655 tgt_name=args.tgt_name, 2656 psk=args.psk) 2657 2658 p = subparsers.add_parser('nvmf_subsystem_add_host', help='Add a host to an NVMe-oF subsystem') 2659 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 2660 p.add_argument('host', help='Host NQN to allow') 2661 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2662 p.add_argument('--psk', help='Path to PSK file for TLS authentication (optional). Only applicable for TCP transport.', type=str) 2663 p.set_defaults(func=nvmf_subsystem_add_host) 2664 2665 def nvmf_subsystem_remove_host(args): 2666 rpc.nvmf.nvmf_subsystem_remove_host(args.client, 2667 nqn=args.nqn, 2668 host=args.host, 2669 tgt_name=args.tgt_name) 2670 2671 p = subparsers.add_parser('nvmf_subsystem_remove_host', help='Remove a host from an NVMe-oF subsystem') 2672 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 2673 p.add_argument('host', help='Host NQN to remove') 2674 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2675 p.set_defaults(func=nvmf_subsystem_remove_host) 2676 2677 def nvmf_subsystem_allow_any_host(args): 2678 rpc.nvmf.nvmf_subsystem_allow_any_host(args.client, 2679 nqn=args.nqn, 2680 disable=args.disable, 2681 tgt_name=args.tgt_name) 2682 2683 p = subparsers.add_parser('nvmf_subsystem_allow_any_host', help='Allow any host to connect to the subsystem') 2684 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 2685 p.add_argument('-e', '--enable', action='store_true', help='Enable allowing any host') 2686 p.add_argument('-d', '--disable', action='store_true', help='Disable allowing any host') 2687 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2688 p.set_defaults(func=nvmf_subsystem_allow_any_host) 2689 2690 def nvmf_subsystem_get_controllers(args): 2691 print_dict(rpc.nvmf.nvmf_subsystem_get_controllers(args.client, 2692 nqn=args.nqn, 2693 tgt_name=args.tgt_name)) 2694 2695 p = subparsers.add_parser('nvmf_subsystem_get_controllers', 2696 help='Display controllers of an NVMe-oF subsystem.') 2697 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 2698 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2699 p.set_defaults(func=nvmf_subsystem_get_controllers) 2700 2701 def nvmf_subsystem_get_qpairs(args): 2702 print_dict(rpc.nvmf.nvmf_subsystem_get_qpairs(args.client, 2703 nqn=args.nqn, 2704 tgt_name=args.tgt_name)) 2705 2706 p = subparsers.add_parser('nvmf_subsystem_get_qpairs', 2707 help='Display queue pairs of an NVMe-oF subsystem.') 2708 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 2709 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2710 p.set_defaults(func=nvmf_subsystem_get_qpairs) 2711 2712 def nvmf_subsystem_get_listeners(args): 2713 print_dict(rpc.nvmf.nvmf_subsystem_get_listeners(args.client, 2714 nqn=args.nqn, 2715 tgt_name=args.tgt_name)) 2716 2717 p = subparsers.add_parser('nvmf_subsystem_get_listeners', 2718 help='Display listeners of an NVMe-oF subsystem.') 2719 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 2720 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2721 p.set_defaults(func=nvmf_subsystem_get_listeners) 2722 2723 def nvmf_get_stats(args): 2724 print_dict(rpc.nvmf.nvmf_get_stats(args.client, tgt_name=args.tgt_name)) 2725 2726 p = subparsers.add_parser( 2727 'nvmf_get_stats', help='Display current statistics for NVMf subsystem') 2728 p.add_argument('-t', '--tgt-name', help='The name of the parent NVMe-oF target (optional)', type=str) 2729 p.set_defaults(func=nvmf_get_stats) 2730 2731 def nvmf_set_crdt(args): 2732 print_dict(rpc.nvmf.nvmf_set_crdt(args.client, args.crdt1, args.crdt2, args.crdt3)) 2733 2734 p = subparsers.add_parser( 2735 'nvmf_set_crdt', 2736 help="""Set the 3 crdt (Command Retry Delay Time) values for NVMf subsystem. All 2737 values are in units of 100 milliseconds (same as the NVM Express specification).""") 2738 p.add_argument('-t1', '--crdt1', help='Command Retry Delay Time 1, in units of 100 milliseconds', type=int) 2739 p.add_argument('-t2', '--crdt2', help='Command Retry Delay Time 2, in units of 100 milliseconds', type=int) 2740 p.add_argument('-t3', '--crdt3', help='Command Retry Delay Time 3, in units of 100 milliseconds', type=int) 2741 p.set_defaults(func=nvmf_set_crdt) 2742 2743 # subsystem 2744 def framework_get_subsystems(args): 2745 print_dict(rpc.subsystem.framework_get_subsystems(args.client)) 2746 2747 p = subparsers.add_parser('framework_get_subsystems', 2748 help="""Print subsystems array in initialization order. Each subsystem 2749 entry contain (unsorted) array of subsystems it depends on.""") 2750 p.set_defaults(func=framework_get_subsystems) 2751 2752 def framework_get_config(args): 2753 print_dict(rpc.subsystem.framework_get_config(args.client, args.name)) 2754 2755 p = subparsers.add_parser('framework_get_config', help="""Print subsystem configuration""") 2756 p.add_argument('name', help='Name of subsystem to query') 2757 p.set_defaults(func=framework_get_config) 2758 2759 # vhost 2760 def vhost_controller_set_coalescing(args): 2761 rpc.vhost.vhost_controller_set_coalescing(args.client, 2762 ctrlr=args.ctrlr, 2763 delay_base_us=args.delay_base_us, 2764 iops_threshold=args.iops_threshold) 2765 2766 p = subparsers.add_parser('vhost_controller_set_coalescing', help='Set vhost controller coalescing') 2767 p.add_argument('ctrlr', help='controller name') 2768 p.add_argument('delay_base_us', help='Base delay time', type=int) 2769 p.add_argument('iops_threshold', help='IOPS threshold when coalescing is enabled', type=int) 2770 p.set_defaults(func=vhost_controller_set_coalescing) 2771 2772 def virtio_blk_create_transport(args): 2773 rpc.vhost.virtio_blk_create_transport(**vars(args)) 2774 2775 p = subparsers.add_parser('virtio_blk_create_transport', 2776 help='Create virtio blk transport') 2777 p.add_argument('name', help='transport name') 2778 p.set_defaults(func=virtio_blk_create_transport) 2779 2780 def virtio_blk_get_transports(args): 2781 print_dict(rpc.vhost.virtio_blk_get_transports(args.client, name=args.name)) 2782 2783 p = subparsers.add_parser('virtio_blk_get_transports', help='Display virtio-blk transports or requested transport') 2784 p.add_argument('--name', help='Transport name (optional)', type=str) 2785 p.set_defaults(func=virtio_blk_get_transports) 2786 2787 def vhost_create_scsi_controller(args): 2788 rpc.vhost.vhost_create_scsi_controller(args.client, 2789 ctrlr=args.ctrlr, 2790 cpumask=args.cpumask, 2791 delay=args.delay) 2792 2793 p = subparsers.add_parser('vhost_create_scsi_controller', help='Add new vhost controller') 2794 p.add_argument('ctrlr', help='controller name') 2795 p.add_argument('--cpumask', help='cpu mask for this controller') 2796 p.add_argument("--delay", action='store_true', help='whether delay starting controller or not') 2797 p.set_defaults(func=vhost_create_scsi_controller) 2798 2799 def vhost_start_scsi_controller(args): 2800 rpc.vhost.vhost_start_scsi_controller(args.client, 2801 ctrlr=args.ctrlr) 2802 2803 p = subparsers.add_parser('vhost_start_scsi_controller', help='Start vhost scsi controller') 2804 p.add_argument('ctrlr', help='controller name') 2805 p.set_defaults(func=vhost_start_scsi_controller) 2806 2807 def vhost_scsi_controller_add_target(args): 2808 print_json(rpc.vhost.vhost_scsi_controller_add_target(args.client, 2809 ctrlr=args.ctrlr, 2810 scsi_target_num=args.scsi_target_num, 2811 bdev_name=args.bdev_name)) 2812 2813 p = subparsers.add_parser('vhost_scsi_controller_add_target', help='Add lun to vhost controller') 2814 p.add_argument('ctrlr', help='controller name where add lun') 2815 p.add_argument('scsi_target_num', help='scsi_target_num', type=int) 2816 p.add_argument('bdev_name', help='bdev name') 2817 p.set_defaults(func=vhost_scsi_controller_add_target) 2818 2819 def vhost_scsi_controller_remove_target(args): 2820 rpc.vhost.vhost_scsi_controller_remove_target(args.client, 2821 ctrlr=args.ctrlr, 2822 scsi_target_num=args.scsi_target_num) 2823 2824 p = subparsers.add_parser('vhost_scsi_controller_remove_target', 2825 help='Remove target from vhost controller') 2826 p.add_argument('ctrlr', help='controller name to remove target from') 2827 p.add_argument('scsi_target_num', help='scsi_target_num', type=int) 2828 p.set_defaults(func=vhost_scsi_controller_remove_target) 2829 2830 def vhost_create_blk_controller(args): 2831 rpc.vhost.vhost_create_blk_controller(**vars(args)) 2832 2833 p = subparsers.add_parser('vhost_create_blk_controller', help='Add a new vhost block controller') 2834 p.add_argument('ctrlr', help='controller name') 2835 p.add_argument('dev_name', help='device name') 2836 p.add_argument('--cpumask', help='cpu mask for this controller') 2837 p.add_argument('--transport', help='virtio blk transport name (default: vhost_user_blk)') 2838 p.add_argument("-r", "--readonly", action='store_true', help='Set controller as read-only') 2839 p.add_argument("-p", "--packed_ring", action='store_true', help='Set controller as packed ring supported') 2840 p.set_defaults(func=vhost_create_blk_controller) 2841 2842 def vhost_get_controllers(args): 2843 print_dict(rpc.vhost.vhost_get_controllers(args.client, args.name)) 2844 2845 p = subparsers.add_parser('vhost_get_controllers', help='List all or specific vhost controller(s)') 2846 p.add_argument('-n', '--name', help="Name of vhost controller", required=False) 2847 p.set_defaults(func=vhost_get_controllers) 2848 2849 def vhost_delete_controller(args): 2850 rpc.vhost.vhost_delete_controller(args.client, 2851 ctrlr=args.ctrlr) 2852 2853 p = subparsers.add_parser('vhost_delete_controller', help='Delete a vhost controller') 2854 p.add_argument('ctrlr', help='controller name') 2855 p.set_defaults(func=vhost_delete_controller) 2856 2857 def bdev_virtio_attach_controller(args): 2858 print_array(rpc.vhost.bdev_virtio_attach_controller(args.client, 2859 name=args.name, 2860 trtype=args.trtype, 2861 traddr=args.traddr, 2862 dev_type=args.dev_type, 2863 vq_count=args.vq_count, 2864 vq_size=args.vq_size)) 2865 2866 p = subparsers.add_parser('bdev_virtio_attach_controller', 2867 help="""Attach virtio controller using provided 2868 transport type and device type. This will also create bdevs for any block devices connected to the 2869 controller (for example, SCSI devices for a virtio-scsi controller). 2870 Result is array of added bdevs.""") 2871 p.add_argument('name', help="Use this name as base for new created bdevs") 2872 p.add_argument('-t', '--trtype', 2873 help='Virtio target transport type: pci or user', required=True) 2874 p.add_argument('-a', '--traddr', 2875 help='Transport type specific target address: e.g. UNIX domain socket path or BDF', required=True) 2876 p.add_argument('-d', '--dev-type', 2877 help='Device type: blk or scsi', required=True) 2878 p.add_argument('--vq-count', help='Number of virtual queues to be used.', type=int) 2879 p.add_argument('--vq-size', help='Size of each queue', type=int) 2880 p.set_defaults(func=bdev_virtio_attach_controller) 2881 2882 def bdev_virtio_scsi_get_devices(args): 2883 print_dict(rpc.vhost.bdev_virtio_scsi_get_devices(args.client)) 2884 2885 p = subparsers.add_parser('bdev_virtio_scsi_get_devices', help='List all Virtio-SCSI devices.') 2886 p.set_defaults(func=bdev_virtio_scsi_get_devices) 2887 2888 def bdev_virtio_detach_controller(args): 2889 rpc.vhost.bdev_virtio_detach_controller(args.client, 2890 name=args.name) 2891 2892 p = subparsers.add_parser('bdev_virtio_detach_controller', help="""Remove a Virtio device 2893 This will delete all bdevs exposed by this device""") 2894 p.add_argument('name', help='Virtio device name. E.g. VirtioUser0') 2895 p.set_defaults(func=bdev_virtio_detach_controller) 2896 2897 def bdev_virtio_blk_set_hotplug(args): 2898 rpc.vhost.bdev_virtio_blk_set_hotplug(args.client, enable=args.enable, period_us=args.period_us) 2899 2900 p = subparsers.add_parser('bdev_virtio_blk_set_hotplug', help='Set hotplug options for bdev virtio_blk type.') 2901 p.add_argument('-d', '--disable', dest='enable', default=False, action='store_false', help="Disable hotplug (default)") 2902 p.add_argument('-e', '--enable', dest='enable', action='store_true', help="Enable hotplug") 2903 p.add_argument('-r', '--period-us', 2904 help='How often the hotplug is processed for insert and remove events', type=int) 2905 p.set_defaults(func=bdev_virtio_blk_set_hotplug) 2906 2907 # vfio-user target 2908 def vfu_tgt_set_base_path(args): 2909 rpc.vfio_user.vfu_tgt_set_base_path(args.client, path=args.path) 2910 2911 p = subparsers.add_parser('vfu_tgt_set_base_path', help='Set socket base path.') 2912 p.add_argument('path', help='socket base path') 2913 p.set_defaults(func=vfu_tgt_set_base_path) 2914 2915 def vfu_virtio_delete_endpoint(args): 2916 rpc.vfio_user.vfu_virtio_delete_endpoint(args.client, name=args.name) 2917 2918 p = subparsers.add_parser('vfu_virtio_delete_endpoint', help='Delete the PCI device via endpoint name.') 2919 p.add_argument('name', help='Endpoint name') 2920 p.set_defaults(func=vfu_virtio_delete_endpoint) 2921 2922 def vfu_virtio_create_blk_endpoint(args): 2923 rpc.vfio_user.vfu_virtio_create_blk_endpoint(args.client, 2924 name=args.name, 2925 bdev_name=args.bdev_name, 2926 cpumask=args.cpumask, 2927 num_queues=args.num_queues, 2928 qsize=args.qsize, 2929 packed_ring=args.packed_ring) 2930 2931 p = subparsers.add_parser('vfu_virtio_create_blk_endpoint', help='Create virtio-blk endpoint.') 2932 p.add_argument('name', help='Name of the endpoint') 2933 p.add_argument('--bdev-name', help='block device name', type=str, required=True) 2934 p.add_argument('--cpumask', help='CPU masks') 2935 p.add_argument('--num-queues', help='number of vrings', type=int, default=0) 2936 p.add_argument('--qsize', help='number of element for each vring', type=int, default=0) 2937 p.add_argument("--packed-ring", action='store_true', help='Enable packed ring') 2938 p.set_defaults(func=vfu_virtio_create_blk_endpoint) 2939 2940 def vfu_virtio_scsi_add_target(args): 2941 rpc.vfio_user.vfu_virtio_scsi_add_target(args.client, 2942 name=args.name, 2943 scsi_target_num=args.scsi_target_num, 2944 bdev_name=args.bdev_name) 2945 2946 p = subparsers.add_parser('vfu_virtio_scsi_add_target', help='Attach a block device to SCSI target of PCI endpoint.') 2947 p.add_argument('name', help='Name of the endpoint') 2948 p.add_argument('--scsi-target-num', help='number of SCSI Target', type=int, required=True) 2949 p.add_argument('--bdev-name', help='block device name', type=str, required=True) 2950 p.set_defaults(func=vfu_virtio_scsi_add_target) 2951 2952 def vfu_virtio_scsi_remove_target(args): 2953 rpc.vfio_user.vfu_virtio_scsi_remove_target(args.client, 2954 name=args.name, 2955 scsi_target_num=args.scsi_target_num) 2956 2957 p = subparsers.add_parser('vfu_virtio_scsi_remove_target', help='Remove the specified SCSI target of PCI endpoint.') 2958 p.add_argument('name', help='Name of the endpoint') 2959 p.add_argument('--scsi-target-num', help='number of SCSI Target', type=int, required=True) 2960 p.set_defaults(func=vfu_virtio_scsi_remove_target) 2961 2962 def vfu_virtio_create_scsi_endpoint(args): 2963 rpc.vfio_user.vfu_virtio_create_scsi_endpoint(args.client, 2964 name=args.name, 2965 cpumask=args.cpumask, 2966 num_io_queues=args.num_io_queues, 2967 qsize=args.qsize, 2968 packed_ring=args.packed_ring) 2969 2970 p = subparsers.add_parser('vfu_virtio_create_scsi_endpoint', help='Create virtio-scsi endpoint.') 2971 p.add_argument('name', help='Name of the endpoint') 2972 p.add_argument('--cpumask', help='CPU masks') 2973 p.add_argument('--num-io-queues', help='number of IO vrings', type=int, default=0) 2974 p.add_argument('--qsize', help='number of element for each vring', type=int, default=0) 2975 p.add_argument("--packed-ring", action='store_true', help='Enable packed ring') 2976 p.set_defaults(func=vfu_virtio_create_scsi_endpoint) 2977 2978 # accel_fw 2979 def accel_get_opc_assignments(args): 2980 print_dict(rpc.accel.accel_get_opc_assignments(args.client)) 2981 2982 p = subparsers.add_parser('accel_get_opc_assignments', help='Get list of opcode name to module assignments.') 2983 p.set_defaults(func=accel_get_opc_assignments) 2984 2985 def accel_get_module_info(args): 2986 print_dict(rpc.accel.accel_get_module_info(args.client)) 2987 2988 p = subparsers.add_parser('accel_get_module_info', aliases=['accel_get_engine_info'], 2989 help='Get list of valid module names and their operations.') 2990 p.set_defaults(func=accel_get_module_info) 2991 2992 def accel_assign_opc(args): 2993 rpc.accel.accel_assign_opc(args.client, opname=args.opname, module=args.module) 2994 2995 p = subparsers.add_parser('accel_assign_opc', help='Manually assign an operation to a module.') 2996 p.add_argument('-o', '--opname', help='opname') 2997 p.add_argument('-m', '--module', help='name of module') 2998 p.set_defaults(func=accel_assign_opc) 2999 3000 def accel_crypto_key_create(args): 3001 print_dict(rpc.accel.accel_crypto_key_create(args.client, 3002 cipher=args.cipher, 3003 key=args.key, 3004 key2=args.key2, 3005 tweak_mode=args.tweak_mode, 3006 name=args.name)) 3007 3008 p = subparsers.add_parser('accel_crypto_key_create', help='Create encryption key') 3009 p.add_argument('-c', '--cipher', help='cipher', required=True) 3010 p.add_argument('-k', '--key', help='key', required=True) 3011 p.add_argument('-e', '--key2', help='key2', required=False, default=None) 3012 p.add_argument('-t', '--tweak-mode', help='tweak mode', required=False, default=None) 3013 p.add_argument('-n', '--name', help='key name', required=True) 3014 p.set_defaults(func=accel_crypto_key_create) 3015 3016 def accel_crypto_key_destroy(args): 3017 print_dict(rpc.accel.accel_crypto_key_destroy(args.client, 3018 key_name=args.name)) 3019 3020 p = subparsers.add_parser('accel_crypto_key_destroy', help='Destroy encryption key') 3021 p.add_argument('-n', '--name', help='key name', required=True, type=str) 3022 p.set_defaults(func=accel_crypto_key_destroy) 3023 3024 def accel_crypto_keys_get(args): 3025 print_dict(rpc.accel.accel_crypto_keys_get(args.client, 3026 key_name=args.key_name)) 3027 3028 p = subparsers.add_parser('accel_crypto_keys_get', help='Get a list of the crypto keys') 3029 p.add_argument('-k', '--key-name', help='Get information about a specific key', type=str) 3030 p.set_defaults(func=accel_crypto_keys_get) 3031 3032 def accel_set_driver(args): 3033 rpc.accel.accel_set_driver(args.client, name=args.name) 3034 3035 p = subparsers.add_parser('accel_set_driver', help='Select accel platform driver to execute ' + 3036 'operation chains') 3037 p.add_argument('name', help='name of the platform driver') 3038 p.set_defaults(func=accel_set_driver) 3039 3040 def accel_set_options(args): 3041 rpc.accel.accel_set_options(args.client, args.small_cache_size, args.large_cache_size, 3042 args.task_count, args.sequence_count, args.buf_count) 3043 3044 p = subparsers.add_parser('accel_set_options', help='Set accel framework\'s options') 3045 p.add_argument('--small-cache-size', type=int, help='Size of the small iobuf cache') 3046 p.add_argument('--large-cache-size', type=int, help='Size of the large iobuf cache') 3047 p.add_argument('--task-count', type=int, help='Maximum number of tasks per IO channel') 3048 p.add_argument('--sequence-count', type=int, help='Maximum number of sequences per IO channel') 3049 p.add_argument('--buf-count', type=int, help='Maximum number of buffers per IO channel') 3050 p.set_defaults(func=accel_set_options) 3051 3052 def accel_get_stats(args): 3053 print_dict(rpc.accel.accel_get_stats(args.client)) 3054 3055 p = subparsers.add_parser('accel_get_stats', help='Display accel framework\'s statistics') 3056 p.set_defaults(func=accel_get_stats) 3057 3058 # ioat 3059 def ioat_scan_accel_module(args): 3060 rpc.ioat.ioat_scan_accel_module(args.client) 3061 3062 p = subparsers.add_parser('ioat_scan_accel_module', aliases=['ioat_scan_accel_engine'], 3063 help='Enable IOAT accel module offload.') 3064 p.set_defaults(func=ioat_scan_accel_module) 3065 3066 # dpdk compressdev 3067 def compressdev_scan_accel_module(args): 3068 rpc.compressdev.compressdev_scan_accel_module(args.client, pmd=args.pmd) 3069 3070 p = subparsers.add_parser('compressdev_scan_accel_module', help='Scan and enable compressdev module and set pmd option.') 3071 p.add_argument('-p', '--pmd', type=int, help='0 = auto-select, 1= QAT only, 2 = mlx5_pci only') 3072 p.set_defaults(func=compressdev_scan_accel_module) 3073 3074 # dsa 3075 def dsa_scan_accel_module(args): 3076 rpc.dsa.dsa_scan_accel_module(args.client, config_kernel_mode=args.config_kernel_mode) 3077 3078 p = subparsers.add_parser('dsa_scan_accel_module', aliases=['dsa_scan_accel_engine'], 3079 help='Set config and enable dsa accel module offload.') 3080 p.add_argument('-k', '--config-kernel-mode', help='Use Kernel mode dsa', 3081 action='store_true', dest='config_kernel_mode') 3082 p.set_defaults(func=dsa_scan_accel_module, config_kernel_mode=None) 3083 3084 # iaa 3085 def iaa_scan_accel_module(args): 3086 rpc.iaa.iaa_scan_accel_module(args.client) 3087 3088 p = subparsers.add_parser('iaa_scan_accel_module', aliases=['iaa_scan_accel_engine'], 3089 help='Set config and enable iaa accel module offload.') 3090 p.set_defaults(func=iaa_scan_accel_module) 3091 3092 def dpdk_cryptodev_scan_accel_module(args): 3093 rpc.dpdk_cryptodev.dpdk_cryptodev_scan_accel_module(args.client) 3094 3095 p = subparsers.add_parser('dpdk_cryptodev_scan_accel_module', 3096 help='Enable dpdk_cryptodev accel module offload.') 3097 p.set_defaults(func=dpdk_cryptodev_scan_accel_module) 3098 3099 def dpdk_cryptodev_set_driver(args): 3100 rpc.dpdk_cryptodev.dpdk_cryptodev_set_driver(args.client, 3101 driver_name=args.driver_name) 3102 3103 p = subparsers.add_parser('dpdk_cryptodev_set_driver', 3104 help='Set the DPDK cryptodev driver.') 3105 p.add_argument('-d', '--driver-name', help='The driver, can be one of crypto_aesni_mb, crypto_qat or mlx5_pci', type=str) 3106 p.set_defaults(func=dpdk_cryptodev_set_driver) 3107 3108 def dpdk_cryptodev_get_driver(args): 3109 print_dict(rpc.dpdk_cryptodev.dpdk_cryptodev_get_driver(args.client)) 3110 3111 p = subparsers.add_parser('dpdk_cryptodev_get_driver', help='Get the DPDK cryptodev driver') 3112 p.set_defaults(func=dpdk_cryptodev_get_driver) 3113 3114 # mlx5 3115 def mlx5_scan_accel_module(args): 3116 rpc.mlx5.mlx5_scan_accel_module(args.client, 3117 qp_size=args.qp_size, 3118 num_requests=args.num_requests) 3119 3120 p = subparsers.add_parser('mlx5_scan_accel_module', help='Enable mlx5 accel module.') 3121 p.add_argument('-q', '--qp-size', type=int, help='QP size') 3122 p.add_argument('-r', '--num-requests', type=int, help='Size of the shared requests pool') 3123 p.set_defaults(func=mlx5_scan_accel_module) 3124 3125 # accel_error 3126 def accel_error_inject_error(args): 3127 rpc.accel.accel_error_inject_error(args.client, opcode=args.opcode, 3128 type=args.type, count=args.count, 3129 interval=args.interval, errcode=args.errcode) 3130 3131 p = subparsers.add_parser('accel_error_inject_error', 3132 help='Inject an error to processing accel operation') 3133 p.add_argument('-o', '--opcode', help='Opcode') 3134 p.add_argument('-t', '--type', 3135 help='Error type ("corrupt": corrupt the data, "failure": fail the operation, "disable": disable error injection)') 3136 p.add_argument('-c', '--count', type=int, 3137 help='Number of errors to inject on each IO channel (0 to disable error injection)') 3138 p.add_argument('-i', '--interval', type=int, help='Interval between injections') 3139 p.add_argument('--errcode', type=int, help='Error code to inject (only relevant for type=failure)') 3140 p.set_defaults(func=accel_error_inject_error) 3141 3142 # opal 3143 def bdev_nvme_opal_init(args): 3144 rpc.nvme.bdev_nvme_opal_init(args.client, 3145 nvme_ctrlr_name=args.nvme_ctrlr_name, 3146 password=args.password) 3147 3148 p = subparsers.add_parser('bdev_nvme_opal_init', help='take ownership and activate') 3149 p.add_argument('-b', '--nvme-ctrlr-name', help='nvme ctrlr name') 3150 p.add_argument('-p', '--password', help='password for admin') 3151 p.set_defaults(func=bdev_nvme_opal_init) 3152 3153 def bdev_nvme_opal_revert(args): 3154 rpc.nvme.bdev_nvme_opal_revert(args.client, 3155 nvme_ctrlr_name=args.nvme_ctrlr_name, 3156 password=args.password) 3157 p = subparsers.add_parser('bdev_nvme_opal_revert', help='Revert to default factory settings') 3158 p.add_argument('-b', '--nvme-ctrlr-name', help='nvme ctrlr name') 3159 p.add_argument('-p', '--password', help='password') 3160 p.set_defaults(func=bdev_nvme_opal_revert) 3161 3162 def bdev_opal_create(args): 3163 print_json(rpc.bdev.bdev_opal_create(args.client, 3164 nvme_ctrlr_name=args.nvme_ctrlr_name, 3165 nsid=args.nsid, 3166 locking_range_id=args.locking_range_id, 3167 range_start=args.range_start, 3168 range_length=args.range_length, 3169 password=args.password)) 3170 3171 p = subparsers.add_parser('bdev_opal_create', help="""Create opal bdev on specified NVMe controller""") 3172 p.add_argument('-b', '--nvme-ctrlr-name', help='nvme ctrlr name', required=True) 3173 p.add_argument('-n', '--nsid', help='namespace ID (only support nsid=1 for now)', type=int, required=True) 3174 p.add_argument('-i', '--locking-range-id', help='locking range id', type=int, required=True) 3175 p.add_argument('-s', '--range-start', help='locking range start LBA', type=int, required=True) 3176 p.add_argument('-l', '--range-length', help='locking range length (in blocks)', type=int, required=True) 3177 p.add_argument('-p', '--password', help='admin password', required=True) 3178 p.set_defaults(func=bdev_opal_create) 3179 3180 def bdev_opal_get_info(args): 3181 print_dict(rpc.bdev.bdev_opal_get_info(args.client, 3182 bdev_name=args.bdev_name, 3183 password=args.password)) 3184 3185 p = subparsers.add_parser('bdev_opal_get_info', help='get opal locking range info for this bdev') 3186 p.add_argument('-b', '--bdev-name', help='opal bdev') 3187 p.add_argument('-p', '--password', help='password') 3188 p.set_defaults(func=bdev_opal_get_info) 3189 3190 def bdev_opal_delete(args): 3191 rpc.bdev.bdev_opal_delete(args.client, 3192 bdev_name=args.bdev_name, 3193 password=args.password) 3194 3195 p = subparsers.add_parser('bdev_opal_delete', help="""delete a virtual opal bdev""") 3196 p.add_argument('-b', '--bdev-name', help='opal virtual bdev', required=True) 3197 p.add_argument('-p', '--password', help='admin password', required=True) 3198 p.set_defaults(func=bdev_opal_delete) 3199 3200 def bdev_opal_new_user(args): 3201 rpc.bdev.bdev_opal_new_user(args.client, 3202 bdev_name=args.bdev_name, 3203 admin_password=args.admin_password, 3204 user_id=args.user_id, 3205 user_password=args.user_password) 3206 3207 p = subparsers.add_parser('bdev_opal_new_user', help="""Add a user to opal bdev who can set lock state for this bdev""") 3208 p.add_argument('-b', '--bdev-name', help='opal bdev', required=True) 3209 p.add_argument('-p', '--admin-password', help='admin password', required=True) 3210 p.add_argument('-i', '--user-id', help='ID for new user', type=int, required=True) 3211 p.add_argument('-u', '--user-password', help='password set for this user', required=True) 3212 p.set_defaults(func=bdev_opal_new_user) 3213 3214 def bdev_opal_set_lock_state(args): 3215 rpc.bdev.bdev_opal_set_lock_state(args.client, 3216 bdev_name=args.bdev_name, 3217 user_id=args.user_id, 3218 password=args.password, 3219 lock_state=args.lock_state) 3220 3221 p = subparsers.add_parser('bdev_opal_set_lock_state', help="""set lock state for an opal bdev""") 3222 p.add_argument('-b', '--bdev-name', help='opal bdev', required=True) 3223 p.add_argument('-i', '--user-id', help='ID of the user who want to set lock state, either admin or a user assigned to this bdev', 3224 type=int, required=True) 3225 p.add_argument('-p', '--password', help='password of this user', required=True) 3226 p.add_argument('-l', '--lock-state', help='lock state to set, choose from {readwrite, readonly, rwlock}', required=True) 3227 p.set_defaults(func=bdev_opal_set_lock_state) 3228 3229 # bdev_nvme_send_cmd 3230 def bdev_nvme_send_cmd(args): 3231 print_dict(rpc.nvme.bdev_nvme_send_cmd(args.client, 3232 name=args.nvme_name, 3233 cmd_type=args.cmd_type, 3234 data_direction=args.data_direction, 3235 cmdbuf=args.cmdbuf, 3236 data=args.data, 3237 metadata=args.metadata, 3238 data_len=args.data_length, 3239 metadata_len=args.metadata_length, 3240 timeout_ms=args.timeout_ms)) 3241 3242 p = subparsers.add_parser('bdev_nvme_send_cmd', help='NVMe passthrough cmd.') 3243 p.add_argument('-n', '--nvme-name', help="""Name of the operating NVMe controller""") 3244 p.add_argument('-t', '--cmd-type', help="""Type of nvme cmd. Valid values are: admin, io""") 3245 p.add_argument('-r', '--data-direction', help="""Direction of data transfer. Valid values are: c2h, h2c""") 3246 p.add_argument('-c', '--cmdbuf', help="""NVMe command encoded by base64 urlsafe""") 3247 p.add_argument('-d', '--data', help="""Data transferring to controller from host, encoded by base64 urlsafe""") 3248 p.add_argument('-m', '--metadata', help="""Metadata transferring to controller from host, encoded by base64 urlsafe""") 3249 p.add_argument('-D', '--data-length', help="""Data length required to transfer from controller to host""", type=int) 3250 p.add_argument('-M', '--metadata-length', help="""Metadata length required to transfer from controller to host""", type=int) 3251 p.add_argument('-T', '--timeout-ms', 3252 help="""Command execution timeout value, in milliseconds, if 0, don't track timeout""", type=int) 3253 p.set_defaults(func=bdev_nvme_send_cmd) 3254 3255 # Notifications 3256 def notify_get_types(args): 3257 print_dict(rpc.notify.notify_get_types(args.client)) 3258 3259 p = subparsers.add_parser('notify_get_types', help='List available notifications that user can subscribe to.') 3260 p.set_defaults(func=notify_get_types) 3261 3262 def notify_get_notifications(args): 3263 ret = rpc.notify.notify_get_notifications(args.client, 3264 id=args.id, 3265 max=args.max) 3266 print_dict(ret) 3267 3268 p = subparsers.add_parser('notify_get_notifications', help='Get notifications') 3269 p.add_argument('-i', '--id', help="""First ID to start fetching from""", type=int) 3270 p.add_argument('-n', '--max', help="""Maximum number of notifications to return in response""", type=int) 3271 p.set_defaults(func=notify_get_notifications) 3272 3273 def thread_get_stats(args): 3274 print_dict(rpc.app.thread_get_stats(args.client)) 3275 3276 p = subparsers.add_parser( 3277 'thread_get_stats', help='Display current statistics of all the threads') 3278 p.set_defaults(func=thread_get_stats) 3279 3280 def thread_set_cpumask(args): 3281 ret = rpc.app.thread_set_cpumask(args.client, 3282 id=args.id, 3283 cpumask=args.cpumask) 3284 p = subparsers.add_parser('thread_set_cpumask', 3285 help="""set the cpumask of the thread whose ID matches to the 3286 specified value. The thread may be migrated to one of the specified CPUs.""") 3287 p.add_argument('-i', '--id', type=int, help='thread ID') 3288 p.add_argument('-m', '--cpumask', help='cpumask for this thread') 3289 p.set_defaults(func=thread_set_cpumask) 3290 3291 def log_enable_timestamps(args): 3292 ret = rpc.app.log_enable_timestamps(args.client, 3293 enabled=args.enabled) 3294 p = subparsers.add_parser('log_enable_timestamps', 3295 help='Enable or disable timestamps.') 3296 p.add_argument('-d', '--disable', dest='enabled', default=False, action='store_false', help="Disable timestamps") 3297 p.add_argument('-e', '--enable', dest='enabled', action='store_true', help="Enable timestamps") 3298 p.set_defaults(func=log_enable_timestamps) 3299 3300 def thread_get_pollers(args): 3301 print_dict(rpc.app.thread_get_pollers(args.client)) 3302 3303 p = subparsers.add_parser( 3304 'thread_get_pollers', help='Display current pollers of all the threads') 3305 p.set_defaults(func=thread_get_pollers) 3306 3307 def thread_get_io_channels(args): 3308 print_dict(rpc.app.thread_get_io_channels(args.client)) 3309 3310 p = subparsers.add_parser( 3311 'thread_get_io_channels', help='Display current IO channels of all the threads') 3312 p.set_defaults(func=thread_get_io_channels) 3313 3314 def env_dpdk_get_mem_stats(args): 3315 print_dict(rpc.env_dpdk.env_dpdk_get_mem_stats(args.client)) 3316 3317 p = subparsers.add_parser( 3318 'env_dpdk_get_mem_stats', help='write the dpdk memory stats to a file.') 3319 p.set_defaults(func=env_dpdk_get_mem_stats) 3320 3321 # blobfs 3322 def blobfs_detect(args): 3323 print(rpc.blobfs.blobfs_detect(args.client, 3324 bdev_name=args.bdev_name)) 3325 3326 p = subparsers.add_parser('blobfs_detect', help='Detect whether a blobfs exists on bdev') 3327 p.add_argument('bdev_name', help='Blockdev name to detect blobfs. Example: Malloc0.') 3328 p.set_defaults(func=blobfs_detect) 3329 3330 def blobfs_create(args): 3331 print(rpc.blobfs.blobfs_create(args.client, 3332 bdev_name=args.bdev_name, 3333 cluster_sz=args.cluster_sz)) 3334 3335 p = subparsers.add_parser('blobfs_create', help='Build a blobfs on bdev') 3336 p.add_argument('bdev_name', help='Blockdev name to build blobfs. Example: Malloc0.') 3337 p.add_argument('-c', '--cluster-sz', 3338 help="""Size of cluster in bytes (Optional). Must be multiple of 4KB page size. Default and minimal value is 1M.""") 3339 p.set_defaults(func=blobfs_create) 3340 3341 def blobfs_mount(args): 3342 print(rpc.blobfs.blobfs_mount(args.client, 3343 bdev_name=args.bdev_name, 3344 mountpoint=args.mountpoint)) 3345 3346 p = subparsers.add_parser('blobfs_mount', help='Mount a blobfs on bdev to host path by FUSE') 3347 p.add_argument('bdev_name', help='Blockdev name where the blobfs is. Example: Malloc0.') 3348 p.add_argument('mountpoint', help='Mountpoint path in host to mount blobfs. Example: /mnt/.') 3349 p.set_defaults(func=blobfs_mount) 3350 3351 def blobfs_set_cache_size(args): 3352 print(rpc.blobfs.blobfs_set_cache_size(args.client, 3353 size_in_mb=args.size_in_mb)) 3354 3355 p = subparsers.add_parser('blobfs_set_cache_size', help='Set cache size for blobfs') 3356 p.add_argument('size_in_mb', help='Cache size for blobfs in megabytes.', type=int) 3357 p.set_defaults(func=blobfs_set_cache_size) 3358 3359 # sock 3360 def sock_impl_get_options(args): 3361 print_json(rpc.sock.sock_impl_get_options(args.client, 3362 impl_name=args.impl)) 3363 3364 p = subparsers.add_parser('sock_impl_get_options', help="""Get options of socket layer implementation""") 3365 p.add_argument('-i', '--impl', help='Socket implementation name, e.g. posix', required=True) 3366 p.set_defaults(func=sock_impl_get_options) 3367 3368 def sock_impl_set_options(args): 3369 rpc.sock.sock_impl_set_options(args.client, 3370 impl_name=args.impl, 3371 recv_buf_size=args.recv_buf_size, 3372 send_buf_size=args.send_buf_size, 3373 enable_recv_pipe=args.enable_recv_pipe, 3374 enable_quickack=args.enable_quickack, 3375 enable_placement_id=args.enable_placement_id, 3376 enable_zerocopy_send_server=args.enable_zerocopy_send_server, 3377 enable_zerocopy_send_client=args.enable_zerocopy_send_client, 3378 zerocopy_threshold=args.zerocopy_threshold, 3379 tls_version=args.tls_version, 3380 enable_ktls=args.enable_ktls) 3381 3382 p = subparsers.add_parser('sock_impl_set_options', help="""Set options of socket layer implementation""") 3383 p.add_argument('-i', '--impl', help='Socket implementation name, e.g. posix', required=True) 3384 p.add_argument('-r', '--recv-buf-size', help='Size of receive buffer on socket in bytes', type=int) 3385 p.add_argument('-s', '--send-buf-size', help='Size of send buffer on socket in bytes', type=int) 3386 p.add_argument('-p', '--enable-placement-id', help='Option for placement-id. 0:disable,1:incoming_napi,2:incoming_cpu', type=int) 3387 p.add_argument('--enable-recv-pipe', help='Enable receive pipe', 3388 action='store_true', dest='enable_recv_pipe') 3389 p.add_argument('--disable-recv-pipe', help='Disable receive pipe', 3390 action='store_false', dest='enable_recv_pipe') 3391 p.add_argument('--enable-quickack', help='Enable quick ACK', 3392 action='store_true', dest='enable_quickack') 3393 p.add_argument('--disable-quickack', help='Disable quick ACK', 3394 action='store_false', dest='enable_quickack') 3395 p.add_argument('--enable-zerocopy-send-server', help='Enable zerocopy on send for server sockets', 3396 action='store_true', dest='enable_zerocopy_send_server') 3397 p.add_argument('--disable-zerocopy-send-server', help='Disable zerocopy on send for server sockets', 3398 action='store_false', dest='enable_zerocopy_send_server') 3399 p.add_argument('--enable-zerocopy-send-client', help='Enable zerocopy on send for client sockets', 3400 action='store_true', dest='enable_zerocopy_send_client') 3401 p.add_argument('--disable-zerocopy-send-client', help='Disable zerocopy on send for client sockets', 3402 action='store_false', dest='enable_zerocopy_send_client') 3403 p.add_argument('--zerocopy-threshold', help='Set zerocopy_threshold in bytes', type=int) 3404 p.add_argument('--tls-version', help='TLS protocol version', type=int) 3405 p.add_argument('--enable-ktls', help='Enable Kernel TLS', 3406 action='store_true', dest='enable_ktls') 3407 p.add_argument('--disable-ktls', help='Disable Kernel TLS', 3408 action='store_false', dest='enable_ktls') 3409 p.set_defaults(func=sock_impl_set_options, enable_recv_pipe=None, enable_quickack=None, 3410 enable_placement_id=None, enable_zerocopy_send_server=None, enable_zerocopy_send_client=None, 3411 zerocopy_threshold=None, tls_version=None, enable_ktls=None) 3412 3413 def sock_set_default_impl(args): 3414 print_json(rpc.sock.sock_set_default_impl(args.client, 3415 impl_name=args.impl)) 3416 3417 p = subparsers.add_parser('sock_set_default_impl', help="""Set the default sock implementation""") 3418 p.add_argument('-i', '--impl', help='Socket implementation name, e.g. posix', required=True) 3419 p.set_defaults(func=sock_set_default_impl) 3420 3421 def framework_get_pci_devices(args): 3422 def splitbuf(buf, step): 3423 return [buf[i:i+step] for i in range(0, len(buf), step)] 3424 3425 devices = rpc.subsystem.framework_get_pci_devices(args.client) 3426 if not args.format_lspci: 3427 print_json(devices) 3428 else: 3429 for devid, dev in enumerate(devices): 3430 print('{} device #{}'.format(dev['address'], devid)) 3431 for lineid, line in enumerate(splitbuf(dev['config_space'], 32)): 3432 print('{:02x}: {}'.format(lineid * 16, ' '.join(splitbuf(line.lower(), 2)))) 3433 print() 3434 3435 p = subparsers.add_parser('framework_get_pci_devices', help='''Get a list of attached PCI devices''') 3436 p.add_argument('--format-lspci', help='Format the output in a way to be consumed by lspci -F', 3437 action='store_true') 3438 p.set_defaults(func=framework_get_pci_devices) 3439 3440 # bdev_nvme_add_error_injection 3441 def bdev_nvme_add_error_injection(args): 3442 print_dict(rpc.nvme.bdev_nvme_add_error_injection(args.client, 3443 name=args.nvme_name, 3444 cmd_type=args.cmd_type, 3445 opc=args.opc, 3446 do_not_submit=args.do_not_submit, 3447 timeout_in_us=args.timeout_in_us, 3448 err_count=args.err_count, 3449 sct=args.sct, 3450 sc=args.sc)) 3451 p = subparsers.add_parser('bdev_nvme_add_error_injection', 3452 help='Add a NVMe command error injection.') 3453 p.add_argument('-n', '--nvme-name', help="""Name of the operating NVMe controller""", required=True) 3454 p.add_argument('-t', '--cmd-type', help="""Type of NVMe command. Valid values are: admin, io""", required=True) 3455 p.add_argument('-o', '--opc', help="""Opcode of the NVMe command.""", required=True, type=int) 3456 p.add_argument('-s', '--do-not-submit', 3457 help="""Set to true if request should not be submitted to the controller""", 3458 dest="do_not_submit", action='store_true') 3459 p.add_argument('-w', '--timeout-in-us', help="""Wait specified microseconds when do_not_submit is true""", type=int) 3460 p.add_argument('-e', '--err-count', help="""Number of matching NVMe commands to inject errors""", type=int) 3461 p.add_argument('-u', '--sct', help="""Status code type""", type=int) 3462 p.add_argument('-c', '--sc', help="""Status code""", type=int) 3463 p.set_defaults(func=bdev_nvme_add_error_injection) 3464 3465 # bdev_nvme_remove_error_injection 3466 def bdev_nvme_remove_error_injection(args): 3467 print_dict(rpc.nvme.bdev_nvme_remove_error_injection(args.client, 3468 name=args.nvme_name, 3469 cmd_type=args.cmd_type, 3470 opc=args.opc)) 3471 p = subparsers.add_parser('bdev_nvme_remove_error_injection', 3472 help='Removes a NVMe command error injection.') 3473 p.add_argument('-n', '--nvme-name', help="""Name of the operating NVMe controller""", required=True) 3474 p.add_argument('-t', '--cmd-type', help="""Type of nvme cmd. Valid values are: admin, io""", required=True) 3475 p.add_argument('-o', '--opc', help="""Opcode of the nvme cmd.""", required=True, type=int) 3476 p.set_defaults(func=bdev_nvme_remove_error_injection) 3477 3478 def bdev_daos_create(args): 3479 num_blocks = (args.total_size * 1024 * 1024) // args.block_size 3480 print_json(rpc.bdev.bdev_daos_create(args.client, 3481 num_blocks=int(num_blocks), 3482 block_size=args.block_size, 3483 name=args.name, 3484 uuid=args.uuid, 3485 pool=args.pool, 3486 cont=args.cont, 3487 oclass=args.oclass)) 3488 p = subparsers.add_parser('bdev_daos_create', 3489 help='Create a bdev with DAOS backend') 3490 p.add_argument('name', help="Name of the bdev") 3491 p.add_argument('pool', help="UUID of the DAOS pool") 3492 p.add_argument('cont', help="UUID of the DAOS container") 3493 p.add_argument( 3494 'total_size', help='Size of DAOS bdev in MB (float > 0)', type=float) 3495 p.add_argument('block_size', help='Block size for this bdev', type=int) 3496 p.add_argument('-u', '--uuid', help="UUID of the bdev") 3497 p.add_argument('-o', '--oclass', help="DAOS object class") 3498 p.set_defaults(func=bdev_daos_create) 3499 3500 def bdev_daos_delete(args): 3501 rpc.bdev.bdev_daos_delete(args.client, 3502 name=args.name) 3503 3504 p = subparsers.add_parser('bdev_daos_delete', 3505 help='Delete a DAOS disk') 3506 p.add_argument('name', help='DAOS bdev name') 3507 p.set_defaults(func=bdev_daos_delete) 3508 3509 def bdev_daos_resize(args): 3510 print_json(rpc.bdev.bdev_daos_resize(args.client, 3511 name=args.name, 3512 new_size=int(args.new_size))) 3513 3514 p = subparsers.add_parser('bdev_daos_resize', 3515 help='Resize a DAOS bdev') 3516 p.add_argument('name', help='DAOS bdev name') 3517 p.add_argument('new_size', help='new bdev size for resize operation. The unit is MiB') 3518 p.set_defaults(func=bdev_daos_resize) 3519 3520 def iobuf_set_options(args): 3521 rpc.iobuf.iobuf_set_options(args.client, 3522 small_pool_count=args.small_pool_count, 3523 large_pool_count=args.large_pool_count, 3524 small_bufsize=args.small_bufsize, 3525 large_bufsize=args.large_bufsize) 3526 p = subparsers.add_parser('iobuf_set_options', help='Set iobuf pool options') 3527 p.add_argument('--small-pool-count', help='number of small buffers in the global pool', type=int) 3528 p.add_argument('--large-pool-count', help='number of large buffers in the global pool', type=int) 3529 p.add_argument('--small-bufsize', help='size of a small buffer', type=int) 3530 p.add_argument('--large-bufsize', help='size of a large buffer', type=int) 3531 p.set_defaults(func=iobuf_set_options) 3532 3533 def iobuf_get_stats(args): 3534 print_dict(rpc.iobuf.iobuf_get_stats(args.client)) 3535 3536 p = subparsers.add_parser('iobuf_get_stats', help='Display iobuf statistics') 3537 p.set_defaults(func=iobuf_get_stats) 3538 3539 def bdev_nvme_start_mdns_discovery(args): 3540 rpc.bdev.bdev_nvme_start_mdns_discovery(args.client, 3541 name=args.name, 3542 svcname=args.svcname, 3543 hostnqn=args.hostnqn) 3544 3545 p = subparsers.add_parser('bdev_nvme_start_mdns_discovery', help='Start mdns based automatic discovery') 3546 p.add_argument('-b', '--name', help="Name of the NVMe controller prefix for each bdev name", required=True) 3547 p.add_argument('-s', '--svcname', help='Service type to discover: e.g., _nvme-disc._tcp', required=True) 3548 p.add_argument('-q', '--hostnqn', help='NVMe-oF host subnqn') 3549 p.set_defaults(func=bdev_nvme_start_mdns_discovery) 3550 3551 def bdev_nvme_stop_mdns_discovery(args): 3552 rpc.bdev.bdev_nvme_stop_mdns_discovery(args.client, name=args.name) 3553 3554 p = subparsers.add_parser('bdev_nvme_stop_mdns_discovery', help='Stop automatic mdns discovery') 3555 p.add_argument('-b', '--name', help="Name of the service to stop", required=True) 3556 p.set_defaults(func=bdev_nvme_stop_mdns_discovery) 3557 3558 def bdev_nvme_get_mdns_discovery_info(args): 3559 print_dict(rpc.bdev.bdev_nvme_get_mdns_discovery_info(args.client)) 3560 3561 p = subparsers.add_parser('bdev_nvme_get_mdns_discovery_info', help='Get information about the automatic mdns discovery') 3562 p.set_defaults(func=bdev_nvme_get_mdns_discovery_info) 3563 3564 def check_called_name(name): 3565 if name in deprecated_aliases: 3566 print("{} is deprecated, use {} instead.".format(name, deprecated_aliases[name]), file=sys.stderr) 3567 3568 class dry_run_client: 3569 def call(self, method, params=None): 3570 print("Request:\n" + json.dumps({"method": method, "params": params}, indent=2)) 3571 3572 def null_print(arg): 3573 pass 3574 3575 def call_rpc_func(args): 3576 args.func(args) 3577 check_called_name(args.called_rpc_name) 3578 3579 def execute_script(parser, client, fd): 3580 executed_rpc = "" 3581 for rpc_call in map(str.rstrip, fd): 3582 if not rpc_call.strip(): 3583 continue 3584 executed_rpc = "\n".join([executed_rpc, rpc_call]) 3585 rpc_args = shlex.split(rpc_call) 3586 if rpc_args[0][0] == '#': 3587 # Ignore lines starting with # - treat them as comments 3588 continue 3589 args = parser.parse_args(rpc_args) 3590 args.client = client 3591 try: 3592 call_rpc_func(args) 3593 except JSONRPCException as ex: 3594 print("Exception:") 3595 print(executed_rpc.strip() + " <<<") 3596 print(ex.message) 3597 exit(1) 3598 3599 def load_plugin(args): 3600 # Create temporary parser, pull out the plugin parameter, load the module, and then run the real argument parser 3601 plugin_parser = argparse.ArgumentParser(add_help=False) 3602 plugin_parser.add_argument('--plugin', dest='rpc_plugin', help='Module name of plugin with additional RPC commands') 3603 3604 rpc_module = plugin_parser.parse_known_args()[0].rpc_plugin 3605 if args is not None: 3606 rpc_module = plugin_parser.parse_known_args(args)[0].rpc_plugin 3607 3608 if rpc_module in plugins: 3609 return 3610 3611 if rpc_module is not None: 3612 try: 3613 rpc_plugin = importlib.import_module(rpc_module) 3614 try: 3615 rpc_plugin.spdk_rpc_plugin_initialize(subparsers) 3616 plugins.append(rpc_module) 3617 except AttributeError: 3618 print("Module %s does not contain 'spdk_rpc_plugin_initialize' function" % rpc_module) 3619 except ModuleNotFoundError: 3620 print("Module %s not found" % rpc_module) 3621 3622 def replace_arg_underscores(args): 3623 # All option names are defined with dashes only - for example: --tgt-name 3624 # But if user used underscores, convert them to dashes (--tgt_name => --tgt-name) 3625 # SPDK was inconsistent previously and had some options with underscores, so 3626 # doing this conversion ensures backward compatibility with older scripts. 3627 for i in range(len(args)): 3628 arg = args[i] 3629 if arg.startswith('--') and "_" in arg: 3630 opt, *vals = arg.split('=') 3631 args[i] = '='.join([opt.replace('_', '-'), *vals]) 3632 3633 plugins = [] 3634 load_plugin(None) 3635 3636 replace_arg_underscores(sys.argv) 3637 3638 args = parser.parse_args() 3639 3640 try: 3641 use_go_client = int(os.getenv('SPDK_JSONRPC_GO_CLIENT', 0)) == 1 3642 except ValueError: 3643 use_go_client = False 3644 3645 if sys.stdin.isatty() and not hasattr(args, 'func'): 3646 # No arguments and no data piped through stdin 3647 parser.print_help() 3648 exit(1) 3649 if args.is_server: 3650 for input in sys.stdin: 3651 cmd = shlex.split(input) 3652 replace_arg_underscores(cmd) 3653 try: 3654 load_plugin(cmd) 3655 tmp_args = parser.parse_args(cmd) 3656 except SystemExit as ex: 3657 print("**STATUS=1", flush=True) 3658 continue 3659 3660 try: 3661 if use_go_client: 3662 tmp_args.client = rpc.client.JSONRPCGoClient(tmp_args.server_addr, 3663 log_level=getattr(logging, tmp_args.verbose.upper())) 3664 else: 3665 tmp_args.client = rpc.client.JSONRPCClient( 3666 tmp_args.server_addr, tmp_args.port, tmp_args.timeout, 3667 log_level=getattr(logging, tmp_args.verbose.upper()), conn_retries=tmp_args.conn_retries) 3668 call_rpc_func(tmp_args) 3669 print("**STATUS=0", flush=True) 3670 except JSONRPCException as ex: 3671 print(ex.message) 3672 print("**STATUS=1", flush=True) 3673 exit(0) 3674 elif args.dry_run: 3675 args.client = dry_run_client() 3676 print_dict = null_print 3677 print_json = null_print 3678 print_array = null_print 3679 elif args.go_client or use_go_client: 3680 try: 3681 args.client = rpc.client.JSONRPCGoClient(args.server_addr, 3682 log_level=getattr(logging, args.verbose.upper())) 3683 except JSONRPCException as ex: 3684 print(ex.message) 3685 exit(1) 3686 else: 3687 try: 3688 args.client = rpc.client.JSONRPCClient(args.server_addr, args.port, args.timeout, 3689 log_level=getattr(logging, args.verbose.upper()), 3690 conn_retries=args.conn_retries) 3691 except JSONRPCException as ex: 3692 print(ex.message) 3693 exit(1) 3694 3695 if hasattr(args, 'func'): 3696 try: 3697 call_rpc_func(args) 3698 except JSONRPCException as ex: 3699 print(ex.message) 3700 exit(1) 3701 else: 3702 execute_script(parser, args.client, sys.stdin) 3703