misc: Update advisor notebook

Author: George Bisbas

benchmarks/user/advisor/roofline.py

@@ -171,8 +171,8 @@ def roofline(name, project, scale, precision, mode, th):
             label_x = row.self_ai + (row.self_ai + ai_max - 2 * ai_min) * (2**0.005 - 1)
             label_y = row.self_gflops
             ax.text(label_x, label_y,
-                    'Time: %.2fs\n'
-                    'Peak pct: %.0f%%' % (row.self_time, row.percent_weight),
+                    f'Time: {row.self_time:.2f}s\n'
+                    f'Incidence: {row.percent_weight:.0f}%',
                     bbox={'boxstyle': 'round', 'facecolor': 'white'}, fontsize=8)
         top_loops_data = [{'ai': row.self_ai,
                            'gflops': row.self_gflops,
@@ -213,5 +213,6 @@ def roofline(name, project, scale, precision, mode, th):
     log('\nJSON file saved as %s.json.' % name)
     log('Done!')
 
+
 if __name__ == '__main__':
     roofline()

benchmarks/user/advisor/run_advisor.py

@@ -28,37 +28,40 @@
                                    'in --exec-args (if any).')
 def run_with_advisor(path, output, name, exec_args):
     path = Path(path)
-    check(path.is_file(), '%s not found' % path)
-    check(path.suffix == '.py', '%s not a Python file' % path)
+    check(path.is_file(), f'{path} not found')
+    check(path.suffix == '.py', f'{path} not a Python file')
 
     # Create a directory to store the profiling report
     if name is None:
         name = path.stem
         if exec_args:
-            name = "%s_%s" % (name, ''.join(exec_args.split()))
+            name = f"{name}_{''.join(exec_args.split())}"
     if output is None:
         output = Path(gettempdir()).joinpath('devito-profilings')
         output.mkdir(parents=True, exist_ok=True)
     else:
         output = Path(output)
     if name is None:
-        output = Path(mkdtemp(dir=str(output), prefix="%s-" % name))
+        output = Path(mkdtemp(dir=str(output), prefix=f"{name}-"))
     else:
         output = Path(output).joinpath(name)
         output.mkdir(parents=True, exist_ok=True)
 
-    # Intel Advisor and Intel compilers must be available through either
-    # Intel oneAPI (tested with Intel oneAPI 2025.1)
+    # advixe-cl and icx should be available through Intel oneAPI
+    # (tested with Intel oneAPI 2025.1)
     try:
         ret = check_output(['advixe-cl', '--version']).decode("utf-8")
+        log(f"Found advixe-cl version: {ret.strip()}\n")
     except FileNotFoundError:
-        check(False, "Error: Couldn't detect `advixe-cl` to run Intel Advisor.")
+        check(False, "Error: Couldn't detect `advixe-cl` to run Intel Advisor."
+              " Please source the Advisor environment.")
 
     try:
         ret = check_output(['icx', '--version']).decode("utf-8")
-        log("Found icx version: %s" % ret.strip())
+        log(f"Found icx version: {ret.strip()}\n")
     except FileNotFoundError:
-        check(False, "Error: Couldn't detect Intel Compiler (icx).")
+        check(False, "Error: Couldn't detect Intel Compiler (icx)."
+              " Please source the Intel oneAPI compilers.")
 
     # All good, Intel compiler and advisor are available
     os.environ['DEVITO_ARCH'] = 'icx'
@@ -82,7 +85,6 @@ def run_with_advisor(path, output, name, exec_args):
             ret = check_output(['numactl', '--show']).decode("utf-8")
             ret = dict(i.split(':') for i in ret.split('\n') if i)
             n_sockets = len(ret['cpubind'].split())
-            n_cores = len(ret['physcpubind'].split())  # noqa
         except FileNotFoundError:
             check(False, "Couldn't detect `numactl`, necessary for thread pinning.")
 
@@ -145,9 +147,9 @@ def run_with_advisor(path, output, name, exec_args):
     advixe_handler.setFormatter(advixe_formatter)
     advixe_logger.addHandler(advixe_handler)
 
-    log("Project folder: %s" % str(output))
-    log("Logging progress in: `%s`" % str(advixe_handler))
-    
+    log(f"Project folder: {output}")
+    log(f"Logging progress in: `{advixe_handler.baseFilename}`")
+
     with progress('Performing `cache warm-up` run'):
         try:
             p_warm_up = Popen(py_cmd, stdout=PIPE, stderr=PIPE)
@@ -171,13 +173,13 @@ def run_with_advisor(path, output, name, exec_args):
         except OSError:
             check(False, 'Failed!')
 
-    log('Storing `survey` and `tripcounts` data in `%s`' % str(output))
+    log(f'Storing `survey` and `tripcounts` data in `{output}`')
     log('To plot a roofline type: ')
-    log('python3 roofline.py --name %s --project %s --scale %f'
-        % (name, str(output), n_sockets))
+    log(f'python3 roofline.py --name {name} --project {output} --scale {n_sockets}')
 
     log('\nTo open the roofline using advixe-gui: ')
-    log('advixe-gui %s' % str(output))
+    log(f'advixe-gui {output}')
+
 
 if __name__ == '__main__':
     run_with_advisor()

devito/arch/archinfo.py

@@ -2,6 +2,7 @@
 
 from functools import cached_property
 from subprocess import PIPE, Popen, DEVNULL, run
+from pathlib import Path
 import ctypes
 import re
 import os
@@ -17,8 +18,8 @@
 
 __all__ = ['platform_registry', 'get_cpu_info', 'get_gpu_info', 'get_nvidia_cc',
            'get_cuda_path', 'get_hip_path', 'check_cuda_runtime', 'get_m1_llvm_path',
-           'Platform', 'Cpu64', 'Intel64', 'IntelSkylake', 'Amd', 'Arm', 'Power',
-           'Device', 'NvidiaDevice', 'AmdDevice', 'IntelDevice',
+           'get_advisor_path', 'Platform', 'Cpu64', 'Intel64', 'IntelSkylake', 'Amd',
+           'Arm', 'Power', 'Device', 'NvidiaDevice', 'AmdDevice', 'IntelDevice',
            # Brand-agnostic
            'ANYCPU', 'ANYGPU',
            # Intel CPUs
@@ -464,6 +465,27 @@ def get_cuda_path():
     return None
 
 
+def get_advisor_path():
+    """
+    Detect if Intel Advisor is installed on the machine and return
+    its location if it is.
+    """
+    path = None
+
+    env_path = os.environ["PATH"]
+    env_path_dirs = env_path.split(":")
+
+    for env_path_dir in env_path_dirs:
+        # intel/oneapi/advisor is the directory for Intel oneAPI
+        if "intel/advisor" in env_path_dir or "intel/oneapi/advisor" in env_path_dir:
+            path = Path(env_path_dir)
+            if path.name.startswith('bin'):
+                path = path.parent
+                return path
+
+    return path
+
+
 @memoized_func
 def get_hip_path():
     # *** First try: via commonly used environment variables

devito/arch/compiler.py

@@ -14,8 +14,8 @@
                               call_capture_output as _call_capture_output)
 
 from devito.arch import (AMDGPUX, Cpu64, AppleArm, NvidiaDevice, POWER8, POWER9,
-                         Graviton, Cortex, IntelDevice, get_nvidia_cc, NvidiaArm,
-                         check_cuda_runtime, get_m1_llvm_path)
+                         Graviton, Cortex, IntelDevice, get_nvidia_cc,
+                         check_cuda_runtime, get_m1_llvm_path, get_advisor_path)
 from devito.exceptions import CompilationError
 from devito.logger import debug, warning
 from devito.parameters import configuration
