1#!/usr/bin/env python3 2# SPDX-License-Identifier: BSD-3-Clause 3# Copyright (C) 2019 Intel Corporation 4# All rights reserved. 5# 6 7import logging 8import argparse 9import sys 10import shlex 11 12try: 13 from spdk.rpc.client import print_dict, JSONRPCException 14 import spdk.rpc as rpc 15except ImportError: 16 print("SPDK RPC library missing. Please add spdk/python directory to PYTHONPATH:") 17 print("'export PYTHONPATH=$PYTHONPATH:spdk/python'") 18 exit(1) 19 20try: 21 from shlex import quote 22except ImportError: 23 from pipes import quote 24 25PATTERN_TYPES_STR = ("read", "write", "randread", "randwrite", "rw", "randrw", "verify", "reset", 26 "unmap", "flush", "write_zeroes") 27 28 29def print_array(a): 30 print(" ".join((quote(v) for v in a))) 31 32 33def perform_tests_func(args): 34 """Perform bdevperf tests with command line arguments. 35 36 Args: 37 none 38 39 Returns: 40 On success, 0 is returned. On error, -1 is returned. 41 """ 42 client = args.client 43 param_names = ['queue_depth', 'time_in_sec', 'workload_type', 'io_size', 'rw_percentage'] 44 params = {name: getattr(args, name) for name in param_names if getattr(args, name, None)} 45 return client.call('perform_tests', params) 46 47 48if __name__ == "__main__": 49 parser = argparse.ArgumentParser( 50 description='SPDK RPC command line interface. NOTE: spdk/python is expected in PYTHONPATH') 51 parser.add_argument('-s', dest='server_addr', 52 help='RPC domain socket path or IP address', default='/var/tmp/spdk.sock') 53 parser.add_argument('-p', dest='port', 54 help='RPC port number (if server_addr is IP address)', 55 default=5260, type=int) 56 parser.add_argument('-t', dest='timeout', 57 help='Timeout as a floating point number expressed in seconds waiting for response. Default: 60.0', 58 default=60.0, type=float) 59 parser.add_argument('-v', dest='verbose', action='store_const', const="INFO", 60 help='Set verbose mode to INFO', default="ERROR") 61 parser.add_argument('--verbose', dest='verbose', choices=['DEBUG', 'INFO', 'ERROR'], 62 help="""Set verbose level. """) 63 subparsers = parser.add_subparsers(help='RPC methods') 64 65 def perform_tests(args): 66 print_dict(perform_tests_func(args)) 67 68 perform_tests_help_string = ''' 69 Perform bdevperf tests 70 All parameters are optional. 71 If any parameter provided it will overwrite ones from prior run or command line. 72 If job config file was used no parameter should be provided. 73 ''' 74 p = subparsers.add_parser('perform_tests', help=perform_tests_help_string) 75 p.add_argument('-q', dest="queue_depth", help='io depth', type=int) 76 p.add_argument('-o', dest="io_size", help='Size in bytes', type=str) 77 p.add_argument('-t', dest="time_in_sec", help='Time in seconds', type=int) 78 p.add_argument('-M', dest="rw_percentage", help='rwmixread (100 for reads, 0 for writes)', 79 type=int, choices=range(0, 101), metavar="[0-100]") 80 p.add_argument('-w', dest="workload_type", choices=PATTERN_TYPES_STR, type=str.lower, 81 help=f'io pattern type, must be one of {PATTERN_TYPES_STR}',) 82 p.set_defaults(func=perform_tests) 83 84 def call_rpc_func(args): 85 try: 86 args.func(args) 87 except JSONRPCException as ex: 88 print(ex.message) 89 exit(1) 90 91 def execute_script(parser, client, fd): 92 for rpc_call in map(str.rstrip, fd): 93 if not rpc_call.strip(): 94 continue 95 args = parser.parse_args(shlex.split(rpc_call)) 96 args.client = client 97 call_rpc_func(args) 98 99 args = parser.parse_args() 100 args.client = rpc.client.JSONRPCClient(args.server_addr, args.port, args.timeout, log_level=getattr(logging, args.verbose.upper())) 101 if hasattr(args, 'func'): 102 call_rpc_func(args) 103 elif sys.stdin.isatty(): 104 # No arguments and no data piped through stdin 105 parser.print_help() 106 exit(1) 107 else: 108 execute_script(parser, args.client, sys.stdin) 109