|
1 | 1 | /* |
2 | | - Copyright (c) 2005-2024 Intel Corporation |
| 2 | + Copyright (c) 2005-2025 Intel Corporation |
| 3 | + Copyright (c) 2025 UXL Foundation Contributors |
3 | 4 |
|
4 | 5 | Licensed under the Apache License, Version 2.0 (the "License"); |
5 | 6 | you may not use this file except in compliance with the License. |
@@ -102,10 +103,9 @@ The same ID may not be reused for different instances, unless a previous |
102 | 103 | #endif /* ITT_OS_FREEBSD */ |
103 | 104 |
|
104 | 105 | #ifndef ITT_OS_OPENBSD |
105 | | -# define ITT_OS_OPENBSD 5 |
| 106 | +# define ITT_OS_OPENBSD 5 |
106 | 107 | #endif /* ITT_OS_OPENBSD */ |
107 | 108 |
|
108 | | - |
109 | 109 | #ifndef ITT_OS |
110 | 110 | # if defined WIN32 || defined _WIN32 |
111 | 111 | # define ITT_OS ITT_OS_WIN |
@@ -274,6 +274,8 @@ The same ID may not be reused for different instances, unless a previous |
274 | 274 | #define ITTNOTIFY_VOID_D4(n,d,x,y,z,a) (d == NULL) ? (void)0 : (!(d)->flags) ? (void)0 : (!ITTNOTIFY_NAME(n)) ? (void)0 : ITTNOTIFY_NAME(n)(d,x,y,z,a) |
275 | 275 | #define ITTNOTIFY_VOID_D5(n,d,x,y,z,a,b) (d == NULL) ? (void)0 : (!(d)->flags) ? (void)0 : (!ITTNOTIFY_NAME(n)) ? (void)0 : ITTNOTIFY_NAME(n)(d,x,y,z,a,b) |
276 | 276 | #define ITTNOTIFY_VOID_D6(n,d,x,y,z,a,b,c) (d == NULL) ? (void)0 : (!(d)->flags) ? (void)0 : (!ITTNOTIFY_NAME(n)) ? (void)0 : ITTNOTIFY_NAME(n)(d,x,y,z,a,b,c) |
| 277 | +#define ITTNOTIFY_VOID_D2_VA(n,d,x,...) (d == NULL) ? (void)0 : (!(d)->flags) ? (void)0 : (!ITTNOTIFY_NAME(n)) ? (void)0 : ITTNOTIFY_NAME(n)(d,x,__VA_ARGS__) |
| 278 | +#define ITTNOTIFY_VOID_D3_VA(n,d,x,y,...) (d == NULL) ? (void)0 : (!(d)->flags) ? (void)0 : (!ITTNOTIFY_NAME(n)) ? (void)0 : ITTNOTIFY_NAME(n)(d,x,y,__VA_ARGS__) |
277 | 279 | #define ITTNOTIFY_DATA_D0(n,d) (d == NULL) ? 0 : (!(d)->flags) ? 0 : (!ITTNOTIFY_NAME(n)) ? 0 : ITTNOTIFY_NAME(n)(d) |
278 | 280 | #define ITTNOTIFY_DATA_D1(n,d,x) (d == NULL) ? 0 : (!(d)->flags) ? 0 : (!ITTNOTIFY_NAME(n)) ? 0 : ITTNOTIFY_NAME(n)(d,x) |
279 | 281 | #define ITTNOTIFY_DATA_D2(n,d,x,y) (d == NULL) ? 0 : (!(d)->flags) ? 0 : (!ITTNOTIFY_NAME(n)) ? 0 : ITTNOTIFY_NAME(n)(d,x,y) |
@@ -318,7 +320,7 @@ extern "C" { |
318 | 320 | * only pauses tracing and analyzing memory access. |
319 | 321 | * It does not pause tracing or analyzing threading APIs. |
320 | 322 | * . |
321 | | - * Intel(R) VTune(TM) Profiler: |
| 323 | + * - Intel(R) VTune(TM) Profiler: |
322 | 324 | * - Does continue to record when new threads are started. |
323 | 325 | * . |
324 | 326 | * - Other effects: |
@@ -347,7 +349,7 @@ typedef enum { |
347 | 349 | void ITTAPI __itt_pause_scoped(__itt_collection_scope); |
348 | 350 | /** @brief Resume scoped collection */ |
349 | 351 | void ITTAPI __itt_resume_scoped(__itt_collection_scope); |
350 | | - |
| 352 | + |
351 | 353 | /** @cond exclude_from_documentation */ |
352 | 354 | #ifndef INTEL_NO_MACRO_BODY |
353 | 355 | #ifndef INTEL_NO_ITTNOTIFY_API |
@@ -393,7 +395,7 @@ ITT_STUBV(ITTAPI, void, detach, (void)) |
393 | 395 | * @defgroup Intel Processor Trace control |
394 | 396 | * API from this group provides control over collection and analysis of Intel Processor Trace (Intel PT) data |
395 | 397 | * Information about Intel Processor Trace technology can be found here (Volume 3 chapter 35): |
396 | | - * https://github.com/tpn/pdfs/blob/master/Intel%2064%20and%20IA-32%20Architectures%20Software%20Developer's%20Manual%20-%20Combined%20Volumes%201-4%20-%20May%202018%20(325462-sdm-vol-1-2abcd-3abcd).pdf |
| 398 | + * https://software.intel.com/sites/default/files/managed/39/c5/325462-sdm-vol-1-2abcd-3abcd.pdf |
397 | 399 | * Use this API to mark particular code regions for loading detailed performance statistics. |
398 | 400 | * This mode makes your analysis faster and more accurate. |
399 | 401 | * @{ |
@@ -2466,9 +2468,58 @@ typedef enum { |
2466 | 2468 | __itt_metadata_u16, /**< Unsigned 16-bit integer */ |
2467 | 2469 | __itt_metadata_s16, /**< Signed 16-bit integer */ |
2468 | 2470 | __itt_metadata_float, /**< Signed 32-bit floating-point */ |
2469 | | - __itt_metadata_double /**< SIgned 64-bit floating-point */ |
| 2471 | + __itt_metadata_double /**< Signed 64-bit floating-point */ |
2470 | 2472 | } __itt_metadata_type; |
2471 | 2473 |
|
| 2474 | +/** |
| 2475 | + * @ingroup parameters |
| 2476 | + * @brief Add metadata to an instance of a named entity. |
| 2477 | + * @param[in] domain The domain controlling the call |
| 2478 | + * @param[in] format The printf-style format of the metadata |
| 2479 | + * @param[in] ... The metadata itself as multiple arguments |
| 2480 | + */ |
| 2481 | +void ITTAPI __itt_formatted_metadata_add(const __itt_domain *domain, __itt_string_handle *format, ...); |
| 2482 | + |
| 2483 | +/** @cond exclude_from_documentation */ |
| 2484 | +#ifndef INTEL_NO_MACRO_BODY |
| 2485 | +#ifndef INTEL_NO_ITTNOTIFY_API |
| 2486 | +ITT_STUBV(ITTAPI, void, formatted_metadata_add, (const __itt_domain *domain, __itt_string_handle *format, ...)) |
| 2487 | +#define __itt_formatted_metadata_add(d,x, ...) ITTNOTIFY_VOID_D2_VA(formatted_metadata_add,d,x,__VA_ARGS__) |
| 2488 | +#define __itt_formatted_metadata_add_ptr ITTNOTIFY_NAME(formatted_metadata_add) |
| 2489 | +#else /* INTEL_NO_ITTNOTIFY_API */ |
| 2490 | +#define __itt_formatted_metadata_add(domain, format, metadata) |
| 2491 | +#define __itt_formatted_metadata_add_ptr 0 |
| 2492 | +#endif /* INTEL_NO_ITTNOTIFY_API */ |
| 2493 | +#else /* INTEL_NO_MACRO_BODY */ |
| 2494 | +#define __itt_formatted_metadata_add_ptr 0 |
| 2495 | +#endif /* INTEL_NO_MACRO_BODY */ |
| 2496 | +/** @endcond */ |
| 2497 | + |
| 2498 | +/** |
| 2499 | + * @ingroup parameters |
| 2500 | + * @brief Add metadata to an instance of a named entity. |
| 2501 | + * @param[in] domain The domain controlling the call |
| 2502 | + * @param[in] taskid The identifier for this task instance, *cannot* be __itt_null. |
| 2503 | + * @param[in] format The printf-style format of the metadata |
| 2504 | + * @param[in] ... The metadata itself as multiple arguments |
| 2505 | + */ |
| 2506 | +void ITTAPI __itt_formatted_metadata_add_overlapped(const __itt_domain *domain, __itt_id taskid, __itt_string_handle *format, ...); |
| 2507 | + |
| 2508 | +/** @cond exclude_from_documentation */ |
| 2509 | +#ifndef INTEL_NO_MACRO_BODY |
| 2510 | +#ifndef INTEL_NO_ITTNOTIFY_API |
| 2511 | +ITT_STUBV(ITTAPI, void, formatted_metadata_add_overlapped, (const __itt_domain *domain, __itt_id taskid, __itt_string_handle *format, ...)) |
| 2512 | +#define __itt_formatted_metadata_add_overlapped(d,x,y, ...) ITTNOTIFY_VOID_D3_VA(formatted_metadata_add_overlapped,d,x,y,__VA_ARGS__) |
| 2513 | +#define __itt_formatted_metadata_add_overlapped_ptr ITTNOTIFY_NAME(formatted_metadata_add_overlapped) |
| 2514 | +#else /* INTEL_NO_ITTNOTIFY_API */ |
| 2515 | +#define __itt_formatted_metadata_add_overlapped(domain, taskid, format, metadata) |
| 2516 | +#define __itt_formatted_metadata_add_overlapped_ptr 0 |
| 2517 | +#endif /* INTEL_NO_ITTNOTIFY_API */ |
| 2518 | +#else /* INTEL_NO_MACRO_BODY */ |
| 2519 | +#define __itt_formatted_metadata_add_overlapped_ptr 0 |
| 2520 | +#endif /* INTEL_NO_MACRO_BODY */ |
| 2521 | +/** @endcond */ |
| 2522 | + |
2472 | 2523 | /** |
2473 | 2524 | * @ingroup parameters |
2474 | 2525 | * @brief Add metadata to an instance of a named entity. |
@@ -4010,21 +4061,21 @@ ITT_STUB(ITTAPI, __itt_histogram*, histogram_create, (const __itt_domain* domain |
4010 | 4061 |
|
4011 | 4062 | /** |
4012 | 4063 | * @brief Submit statistics for a histogram instance. |
4013 | | - * @param[in] histogram Pointer to the histogram instance to which the histogram statistic is to be dumped. |
| 4064 | + * @param[in] hist Pointer to the histogram instance to which the histogram statistic is to be dumped. |
4014 | 4065 | * @param[in] length The number of elements in dumped axis data array. |
4015 | 4066 | * @param[in] x_data The X axis dumped data itself (may be NULL to calculate batch statistics). |
4016 | 4067 | * @param[in] y_data The Y axis dumped data itself. |
4017 | 4068 | */ |
4018 | | -void ITTAPI __itt_histogram_submit(__itt_histogram* histogram, size_t length, void* x_data, void* y_data); |
| 4069 | +void ITTAPI __itt_histogram_submit(__itt_histogram* hist, size_t length, void* x_data, void* y_data); |
4019 | 4070 |
|
4020 | 4071 | /** @cond exclude_from_documentation */ |
4021 | 4072 | #ifndef INTEL_NO_MACRO_BODY |
4022 | 4073 | #ifndef INTEL_NO_ITTNOTIFY_API |
4023 | | -ITT_STUBV(ITTAPI, void, histogram_submit, (__itt_histogram* histogram, size_t length, void* x_data, void* y_data)) |
| 4074 | +ITT_STUBV(ITTAPI, void, histogram_submit, (__itt_histogram* hist, size_t length, void* x_data, void* y_data)) |
4024 | 4075 | #define __itt_histogram_submit ITTNOTIFY_VOID(histogram_submit) |
4025 | 4076 | #define __itt_histogram_submit_ptr ITTNOTIFY_NAME(histogram_submit) |
4026 | 4077 | #else /* INTEL_NO_ITTNOTIFY_API */ |
4027 | | -#define __itt_histogram_submit(histogram, length, x_data, y_data) |
| 4078 | +#define __itt_histogram_submit(hist, length, x_data, y_data) |
4028 | 4079 | #define __itt_histogram_submit_ptr 0 |
4029 | 4080 | #endif /* INTEL_NO_ITTNOTIFY_API */ |
4030 | 4081 | #else /* INTEL_NO_MACRO_BODY */ |
@@ -4630,7 +4681,7 @@ typedef enum __itt_error_code |
4630 | 4681 | { |
4631 | 4682 | __itt_error_success = 0, /*!< no error */ |
4632 | 4683 | __itt_error_no_module = 1, /*!< module can't be loaded */ |
4633 | | - /* %1$s -- library name; win: %2$d -- system error code; unix: %2$s -- system error message. */ |
| 4684 | + /* %1$s -- library name; win: %2$d -- system error code; unx: %2$s -- system error message. */ |
4634 | 4685 | __itt_error_no_symbol = 2, /*!< symbol not found */ |
4635 | 4686 | /* %1$s -- library name, %2$s -- symbol name. */ |
4636 | 4687 | __itt_error_unknown_group = 3, /*!< unknown group specified */ |
|
0 commit comments