Merge branch 'expose-context-names' into 'master'

Expose enabling of context names

Closes #44

See merge request micro-ROS/ros_tracing/ros2_tracing!129

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(

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})'
         )

tracetools_trace/tracetools_trace/tools/__init__.py

@@ -27,9 +27,9 @@ def tracing_supported() -> bool:
     return sys.platform == 'linux'
 
 
-def print_events_list(
-    events: List[str],
+def print_names_list(
+    names: List[str],
     prefix: str = '\t',
 ) -> None:
-    for event in events:
-        print(f'{prefix}{event}')
+    for name in names:
+        print(f'{prefix}{name}')

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)')

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.
@@ -52,7 +52,9 @@ def lttng_init(
     _lttng.start(session_name)
 
 
-def lttng_fini(session_name: str) -> None:
+def lttng_fini(
+    session_name: str,
+) -> None:
     """
     Stop and destroy LTTng session.
 

tracetools_trace/tracetools_trace/tools/lttng_impl.py

@@ -109,11 +109,14 @@ def setup(
 
     # Context
     context_list = _create_context_list(context_names)
+    # TODO make it possible to add context in userspace and kernel separately
     enabled_handles = [h for h in [handle_ust, handle_kernel] if h is not None]
     _add_context(enabled_handles, context_list)
 
 
-def start(session_name: str) -> None:
+def start(
+    session_name: str,
+) -> None:
     """
     Start LTTng session, and check for errors.
 
@@ -124,7 +127,9 @@ def start(session_name: str) -> None:
         raise RuntimeError(f'failed to start tracing: {lttng.strerror(result)}')
 
 
-def stop(session_name: str) -> None:
+def stop(
+    session_name: str,
+) -> None:
     """
     Stop LTTng session, and check for errors.
 
@@ -135,7 +140,9 @@ def stop(session_name: str) -> None:
         raise RuntimeError(f'failed to stop tracing: {lttng.strerror(result)}')
 
 
-def destroy(session_name: str) -> None:
+def destroy(
+    session_name: str,
+) -> None:
     """
     Destroy LTTng session, and check for errors.
 
@@ -146,7 +153,9 @@ def destroy(session_name: str) -> None:
         raise RuntimeError(f'failed to destroy tracing session: {lttng.strerror(result)}')
 
 
-def _create_events(event_names_list: List[str]) -> List[lttng.Event]:
+def _create_events(
+    event_names_list: List[str],
+) -> List[lttng.Event]:
     """
     Create events list from names.
 
@@ -163,7 +172,10 @@ def _create_events(event_names_list: List[str]) -> List[lttng.Event]:
     return events_list
 
 
-def _create_session(session_name: str, full_path: str) -> None:
+def _create_session(
+    session_name: str,
+    full_path: str,
+) -> None:
     """
     Create session from name and full directory path, and check for errors.
 
@@ -181,7 +193,10 @@ def _create_session(session_name: str, full_path: str) -> None:
         raise RuntimeError(f'session creation failed: {lttng.strerror(result)}')
 
 
-def _create_handle(session_name: str, domain: lttng.Domain) -> lttng.Handle:
+def _create_handle(
+    session_name: str,
+    domain: lttng.Domain,
+) -> lttng.Handle:
     """
     Create a handle for a given session name and a domain, and check for errors.
 
@@ -196,7 +211,10 @@ def _create_handle(session_name: str, domain: lttng.Domain) -> lttng.Handle:
     return handle
 
 
-def _enable_channel(handle: lttng.Handle, channel: lttng.Channel) -> None:
+def _enable_channel(
+    handle: lttng.Handle,
+    channel: lttng.Channel,
+) -> None:
     """
     Enable channel for a handle, and check for errors.
 
@@ -229,12 +247,15 @@ def _enable_events(
 context_map = {
     'procname': lttng.EVENT_CONTEXT_PROCNAME,
     'pid': lttng.EVENT_CONTEXT_PID,
+    'tid': lttng.EVENT_CONTEXT_TID,
     'vpid': lttng.EVENT_CONTEXT_VPID,
     'vtid': lttng.EVENT_CONTEXT_VTID,
 }
 
 
-def _context_name_to_type(context_name: str) -> int:
+def _context_name_to_type(
+    context_name: str,
+) -> int:
     """
     Convert from context name to LTTng enum/constant type.
 
@@ -244,7 +265,9 @@ def _context_name_to_type(context_name: str) -> int:
     return context_map.get(context_name)
 
 
-def _create_context_list(context_names_list: List[str]) -> List[lttng.EventContext]:
+def _create_context_list(
+    context_names_list: List[str],
+) -> List[lttng.EventContext]:
     """
     Create context list from names, and check for errors.
 

tracetools_trace/tracetools_trace/tools/names.py

@@ -75,11 +75,19 @@ DEFAULT_EVENTS_ROS = [
     'ros2:callback_end',
 ]
 
-DEFAULT_CONTEXT = [
+CONTEXT = [
     'procname',
     'perf:thread:instructions',
     'perf:thread:cycles',
     'perf:thread:cpu-cycles',
+    'pid',
+    'tid',
+    'vpid',
+    'vtid',
+]
+
+DEFAULT_CONTEXT = [
+    'procname',
     'vpid',
     'vtid',
 ]

tracetools_trace/tracetools_trace/trace.py

@@ -20,7 +20,7 @@ from typing import List
 from tracetools_trace.tools import args
 from tracetools_trace.tools import lttng
 from tracetools_trace.tools import path
-from tracetools_trace.tools import print_events_list
+from tracetools_trace.tools import print_names_list
 
 
 def init(
@@ -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,22 +38,27 @@ 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
     if ust_enabled:
         print(f'UST tracing enabled ({len(ros_events)} events)')
         if display_list:
-            print_events_list(ros_events)
+            print_names_list(ros_events)
     else:
         print('UST tracing disabled')
     if kernel_enabled:
         print(f'kernel tracing enabled ({len(kernel_events)} events)')
         if display_list:
-            print_events_list(kernel_events)
+            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(