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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134

// This file is part of Substrate.

// Copyright (C) 2022 Parity Technologies (UK) Ltd.
// SPDX-License-Identifier: Apache-2.0

// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! Code that is shared among all benchmarking sub-commands.

pub mod record;
pub mod stats;
pub mod weight_params;

pub use record::BenchRecord;
pub use stats::{StatSelect, Stats};
pub use weight_params::WeightParams;

use clap::Args;
use rand::prelude::*;
use sc_sysinfo::gather_sysinfo;
use serde::Serialize;

/// A Handlebars helper to add an underscore after every 3rd character,
/// i.e. a separator for large numbers.
#[derive(Clone, Copy)]
pub struct UnderscoreHelper;

impl handlebars::HelperDef for UnderscoreHelper {
	fn call<'reg: 'rc, 'rc>(
		&self,
		h: &handlebars::Helper,
		_: &handlebars::Handlebars,
		_: &handlebars::Context,
		_rc: &mut handlebars::RenderContext,
		out: &mut dyn handlebars::Output,
	) -> handlebars::HelperResult {
		use handlebars::JsonRender;
		let param = h.param(0).unwrap();
		let underscore_param = underscore(param.value().render());
		out.write(&underscore_param)?;
		Ok(())
	}
}

/// Add an underscore after every 3rd character, i.e. a separator for large numbers.
fn underscore<Number>(i: Number) -> String
where
	Number: std::string::ToString,
{
	let mut s = String::new();
	let i_str = i.to_string();
	let a = i_str.chars().rev().enumerate();
	for (idx, val) in a {
		if idx != 0 && idx % 3 == 0 {
			s.insert(0, '_');
		}
		s.insert(0, val);
	}
	s
}

/// Returns an rng and the seed that was used to create it.
///
/// Uses a random seed if none is provided.
pub fn new_rng(seed: Option<u64>) -> (impl rand::Rng, u64) {
	let seed = seed.unwrap_or(rand::thread_rng().gen::<u64>());
	(rand_pcg::Pcg64::seed_from_u64(seed), seed)
}

/// Returns an error if a debug profile is detected.
///
/// The rust compiler only exposes the binary information whether
/// or not we are in a `debug` build.
/// This means that `release` and `production` cannot be told apart.
/// This function additionally checks for OPT-LEVEL = 3.
pub fn check_build_profile() -> Result<(), String> {
	if cfg!(build_profile = "debug") {
		Err("Detected a `debug` profile".into())
	} else if !cfg!(build_opt_level = "3") {
		Err("The optimization level is not set to 3".into())
	} else {
		Ok(())
	}
}

/// Parameters to configure how the host info will be determined.
#[derive(Debug, Default, Serialize, Clone, PartialEq, Args)]
#[command(rename_all = "kebab-case")]
pub struct HostInfoParams {
	/// Manually override the hostname to use.
	#[arg(long)]
	pub hostname_override: Option<String>,

	/// Specify a fallback hostname if no-one could be detected automatically.
	///
	/// Note: This only exists to make the `hostname` function infallible.
	#[arg(long, default_value = "<UNKNOWN>")]
	pub hostname_fallback: String,

	/// Specify a fallback CPU name if no-one could be detected automatically.
	///
	/// Note: This only exists to make the `cpuname` function infallible.
	#[arg(long, default_value = "<UNKNOWN>")]
	pub cpuname_fallback: String,
}

impl HostInfoParams {
	/// Returns the hostname of the machine.
	///
	/// Can be used to track on which machine a benchmark was run.
	pub fn hostname(&self) -> String {
		self.hostname_override
			.clone()
			.or(gethostname::gethostname().into_string().ok())
			.unwrap_or(self.hostname_fallback.clone())
	}

	/// Returns the CPU name of the current machine.
	///
	/// Can be used to track on which machine a benchmark was run.
	pub fn cpuname(&self) -> String {
		gather_sysinfo().cpu.unwrap_or(self.cpuname_fallback.clone())
	}
}