You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
331 lines
12 KiB
331 lines
12 KiB
// Copyright 2016, VIXL authors
|
|
// All rights reserved.
|
|
//
|
|
// Redistribution and use in source and binary forms, with or without
|
|
// modification, are permitted provided that the following conditions are met:
|
|
//
|
|
// * Redistributions of source code must retain the above copyright notice,
|
|
// this list of conditions and the following disclaimer.
|
|
// * Redistributions in binary form must reproduce the above copyright notice,
|
|
// this list of conditions and the following disclaimer in the documentation
|
|
// and/or other materials provided with the distribution.
|
|
// * Neither the name of ARM Limited nor the names of its contributors may be
|
|
// used to endorse or promote products derived from this software without
|
|
// specific prior written permission.
|
|
//
|
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS CONTRIBUTORS "AS IS" AND
|
|
// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
|
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
|
|
// FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
// DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
|
// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
|
// OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
/// This file is a template read by tools/generate_tests.py, it isn't valid C++
|
|
/// as it is. Variables written as ${substitute_me} are replaced by the script.
|
|
/// Comments starting with three forward slashes such as this one are also
|
|
/// removed.
|
|
|
|
${do_not_edit_comment}
|
|
|
|
#include "test-runner.h"
|
|
|
|
#include "test-utils.h"
|
|
#include "test-utils-aarch32.h"
|
|
|
|
#include "aarch32/assembler-aarch32.h"
|
|
#include "aarch32/macro-assembler-aarch32.h"
|
|
#include "aarch32/disasm-aarch32.h"
|
|
|
|
#define __ masm.
|
|
#define BUF_SIZE (4096)
|
|
|
|
#ifdef VIXL_INCLUDE_SIMULATOR_AARCH32
|
|
// Run tests with the simulator.
|
|
|
|
#define SETUP() MacroAssembler masm(BUF_SIZE)
|
|
|
|
#define START() masm.GetBuffer()->Reset()
|
|
|
|
#define END() \
|
|
__ Hlt(0); \
|
|
__ FinalizeCode();
|
|
|
|
// TODO: Run the tests in the simulator.
|
|
#define RUN()
|
|
|
|
#else // ifdef VIXL_INCLUDE_SIMULATOR_AARCH32.
|
|
|
|
#define SETUP() \
|
|
MacroAssembler masm(BUF_SIZE); \
|
|
UseScratchRegisterScope harness_scratch; \
|
|
|
|
#define START() \
|
|
harness_scratch.Open(&masm); \
|
|
harness_scratch.ExcludeAll(); \
|
|
masm.GetBuffer()->Reset(); \
|
|
__ Push(r4); \
|
|
__ Push(r5); \
|
|
__ Push(r6); \
|
|
__ Push(r7); \
|
|
__ Push(r8); \
|
|
__ Push(r9); \
|
|
__ Push(r10); \
|
|
__ Push(r11); \
|
|
__ Push(lr); \
|
|
harness_scratch.Include(ip);
|
|
|
|
#define END() \
|
|
harness_scratch.Exclude(ip); \
|
|
__ Pop(lr); \
|
|
__ Pop(r11); \
|
|
__ Pop(r10); \
|
|
__ Pop(r9); \
|
|
__ Pop(r8); \
|
|
__ Pop(r7); \
|
|
__ Pop(r6); \
|
|
__ Pop(r5); \
|
|
__ Pop(r4); \
|
|
__ Bx(lr); \
|
|
__ FinalizeCode(); \
|
|
harness_scratch.Close();
|
|
|
|
#define RUN() \
|
|
{ \
|
|
int pcs_offset = masm.IsUsingT32() ? 1 : 0; \
|
|
masm.GetBuffer()->SetExecutable(); \
|
|
ExecuteMemory(masm.GetBuffer()->GetStartAddress<byte*>(), \
|
|
masm.GetSizeOfCodeGenerated(), \
|
|
pcs_offset); \
|
|
masm.GetBuffer()->SetWritable(); \
|
|
}
|
|
|
|
#endif // ifdef VIXL_INCLUDE_SIMULATOR_AARCH32
|
|
|
|
namespace vixl {
|
|
namespace aarch32 {
|
|
|
|
// List of instruction encodings:
|
|
#define FOREACH_INSTRUCTION(M) \
|
|
${instruction_list_declaration}
|
|
|
|
// The following definitions are defined again in each generated test, therefore
|
|
// we need to place them in an anomymous namespace. It expresses that they are
|
|
// local to this file only, and the compiler is not allowed to share these types
|
|
// across test files during template instantiation. Specifically, `Operands` and
|
|
// `Inputs` have various layouts across generated tests so they absolutely
|
|
// cannot be shared.
|
|
|
|
#ifdef ${isa_guard}
|
|
namespace {
|
|
|
|
// Values to be passed to the assembler to produce the instruction under test.
|
|
struct Operands {
|
|
${operand_list_declaration}
|
|
};
|
|
|
|
// Input data to feed to the instruction.
|
|
struct Inputs {
|
|
${input_declarations}
|
|
};
|
|
|
|
// This structure contains all input data needed to test one specific encoding.
|
|
// It used to generate a loop over an instruction.
|
|
struct TestLoopData {
|
|
// The `operands` fields represents the values to pass to the assembler to
|
|
// produce the instruction.
|
|
Operands operands;
|
|
// Description of the operands, used for error reporting.
|
|
const char* operands_description;
|
|
// Unique identifier, used for generating traces.
|
|
const char* identifier;
|
|
// Array of values to be fed to the instruction.
|
|
size_t input_size;
|
|
const Inputs* inputs;
|
|
};
|
|
|
|
${input_definitions}
|
|
|
|
// A loop will be generated for each element of this array.
|
|
const TestLoopData kTests[] = {${test_case_definitions}};
|
|
|
|
// We record all inputs to the instructions as outputs. This way, we also check
|
|
// that what shouldn't change didn't change.
|
|
struct TestResult {
|
|
size_t output_size;
|
|
const Inputs* outputs;
|
|
};
|
|
|
|
// These headers each contain an array of `TestResult` with the reference output
|
|
// values. The reference arrays are names `kReference{mnemonic}`.
|
|
${include_trace_files}
|
|
|
|
// The maximum number of errors to report in detail for each test.
|
|
const unsigned kErrorReportLimit = 8;
|
|
|
|
typedef void (MacroAssembler::*Fn)(${macroassembler_method_args});
|
|
|
|
void TestHelper(Fn instruction, const char* mnemonic,
|
|
const TestResult reference[]) {
|
|
SETUP();
|
|
${macroassembler_set_isa}
|
|
START();
|
|
|
|
// Data to compare to `reference`.
|
|
TestResult* results[ARRAY_SIZE(kTests)];
|
|
|
|
// Test cases for memory bound instructions may allocate a buffer and save its
|
|
// address in this array.
|
|
byte* scratch_memory_buffers[ARRAY_SIZE(kTests)];
|
|
|
|
// Generate a loop for each element in `kTests`. Each loop tests one specific
|
|
// instruction.
|
|
for (unsigned i = 0; i < ARRAY_SIZE(kTests); i++) {
|
|
// Allocate results on the heap for this test.
|
|
results[i] = new TestResult;
|
|
results[i]->outputs = new Inputs[kTests[i].input_size];
|
|
results[i]->output_size = kTests[i].input_size;
|
|
|
|
size_t input_stride = sizeof(kTests[i].inputs[0]) * kTests[i].input_size;
|
|
VIXL_ASSERT(IsUint32(input_stride));
|
|
|
|
scratch_memory_buffers[i] = NULL;
|
|
|
|
Label loop;
|
|
UseScratchRegisterScope scratch_registers(&masm);
|
|
// Include all registers from r0 ro r12.
|
|
scratch_registers.Include(RegisterList(0x1fff));
|
|
|
|
// Values to pass to the macro-assembler.
|
|
${code_instantiate_operands}
|
|
|
|
// Allocate reserved registers for our own use.
|
|
Register input_ptr = scratch_registers.Acquire();
|
|
Register input_end = scratch_registers.Acquire();
|
|
Register result_ptr = scratch_registers.Acquire();
|
|
|
|
// Initialize `input_ptr` to the first element and `input_end` the address
|
|
// after the array.
|
|
__ Mov(input_ptr, Operand::From(kTests[i].inputs));
|
|
__ Add(input_end, input_ptr, static_cast<uint32_t>(input_stride));
|
|
__ Mov(result_ptr, Operand::From(results[i]->outputs));
|
|
__ Bind(&loop);
|
|
|
|
${code_prologue}
|
|
|
|
(masm.*instruction)(${code_parameter_list});
|
|
|
|
${code_epilogue}
|
|
|
|
// Advance the result pointer.
|
|
__ Add(result_ptr, result_ptr, Operand::From(sizeof(kTests[i].inputs[0])));
|
|
// Loop back until `input_ptr` is lower than `input_base`.
|
|
__ Add(input_ptr, input_ptr, Operand::From(sizeof(kTests[i].inputs[0])));
|
|
__ Cmp(input_ptr, input_end);
|
|
__ B(ne, &loop);
|
|
}
|
|
|
|
END();
|
|
|
|
RUN();
|
|
|
|
if (Test::generate_test_trace()) {
|
|
// Print the results.
|
|
for (size_t i = 0; i < ARRAY_SIZE(kTests); i++) {
|
|
printf("const Inputs kOutputs_%s_%s[] = {\n", mnemonic,
|
|
kTests[i].identifier);
|
|
for (size_t j = 0; j < results[i]->output_size; j++) {
|
|
printf(" { ");
|
|
${trace_print_outputs}
|
|
printf(" },\n");
|
|
}
|
|
printf("};\n");
|
|
}
|
|
printf("const TestResult kReference%s[] = {\n", mnemonic);
|
|
for (size_t i = 0; i < ARRAY_SIZE(kTests); i++) {
|
|
printf(" {\n");
|
|
printf(" ARRAY_SIZE(kOutputs_%s_%s),\n", mnemonic,
|
|
kTests[i].identifier);
|
|
printf(" kOutputs_%s_%s,\n", mnemonic, kTests[i].identifier);
|
|
printf(" },\n");
|
|
}
|
|
printf("};\n");
|
|
} else if (kCheckSimulatorTestResults) {
|
|
// Check the results.
|
|
unsigned total_error_count = 0;
|
|
for (size_t i = 0; i < ARRAY_SIZE(kTests); i++) {
|
|
bool instruction_has_errors = false;
|
|
for (size_t j = 0; j < kTests[i].input_size; j++) {
|
|
${check_instantiate_results}
|
|
${check_instantiate_inputs}
|
|
${check_instantiate_references}
|
|
|
|
if ((${check_results_against_references}) &&
|
|
(++total_error_count <= kErrorReportLimit)) {
|
|
// Print the instruction once even if it triggered multiple failures.
|
|
if (!instruction_has_errors) {
|
|
printf("Error(s) when testing \"%s %s\":\n", mnemonic,
|
|
kTests[i].operands_description);
|
|
instruction_has_errors = true;
|
|
}
|
|
// Print subsequent errors.
|
|
printf(" Input: ");
|
|
${check_print_input}
|
|
printf("\n");
|
|
printf(" Expected: ");
|
|
${check_print_expected}
|
|
printf("\n");
|
|
printf(" Found: ");
|
|
${check_print_found}
|
|
printf("\n\n");
|
|
}
|
|
}
|
|
}
|
|
|
|
if (total_error_count > kErrorReportLimit) {
|
|
printf("%u other errors follow.\n",
|
|
total_error_count - kErrorReportLimit);
|
|
}
|
|
VIXL_CHECK(total_error_count == 0);
|
|
} else {
|
|
VIXL_WARNING("Assembled the code, but did not run anything.\n");
|
|
}
|
|
|
|
for (size_t i = 0; i < ARRAY_SIZE(kTests); i++) {
|
|
delete[] results[i]->outputs;
|
|
delete results[i];
|
|
delete[] scratch_memory_buffers[i];
|
|
}
|
|
}
|
|
|
|
// Instantiate tests for each instruction in the list.
|
|
// TODO: Remove this limitation by having a sandboxing mechanism.
|
|
#if defined(VIXL_HOST_POINTER_32)
|
|
#define TEST(mnemonic) \
|
|
void Test_##mnemonic() { \
|
|
TestHelper(&MacroAssembler::mnemonic, #mnemonic, kReference##mnemonic); \
|
|
} \
|
|
Test test_##mnemonic("AARCH32_${test_name}_" #mnemonic "_${test_isa}", \
|
|
&Test_##mnemonic);
|
|
#else
|
|
#define TEST(mnemonic) \
|
|
void Test_##mnemonic() { \
|
|
VIXL_WARNING("This test can only run on a 32-bit host.\n"); \
|
|
USE(TestHelper); \
|
|
} \
|
|
Test test_##mnemonic("AARCH32_${test_name}_" #mnemonic "_${test_isa}", \
|
|
&Test_##mnemonic);
|
|
#endif
|
|
|
|
FOREACH_INSTRUCTION(TEST)
|
|
#undef TEST
|
|
|
|
} // namespace
|
|
#endif
|
|
|
|
} // namespace aarch32
|
|
} // namespace vixl
|