1 #!/usr/bin/env python3 2 # SPDX-License-Identifier: BSD-3-Clause 3 # Copyright (C) 2019 Intel Corporation 4 # All rights reserved. 5 # 6 7 from spdk.rpc.client import print_dict, JSONRPCException 8 9 import logging 10 import argparse 11 import spdk.rpc as rpc 12 import sys 13 import shlex 14 15 try: 16 from shlex import quote 17 except ImportError: 18 from pipes import quote 19 20 21 def print_array(a): 22 print(" ".join((quote(v) for v in a))) 23 24 25 def _fuzz_vhost_create_dev(client, socket, is_blk, use_bogus_buffer, use_valid_buffer, test_scsi_tmf, valid_lun): 26 """Create a new device in the vhost fuzzer. 27 28 Args: 29 socket: A valid unix domain socket for the dev to bind to. 30 is_blk: if set, create a virtio_blk device, otherwise use scsi. 31 use_bogus_buffer: if set, pass an invalid memory address as a buffer accompanying requests. 32 use_valid_buffer: if set, pass in a valid memory buffer with requests. Overrides use_bogus_buffer. 33 test_scsi_tmf: Test scsi management commands on the given device. Valid if and only if is_blk is false. 34 valid_lun: Supply only a valid lun number when submitting commands to the given device. Valid if and only if is_blk is false. 35 36 Returns: 37 True or False 38 """ 39 40 params = {"socket": socket, 41 "is_blk": is_blk, 42 "use_bogus_buffer": use_bogus_buffer, 43 "use_valid_buffer": use_valid_buffer, 44 "test_scsi_tmf": test_scsi_tmf, 45 "valid_lun": valid_lun} 46 47 return client.call("fuzz_vhost_create_dev", params) 48 49 50 if __name__ == "__main__": 51 parser = argparse.ArgumentParser( 52 description='SPDK RPC command line interface. NOTE: spdk/python is expected in PYTHONPATH') 53 parser.add_argument('-s', dest='server_addr', 54 help='RPC domain socket path or IP address', default='/var/tmp/spdk.sock') 55 parser.add_argument('-p', dest='port', 56 help='RPC port number (if server_addr is IP address)', 57 default=5260, type=int) 58 parser.add_argument('-t', dest='timeout', 59 help='Timeout as a floating point number expressed in seconds waiting for response. Default: 60.0', 60 default=60.0, type=float) 61 parser.add_argument('-v', dest='verbose', action='store_const', const="INFO", 62 help='Set verbose mode to INFO', default="ERROR") 63 parser.add_argument('--verbose', dest='verbose', choices=['DEBUG', 'INFO', 'ERROR'], 64 help="""Set verbose level. """) 65 subparsers = parser.add_subparsers(help='RPC methods') 66 67 def fuzz_vhost_create_dev(args): 68 _fuzz_vhost_create_dev( 69 args.client, 70 args.socket, 71 args.is_blk, 72 args.use_bogus_buffer, 73 args.use_valid_buffer, 74 args.test_scsi_tmf, 75 args.valid_lun) 76 77 p = subparsers.add_parser('fuzz_vhost_create_dev', help="Add a new device to the vhost fuzzer.") 78 p.add_argument('-s', '--socket', help="Path to a valid unix domain socket for dev binding.") 79 p.add_argument('-b', '--is-blk', help='The specified socket corresponds to a vhost-blk dev.', action='store_true') 80 p.add_argument('-u', '--use-bogus-buffer', help='Pass bogus buffer addresses with requests when fuzzing.', action='store_true') 81 p.add_argument('-v', '--use-valid-buffer', help='Pass valid buffers when fuzzing. overrides use-bogus-buffer.', action='store_true') 82 p.add_argument('-m', '--test-scsi-tmf', help='for a scsi device, test scsi management commands.', action='store_true') 83 p.add_argument('-l', '--valid-lun', help='for a scsi device, test only using valid lun IDs.', action='store_true') 84 p.set_defaults(func=fuzz_vhost_create_dev) 85 86 def call_rpc_func(args): 87 try: 88 args.func(args) 89 except JSONRPCException as ex: 90 print(ex.message) 91 exit(1) 92 93 def execute_script(parser, client, fd): 94 for rpc_call in map(str.rstrip, fd): 95 if not rpc_call.strip(): 96 continue 97 args = parser.parse_args(shlex.split(rpc_call)) 98 args.client = client 99 call_rpc_func(args) 100 101 args = parser.parse_args() 102 args.client = rpc.client.JSONRPCClient(args.server_addr, args.port, args.timeout, log_level=getattr(logging, args.verbose.upper())) 103 if hasattr(args, 'func'): 104 call_rpc_func(args) 105 elif sys.stdin.isatty(): 106 # No arguments and no data piped through stdin 107 parser.print_help() 108 exit(1) 109 else: 110 execute_script(parser, args.client, sys.stdin) 111