| |
| |
| <!DOCTYPE html> |
| <html class="writer-html5" lang="en" data-content_root="../"> |
| <head> |
| <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <title>Overview — ITT/JIT APIs Documentation documentation</title> |
| <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" /> |
| <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=9edc463e" /> |
| |
| |
| <link rel="canonical" href="https://intel.github.io/ittapi/src/overview.html" /> |
| <script src="../_static/jquery.js?v=5d32c60e"></script> |
| <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> |
| <script src="../_static/documentation_options.js?v=5929fcd5"></script> |
| <script src="../_static/doctools.js?v=fd6eb6e6"></script> |
| <script src="../_static/sphinx_highlight.js?v=6ffebe34"></script> |
| <script src="../_static/js/theme.js"></script> |
| <link rel="index" title="Index" href="../genindex.html" /> |
| <link rel="search" title="Search" href="../search.html" /> |
| <link rel="next" title="Build from Source Code" href="build.html" /> |
| <link rel="prev" title="The Intel® Instrumentation and Tracing Technology (ITT) and Just-In-Time (JIT) APIs" href="../index.html" /> |
| </head> |
| |
| <body class="wy-body-for-nav"> |
| <div class="wy-grid-for-nav"> |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-scroll"> |
| <div class="wy-side-nav-search" > |
| |
| |
| |
| <a href="../index.html" class="icon icon-home"> |
| ITT/JIT APIs Documentation |
| </a> |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> |
| <p class="caption" role="heading"><span class="caption-text">Contents:</span></p> |
| <ul class="current"> |
| <li class="toctree-l1 current"><a class="current reference internal" href="#">Overview</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="#components">Components</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="#architecture">Architecture</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="build.html">Build from Source Code</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="api-support.html">Use the ITT/JIT APIs</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="ref_collector.html">ITT API Reference Collector</a></li> |
| <li class="toctree-l1"><a class="reference external" href="https://github.com/intel/ittapi">GitHub Project</a></li> |
| </ul> |
| |
| </div> |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="../index.html">ITT/JIT APIs Documentation</a> |
| </nav> |
| |
| <div class="wy-nav-content"> |
| <div class="rst-content style-external-links"> |
| <div role="navigation" aria-label="Page navigation"> |
| <ul class="wy-breadcrumbs"> |
| <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li> |
| <li class="breadcrumb-item active">Overview</li> |
| <li class="wy-breadcrumbs-aside"> |
| <a href="../_sources/src/overview.rst.txt" rel="nofollow"> View page source</a> |
| </li> |
| </ul> |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <section id="overview"> |
| <span id="id1"></span><h1>Overview<a class="headerlink" href="#overview" title="Link to this heading"></a></h1> |
| <p>When you use Intel analyzer tools to improve the performance of your software |
| application, during execution, use the Intel® Instrumentation and Tracing |
| Technology (ITT) and Just-In-Time (JIT) APIs to instrument your code to generate |
| trace data and control its collection. You use the ITT/JIT APIs to identify and |
| measure specific areas of code to get insights into performance bottlenecks and |
| resource utilization.</p> |
| <section id="components"> |
| <h2>Components<a class="headerlink" href="#components" title="Link to this heading"></a></h2> |
| <ul class="simple"> |
| <li><p><strong>ITT API</strong>: Powers your application to generate and control the collection |
| of trace data during its execution, seamlessly integrating with Intel tools.</p></li> |
| <li><p><strong>JIT API</strong>: Reports detailed information about just-in-time (JIT) compiled |
| code, enabling you to profile the performance of dynamically generated code.</p></li> |
| </ul> |
| </section> |
| <section id="architecture"> |
| <h2>Architecture<a class="headerlink" href="#architecture" title="Link to this heading"></a></h2> |
| <p>The ITT/JIT APIs consist of two parts:</p> |
| <ul class="simple"> |
| <li><p><strong>Static Part</strong>: An open-source static library |
| (<a class="reference external" href="https://github.com/intel/ittapi">ittapi</a>) that you compile and link |
| with your application to enable tracing features.</p></li> |
| <li><p><strong>Dynamic Part</strong>: A tool-specific shared library that collects and writes |
| trace data. You can find the reference implementation of the dynamic part |
| as a <em>Reference Collector</em> <a class="reference external" href="ref_collector.html">here</a>.</p></li> |
| </ul> |
| </section> |
| </section> |
| |
| |
| </div> |
| </div> |
| <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> |
| <a href="../index.html" class="btn btn-neutral float-left" title="The Intel® Instrumentation and Tracing Technology (ITT) and Just-In-Time (JIT) APIs" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |
| <a href="build.html" class="btn btn-neutral float-right" title="Build from Source Code" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> |
| </div> |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p>© Copyright 2026 Intel Corporation.</p> |
| </div> |
| |
| Built with <a href="https://www.sphinx-doc.org/">Sphinx</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>. |
| |
| |
| </footer> |
| </div> |
| </div> |
| </section> |
| </div> |
| <script> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| </body> |
| </html> |