rumtk-benchmark 0.3.0

Benchmark tool to generate a report of performance characteristics. Built for the RUMTK toolkit, but not limited to it.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84

/*
 *     rumtk attempts to implement HL7 and medical protocols for interoperability in medicine.
 *     This toolkit aims to be reliable, simple, performant, and standards compliant.
 *     Copyright (C) 2026  Luis M. Santos, M.D. <lsantos@medicalmasses.com>
 *     Copyright (C) 2026  MedicalMasses L.L.C. <contact@medicalmasses.com>
 *
 *     This program is free software: you can redistribute it and/or modify
 *     it under the terms of the GNU General Public License as published by
 *     the Free Software Foundation, either version 3 of the License, or
 *     (at your option) any later version.
 *
 *     This program is distributed in the hope that it will be useful,
 *     but WITHOUT ANY WARRANTY; without even the implied warranty of
 *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *     GNU General Public License for more details.
 *
 *     You should have received a copy of the GNU General Public License
 *     along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
use crate::utils::types::cpu_report::CPUBenchmarkReport;
use rumtk_core::buffers::*;
use rumtk_core::serde::{RUMDeJson, RUMSerJson};
use rumtk_core::strings::RUMString;
use rumtk_web::RUMWebTemplate;
use std::convert::{From, TryFrom};
use std::fmt::Debug;

mod meta;
mod basic_report;
mod flamegraph;
mod cpu_report;

pub use basic_report::*;
pub use flamegraph::*;
pub use meta::*;

type ReportRawResults<'a> = (MetaData, &'a RUMBuffer, &'a RUMBuffer, &'a RUMBuffer, &'a RUMBuffer, &'a RUMBuffer);

#[derive(Default, Debug, RUMDeJson, RUMSerJson, RUMWebTemplate)]
#[template(
    source = "
        <h1>META</h1>
        {{meta|safe}}
        <h1>BASIC</h1>
        {{report|safe}}
        {{visualization|safe}}
        <h1>CPU</h1>
        {{cpu_summary|safe}}
        {{cpu_performance|safe}}
        <h1>CACHE</h1>
        {{cpu_cache_details|safe}}
    ",
    ext = "html"
)]
pub struct BenchmarkReport {
    pub meta: BenchmarkMeta,
    pub report: BasicBenchmarkReport,
    pub visualization: FlamegraphBenchmarkVisualizer,
    pub cpu_summary: CPUBenchmarkReport,
    pub cpu_performance: CPUBenchmarkReport,
    pub cpu_cache_details: CPUBenchmarkReport,
}

impl<'a> TryFrom<ReportRawResults<'a>> for BenchmarkReport {
    type Error = RUMString;
    fn try_from(data: ReportRawResults) -> Result<Self, Self::Error>
    {
        let (cpu_info, raw_report, raw_visualization, cpu_summary, cpu_performance, cpu_cache_details) = data;
        let meta = BenchmarkMeta::try_from(cpu_info)?;
        let report = BasicBenchmarkReport::try_from(raw_report)?;
        let visualization = FlamegraphBenchmarkVisualizer::try_from(raw_visualization)?;
        let cpu_summary = CPUBenchmarkReport::try_from(cpu_summary)?;
        let cpu_performance = CPUBenchmarkReport::try_from(cpu_performance)?;
        let cpu_cache_details = CPUBenchmarkReport::try_from(cpu_cache_details)?;
        Ok(Self {
            meta,
            report,
            visualization,
            cpu_summary,
            cpu_performance,
            cpu_cache_details
        })
    }
}