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