xref: /spdk/scripts/rpc.py (revision ea1c15791fc760e07c8e9cd4629fe17dc0ddb1a1) 
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 construct_malloc_bdev(args):
167    num_blocks = (args.total_size * 1024 * 1024) / args.block_size
168    params = {'num_blocks': num_blocks, 'block_size': args.block_size}
169    if args.name:
170        params['name'] = args.name
171    print_array(jsonrpc_call('construct_malloc_bdev', params))
172
173p = subparsers.add_parser('construct_malloc_bdev', help='Add a bdev with malloc backend')
174p.add_argument('-b', '--name', help="Name of the bdev")
175p.add_argument('total_size', help='Size of malloc bdev in MB (int > 0)', type=int)
176p.add_argument('block_size', help='Block size for this bdev', type=int)
177p.set_defaults(func=construct_malloc_bdev)
178
179
180def create_pmem_pool(args):
181    num_blocks = (args.total_size * 1024 * 1024) / args.block_size
182    params = {'pmem_file': args.pmem_file,
183              'num_blocks': num_blocks,
184              'block_size': args.block_size}
185    jsonrpc_call('create_pmem_pool', params)
186
187p = subparsers.add_parser('create_pmem_pool', help='Create pmem pool')
188p.add_argument('pmem_file', help='Path to pmemblk pool file')
189p.add_argument('total_size', help='Size of malloc bdev in MB (int > 0)', type=int)
190p.add_argument('block_size', help='Block size for this pmem pool', type=int)
191p.set_defaults(func=create_pmem_pool)
192
193
194def pmem_pool_info(args):
195    params = {'pmem_file': args.pmem_file}
196    print_dict(jsonrpc_call('pmem_pool_info', params))
197
198p = subparsers.add_parser('pmem_pool_info', help='Display pmem pool info and check consistency')
199p.add_argument('pmem_file', help='Path to pmemblk pool file')
200p.set_defaults(func=pmem_pool_info)
201
202
203def delete_pmem_pool(args):
204    params = {'pmem_file': args.pmem_file}
205    jsonrpc_call('delete_pmem_pool', params)
206
207p = subparsers.add_parser('delete_pmem_pool', help='Delete pmem pool')
208p.add_argument('pmem_file', help='Path to pmemblk pool file')
209p.set_defaults(func=delete_pmem_pool)
210
211
212def construct_pmem_bdev(args):
213    params = {
214        'pmem_file': args.pmem_file,
215        'name': args.name
216    }
217    print_array(jsonrpc_call('construct_pmem_bdev', params))
218
219p = subparsers.add_parser('construct_pmem_bdev', help='Add a bdev with pmem backend')
220p.add_argument('pmem_file', help='Path to pmemblk pool file')
221p.add_argument('-n', '--name', help='Block device name', required=True)
222p.set_defaults(func=construct_pmem_bdev)
223
224def construct_null_bdev(args):
225    num_blocks = (args.total_size * 1024 * 1024) / args.block_size
226    params = {'name': args.name, 'num_blocks': num_blocks, 'block_size': args.block_size}
227    print_array(jsonrpc_call('construct_null_bdev', params))
228
229p = subparsers.add_parser('construct_null_bdev', help='Add a bdev with null backend')
230p.add_argument('name', help='Block device name')
231p.add_argument('total_size', help='Size of null bdev in MB (int > 0)', type=int)
232p.add_argument('block_size', help='Block size for this bdev', type=int)
233p.set_defaults(func=construct_null_bdev)
234
235
236def construct_aio_bdev(args):
237    params = {'name': args.name,
238              'filename': args.filename}
239
240    if args.block_size:
241        params['block_size'] = args.block_size
242
243    print_array(jsonrpc_call('construct_aio_bdev', params))
244
245p = subparsers.add_parser('construct_aio_bdev', help='Add a bdev with aio backend')
246p.add_argument('filename', help='Path to device or file (ex: /dev/sda)')
247p.add_argument('name', help='Block device name')
248p.add_argument('block_size', help='Block size for this bdev', type=int, default=argparse.SUPPRESS)
249p.set_defaults(func=construct_aio_bdev)
250
251def construct_nvme_bdev(args):
252    params = {'name': args.name,
253              'trtype': args.trtype,
254              'traddr': args.traddr}
255
256    if args.adrfam:
257        params['adrfam'] = args.adrfam
258
259    if args.trsvcid:
260        params['trsvcid'] = args.trsvcid
261
262    if args.subnqn:
263        params['subnqn'] = args.subnqn
264
265    jsonrpc_call('construct_nvme_bdev', params)
266
267p = subparsers.add_parser('construct_nvme_bdev', help='Add bdev with nvme backend')
268p.add_argument('-b', '--name', help="Name of the bdev", required=True)
269p.add_argument('-t', '--trtype', help='NVMe-oF target trtype: e.g., rdma, pcie', required=True)
270p.add_argument('-a', '--traddr', help='NVMe-oF target address: e.g., an ip address or BDF', required=True)
271p.add_argument('-f', '--adrfam', help='NVMe-oF target adrfam: e.g., ipv4, ipv6, ib, fc, intra_host')
272p.add_argument('-s', '--trsvcid', help='NVMe-oF target trsvcid: e.g., a port number')
273p.add_argument('-n', '--subnqn', help='NVMe-oF target subnqn')
274p.set_defaults(func=construct_nvme_bdev)
275
276def construct_rbd_bdev(args):
277    params = {
278        'pool_name': args.pool_name,
279        'rbd_name': args.rbd_name,
280        'block_size': args.block_size,
281    }
282    print_array(jsonrpc_call('construct_rbd_bdev', params))
283
284p = subparsers.add_parser('construct_rbd_bdev', help='Add a bdev with ceph rbd backend')
285p.add_argument('pool_name', help='rbd pool name')
286p.add_argument('rbd_name', help='rbd image name')
287p.add_argument('block_size', help='rbd block size', type=int)
288p.set_defaults(func=construct_rbd_bdev)
289
290def construct_error_bdev(args):
291    params = {'base_name': args.base_name}
292    jsonrpc_call('construct_error_bdev', params)
293p = subparsers.add_parser('construct_error_bdev', help='Add bdev with error injection backend')
294p.add_argument('base_name', help='base bdev name')
295p.set_defaults(func=construct_error_bdev)
296
297
298def construct_lvol_store(args):
299    params = {'bdev_name': args.bdev_name, 'lvs_name': args.lvs_name}
300
301    if args.cluster_sz:
302        params['cluster_sz'] = args.cluster_sz
303
304    print_array(jsonrpc_call('construct_lvol_store', params))
305p = subparsers.add_parser('construct_lvol_store', help='Add logical volume store on base bdev')
306p.add_argument('bdev_name', help='base bdev name')
307p.add_argument('lvs_name', help='name for lvol store')
308p.add_argument('-c', '--cluster-sz', help='size of cluster (in bytes)', type=int, required=False)
309p.set_defaults(func=construct_lvol_store)
310
311
312def construct_lvol_bdev(args):
313    num_bytes = (args.size * 1024 * 1024)
314    params = {'lvol_name': args.lvol_name, 'size': num_bytes}
315    if (args.uuid and args.lvs_name) or (not args.uuid and not args.lvs_name):
316        print("You need to specify either uuid or name of lvolstore")
317    else:
318        if args.uuid:
319            params['uuid'] = args.uuid
320        if args.lvs_name:
321            params['lvs_name'] = args.lvs_name
322        print_array(jsonrpc_call('construct_lvol_bdev', params))
323p = subparsers.add_parser('construct_lvol_bdev', help='Add a bdev with an logical volume backend')
324p.add_argument('-u', '--uuid', help='lvol store UUID', required=False)
325p.add_argument('-l', '--lvs_name', help='lvol store name', required=False)
326p.add_argument('lvol_name', help='name for this lvol')
327p.add_argument('size', help='size in MiB for this bdev', type=int)
328p.set_defaults(func=construct_lvol_bdev)
329
330# Logical volume resize feature is disabled, as it is currently work in progress
331#
332# def resize_lvol_bdev(args):
333#     params = {
334#         'name': args.name,
335#         'size': args.size,
336#     }
337#     jsonrpc_call('resize_lvol_bdev', params)
338# p = subparsers.add_parser('resize_lvol_bdev', help='Resize existing lvol bdev')
339# p.add_argument('name', help='lvol bdev name')
340# p.add_argument('size', help='new size in MiB for this bdev', type=int)
341# p.set_defaults(func=resize_lvol_bdev)
342
343
344def destroy_lvol_store(args):
345    params = {}
346    if (args.uuid and args.lvs_name) or (not args.uuid and not args.lvs_name):
347        print("You need to specify either uuid or name of lvolstore")
348    else:
349        if args.uuid:
350            params['uuid'] = args.uuid
351        if args.lvs_name:
352            params['lvs_name'] = args.lvs_name
353        jsonrpc_call('destroy_lvol_store', params)
354p = subparsers.add_parser('destroy_lvol_store', help='Destroy an logical volume store')
355p.add_argument('-u', '--uuid', help='lvol store UUID', required=False)
356p.add_argument('-l', '--lvs_name', help='lvol store name', required=False)
357p.set_defaults(func=destroy_lvol_store)
358
359
360def get_lvol_stores(args):
361    print_dict(jsonrpc_call('get_lvol_stores'))
362
363p = subparsers.add_parser('get_lvol_stores', help='Display current logical volume store list')
364p.set_defaults(func=get_lvol_stores)
365
366
367def set_trace_flag(args):
368    params = {'flag': args.flag}
369    jsonrpc_call('set_trace_flag', params)
370
371p = subparsers.add_parser('set_trace_flag', help='set trace flag')
372p.add_argument('flag', help='trace mask we want to set. (for example "debug").')
373p.set_defaults(func=set_trace_flag)
374
375
376def clear_trace_flag(args):
377    params = {'flag': args.flag}
378    jsonrpc_call('clear_trace_flag', params)
379
380p = subparsers.add_parser('clear_trace_flag', help='clear trace flag')
381p.add_argument('flag', help='trace mask we want to clear. (for example "debug").')
382p.set_defaults(func=clear_trace_flag)
383
384
385def get_trace_flags(args):
386    print_dict(jsonrpc_call('get_trace_flags'))
387
388p = subparsers.add_parser('get_trace_flags', help='get trace flags')
389p.set_defaults(func=get_trace_flags)
390
391def set_log_level(args):
392    params = {'level': args.level}
393    jsonrpc_call('set_log_level', params)
394
395p = subparsers.add_parser('set_log_level', help='set log level')
396p.add_argument('level', help='log level we want to set. (for example "DEBUG").')
397p.set_defaults(func=set_log_level)
398
399def get_log_level(args):
400    print_dict(jsonrpc_call('get_log_level'))
401
402p = subparsers.add_parser('get_log_level', help='get log level')
403p.set_defaults(func=get_log_level)
404
405def set_log_print_level(args):
406    params = {'level': args.level}
407    jsonrpc_call('set_log_print_level', params)
408
409p = subparsers.add_parser('set_log_print_level', help='set log print level')
410p.add_argument('level', help='log print level we want to set. (for example "DEBUG").')
411p.set_defaults(func=set_log_print_level)
412
413def get_log_print_level(args):
414    print_dict(jsonrpc_call('get_log_print_level'))
415
416p = subparsers.add_parser('get_log_print_level', help='get log print level')
417p.set_defaults(func=get_log_print_level)
418
419def add_portal_group(args):
420    # parse out portal list host1:port1 host2:port2
421    portals = []
422    for p in args.portal_list:
423        host_port = p.split(':')
424        portals.append({'host': host_port[0], 'port': host_port[1]})
425
426    params = {'tag': args.tag, 'portals': portals}
427    jsonrpc_call('add_portal_group', params)
428
429p = subparsers.add_parser('add_portal_group', help='Add a portal group')
430p.add_argument('tag', help='Portal group tag (unique, integer > 0)', type=int)
431p.add_argument('portal_list', nargs=argparse.REMAINDER, help="""List of portals in 'host:port' format, separated by whitespace
432Example: '192.168.100.100:3260' '192.168.100.100:3261'""")
433p.set_defaults(func=add_portal_group)
434
435
436def add_initiator_group(args):
437    initiators = []
438    netmasks = []
439    for i in args.initiator_list.strip().split(' '):
440        initiators.append(i)
441    for n in args.netmask_list.strip().split(' '):
442        netmasks.append(n)
443
444    params = {'tag': args.tag, 'initiators': initiators, 'netmasks': netmasks}
445    jsonrpc_call('add_initiator_group', params)
446
447
448p = subparsers.add_parser('add_initiator_group', help='Add an initiator group')
449p.add_argument('tag', help='Initiator group tag (unique, integer > 0)', type=int)
450p.add_argument('initiator_list', help="""Whitespace-separated list of initiator hostnames or IP addresses,
451enclosed in quotes.  Example: 'ANY' or '127.0.0.1 192.168.200.100'""")
452p.add_argument('netmask_list', help="""Whitespace-separated list of initiator netmasks enclosed in quotes.
453Example: '255.255.0.0 255.248.0.0' etc""")
454p.set_defaults(func=add_initiator_group)
455
456
457def delete_target_node(args):
458    params = {'name': args.target_node_name}
459    jsonrpc_call('delete_target_node', params)
460
461p = subparsers.add_parser('delete_target_node', help='Delete a target node')
462p.add_argument('target_node_name', help='Target node name to be deleted. Example: iqn.2016-06.io.spdk:disk1.')
463p.set_defaults(func=delete_target_node)
464
465
466def delete_portal_group(args):
467    params = {'tag': args.tag}
468    jsonrpc_call('delete_portal_group', params)
469
470p = subparsers.add_parser('delete_portal_group', help='Delete a portal group')
471p.add_argument('tag', help='Portal group tag (unique, integer > 0)', type=int)
472p.set_defaults(func=delete_portal_group)
473
474
475def delete_initiator_group(args):
476    params = {'tag': args.tag}
477    jsonrpc_call('delete_initiator_group', params)
478
479p = subparsers.add_parser('delete_initiator_group', help='Delete an initiator group')
480p.add_argument('tag', help='Initiator group tag (unique, integer > 0)', type=int)
481p.set_defaults(func=delete_initiator_group)
482
483
484def get_iscsi_connections(args):
485    print_dict(jsonrpc_call('get_iscsi_connections'))
486
487p = subparsers.add_parser('get_iscsi_connections', help='Display iSCSI connections')
488p.set_defaults(func=get_iscsi_connections)
489
490
491def get_scsi_devices(args):
492    print_dict(jsonrpc_call('get_scsi_devices'))
493
494p = subparsers.add_parser('get_scsi_devices', help='Display SCSI devices')
495p.set_defaults(func=get_scsi_devices)
496
497
498def add_ip_address(args):
499    params = {'ifc_index': args.ifc_index, 'ip_address': args.ip_addr}
500    jsonrpc_call('add_ip_address', params)
501
502p = subparsers.add_parser('add_ip_address', help='Add IP address')
503p.add_argument('ifc_index', help='ifc index of the nic device.', type=int)
504p.add_argument('ip_addr', help='ip address will be added.')
505p.set_defaults(func=add_ip_address)
506
507
508def delete_ip_address(args):
509    params = {'ifc_index': args.ifc_index, 'ip_address': args.ip_addr}
510    jsonrpc_call('delete_ip_address', params)
511
512p = subparsers.add_parser('delete_ip_address', help='Delete IP address')
513p.add_argument('ifc_index', help='ifc index of the nic device.', type=int)
514p.add_argument('ip_addr', help='ip address will be deleted.')
515p.set_defaults(func=delete_ip_address)
516
517
518def get_interfaces(args):
519    print_dict(jsonrpc_call('get_interfaces'))
520
521p = subparsers.add_parser('get_interfaces', help='Display current interface list')
522p.set_defaults(func=get_interfaces)
523
524def apply_firmware(args):
525
526    params = {
527        'filename': args.filename,
528        'bdev_name': args.bdev_name,
529    }
530
531    print_dict(jsonrpc_call('apply_nvme_firmware', params))
532
533p = subparsers.add_parser('apply_firmware', help='Download and commit firmware to NVMe device')
534p.add_argument('filename', help='filename of the firmware to download')
535p.add_argument('bdev_name', help='name of the NVMe device')
536p.set_defaults(func=apply_firmware)
537
538def get_bdevs(args):
539    params = {}
540    if args.name:
541        params['name'] = args.name
542    print_dict(jsonrpc_call('get_bdevs', params))
543
544p = subparsers.add_parser('get_bdevs', help='Display current blockdev list or required blockdev')
545p.add_argument('-b', '--name', help="Name of the Blockdev. Example: Nvme0n1", required=False)
546p.set_defaults(func=get_bdevs)
547
548
549def delete_bdev(args):
550    params = {'name': args.bdev_name}
551    jsonrpc_call('delete_bdev', params)
552
553p = subparsers.add_parser('delete_bdev', help='Delete a blockdev')
554p.add_argument('bdev_name', help='Blockdev name to be deleted. Example: Malloc0.')
555p.set_defaults(func=delete_bdev)
556
557
558def get_nvmf_subsystems(args):
559    print_dict(jsonrpc_call('get_nvmf_subsystems'))
560
561p = subparsers.add_parser('get_nvmf_subsystems', help='Display nvmf subsystems')
562p.set_defaults(func=get_nvmf_subsystems)
563
564def construct_nvmf_subsystem(args):
565    listen_addresses = [dict(u.split(":") for u in a.split(" ")) for a in args.listen.split(",")]
566
567    params = {
568        'core': args.core,
569        'nqn': args.nqn,
570        'listen_addresses': listen_addresses,
571        'serial_number': args.serial_number,
572    }
573
574    if args.hosts:
575        hosts = []
576        for u in args.hosts.strip().split(" "):
577            hosts.append(u)
578        params['hosts'] = hosts
579
580    if args.allow_any_host:
581        params['allow_any_host'] = True
582
583    if args.namespaces:
584        namespaces = []
585        for u in args.namespaces.strip().split(" "):
586            bdev_name = u
587            nsid = 0
588            if ':' in u:
589                (bdev_name, nsid) = u.split(":")
590
591            ns_params = {'bdev_name': bdev_name}
592
593            nsid = int(nsid)
594            if nsid != 0:
595                ns_params['nsid'] = nsid
596
597            namespaces.append(ns_params)
598        params['namespaces'] = namespaces
599
600    jsonrpc_call('construct_nvmf_subsystem', params)
601
602p = subparsers.add_parser('construct_nvmf_subsystem', help='Add a nvmf subsystem')
603p.add_argument("-c", "--core", help='The core Nvmf target run on', type=int, default=-1)
604p.add_argument('nqn', help='Target nqn(ASCII)')
605p.add_argument('listen', help="""comma-separated list of Listen <trtype:transport_name traddr:address trsvcid:port_id> pairs enclosed
606in quotes.  Format:  'trtype:transport0 traddr:traddr0 trsvcid:trsvcid0,trtype:transport1 traddr:traddr1 trsvcid:trsvcid1' etc
607Example: 'trtype:RDMA traddr:192.168.100.8 trsvcid:4420,trtype:RDMA traddr:192.168.100.9 trsvcid:4420'""")
608p.add_argument('hosts', help="""Whitespace-separated list of host nqn list.
609Format:  'nqn1 nqn2' etc
610Example: 'nqn.2016-06.io.spdk:init nqn.2016-07.io.spdk:init'""")
611p.add_argument("-a", "--allow-any-host", action='store_true', help="Allow any host to connect (don't enforce host NQN whitelist)")
612p.add_argument("-s", "--serial_number", help="""
613Format:  'sn' etc
614Example: 'SPDK00000000000001'""", default='0000:00:01.0')
615p.add_argument("-n", "--namespaces", help="""Whitespace-separated list of namespaces
616Format:  'bdev_name1[:nsid1] bdev_name2[:nsid2] bdev_name3[:nsid3]' etc
617Example: '1:Malloc0 2:Malloc1 3:Malloc2'
618*** The devices must pre-exist ***""")
619p.set_defaults(func=construct_nvmf_subsystem)
620
621def delete_nvmf_subsystem(args):
622    params = {'nqn': args.subsystem_nqn}
623    jsonrpc_call('delete_nvmf_subsystem', params)
624
625p = subparsers.add_parser('delete_nvmf_subsystem', help='Delete a nvmf subsystem')
626p.add_argument('subsystem_nqn', help='subsystem nqn to be deleted. Example: nqn.2016-06.io.spdk:cnode1.')
627p.set_defaults(func=delete_nvmf_subsystem)
628
629def bdev_inject_error(args):
630    params = {
631        'name': args.name,
632        'io_type': args.io_type,
633        'error_type': args.error_type,
634        'num': args.num,
635    }
636
637    jsonrpc_call('bdev_inject_error', params)
638
639p = subparsers.add_parser('bdev_inject_error', help='bdev inject error')
640p.add_argument('name', help="""the name of the error injection bdev""")
641p.add_argument('io_type', help="""io_type: 'clear' 'read' 'write' 'unmap' 'flush' 'all'""")
642p.add_argument('error_type', help="""error_type: 'failure' 'pending'""")
643p.add_argument('-n', '--num', help='the number of commands you want to fail', type=int, default=1)
644p.set_defaults(func=bdev_inject_error)
645
646def kill_instance(args):
647    params = {'sig_name': args.sig_name}
648    jsonrpc_call('kill_instance', params)
649
650p = subparsers.add_parser('kill_instance', help='Send signal to instance')
651p.add_argument('sig_name', help='signal will be sent to server.')
652p.set_defaults(func=kill_instance)
653
654def set_vhost_controller_coalescing(args):
655    params = {
656        'ctrlr': args.ctrlr,
657        'delay_base_us': args.delay_base_us,
658        'iops_threshold': args.iops_threshold,
659    }
660    jsonrpc_call('set_vhost_controller_coalescing', params)
661
662p = subparsers.add_parser('set_vhost_controller_coalescing', help='Set vhost controller coalescing')
663p.add_argument('ctrlr', help='controller name')
664p.add_argument('delay_base_us', help='Base delay time', type=int)
665p.add_argument('iops_threshold', help='IOPS threshold when coalescing is enabled', type=int)
666p.set_defaults(func=set_vhost_controller_coalescing)
667
668def construct_vhost_scsi_controller(args):
669    params = {'ctrlr': args.ctrlr}
670
671    if args.cpumask:
672        params['cpumask'] = args.cpumask
673
674    jsonrpc_call('construct_vhost_scsi_controller', params)
675
676p = subparsers.add_parser('construct_vhost_scsi_controller', help='Add new vhost controller')
677p.add_argument('ctrlr', help='controller name')
678p.add_argument('--cpumask', help='cpu mask for this controller')
679p.set_defaults(func=construct_vhost_scsi_controller)
680
681def add_vhost_scsi_lun(args):
682    params = {
683        'ctrlr': args.ctrlr,
684        'scsi_dev_num': args.scsi_dev_num,
685        'lun_name': args.lun_name
686    }
687    jsonrpc_call('add_vhost_scsi_lun', params)
688
689p = subparsers.add_parser('add_vhost_scsi_lun', help='Add lun to vhost controller')
690p.add_argument('ctrlr', help='conntroller name where add lun')
691p.add_argument('scsi_dev_num', help='scsi_dev_num', type=int)
692p.add_argument('lun_name', help='lun name')
693p.set_defaults(func=add_vhost_scsi_lun)
694
695def remove_vhost_scsi_dev(args):
696    params = {
697        'ctrlr': args.ctrlr,
698        'scsi_dev_num': args.scsi_dev_num,
699    }
700    jsonrpc_call('remove_vhost_scsi_dev', params)
701
702p = subparsers.add_parser('remove_vhost_scsi_dev', help='Remove device from vhost controller')
703p.add_argument('ctrlr', help='controller name to remove device from')
704p.add_argument('scsi_dev_num', help='scsi_dev_num', type=int)
705p.set_defaults(func=remove_vhost_scsi_dev)
706
707def construct_vhost_blk_controller(args):
708    params = {
709        'ctrlr': args.ctrlr,
710        'dev_name': args.dev_name,
711    }
712    if args.cpumask:
713        params['cpumask'] = args.cpumask
714    if args.readonly:
715        params['readonly'] = args.readonly
716    jsonrpc_call('construct_vhost_blk_controller', params)
717
718p = subparsers.add_parser('construct_vhost_blk_controller', help='Add a new vhost block controller')
719p.add_argument('ctrlr', help='controller name')
720p.add_argument('dev_name', help='device name')
721p.add_argument('--cpumask', help='cpu mask for this controller')
722p.add_argument("-r", "--readonly", action='store_true', help='Set controller as read-only')
723p.set_defaults(func=construct_vhost_blk_controller)
724
725def get_vhost_controllers(args):
726    print_dict(jsonrpc_call('get_vhost_controllers'))
727
728p = subparsers.add_parser('get_vhost_controllers', help='List vhost controllers')
729p.set_defaults(func=get_vhost_controllers)
730
731def remove_vhost_controller(args):
732    params = {'ctrlr': args.ctrlr}
733    jsonrpc_call('remove_vhost_controller', params)
734
735p = subparsers.add_parser('remove_vhost_controller', help='Remove a vhost controller')
736p.add_argument('ctrlr', help='controller name')
737p.set_defaults(func=remove_vhost_controller)
738
739def construct_virtio_user_scsi_bdev(args):
740    params = {'path': args.path}
741    if args.vq_count:
742        params['vq_count'] = args.vq_count
743    if args.vq_size:
744        params['vq_size'] = args.vq_size
745    print_dict(jsonrpc_call('construct_virtio_user_scsi_bdev', params))
746
747p = subparsers.add_parser('construct_virtio_user_scsi_bdev', help="""Connect to virtio user scsi device.
748This imply scan and add bdevs offered by remote side.
749Result is array of added bdevs.""")
750p.add_argument('path', help='Path to Virtio SCSI socket')
751p.add_argument('-b', '--name', help="""Use this name as base instead of 'VirtioScsiN'
752Base will be used to construct new bdev's found on target by adding 't<TARGET_ID>' sufix.""", required=True)
753p.add_argument('--vq-count', help='Number of virtual queues to be used.', type=int)
754p.add_argument('--vq-size', help='Size of each queue', type=int)
755p.set_defaults(func=construct_virtio_user_scsi_bdev)
756
757def get_rpc_methods(args):
758    print_dict(jsonrpc_call('get_rpc_methods'))
759
760p = subparsers.add_parser('get_rpc_methods', help='Get list of supported RPC methods')
761p.set_defaults(func=get_rpc_methods)
762
763def context_switch_monitor(args):
764    params = {}
765    if args.enable:
766        params['enabled'] = True
767    if args.disable:
768        params['enabled'] = False
769    print_dict(jsonrpc_call('context_switch_monitor', params))
770
771p = subparsers.add_parser('context_switch_monitor', help='Control whether the context switch monitor is enabled')
772p.add_argument('-e', '--enable', action='store_true', help='Enable context switch monitoring')
773p.add_argument('-d', '--disable', action='store_true', help='Disable context switch monitoring')
774p.set_defaults(func=context_switch_monitor)
775
776args = parser.parse_args()
777args.func(args)
778