hebench_report_impl.h

Go to the documentation of this file.

 
// Copyright (C) 2021 Intel Corporation
// SPDX-License-Identifier: Apache-2.0
 
#ifndef _HEBench_TimingReport_H_0596d40a3cce4b108a81595c50eb286d
#define _HEBench_TimingReport_H_0596d40a3cce4b108a81595c50eb286d
 
#include <cmath>
#include <iostream>
#include <memory>
#include <ratio>
#include <string>
#include <unordered_map>
#include <vector>
 
#include "hebench_report.h"
 
namespace hebench {
namespace ReportGen {
 
class TimingReportImpl
{
public:
    // section indicators for parsing generated CSV
 
    static constexpr const char *TagVersion      = "#v,0,1,1";
    static constexpr const char *TagReportHeader = "#0100"; // header at the start of the test
    static constexpr const char *TagFailedTest   = "#XXXX"; // indicates failed test (validation failed)
    static constexpr const char *TagReportData   = "#0200"; // start of the data
    static constexpr const char *TagReportFooter = "#8E00"; // start of the footer
    static constexpr const char *TagReportEnd    = "#8FFF"; // end of the report
 
    TimingReportImpl();
 
    void newEventType(std::uint32_t set_id, const std::string &set_header, bool is_main_event = false);
    const std::unordered_map<std::uint32_t, std::string> &getEventTypes() const { return m_event_headers; }
    const std::vector<std::uint32_t> &getEventTypeIDs() const { return m_event_types; }
 
    std::uint32_t getMainEventID() const { return m_main_event; }
 
    void newEvent(std::shared_ptr<TimingReportEventC> p_event, const std::string &set_header = std::string());
    const std::vector<std::shared_ptr<TimingReportEventC>> &getEvents() const { return m_events; }
    void reserveCapacityForEvents(std::size_t new_capacity);
    void clear();
 
    const std::string &getHeader() const { return m_header; }
    void setHeader(const std::string &header) { m_header = header; }
    void appendHeader(const std::string &header, bool new_line);
    void prependHeader(const std::string &header, bool new_line);
 
    const std::string &getFooter() const { return m_footer; }
    void setFooter(const std::string &footer) { m_footer = footer; }
    void appendFooter(const std::string &footer, bool new_line);
    void prependFooter(const std::string &footer, bool new_line);
 
    std::ostream &convert2CSV(std::ostream &os) const;
 
    static TimingReportImpl loadCSV(std::istream &is);
    static TimingReportImpl loadCSV(const std::string &csv_content);
 
    static void setTimingPrefix(TimingPrefixedSeconds &prefix, double seconds, char ch_prefix);
    static void computeTimingPrefix(TimingPrefixedSeconds &prefix, double seconds);
 
private:
    static std::string_view findNextValueCSV(std::size_t &out_start_idx,
                                             std::size_t &out_count,
                                             const char *s);
    static void parseHeadingValue(std::string &s_out_heading, std::uint64_t &out_value,
                                  const std::string &s_line);
    static void parseHeadingValue(std::string &s_out_heading, double &out_value,
                                  const std::string &s_line);
    static std::istream &getTrimmedLine(std::istream &is, std::string &s_out,
                                        const std::string &extra_trim = std::string());
    static std::istream &getTrimmedLine(std::istream &is, std::string &s_out,
                                        const std::string &extra_ltrim, const std::string &extra_rtrim);
    static std::string readTextBlock(std::istream &is, std::string &s_block,
                                     const std::vector<std::string> tags);
    static void parseTimingEvent(std::string &s_out_event_header,
                                 std::shared_ptr<TimingReportEventC> &p_out_event,
                                 const std::string &s_line);
 
    std::string m_header;
    std::string m_footer;
    std::uint32_t m_main_event;
    std::unordered_map<std::uint32_t, std::string> m_event_headers; // maps event id to event header
    std::vector<std::uint32_t> m_event_types; // all keys to map m_event_headers
    std::vector<std::shared_ptr<TimingReportEventC>> m_events;
};
 
} // namespace ReportGen
} // namespace hebench
 
#endif // defined _HEBench_TimingReport_H_0596d40a3cce4b108a81595c50eb286d