54efa1afc0
Dear reader, I must apologize in advance. This CL contains the following: - A new 256-line perlasm file with non-trivial perl bits and a dual-ABI variadic function caller. - C preprocessor gymnastics, with variadic macros and fun facts about __VA_ARGS__'s behavior on empty argument lists. - C++ template gymnastics, including variadic arguments, template specialization, std::enable_if, and machinery to control template argument deduction. Enjoy. This tests that our assembly functions correctly honor platform ABI conventions. Right now this only tests callee-saved registers, but it should be extendable to SEH/CFI unwind testing with single-step debugging APIs. Register-checking does not involve anything funny and should be compatible with SDE. (The future unwind testing is unlikely to be compatible.) This CL adds support for x86_64 SysV and Win64 ABIs. ARM, AArch64, and x86 can be added in the future. The testing is injected in two places. First, all the assembly tests in p256-x86_64-test.cc are now instrumented. This is the intended workflow and should capture all registers. However, we currently do not unit-test our assembly much directly. We should do that as follow-up work[0] but, in the meantime, I've also wrapped all of the GTest main function in an ABI test. This is imperfect as ABI failures may be masked by other stack frames, but it costs nothing[1] and is pretty reliable at catching Win64 xmm register failures. [0] An alternate strategy would be, in debug builds, unconditionally instrument every assembly call in libcrypto. But the CHECK_ABI macro would be difficult to replicate in pure C, and unwind testing may be too invasive for this. Still, something to consider when we C++ libcrypto. [1] When single-stepped unwind testing exists, it won't cost nothing. The gtest_main.cc call will turn unwind testing off. Change-Id: I6643b26445891fd46abfacac52bc024024c8d7f6 Reviewed-on: https://boringssl-review.googlesource.com/c/33764 Reviewed-by: Adam Langley <agl@google.com> Reviewed-by: Adam Langley <alangley@gmail.com> Commit-Queue: David Benjamin <davidben@google.com>
63 lines
2.0 KiB
C++
63 lines
2.0 KiB
C++
/* Copyright (c) 2018, Google Inc.
|
|
*
|
|
* Permission to use, copy, modify, and/or distribute this software for any
|
|
* purpose with or without fee is hereby granted, provided that the above
|
|
* copyright notice and this permission notice appear in all copies.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
|
|
* SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
|
|
* OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
|
|
* CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */
|
|
|
|
#include "abi_test.h"
|
|
|
|
#include <openssl/rand.h>
|
|
|
|
|
|
namespace abi_test {
|
|
namespace internal {
|
|
|
|
std::string FixVAArgsString(const char *str) {
|
|
std::string ret = str;
|
|
size_t idx = ret.find(',');
|
|
if (idx == std::string::npos) {
|
|
return ret + "()";
|
|
}
|
|
size_t idx2 = idx + 1;
|
|
while (idx2 < ret.size() && ret[idx2] == ' ') {
|
|
idx2++;
|
|
}
|
|
while (idx > 0 && ret[idx - 1] == ' ') {
|
|
idx--;
|
|
}
|
|
return ret.substr(0, idx) + "(" + ret.substr(idx2) + ")";
|
|
}
|
|
|
|
#if defined(SUPPORTS_ABI_TEST)
|
|
crypto_word_t RunTrampoline(Result *out, crypto_word_t func,
|
|
const crypto_word_t *argv, size_t argc) {
|
|
CallerState state;
|
|
RAND_bytes(reinterpret_cast<uint8_t *>(&state), sizeof(state));
|
|
|
|
// TODO(davidben): Use OS debugging APIs to single-step |func| and test that
|
|
// CFI and SEH annotations are correct.
|
|
CallerState state2 = state;
|
|
crypto_word_t ret = abi_test_trampoline(func, &state2, argv, argc);
|
|
|
|
*out = Result();
|
|
#define CALLER_STATE_REGISTER(type, name) \
|
|
if (state.name != state2.name) { \
|
|
out->errors.push_back(#name " was not restored"); \
|
|
}
|
|
LOOP_CALLER_STATE_REGISTERS()
|
|
#undef CALLER_STATE_REGISTER
|
|
return ret;
|
|
}
|
|
#endif
|
|
|
|
} // namespace internal
|
|
} // namespace abi_test
|