Deployed ad9e12c with MkDocs version: 1.5.3

UO-OACISS · Feb 7, 2024 · 67a1eaa · 67a1eaa
1 parent bf0b2f0
commit 67a1eaa
Show file tree

Hide file tree

Showing 17 changed files with 468 additions and 245 deletions.
diff --git a/404.html b/404.html
@@ -103,7 +103,7 @@ <h1 id="404-page-not-found">404</h1>
 
   <div role="contentinfo">
     <!-- Copyright etc -->
-      <p>(C) 2014-2023 University of Oregon, All Rights Reserved</p>
+      <p>(C) 2014-2024 University of Oregon, All Rights Reserved</p>
   </div>
 
   Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.

diff --git a/environment/index.html b/environment/index.html
@@ -115,7 +115,8 @@ <h2 id="environment_variables">Environment Variables<a class="headerlink" href="
 APEX_VARIABLE2=value
 ...
 </code></pre>
-<p>To generate a default APEX configuration file in the current working directory, run the <code>./install/bin/apex_make_default_config</code> program.</p>
+<p>To generate a default APEX configuration file in the current working directory, run the <code>./install/bin/apex_make_default_config</code> program.
+To get a list of all known environment variables, run the <code>./install/bin/apex_environment_help</code> program.</p>
 <table>
 <thead>
 <tr>
@@ -410,39 +411,72 @@ <h2 id="apex_exec_flags"><code>apex_exec</code> flags<a class="headerlink" href=
 apex_exec &lt;APEX options&gt; executable &lt;executable options&gt;
 
 where APEX options are zero or more of:
