rocpd filter support

Author: jrmadsen

source/lib/python/rocpd/__main__.py

@@ -44,6 +44,7 @@ def main(argv=None, config=None):
     from . import pftrace
     from . import query
     from . import summary
+    from . import filter
     from . import time_window
     from . import version_info
     from .importer import RocpdImportData
@@ -110,6 +111,18 @@ def main(argv=None, config=None):
         help="Print the version information and exit",
     )
 
+    def add_required_args(_parser):
+        _required_params = _parser.add_argument_group("Required options")
+        _required_params.add_argument(
+            "-i",
+            "--input",
+            required=True,
+            type=output_config.check_file_exists,
+            nargs="+",
+            help="Input path and filename to one or more database(s), separated by spaces",
+        )
+        return _required_params
+
     subparsers = parser.add_subparsers(dest="command")
     converter = subparsers.add_parser(
         "convert",
@@ -138,16 +151,7 @@ def main(argv=None, config=None):
     def get_output_type(val):
         return val.lower().replace("perfetto", "pftrace")
 
-    # add required options for each subparser
-    converter_required_params = converter.add_argument_group("Required options")
-    converter_required_params.add_argument(
-        "-i",
-        "--input",
-        required=True,
-        type=output_config.check_file_exists,
-        nargs="+",
-        help="Input path and filename to one or more database(s)",
-    )
+    converter_required_params = add_required_args(converter)
     converter_required_params.add_argument(
         "-f",
         "--output-format",
@@ -159,43 +163,28 @@ def get_output_type(val):
         required=True,
     )
 
-    query_required_params = query_reporter.add_argument_group("Required options")
-    query_required_params.add_argument(
-        "-i",
-        "--input",
-        required=True,
-        type=output_config.check_file_exists,
-        nargs="+",
-        help="Input path and filename to one or more database(s)",
-    )
-
-    summary_required_params = generate_summary.add_argument_group("Required options")
-    summary_required_params.add_argument(
-        "-i",
-        "--input",
-        required=True,
-        type=output_config.check_file_exists,
-        nargs="+",
-        help="Input path and filename to one or more database(s)",
-    )
+    query_required_params = add_required_args(query_reporter)
+    summary_required_params = add_required_args(generate_summary)
 
     # converter: add args from any sub-modules
     valid_out_config_args = output_config.add_args(converter)
-    valid_generic_args = output_config.add_generic_args(converter)
     valid_pftrace_args = pftrace.add_args(converter)
     valid_csv_args = csv.add_args(converter)
     valid_otf2_args = otf2.add_args(converter)
     valid_time_window_args = time_window.add_args(converter)
+    valid_filter_args = filter.add_args(converter)
 
     # query: subparser args
     valid_out_config_args = output_config.add_args(query_reporter)
     valid_query_args = query.add_args(query_reporter)
     valid_time_window_args = time_window.add_args(query_reporter)
+    valid_filter_args = filter.add_args(query_reporter)
 
     # summary: subparser args
     valid_io_args = summary.add_io_args(generate_summary)
     valid_summary_args = summary.add_args(generate_summary)
     valid_time_window_args = time_window.add_args(generate_summary)
+    valid_filter_args = filter.add_args(generate_summary)
 
     # parse the command line arguments
     args = parser.parse_args(argv)
@@ -216,13 +205,11 @@ def get_output_type(val):
     if args.command == "convert":
         # process the args
         out_cfg_args = output_config.process_args(args, valid_out_config_args)
-        generic_out_cfg_args = output_config.process_generic_args(
-            args, valid_generic_args
-        )
         pftrace_args = pftrace.process_args(args, valid_pftrace_args)
         csv_args = csv.process_args(args, valid_csv_args)
         otf2_args = otf2.process_args(args, valid_otf2_args)
         window_args = time_window.process_args(args, valid_time_window_args)
+        filter_args = filter.process_args(args, valid_filter_args)
 
         # now start processing the data.  Import the data and merge the views
         importData = RocpdImportData(args.input)
@@ -231,9 +218,13 @@ def get_output_type(val):
         if window_args is not None:
             time_window.apply_time_window(importData, **window_args)
 
+        # apply filtering if requested
+        if filter_args is not None:
+            filter.check_args(importData, **filter_args)
+            filter.apply_filter(importData, **filter_args)
+
         all_args = {
             **out_cfg_args,
-            **generic_out_cfg_args,
             **pftrace_args,
             **csv_args,
             **otf2_args,
@@ -254,7 +245,7 @@ def get_output_type(val):
 
         for out_format in args.output_format:
             if out_format in format_handlers:
-                print(f"Converting database(s) to {out_format} format:")
+                print(f"\nConverting database(s) to {out_format} format...")
                 format_handlers[out_format](importData, config)
             else:
                 print(f"Warning: Unsupported output format '{out_format}'")
@@ -265,13 +256,18 @@ def get_output_type(val):
         query_args = query.process_args(args, valid_query_args)
         out_cfg_args = output_config.process_args(args, valid_out_config_args)
         window_args = time_window.process_args(args, valid_time_window_args)
+        filter_args = filter.process_args(args, valid_filter_args)
 
-        all_args = {**query_args, **out_cfg_args}
+        all_args = {
+            **query_args,
+            **out_cfg_args,
+        }
 
         query.execute(
             args.input,
             args,
             window_args=window_args,
+            filter_args=filter_args,
             **all_args,
         )
 
@@ -281,6 +277,7 @@ def get_output_type(val):
         summary_args = summary.process_args(args, valid_summary_args)
         io_args = output_config.process_args(args, valid_io_args)
         window_args = time_window.process_args(args, valid_time_window_args)
+        filter_args = filter.process_args(args, valid_filter_args)
 
         # now start processing the data.  Import the data and merge the views
         importData = RocpdImportData(args.input)
@@ -289,6 +286,11 @@ def get_output_type(val):
         if window_args is not None:
             time_window.apply_time_window(importData, **window_args)
 
+        # apply filtering if requested
+        if filter_args is not None:
+            filter.check_args(importData, **filter_args)
+            filter.apply_filter(importData, **filter_args)
+
         all_args = {**summary_args, **io_args}
         summary.generate_all_summaries(importData, **all_args)
 

source/lib/python/rocpd/bindings.py

@@ -0,0 +1,45 @@
+#!/usr/bin/env python3
+###############################################################################
+# MIT License
+#
+# Copyright (c) 2023 Advanced Micro Devices, Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+###############################################################################
+
+
+__all__ = ["RocpdImportData", "connect"]
+
+import sqlite3
+
+try:
+    from . import libpyrocpd
+
+    RocpdImportData = libpyrocpd.RocpdImportData
+    connect = libpyrocpd.connect
+
+except ImportError:
+
+    class RocpdImportData(sqlite3.Connection):
+        """Fallback class replicating the interface of libpyrocpd.RocpdImportData."""
+
+        def __init__(self, input, dbname=":memory:"):
+            pass
+
+    connect = sqlite3.connect

source/lib/python/rocpd/csv.py

@@ -25,6 +25,7 @@
 
 from .importer import RocpdImportData
 from .time_window import apply_time_window
+from .filter import apply_filter
 from . import output_config
 from . import libpyrocpd
 
@@ -33,11 +34,12 @@ def write_csv(importData, config):
     return libpyrocpd.write_csv(importData, config)
 
 
-def execute(input, config=None, window_args=None, **kwargs):
+def execute(input, config=None, window_args=None, filter_args=None, **kwargs):
 
     importData = RocpdImportData(input)
 
     apply_time_window(importData, **window_args)
+    apply_filter(importData, **filter_args)
 
     config = (
         output_config.output_config(**kwargs)
@@ -65,7 +67,8 @@ def main(argv=None):
     from .time_window import process_args as process_args_time_window
     from .output_config import add_args as add_args_output_config
     from .output_config import process_args as process_args_output_config
-    from .output_config import add_generic_args, process_generic_args
+    from .filter import add_args as add_args_filter
+    from .filter import process_args as process_args_filter
 
     parser = argparse.ArgumentParser(
         description="Convert rocPD to CSV files",
@@ -85,24 +88,23 @@ def main(argv=None):
     )
 
     valid_out_config_args = add_args_output_config(parser)
-    valid_generic_args = add_generic_args(parser)
+    valid_filter_args = add_args_filter(parser)
     valid_time_window_args = add_args_time_window(parser)
     valid_csv_args = add_args(parser)
 
     args = parser.parse_args(argv)
 
     out_cfg_args = process_args_output_config(args, valid_out_config_args)
-    generic_out_cfg_args = process_generic_args(args, valid_generic_args)
+    filter_args = process_args_filter(args, valid_filter_args)
     window_args = process_args_time_window(args, valid_time_window_args)
     csv_args = process_args(args, valid_csv_args)
 
     all_args = {
         **out_cfg_args,
-        **generic_out_cfg_args,
         **csv_args,
     }
 
-    execute(args.input, window_args=window_args, **all_args)
+    execute(args.input, window_args=window_args, filter_args=filter_args, **all_args)
 
 
 if __name__ == "__main__":