Spdk/scripts/spdkcli.py
paul luse 17538bdc67 add (c) and SPDX header to python files as needed
per Intel policy to include file commit date using git cmd
below.  The policy does not apply to non-Intel (C) notices.

git log --follow -C90% --format=%ad --date default <file> | tail -1

and then pull just the year from the result.

Intel copyrights were not added to files where Intel either had
no contribution ot the contribution lacked substance (ie license
header updates, formatting changes, etc)

Note that several files in this patch didn't end the license/(c)
block with a blank comment line so these were added as the vast
majority of files do have this last blank line.  Simply there for
consistency.

Signed-off-by: paul luse <paul.e.luse@intel.com>
Change-Id: I6cd3f18d1b469d5ef249d26ddb2923ca6b970bd4
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/15208
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
2022-11-10 08:28:53 +00:00

94 lines
3.3 KiB
Python
Executable File

#!/usr/bin/env python3
# SPDX-License-Identifier: BSD-3-Clause
# Copyright (C) 2018 Intel Corporation
# All rights reserved.
#
import os
import sys
import argparse
from configshell_fb import ConfigShell, shell, ExecutionError
from pyparsing import (alphanums, Optional, Suppress, Word, Regex,
removeQuotes, dblQuotedString, OneOrMore)
sys.path.append(os.path.dirname(__file__) + '/../python')
from spdk.rpc.client import JSONRPCException, JSONRPCClient # noqa
from spdk.spdkcli import UIRoot # noqa
def add_quotes_to_shell(spdk_shell):
command = shell.locatedExpr(Word(alphanums + '_'))('command')
value = dblQuotedString.addParseAction(removeQuotes)
value_word = Word(alphanums + r';,=_\+/.<>()~@:-%[]')
keyword = Word(alphanums + r'_\-')
kparam = shell.locatedExpr(keyword + Suppress('=') +
Optional(value | value_word, default=''))('kparams*')
pparam = shell.locatedExpr(value | value_word)('pparams*')
parameters = OneOrMore(kparam | pparam)
bookmark = Regex(r'@([A-Za-z0-9:_.]|-)+')
pathstd = Regex(r'([A-Za-z0-9:_.\[\]]|-)*' + '/' + r'([A-Za-z0-9:_.\[\]/]|-)*') \
| '..' | '.'
path = shell.locatedExpr(bookmark | pathstd | '*')('path')
spdk_shell._parser = Optional(path) + Optional(command) + Optional(parameters)
def main():
"""
Start SPDK CLI
:return:
"""
spdk_shell = ConfigShell("~/.scripts")
spdk_shell.interactive = True
add_quotes_to_shell(spdk_shell)
parser = argparse.ArgumentParser(description="SPDK command line interface")
parser.add_argument('-s', dest='server_addr',
help='RPC domain socket path or IP address', default='/var/tmp/spdk.sock')
parser.add_argument('-p', dest='port',
help='RPC port number (if server_addr is IP address)',
default=None, type=int)
parser.add_argument("-v", dest="verbose", help="Print request/response JSON for configuration calls",
default=False, action="store_true")
parser.add_argument("commands", metavar="command", type=str, nargs="*", default="",
help="commands to execute by SPDKCli as one-line command")
args = parser.parse_args()
try:
client = JSONRPCClient(args.server_addr, port=args.port)
except JSONRPCException as e:
spdk_shell.log.error("%s. SPDK not running?" % e)
sys.exit(1)
with client:
root_node = UIRoot(client, spdk_shell)
root_node.verbose = args.verbose
try:
root_node.refresh()
except BaseException:
pass
if args.commands:
try:
spdk_shell.interactive = False
spdk_shell.run_cmdline(" ".join(args.commands))
except Exception as e:
sys.stderr.write("%s\n" % e)
sys.exit(1)
sys.exit(0)
spdk_shell.con.display("SPDK CLI v0.1")
spdk_shell.con.display("")
while not spdk_shell._exit:
try:
spdk_shell.run_interactive()
except (JSONRPCException, ExecutionError) as e:
spdk_shell.log.error("%s" % e)
except BrokenPipeError as e:
spdk_shell.log.error("Lost connection with SPDK: %s" % e)
if __name__ == "__main__":
main()