-    --apex:help            show this usage message
-    --apex:debug           run with APEX in debugger
-    --apex:verbose         enable verbose list of APEX environment variables
-    --apex:screen          enable screen text output (on by default)
-    --apex:quiet           disable screen text output
-    --apex:csv             enable csv text output
-    --apex:tau             enable tau profile output
-    --apex:taskgraph       enable taskgraph output
-                           (graphviz required for post-processing)
-    --apex:otf2            enable OTF2 trace output
-    --apex:otf2path        specify location of OTF2 archive
-                           (default: ./OTF2_archive)
-    --apex:otf2name        specify name of OTF2 file (default: APEX)
-    --apex:gtrace          enable Google Trace Events output
-    --apex:scatter         enable scatterplot output
-                           (python required for post-processing)
-    --apex:openacc         enable OpenACC support
-    --apex:kokkos          enable Kokkos support
-    --apex:raja            enable RAJA support
-    --apex:pthread         enable pthread wrapper support
-    --apex:untied          enable tasks to migrate cores/OS threads
-                           during execution (not compatible with trace output)
-    --apex:cuda_counters   enable CUDA/CUPTI counter support
-    --apex:cuda_driver     enable CUDA driver API callbacks
-    --apex:cuda_details    enable per-kernel statistics where available
-    --apex:cpuinfo         enable sampling of /proc/cpuinfo (Linux only)
-    --apex:meminfo         enable sampling of /proc/meminfo (Linux only)
-    --apex:net             enable sampling of /proc/net/dev (Linux only)
-    --apex:status          enable sampling of /proc/self/status (Linux only)
-    --apex:io              enable sampling of /proc/self/io (Linux only)
-    --apex:period          specify frequency of OS/HW sampling
-    --apex:ompt_simple     only enable OpenMP Tools required events
-    --apex:ompt_details    enable all OpenMP Tools events
+    --apex:help                   show this usage message
+    --apex:debug                  run with APEX in debugger
+    --apex:verbose                enable verbose list of APEX environment variables
+    --apex:screen                 enable screen text output (on by default)
+    --apex:screen-detail          enable detailed text output (off by default)
+    --apex:quiet                  disable screen text output
+    --apex:final-output-only      only output performance data at exit (ignore intermediate dump calls)
+    --apex:csv                    enable csv text output
+    --apex:tau                    enable tau profile output
+    --apex:taskgraph              enable taskgraph output
+                                  (graphviz required for post-processing)
+    --apex:tasktree               enable tasktree output
+                                  (python3 with Pandas required for post-processing)
+    --apex:hatchet                enable Hatchet tasktree output
+                                  (python3 with Hatchet required for post-processing)
+    --apex:concur                 Periodically sample thread activity (default: off)
+    --apex:concur-max             Max timers to track with concurrency activity (default: 5)
+    --apex:concur-period &lt;value&gt;  Frequency of concurrency sampling, in microseconds
+                                  (default: 1000000)
+    --apex:throttle               throttle short-lived timers to reduce overhead (default: off)
+    --apex:throttle-calls &lt;value&gt; minimum number of calls before throttling (default: 1000)
+    --apex:throttle-per &lt;value&gt;   minimum timer duration in microseconds (default: 10)
+    --apex:otf2                   enable OTF2 trace output (requries --apex:mpi with MPI configurations)
+    --apex:otf2path &lt;value&gt;       specify location of OTF2 archive
+                                  (default: ./OTF2_archive)
+    --apex:otf2name &lt;value&gt;       specify name of OTF2 file (default: APEX)
+    --apex:gtrace                 enable Google Trace Events output (deprecated)
+    --apex:pftrace                enable Perfetto Trace output
+    --apex:scatter                enable scatterplot output
+                                  (python required for post-processing)
+    --apex:openacc                enable OpenACC support
+    --apex:kokkos                 enable Kokkos support
+    --apex:kokkos-tuning          enable Kokkos runtime autotuning support
+    --apex:kokkos-fence           enable Kokkos fences for async kernels
+    --apex:raja                   enable RAJA support
+    --apex:pthread                enable pthread wrapper support
+    --apex:gpu-memory             enable GPU memory wrapper support
+    --apex:cpu-memory             enable CPU memory wrapper support
+    --apex:untied                 enable tasks to migrate cores/OS threads
+                                  during execution (not compatible with trace output)
+    --apex:cuda                   enable CUDA/CUPTI measurement (default: off)
+    --apex:cuda-counters          enable CUDA/CUPTI counter support (default: off)
+    --apex:cuda-driver            enable CUDA driver API callbacks (default: off)
+    --apex:cuda-details           enable per-kernel statistics where available (default: off)
+    --apex:hip                    enable HIP/ROCTracer measurement (default: off)
+    --apex:hip-metrics            enable HIP/ROCProfiler metric support (default: off)
+    --apex:hip-counters           enable HIP/ROCTracer counter support (default: off)
+    --apex:hip-driver             enable HIP/ROCTracer KSA driver API callbacks (default: off)
+    --apex:hip-details            enable per-kernel statistics where available (default: off)
+    --apex:monitor-gpu            enable GPU monitoring services (CUDA NVML, ROCm SMI)
+    --apex:level0                 enable OneAPI Level0 measurement (default: off)
+    --apex:cpuinfo                enable sampling of /proc/cpuinfo (Linux only)
+    --apex:meminfo                enable sampling of /proc/meminfo (Linux only)
+    --apex:net                    enable sampling of /proc/net/dev (Linux only)
+    --apex:status                 enable sampling of /proc/self/status (Linux only)
+    --apex:io                     enable sampling of /proc/self/io (Linux only)
+    --apex:period &lt;value&gt;         specify frequency of OS/HW sampling
+    --apex:mpi                    enable MPI profiling (required for OTF2 support with MPI configurations)
+    --apex:ompt                   enable OpenMP profiling (requires runtime support)
+    --apex:ompt-simple            only enable OpenMP Tools required events
+    --apex:ompt-details           enable all OpenMP Tools events
+    --apex:source                 resolve function, file and line info for address lookups with binutils
+                                  (default: function only)
+    --apex:preload &lt;lib&gt;          extra libraries to load with LD_PRELOAD _before_ APEX libraries
+                                  (LD_PRELOAD value is added _after_ APEX libraries)
+    --apex:postprocess            run post-process scripts (graphviz, python) on output data after exit
 </code></pre>
 
             </div>
