log: use new framework for marking deprecated RPCs

We marked the old set/clear/get_trace_flags as
deprecated in v19.01.  These are now called
set/clear/get_log_flags (to reduce confusion with the
tracing framework).  Use the new methods in this
patch series to mark these RPCs as deprecated.

Signed-off-by: Jim Harris <james.r.harris@intel.com>
Change-Id: I5ce8992ce8f6c1de5d5596b5f94a1587555e8546

Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/453563
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
This commit is contained in:
Jim Harris 2019-05-07 09:05:41 -07:00
parent c2b5a3f6b4
commit e2d7d02d65
3 changed files with 12 additions and 71 deletions

View File

@ -278,16 +278,7 @@ invalid:
free_rpc_log_flag(&req); free_rpc_log_flag(&req);
} }
SPDK_RPC_REGISTER("set_log_flag", spdk_rpc_set_log_flag, SPDK_RPC_STARTUP | SPDK_RPC_RUNTIME) SPDK_RPC_REGISTER("set_log_flag", spdk_rpc_set_log_flag, SPDK_RPC_STARTUP | SPDK_RPC_RUNTIME)
SPDK_RPC_REGISTER_ALIAS_DEPRECATED(set_log_flag, set_trace_flag)
static void
spdk_rpc_set_trace_flag(struct spdk_jsonrpc_request *request,
const struct spdk_json_val *params)
{
SPDK_ERRLOG("set_log_flag is deprecated\n");
spdk_rpc_set_log_flag(request, params);
}
SPDK_RPC_REGISTER("set_trace_flag", spdk_rpc_set_trace_flag, SPDK_RPC_STARTUP | SPDK_RPC_RUNTIME)
static void static void
spdk_rpc_clear_log_flag(struct spdk_jsonrpc_request *request, spdk_rpc_clear_log_flag(struct spdk_jsonrpc_request *request,
@ -325,17 +316,7 @@ invalid:
} }
SPDK_RPC_REGISTER("clear_log_flag", spdk_rpc_clear_log_flag, SPDK_RPC_REGISTER("clear_log_flag", spdk_rpc_clear_log_flag,
SPDK_RPC_STARTUP | SPDK_RPC_RUNTIME) SPDK_RPC_STARTUP | SPDK_RPC_RUNTIME)
SPDK_RPC_REGISTER_ALIAS_DEPRECATED(clear_log_flag, clear_trace_flag)
static void
spdk_rpc_clear_trace_flag(struct spdk_jsonrpc_request *request,
const struct spdk_json_val *params)
{
SPDK_ERRLOG("clear_log_flag RPC is deprecated\n");
spdk_rpc_clear_log_flag(request, params);
}
SPDK_RPC_REGISTER("clear_trace_flag", spdk_rpc_clear_trace_flag,
SPDK_RPC_STARTUP | SPDK_RPC_RUNTIME)
static void static void
spdk_rpc_get_log_flags(struct spdk_jsonrpc_request *request, spdk_rpc_get_log_flags(struct spdk_jsonrpc_request *request,
@ -366,13 +347,4 @@ spdk_rpc_get_log_flags(struct spdk_jsonrpc_request *request,
spdk_jsonrpc_end_result(request, w); spdk_jsonrpc_end_result(request, w);
} }
SPDK_RPC_REGISTER("get_log_flags", spdk_rpc_get_log_flags, SPDK_RPC_STARTUP | SPDK_RPC_RUNTIME) SPDK_RPC_REGISTER("get_log_flags", spdk_rpc_get_log_flags, SPDK_RPC_STARTUP | SPDK_RPC_RUNTIME)
SPDK_RPC_REGISTER_ALIAS_DEPRECATED(get_log_flags, get_trace_flags)
static void
spdk_rpc_get_trace_flags(struct spdk_jsonrpc_request *request,
const struct spdk_json_val *params)
{
SPDK_ERRLOG("get_trace_flags RPC is deprecated\n");
spdk_rpc_get_log_flags(request, params);
}
SPDK_RPC_REGISTER("get_trace_flags", spdk_rpc_get_trace_flags, SPDK_RPC_STARTUP | SPDK_RPC_RUNTIME)

View File

@ -1019,50 +1019,25 @@ Format: 'user:u1 secret:s1 muser:mu1 msecret:ms1,user:u2 secret:s2 muser:mu2 mse
def set_log_flag(args): def set_log_flag(args):
rpc.log.set_log_flag(args.client, flag=args.flag) rpc.log.set_log_flag(args.client, flag=args.flag)
p = subparsers.add_parser('set_log_flag', help='set log flag') p = subparsers.add_parser('set_log_flag', help='set log flag', aliases=['set_trace_flag'])
p.add_argument( p.add_argument(
'flag', help='log flag we want to set. (for example "nvme").') 'flag', help='log flag we want to set. (for example "nvme").')
p.set_defaults(func=set_log_flag) p.set_defaults(func=set_log_flag)
def set_trace_flag(args):
print("set_trace_flag is deprecated - use set_log_flag instead")
rpc.log.set_trace_flag(args.client, flag=args.flag)
p = subparsers.add_parser('set_trace_flag', help='set trace flag')
p.add_argument(
'flag', help='trace mask we want to set. (for example "nvme").')
p.set_defaults(func=set_trace_flag)
def clear_log_flag(args): def clear_log_flag(args):
rpc.log.clear_log_flag(args.client, flag=args.flag) rpc.log.clear_log_flag(args.client, flag=args.flag)
p = subparsers.add_parser('clear_log_flag', help='clear log flag') p = subparsers.add_parser('clear_log_flag', help='clear log flag', aliases=['clear_trace_flag'])
p.add_argument( p.add_argument(
'flag', help='log flag we want to clear. (for example "nvme").') 'flag', help='log flag we want to clear. (for example "nvme").')
p.set_defaults(func=clear_log_flag) p.set_defaults(func=clear_log_flag)
def clear_trace_flag(args):
print("clear_trace_flag is deprecated - use clear_log_flag instead")
rpc.log.clear_trace_flag(args.client, flag=args.flag)
p = subparsers.add_parser('clear_trace_flag', help='clear trace flag')
p.add_argument(
'flag', help='trace mask we want to clear. (for example "nvme").')
p.set_defaults(func=clear_trace_flag)
def get_log_flags(args): def get_log_flags(args):
print_dict(rpc.log.get_log_flags(args.client)) print_dict(rpc.log.get_log_flags(args.client))
p = subparsers.add_parser('get_log_flags', help='get log flags') p = subparsers.add_parser('get_log_flags', help='get log flags', aliases=['get_trace_flags'])
p.set_defaults(func=get_log_flags) p.set_defaults(func=get_log_flags)
def get_trace_flags(args):
print("get_trace_flags is deprecated - use get_log_flags instead")
print_dict(rpc.log.get_trace_flags(args.client))
p = subparsers.add_parser('get_trace_flags', help='get trace flags')
p.set_defaults(func=get_trace_flags)
def set_log_level(args): def set_log_level(args):
rpc.log.set_log_level(args.client, level=args.level) rpc.log.set_log_level(args.client, level=args.level)

View File

@ -1,3 +1,7 @@
from .helpers import deprecated_alias
@deprecated_alias('set_trace_flag')
def set_log_flag(client, flag): def set_log_flag(client, flag):
"""Set log flag. """Set log flag.
@ -8,10 +12,7 @@ def set_log_flag(client, flag):
return client.call('set_log_flag', params) return client.call('set_log_flag', params)
def set_trace_flag(client, flag): @deprecated_alias('clear_trace_flag')
return set_log_flag(client, flag)
def clear_log_flag(client, flag): def clear_log_flag(client, flag):
"""Clear log flag. """Clear log flag.
@ -22,10 +23,7 @@ def clear_log_flag(client, flag):
return client.call('clear_log_flag', params) return client.call('clear_log_flag', params)
def clear_trace_flag(client, flag): @deprecated_alias('get_trace_flags')
return clear_log_flag(client, flag)
def get_log_flags(client): def get_log_flags(client):
"""Get log flags """Get log flags
@ -35,10 +33,6 @@ def get_log_flags(client):
return client.call('get_log_flags') return client.call('get_log_flags')
def get_trace_flags(client):
return get_log_flags(client)
def set_log_level(client, level): def set_log_level(client, level):
"""Set log level. """Set log level.