Google Git
Sign in
chromium / external / github.com / intel / ittapi / e8a6e760801eed19b5164c09913c9c413e64b856
commite8a6e760801eed19b5164c09913c9c413e64b856[log] [tgz]
authorAlexey Kireev <[email protected]>Wed Oct 08 09:46:55 2025
committerGitHub <[email protected]>Wed Oct 08 09:46:55 2025
treebb28ce6771bf89ec43a7ee69a138a9acdeb7aa9d
parentca45fef1a12cef3316e6ff362a4d36571270e392 [diff]
doc: add Formatted Metadata API documentation (#185)

* initial add of formatted metadata api documentation

* add formatted metadata reference to task api page

* small naming fix

* Update docs/src/ittapi/formatted-metadata-api.rst

* add documentation for formatted metadata in overlapped tasks

---------

Co-authored-by: Evgeny Parshutin <[email protected]>
3 files changed
tree: bb28ce6771bf89ec43a7ee69a138a9acdeb7aa9d
  1. .github/
  2. cmake/
  3. docs/
  4. include/
  5. LICENSES/
  6. python/
  7. rust/
  8. src/
  9. .gitignore
  10. buildall.py
  11. CMakeLists.txt
  12. CONTRIBUTING.md
  13. README.md
  14. SECURITY.md
README.md

Intel® Instrumentation and Tracing Technology (ITT) and Just-In-Time (JIT) APIs

Build Status CodeQL Package on conda-forge Package on PyPI Package on crates.io OpenSSF Scorecard

This repository contains the following profiling APIs:

  • Instrumentation and Tracing Technology (ITT) API
    Powers your application to generate and control the collection of trace data during its execution, seamlessly integrating with Intel tools.
  • Just-In-Time (JIT) Profiling API
    Reports detailed information about just-in-time (JIT) compiled code, enabling you to profile the performance of dynamically generated code.

The ITT/JIT APIs consist of two parts:

  • Static Part
    An open-source static library that you compile and link with your application.
  • Dynamic Part
    A tool-specific shared library that collects and writes trace data. You can find the reference implementation of the dynamic part as a Reference Collector here.

Build

To build the library:

  • Get general development tools, including C/C++ Compiler
  • Install Python 3.6 or later
  • Install CMake 3.5 or later
  • For a Windows* system, install one of these:
  • To enable support for Fortran, install the Intel Fortran Compiler
  • To list available build options execute: python buildall.py -h
usage: buildall.py [-h] [-d] [-c] [-v] [-pt] [-ft] [--force_bits]

optional arguments:
  -h, --help      show this help message and exit
  -d, --debug     specify debug build configuration (release by default)
  -c, --clean     delete any intermediate and output files
  -v, --verbose   enable verbose output from build process
  -pt, --ptmark   enable anomaly detection support
  -ft, --fortran  enable fortran support
  --force_bits    specify bit version for the target
  --vs            specify visual studio version (Windows only)
  --cmake_gen     specify cmake build generator (Windows only)

Documentation

Find complete documentation for ITT/JIT APIs on the ITT/JIT APIs Documentation Page

License

All code in the repo is dual licensed under GPLv2 and 3-Clause BSD licenses

Make Contributions

Learn how to contribute using our contribution guide
To report bugs or request enhancements, please use the Issues page on GitHub

Security

To report vulnerabilities, refer to our security policy