@@ -456,7 +490,7 @@ <h2 id="apex_exec_flags"><code>apex_exec</code> flags<a class="headerlink" href=
 
   <div role="contentinfo">
     <!-- Copyright etc -->
-      <p>(C) 2014-2023 University of Oregon, All Rights Reserved</p>
+      <p>(C) 2014-2024 University of Oregon, All Rights Reserved</p>
   </div>
 
   Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.

diff --git a/examples/index.html b/examples/index.html
@@ -121,7 +121,7 @@ <h1 id="mpi_applications">MPI applications<a class="headerlink" href="#mpi_appli
 
   <div role="contentinfo">
     <!-- Copyright etc -->
-      <p>(C) 2014-2023 University of Oregon, All Rights Reserved</p>
+      <p>(C) 2014-2024 University of Oregon, All Rights Reserved</p>
   </div>
 
   Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.

diff --git a/feature/index.html b/feature/index.html
@@ -186,14 +186,20 @@ <h2 id="supported_parallel_models">Supported Parallel Models<a class="headerlink
 <li><strong>Kokkos</strong> - Using the Kokkos profiling interface, APEX can capture performance data related to Kokkos parallel abstractions.</li>
 <li><strong>RAJA</strong> - Using the RAJA profiling interface, APEX can capture performance data related to RAJA parallel abstractions.  Unlike Kokkos, RAJA doesn't give any details, so don't expect much.</li>
 <li><strong>CUDA</strong> - Using the NVIDIA CUPTI and NVML libraries, APEX can capture runtime and driver API calls as well as memory transfers and kernels executed on a device, and monitor GPU utilization.</li>
-<li><strong>Distributed Execution over MPI</strong> - While APEX doesn't measure MPI function calls, it is "MPI-aware", and can detect when used in a distributed run so that each process can write separate or aggregated performance data.</li>
+<li><strong>HIP</strong> - Using the AMD Roctracer, Rocprofiler and ROCM-SMI libraries, APEX can capture runtime and driver API calls as well as memory transfers and kernels executed on a device, and monitor GPU utilization.</li>
+<li><strong>Intel SYCL</strong> - Using the Intel Level0 libraries, APEX can capture runtime and driver API calls as well as memory transfers and kernels executed on a device, and monitor GPU utilization.</li>
+<li><strong>PhiProf</strong> - APEX is integrated with support to intercept PhiProf profiling data. See <a href="https://github.com/fmihpc/phiprof">https://github.com/fmihpc/phiprof</a>.</li>
+<li><strong>StarPU</strong> - APEX is integrated with support to profile StarPU. See <a href="https://starpu.gitlabpages.inria.fr">https://starpu.gitlabpages.inria.fr</a>.</li>
+<li><strong>Distributed Execution over MPI</strong> - While APEX doesn't measure all MPI function calls, it is "MPI-aware", and can detect when used in a distributed run so that each process can write separate or aggregated performance data. APEX provides rudimentary support for measuring point-to-point and collectives.</li>
 </ul>
 <h2 id="parallel_models_with_experimental_support_in_development_wish_list">Parallel Models with Experimental Support / In Development / Wish List<a class="headerlink" href="#parallel_models_with_experimental_support_in_development_wish_list" title="Permanent link">&para;</a></h2>
 <ul>
 <li><strong>Argobots</strong> - APEX has been used to instrument services based on Argobots, but it is not integrated into the runtime.</li>
 <li><strong>TBB</strong> - The APEX team is evaluating integrated TBB support.</li>
-<li><strong>Legion</strong> - No plans at this time, but open to exploring it.</li>
+<li><strong>Legion</strong> - No plans at this time.</li>
 <li><strong>Charm++</strong> - No plans at this time.</li>