@@ -771,17 +771,15 @@ def __init_finalize__(self, **kwargs):
 
         if configuration['profiling'] == 'advisor':
             # Locate the Intel Advisor installation and
-            # add the necessary flags to the compiler
-            from devito.operator.profiling import locate_intel_advisor
-            path = locate_intel_advisor()
+            # add the necessary paths and flags to the compiler
+            path = get_advisor_path()
             self.add_include_dirs(path.joinpath('include').as_posix())
 
             _default_libs = ['ittnotify']
             self.add_libraries(_default_libs)
 
             libdir = path.joinpath('lib64').as_posix()
-            self.add_library_dirs(libdir)
-            self.add_ldflags('-Wl,-rpath,%s' % libdir)
+            self.add_library_dirs(libdir, rpath=True)
 
     def __init_intel_mpi__(self, **kwargs):
         # Make sure the MPI compiler uses an Intel compiler underneath,

devito/operator/profiling.py

@@ -2,10 +2,7 @@
 from contextlib import contextmanager
 from functools import reduce
 from operator import mul
-from pathlib import Path
-from subprocess import DEVNULL, PIPE, run
 from time import time as seq_time
-import os
 
 import cgen as c
 import numpy as np
@@ -14,7 +11,7 @@
 from devito.ir.iet import (ExpressionBundle, List, TimedList, Section,
                            Iteration, FindNodes, Transformer)
 from devito.ir.support import IntervalGroup
