OILS / benchmarks / common.sh View on Github | oilshell.org

100 lines, 50 significant
1#!/usr/bin/env bash
2#
3# Common functions for benchmarks.
4#
5
6# Include guard.
7test -n "${__BENCHMARKS_COMMON_SH:-}" && return
8readonly __BENCHMARKS_COMMON_SH=1
9
10#readonly MACHINE1=flanders
11#readonly MACHINE2=lenny
12
13# 2023-11-29: machine1 is still lenny because it has bloaty, which doesn't
14# work with ELF data emitted by newer GCC on Debian 12
15readonly MACHINE1=lenny
16readonly MACHINE2=hoover
17
18OIL_VERSION=$(head -n 1 oil-version.txt)
19
20# Used by devtools/release.sh
21readonly BENCHMARK_DATA_OILS=$PWD/../benchmark-data/src/oils-for-unix-$OIL_VERSION
22
23readonly OSH_CPP_NINJA_BUILD=_bin/cxx-opt/osh
24
25readonly OSH_CPP_SH_BUILD=_bin/cxx-opt-sh/osh
26readonly YSH_CPP_SH_BUILD=_bin/cxx-opt-sh/ysh
27
28readonly OSH_CPP_BENCHMARK_DATA=$BENCHMARK_DATA_OILS/$OSH_CPP_SH_BUILD
29readonly YSH_CPP_BENCHMARK_DATA=$BENCHMARK_DATA_OILS/$YSH_CPP_SH_BUILD
30
31#
32# Binaries we want to test, which can be overridden
33#
34
35OSH_OVM=${OSH_OVM:-_bin/osh} # This is overridden by devtools/release.sh.
36
37readonly OTHER_SHELLS=( bash dash mksh zsh )
38readonly SHELLS=( ${OTHER_SHELLS[@]} bin/osh $OSH_OVM )
39
40# Passed to awk in filter-provenance. TODO: This could be a parameter
41# Awk wants this to be \\. ? Probably should stop using Awk.
42readonly OSH_CPP_REGEX='_bin/.*/osh'
43
44# NOTE: This is in {build,test}/common.sh too.
45die() {
46 echo "FATAL: $@" 1>&2
47 exit 1
48}
49
50log() {
51 echo "$@" 1>&2
52}
53
54cmark() {
55 # A filter to making reports
56 PYTHONPATH=. doctools/cmark.py "$@"
57}
58
59# For compatibility, if cell starts with 'osh', apply the 'special' CSS class.
60csv2html() {
61 web/table/csv2html.py --css-class-pattern 'special ^osh' "$@"
62}
63
64# also in metrics/source-code.sh
65hist() { sort | uniq -c | sort -n; }
66
67html-head() {
68 PYTHONPATH=. doctools/html_head.py "$@"
69}
70
71benchmark-html-head() {
72 local title="$1"
73
74 local base_url='../../web'
75
76 html-head --title "$title" \
77 "$base_url/table/table-sort.js" \
78 "$base_url/table/table-sort.css" \
79 "$base_url/base.css"\
80 "$base_url/benchmarks.css"
81}
82
83filter-provenance() {
84 # create a regex bash|dash
85 local pat=$(echo "$@" | sed 's/ /|/g')
86
87 # Anchor it at the end only. For _bin/cxx-opt/oils-for-unix.stripped and the
88 # ../benchmark-data one.
89 pat="($pat)\$"
90
91 # 4th column is the shell
92 awk -v pat="$pat" '$4 ~ pat { print }'
93}
94
95maybe-tree() {
96 ### Run tree command if it's installed
97 if command -v tree; then
98 tree "$@"
99 fi
100}