+<li><strong>Iris</strong> - Plans are afoot. Stay tuned.</li>
+<li><strong>YAKL</strong> - Plans are afoot. Stay tuned.</li>
 </ul>
 <h2 id="introspection">Introspection<a class="headerlink" href="#introspection" title="Permanent link">&para;</a></h2>
 <p>APEX collects data through <em>inspectors</em>. The synchronous data collection uses an event API and event <em>listeners</em>. The API includes events for:</p>
@@ -257,7 +263,7 @@ <h3 id="concurrency_tracking">Concurrency Tracking<a class="headerlink" href="#c
 <h3 id="otf2_tracing">OTF2 Tracing<a class="headerlink" href="#otf2_tracing" title="Permanent link">&para;</a></h3>
 <p>The <strong>OTF2 listener</strong> will construct a full event trace and write the events out to an <a href="https://www.vi-hps.org/projects/score-p/">OTF2</a> archive.  OTF2 files can be visualized with tools like <a href="https://tu-dresden.de/zih/forschung/projekte/vampir/index?set_language=en">Vampir</a> or <a href="https://github.com/hdc-arizona/traveler-integrated">Traveler</a>.  Due to the constraints of OTF2 trace collection, tasks that start on one OS thread and end on another OS thread are not supported.  Similarly, tasks/functions that are not perfectly nested are not supported by OTF2 tracing.  For those types of tasks, we recommend the Trace Event listener.</p>
 <h3 id="google_trace_event_listener">Google Trace Event Listener<a class="headerlink" href="#google_trace_event_listener" title="Permanent link">&para;</a></h3>
-<p>The <strong>Trace Event listener</strong> will construct a full event trace and write the events to one or more <a href="https://docs.google.com/document/d/1CvAClvFfyA5R-PhYUmn5OOQtYMH4h6I0nSsKchNAySU/edit#">Google Trace Event</a> trace files.  The files can be visualized with the Google Chrome web browser, by navigating to the <code>chrome://tracing</code> URL.  Other tools can be used to visualize or analyze traces, like <a href="https://chromium.googlesource.com/catapult">Catapult</a>.</p>
+<p>The <strong>Trace Event listener</strong> will construct a full event trace and write the events to one or more <a href="https://docs.google.com/document/d/1CvAClvFfyA5R-PhYUmn5OOQtYMH4h6I0nSsKchNAySU/edit#">Google Trace Event</a> trace files.  The files can be visualized with the Google Chrome web browser, by navigating to the <a href="https://ui.perfetto.dev">https://ui.perfetto.dev</a> URL. <!-- Other tools can be used to visualize or analyze traces, like <a href="https://chromium.googlesource.com/catapult">Catapult</a>. --></p>
 <h2 id="policy_listener">Policy Listener<a class="headerlink" href="#policy_listener" title="Permanent link">&para;</a></h2>
 <p>Policies are rules that decide on outcomes based on observed state.
 Triggered policies are invoked by introspection API events.
@@ -282,7 +288,7 @@ <h2 id="policy_listener">Policy Listener<a class="headerlink" href="#policy_list
 
   <div role="contentinfo">
     <!-- Copyright etc -->
-      <p>(C) 2014-2023 University of Oregon, All Rights Reserved</p>
+      <p>(C) 2014-2024 University of Oregon, All Rights Reserved</p>
   </div>
 
   Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.

diff --git a/hpx5/index.html b/hpx5/index.html
@@ -337,7 +337,7 @@ <h3 id="building_hpx-5_applications_with_apex">Building HPX-5 applications with
 
   <div role="contentinfo">
     <!-- Copyright etc -->
-      <p>(C) 2014-2023 University of Oregon, All Rights Reserved</p>
+      <p>(C) 2014-2024 University of Oregon, All Rights Reserved</p>
   </div>
 
   Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.