HEBench
hebench_report_types.h File Reference
#include <stdint.h>
Include dependency graph for hebench_report_types.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  hebench::ReportGen::_TimingReportEventC
 
struct  hebench::ReportGen::_UnitPrefix
 

Namespaces

 hebench
 
 hebench::ReportGen
 

Macros

#define MAX_DESCRIPTION_BUFFER_SIZE   256
 
#define MAX_SYMBOL_BUFFER_SIZE   4
 
#define MAX_TIME_REPORT_EVENT_DESCRIPTION_SIZE   256
 

Typedefs

typedef struct _TimingReportEventC hebench::ReportGen::TimingReportEventC
 
typedef struct _UnitPrefix hebench::ReportGen::TimingPrefixedSeconds
 

Class Documentation

◆ hebench::ReportGen::_TimingReportEventC

struct hebench::ReportGen::_TimingReportEventC

Definition at line 20 of file hebench_report_types.h.

Class Members
double cpu_time_end
double cpu_time_start
char description[MAX_TIME_REPORT_EVENT_DESCRIPTION_SIZE] Description attached to this event.

Set to empty string if no description.

uint32_t event_type_id ID specifying the event type.

During summary report, events with the same ID will be grouped together for statistical computations. Users must make sure that related events are tagged with the correct ID.

uint64_t input_sample_count
int64_t time_interval_ratio_den Scale of time interval used for this event.
See also
time_interval_ratio_num
int64_t time_interval_ratio_num Scale of time interval used for this event.

Timing values in this instance are given in this scale.

This represents the ratio of this scale with respect to 1 second. For example, 1 millisecond is 0.001 seconds, and thus, its scale ratio is 1:1000. So, the time, in seconds for wall time is

Similarly for CPU time.

double wall_time_end
double wall_time_start

◆ hebench::ReportGen::_UnitPrefix

struct hebench::ReportGen::_UnitPrefix

Definition at line 60 of file hebench_report_types.h.

Class Members
char prefix[MAX_DESCRIPTION_BUFFER_SIZE] Full name for the prefix (or empty string if no prefix).

milli, micro, nano

char symbol[MAX_SYMBOL_BUFFER_SIZE] Symbol for the prefix.

m for milli, u micro, n for nano

int64_t time_interval_ratio_den Denominator of timing scale ratio with respect to a unit.

Numerator is always 1.

double value Value in the specified unit.

Macro Definition Documentation

◆ MAX_DESCRIPTION_BUFFER_SIZE

#define MAX_DESCRIPTION_BUFFER_SIZE   256

Definition at line 16 of file hebench_report_types.h.

◆ MAX_SYMBOL_BUFFER_SIZE

#define MAX_SYMBOL_BUFFER_SIZE   4

Definition at line 17 of file hebench_report_types.h.

◆ MAX_TIME_REPORT_EVENT_DESCRIPTION_SIZE

#define MAX_TIME_REPORT_EVENT_DESCRIPTION_SIZE   256

Definition at line 18 of file hebench_report_types.h.