-from devito.logger import warning, error
+from devito.logger import warning
 from devito.mpi import MPI
 from devito.parameters import configuration
 from devito.symbolics import subs_op_args
@@ -367,12 +364,7 @@ class AdvisorProfiler(AdvancedProfiler):
     _ext_calls = [_api_resume, _api_pause]
 
     def __init__(self, name):
-        path = locate_intel_advisor()
-        if path is None:
-            self.initialized = False
-        else:
-            super(AdvisorProfiler, self).__init__(name)
-
+        super(AdvisorProfiler, self).__init__(name)
         return
 
     def analyze(self, iet):
@@ -525,55 +517,3 @@ def create_profile(name):
     'advisor': AdvisorProfiler
 }
 """Profiling levels."""
-
-
-def locate_intel_advisor():
-    """
-    Detect if Intel Advisor is installed on the machine and return
-    its location if it is.
-
-    """
-    path = None
-
-    try:
-        # Check if the directory to Intel Advisor is specified
-        path = Path(os.environ['DEVITO_ADVISOR_DIR'])
-    except KeyError:
-        # Otherwise, 'sniff' the location of Advisor's directory
-        error_msg = 'Intel Advisor cannot be found on your system, consider if you'\
-                    ' have sourced its environment variables correctly. Information can'\
-                    ' be found at https://software.intel.com/content/www/us/en/develop/'\
-                    'documentation/advisor-user-guide/top/launch-the-intel-advisor/'\
-                    'intel-advisor-cli/setting-and-using-intel-advisor-environment'\
-                    '-variables.html'
-        try:
-            res = run(["advixe-cl", "--version"], stdout=PIPE, stderr=DEVNULL)
-            ver = res.stdout.decode("utf-8")
-            if not ver:
-                error(error_msg)
-                return None
-        except (UnicodeDecodeError, FileNotFoundError):
-            error(error_msg)
-            return None
-
-        env_path = os.environ["PATH"]
-        env_path_dirs = env_path.split(":")
-
-        for env_path_dir in env_path_dirs:
-            # intel/advisor is the advisor directory for Intel Parallel Studio,
-            # intel/oneapi/advisor is the directory for Intel oneAPI
-            if "intel/advisor" in env_path_dir or "intel/oneapi/advisor" in env_path_dir:
-                path = Path(env_path_dir)
-                if path.name.startswith('bin'):
-                    path = path.parent
-
-        if not path:
-            error(error_msg)
-            return None
-
-    if path.joinpath('bin64').joinpath('advixe-cl').is_file():
-        return path
-    else:
-        warning("Requested `advisor` profiler, but couldn't locate executable"
-                "in advisor directory")
-        return None

examples/performance/02_advisor_roofline.ipynb

