numam-spdk/scripts/spdkcli.py
Vitaliy Mysak 9fd7f2196b spdkcli: handle BrokenPipeError
Catch BrokenPipeError to display meaningful error message.

Withouth this change, user gets stacktrace
  when e.g. SPDK application was closed.

Change-Id: Ia7d8edb92a70b4c4b9e71a7d4ce38e265769936a
Signed-off-by: Vitaliy Mysak <vitaliy.mysak@intel.com>
Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/461571
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Karol Latecki <karol.latecki@intel.com>
Reviewed-by: Darek Stojaczyk <dariusz.stojaczyk@intel.com>
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
2019-07-22 03:41:00 +00:00

84 lines
3.0 KiB
Python
Executable File

#!/usr/bin/env python3
import sys
import argparse
import configshell_fb
from os import getuid
from rpc.client import JSONRPCException
from configshell_fb import ConfigShell, shell, ExecutionError
from spdkcli import UIRoot
import rpc.client
from pyparsing import (alphanums, Optional, Suppress, Word, Regex,
removeQuotes, dblQuotedString, OneOrMore)
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="socket", help="RPC socket path", default="/var/tmp/spdk.sock")
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 = rpc.client.JSONRPCClient(args.socket)
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 len(args.commands) > 0:
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)
break
if __name__ == "__main__":
main()