adding perfetto-validation-script (#66)

* adding perfetto-validation-script * Rename validation script * Update tests/validate_perfetto.py Co-authored-by: Jonathan R. Madsen <[email protected]> * Update tests/validate_perfetto.py Co-authored-by: Jonathan R. Madsen <[email protected]> * Update tests/validate_perfetto.py Co-authored-by: Jonathan R. Madsen <[email protected]> * Update tests/validate_perfetto.py Co-authored-by: Jonathan R. Madsen <[email protected]> * addressed the edits in the validation script * addressed the edits in the validation script * Perfetto validation script (#1) * Fixed mismatch message in validate-timemory-json * validate_perfetto.py -> validate-perfetto-proto.py * Add python-source-validate-perfetto - python-source-validate-perfetto uses validate-python-proto.py to validate perfetto output - renamed python-source-check test to python-source-validate timemory * Moved python-source-validate tests outside of cat command if block - these tests don't rely on OMNITRACE_CAT_COMMAND * CMake/CTest OMNITRACE_ADD_PYTHON_VALIDATION_TEST function - generalized function for performing validation test with validate-{timemory-json,perfetto-proto}.py scripts * Print perfetto validation * Install perfetto python package in workflows * cmake format * Python formatting * Python formatting CI * Install perfetto python package in workflows * Install dataclasses for perfetto in opensuse * Install dataclasses for perfetto in ubuntu - uninstalled dependency for perfetto in Python 3.6 Co-authored-by: Jonathan R. Madsen <[email protected]> Co-authored-by: Jonathan R. Madsen <[email protected]>
ROCm · Jun 24, 2022 · cfa16cb · cfa16cb
1 parent be7b03e
commit cfa16cb
Show file tree

Hide file tree

Showing 16 changed files with 250 additions and 58 deletions.
diff --git a/.cmake-format.yaml b/.cmake-format.yaml
@@ -84,6 +84,13 @@ parse:
         PASS_REGEX: '*'
         FAIL_REGEX: '*'
         SKIP_REGEX: '*'
+    omnitrace_add_python_validation_test:
+      kwargs:
+        NAME: '*'
+        ARGS: '*'
+        PERFETTO_FILE: '*'
+        TIMEMORY_FILE: '*'
+        TIMEMORY_METRIC: '*'
     rocm_version_message:
       flags:
         - STATUS

diff --git a/.github/workflows/formatting.yml b/.github/workflows/formatting.yml
@@ -10,6 +10,27 @@ on:
     branches: [ main, develop ]
 
 jobs:
+  python-formatting:
+    runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        python-version: [3.8]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install black
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: black format
+      run: |
+        black --diff --check .
+
   cmake-format:
     runs-on: ubuntu-20.04
 

diff --git a/.github/workflows/opensuse.yml b/.github/workflows/opensuse.yml
@@ -27,7 +27,7 @@ jobs:
     - name: Install Packages
       timeout-minutes: 5
       run:
-        for i in 6 7 8 9 10; do /opt/conda/envs/py3.${i}/bin/python -m pip install numpy; done
+        for i in 6 7 8 9 10; do /opt/conda/envs/py3.${i}/bin/python -m pip install numpy perfetto dataclasses; done
 
     - name: Configure Env
       run:

diff --git a/.github/workflows/ubuntu-bionic.yml b/.github/workflows/ubuntu-bionic.yml
@@ -46,8 +46,9 @@ jobs:
         apt-get install -y build-essential m4 autoconf libtool python3-pip ${{ matrix.compiler }} ${{ matrix.mpi }} &&
         python3 -m pip install --upgrade pip &&
         python3 -m pip install numpy &&
+        python3 -m pip install perfetto &&
         python3 -m pip install 'cmake==3.16.3' &&
-        for i in 6 7 8 9; do /opt/conda/envs/py3.${i}/bin/python -m pip install numpy; done
+        for i in 6 7 8 9; do /opt/conda/envs/py3.${i}/bin/python -m pip install numpy perfetto dataclasses; done
 
     - name: Install Kokkos
       timeout-minutes: 5

diff --git a/.github/workflows/ubuntu-focal-external-rocm.yml b/.github/workflows/ubuntu-focal-external-rocm.yml
@@ -37,7 +37,7 @@ jobs:
         apt-get install -y build-essential m4 autoconf libtool python3-pip clang libomp-dev ${{ matrix.compiler }} libudev-dev libnuma-dev rocm-dev rocm-utils roctracer-dev rocprofiler-dev hip-base hsa-amd-aqlprofile hsa-rocr-dev hsakmt-roct-dev libpapi-dev libopenmpi-dev curl &&
         python3 -m pip install --upgrade pip &&
         python3 -m pip install 'cmake==3.16.3' &&
-        for i in 6 7 8 9; do /opt/conda/envs/py3.${i}/bin/python -m pip install numpy; done
+        for i in 6 7 8 9; do /opt/conda/envs/py3.${i}/bin/python -m pip install numpy perfetto dataclasses; done
 
     - name: Configure Env
       run:

diff --git a/.github/workflows/ubuntu-focal-external.yml b/.github/workflows/ubuntu-focal-external.yml
@@ -65,8 +65,9 @@ jobs:
         apt-get install -y build-essential m4 autoconf libtool python3-pip libiberty-dev clang libomp-dev ${{ matrix.compiler }} &&
         python3 -m pip install --upgrade pip &&
         python3 -m pip install numpy &&
+        python3 -m pip install perfetto &&
         python3 -m pip install 'cmake==3.16.3' &&
-        for i in 6 7 8 9; do /opt/conda/envs/py3.${i}/bin/python -m pip install numpy; done
+        for i in 6 7 8 9; do /opt/conda/envs/py3.${i}/bin/python -m pip install numpy perfetto dataclasses; done
 
     - name: Configure Env
       run:

diff --git a/.github/workflows/ubuntu-focal.yml b/.github/workflows/ubuntu-focal.yml
@@ -30,6 +30,7 @@ jobs:
         sudo apt-get install -y build-essential m4 autoconf libtool python3-pip libtbb-dev libboost-{atomic,system,thread,date-time,filesystem,timer}-dev clang libomp-dev ${{ matrix.compiler }} ${{ matrix.mpi }} &&
         python3 -m pip install --upgrade pip &&
         python3 -m pip install numpy &&
+        python3 -m pip install perfetto &&
         python3 -m pip install 'cmake==3.16.3'
 
     - name: Configure Env

diff --git a/examples/python/builtin.py b/examples/python/builtin.py
@@ -37,12 +37,8 @@ def run(n):
     import argparse
 
     parser = argparse.ArgumentParser()
-    parser.add_argument(
-        "-n", "--num-iterations", help="Number", type=int, default=3
-    )
-    parser.add_argument(
-        "-v", "--value", help="Starting value", type=int, default=20
-    )
+    parser.add_argument("-n", "--num-iterations", help="Number", type=int, default=3)
+    parser.add_argument("-v", "--value", help="Starting value", type=int, default=20)
     args = parser.parse_args()
 
     _prefix = os.path.basename(__file__)

diff --git a/examples/python/external.py b/examples/python/external.py
@@ -36,12 +36,8 @@ def run(n):
     import argparse
 
     parser = argparse.ArgumentParser()
-    parser.add_argument(
-        "-n", "--num-iterations", help="Number", type=int, default=3
-    )
-    parser.add_argument(
-        "-v", "--value", help="Starting value", type=int, default=20
-    )
+    parser.add_argument("-n", "--num-iterations", help="Number", type=int, default=3)
+    parser.add_argument("-v", "--value", help="Starting value", type=int, default=20)
     args = parser.parse_args()
 
     _prefix = os.path.basename(__file__)

diff --git a/examples/python/source.py b/examples/python/source.py
@@ -58,12 +58,8 @@ def run(n):
     import argparse
 
     parser = argparse.ArgumentParser()
-    parser.add_argument(
-        "-n", "--num-iterations", help="Number", type=int, default=3
-    )
-    parser.add_argument(
-        "-v", "--value", help="Starting value", type=int, default=20
-    )
+    parser.add_argument("-n", "--num-iterations", help="Number", type=int, default=3)
+    parser.add_argument("-v", "--value", help="Starting value", type=int, default=20)
     args = parser.parse_args()
 
     _prefix = os.path.basename(__file__)

diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,31 @@
+[build-system]
+requires = [
+    "setuptools >= 40.0.4",
+    "setuptools_scm >= 2.0.0",
+    "wheel >= 0.29.0",
+]
+build-backend = 'setuptools.build_meta'
+
+[tool.black]
+line-length = 90
+target-version = ['py38']
+include = '\.py'
+exclude = '''
+(
+  /(
+      \.eggs
+    | \.git
+    | \.github
+    | \.tox
+    | \.venv
+    | \.misc
+    | \.vscode
+    | dist
+    | external
+    | .pytest_cache
+    | build
+    | build-release
+    | build-omnitrace
+  )/
+)
+'''
diff --git a/source/docs/conf.py b/source/docs/conf.py
@@ -110,26 +110,26 @@ def install(package):
 html_static_path = ["_static"]
 
 html_theme_options = {
-    'analytics_id': 'G-1HLBBRSTT9',  #  Provided by Google in your dashboard
-    'analytics_anonymize_ip': False,
-    'logo_only': False,
-    'display_version': True,
-    'prev_next_buttons_location': 'bottom',
-    'style_external_links': False,
-    'vcs_pageview_mode': '',
+    "analytics_id": "G-1HLBBRSTT9",  #  Provided by Google in your dashboard
+    "analytics_anonymize_ip": False,
+    "logo_only": False,
+    "display_version": True,
+    "prev_next_buttons_location": "bottom",
+    "style_external_links": False,
+    "vcs_pageview_mode": "",
     # 'style_nav_header_background': 'white',
     # Toc options
-    'collapse_navigation': True,
-    'sticky_navigation': True,
-    'navigation_depth': 4,
-    'includehidden': True,
-    'titles_only': False
+    "collapse_navigation": True,
+    "sticky_navigation": True,
+    "navigation_depth": 4,
+    "includehidden": True,
+    "titles_only": False,
 }
 
 # Breathe Configuration
 breathe_projects = {"omnitrace": "_doxygen/xml"}
 breathe_default_project = "omnitrace"
-breathe_default_members = ('members', )
+breathe_default_members = ("members",)
 breathe_projects_source = {
     "auto": (
         os.path.join(project_root, "source"),

diff --git a/source/python/omnitrace/profiler.py b/source/python/omnitrace/profiler.py
@@ -295,11 +295,7 @@ def __exit__(self, exec_type, exec_value, exec_tb):
 
         self.stop()
 
-        if (
-            exec_type is not None
-            and exec_value is not None
-            and exec_tb is not None
-        ):
+        if exec_type is not None and exec_value is not None and exec_tb is not None:
             import traceback
 
             traceback.print_exception(exec_type, exec_value, exec_tb, limit=5)
@@ -390,9 +386,5 @@ def __exit__(self, exec_type, exec_value, exec_tb):
 
         import traceback
 
-        if (
-            exec_type is not None
-            and exec_value is not None
-            and exec_tb is not None
-        ):
+        if exec_type is not None and exec_value is not None and exec_tb is not None:
             traceback.print_exception(exec_type, exec_value, exec_tb, limit=5)
diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt
@@ -964,24 +964,74 @@ foreach(_VERSION ${OMNITRACE_PYTHON_VERSIONS})
             PASS_REGEX "\\\[inefficient\\\]\\\[builtin.py:14\\\]"
             DEPENDS python-builtin-${_VERSION}
             ENVIRONMENT "${_python_environment}")
+    else()
+        omnitrace_message(
+            WARNING
+            "Neither 'cat' nor 'cmake -E cat' are available. Python source checks are disabled"
+            )
+    endif()
+
+    function(OMNITRACE_ADD_PYTHON_VALIDATION_TEST)
+        cmake_parse_arguments(TEST "" "NAME;TIMEMORY_METRIC;TIMEMORY_FILE;PERFETTO_FILE"
+                              "ARGS" ${ARGN})
 
         omnitrace_add_python_test(
-            NAME python-source-check
+            NAME ${TEST_NAME}-validate-timemory
             COMMAND
                 ${_PYTHON_EXECUTABLE} ${CMAKE_CURRENT_LIST_DIR}/validate-timemory-json.py
-                -l run fib fib fib fib fib inefficient _sum -c 5 5 10 20 30 10 5 5 -d 0 1
-                2 3 4 5 1 2 -m trip_count -i
+                -m ${TEST_TIMEMORY_METRIC} ${TEST_ARGS} -i
             PYTHON_VERSION ${_VERSION}
-            FILE omnitrace-tests-output/python-source/${_VERSION}/trip_count.json
-            DEPENDS python-source-${_VERSION}
+            FILE omnitrace-tests-output/${TEST_NAME}/${_VERSION}/${TEST_TIMEMORY_FILE}
+            DEPENDS ${TEST_NAME}-${_VERSION}
             PASS_REGEX
-                "omnitrace-tests-output/python-source/${_VERSION}/trip_count.json validated"
+                "omnitrace-tests-output/${TEST_NAME}/${_VERSION}/${TEST_TIMEMORY_FILE} validated"
             ENVIRONMENT "${_python_environment}")
-    else()
-        omnitrace_message(
-            WARNING
-            "Neither 'cat' nor 'cmake -E cat' are available. Python source checks are disabled"
-            )
-    endif()
+
+        omnitrace_add_python_test(
+            NAME ${TEST_NAME}-validate-perfetto
+            COMMAND
+                ${_PYTHON_EXECUTABLE} ${CMAKE_CURRENT_LIST_DIR}/validate-perfetto-proto.py
+                ${TEST_ARGS} -p -i
+            PYTHON_VERSION ${_VERSION}
+            FILE omnitrace-tests-output/${TEST_NAME}/${_VERSION}/${TEST_PERFETTO_FILE}
+            DEPENDS ${TEST_NAME}-${_VERSION}
+            PASS_REGEX
+                "omnitrace-tests-output/${TEST_NAME}/${_VERSION}/${TEST_PERFETTO_FILE} validated"
+            ENVIRONMENT "${_python_environment}")
+    endfunction()
+
+    omnitrace_add_python_validation_test(
+        NAME python-source
+        TIMEMORY_METRIC "trip_count"
+        TIMEMORY_FILE "trip_count.json"
+        PERFETTO_FILE "perfetto-trace.proto"
+        ARGS -l
+             run
+             fib
+             fib
+             fib
+             fib
+             fib
+             inefficient
+             _sum
+             -c
+             5
+             5
+             10
+             20
+             30
+             10
+             5
+             5
+             -d
+             0
+             1
+             2
+             3
+             4
+             5
+             1
+             2)
+
     math(EXPR _INDEX "${_INDEX} + 1")
 endforeach()