@@ -81,21 +81,25 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
+      "\u001b[1;37;32mFound advixe-cl version: Intel(R) Advisor 2025.0.0 (build 615865) Command Line Tool\n",
+      "Copyright (C) 2009-2025 Intel Corporation. All rights reserved.\n",
+      "\u001b[0m\n",
       "\u001b[1;37;32mFound icx version: Intel(R) oneAPI DPC++/C++ Compiler 2025.0.4 (2025.0.4.20241205)\n",
       "Target: x86_64-unknown-linux-gnu\n",
       "Thread model: posix\n",
       "InstalledDir: /opt/intel/oneapi/compiler/2025.0/bin/compiler\n",
-      "Configuration file: /opt/intel/oneapi/compiler/2025.0/bin/compiler/../icx.cfg\u001b[0m\n",
+      "Configuration file: /opt/intel/oneapi/compiler/2025.0/bin/compiler/../icx.cfg\n",
+      "\u001b[0m\n",
       "\u001b[1;37;32mSetting up multi-threading environment with OpenMP ... \u001b[0m\u001b[1;37;32mDone!\u001b[0m\n",
       "\u001b[1;37;32mStarting Intel Advisor's `roofline` analysis for `JupyterProfiling`\u001b[0m\n",
       "\u001b[1;37;32mProject folder: /home/gb4018/workspace/devitocodes/devito/examples/performance/profilings/JupyterProfiling\u001b[0m\n",
-      "\u001b[1;37;32mLogging progress in: `<FileHandler /home/gb4018/workspace/devitocodes/devito/examples/performance/profilings/JupyterProfiling/JupyterProfiling_2025.2.10.20.10.45.log (NOTSET)>`\u001b[0m\n",
+      "\u001b[1;37;32mLogging progress in: `/home/gb4018/workspace/devitocodes/devito/examples/performance/profilings/JupyterProfiling/JupyterProfiling_2025.2.11.17.2.29.log`\u001b[0m\n",
       "\u001b[1;37;32mPerforming `cache warm-up` run ... \u001b[0m\u001b[1;37;32mDone!\u001b[0m\n",
       "\u001b[1;37;32mPerforming `survey` analysis ... \u001b[0m\u001b[1;37;32mDone!\u001b[0m\n",
       "\u001b[1;37;32mPerforming `tripcounts` analysis ... \u001b[0m\u001b[1;37;32mDone!\u001b[0m\n",
       "\u001b[1;37;32mStoring `survey` and `tripcounts` data in `/home/gb4018/workspace/devitocodes/devito/examples/performance/profilings/JupyterProfiling`\u001b[0m\n",
       "\u001b[1;37;32mTo plot a roofline type: \u001b[0m\n",
-      "\u001b[1;37;32mpython3 roofline.py --name JupyterProfiling --project /home/gb4018/workspace/devitocodes/devito/examples/performance/profilings/JupyterProfiling --scale 1.000000\u001b[0m\n",
+      "\u001b[1;37;32mpython3 roofline.py --name JupyterProfiling --project /home/gb4018/workspace/devitocodes/devito/examples/performance/profilings/JupyterProfiling --scale 1\u001b[0m\n",
       "\u001b[1;37;32m\n",
       "To open the roofline using advixe-gui: \u001b[0m\n",
       "\u001b[1;37;32madvixe-gui /home/gb4018/workspace/devitocodes/devito/examples/performance/profilings/JupyterProfiling\u001b[0m\n"

tests/test_benchmark.py

@@ -3,7 +3,7 @@
 import sys
 
 from benchmarks.user.benchmark import run
-from devito import configuration, switchconfig
+from devito import configuration, switchconfig, Grid, TimeFunction, Eq, Operator
 from conftest import skipif
 from subprocess import check_call
 
@@ -87,3 +87,16 @@ def test_run_mpi(mode):
         'dump_norms': 'norms.txt'
     }
     run('acoustic', **kwargs)
+
+
+@switchconfig(profiling='advisor')
+def test_advisor_profiling():
+    grid = Grid(shape=(10, 10, 10))
+
+    f = TimeFunction(name='f', grid=grid, space_order=2)
+
+    eq0 = [Eq(f.forward, f.dx + 1.)]
+
+    # Only check codegen, do not run
+    op = Operator(eq0)
+    assert 'ittnotify.h' in op._includes