summaryrefslogtreecommitdiff
path: root/benchtests
diff options
context:
space:
mode:
authorSiddhesh Poyarekar <siddhesh@redhat.com>2014-06-11 14:16:29 +0530
committerSiddhesh Poyarekar <siddhesh@redhat.com>2014-06-11 14:16:29 +0530
commit42b1161e8c45df468d1696b43a7820c3ffe29da1 (patch)
tree9f736456fa4b53ccb02b0f9459141f23d31f7db2 /benchtests
parent4a594c34356b1ae90b69f359fa95e9c4ad8d8694 (diff)
downloadglibc-42b1161e8c45df468d1696b43a7820c3ffe29da1.tar.gz
Validate bench.out against a JSON schema
This patch adds a JSON schema for the benchmark output file and also adds a script that validates the generated output against the schema.
Diffstat (limited to 'benchtests')
-rw-r--r--benchtests/Makefile2
-rw-r--r--benchtests/scripts/benchout.schema.json42
-rwxr-xr-xbenchtests/scripts/validate_benchout.py85
3 files changed, 129 insertions, 0 deletions
diff --git a/benchtests/Makefile b/benchtests/Makefile
index fbcee1328b..dc9ee043d6 100644
--- a/benchtests/Makefile
+++ b/benchtests/Makefile
@@ -131,6 +131,8 @@ bench-func: $(binaries-bench)
mv -f $(objpfx)bench.out $(objpfx)bench.out.old; \
fi; \
mv -f $(objpfx)bench.out-tmp $(objpfx)bench.out
+ scripts/validate_benchout.py $(objpfx)bench.out \
+ scripts/benchout.schema.json
$(timing-type) $(binaries-bench) $(binaries-benchset): %: %.o $(objpfx)json-lib.o \
$(sort $(filter $(common-objpfx)lib%,$(link-libc))) \
diff --git a/benchtests/scripts/benchout.schema.json b/benchtests/scripts/benchout.schema.json
new file mode 100644
index 0000000000..affb7c11f4
--- /dev/null
+++ b/benchtests/scripts/benchout.schema.json
@@ -0,0 +1,42 @@
+{
+ "title": "benchmark",
+ "type": "object",
+ "properties": {
+ "timing_type": {
+ "type": "string"
+ },
+ "functions": {
+ "title": "Associative array of functions",
+ "type": "object",
+ "patternProperties": {
+ "^[_a-zA-Z][_a-zA-Z0-9]+$": {
+ "title": "Function names",
+ "type": "object",
+ "patternProperties": {
+ "^[_a-zA-Z0-9]*$": {
+ "title": "Function variants",
+ "type": "object",
+ "properties": {
+ "duration": {"type": "number"},
+ "iterations": {"type": "number"},
+ "max": {"type": "number"},
+ "min": {"type": "number"},
+ "mean": {"type": "number"},
+ "timings": {
+ "type": "array",
+ "items": {"type": "number"}
+ }
+ },
+ "required": ["duration", "iterations", "max", "min", "mean"],
+ "additionalProperties": false
+ }
+ },
+ "additionalProperties": false
+ }
+ },
+ "minProperties": 1
+ }
+ },
+ "required": ["timing_type", "functions"],
+ "additionalProperties": false
+}
diff --git a/benchtests/scripts/validate_benchout.py b/benchtests/scripts/validate_benchout.py
new file mode 100755
index 0000000000..61a8cbd5d3
--- /dev/null
+++ b/benchtests/scripts/validate_benchout.py
@@ -0,0 +1,85 @@
+#!/usr/bin/python
+# Copyright (C) 2014 Free Software Foundation, Inc.
+# 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
+# <http://www.gnu.org/licenses/>.
+"""Benchmark output validator
+
+Given a benchmark output file in json format and a benchmark schema file,
+validate the output against the schema.
+"""
+
+from __future__ import print_function
+import json
+import sys
+import os
+
+try:
+ import jsonschema
+except ImportError:
+ print('Could not find jsonschema module. Output not validated.')
+ # Return success because we don't want the bench target to fail just
+ # because the jsonschema module was not found.
+ sys.exit(os.EX_OK)
+
+
+def validate_bench(benchfile, schemafile):
+ """Validate benchmark file
+
+ Validate a benchmark output file against a JSON schema.
+
+ Args:
+ benchfile: The file name of the bench.out file.
+ schemafile: The file name of the JSON schema file to validate
+ bench.out against.
+
+ Exceptions:
+ jsonschema.ValidationError: When bench.out is not valid
+ jsonschema.SchemaError: When the JSON schema is not valid
+ IOError: If any of the files are not found.
+ """
+ with open(benchfile, 'r') as bfile:
+ with open(schemafile, 'r') as sfile:
+ bench = json.load(bfile)
+ schema = json.load(sfile)
+ jsonschema.validate(bench, schema)
+
+ # If we reach here, we're all good.
+ print("Benchmark output in %s is valid." % benchfile)
+
+
+def main(args):
+ """Main entry point
+
+ Args:
+ args: The command line arguments to the program
+
+ Returns:
+ 0 on success or a non-zero failure code
+
+ Exceptions:
+ Exceptions thrown by validate_bench
+ """
+ if len(args) != 2:
+ print("Usage: %s <bench.out file> <bench.out schema>" % sys.argv[0],
+ file=sys.stderr)
+ return os.EX_USAGE
+
+ validate_bench(args[0], args[1])
+ return os.EX_OK
+
+
+if __name__ == '__main__':
+ sys.exit(main(sys.argv[1:]))