PBE-START(1)

🦋 PBE-START(1) 🦋

okay so bestie, this is the PBE manual, section 1, and today's episode is all about the start command 💅 she's the one who kicks off the whole measuring party, so let's get into it fr fr ✨

🎀 COMMAND 'pbe start' 🎀

here's how you call her:

pbe start [-h] [-q] [-d] [-H HOSTNAME] [-U USERNAME] [-K PRIVKEY]
[-T TIMEOUT] [-l LDIST] [-S LDIST_STEP] [--span SPAN] [--warmup WARMUP]
[-o OUTDIR] [--reportid REPORTID] [--report]

and what does she do? she starts measuring C-states power break even. that's the whole vibe. periodt 🔥

✨ OPTIONS 'pbe start' ✨

• -h — shows you this help message and then dips out. the classic "tell me what's up" move 🫶
• -q — be quiet. shhh, no chatter, just vibes 🤫
• -d — print debugging information. when you need the tea, she spills it 💀
• -H HOSTNAME, --host HOSTNAME — the name of the host you wanna run the command on.
• -U USERNAME, --username USERNAME — the user name to use when logging into the remote host over SSH. the default user name is 'root' 👑
• -K PRIVKEY, --priv-key PRIVKEY — the path to the private SSH key that should be used for logging into the remote host. by default the key is automatically found from standard paths like '~/.ssh' 🔑
• -T TIMEOUT, --timeout TIMEOUT — SSH connect timeout, in seconds. default is 8. not too patient, not too rushed, lowkey perfect ⏱️
• -w LDIST, --ldist LDIST — the launch distance range to go through. the default range is [10us,10ms], but you can override it with this option by specifying a comma-separated range. the default unit is microseconds, but you can use the following specifiers as well: ms - milliseconds, us -microseconds, ns - nanoseconds. for example, '--ldist 20us,1ms' would be a [20,1000] microseconds range. slay 🌈
• -S LDIST_STEP, --ldist-step LDIST_STEP — the launch distance step. by default it's 1%. you can specify a percent value or an absolute time value. in the latter case, you can use one of the following specifiers: ms - milliseconds, us - microseconds, ns - nanoseconds. for example, '--ldist-step=1ms' means that launch distance will be incremented by 1 millisecond on every iteration. if no unit was specified, microseconds are assumed. cute ✨
• --span SPAN — for how long a single launch distance value should be measured. by default, it's 1 minute. specify the time value in minutes, or use one of the following specifiers: d - days, h - hours, m - minutes, s -seconds. she'll hold that pose for as long as you say 💅
• --warmup WARMUP — when this tool starts measuring a new launch distance value, first it lets the system "warm up" for some amount of time, and starts collecting the data (e.g., power) only after the warm up period. this allows the system to get into the "steady state" (e.g., fans speed and CPU temperature stabilizes). by default, the warm up period is 1 minute. specify a value in minutes, or use one of the following specifiers: d - days, h - hours, m - minutes, s - seconds. honestly? self-care 🌸
• -o OUTDIR, --outdir OUTDIR — the path to the directory where the results get stored. put it somewhere cute 🎀
• --stats STATS — a comma-separated list of statistics to collect. the statistics are collected in parallel with power break-even data collection. they are stored in the the "stats" sub-directory of the output directory. by default, only 'turbostat, sysinfo' statistics are collected. use 'all' to collect all possible statistics. use '--stats=""' or '--stats="none"' to disable statistics collection. if you know exactly what statistics you need, specify the comma-separated list of statistics to collect. for example, use 'turbostat,acpower' if you need only turbostat and AC power meter statistics. you can also specify the statistics you do not want to be collected by pre-pending the '!' symbol. for example, 'all,!turbostat' would mean: collect all the statistics supported by the SUT, except for 'turbostat'. use the '--list-stats' option to get more information about available statistics. it's giving full control, no cap 💜
• --stats-intervals STATS_INTERVALS — the intervals for statistics. statistics collection is based on doing periodic snapshots of data. for example, by default the 'acpower' statistics collector reads SUT power consumption for the last second every second, and 'turbostat' default interval is 5 seconds. use 'acpower:5,turbostat:10' to increase the intervals to 5 and 10 seconds correspondingly. use the '--list-stats' to get the default interval values. clock management icon behavior ⏰
• --list-stats — prints information about the statistics pbe can collect and then exits. the "just show me the menu" option 🍓
• --reportid REPORTID — any string which may serve as an identifier of this run. by default report ID is the current date, prefixed with the remote host name in case the '-H' option was used: [hostname-]YYYYMMDD. for example, "20150323" is a report ID for a run made on March 23, 2015. the allowed characters are: ACSII alphanumeric, '-', '.', ',', '_', '~', and ':'. name your run like it's your burner account 😭
• --report — generate an HTML report for collected results (same as calling 'report' command with default arguments). the glow-up at the end 💖
• --lead-cpu — the lead CPU. this is the CPU that will set timers and send interrupts to all other CPUs to wake them when the timers expire. the default is CPU 0. she's the main character, everyone else is the supporting cast 👑

fr fr bestie, that's every single one — don't come for me saying I skipped one, I would never 🙈

and that's the whole page, we ate and left no crumbs 🫶 the source/version footer says PBE() and it's dated 2024-05-28 — so like, write that down in your notes app. mwah 💋