Google Git
Sign in
chromium / external / github.com / intel / ittapi / refs/heads/gh-pages / . / src / ittapi / metadata-api.html
blob: 6ca239639b194eae1b18d88d4c348d28100b0150 [file] [log] [blame] [edit]
<!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>Metadata API &mdash; 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=e59714d7" />
<link rel="canonical" href="https://intel.github.io/ittapi/src/ittapi/metadata-api.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=9bcbadda"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></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="Relation API" href="relation-api.html" />
<link rel="prev" title="Memory Allocation APIs" href="memory-allocation-apis.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"><a class="reference internal" href="../overview.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../build.html">Build from Source Code</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../api-support.html">Use the ITT/JIT APIs</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="../api-support.html#c-c-api-usage-and-reference">C/C++ API Usage and Reference:</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="../itt-api-support.html">Instrumentation and Tracing Technology (ITT) API</a><ul class="current">
<li class="toctree-l4 current"><a class="reference internal" href="../itt-api-support.html#itt-api-usage-and-reference">ITT API Usage and Reference</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../jit-api-support.html">Just-In-Time (JIT) API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../api-support.html#other-language-api-bindings">Other Language API Bindings:</a></li>
</ul>
</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"><a href="../api-support.html">Use the ITT/JIT APIs</a></li>
<li class="breadcrumb-item"><a href="../itt-api-support.html">Instrumentation and Tracing Technology (ITT) API</a></li>
<li class="breadcrumb-item"><a href="../itt-api-reference.html">ITT API Reference</a></li>
<li class="breadcrumb-item active">Metadata API</li>
<li class="wy-breadcrumbs-aside">
<a href="../../_sources/src/ittapi/metadata-api.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="metadata-api">
<span id="id1"></span><h1>Metadata API<a class="headerlink" href="#metadata-api" title="Link to this heading"></a></h1>
<p>Metadata is additional information or generic data that can be attached to a
task, a thread, a process, etc. Metadata has a type, name, and value.
The value encoding depends on the metadata type. The encoding may contain
either string data or a number of integer or floating point values.</p>
<p>To create metadata, use the following primitives:</p>
<div class="highlight-cpp notranslate"><div class="highlight"><pre><span></span><span class="kt">void</span><span class="w"> </span><span class="nf">__itt_metadata_add</span><span class="p">(</span><span class="k">const</span><span class="w"> </span><span class="n">__itt_domain</span><span class="w"> </span><span class="o">*</span><span class="n">domain</span><span class="p">,</span><span class="w"> </span><span class="n">__itt_id</span><span class="w"> </span><span class="n">id</span><span class="p">,</span><span class="w"> </span><span class="n">__itt_string_handle</span><span class="w"> </span><span class="o">*</span><span class="n">key</span><span class="p">,</span>
<span class="w"> </span><span class="n">__itt_metadata_type</span><span class="w"> </span><span class="n">type</span><span class="p">,</span><span class="w"> </span><span class="kt">size_t</span><span class="w"> </span><span class="n">count</span><span class="p">,</span><span class="w"> </span><span class="kt">void</span><span class="w"> </span><span class="o">*</span><span class="n">data</span><span class="p">);</span>
<span class="kt">void</span><span class="w"> </span><span class="nf">__itt_metadata_str_addA</span><span class="p">(</span><span class="k">const</span><span class="w"> </span><span class="n">__itt_domain</span><span class="w"> </span><span class="o">*</span><span class="n">domain</span><span class="p">,</span><span class="w"> </span><span class="n">__itt_id</span><span class="w"> </span><span class="n">id</span><span class="p">,</span><span class="w"> </span><span class="n">__itt_string_handle</span><span class="w"> </span><span class="o">*</span><span class="n">key</span><span class="p">,</span>
<span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="o">*</span><span class="n">data</span><span class="p">,</span><span class="w"> </span><span class="kt">size_t</span><span class="w"> </span><span class="n">length</span><span class="p">);</span>
<span class="kt">void</span><span class="w"> </span><span class="nf">__itt_metadata_str_addW</span><span class="p">(</span><span class="k">const</span><span class="w"> </span><span class="n">__itt_domain</span><span class="w"> </span><span class="o">*</span><span class="n">domain</span><span class="p">,</span><span class="w"> </span><span class="n">__itt_id</span><span class="w"> </span><span class="n">id</span><span class="p">,</span><span class="w"> </span><span class="n">__itt_string_handle</span><span class="w"> </span><span class="o">*</span><span class="n">key</span><span class="p">,</span>
<span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="kt">wchar_t</span><span class="w"> </span><span class="o">*</span><span class="n">data</span><span class="p">,</span><span class="w"> </span><span class="kt">size_t</span><span class="w"> </span><span class="n">length</span><span class="p">);</span>
<span class="kt">void</span><span class="w"> </span><span class="nf">__itt_metadata_add_with_scope</span><span class="p">(</span><span class="k">const</span><span class="w"> </span><span class="n">__itt_domain</span><span class="w"> </span><span class="o">*</span><span class="n">domain</span><span class="p">,</span><span class="w"> </span><span class="n">__itt_scope</span><span class="w"> </span><span class="n">scope</span><span class="p">,</span>
<span class="w"> </span><span class="n">__itt_string_handle</span><span class="w"> </span><span class="o">*</span><span class="n">key</span><span class="p">,</span><span class="w"> </span><span class="n">__itt_metadata_type</span><span class="w"> </span><span class="n">type</span><span class="p">,</span>
<span class="w"> </span><span class="kt">size_t</span><span class="w"> </span><span class="n">count</span><span class="p">,</span><span class="w"> </span><span class="kt">void</span><span class="w"> </span><span class="o">*</span><span class="n">data</span><span class="p">);</span>
<span class="kt">void</span><span class="w"> </span><span class="nf">__itt_metadata_str_add_with_scopeA</span><span class="p">(</span><span class="k">const</span><span class="w"> </span><span class="n">__itt_domain</span><span class="w"> </span><span class="o">*</span><span class="n">domain</span><span class="p">,</span><span class="w"> </span><span class="n">__itt_scope</span><span class="w"> </span><span class="n">scope</span><span class="p">,</span>
<span class="w"> </span><span class="n">__itt_string_handle</span><span class="w"> </span><span class="o">*</span><span class="n">key</span><span class="p">,</span><span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="o">*</span><span class="n">data</span><span class="p">,</span><span class="w"> </span><span class="kt">size_t</span><span class="w"> </span><span class="n">length</span><span class="p">);</span>
<span class="kt">void</span><span class="w"> </span><span class="nf">__itt_metadata_str_add_with_scopeW</span><span class="p">(</span><span class="k">const</span><span class="w"> </span><span class="n">__itt_domain</span><span class="w"> </span><span class="o">*</span><span class="n">domain</span><span class="p">,</span><span class="w"> </span><span class="n">__itt_scope</span><span class="w"> </span><span class="n">scope</span><span class="p">,</span>
<span class="w"> </span><span class="n">__itt_string_handle</span><span class="w"> </span><span class="o">*</span><span class="n">key</span><span class="p">,</span><span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="kt">wchar_t</span><span class="w"> </span><span class="o">*</span><span class="n">data</span><span class="p">,</span><span class="w"> </span><span class="kt">size_t</span><span class="w"> </span><span class="n">length</span><span class="p">);</span>
</pre></div>
</div>
<p>The following table defines the parameters used in the Metadata API primitives.</p>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Type</p></th>
<th class="head"><p>Parameter</p></th>
<th class="head"><p>Description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>[in]</p></td>
<td><div class="highlight-cpp notranslate"><div class="highlight"><pre><span></span><span class="n">__itt_domain</span><span class="o">*</span><span class="w"> </span><span class="n">domain</span>
</pre></div>
</div>
</td>
<td><p>Metadata domain</p></td>
</tr>
<tr class="row-odd"><td><p>[in]</p></td>
<td><div class="highlight-cpp notranslate"><div class="highlight"><pre><span></span><span class="n">__itt_scope</span><span class="w"> </span><span class="n">scope</span>
</pre></div>
</div>
</td>
<td><p>Metadata scope: task, thread, process, and global.
If a scope is undefined, metadata belongs to the
last task in the thread.</p></td>
</tr>
<tr class="row-even"><td><p>[in]</p></td>
<td><div class="highlight-cpp notranslate"><div class="highlight"><pre><span></span><span class="n">__itt_string_handle</span><span class="o">*</span><span class="w"> </span><span class="n">name</span>
</pre></div>
</div>
</td>
<td><p>Metadata name</p></td>
</tr>
<tr class="row-odd"><td><p>[in]</p></td>
<td><div class="highlight-cpp notranslate"><div class="highlight"><pre><span></span><span class="n">__itt_metadata_type</span><span class="w"> </span><span class="n">type</span>
</pre></div>
</div>
</td>
<td><p>Metadata type; used only for numeric metadata</p></td>
</tr>
<tr class="row-even"><td><p>[in]</p></td>
<td><div class="highlight-cpp notranslate"><div class="highlight"><pre><span></span><span class="kt">size_t</span><span class="w"> </span><span class="n">count</span>
</pre></div>
</div>
</td>
<td><p>Number of numeric metadata items
<code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">size_t</span></code> length</p></td>
</tr>
<tr class="row-odd"><td><p>[in]</p></td>
<td><div class="highlight-cpp notranslate"><div class="highlight"><pre><span></span><span class="kt">size_t</span><span class="w"> </span><span class="n">length</span>
</pre></div>
</div>
</td>
<td><p>Number of symbols a metadata string</p></td>
</tr>
<tr class="row-even"><td><p>[in]</p></td>
<td><div class="highlight-cpp notranslate"><div class="highlight"><pre><span></span><span class="kt">void</span><span class="w"> </span><span class="o">*</span><span class="n">data</span>
<span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="o">*</span><span class="n">data</span>
<span class="k">const</span><span class="w"> </span><span class="kt">wchar_t</span><span class="w"> </span><span class="o">*</span><span class="n">data</span>
</pre></div>
</div>
</td>
<td><p>Actual metadata (array of numerics or string)</p></td>
</tr>
</tbody>
</table>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="memory-allocation-apis.html" class="btn btn-neutral float-left" title="Memory Allocation APIs" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="relation-api.html" class="btn btn-neutral float-right" title="Relation API" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2025 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>