From cc459456f0f777d1ac46374fda94835657257846 Mon Sep 17 00:00:00 2001 From: Christophe Bedard Date: Wed, 1 Jan 2020 14:12:23 -0500 Subject: [PATCH] Expose context enabling through CLI and Trace action --- ros2trace/ros2trace/command/trace.py | 1 + tracetools_launch/tracetools_launch/action.py | 8 +++++++- tracetools_trace/tracetools_trace/tools/args.py | 13 ++++++++++--- tracetools_trace/tracetools_trace/tools/lttng.py | 2 +- tracetools_trace/tracetools_trace/trace.py | 13 +++++++++++-- 5 files changed, 30 insertions(+), 7 deletions(-) diff --git a/ros2trace/ros2trace/command/trace.py b/ros2trace/ros2trace/command/trace.py index 6c0537b..798770b 100644 --- a/ros2trace/ros2trace/command/trace.py +++ b/ros2trace/ros2trace/command/trace.py @@ -32,6 +32,7 @@ class TraceCommand(CommandExtension): args.path, args.events_ust, args.events_kernel, + args.context_names, args.list, ) fini( diff --git a/tracetools_launch/tracetools_launch/action.py b/tracetools_launch/tracetools_launch/action.py index a3432e2..c36fd0d 100644 --- a/tracetools_launch/tracetools_launch/action.py +++ b/tracetools_launch/tracetools_launch/action.py @@ -51,6 +51,7 @@ class Trace(Action): base_path: str = path.DEFAULT_BASE_PATH, events_ust: List[str] = names.DEFAULT_EVENTS_ROS, events_kernel: List[str] = names.DEFAULT_EVENTS_KERNEL, + context_names: List[str] = names.DEFAULT_CONTEXT, profile_fast: bool = True, **kwargs, ) -> None: @@ -62,6 +63,7 @@ class Trace(Action): :param base_path: the path to the base directory in which to create the session directory :param events_ust: the list of ROS UST events to enable :param events_kernel: the list of kernel events to enable + :param context_names: the list of context names to enable :param profile_fast: `True` to use fast profiling, `False` for normal (only if necessary) """ super().__init__(**kwargs) @@ -71,6 +73,7 @@ class Trace(Action): self.__base_path = base_path self.__events_ust = events_ust self.__events_kernel = events_kernel + self.__context_names = context_names self.__profile_fast = profile_fast self.__ld_preload_actions = [] # Add LD_PRELOAD actions if corresponding events are enabled @@ -125,7 +128,9 @@ class Trace(Action): self.__session_name, self.__base_path, ros_events=self.__events_ust, - kernel_events=self.__events_kernel) + kernel_events=self.__events_kernel, + context_names=self.__context_names, + ) def _destroy(self, event: Event, context: LaunchContext) -> None: lttng.lttng_fini(self.__session_name) @@ -137,6 +142,7 @@ class Trace(Action): f'base_path={self.__base_path}, ' f'num_events_ust={len(self.__events_ust)}, ' f'num_events_kernel={len(self.__events_kernel)}, ' + f'context_names={self.__context_names}, ' f'profile_fast={self.__profile_fast}, ' f'ld_preload_actions={self.__ld_preload_actions})' ) diff --git a/tracetools_trace/tracetools_trace/tools/args.py b/tracetools_trace/tracetools_trace/tools/args.py index aca714e..7a98af7 100644 --- a/tracetools_trace/tracetools_trace/tools/args.py +++ b/tracetools_trace/tracetools_trace/tools/args.py @@ -50,17 +50,24 @@ def add_arguments(parser: argparse.ArgumentParser): arg = parser.add_argument( '-u', '--ust', nargs='*', dest='events_ust', default=names.DEFAULT_EVENTS_ROS, - help='the ROS UST events to enable (default: all events) ' + help='the ROS UST events to enable (default: see tracetools_trace.tools.names) ' '[to disable all UST events, ' 'provide this flag without any event name]') arg.completer = DefaultArgValueCompleter(arg) arg = parser.add_argument( '-k', '--kernel', nargs='*', dest='events_kernel', default=names.DEFAULT_EVENTS_KERNEL, - help='the kernel events to enable (default: all events) ' + help='the kernel events to enable (default: see tracetools_trace.tools.names) ' '[to disable all kernel events, ' 'provide this flag without any event name]') arg.completer = DefaultArgValueCompleter(arg) + arg = parser.add_argument( + '-c', '--context', nargs='*', dest='context_names', + default=names.DEFAULT_CONTEXT, + help='the context names to enable (default: see tracetools_trace.tools.names) ' + '[to disable all context names, ' + 'provide this flag without any name]') + arg.completer = DefaultArgValueCompleter(arg) parser.add_argument( '-l', '--list', dest='list', action='store_true', - help='display lists of enabled events (default: %(default)s)') + help='display lists of enabled events and context names (default: %(default)s)') diff --git a/tracetools_trace/tracetools_trace/tools/lttng.py b/tracetools_trace/tracetools_trace/tools/lttng.py index de22fd5..20f04e9 100644 --- a/tracetools_trace/tracetools_trace/tools/lttng.py +++ b/tracetools_trace/tracetools_trace/tools/lttng.py @@ -37,7 +37,7 @@ def lttng_init( base_path: str = DEFAULT_BASE_PATH, ros_events: List[str] = DEFAULT_EVENTS_ROS, kernel_events: List[str] = DEFAULT_EVENTS_KERNEL, - context_names: List[str] = DEFAULT_CONTEXT + context_names: List[str] = DEFAULT_CONTEXT, ) -> None: """ Set up and start LTTng session. diff --git a/tracetools_trace/tracetools_trace/trace.py b/tracetools_trace/tracetools_trace/trace.py index a4b0362..1f3aad9 100644 --- a/tracetools_trace/tracetools_trace/trace.py +++ b/tracetools_trace/tracetools_trace/trace.py @@ -28,6 +28,7 @@ def init( base_path: str, ros_events: List[str], kernel_events: List[str], + context_names: List[str], display_list: bool = False, ) -> None: """ @@ -37,7 +38,8 @@ def init( :param base_path: the path to the directory in which to create the tracing session directory :param ros_events: list of ROS events to enable :param kernel_events: list of kernel events to enable - :param display_list: whether to display list(s) of enabled events + :param context_names: list of context names to enable + :param display_list: whether to display list(s) of enabled events and context names """ ust_enabled = len(ros_events) > 0 kernel_enabled = len(kernel_events) > 0 @@ -53,6 +55,10 @@ def init( print_names_list(kernel_events) else: print('kernel tracing disabled') + if len(context_names) > 0: + print(f'context ({len(context_names)} names)') + if display_list: + print_names_list(context_names) full_session_path = path.get_full_session_path(session_name, base_path) print(f'writing tracing session to: {full_session_path}') @@ -61,7 +67,9 @@ def init( session_name, base_path=base_path, ros_events=ros_events, - kernel_events=kernel_events) + kernel_events=kernel_events, + context_names=context_names, + ) def fini( @@ -85,6 +93,7 @@ def main(): params.path, params.events_ust, params.events_kernel, + params.context_names, params.list, ) fini(