hebench_report.h

Go to the documentation of this file.

 
// Copyright (C) 2021 Intel Corporation
// SPDX-License-Identifier: Apache-2.0
 
#ifndef _HEBench_Harness_Report_H_0596d40a3cce4b108a81595c50eb286d
#define _HEBench_Harness_Report_H_0596d40a3cce4b108a81595c50eb286d
 
#include <stdint.h>
 
#include "hebench_report_types.h"
 
namespace hebench {
namespace ReportGen {
 
extern "C"
{
 
    void *allocateReport();
    void freeReport(void *p_report);
 
    int32_t setReportHeader(void *p_report, const char *new_header);
    int32_t appendReportHeader(void *p_report, const char *new_header, int32_t new_line);
    int32_t prependReportHeader(void *p_report, const char *new_header, int32_t new_line);
    uint64_t getReportHeader(void *p_report, char *header, uint64_t size);
 
    int32_t setReportFooter(void *p_report, const char *new_footer);
    int32_t appendReportFooter(void *p_report, const char *new_footer, int32_t new_line);
    int32_t prependReportFooter(void *p_report, const char *new_footer, int32_t new_line);
    uint64_t getReportFooter(void *p_report, char *footer, uint64_t size);
 
    int32_t addEventType(void *p_report, uint32_t event_type_id, const char *event_type_header);
    int32_t addMainEventType(void *p_report, uint32_t event_type_id, const char *event_type_header);
    int32_t hasEventType(void *p_report, uint32_t event_type_id);
    uint64_t getEventTypeHeader(void *p_report, uint32_t event_type_id, char *event_type_header, uint64_t size);
    uint64_t getEventTypeCount(void *p_report);
    uint32_t getEventType(void *p_report, uint64_t index);
    int32_t getMainEventType(void *p_report, uint32_t *p_event_type_id);
 
    // events management
 
    int32_t addEvent(void *p_report, const TimingReportEventC *p_event);
    int32_t getEvent(void *p_report, TimingReportEventC *p_event, uint64_t index);
    uint64_t getEventCount(void *p_report);
    uint64_t getEventCapacity(void *p_report);
    int32_t setEventCapacity(void *p_report, uint64_t new_capacity);
    int32_t clearEvents(void *p_report);
 
    // CSV
    int32_t save2CSV(void *p_report, const char *filename);
    int32_t convert2CSV(void *p_report, char **pp_csv_content);
    void freeCSVContent(char *p_csv_content);
 
    void *loadReportFromCSV(const char *p_csv_content, char error_description[MAX_DESCRIPTION_BUFFER_SIZE]);
    void *loadReportFromCSVFile(const char *filename, char error_description[MAX_DESCRIPTION_BUFFER_SIZE]);
 
    // misc/utilities
 
    int32_t setTimingPrefix(TimingPrefixedSeconds *p_prefix, double seconds, char prefix);
 
    int32_t computeTimingPrefix(TimingPrefixedSeconds *p_prefix, double seconds);
}
 
} // namespace ReportGen
} // namespace hebench
 
#endif // defined _HEBench_Harness_Report_H_0596d40a3cce4b108a81595c50eb286d