NVIDIA IndeX API nvidia_logo_transpbg.gif Up
iperformance_values.h
Go to the documentation of this file.
1/******************************************************************************
2 * Copyright 2023 NVIDIA Corporation. All rights reserved.
3 *****************************************************************************/
6
7#ifndef NVIDIA_INDEX_IPERFORMANCE_VALUES_H
8#define NVIDIA_INDEX_IPERFORMANCE_VALUES_H
9
10#include <mi/dice.h>
11
12namespace nv {
13
14namespace index {
15
24 public mi::base::Interface_declare<0x323be64a,0xbd51,0x4078,0xb3,0x29,0xf6,0xe8,0x04,0x93,0x70,0xeb,
25 mi::neuraylib::ISerializable>
26{
27public:
30 virtual mi::Uint32 get_span_id() const = 0;
31
34 virtual mi::Uint32 get_cluster_node_id() const = 0;
35
38 virtual mi::Uint32 get_nb_type_names() const = 0;
39
43 virtual const char* get_type_name(mi::Uint32 index) const = 0;
44
48 virtual mi::Uint64 get(const char* type_name) const = 0;
49
53 virtual mi::Float32 get_time(const char* type_name) const = 0;
54};
55
61 public mi::base::Interface_declare<0xa3ed753a,0x5a9c,0x4157,0xa4,0x71,0x52,0x86,0x5f,0x5f,0x43,0xd9>
62{
63public:
65 static const mi::Uint64 TIME_RESOLUTION = 1000000;
66
68 static const mi::Uint64 INVALID_VALUE = ~0ULL;
69
72 static mi::Float32 INVALID_VALUE_FLOAT() { return -1.f; }
73
158 virtual mi::Uint64 get(const char* type_name, mi::Uint32 host_id = 0) const = 0;
159
169 virtual mi::Float32 get_time(const char* type_name, mi::Uint32 host_id = 0) const = 0;
170
174 virtual mi::Uint32 get_nb_type_names() const = 0;
175
180 virtual const char* get_type_name(mi::Uint32 index) const = 0;
181
185 virtual mi::Size get_nb_host_ids() const = 0;
186
193 virtual void get_host_id_array(mi::Uint32 host_id_array[]) const = 0;
194
202 virtual IPer_span_statistics* get_per_span_statistics(mi::Uint32 span_id) const = 0;
203
204};
205
206}} // namespace index / nv
207
208#endif // NVIDIA_INDEX_IPERFORMANCE_VALUES_H
Interface class that exposes the performance values and statistics of a single horizontal span.
Definition: iperformance_values.h:26
virtual mi::Uint32 get_cluster_node_id() const =0
Returns the id of the cluster node that was responsible for the span compositing.
virtual mi::Uint32 get_nb_type_names() const =0
Returns the number of type names for performance values.
virtual mi::Float32 get_time(const char *type_name) const =0
Returns the value of the given performance value, interpreted as time in milliseconds.
virtual const char * get_type_name(mi::Uint32 index) const =0
Returns type name string by the given index.
virtual mi::Uint64 get(const char *type_name) const =0
Returns the value of the given performance counter.
virtual mi::Uint32 get_span_id() const =0
Returns the id of the span for which the present performance values have been gathered.
Interface class to query overall system performance values and statistics.
Definition: iperformance_values.h:62
virtual mi::Float32 get_time(const char *type_name, mi::Uint32 host_id=0) const =0
Returns the value of the given performance value, interpreted as time in milliseconds.
virtual IPer_span_statistics * get_per_span_statistics(mi::Uint32 span_id) const =0
Returns performance statistics for the given horizontal span.
virtual mi::Uint64 get(const char *type_name, mi::Uint32 host_id=0) const =0
Returns the value of the given performance counter.
virtual void get_host_id_array(mi::Uint32 host_id_array[]) const =0
Returns the host id array.
static mi::Float32 INVALID_VALUE_FLOAT()
Value returned by get_time() when an invalid type was specified.
Definition: iperformance_values.h:72
virtual mi::Uint32 get_nb_type_names() const =0
Returns the number of different performance value types.
static const mi::Uint64 INVALID_VALUE
Value returned by get() when an invalid type was specified.
Definition: iperformance_values.h:68
static const mi::Uint64 TIME_RESOLUTION
Internal resolution of time values (in 1/milliseconds).
Definition: iperformance_values.h:65
virtual mi::Size get_nb_host_ids() const =0
Returns the size of host id array.
virtual const char * get_type_name(mi::Uint32 index) const =0
Returns the name of the given performance value type.
Common namespace for all NVIDIA APIs.
Definition: iindex.h:349