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