blob: 5a88f93ac3e7a075e541aac5abf3d096203b968b [file] [log] [blame]
#!/usr/bin/env python
# Copyright 2020 Google LLC
#
# This source code is licensed under the BSD-style license found in the
# LICENSE file in the root directory of this source tree.
import argparse
import codecs
import math
import os
import re
import sys
import yaml
sys.path.insert(0, os.path.dirname(os.path.abspath(__file__)))
import xngen
import xnncommon
parser = argparse.ArgumentParser(
description='Clamp microkernel test generator')
parser.add_argument("-s", "--spec", metavar="FILE", required=True,
help="Specification (YAML) file")
parser.add_argument("-o", "--output", metavar="FILE", required=True,
help='Output (C++ source) file')
parser.set_defaults(defines=list())
def split_ukernel_name(name):
match = re.match(r"^xnn_(u8|f16|f32)_clamp_ukernel__(.+)_x(\d+)$", name)
if match is None:
raise ValueError("Unexpected microkernel name: " + name)
batch_tile = int(match.group(3))
arch, isa = xnncommon.parse_target_name(target_name=match.group(2))
return batch_tile, arch, isa
CLAMP_TEST_TEMPLATE = """\
TEST(${TEST_NAME}, batch_eq_${BATCH_TILE}) {
$if ISA_CHECK:
${ISA_CHECK};
ClampMicrokernelTester()
.batch_size(${BATCH_TILE})
.Test(${", ".join(TEST_ARGS)});
}
$if BATCH_TILE > 1:
TEST(${TEST_NAME}, batch_div_${BATCH_TILE}) {
$if ISA_CHECK:
${ISA_CHECK};
for (size_t batch_size = ${BATCH_TILE*2}; batch_size < ${BATCH_TILE*10}; batch_size += ${BATCH_TILE}) {
ClampMicrokernelTester()
.batch_size(batch_size)
.Test(${", ".join(TEST_ARGS)});
}
}
TEST(${TEST_NAME}, batch_lt_${BATCH_TILE}) {
$if ISA_CHECK:
${ISA_CHECK};
for (size_t batch_size = 1; batch_size < ${BATCH_TILE}; batch_size++) {
ClampMicrokernelTester()
.batch_size(batch_size)
.Test(${", ".join(TEST_ARGS)});
}
}
TEST(${TEST_NAME}, batch_gt_${BATCH_TILE}) {
$if ISA_CHECK:
${ISA_CHECK};
for (size_t batch_size = ${BATCH_TILE+1}; batch_size < ${10 if BATCH_TILE == 1 else BATCH_TILE*2}; batch_size++) {
ClampMicrokernelTester()
.batch_size(batch_size)
.Test(${", ".join(TEST_ARGS)});
}
}
TEST(${TEST_NAME}, inplace) {
$if ISA_CHECK:
${ISA_CHECK};
for (size_t batch_size = 1; batch_size <= ${BATCH_TILE*5}; batch_size += ${max(1, BATCH_TILE-1)}) {
ClampMicrokernelTester()
.batch_size(batch_size)
.inplace(true)
.Test(${", ".join(TEST_ARGS)});
}
}
TEST(${TEST_NAME}, qmin) {
$if ISA_CHECK:
${ISA_CHECK};
for (size_t batch_size = 1; batch_size <= ${BATCH_TILE*5}; batch_size += ${max(1, BATCH_TILE-1)}) {
for (uint8_t qmin = 1; qmin < 255; qmin++) {
ClampMicrokernelTester()
.batch_size(batch_size)
.qmin(qmin)
.qmax(255)
.Test(${", ".join(TEST_ARGS)});
}
}
}
TEST(${TEST_NAME}, qmax) {
$if ISA_CHECK:
${ISA_CHECK};
for (size_t batch_size = 1; batch_size <= ${BATCH_TILE*5}; batch_size += ${max(1, BATCH_TILE-1)}) {
for (uint8_t qmax = 1; qmax < 255; qmax++) {
ClampMicrokernelTester()
.batch_size(batch_size)
.qmin(0)
.qmax(qmax)
.Test(${", ".join(TEST_ARGS)});
}
}
}
"""
def generate_test_cases(ukernel, batch_tile, isa):
"""Generates all tests cases for a Clamp micro-kernel.
Args:
ukernel: C name of the micro-kernel function.
batch_tile: Number of batch elements processed per one iteration of the
inner loop of the micro-kernel.
isa: instruction set required to run the micro-kernel. Generated unit test
will skip execution if the host processor doesn't support this ISA.
Returns:
Code for the test case.
"""
_, test_name = ukernel.split("_", 1)
_, datatype, _ = ukernel.split("_", 2)
test_args = [ukernel]
if not isa:
test_args.append("ClampMicrokernelTester::Variant::Scalar")
return xngen.preprocess(CLAMP_TEST_TEMPLATE, {
"TEST_NAME": test_name.upper().replace("UKERNEL_", ""),
"TEST_ARGS": test_args,
"DATATYPE": datatype,
"BATCH_TILE": batch_tile,
"ISA_CHECK": xnncommon.generate_isa_check_macro(isa),
})
def main(args):
options = parser.parse_args(args)
with codecs.open(options.spec, "r", encoding="utf-8") as spec_file:
spec_yaml = yaml.safe_load(spec_file)
if not isinstance(spec_yaml, list):
raise ValueError("expected a list of micro-kernels in the spec")
tests = """\
// Copyright 2020 Google LLC
//
// This source code is licensed under the BSD-style license found in the
// LICENSE file in the root directory of this source tree.
//
// Auto-generated file. Do not edit!
// Specification: {specification}
// Generator: {generator}
#include <gtest/gtest.h>
#include <xnnpack/common.h>
#include <xnnpack/isa-checks.h>
#include <xnnpack/clamp.h>
#include "clamp-microkernel-tester.h"
""".format(specification=options.spec, generator=sys.argv[0])
for ukernel_spec in spec_yaml:
name = ukernel_spec["name"]
batch_tile, arch, isa = split_ukernel_name(name)
# specification can override architecture
arch = ukernel_spec.get("arch", arch)
test_case = generate_test_cases(name, batch_tile, isa)
tests += "\n\n" + xnncommon.postprocess_test_case(test_case, arch, isa)
with codecs.open(options.output, "w", encoding="utf-8") as output_file:
output_file.write(tests)
if __name__ == "__main__":
main(sys.argv[1:])