1#!/usr/bin/env python 2 3import argparse 4import json 5import socket 6 7try: 8 from shlex import quote 9except ImportError: 10 from pipes import quote 11 12def print_dict(d): 13 print json.dumps(d, indent=2) 14 15def print_array(a): 16 print " ".join((quote(v) for v in a)) 17 18parser = argparse.ArgumentParser(description='SPDK RPC command line interface') 19parser.add_argument('-s', dest='server_addr', help='RPC server address', default='/var/tmp/spdk.sock') 20parser.add_argument('-p', dest='port', help='RPC port number (if server_addr is IP address)', default=5260, type=int) 21parser.add_argument('-v', dest='verbose', help='Verbose mode', action='store_true') 22subparsers = parser.add_subparsers(help='RPC methods') 23 24 25def int_arg(arg): 26 return int(arg, 0) 27 28 29def jsonrpc_call(method, params={}): 30 if args.server_addr.startswith('/'): 31 s = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM) 32 s.connect(args.server_addr) 33 else: 34 s = socket.socket(socket.AF_INET, socket.SOCK_STREAM) 35 s.connect((args.server_addr, args.port)) 36 req = {} 37 req['jsonrpc'] = '2.0' 38 req['method'] = method 39 req['id'] = 1 40 if (params): 41 req['params'] = params 42 reqstr = json.dumps(req) 43 44 if args.verbose: 45 print("request:") 46 print(json.dumps(req, indent=2)) 47 48 s.sendall(reqstr) 49 buf = '' 50 closed = False 51 response = {} 52 while not closed: 53 newdata = s.recv(4096) 54 if (newdata == b''): 55 closed = True 56 buf += newdata 57 try: 58 response = json.loads(buf) 59 except ValueError: 60 continue # incomplete response; keep buffering 61 break 62 s.close() 63 64 if not response: 65 if method == "kill_instance": 66 exit(0) 67 print "Connection closed with partial response:" 68 print buf 69 exit(1) 70 71 if 'error' in response: 72 print "Got JSON-RPC error response" 73 print "request:" 74 print_dict(json.loads(reqstr)) 75 print "response:" 76 print_dict(response['error']) 77 exit(1) 78 79 if args.verbose: 80 print("response:") 81 print(json.dumps(response, indent=2)) 82 83 return response['result'] 84 85def get_luns(args): 86 print_dict(jsonrpc_call('get_luns')) 87 88p = subparsers.add_parser('get_luns', help='Display active LUNs') 89p.set_defaults(func=get_luns) 90 91 92def get_portal_groups(args): 93 print_dict(jsonrpc_call('get_portal_groups')) 94 95p = subparsers.add_parser('get_portal_groups', help='Display current portal group configuration') 96p.set_defaults(func=get_portal_groups) 97 98 99def get_initiator_groups(args): 100 print_dict(jsonrpc_call('get_initiator_groups')) 101 102p = subparsers.add_parser('get_initiator_groups', help='Display current initiator group configuration') 103p.set_defaults(func=get_initiator_groups) 104 105 106def get_target_nodes(args): 107 print_dict(jsonrpc_call('get_target_nodes')) 108 109p = subparsers.add_parser('get_target_nodes', help='Display target nodes') 110p.set_defaults(func=get_target_nodes) 111 112 113def construct_target_node(args): 114 lun_name_id_dict = dict(u.split(":") 115 for u in args.lun_name_id_pairs.strip().split(" ")) 116 lun_names = lun_name_id_dict.keys() 117 lun_ids = list(map(int, lun_name_id_dict.values())) 118 119 pg_tags = [] 120 ig_tags = [] 121 for u in args.pg_ig_mappings.strip().split(" "): 122 pg, ig = u.split(":") 123 pg_tags.append(int(pg)) 124 ig_tags.append(int(ig)) 125 126 params = { 127 'name': args.name, 128 'alias_name': args.alias_name, 129 'pg_tags': pg_tags, 130 'ig_tags': ig_tags, 131 'lun_names': lun_names, 132 'lun_ids': lun_ids, 133 'queue_depth': args.queue_depth, 134 'chap_disabled': args.chap_disabled, 135 'chap_required': args.chap_required, 136 'chap_mutual': args.chap_mutual, 137 'chap_auth_group': args.chap_auth_group, 138 } 139 jsonrpc_call('construct_target_node', params) 140 141p = subparsers.add_parser('construct_target_node', help='Add a target node') 142p.add_argument('name', help='Target node name (ASCII)') 143p.add_argument('alias_name', help='Target node alias name (ASCII)') 144p.add_argument('lun_name_id_pairs', help="""Whitespace-separated list of LUN <name:id> pairs enclosed 145in quotes. Format: 'lun_name0:id0 lun_name1:id1' etc 146Example: 'Malloc0:0 Malloc1:1 Malloc5:2' 147*** The LUNs must pre-exist *** 148*** LUN0 (id = 0) is required *** 149*** LUN names cannot contain space or colon characters ***""") 150p.add_argument('pg_ig_mappings', help="""List of (Portal_Group_Tag:Initiator_Group_Tag) mappings 151Whitespace separated, quoted, mapping defined with colon 152separated list of "tags" (int > 0) 153Example: '1:1 2:2 2:1' 154*** The Portal/Initiator Groups must be precreated ***""") 155p.add_argument('queue_depth', help='Desired target queue depth', type=int) 156p.add_argument('chap_disabled', help="""CHAP authentication should be disabled for this target node. 157*** Mutually exclusive with chap_required ***""", type=int) 158p.add_argument('chap_required', help="""CHAP authentication should be required for this target node. 159*** Mutually exclusive with chap_disabled ***""", type=int) 160p.add_argument('chap_mutual', help='CHAP authentication should be mutual/bidirectional.', type=int) 161p.add_argument('chap_auth_group', help="""Authentication group ID for this target node. 162*** Authentication group must be precreated ***""", type=int) 163p.set_defaults(func=construct_target_node) 164 165 166def add_pg_ig_maps(args): 167 pg_tags = [] 168 ig_tags = [] 169 for u in args.pg_ig_mappings.strip().split(" "): 170 pg, ig = u.split(":") 171 pg_tags.append(int(pg)) 172 ig_tags.append(int(ig)) 173 174 params = { 175 'name': args.name, 176 'pg_tags': pg_tags, 177 'ig_tags': ig_tags, 178 } 179 jsonrpc_call('add_pg_ig_maps', params) 180 181p = subparsers.add_parser('add_pg_ig_maps', help='Add PG-IG maps to the target node') 182p.add_argument('name', help='Target node name (ASCII)') 183p.add_argument('pg_ig_mappings', help="""List of (Portal_Group_Tag:Initiator_Group_Tag) mappings 184Whitespace separated, quoted, mapping defined with colon 185separated list of "tags" (int > 0) 186Example: '1:1 2:2 2:1' 187*** The Portal/Initiator Groups must be precreated ***""") 188p.set_defaults(func=add_pg_ig_maps) 189 190 191def delete_pg_ig_maps(args): 192 pg_tags = [] 193 ig_tags = [] 194 for u in args.pg_ig_mappings.strip().split(" "): 195 pg, ig = u.split(":") 196 pg_tags.append(int(pg)) 197 ig_tags.append(int(ig)) 198 199 params = { 200 'name': args.name, 201 'pg_tags': pg_tags, 202 'ig_tags': ig_tags, 203 } 204 jsonrpc_call('delete_pg_ig_maps', params) 205 206p = subparsers.add_parser('delete_pg_ig_maps', help='Delete PG-IG maps from the target node') 207p.add_argument('name', help='Target node name (ASCII)') 208p.add_argument('pg_ig_mappings', help="""List of (Portal_Group_Tag:Initiator_Group_Tag) mappings 209Whitespace separated, quoted, mapping defined with colon 210separated list of "tags" (int > 0) 211Example: '1:1 2:2 2:1' 212*** The Portal/Initiator Groups must be precreated ***""") 213p.set_defaults(func=delete_pg_ig_maps) 214 215 216def construct_malloc_bdev(args): 217 num_blocks = (args.total_size * 1024 * 1024) / args.block_size 218 params = {'num_blocks': num_blocks, 'block_size': args.block_size} 219 if args.name: 220 params['name'] = args.name 221 print_array(jsonrpc_call('construct_malloc_bdev', params)) 222 223p = subparsers.add_parser('construct_malloc_bdev', help='Add a bdev with malloc backend') 224p.add_argument('-b', '--name', help="Name of the bdev") 225p.add_argument('total_size', help='Size of malloc bdev in MB (int > 0)', type=int) 226p.add_argument('block_size', help='Block size for this bdev', type=int) 227p.set_defaults(func=construct_malloc_bdev) 228 229 230def create_pmem_pool(args): 231 num_blocks = (args.total_size * 1024 * 1024) / args.block_size 232 params = {'pmem_file': args.pmem_file, 233 'num_blocks': num_blocks, 234 'block_size': args.block_size} 235 jsonrpc_call('create_pmem_pool', params) 236 237p = subparsers.add_parser('create_pmem_pool', help='Create pmem pool') 238p.add_argument('pmem_file', help='Path to pmemblk pool file') 239p.add_argument('total_size', help='Size of malloc bdev in MB (int > 0)', type=int) 240p.add_argument('block_size', help='Block size for this pmem pool', type=int) 241p.set_defaults(func=create_pmem_pool) 242 243 244def pmem_pool_info(args): 245 params = {'pmem_file': args.pmem_file} 246 print_dict(jsonrpc_call('pmem_pool_info', params)) 247 248p = subparsers.add_parser('pmem_pool_info', help='Display pmem pool info and check consistency') 249p.add_argument('pmem_file', help='Path to pmemblk pool file') 250p.set_defaults(func=pmem_pool_info) 251 252 253def delete_pmem_pool(args): 254 params = {'pmem_file': args.pmem_file} 255 jsonrpc_call('delete_pmem_pool', params) 256 257p = subparsers.add_parser('delete_pmem_pool', help='Delete pmem pool') 258p.add_argument('pmem_file', help='Path to pmemblk pool file') 259p.set_defaults(func=delete_pmem_pool) 260 261 262def construct_pmem_bdev(args): 263 params = { 264 'pmem_file': args.pmem_file, 265 'name': args.name 266 } 267 print_array(jsonrpc_call('construct_pmem_bdev', params)) 268 269p = subparsers.add_parser('construct_pmem_bdev', help='Add a bdev with pmem backend') 270p.add_argument('pmem_file', help='Path to pmemblk pool file') 271p.add_argument('-n', '--name', help='Block device name', required=True) 272p.set_defaults(func=construct_pmem_bdev) 273 274def construct_null_bdev(args): 275 num_blocks = (args.total_size * 1024 * 1024) / args.block_size 276 params = {'name': args.name, 'num_blocks': num_blocks, 'block_size': args.block_size} 277 print_array(jsonrpc_call('construct_null_bdev', params)) 278 279p = subparsers.add_parser('construct_null_bdev', help='Add a bdev with null backend') 280p.add_argument('name', help='Block device name') 281p.add_argument('total_size', help='Size of null bdev in MB (int > 0)', type=int) 282p.add_argument('block_size', help='Block size for this bdev', type=int) 283p.set_defaults(func=construct_null_bdev) 284 285 286def construct_aio_bdev(args): 287 params = {'name': args.name, 288 'filename': args.filename} 289 290 if args.block_size: 291 params['block_size'] = args.block_size 292 293 print_array(jsonrpc_call('construct_aio_bdev', params)) 294 295p = subparsers.add_parser('construct_aio_bdev', help='Add a bdev with aio backend') 296p.add_argument('filename', help='Path to device or file (ex: /dev/sda)') 297p.add_argument('name', help='Block device name') 298p.add_argument('block_size', help='Block size for this bdev', type=int, default=argparse.SUPPRESS) 299p.set_defaults(func=construct_aio_bdev) 300 301def construct_nvme_bdev(args): 302 params = {'name': args.name, 303 'trtype': args.trtype, 304 'traddr': args.traddr} 305 306 if args.adrfam: 307 params['adrfam'] = args.adrfam 308 309 if args.trsvcid: 310 params['trsvcid'] = args.trsvcid 311 312 if args.subnqn: 313 params['subnqn'] = args.subnqn 314 315 jsonrpc_call('construct_nvme_bdev', params) 316 317p = subparsers.add_parser('construct_nvme_bdev', help='Add bdev with nvme backend') 318p.add_argument('-b', '--name', help="Name of the bdev", required=True) 319p.add_argument('-t', '--trtype', help='NVMe-oF target trtype: e.g., rdma, pcie', required=True) 320p.add_argument('-a', '--traddr', help='NVMe-oF target address: e.g., an ip address or BDF', required=True) 321p.add_argument('-f', '--adrfam', help='NVMe-oF target adrfam: e.g., ipv4, ipv6, ib, fc, intra_host') 322p.add_argument('-s', '--trsvcid', help='NVMe-oF target trsvcid: e.g., a port number') 323p.add_argument('-n', '--subnqn', help='NVMe-oF target subnqn') 324p.set_defaults(func=construct_nvme_bdev) 325 326def construct_rbd_bdev(args): 327 params = { 328 'pool_name': args.pool_name, 329 'rbd_name': args.rbd_name, 330 'block_size': args.block_size, 331 } 332 print_array(jsonrpc_call('construct_rbd_bdev', params)) 333 334p = subparsers.add_parser('construct_rbd_bdev', help='Add a bdev with ceph rbd backend') 335p.add_argument('pool_name', help='rbd pool name') 336p.add_argument('rbd_name', help='rbd image name') 337p.add_argument('block_size', help='rbd block size', type=int) 338p.set_defaults(func=construct_rbd_bdev) 339 340def construct_error_bdev(args): 341 params = {'base_name': args.base_name} 342 jsonrpc_call('construct_error_bdev', params) 343p = subparsers.add_parser('construct_error_bdev', help='Add bdev with error injection backend') 344p.add_argument('base_name', help='base bdev name') 345p.set_defaults(func=construct_error_bdev) 346 347 348def construct_lvol_store(args): 349 params = {'bdev_name': args.bdev_name, 'lvs_name': args.lvs_name} 350 351 if args.cluster_sz: 352 params['cluster_sz'] = args.cluster_sz 353 354 print_array(jsonrpc_call('construct_lvol_store', params)) 355p = subparsers.add_parser('construct_lvol_store', help='Add logical volume store on base bdev') 356p.add_argument('bdev_name', help='base bdev name') 357p.add_argument('lvs_name', help='name for lvol store') 358p.add_argument('-c', '--cluster-sz', help='size of cluster (in bytes)', type=int, required=False) 359p.set_defaults(func=construct_lvol_store) 360 361 362def construct_lvol_bdev(args): 363 num_bytes = (args.size * 1024 * 1024) 364 params = {'lvol_name': args.lvol_name, 'size': num_bytes} 365 if (args.uuid and args.lvs_name) or (not args.uuid and not args.lvs_name): 366 print("You need to specify either uuid or name of lvolstore") 367 else: 368 if args.uuid: 369 params['uuid'] = args.uuid 370 if args.lvs_name: 371 params['lvs_name'] = args.lvs_name 372 print_array(jsonrpc_call('construct_lvol_bdev', params)) 373p = subparsers.add_parser('construct_lvol_bdev', help='Add a bdev with an logical volume backend') 374p.add_argument('-u', '--uuid', help='lvol store UUID', required=False) 375p.add_argument('-l', '--lvs_name', help='lvol store name', required=False) 376p.add_argument('lvol_name', help='name for this lvol') 377p.add_argument('size', help='size in MiB for this bdev', type=int) 378p.set_defaults(func=construct_lvol_bdev) 379 380# Logical volume resize feature is disabled, as it is currently work in progress 381# 382# def resize_lvol_bdev(args): 383# params = { 384# 'name': args.name, 385# 'size': args.size, 386# } 387# jsonrpc_call('resize_lvol_bdev', params) 388# p = subparsers.add_parser('resize_lvol_bdev', help='Resize existing lvol bdev') 389# p.add_argument('name', help='lvol bdev name') 390# p.add_argument('size', help='new size in MiB for this bdev', type=int) 391# p.set_defaults(func=resize_lvol_bdev) 392 393 394def destroy_lvol_store(args): 395 params = {} 396 if (args.uuid and args.lvs_name) or (not args.uuid and not args.lvs_name): 397 print("You need to specify either uuid or name of lvolstore") 398 else: 399 if args.uuid: 400 params['uuid'] = args.uuid 401 if args.lvs_name: 402 params['lvs_name'] = args.lvs_name 403 jsonrpc_call('destroy_lvol_store', params) 404p = subparsers.add_parser('destroy_lvol_store', help='Destroy an logical volume store') 405p.add_argument('-u', '--uuid', help='lvol store UUID', required=False) 406p.add_argument('-l', '--lvs_name', help='lvol store name', required=False) 407p.set_defaults(func=destroy_lvol_store) 408 409 410def get_lvol_stores(args): 411 print_dict(jsonrpc_call('get_lvol_stores')) 412 413p = subparsers.add_parser('get_lvol_stores', help='Display current logical volume store list') 414p.set_defaults(func=get_lvol_stores) 415 416 417def set_trace_flag(args): 418 params = {'flag': args.flag} 419 jsonrpc_call('set_trace_flag', params) 420 421p = subparsers.add_parser('set_trace_flag', help='set trace flag') 422p.add_argument('flag', help='trace mask we want to set. (for example "debug").') 423p.set_defaults(func=set_trace_flag) 424 425 426def clear_trace_flag(args): 427 params = {'flag': args.flag} 428 jsonrpc_call('clear_trace_flag', params) 429 430p = subparsers.add_parser('clear_trace_flag', help='clear trace flag') 431p.add_argument('flag', help='trace mask we want to clear. (for example "debug").') 432p.set_defaults(func=clear_trace_flag) 433 434 435def get_trace_flags(args): 436 print_dict(jsonrpc_call('get_trace_flags')) 437 438p = subparsers.add_parser('get_trace_flags', help='get trace flags') 439p.set_defaults(func=get_trace_flags) 440 441def set_log_level(args): 442 params = {'level': args.level} 443 jsonrpc_call('set_log_level', params) 444 445p = subparsers.add_parser('set_log_level', help='set log level') 446p.add_argument('level', help='log level we want to set. (for example "DEBUG").') 447p.set_defaults(func=set_log_level) 448 449def get_log_level(args): 450 print_dict(jsonrpc_call('get_log_level')) 451 452p = subparsers.add_parser('get_log_level', help='get log level') 453p.set_defaults(func=get_log_level) 454 455def set_log_print_level(args): 456 params = {'level': args.level} 457 jsonrpc_call('set_log_print_level', params) 458 459p = subparsers.add_parser('set_log_print_level', help='set log print level') 460p.add_argument('level', help='log print level we want to set. (for example "DEBUG").') 461p.set_defaults(func=set_log_print_level) 462 463def get_log_print_level(args): 464 print_dict(jsonrpc_call('get_log_print_level')) 465 466p = subparsers.add_parser('get_log_print_level', help='get log print level') 467p.set_defaults(func=get_log_print_level) 468 469def add_portal_group(args): 470 # parse out portal list host1:port1 host2:port2 471 portals = [] 472 for p in args.portal_list: 473 host_port = p.split(':') 474 portals.append({'host': host_port[0], 'port': host_port[1]}) 475 476 params = {'tag': args.tag, 'portals': portals} 477 jsonrpc_call('add_portal_group', params) 478 479p = subparsers.add_parser('add_portal_group', help='Add a portal group') 480p.add_argument('tag', help='Portal group tag (unique, integer > 0)', type=int) 481p.add_argument('portal_list', nargs=argparse.REMAINDER, help="""List of portals in 'host:port' format, separated by whitespace 482Example: '192.168.100.100:3260' '192.168.100.100:3261'""") 483p.set_defaults(func=add_portal_group) 484 485 486def add_initiator_group(args): 487 initiators = [] 488 netmasks = [] 489 for i in args.initiator_list.strip().split(' '): 490 initiators.append(i) 491 for n in args.netmask_list.strip().split(' '): 492 netmasks.append(n) 493 494 params = {'tag': args.tag, 'initiators': initiators, 'netmasks': netmasks} 495 jsonrpc_call('add_initiator_group', params) 496 497 498p = subparsers.add_parser('add_initiator_group', help='Add an initiator group') 499p.add_argument('tag', help='Initiator group tag (unique, integer > 0)', type=int) 500p.add_argument('initiator_list', help="""Whitespace-separated list of initiator hostnames or IP addresses, 501enclosed in quotes. Example: 'ANY' or '127.0.0.1 192.168.200.100'""") 502p.add_argument('netmask_list', help="""Whitespace-separated list of initiator netmasks enclosed in quotes. 503Example: '255.255.0.0 255.248.0.0' etc""") 504p.set_defaults(func=add_initiator_group) 505 506 507def delete_target_node(args): 508 params = {'name': args.target_node_name} 509 jsonrpc_call('delete_target_node', params) 510 511p = subparsers.add_parser('delete_target_node', help='Delete a target node') 512p.add_argument('target_node_name', help='Target node name to be deleted. Example: iqn.2016-06.io.spdk:disk1.') 513p.set_defaults(func=delete_target_node) 514 515 516def delete_portal_group(args): 517 params = {'tag': args.tag} 518 jsonrpc_call('delete_portal_group', params) 519 520p = subparsers.add_parser('delete_portal_group', help='Delete a portal group') 521p.add_argument('tag', help='Portal group tag (unique, integer > 0)', type=int) 522p.set_defaults(func=delete_portal_group) 523 524 525def delete_initiator_group(args): 526 params = {'tag': args.tag} 527 jsonrpc_call('delete_initiator_group', params) 528 529p = subparsers.add_parser('delete_initiator_group', help='Delete an initiator group') 530p.add_argument('tag', help='Initiator group tag (unique, integer > 0)', type=int) 531p.set_defaults(func=delete_initiator_group) 532 533 534def get_iscsi_connections(args): 535 print_dict(jsonrpc_call('get_iscsi_connections')) 536 537p = subparsers.add_parser('get_iscsi_connections', help='Display iSCSI connections') 538p.set_defaults(func=get_iscsi_connections) 539 540 541def get_iscsi_global_params(args): 542 print_dict(jsonrpc_call('get_iscsi_global_params')) 543 544p = subparsers.add_parser('get_iscsi_global_params', help='Display iSCSI global parameters') 545p.set_defaults(func=get_iscsi_global_params) 546 547 548def get_scsi_devices(args): 549 print_dict(jsonrpc_call('get_scsi_devices')) 550 551p = subparsers.add_parser('get_scsi_devices', help='Display SCSI devices') 552p.set_defaults(func=get_scsi_devices) 553 554 555def add_ip_address(args): 556 params = {'ifc_index': args.ifc_index, 'ip_address': args.ip_addr} 557 jsonrpc_call('add_ip_address', params) 558 559p = subparsers.add_parser('add_ip_address', help='Add IP address') 560p.add_argument('ifc_index', help='ifc index of the nic device.', type=int) 561p.add_argument('ip_addr', help='ip address will be added.') 562p.set_defaults(func=add_ip_address) 563 564 565def delete_ip_address(args): 566 params = {'ifc_index': args.ifc_index, 'ip_address': args.ip_addr} 567 jsonrpc_call('delete_ip_address', params) 568 569p = subparsers.add_parser('delete_ip_address', help='Delete IP address') 570p.add_argument('ifc_index', help='ifc index of the nic device.', type=int) 571p.add_argument('ip_addr', help='ip address will be deleted.') 572p.set_defaults(func=delete_ip_address) 573 574 575def get_interfaces(args): 576 print_dict(jsonrpc_call('get_interfaces')) 577 578p = subparsers.add_parser('get_interfaces', help='Display current interface list') 579p.set_defaults(func=get_interfaces) 580 581def apply_firmware(args): 582 583 params = { 584 'filename': args.filename, 585 'bdev_name': args.bdev_name, 586 } 587 588 print_dict(jsonrpc_call('apply_nvme_firmware', params)) 589 590p = subparsers.add_parser('apply_firmware', help='Download and commit firmware to NVMe device') 591p.add_argument('filename', help='filename of the firmware to download') 592p.add_argument('bdev_name', help='name of the NVMe device') 593p.set_defaults(func=apply_firmware) 594 595def get_bdevs(args): 596 params = {} 597 if args.name: 598 params['name'] = args.name 599 print_dict(jsonrpc_call('get_bdevs', params)) 600 601p = subparsers.add_parser('get_bdevs', help='Display current blockdev list or required blockdev') 602p.add_argument('-b', '--name', help="Name of the Blockdev. Example: Nvme0n1", required=False) 603p.set_defaults(func=get_bdevs) 604 605 606def delete_bdev(args): 607 params = {'name': args.bdev_name} 608 jsonrpc_call('delete_bdev', params) 609 610p = subparsers.add_parser('delete_bdev', help='Delete a blockdev') 611p.add_argument('bdev_name', help='Blockdev name to be deleted. Example: Malloc0.') 612p.set_defaults(func=delete_bdev) 613 614def start_nbd_disk(args): 615 params = { 616 'bdev_name': args.bdev_name, 617 'nbd_device': args.nbd_device 618 } 619 jsonrpc_call('start_nbd_disk', params) 620 621p = subparsers.add_parser('start_nbd_disk', help='Export a bdev as a nbd disk') 622p.add_argument('bdev_name', help='Blockdev name to be exported. Example: Malloc0.') 623p.add_argument('nbd_device', help='Nbd device name to be assigned. Example: /dev/nbd0.') 624p.set_defaults(func=start_nbd_disk) 625 626def stop_nbd_disk(args): 627 params = {'nbd_device': args.nbd_device} 628 jsonrpc_call('stop_nbd_disk', params) 629 630p = subparsers.add_parser('stop_nbd_disk', help='Stop a nbd disk') 631p.add_argument('nbd_device', help='Nbd device name to be stopped. Example: /dev/nbd0.') 632p.set_defaults(func=stop_nbd_disk) 633 634def get_nbd_disks(args): 635 params = {} 636 if args.nbd_device: 637 params['nbd_device'] = args.nbd_device 638 print_dict(jsonrpc_call('get_nbd_disks', params)) 639 640p = subparsers.add_parser('get_nbd_disks', help='Display full or specified nbd device list') 641p.add_argument('-n', '--nbd_device', help="Path of the nbd device. Example: /dev/nbd0", required=False) 642p.set_defaults(func=get_nbd_disks) 643 644def get_nvmf_subsystems(args): 645 print_dict(jsonrpc_call('get_nvmf_subsystems')) 646 647p = subparsers.add_parser('get_nvmf_subsystems', help='Display nvmf subsystems') 648p.set_defaults(func=get_nvmf_subsystems) 649 650def construct_nvmf_subsystem(args): 651 listen_addresses = [dict(u.split(":") for u in a.split(" ")) for a in args.listen.split(",")] 652 653 params = { 654 'nqn': args.nqn, 655 'listen_addresses': listen_addresses, 656 'serial_number': args.serial_number, 657 } 658 659 if args.hosts: 660 hosts = [] 661 for u in args.hosts.strip().split(" "): 662 hosts.append(u) 663 params['hosts'] = hosts 664 665 if args.allow_any_host: 666 params['allow_any_host'] = True 667 668 if args.namespaces: 669 namespaces = [] 670 for u in args.namespaces.strip().split(" "): 671 bdev_name = u 672 nsid = 0 673 if ':' in u: 674 (bdev_name, nsid) = u.split(":") 675 676 ns_params = {'bdev_name': bdev_name} 677 678 nsid = int(nsid) 679 if nsid != 0: 680 ns_params['nsid'] = nsid 681 682 namespaces.append(ns_params) 683 params['namespaces'] = namespaces 684 685 jsonrpc_call('construct_nvmf_subsystem', params) 686 687p = subparsers.add_parser('construct_nvmf_subsystem', help='Add a nvmf subsystem') 688p.add_argument('nqn', help='Target nqn(ASCII)') 689p.add_argument('listen', help="""comma-separated list of Listen <trtype:transport_name traddr:address trsvcid:port_id> pairs enclosed 690in quotes. Format: 'trtype:transport0 traddr:traddr0 trsvcid:trsvcid0,trtype:transport1 traddr:traddr1 trsvcid:trsvcid1' etc 691Example: 'trtype:RDMA traddr:192.168.100.8 trsvcid:4420,trtype:RDMA traddr:192.168.100.9 trsvcid:4420'""") 692p.add_argument('hosts', help="""Whitespace-separated list of host nqn list. 693Format: 'nqn1 nqn2' etc 694Example: 'nqn.2016-06.io.spdk:init nqn.2016-07.io.spdk:init'""") 695p.add_argument("-a", "--allow-any-host", action='store_true', help="Allow any host to connect (don't enforce host NQN whitelist)") 696p.add_argument("-s", "--serial_number", help=""" 697Format: 'sn' etc 698Example: 'SPDK00000000000001'""", default='0000:00:01.0') 699p.add_argument("-n", "--namespaces", help="""Whitespace-separated list of namespaces 700Format: 'bdev_name1[:nsid1] bdev_name2[:nsid2] bdev_name3[:nsid3]' etc 701Example: '1:Malloc0 2:Malloc1 3:Malloc2' 702*** The devices must pre-exist ***""") 703p.set_defaults(func=construct_nvmf_subsystem) 704 705def delete_nvmf_subsystem(args): 706 params = {'nqn': args.subsystem_nqn} 707 jsonrpc_call('delete_nvmf_subsystem', params) 708 709p = subparsers.add_parser('delete_nvmf_subsystem', help='Delete a nvmf subsystem') 710p.add_argument('subsystem_nqn', help='subsystem nqn to be deleted. Example: nqn.2016-06.io.spdk:cnode1.') 711p.set_defaults(func=delete_nvmf_subsystem) 712 713def bdev_inject_error(args): 714 params = { 715 'name': args.name, 716 'io_type': args.io_type, 717 'error_type': args.error_type, 718 'num': args.num, 719 } 720 721 jsonrpc_call('bdev_inject_error', params) 722 723p = subparsers.add_parser('bdev_inject_error', help='bdev inject error') 724p.add_argument('name', help="""the name of the error injection bdev""") 725p.add_argument('io_type', help="""io_type: 'clear' 'read' 'write' 'unmap' 'flush' 'all'""") 726p.add_argument('error_type', help="""error_type: 'failure' 'pending'""") 727p.add_argument('-n', '--num', help='the number of commands you want to fail', type=int, default=1) 728p.set_defaults(func=bdev_inject_error) 729 730def kill_instance(args): 731 params = {'sig_name': args.sig_name} 732 jsonrpc_call('kill_instance', params) 733 734p = subparsers.add_parser('kill_instance', help='Send signal to instance') 735p.add_argument('sig_name', help='signal will be sent to server.') 736p.set_defaults(func=kill_instance) 737 738def set_vhost_controller_coalescing(args): 739 params = { 740 'ctrlr': args.ctrlr, 741 'delay_base_us': args.delay_base_us, 742 'iops_threshold': args.iops_threshold, 743 } 744 jsonrpc_call('set_vhost_controller_coalescing', params) 745 746p = subparsers.add_parser('set_vhost_controller_coalescing', help='Set vhost controller coalescing') 747p.add_argument('ctrlr', help='controller name') 748p.add_argument('delay_base_us', help='Base delay time', type=int) 749p.add_argument('iops_threshold', help='IOPS threshold when coalescing is enabled', type=int) 750p.set_defaults(func=set_vhost_controller_coalescing) 751 752def construct_vhost_scsi_controller(args): 753 params = {'ctrlr': args.ctrlr} 754 755 if args.cpumask: 756 params['cpumask'] = args.cpumask 757 758 jsonrpc_call('construct_vhost_scsi_controller', params) 759 760p = subparsers.add_parser('construct_vhost_scsi_controller', help='Add new vhost controller') 761p.add_argument('ctrlr', help='controller name') 762p.add_argument('--cpumask', help='cpu mask for this controller') 763p.set_defaults(func=construct_vhost_scsi_controller) 764 765def add_vhost_scsi_lun(args): 766 params = { 767 'ctrlr': args.ctrlr, 768 'lun_name': args.lun_name, 769 'scsi_target_num': args.scsi_target_num 770 } 771 772 jsonrpc_call('add_vhost_scsi_lun', params) 773 774p = subparsers.add_parser('add_vhost_scsi_lun', help='Add lun to vhost controller') 775p.add_argument('ctrlr', help='conntroller name where add lun') 776p.add_argument('scsi_target_num', help='scsi_target_num', type=int) 777p.add_argument('lun_name', help='lun name') 778p.set_defaults(func=add_vhost_scsi_lun) 779 780def remove_vhost_scsi_target(args): 781 params = { 782 'ctrlr': args.ctrlr, 783 'scsi_target_num': args.scsi_target_num 784 } 785 jsonrpc_call('remove_vhost_scsi_target', params) 786 787p = subparsers.add_parser('remove_vhost_scsi_target', help='Remove target from vhost controller') 788p.add_argument('ctrlr', help='controller name to remove target from') 789p.add_argument('scsi_target_num', help='scsi_target_num', type=int) 790p.set_defaults(func=remove_vhost_scsi_target) 791 792def construct_vhost_blk_controller(args): 793 params = { 794 'ctrlr': args.ctrlr, 795 'dev_name': args.dev_name, 796 } 797 if args.cpumask: 798 params['cpumask'] = args.cpumask 799 if args.readonly: 800 params['readonly'] = args.readonly 801 jsonrpc_call('construct_vhost_blk_controller', params) 802 803p = subparsers.add_parser('construct_vhost_blk_controller', help='Add a new vhost block controller') 804p.add_argument('ctrlr', help='controller name') 805p.add_argument('dev_name', help='device name') 806p.add_argument('--cpumask', help='cpu mask for this controller') 807p.add_argument("-r", "--readonly", action='store_true', help='Set controller as read-only') 808p.set_defaults(func=construct_vhost_blk_controller) 809 810def get_vhost_controllers(args): 811 print_dict(jsonrpc_call('get_vhost_controllers')) 812 813p = subparsers.add_parser('get_vhost_controllers', help='List vhost controllers') 814p.set_defaults(func=get_vhost_controllers) 815 816def remove_vhost_controller(args): 817 params = {'ctrlr': args.ctrlr} 818 jsonrpc_call('remove_vhost_controller', params) 819 820p = subparsers.add_parser('remove_vhost_controller', help='Remove a vhost controller') 821p.add_argument('ctrlr', help='controller name') 822p.set_defaults(func=remove_vhost_controller) 823 824def construct_virtio_user_scsi_bdev(args): 825 params = { 826 'path': args.path, 827 'name': args.name, 828 } 829 if args.vq_count: 830 params['vq_count'] = args.vq_count 831 if args.vq_size: 832 params['vq_size'] = args.vq_size 833 print_dict(jsonrpc_call('construct_virtio_user_scsi_bdev', params)) 834 835p = subparsers.add_parser('construct_virtio_user_scsi_bdev', help="""Connect to virtio user scsi device. 836This imply scan and add bdevs offered by remote side. 837Result is array of added bdevs.""") 838p.add_argument('path', help='Path to Virtio SCSI socket') 839p.add_argument('name', help="""Use this name as base instead of 'VirtioScsiN' 840Base will be used to construct new bdev's found on target by adding 't<TARGET_ID>' sufix.""") 841p.add_argument('--vq-count', help='Number of virtual queues to be used.', type=int) 842p.add_argument('--vq-size', help='Size of each queue', type=int) 843p.set_defaults(func=construct_virtio_user_scsi_bdev) 844 845def get_rpc_methods(args): 846 print_dict(jsonrpc_call('get_rpc_methods')) 847 848p = subparsers.add_parser('get_rpc_methods', help='Get list of supported RPC methods') 849p.set_defaults(func=get_rpc_methods) 850 851def context_switch_monitor(args): 852 params = {} 853 if args.enable: 854 params['enabled'] = True 855 if args.disable: 856 params['enabled'] = False 857 print_dict(jsonrpc_call('context_switch_monitor', params)) 858 859p = subparsers.add_parser('context_switch_monitor', help='Control whether the context switch monitor is enabled') 860p.add_argument('-e', '--enable', action='store_true', help='Enable context switch monitoring') 861p.add_argument('-d', '--disable', action='store_true', help='Disable context switch monitoring') 862p.set_defaults(func=context_switch_monitor) 863 864args = parser.parse_args() 865args.func(args) 866