ceph/src/spdk/scripts/rpc.py

   1 #!/usr/bin/env python
   2
   3 import argparse
   4 import json
   5 import socket
   6
   7 try:
   8     from shlex import quote
   9 except ImportError:
  10     from pipes import quote
  11
  12 def print_dict(d):
  13     print json.dumps(d, indent=2)
  14
  15 def print_array(a):
  16     print " ".join((quote(v) for v in a))
  17
  18 parser = argparse.ArgumentParser(description='SPDK RPC command line interface')
  19 parser.add_argument('-s', dest='server_addr', help='RPC server address', default='127.0.0.1')
  20 parser.add_argument('-p', dest='port', help='RPC port number', default=5260, type=int)
  21 subparsers = parser.add_subparsers(help='RPC methods')
  22
  23
  24 def int_arg(arg):
  25     return int(arg, 0)
  26
  27
  28 def jsonrpc_call(method, params={}):
  29     if args.server_addr.startswith('/'):
  30         s = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
  31         s.connect(args.server_addr)
  32     else:
  33         s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
  34         s.connect((args.server_addr, args.port))
  35     req = {}
  36     req['jsonrpc'] = '2.0'
  37     req['method'] = method
  38     req['id'] = 1
  39     if (params):
  40         req['params'] = params
  41     reqstr = json.dumps(req)
  42     s.sendall(reqstr)
  43     buf = ''
  44     closed = False
  45     response = {}
  46     while not closed:
  47         newdata = s.recv(4096)
  48         if (newdata == b''):
  49             closed = True
  50         buf += newdata
  51         try:
  52             response = json.loads(buf)
  53         except ValueError:
  54             continue  # incomplete response; keep buffering
  55         break
  56     s.close()
  57
  58     if not response:
  59         if method == "kill_instance":
  60             exit(0)
  61         print "Connection closed with partial response:"
  62         print buf
  63         exit(1)
  64
  65     if 'error' in response:
  66         print "Got JSON-RPC error response"
  67         print "request:"
  68         print_dict(json.loads(reqstr))
  69         print "response:"
  70         print_dict(response['error'])
  71         exit(1)
  72
  73     return response['result']
  74
  75 def get_luns(args):
  76     print_dict(jsonrpc_call('get_luns'))
  77
  78 p = subparsers.add_parser('get_luns', help='Display active LUNs')
  79 p.set_defaults(func=get_luns)
  80
  81
  82 def get_portal_groups(args):
  83     print_dict(jsonrpc_call('get_portal_groups'))
  84
  85 p = subparsers.add_parser('get_portal_groups', help='Display current portal group configuration')
  86 p.set_defaults(func=get_portal_groups)
  87
  88
  89 def get_initiator_groups(args):
  90     print_dict(jsonrpc_call('get_initiator_groups'))
  91
  92 p = subparsers.add_parser('get_initiator_groups', help='Display current initiator group configuration')
  93 p.set_defaults(func=get_initiator_groups)
  94
  95
  96 def get_target_nodes(args):
  97     print_dict(jsonrpc_call('get_target_nodes'))
  98
  99 p = subparsers.add_parser('get_target_nodes', help='Display target nodes')
 100 p.set_defaults(func=get_target_nodes)
 101
 102
 103 def construct_target_node(args):
 104     lun_name_id_dict = dict(u.split(":")
 105                             for u in args.lun_name_id_pairs.strip().split(" "))
 106     lun_names = lun_name_id_dict.keys()
 107     lun_ids = list(map(int, lun_name_id_dict.values()))
 108
 109     pg_tags = []
 110     ig_tags = []
 111     for u in args.pg_ig_mappings.strip().split(" "):
 112         pg, ig = u.split(":")
 113         pg_tags.append(int(pg))
 114         ig_tags.append(int(ig))
 115
 116     params = {
 117         'name': args.name,
 118         'alias_name': args.alias_name,
 119         'pg_tags': pg_tags,
 120         'ig_tags': ig_tags,
 121         'lun_names': lun_names,
 122         'lun_ids': lun_ids,
 123         'queue_depth': args.queue_depth,
 124         'chap_disabled': args.chap_disabled,
 125         'chap_required': args.chap_required,
 126         'chap_mutual': args.chap_mutual,
 127         'chap_auth_group': args.chap_auth_group,
 128     }
 129     jsonrpc_call('construct_target_node', params)
 130
 131 p = subparsers.add_parser('construct_target_node', help='Add a target node')
 132 p.add_argument('name', help='Target node name (ASCII)')
 133 p.add_argument('alias_name', help='Target node alias name (ASCII)')
 134 p.add_argument('lun_name_id_pairs', help="""Whitespace-separated list of LUN <name:id> pairs enclosed
 135 in quotes.  Format:  'lun_name0:id0 lun_name1:id1' etc
 136 Example: 'Malloc0:0 Malloc1:1 Malloc5:2'
 137 *** The LUNs must pre-exist ***
 138 *** LUN0 (id = 0) is required ***
 139 *** LUN names cannot contain space or colon characters ***""")
 140 p.add_argument('pg_ig_mappings', help="""List of (Portal_Group_Tag:Initiator_Group_Tag) mappings
 141 Whitespace separated, quoted, mapping defined with colon
 142 separated list of "tags" (int > 0)
 143 Example: '1:1 2:2 2:1'
 144 *** The Portal/Initiator Groups must be precreated ***""")
 145 p.add_argument('queue_depth', help='Desired target queue depth', type=int)
 146 p.add_argument('chap_disabled', help="""CHAP authentication should be disabled for this target node.
 147 *** Mutually exclusive with chap_required ***""", type=int)
 148 p.add_argument('chap_required', help="""CHAP authentication should be required for this target node.
 149 *** Mutually exclusive with chap_disabled ***""", type=int)
 150 p.add_argument('chap_mutual', help='CHAP authentication should be mutual/bidirectional.', type=int)
 151 p.add_argument('chap_auth_group', help="""Authentication group ID for this target node.
 152 *** Authentication group must be precreated ***""", type=int)
 153 p.set_defaults(func=construct_target_node)
 154
 155
 156 def construct_malloc_bdev(args):
 157     num_blocks = (args.total_size * 1024 * 1024) / args.block_size
 158     params = {'num_blocks': num_blocks, 'block_size': args.block_size}
 159     print_array(jsonrpc_call('construct_malloc_bdev', params))
 160
 161 p = subparsers.add_parser('construct_malloc_bdev', help='Add a bdev with malloc backend')
 162 p.add_argument('total_size', help='Size of malloc bdev in MB (int > 0)', type=int)
 163 p.add_argument('block_size', help='Block size for this bdev', type=int)
 164 p.set_defaults(func=construct_malloc_bdev)
 165
 166
 167 def construct_aio_bdev(args):
 168     params = {'name': args.name,
 169               'fname': args.fname}
 170
 171     print_array(jsonrpc_call('construct_aio_bdev', params))
 172
 173 p = subparsers.add_parser('construct_aio_bdev', help='Add a bdev with aio backend')
 174 p.add_argument('fname', help='Path to device or file (ex: /dev/sda)')
 175 p.add_argument('name', help='Block device name')
 176 p.set_defaults(func=construct_aio_bdev)
 177
 178 def construct_nvme_bdev(args):
 179     params = {'name': args.name,
 180               'trtype': args.trtype,
 181               'traddr': args.traddr}
 182
 183     if args.adrfam:
 184         params['adrfam'] = args.adrfam
 185
 186     if args.trsvcid:
 187         params['trsvcid'] = args.trsvcid
 188
 189     if args.subnqn:
 190         params['subnqn'] = args.subnqn
 191
 192     jsonrpc_call('construct_nvme_bdev', params)
 193
 194 p = subparsers.add_parser('construct_nvme_bdev', help='Add bdev with nvme backend')
 195 p.add_argument('-b', '--name', help="Name of the bdev", required=True)
 196 p.add_argument('-t', '--trtype', help='NVMe-oF target trtype: e.g., rdma, pcie', required=True)
 197 p.add_argument('-a', '--traddr', help='NVMe-oF target address: e.g., an ip address or BDF', required=True)
 198 p.add_argument('-f', '--adrfam', help='NVMe-oF target adrfam: e.g., ipv4, ipv6, ib, fc, intra_host')
 199 p.add_argument('-s', '--trsvcid', help='NVMe-oF target trsvcid: e.g., a port number')
 200 p.add_argument('-n', '--subnqn', help='NVMe-oF target subnqn')
 201 p.set_defaults(func=construct_nvme_bdev)
 202
 203 def construct_rbd_bdev(args):
 204     params = {
 205         'pool_name': args.pool_name,
 206         'rbd_name': args.rbd_name,
 207         'block_size': args.block_size,
 208     }
 209     print_array(jsonrpc_call('construct_rbd_bdev', params))
 210
 211 p = subparsers.add_parser('construct_rbd_bdev', help='Add a bdev with ceph rbd backend')
 212 p.add_argument('pool_name', help='rbd pool name')
 213 p.add_argument('rbd_name', help='rbd image name')
 214 p.add_argument('block_size', help='rbd block size', type=int)
 215 p.set_defaults(func=construct_rbd_bdev)
 216
 217 def set_trace_flag(args):
 218     params = {'flag': args.flag}
 219     jsonrpc_call('set_trace_flag', params)
 220
 221 p = subparsers.add_parser('set_trace_flag', help='set trace flag')
 222 p.add_argument('flag', help='trace mask we want to set. (for example "debug").')
 223 p.set_defaults(func=set_trace_flag)
 224
 225
 226 def clear_trace_flag(args):
 227     params = {'flag': args.flag}
 228     jsonrpc_call('clear_trace_flag', params)
 229
 230 p = subparsers.add_parser('clear_trace_flag', help='clear trace flag')
 231 p.add_argument('flag', help='trace mask we want to clear. (for example "debug").')
 232 p.set_defaults(func=clear_trace_flag)
 233
 234
 235 def get_trace_flags(args):
 236     print_dict(jsonrpc_call('get_trace_flags'))
 237
 238 p = subparsers.add_parser('get_trace_flags', help='get trace flags')
 239 p.set_defaults(func=get_trace_flags)
 240
 241
 242 def add_portal_group(args):
 243     # parse out portal list host1:port1 host2:port2
 244     portals = []
 245     for p in args.portal_list:
 246         host_port = p.split(':')
 247         portals.append({'host': host_port[0], 'port': host_port[1]})
 248
 249     params = {'tag': args.tag, 'portals': portals}
 250     jsonrpc_call('add_portal_group', params)
 251
 252 p = subparsers.add_parser('add_portal_group', help='Add a portal group')
 253 p.add_argument('tag', help='Portal group tag (unique, integer > 0)', type=int)
 254 p.add_argument('portal_list', nargs=argparse.REMAINDER, help="""List of portals in 'host:port' format, separated by whitespace
 255 Example: '192.168.100.100:3260' '192.168.100.100:3261'""")
 256 p.set_defaults(func=add_portal_group)
 257
 258
 259 def add_initiator_group(args):
 260     initiators = []
 261     netmasks = []
 262     for i in args.initiator_list.strip().split(' '):
 263         initiators.append(i)
 264     for n in args.netmask_list.strip().split(' '):
 265         netmasks.append(n)
 266
 267     params = {'tag': args.tag, 'initiators': initiators, 'netmasks': netmasks}
 268     jsonrpc_call('add_initiator_group', params)
 269
 270
 271 p = subparsers.add_parser('add_initiator_group', help='Add an initiator group')
 272 p.add_argument('tag', help='Initiator group tag (unique, integer > 0)', type=int)
 273 p.add_argument('initiator_list', help="""Whitespace-separated list of initiator hostnames or IP addresses,
 274 enclosed in quotes.  Example: 'ALL' or '127.0.0.1 192.168.200.100'""")
 275 p.add_argument('netmask_list', help="""Whitespace-separated list of initiator netmasks enclosed in quotes.
 276 Example: '255.255.0.0 255.248.0.0' etc""")
 277 p.set_defaults(func=add_initiator_group)
 278
 279
 280 def delete_target_node(args):
 281     params = {'name': args.target_node_name}
 282     jsonrpc_call('delete_target_node', params)
 283
 284 p = subparsers.add_parser('delete_target_node', help='Delete a target node')
 285 p.add_argument('target_node_name', help='Target node name to be deleted. Example: iqn.2016-06.io.spdk:disk1.')
 286 p.set_defaults(func=delete_target_node)
 287
 288
 289 def delete_portal_group(args):
 290     params = {'tag': args.tag}
 291     jsonrpc_call('delete_portal_group', params)
 292
 293 p = subparsers.add_parser('delete_portal_group', help='Delete a portal group')
 294 p.add_argument('tag', help='Portal group tag (unique, integer > 0)', type=int)
 295 p.set_defaults(func=delete_portal_group)
 296
 297
 298 def delete_initiator_group(args):
 299     params = {'tag': args.tag}
 300     jsonrpc_call('delete_initiator_group', params)
 301
 302 p = subparsers.add_parser('delete_initiator_group', help='Delete an initiator group')
 303 p.add_argument('tag', help='Initiator group tag (unique, integer > 0)', type=int)
 304 p.set_defaults(func=delete_initiator_group)
 305
 306
 307 def get_iscsi_connections(args):
 308     print_dict(jsonrpc_call('get_iscsi_connections'))
 309
 310 p = subparsers.add_parser('get_iscsi_connections', help='Display iSCSI connections')
 311 p.set_defaults(func=get_iscsi_connections)
 312
 313
 314 def get_scsi_devices(args):
 315     print_dict(jsonrpc_call('get_scsi_devices'))
 316
 317 p = subparsers.add_parser('get_scsi_devices', help='Display SCSI devices')
 318 p.set_defaults(func=get_scsi_devices)
 319
 320
 321 def add_ip_address(args):
 322     params = {'ifc_index': args.ifc_index, 'ip_address': args.ip_addr}
 323     jsonrpc_call('add_ip_address', params)
 324
 325 p = subparsers.add_parser('add_ip_address', help='Add IP address')
 326 p.add_argument('ifc_index', help='ifc index of the nic device.', type=int)
 327 p.add_argument('ip_addr', help='ip address will be added.')
 328 p.set_defaults(func=add_ip_address)
 329
 330
 331 def delete_ip_address(args):
 332     params = {'ifc_index': args.ifc_index, 'ip_address': args.ip_addr}
 333     jsonrpc_call('delete_ip_address', params)
 334
 335 p = subparsers.add_parser('delete_ip_address', help='Delete IP address')
 336 p.add_argument('ifc_index', help='ifc index of the nic device.', type=int)
 337 p.add_argument('ip_addr', help='ip address will be deleted.')
 338 p.set_defaults(func=delete_ip_address)
 339
 340
 341 def get_interfaces(args):
 342     print_dict(jsonrpc_call('get_interfaces'))
 343
 344 p = subparsers.add_parser('get_interfaces', help='Display current interface list')
 345 p.set_defaults(func=get_interfaces)
 346
 347 def get_bdevs(args):
 348     print_dict(jsonrpc_call('get_bdevs'))
 349
 350 p = subparsers.add_parser('get_bdevs', help='Display current blockdev list')
 351 p.set_defaults(func=get_bdevs)
 352
 353
 354 def delete_bdev(args):
 355     params = {'name': args.bdev_name}
 356     jsonrpc_call('delete_bdev', params)
 357
 358 p = subparsers.add_parser('delete_bdev', help='Delete a blockdev')
 359 p.add_argument('bdev_name', help='Blockdev name to be deleted. Example: Malloc0.')
 360 p.set_defaults(func=delete_bdev)
 361
 362
 363 def get_nvmf_subsystems(args):
 364     print_dict(jsonrpc_call('get_nvmf_subsystems'))
 365
 366 p = subparsers.add_parser('get_nvmf_subsystems', help='Display nvmf subsystems')
 367 p.set_defaults(func=get_nvmf_subsystems)
 368
 369 def construct_nvmf_subsystem(args):
 370     listen_addresses = [dict(u.split(":") for u in a.split(" ")) for a in args.listen.split(",")]
 371
 372     params = {
 373         'core': args.core,
 374         'mode': args.mode,
 375         'nqn': args.nqn,
 376         'listen_addresses': listen_addresses,
 377         'serial_number': args.serial_number,
 378     }
 379
 380     if args.hosts:
 381         hosts = []
 382         for u in args.hosts.strip().split(" "):
 383             hosts.append(u)
 384         params['hosts'] = hosts
 385
 386     if args.namespaces:
 387         namespaces = []
 388         for u in args.namespaces.strip().split(" "):
 389             namespaces.append(u)
 390         params['namespaces'] = namespaces
 391
 392     if args.pci_address:
 393         params['pci_address'] = args.pci_address
 394
 395     jsonrpc_call('construct_nvmf_subsystem', params)
 396
 397 p = subparsers.add_parser('construct_nvmf_subsystem', help='Add a nvmf subsystem')
 398 p.add_argument("-c", "--core", help='The core Nvmf target run on', type=int, default=-1)
 399 p.add_argument('mode', help='Target mode: Virtual or Direct')
 400 p.add_argument('nqn', help='Target nqn(ASCII)')
 401 p.add_argument('listen', help="""comma-separated list of Listen <transport:transport_name traddr:address trsvcid:port_id> pairs enclosed
 402 in quotes.  Format:  'transport:transport0 traddr:traddr0 trsvcid:trsvcid0,transport:transport1 traddr:traddr1 trsvcid:trsvcid1' etc
 403 Example: 'transport:RDMA traddr:192.168.100.8 trsvcid:4420,transport:RDMA traddr:192.168.100.9 trsvcid:4420'""")
 404 p.add_argument('hosts', help="""Whitespace-separated list of host nqn list.
 405 Format:  'nqn1 nqn2' etc
 406 Example: 'nqn.2016-06.io.spdk:init nqn.2016-07.io.spdk:init'""")
 407 p.add_argument("-p", "--pci_address", help="""Valid if mode == Direct.
 408 Format:  'domain:device:function' etc
 409 Example: '0000:00:01.0'""")
 410 p.add_argument("-s", "--serial_number", help="""Valid if mode == Virtual.
 411 Format:  'sn' etc
 412 Example: 'SPDK00000000000001'""", default='0000:00:01.0')
 413 p.add_argument("-n", "--namespaces", help="""Whitespace-separated list of namespaces.
 414 Format:  'dev1 dev2 dev3' etc
 415 Example: 'Malloc0 Malloc1 Malloc2'
 416 *** The devices must pre-exist ***""")
 417 p.set_defaults(func=construct_nvmf_subsystem)
 418
 419 def delete_nvmf_subsystem(args):
 420     params = {'nqn': args.subsystem_nqn}
 421     jsonrpc_call('delete_nvmf_subsystem', params)
 422
 423 p = subparsers.add_parser('delete_nvmf_subsystem', help='Delete a nvmf subsystem')
 424 p.add_argument('subsystem_nqn', help='subsystem nqn to be deleted. Example: nqn.2016-06.io.spdk:cnode1.')
 425 p.set_defaults(func=delete_nvmf_subsystem)
 426
 427 def kill_instance(args):
 428     params = {'sig_name': args.sig_name}
 429     jsonrpc_call('kill_instance', params)
 430
 431 p = subparsers.add_parser('kill_instance', help='Send signal to instance')
 432 p.add_argument('sig_name', help='signal will be sent to server.')
 433 p.set_defaults(func=kill_instance)
 434
 435 def get_vhost_scsi_controllers(args):
 436     print_dict(jsonrpc_call('get_vhost_scsi_controllers'))
 437
 438 p = subparsers.add_parser('get_vhost_scsi_controllers', help='List vhost controllers')
 439 p.set_defaults(func=get_vhost_scsi_controllers)
 440
 441 def construct_vhost_scsi_controller(args):
 442     params = {'ctrlr': args.ctrlr}
 443
 444     if args.cpumask:
 445         params['cpumask'] = args.cpumask
 446
 447     jsonrpc_call('construct_vhost_scsi_controller', params)
 448
 449 p = subparsers.add_parser('construct_vhost_scsi_controller', help='Add new vhost controller')
 450 p.add_argument('ctrlr', help='controller name')
 451 p.add_argument('--cpumask', help='cpu mask for this controller')
 452 p.set_defaults(func=construct_vhost_scsi_controller)
 453
 454 def add_vhost_scsi_lun(args):
 455     params = {
 456         'ctrlr': args.ctrlr,
 457         'scsi_dev_num': args.scsi_dev_num,
 458         'lun_name': args.lun_name
 459     }
 460     jsonrpc_call('add_vhost_scsi_lun', params)
 461
 462 p = subparsers.add_parser('add_vhost_scsi_lun', help='Add lun to vhost controller')
 463 p.add_argument('ctrlr', help='conntroller name where add lun')
 464 p.add_argument('scsi_dev_num', help='scsi_dev_num', type=int)
 465 p.add_argument('lun_name', help='lun name')
 466 p.set_defaults(func=add_vhost_scsi_lun)
 467
 468 args = parser.parse_args()
 469 args.func(args)