AuroraMiddleware/glibc
1
0
Fork 0
mirror of https://sourceware.org/git/glibc.git synced 2024-12-02 09:40:13 +00:00
Code Issues Packages Projects Releases Wiki Activity
4e58941fc4
glibc/benchtests/scripts/plot_strings.py

396 lines
14 KiB
Python
Raw Normal View History

Add new script for plotting string benchmark JSON output Add a script for visualizing the JSON output generated by existing glibc string microbenchmarks. Overview: plot_strings.py is capable of plotting benchmark results in the following formats, which are controlled with the -p or --plot argument: 1. absolute timings (-p time): plot the timings as they are in the input benchmark results file. 2. relative timings (-p rel): plot relative timing difference with respect to a chosen ifunc (controlled with -b argument). 3. performance relative to max (-p max): for each varied parameter value, plot 1/timing as the percentage of the maximum value out of the plotted ifuncs. 4. throughput (-p thru): plot varied parameter value over timing For all types of graphs, there is an option to explicitly specify the subset of ifuncs to plot using the --ifuncs parameter. For plot types 1. and 4. one can hide/expose exact benchmark figures using the --values flag. When plotting relative timing differences between ifuncs, the first ifunc listed in the input JSON file is the baseline, unless the baseline implementation is explicitly chosen with the --baseline parameter. For the ease of reading, the script marks the statistically insignificant range on the graphs. The default is +-5% but this value can be controlled with the --threshold parameter. To accommodate for the heterogeneity in benchmark results files, one can control i.e the x-axis scale, the resolution (dpi) of the generated figures or the key to access the varied parameter value in the JSON file. The corresponding options are --logarithmic, --resolution or --key. The --key parameter ensures that plot_strings.py works with all files which pass JSON schema validation. The schema can be chosen with the --schema parameter. If a window manager is available, one can enable interactive figure display using the --display flag. Finally, one can use the --grid flag to enable grid lines in the generated figures. Implementation: plot_strings.py traverses the JSON tree until a 'results' array is found and generates a separate figure for each such array. The figure is then saved to a file in one of the available formats (controlled with the --extension parameter). As the tree is traversed, the recursive function tracks the metadata about the test being run, so that each figure has a unique and meaningful title and filename. While plot_strings.py works with existing benchmarks, provisions have been made to allow adding more structure and metadata to these benchmarks. Currently, many benchmarks produce multiple timing values for the same value of the varied parameter (typically 'length'). Mutiple data points for the same parameter usually mean that some other parameter was varied as well, for example, if memmove's src and dst buffers overlap or not (see bench-memmove-walk.c and bench-memmove-walk.out). Unfortunately, this information is not exposed in the benchmark output file, so plot_strings.py has to resort to computing the geometric mean of these multiple values. In the process, useful information about the benchmark configuration is lost. Also, averaging the timings for different alignments can hide useful characterstics of the benchmarked ifuncs. Testing: plot_strings.py has been tested on all existing string microbenchmarks which produce results in JSON format. The script was tested on both Windows 10 and Ubuntu 16.04.2 LTS. It runs on both python 2 and 3 (2.7.12 and 3.5.12 tested). Useful commands: 1. Plot timings for all ifuncs in bench-strlen.out: $ ./plot_strings.py bench-strlen.out 2. Display help: $ ./plot_strings.py -h 3. Plot throughput for __memset_avx512_unaligned_erms and __memset_avx512_unaligned. Save the generated figure in pdf format to 'results/'. Use logarithmic x-axis scale, show grid lines and expose the performance numbers: $ ./plot_strings.py bench.out -o results/ -lgv -e pdf -p thru \ -i __memset_avx512_unaligned_erms __memset_avx512_unaligned 4. Plot relative timings for all ifuncs in bench.out with __generic_memset as baseline. Display percentage difference threshold of +-10%: $ ./plot_strings.py bench.out -p rel -b __generic_memset -t 10 Discussion: 1. I would like to propose relaxing the benchout_strings.schema.json to allow specifying either a 'results' array with 'timings' (as before) or a 'variants' array. See below example: { "timing_type": "hp_timing", "functions": { "memcpy": { "bench-variant": "default", "ifuncs": ["generic_memcpy", "__memcpy_thunderx"], "variants": [ { "name": "powers of 2", "variants": [ { "name": "both aligned", "results": [ { "length": 1, "align1": 0, "align2": 0, "timings": [x, y] }, { "length": 2, "align1": 0, "align2": 0, "timings": [x, y] }, ... { "length": 65536, "align1": 0, "align2": 0, "timings": [x, y] }] }, { "name": "dst misaligned", "results": [ { "length": 1, "align1": 0, "align2": 0, "timings": [x, y] }, { "length": 2, "align1": 0, "align2": 1, "timings": [x, y] }, ... 'variants' array consists of objects such that each object has a 'name' attribute to describe the configuration of a particular test in the benchmark. This can be a description, for example, of how the parameter was varied or what was the buffer alignment tested. The 'name' attribute is then followed by another 'variants' array or a 'results' array. The nesting of variants allows arbitrary grouping of benchmark timings, while allowing description of these groups. Using recusion, it is possible to proceduraly create titles and filenames for the figures being generated.
2019-11-13 11:57:17 +00:00
#!/usr/bin/python3
# Plot GNU C Library string microbenchmark output.
Update copyright dates with scripts/update-copyrights.
2020-01-01 00:14:33 +00:00
# Copyright (C) 2019-2020 Free Software Foundation, Inc.
Add new script for plotting string benchmark JSON output Add a script for visualizing the JSON output generated by existing glibc string microbenchmarks. Overview: plot_strings.py is capable of plotting benchmark results in the following formats, which are controlled with the -p or --plot argument: 1. absolute timings (-p time): plot the timings as they are in the input benchmark results file. 2. relative timings (-p rel): plot relative timing difference with respect to a chosen ifunc (controlled with -b argument). 3. performance relative to max (-p max): for each varied parameter value, plot 1/timing as the percentage of the maximum value out of the plotted ifuncs. 4. throughput (-p thru): plot varied parameter value over timing For all types of graphs, there is an option to explicitly specify the subset of ifuncs to plot using the --ifuncs parameter. For plot types 1. and 4. one can hide/expose exact benchmark figures using the --values flag. When plotting relative timing differences between ifuncs, the first ifunc listed in the input JSON file is the baseline, unless the baseline implementation is explicitly chosen with the --baseline parameter. For the ease of reading, the script marks the statistically insignificant range on the graphs. The default is +-5% but this value can be controlled with the --threshold parameter. To accommodate for the heterogeneity in benchmark results files, one can control i.e the x-axis scale, the resolution (dpi) of the generated figures or the key to access the varied parameter value in the JSON file. The corresponding options are --logarithmic, --resolution or --key. The --key parameter ensures that plot_strings.py works with all files which pass JSON schema validation. The schema can be chosen with the --schema parameter. If a window manager is available, one can enable interactive figure display using the --display flag. Finally, one can use the --grid flag to enable grid lines in the generated figures. Implementation: plot_strings.py traverses the JSON tree until a 'results' array is found and generates a separate figure for each such array. The figure is then saved to a file in one of the available formats (controlled with the --extension parameter). As the tree is traversed, the recursive function tracks the metadata about the test being run, so that each figure has a unique and meaningful title and filename. While plot_strings.py works with existing benchmarks, provisions have been made to allow adding more structure and metadata to these benchmarks. Currently, many benchmarks produce multiple timing values for the same value of the varied parameter (typically 'length'). Mutiple data points for the same parameter usually mean that some other parameter was varied as well, for example, if memmove's src and dst buffers overlap or not (see bench-memmove-walk.c and bench-memmove-walk.out). Unfortunately, this information is not exposed in the benchmark output file, so plot_strings.py has to resort to computing the geometric mean of these multiple values. In the process, useful information about the benchmark configuration is lost. Also, averaging the timings for different alignments can hide useful characterstics of the benchmarked ifuncs. Testing: plot_strings.py has been tested on all existing string microbenchmarks which produce results in JSON format. The script was tested on both Windows 10 and Ubuntu 16.04.2 LTS. It runs on both python 2 and 3 (2.7.12 and 3.5.12 tested). Useful commands: 1. Plot timings for all ifuncs in bench-strlen.out: $ ./plot_strings.py bench-strlen.out 2. Display help: $ ./plot_strings.py -h 3. Plot throughput for __memset_avx512_unaligned_erms and __memset_avx512_unaligned. Save the generated figure in pdf format to 'results/'. Use logarithmic x-axis scale, show grid lines and expose the performance numbers: $ ./plot_strings.py bench.out -o results/ -lgv -e pdf -p thru \ -i __memset_avx512_unaligned_erms __memset_avx512_unaligned 4. Plot relative timings for all ifuncs in bench.out with __generic_memset as baseline. Display percentage difference threshold of +-10%: $ ./plot_strings.py bench.out -p rel -b __generic_memset -t 10 Discussion: 1. I would like to propose relaxing the benchout_strings.schema.json to allow specifying either a 'results' array with 'timings' (as before) or a 'variants' array. See below example: { "timing_type": "hp_timing", "functions": { "memcpy": { "bench-variant": "default", "ifuncs": ["generic_memcpy", "__memcpy_thunderx"], "variants": [ { "name": "powers of 2", "variants": [ { "name": "both aligned", "results": [ { "length": 1, "align1": 0, "align2": 0, "timings": [x, y] }, { "length": 2, "align1": 0, "align2": 0, "timings": [x, y] }, ... { "length": 65536, "align1": 0, "align2": 0, "timings": [x, y] }] }, { "name": "dst misaligned", "results": [ { "length": 1, "align1": 0, "align2": 0, "timings": [x, y] }, { "length": 2, "align1": 0, "align2": 1, "timings": [x, y] }, ... 'variants' array consists of objects such that each object has a 'name' attribute to describe the configuration of a particular test in the benchmark. This can be a description, for example, of how the parameter was varied or what was the buffer alignment tested. The 'name' attribute is then followed by another 'variants' array or a 'results' array. The nesting of variants allows arbitrary grouping of benchmark timings, while allowing description of these groups. Using recusion, it is possible to proceduraly create titles and filenames for the figures being generated.
2019-11-13 11:57:17 +00:00
# This file is part of the GNU C Library.
#
# The GNU C Library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# The GNU C Library 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
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with the GNU C Library; if not, see
# <https://www.gnu.org/licenses/>.
"""Plot string microbenchmark results.
Given a benchmark results file in JSON format and a benchmark schema file,
plot the benchmark timings in one of the available representations.
Separate figure is generated and saved to a file for each 'results' array
found in the benchmark results file. Output filenames and plot titles
are derived from the metadata found in the benchmark results file.
"""
import argparse
from collections import defaultdict
import json
import matplotlib as mpl
import numpy as np
import os
try:
import jsonschema as validator
except ImportError:
print("Could not find jsonschema module.")
raise
# Use pre-selected markers for plotting lines to improve readability
markers = [".", "x", "^", "+", "*", "v", "1", ">", "s"]
# Benchmark variants for which the x-axis scale should be logarithmic
log_variants = {"powers of 2"}
def gmean(numbers):
"""Compute geometric mean.
Args:
numbers: 2-D list of numbers
Return:
numpy array with geometric means of numbers along each column
"""
a = np.array(numbers, dtype=np.complex)
means = a.prod(0) ** (1.0 / len(a))
return np.real(means)
def relativeDifference(x, x_reference):
"""Compute per-element relative difference between each row of
a matrix and an array of reference values.
Args:
x: numpy matrix of shape (n, m)
x_reference: numpy array of size m
Return:
relative difference between rows of x and x_reference (in %)
"""
abs_diff = np.subtract(x, x_reference)
return np.divide(np.multiply(abs_diff, 100.0), x_reference)
def plotTime(timings, routine, bench_variant, title, outpath):
"""Plot absolute timing values.
Args:
timings: timings to plot
routine: benchmarked string routine name
bench_variant: top-level benchmark variant name
title: figure title (generated so far)
outpath: output file path (generated so far)
Return:
y: y-axis values to plot
title_final: final figure title
outpath_final: file output file path
"""
y = timings
plt.figure()
if not args.values:
plt.axes().yaxis.set_major_formatter(plt.NullFormatter())
plt.ylabel("timing")
title_final = "%s %s benchmark timings\n%s" % \
(routine, bench_variant, title)
outpath_final = os.path.join(args.outdir, "%s_%s_%s%s" % \
(routine, args.plot, bench_variant, outpath))
return y, title_final, outpath_final
def plotRelative(timings, all_timings, routine, ifuncs, bench_variant,
title, outpath):
"""Plot timing values relative to a chosen ifunc
Args:
timings: timings to plot
all_timings: all collected timings
routine: benchmarked string routine name
ifuncs: names of ifuncs tested
bench_variant: top-level benchmark variant name
title: figure title (generated so far)
outpath: output file path (generated so far)
Return:
y: y-axis values to plot
title_final: final figure title
outpath_final: file output file path
"""
# Choose the baseline ifunc
if args.baseline:
baseline = args.baseline.replace("__", "")
else:
baseline = ifuncs[0]
baseline_index = ifuncs.index(baseline)
# Compare timings against the baseline
y = relativeDifference(timings, all_timings[baseline_index])
plt.figure()
plt.axhspan(-args.threshold, args.threshold, color="lightgray", alpha=0.3)
plt.axhline(0, color="k", linestyle="--", linewidth=0.4)
plt.ylabel("relative timing (in %)")
title_final = "Timing comparison against %s\nfor %s benchmark, %s" % \
(baseline, bench_variant, title)
outpath_final = os.path.join(args.outdir, "%s_%s_%s%s" % \
(baseline, args.plot, bench_variant, outpath))
return y, title_final, outpath_final
def plotMax(timings, routine, bench_variant, title, outpath):
"""Plot results as percentage of the maximum ifunc performance.
The optimal ifunc is computed on a per-parameter-value basis.
Performance is computed as 1/timing.
Args:
timings: timings to plot
routine: benchmarked string routine name
bench_variant: top-level benchmark variant name
title: figure title (generated so far)
outpath: output file path (generated so far)
Return:
y: y-axis values to plot
title_final: final figure title
outpath_final: file output file path
"""
perf = np.reciprocal(timings)
max_perf = np.max(perf, axis=0)
y = np.add(100.0, relativeDifference(perf, max_perf))
plt.figure()
plt.axhline(100.0, color="k", linestyle="--", linewidth=0.4)
plt.ylabel("1/timing relative to max (in %)")
title_final = "Performance comparison against max for %s\n%s " \
"benchmark, %s" % (routine, bench_variant, title)
outpath_final = os.path.join(args.outdir, "%s_%s_%s%s" % \
(routine, args.plot, bench_variant, outpath))
return y, title_final, outpath_final
def plotThroughput(timings, params, routine, bench_variant, title, outpath):
"""Plot throughput.
Throughput is computed as the varied parameter value over timing.
Args:
timings: timings to plot
params: varied parameter values
routine: benchmarked string routine name
bench_variant: top-level benchmark variant name
title: figure title (generated so far)
outpath: output file path (generated so far)
Return:
y: y-axis values to plot
title_final: final figure title
outpath_final: file output file path
"""
y = np.divide(params, timings)
plt.figure()
if not args.values:
plt.axes().yaxis.set_major_formatter(plt.NullFormatter())
plt.ylabel("%s / timing" % args.key)
title_final = "%s %s benchmark throughput results\n%s" % \
(routine, bench_variant, title)
outpath_final = os.path.join(args.outdir, "%s_%s_%s%s" % \
(routine, args.plot, bench_variant, outpath))
return y, title_final, outpath_final
def finishPlot(x, y, title, outpath, x_scale, plotted_ifuncs):
"""Finish generating current Figure.
Args:
x: x-axis values
y: y-axis values
title: figure title
outpath: output file path
x_scale: x-axis scale
plotted_ifuncs: names of ifuncs to plot
"""
plt.xlabel(args.key)
plt.xscale(x_scale)
plt.title(title)
plt.grid(color="k", linestyle=args.grid, linewidth=0.5, alpha=0.5)
for i in range(len(plotted_ifuncs)):
plt.plot(x, y[i], marker=markers[i % len(markers)],
label=plotted_ifuncs[i])
plt.legend(loc="best", fontsize="small")
plt.savefig("%s_%s.%s" % (outpath, x_scale, args.extension),
format=args.extension, dpi=args.resolution)
if args.display:
plt.show()
plt.close()
def plotRecursive(json_iter, routine, ifuncs, bench_variant, title, outpath,
x_scale):
"""Plot benchmark timings.
Args:
json_iter: reference to json object
routine: benchmarked string routine name
ifuncs: names of ifuncs tested
bench_variant: top-level benchmark variant name
title: figure's title (generated so far)
outpath: output file path (generated so far)
x_scale: x-axis scale
"""
# RECURSIVE CASE: 'variants' array found
if "variants" in json_iter:
# Continue recursive search for 'results' array. Record the
# benchmark variant (configuration) in order to customize
# the title, filename and X-axis scale for the generated figure.
for variant in json_iter["variants"]:
new_title = "%s%s, " % (title, variant["name"])
new_outpath = "%s_%s" % (outpath, variant["name"].replace(" ", "_"))
new_x_scale = "log" if variant["name"] in log_variants else x_scale
plotRecursive(variant, routine, ifuncs, bench_variant, new_title,
new_outpath, new_x_scale)
return
# BASE CASE: 'results' array found
domain = []
timings = defaultdict(list)
# Collect timings
for result in json_iter["results"]:
domain.append(result[args.key])
timings[result[args.key]].append(result["timings"])
domain = np.unique(np.array(domain))
averages = []
# Compute geometric mean if there are multple timings for each
# parameter value.
for parameter in domain:
averages.append(gmean(timings[parameter]))
averages = np.array(averages).transpose()
# Choose ifuncs to plot
if isinstance(args.ifuncs, str):
plotted_ifuncs = ifuncs
else:
plotted_ifuncs = [x.replace("__", "") for x in args.ifuncs]
plotted_indices = [ifuncs.index(x) for x in plotted_ifuncs]
plotted_vals = averages[plotted_indices,:]
# Plotting logic specific to each plot type
if args.plot == "time":
codomain, title, outpath = plotTime(plotted_vals, routine,
bench_variant, title, outpath)
elif args.plot == "rel":
codomain, title, outpath = plotRelative(plotted_vals, averages, routine,
ifuncs, bench_variant, title, outpath)
elif args.plot == "max":
codomain, title, outpath = plotMax(plotted_vals, routine,
bench_variant, title, outpath)
elif args.plot == "thru":
codomain, title, outpath = plotThroughput(plotted_vals, domain, routine,
bench_variant, title, outpath)
# Plotting logic shared between plot types
finishPlot(domain, codomain, title, outpath, x_scale, plotted_ifuncs)
def main(args):
"""Program Entry Point.
Args:
args: command line arguments (excluding program name)
"""
# Select non-GUI matplotlib backend if interactive display is disabled
if not args.display:
mpl.use("Agg")
global plt
import matplotlib.pyplot as plt
schema = None
with open(args.schema, "r") as f:
schema = json.load(f)
for filename in args.bench:
bench = None
with open(filename, "r") as f:
bench = json.load(f)
validator.validate(bench, schema)
for function in bench["functions"]:
bench_variant = bench["functions"][function]["bench-variant"]
ifuncs = bench["functions"][function]["ifuncs"]
ifuncs = [x.replace("__", "") for x in ifuncs]
plotRecursive(bench["functions"][function], function, ifuncs,
bench_variant, "", "", args.logarithmic)
""" main() """
if __name__ == "__main__":
parser = argparse.ArgumentParser(description=
"Plot string microbenchmark results",
formatter_class=argparse.ArgumentDefaultsHelpFormatter)
# Required parameter
parser.add_argument("bench", nargs="+",
help="benchmark results file(s) in json format")
# Optional parameters
parser.add_argument("-b", "--baseline", type=str,
help="baseline ifunc for 'rel' plot")
parser.add_argument("-d", "--display", action="store_true",
help="display figures")
parser.add_argument("-e", "--extension", type=str, default="png",
choices=["png", "pdf", "svg"],
help="output file(s) extension")
parser.add_argument("-g", "--grid", action="store_const", default="",
const="-", help="show grid lines")
parser.add_argument("-i", "--ifuncs", nargs="+", default="all",
help="ifuncs to plot")
parser.add_argument("-k", "--key", type=str, default="length",
help="key to access the varied parameter")
parser.add_argument("-l", "--logarithmic", action="store_const",
default="linear", const="log",
help="use logarithmic x-axis scale")
parser.add_argument("-o", "--outdir", type=str, default=os.getcwd(),
help="output directory")
parser.add_argument("-p", "--plot", type=str, default="time",
choices=["time", "rel", "max", "thru"],
help="plot absolute timings, relative timings, " \
"performance relative to max, or throughput")
parser.add_argument("-r", "--resolution", type=int, default=100,
help="dpi resolution for the generated figures")
parser.add_argument("-s", "--schema", type=str,
default=os.path.join(os.path.dirname(
os.path.realpath(__file__)),
"benchout_strings.schema.json"),
help="schema file to validate the results file.")
parser.add_argument("-t", "--threshold", type=int, default=5,
help="threshold to mark in 'rel' graph (in %%)")
parser.add_argument("-v", "--values", action="store_true",
help="show actual values")
args = parser.parse_args()
main(args)
Reference in New Issue Copy Permalink